foreign_key

Module to interact with foreign keys.

This module contains class to interact with a foreign key in EMS data integration.

Typical usage example

foreign_key = data_model.get_foreign_key(foreign_key_id)
foreign_key.name = "NEW_NAME"
foreign_key.update()
foreign_key.reload()
foreign_key.delete()

ForeignKey

Bases: DataModelForeignKeyTransport

Foreign key object to interact with foreign key specific data integration endpoints.

client class-attribute

client: Client = Field(Ellipsis, exclude=True)

id class-attribute

id: str

Id of foreign key.

data_pool_id class-attribute

data_pool_id: str

Id of data pool where foreign key is located.

data_model_id class-attribute

data_model_id: str

Id of data model where foreign key is located.

source_table_id class-attribute

source_table_id: typing.Optional[str]

Id of source data model table.

target_table_id class-attribute

target_table_id: typing.Optional[str]

Id of target data model table.

columns class-attribute

columns: typing.Optional[
    typing.List[
        typing.Optional[DataModelForeignKeyColumnTransport]
    ]
]

Columns of foreign key.

from_transport classmethod

from_transport(client, data_pool_id, foreign_key_transport)

Creates high-level foreign key object from given DataModelForeignKeyTransport.

Parameters:

• client (Client) –

  Client to use to make API calls for given foreign key.

• data_pool_id (str) –

  Id of data pool where table is located

• foreign_key_transport (DataModelForeignKeyTransport) –

  DataModelForeignKeyTransport object containing properties of foreign key.

Returns:

• ForeignKey –

  A ForeignKey object with properties from transport and given client.

update

update()

Pushes local changes of foreign key to EMS and updates properties with response from EMS.

sync

sync()

Syncs foreign key properties with EMS.

delete

delete()

Deletes foreign key.