Skip to content

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

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

id class-attribute

id: str

data_pool_id class-attribute

data_pool_id: str

job_id class-attribute

job_id: str

task_id class-attribute

task_id: str

extraction_id class-attribute

extraction_id: str

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.