ConnectionService¶
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 |
browse_bucket_data_source
¶
Browses the contents of a bucket DataSource at the specified path. This API accepts the connection-id path parameter, optional browse-limit query parameter, and a request body with the path field. Returns a response containing folders array, files array (each with bucket, relativePath, and fileName), and metadata object (protocol, reachedLimit). This helps users explore storage structure before configuring DataSources.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
browse_bucket_data_source_request
|
BrowseBucketDataSourceRequest
|
Browse Bucket DataSource Request (required) |
required |
browse_limit
|
Optional[conint(strict=True, le=1000, ge=1)]
|
Maximum number of objects to retrieve in the browse operation |
None
|
Returns:
| Type | Description |
|---|---|
BrowseBucketDataSourceResponse
|
Returns the result object. |
create_connection
¶
Creates a new Connection for authenticating to external data systems. The request body requires type (s3/snowflake/delta_sharing/priceit_dim), name, and type-specific auth object, with optional description, tags, read/write permissions, and type-specific properties. Returns a Connection response object containing the created resource with id, lockVersion, and all submitted fields plus audit information.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
create_connection_request
|
CreateConnectionRequest
|
Create Connection Request (required) |
required |
Returns:
| Type | Description |
|---|---|
ConnectionResponse
|
Returns the result object. |
delete_connection
¶
Deletes a Connection from the workspace. This API accepts the connection-id path parameter and permanently removes the Connection. This operation will fail if there are DataSources or DataTargets currently using this Connection. Returns 204 No Content on successful deletion or NOT_FOUND if the Connection does not exist.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
None
|
Returns the result object. |
delete_connection_type_mapping
¶
Removes the type-mapping configuration from a Price-It DIM Connection. This clears both the typeMapping and typeMappingName fields. Returns the updated Connection object with null typeMapping and typeMappingName.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
ConnectionResponse
|
Returns the result object. |
get_connection
¶
Retrieves detailed information about a specific Connection by its ID. This API accepts the connection-id path parameter and returns a Connection object containing fields such as id, type, name, description, tags, read/write permissions, authentication details (authType with credentials), type-specific properties, lockVersion, and audit information (createdBy, createdDate, lastModifiedBy, lastModifiedDate). Returns NOT_FOUND if the Connection does not exist.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
ConnectionResponse
|
Returns the result object. |
is_connection_name_available
¶
Checks if a Connection 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 Connections.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
constr(strict=True, min_length=1)
|
The proposed name for the Connection to check for availability (case-insensitive) (required) |
required |
Returns:
| Type | Description |
|---|---|
bool
|
Returns the result object. |
list_connections
¶
Retrieves a list of all Connections within the workspace for external data system authentication. Returns an array of Connection objects with fields such as id, type (s3/snowflake/delta_sharing/priceit_dim), name, description, tags, read/write permissions, authentication details, type-specific properties (pathRestriction for S3, database/schema/warehouse for Snowflake), lockVersion, and audit information.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
list_query
|
Optional[ListQuery]
|
List query parameters |
None
|
Returns:
| Type | Description |
|---|---|
ConnectionsResponse
|
Returns the result object. |
list_deltasharing_schema_tables
¶
Retrieves a list of all available tables in a specific schema for a given share of a Delta Sharing Connection. This API accepts connection-id, share, and schema path parameters and returns an array of table names (strings). This helps users identify the specific tables to import when configuring Delta Sharing DataSources.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
share
|
StrictStr
|
The name of the Deltasharing Share (required) |
required |
var_schema
|
StrictStr
|
The name of the schema within the Deltasharing Share (required) |
required |
Returns:
| Type | Description |
|---|---|
List[str]
|
Returns the result object. |
list_deltasharing_schemas
¶
Retrieves a list of all available schemas within a specific share of a Delta Sharing Connection. This API accepts connection-id and share path parameters and returns an array of schema names (strings) within that share. This helps users navigate the data hierarchy when configuring Delta Sharing DataSources.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
share
|
StrictStr
|
The name of the Deltasharing Share (required) |
required |
Returns:
| Type | Description |
|---|---|
List[str]
|
Returns the result object. |
list_deltasharing_shares
¶
Retrieves a list of all available Shares in a Delta Sharing Connection. This API accepts the connection-id path parameter and returns an array of share names (strings) accessible through the connection. This helps users browse the available shared data resources when configuring Delta Sharing DataSources.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
List[str]
|
Returns the result object. |
list_tables
¶
Retrieves a list of all accessible tables and views in a Connection. This API accepts the connection-id path parameter and returns an array of TableDetails objects containing database, schema, and table name fields. This helps users browse available data sources and select tables for importing when configuring DataSources.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
List[TableDetailsResponse]
|
Returns the result object. |
list_warehouses
¶
Retrieves a list of all available warehouses for a Snowflake Connection. This API accepts the connection-id path parameter and returns an array of warehouse names (strings) that can be used for query execution and data processing operations. This helps users discover available compute resources when configuring DataSources.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
Returns:
| Type | Description |
|---|---|
List[str]
|
Returns the result object. |
merge_connection
¶
Partially updates a Connection by applying only the provided fields. The request body requires id, lockVersion, and type, with optional fields including name, description, tags, authentication details, and type-specific properties. This API uses merge-patch semantics and returns the updated Connection object with all fields including the new lockVersion and lastModified audit information.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
merge_connection_request
|
MergeConnectionRequest
|
Merge Connection Request (required) |
required |
Returns:
| Type | Description |
|---|---|
ConnectionResponse
|
Returns the result object. |
test_connection
¶
Tests a Connection configuration before creating it. The request body requires type and type-specific authentication object (auth) with properties like endpoint/credentials for S3, or host/username/password for Snowflake. Returns an empty response on successful connection or an error detailing connectivity issues. This allows validation before creating the Connection resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
test_connection_request
|
TestConnectionRequest
|
Test Connection Request (required) |
required |
Returns:
| Type | Description |
|---|---|
None
|
Returns the result object. |
test_connection_by_id
¶
Tests the connectivity of an existing Connection using its stored configuration. This API accepts the connection-id path parameter and an optional request body with type and type-specific override parameters. Returns an empty response on successful connection or an error detailing the connectivity issue. This allows validation of Connection settings before applying changes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
test_updated_connection_request
|
Optional[TestUpdatedConnectionRequest]
|
Test Updated Connection Request - validates connectivity using current stored configuration with optional parameter overrides |
None
|
Returns:
| Type | Description |
|---|---|
None
|
Returns the result object. |
test_rdbms_data_source
¶
Tests an RDBMS DataSource configuration by executing the provided SQL query. This API accepts the connection-id path parameter and a request body containing the query field (and optional warehouse). Returns an empty response if the query executes successfully or an error detailing validation issues. This helps verify DataSource settings before creating or updating them.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
test_rdbms_data_source_request
|
TestRDBMSDataSourceRequest
|
Test RDBMS DataSource Request (required) |
required |
Returns:
| Type | Description |
|---|---|
None
|
Returns the result object. |
update_connection
¶
Completely updates an existing Connection configuration. The request body requires id, lockVersion, type, name, and type-specific auth object, with optional description, tags, and type-specific properties. Returns the updated Connection object with all fields including the new lockVersion and lastModified audit information.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
update_connection_request
|
UpdateConnectionRequest
|
Update Connection Request (required) |
required |
Returns:
| Type | Description |
|---|---|
ConnectionResponse
|
Returns the result object. |
update_connection_type_mapping
¶
Updates the type-mapping configuration for a Price-It DIM Connection. The request body requires id, lockVersion, and typeMapping object (key-value pairs mapping source column names to Price-It target types). Returns the updated Connection object with the modified typeMapping. This operation is only available to users with the relevant feature permission.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_id
|
StrictInt
|
Unique identifier of the Connection to operate on (required) |
required |
update_connection_type_mapping_request
|
UpdateConnectionTypeMappingRequest
|
Update Connection Type-Mapping Request (required) |
required |
Returns:
| Type | Description |
|---|---|
ConnectionResponse
|
Returns the result object. |