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 = 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.

type_ class-attribute instance-attribute

type_ = Field(None, alias='type')

metadata class-attribute instance-attribute

metadata = Field(None, alias='metadata')

uplink_id class-attribute instance-attribute

uplink_id = Field(None, alias='uplinkId')

connected class-attribute instance-attribute

connected = Field(None, alias='connected')

locked class-attribute instance-attribute

locked = Field(None, alias='locked')

uplink_name class-attribute instance-attribute

uplink_name = Field(None, alias='uplinkName')

signature class-attribute instance-attribute

signature = Field(None, alias='signature')

use_uplink class-attribute instance-attribute

use_uplink = Field(None, alias='useUplink')

internal_system_id class-attribute instance-attribute

internal_system_id = Field(None, alias='internalSystemId')

internal_system_selected class-attribute instance-attribute

internal_system_selected = Field(
    None, alias="internalSystemSelected"
)

configuration class-attribute instance-attribute

configuration = Field(None, alias='configuration')

target_schema_name class-attribute instance-attribute

target_schema_name = Field(None, alias='targetSchemaName')

exported class-attribute instance-attribute

exported = Field(None, alias='exported')

export_available class-attribute instance-attribute

export_available = Field(None, alias='exportAvailable')

extractor_port class-attribute instance-attribute

extractor_port = Field(None, alias='extractorPort')

anonymization_algorithm class-attribute instance-attribute

anonymization_algorithm = Field(
    None, alias="anonymizationAlgorithm"
)

salt_id class-attribute instance-attribute

salt_id = Field(None, alias='saltId')

custom_extractor_id class-attribute instance-attribute

custom_extractor_id = Field(None, alias="customExtractorId")

custom_extractor_name class-attribute instance-attribute

custom_extractor_name = Field(
    None, alias="customExtractorName"
)

creator_user_id class-attribute instance-attribute

creator_user_id = Field(None, alias='creatorUserId')

creator_username class-attribute instance-attribute

creator_username = Field(None, alias='creatorUsername')

reachable_and_valid class-attribute instance-attribute

reachable_and_valid = Field(None, alias="reachableAndValid")

normalized_name class-attribute instance-attribute

normalized_name = Field(None, alias='normalizedName')

imported class-attribute instance-attribute

imported = Field(None, alias='imported')

parameter_name class-attribute instance-attribute

parameter_name = Field(None, alias='parameterName')

configured class-attribute instance-attribute

configured = Field(None, alias='configured')

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:

• PyCelonisValueError –

  Raised if search for tables with given search string failed.

create_replication

create_replication(table_name, **kwargs)

Creates new replication for table with name in given data connection.

Parameters:

• table_name (str) –

  Name of table for which to create replication.

• **kwargs (Any, default: {} ) –

  Additional parameters set for DataModelTransport object.

Returns:

• Replication –

  A Replication object for newly created replication.

Examples:

Create a replication for table TEST_TABLE and initialize/start it:

replication = data_connection.create_replication(
    "TEST_TABLE"
)
replication.initialize()  # initializes and triggers replication

get_replication

get_replication(id_)

Gets replication with given id.

Parameters:

• id_ (str) –

  Id of replication.

Returns:

• Replication –

  A Replication object for replication with given id.

get_replications

get_replications()

Gets all replications of given data connection.

Returns:

• List[Replication] –

  A list containing all replications.