Skip to content

data_connection

Module to interact with data connections.

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

Typical usage example
data_connection = data_pool.get_data_connection("ID")

data_connection.sync()
data_connection.delete()

DataConnection

Bases: DataSourceTransport

DataConnection object to interact with data connection specific data integration endpoints.

client class-attribute

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

id class-attribute

id: str

pool_id class-attribute

pool_id: str

from_transport classmethod

from_transport(client, data_source_transport)

Creates high-level data connection object from given DataSourceTransport.

Parameters:

  • client (Client) –

    Client to use to make API calls for given job.

  • data_source_transport (DataSourceTransport) –

    DataSourceTransport object containing properties of data connection.

Returns:

  • DataConnection

    A DataConnection object with properties from transport and given client.

data_pool_id writable property

data_pool_id()

Returns id of data pool for given data connection.

sync

sync()

Syncs data connection properties with EMS.

delete

delete()

Deletes data connection.

get_tables

get_tables(search_string=None)

Returns tables matching given search string. If no search string is given, all tables are returned.

Parameters:

  • search_string (typing.Optional[str]) –

    Search string to filter tables. Default is None which returns all tables.

Returns:

  • typing.List[DataSourceTable]

    Returns list of DataSourceTable objects containing tables matching search string.

Raises: