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 instance-attribute 

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

id instance-attribute 

id: str

Id of data connection.

pool_id instance-attribute 

pool_id: str

Id of pool where data connection is located.

name instance-attribute 

name: typing.Optional[str]

Name of data connection.

data_pool_id property writable 

data_pool_id: str

Returns id of data pool for given data connection.

Returns:

  • str –

    Data pool id.

from_transport classmethod 

from_transport(client, data_source_transport)

Creates high-level data connection object from the 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.

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[typing.Optional[DataSourceTable]] –

    Returns list of DataSourceTable objects containing tables matching search string.

Raises: