DataSourceService¶
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_source
¶
Creates a new DataSource for importing data from external systems. The request body requires type (bucket/rdbms/delta_sharing), name, and connectionId, with additional type-specific fields like path for bucket sources, query and optional warehouse for RDBMS sources, or share/schema/table for delta sharing sources. Returns a DataSource response object containing the created resource with id, lockVersion, and all submitted fields plus audit information.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
create_data_source_request
|
CreateDataSourceRequest
|
Create DataSource Request (required) |
required |
Returns:
| Type | Description |
|---|---|
DataSourceResponse
|
Returns the result object. |
delete_data_source
¶
Deletes a DataSource from the workspace. This API accepts the data-source-id path parameter and permanently removes the DataSource. This operation will fail if there are DataTables currently using this DataSource. Returns 204 No Content on successful deletion or NOT_FOUND if the DataSource does not exist.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_source_id
|
StrictInt
|
Unique identifier of the DataSource to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
None
|
Returns the result object. |
get_data_source
¶
Retrieves detailed information about a specific DataSource by its ID. This API accepts the data-source-id path parameter and returns a DataSource object containing fields such as id, type, name, description, tags, connectionId, data location properties (path for bucket, query/warehouse for rdbms, or share/schema/table for delta sharing), lockVersion, and audit information (createdBy, createdDate, lastModifiedBy, lastModifiedDate). Returns NOT_FOUND if the DataSource does not exist.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_source_id
|
StrictInt
|
Unique identifier of the DataSource to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
DataSourceResponse
|
Returns the result object. |
list_data_sources
¶
Retrieves a list of all DataSources within the workspace. Returns an array of DataSource objects with fields such as id, type (bucket/rdbms/delta_sharing), name, description, tags, connectionId, data location properties (path for bucket, query for rdbms, or share/schema/table for delta sharing), lockVersion, and audit information (createdBy, createdDate, lastModifiedBy, lastModifiedDate).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
list_query
|
Optional[ListQuery]
|
List query parameters |
None
|
Returns:
| Type | Description |
|---|---|
DataSourcesResponse
|
Returns the result object. |
update_data_source
¶
Updates the configuration of an existing DataSource. The request body requires id, lockVersion, type, name, connectionId, and type-specific fields (path for bucket, query for rdbms, or share/schema/table for delta sharing), with optional description and tags. Returns the updated DataSource object with all fields including the new lockVersion and lastModified audit information.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_source_id
|
StrictInt
|
Unique identifier of the DataSource to operate on (required) |
required |
update_data_source_request
|
UpdateDataSourceRequest
|
Update DataSource Request (required) |
required |
Returns:
| Type | Description |
|---|---|
DataSourceResponse
|
Returns the result object. |