table_extraction

Module to interact with table extractions.

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

Typical usage example

table_extraction = data_job.create_table_extraction(table_name, schema_name)
table_extraction.delete()

TableExtraction

Bases: TableExtractionTransport

Table extraction object to interact with table extraction specific data integration endpoints.

client class-attribute instance-attribute

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

id instance-attribute

id: str

Id of table extraction.

data_pool_id instance-attribute

data_pool_id: str

Id of data pool where table extraction is located.

job_id instance-attribute

job_id: str

Id of job where table extraction is located.

task_id instance-attribute

task_id: str

extraction_id instance-attribute

extraction_id: str

table_execution_item_id class-attribute instance-attribute

table_execution_item_id: Optional[str] = Field(
    alias="tableExecutionItemId"
)

table_name class-attribute instance-attribute

table_name: Optional[str] = Field(alias='tableName')

rename_target_table class-attribute instance-attribute

rename_target_table: Optional[bool] = Field(
    alias="renameTargetTable"
)

target_table_name class-attribute instance-attribute

target_table_name: Optional[str] = Field(
    alias="targetTableName"
)

columns class-attribute instance-attribute

columns: Optional[
    List[Optional[TableExtractionColumnTransport]]
] = Field(alias="columns")

joins class-attribute instance-attribute

joins: Optional[
    List[Optional[TableExtractionJoinTransport]]
] = Field(alias="joins")

dependent_tables class-attribute instance-attribute

dependent_tables: Optional[
    List[Optional[TableExtractionTransport]]
] = Field(alias="dependentTables")

use_manual_p_ks class-attribute instance-attribute

use_manual_p_ks: Optional[bool] = Field(
    alias="useManualPKs"
)

filter_definition class-attribute instance-attribute

filter_definition: Optional[str] = Field(
    alias="filterDefinition"
)

delta_filter_definition class-attribute instance-attribute

delta_filter_definition: Optional[str] = Field(
    alias="deltaFilterDefinition"
)

schema_name class-attribute instance-attribute

schema_name: Optional[str] = Field(alias='schemaName')

creation_date_column class-attribute instance-attribute

creation_date_column: Optional[str] = Field(
    alias="creationDateColumn"
)

creation_date_value_start class-attribute instance-attribute

creation_date_value_start: Optional[str] = Field(
    alias="creationDateValueStart"
)

creation_date_value_end class-attribute instance-attribute

creation_date_value_end: Optional[str] = Field(
    alias="creationDateValueEnd"
)

creation_date_parameter_start class-attribute instance-attribute

creation_date_parameter_start: Optional[str] = Field(
    alias="creationDateParameterStart"
)

creation_date_parameter_end class-attribute instance-attribute

creation_date_parameter_end: Optional[str] = Field(
    alias="creationDateParameterEnd"
)

creation_date_value_today class-attribute instance-attribute

creation_date_value_today: Optional[bool] = Field(
    alias="creationDateValueToday"
)

change_date_column class-attribute instance-attribute

change_date_column: Optional[str] = Field(
    alias="changeDateColumn"
)

change_date_offset class-attribute instance-attribute

change_date_offset: Optional[int] = Field(
    alias="changeDateOffset"
)

change_date_offset_type class-attribute instance-attribute

change_date_offset_type: Optional[
    ChangeDateOffsetType
] = Field(alias="changeDateOffsetType")

table_extraction_type class-attribute instance-attribute

table_extraction_type: Optional[
    TableExtractionType
] = Field(alias="tableExtractionType")

parent_table class-attribute instance-attribute

parent_table: Optional[str] = Field(alias='parentTable')

depends_on class-attribute instance-attribute

depends_on: Optional[str] = Field(alias='dependsOn')

column_value_table class-attribute instance-attribute

column_value_table: Optional[str] = Field(
    alias="columnValueTable"
)

column_value_column class-attribute instance-attribute

column_value_column: Optional[str] = Field(
    alias="columnValueColumn"
)

column_value_target_column class-attribute instance-attribute

column_value_target_column: Optional[str] = Field(
    alias="columnValueTargetColumn"
)

column_values_at_a_time class-attribute instance-attribute

column_values_at_a_time: Optional[int] = Field(
    alias="columnValuesAtATime"
)

join_type class-attribute instance-attribute

join_type: Optional[JoinType] = Field(alias='joinType')

disabled class-attribute instance-attribute

disabled: Optional[bool] = Field(alias='disabled')

connector_specific_configuration class-attribute instance-attribute

connector_specific_configuration: Optional[
    List[Optional[TableConfigurationParameterValue]]
] = Field(alias="connectorSpecificConfiguration")

calculated_columns class-attribute instance-attribute

calculated_columns: Optional[
    List[Optional[CalculatedColumnTransport]]
] = Field(alias="calculatedColumns")

end_date_disabled class-attribute instance-attribute

end_date_disabled: Optional[bool] = Field(
    alias="endDateDisabled"
)

disable_change_log class-attribute instance-attribute

disable_change_log: Optional[bool] = Field(
    alias="disableChangeLog"
)

data_push_delete_strategy class-attribute instance-attribute

data_push_delete_strategy: Optional[
    DataPushDeleteStrategy
] = Field(alias="dataPushDeleteStrategy")

customize_column_selection class-attribute instance-attribute

customize_column_selection: Optional[bool] = Field(
    alias="customizeColumnSelection"
)

mirror_table_names class-attribute instance-attribute

mirror_table_names: Optional[List[Optional[str]]] = Field(
    alias="mirrorTableNames"
)

parent class-attribute instance-attribute

parent: Optional[bool] = Field(alias='parent')

selected_columns class-attribute instance-attribute

selected_columns: Optional[List[Optional[str]]] = Field(
    alias="selectedColumns"
)

from_transport classmethod

from_transport(
    client,
    data_pool_id,
    job_id,
    extraction_id,
    table_extraction_transport,
)

Creates high-level table extraction object from given TableExtractionTransport.

Parameters:

• client (Client) –

  Client to use to make API calls for given table extraction.

• data_pool_id (str) –

  Id of data pool where table extraction is located.

• job_id (str) –

  Id of job where table extraction is located.

• extraction_id (str) –

  Id of extraction where table extraction is located.

• table_extraction_transport (TableExtractionTransport) –

  TableExtractionTransport object containing properties of data model execution.

Returns:

• TableExtraction –

  A TableExtraction object with properties from transport and given client.

sync

sync()

Syncs table extraction properties with EMS.

update

update()

Pushes local changes of data model to EMS and updates properties with response from EMS.

Raises:

• PyCelonisValueError –

  Raised if something went wrong updating the table extraction which could indicate that the table extraction no longer exists or the local state is invalid.

delete

delete()

Deletes table extraction.