DataTableService¶
Initialize the Elevate service.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
server
|
Optional[str]
|
The server name for the Elevate service API. If not provided, defaults to the |
None
|
client_id
|
Optional[str]
|
The client ID for authentication. If not provided, defaults to the |
None
|
secret_key
|
Optional[str]
|
The secret key for authentication. If not provided, defaults to the |
None
|
Raises:
| Type | Description |
|---|---|
ElevateConfigurationException
|
If any required parameter is missing or invalid |
create_data_table
¶
Creates a new DataTable that serves as a container for imported data within the system. The request body requires name and dataSourceId, with optional description and tags. Returns a DataTable response object containing the created resource with id, lockVersion, latestDataVersion (null initially), and all submitted fields plus audit information.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
create_data_table_request
|
CreateDataTableRequest
|
Request body containing the configuration details needed to create a new DataTable, including name, description, and DataSource reference (required) |
required |
Returns:
| Type | Description |
|---|---|
DataTableResponse
|
Returns the result object. |
create_data_version
¶
Creates a new data version for the specified DataTable by importing data from the associated DataSource. This API accepts the data-table-id path parameter, triggers the data ingestion process, and returns the newly created DataVersion object with fields such as versionNumber, status (initially PENDING or IN_PROGRESS), importJobId, and audit information.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
DataVersionResponse
|
Returns the result object. |
delete_data_table
¶
Marks a DataTable for deletion (soft delete). This API accepts the data-table-id path parameter and marks the DataTable and all associated data versions for deletion. A background cleaner job will later purge the actual data from storage and remove the entities from the database. Returns 204 No Content on success or NOT_FOUND if the DataTable does not exist.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
None
|
Returns the result object. |
delete_data_version
¶
Permanently deletes a specific data version from a DataTable. This API accepts data-table-id and data-version-number path parameters, removes the data version entity from the database, and kills any running import job associated with that version. If the deleted version is the latest, the DataTable's latestDataVersion is updated to the next available version. Returns 204 No Content on success or NOT_FOUND if not found.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
data_version_number
|
StrictInt
|
Version number of the data within the DataTable (required) |
required |
Returns:
| Type | Description |
|---|---|
None
|
Returns the result object. |
export_data_version_to_s3
¶
Initiates a single-file export of a specific data version to Amazon S3. This API accepts data-table-id and data-version-number path parameters, plus a request body with S3 configuration (bucket, path, credentials). Returns a response containing jobId for tracking the export progress. This operation exports the entire data version as a single file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
data_version_number
|
StrictInt
|
Version number of the data within the DataTable (required) |
required |
export_s3_request
|
ExportS3Request
|
Request body containing S3 credentials and configuration details for exporting data to Amazon S3 (required) |
required |
Returns:
| Type | Description |
|---|---|
ExportS3Response
|
Returns the result object. |
export_data_version_to_s3_parts
¶
Initiates a multi-part export of a specific data version to Amazon S3. This API accepts data-table-id and data-version-number path parameters, plus a request body with S3 configuration (bucket, path, credentials). Returns a response containing jobId for tracking the export progress, allowing efficient transfer of large datasets by splitting the export into multiple parts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
data_version_number
|
StrictInt
|
Version number of the data within the DataTable (required) |
required |
export_s3_part_request
|
ExportS3PartRequest
|
Request body containing the list of S3 parts and configuration for multi-part export operations (required) |
required |
Returns:
| Type | Description |
|---|---|
ExportS3PartResponse
|
Returns the result object. |
export_latest_data_version_to_s3_parts
¶
Initiates a multi-part export of the latest data version to Amazon S3. This API accepts data-table-id path parameter and a request body with S3 configuration (bucket, path, credentials). Returns a response containing jobId for tracking the export progress. This operation automatically uses the most recent data version available in the DataTable.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
export_s3_part_request
|
ExportS3PartRequest
|
Request body containing the list of S3 parts and configuration for multi-part export operations (required) |
required |
Returns:
| Type | Description |
|---|---|
ExportS3PartResponse
|
Returns the result object. |
get_data_table
¶
Retrieves detailed information about a specific DataTable by its ID. This API accepts the data-table-id path parameter and returns a DataTable object containing fields such as id, name, description, tags, dataSourceId, latestDataVersion, lockVersion, and audit information (createdBy, createdDate, lastModifiedBy, lastModifiedDate). Connection details are included in the response by default. Returns NOT_FOUND if the DataTable does not exist.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
DataTableResponse
|
Returns the result object. |
get_data_table_export_s3_job_status
¶
Retrieves the current status and progress of an S3 export job. This API accepts the job-id path parameter and returns an ExportS3JobStatus object containing status (PENDING, IN_PROGRESS, COMPLETED, FAILED), progress percentage, result details, and error information if applicable. Use this endpoint to monitor single-file export operations and determine when they have completed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job_id
|
StrictStr
|
Unique identifier of the background job to query (required) |
required |
Returns:
| Type | Description |
|---|---|
ExportS3JobStatusResponse
|
Returns the result object. |
get_data_version
¶
Retrieves detailed information about a specific data version. This API accepts data-table-id and data-version-number path parameters and returns a DataVersion object containing fields such as versionNumber, status, rowCount, columnCount, schema (columns with name and type), importJobId, processing results, and audit information. Returns NOT_FOUND if the DataTable or data version does not exist.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
data_version_number
|
StrictInt
|
Version number of the data within the DataTable (required) |
required |
Returns:
| Type | Description |
|---|---|
DataVersionResponse
|
Returns the result object. |
get_data_version_column_analysis
¶
Retrieves schema analysis results for a single column of a data version. This API accepts data-table-id, data-version-number, and column-name path parameters and returns a SchemaAnalysis object containing statistical information, data quality metrics, and column profiling data. Returns NOT_FOUND if the data table, data version, or schema analysis does not exist.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
data_version_number
|
StrictInt
|
Version number of the data within the DataTable (required) |
required |
column_name
|
StrictStr
|
Name of the column to retrieve analysis for (must exist in the data version schema) (required) |
required |
Returns:
| Type | Description |
|---|---|
Dict[str, object]
|
Returns the result object. |
get_data_version_overview
¶
Retrieves schema overview statistics for a data version. This API accepts data-table-id and data-version-number path parameters and returns a SchemaOverview object containing summary statistics such as total columns, row count, data types distribution, null value percentages, and other high-level data quality metrics. Returns NOT_FOUND if the data table, data version, or schema overview does not exist.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
data_version_number
|
StrictInt
|
Version number of the data within the DataTable (required) |
required |
Returns:
| Type | Description |
|---|---|
Dict[str, object]
|
Returns the result object. |
get_data_version_preview
¶
Retrieves a sample of the actual data content from a specific data version for preview purposes. This API accepts data-table-id and data-version-number path parameters and returns a Preview object containing schema (column definitions) and rows (limited sample data) arrays, allowing users to inspect the data structure and content without downloading the entire dataset.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
data_version_number
|
StrictInt
|
Version number of the data within the DataTable (required) |
required |
Returns:
| Type | Description |
|---|---|
List[Dict[str, object]]
|
Returns the result object. |
get_data_version_schema_alerts
¶
Retrieves schema alerts for a data version. This API accepts data-table-id and data-version-number path parameters and returns a SchemaAlerts object containing an array of alert information including severity, type, affected columns, and descriptions of detected data quality or schema issues. Returns NOT_FOUND if the data table, data version, or schema alerts does not exist.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
data_version_number
|
StrictInt
|
Version number of the data within the DataTable (required) |
required |
Returns:
| Type | Description |
|---|---|
List[Dict[str, object]]
|
Returns the result object. |
get_data_version_schema_analysis_status
¶
Retrieves schema analysis job status for a specific data version. This API accepts data-table-id and data-version-number path parameters and returns a SchemaAnalysisStatus object containing status (PENDING, IN_PROGRESS, COMPLETED, FAILED), progress percentage, and error information if applicable. Returns NOT_FOUND if the data table, data version, or schema analysis does not exist.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
data_version_number
|
StrictInt
|
Version number of the data within the DataTable (required) |
required |
Returns:
| Type | Description |
|---|---|
SchemaAnalysisStatusResponse
|
Returns the result object. |
get_export_job_status
¶
Retrieves the current status and progress of a multi-part S3 export job. This API accepts the job-id path parameter and returns an ExportS3PartJobStatus object containing status (PENDING, IN_PROGRESS, COMPLETED, FAILED), progress percentage, part upload results, and error information if applicable. Use this endpoint to monitor multi-part export operations and retrieve part details.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
job_id
|
StrictStr
|
Unique identifier of the background job to query (required) |
required |
Returns:
| Type | Description |
|---|---|
ExportS3PartJobStatusResponse
|
Returns the result object. |
is_data_table_name_available
¶
Checks if a DataTable name is available for use within the current workspace. This API accepts the name path parameter (case-insensitive) and returns a boolean response (true if available, false if already in use). This validation helps prevent duplicate names before creating new DataTables.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
constr(strict=True, min_length=1)
|
The proposed name for the DataTable to check for availability (required) |
required |
Returns:
| Type | Description |
|---|---|
bool
|
Returns the result object. |
list_data_tables
¶
Retrieves a list of all DataTables within the workspace. Returns an array of DataTable objects with fields such as id, name, description, tags, dataSourceId, latestDataVersion, lockVersion, and audit information (createdBy, createdDate, lastModifiedBy, lastModifiedDate). DataTables are containers for imported data from external sources and serve as building blocks for data transformation workflows.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
list_query
|
Optional[ListQuery]
|
List query parameters |
None
|
Returns:
| Type | Description |
|---|---|
DataTablesResponse
|
Returns the result object. |
list_data_versions
¶
Retrieves all data versions associated with a specific DataTable. This API accepts the data-table-id path parameter and returns an array of DataVersion objects with fields such as versionNumber, status, rowCount, columnCount, schema information, importJobId, and audit information. Data versions represent different snapshots or iterations of data imported into the DataTable.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
List[DataVersionResponse]
|
Returns the result object. |
update_data_table
¶
Updates the metadata and configuration of an existing DataTable. The request body requires id, lockVersion, and name, with optional description and tags. The associated dataSourceId cannot be changed after creation. Returns the updated DataTable object with all fields including the new lockVersion and lastModified audit information.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_table_id
|
StrictInt
|
Unique identifier of the DataTable to operate on (required) |
required |
update_data_table_request
|
UpdateDataTableRequest
|
Request body containing the updated configuration for an existing DataTable, including metadata changes such as name, description, and tags. The DataSource cannot be modified after creation (required) |
required |
Returns:
| Type | Description |
|---|---|
DataTableResponse
|
Returns the result object. |