data_export

KnowledgeModelDataExport

Bases: ProxyDataExportStatusResponseV2

Data export object to interact with version knowledge model data exports using semantic layer endpoints.

created class-attribute instance-attribute

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

export_status class-attribute instance-attribute

export_status = Field(None, alias='exportStatus')

export_type class-attribute instance-attribute

export_type = Field(None, alias='exportType')

exported_chunks class-attribute instance-attribute

exported_chunks = Field(None, alias='exportedChunks')

messages class-attribute instance-attribute

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

client class-attribute instance-attribute

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

id instance-attribute

id

Id of data export.

root_with_key instance-attribute

root_with_key

Knowledge model root concatenated with key.

query_context instance-attribute

query_context

Operational query context.

from_transport classmethod

from_transport(
    client,
    root_with_key,
    query_context,
    data_export_transport,
)

Creates high-level data export object from given SemanticProxyDataExportStatusResponseV2.

Parameters:

• client (Client) –

  Client to use to make API calls for given data pool.

• root_with_key (str) –

  Knowledge model root concatenated by key.

• data_export_transport (ProxyDataExportStatusResponseV2) –

  SemanticProxyDataExportStatusResponseV2 object containing properties of data export.

• query_context (QueryContext) –

  Operational level (published or unpublished) for the data export context.

Returns:

• KnowledgeModelDataExport –

  A SemanticProxyDataExportStatusResponseV2 object with properties from transport and given client.

get_chunks

get_chunks()

Yields exported chunks.

Yields:

• BytesIO –

  Byte chunks of exported data.

wait_for_execution

wait_for_execution()

Waits until data export execution is done.