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:

```python
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.

type_ class-attribute instance-attribute 

type_ = Field(alias='type')

metadata class-attribute instance-attribute 

metadata = Field(alias='metadata')

uplink_id = Field(alias='uplinkId')

connected class-attribute instance-attribute 

connected = Field(alias='connected')

locked class-attribute instance-attribute 

locked = Field(alias='locked')

uplink_name = Field(alias='uplinkName')

signature class-attribute instance-attribute 

signature = Field(alias='signature')

use_uplink = Field(alias='useUplink')

internal_system_id class-attribute instance-attribute 

internal_system_id = Field(alias='internalSystemId')

internal_system_selected class-attribute instance-attribute 

internal_system_selected = Field(
    alias="internalSystemSelected"
)

configuration class-attribute instance-attribute 

configuration = Field(alias='configuration')

target_schema_name class-attribute instance-attribute 

target_schema_name = Field(alias='targetSchemaName')

exported class-attribute instance-attribute 

exported = Field(alias='exported')

export_available class-attribute instance-attribute 

export_available = Field(alias='exportAvailable')

extractor_port class-attribute instance-attribute 

extractor_port = Field(alias='extractorPort')

anonymization_algorithm class-attribute instance-attribute 

anonymization_algorithm = Field(
    alias="anonymizationAlgorithm"
)

salt_id class-attribute instance-attribute 

salt_id = Field(alias='saltId')

custom_extractor_id class-attribute instance-attribute 

custom_extractor_id = Field(alias='customExtractorId')

custom_extractor_name class-attribute instance-attribute 

custom_extractor_name = Field(alias='customExtractorName')

creator_user_id class-attribute instance-attribute 

creator_user_id = Field(alias='creatorUserId')

creator_username class-attribute instance-attribute 

creator_username = Field(alias='creatorUsername')

reachable_and_valid class-attribute instance-attribute 

reachable_and_valid = Field(alias='reachableAndValid')

normalized_name class-attribute instance-attribute 

normalized_name = Field(alias='normalizedName')

imported class-attribute instance-attribute 

imported = Field(alias='imported')

parameter_name class-attribute instance-attribute 

parameter_name = Field(alias='parameterName')

configured class-attribute instance-attribute 

configured = Field(alias='configured')

client class-attribute instance-attribute 

client = Field(..., exclude=True)

id instance-attribute 

id

Id of data connection.

pool_id instance-attribute 

pool_id

Id of pool where data connection is located.

name instance-attribute 

name

Name of data connection.

data_pool_id property writable 

data_pool_id

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 (Optional[str], default: None ) –

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

Returns:

  • List[Optional[DataSourceTable]] –

    Returns list of DataSourceTable objects containing tables matching search string.

Raises: