datakiln.metadata.foreign_key module

Foreign key metadata.

class datakiln.metadata.foreign_key.ForeignKeyReference(schema: str, table: str, columns: list)[source]

Bases: object

Metadata for table referenced in foreign key.

Parameters:
  • schema (str) – Schema of foreign table.

  • table (str) – Table referenced by foreign key.

  • columns (str) – Columns referenced by foreign key.

schema: str
table: str
columns: list
class datakiln.metadata.foreign_key.ForeignKeyMeta(table, columns, reference, dtypes=None)[source]

Bases: object

Metadata for foreign key.

create(conn)[source]

Create statement.

Parameters:

conn (sqlalchemy.Engine) – SQLAlchemy connection or session.

Returns:

None

join(alias=None, dialect='default')[source]

Generate JOIN statement for the foreign key.

Returns:

JOIN statement.

Return type:

list[str]

Parameters:

dialect (str) – Dialect of the database.

distinct_reference(alias=None, dialect='default')[source]

Filter foreign key values that do not exist in the reference tables, allowing null values.

Returns:

Comparisons for each foreign key column.

Return type:

list[str]

Parameters:

dialect (str) – Dialect of the database.