Azure Databricks (Preview)
Databricks offers a unified platform for scalable data management, governance, and analytics, combining streamlined workflows with the ability to handle diverse data types efficiently
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Databricks Support |
| URL | https://help.databricks.com |
| eng-partner-eco-help@databricks.com |
| Connector Metadata | |
|---|---|
| Publisher | Databricks Inc. |
| Website | https://www.databricks.com/ |
| Privacy policy | https://www.databricks.com/legal/privacynotice |
| Categories | Data |
Databricks
Databricks offers a unified platform for scalable data management, governance, and analytics, combining streamlined workflows with the ability to handle diverse data types efficiently.
Prerequisite
- Users must have Microsoft Entra ID for the external authentication.
- Users must have a premium Power Apps license.
- Users must have Databricks account.
- Unity catalog must be enabled in the Databricks Workspace
Supported authentication
- Microsoft Entra ID U2M
- Microsoft Entra ID M2M: Service Principal
Support features and limitations
- Query Table Data: Retrieve data from your Databricks tables
- Create Rows: Add new rows to your Databricks tables
- Read/Update/Delete Rows: Perform operations on individual rows in the Databricks tables (requires the table to have primary keys).
- Execute SQL statement: Execute a SQL statement and get the statement status and result, you can also cancel the execution.
Creating a connection
The connector supports the following authentication types:
| OAuth Connection | OAuth Connection | All regions | Not shareable |
| Service Principal Connection | Service Principal Connection | All regions | Shareable |
| Default [DEPRECATED] | This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility. | All regions | Not shareable |
OAuth Connection
Auth ID: oauth2-auth
Applicable: All regions
OAuth Connection
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Server Hostname (Example: adb-3980263885549757139.2.azuredatabricks.net) | string | Server name of Databricks workspace | True |
| HTTP Path (Example: /sql/1.0/warehouses/a9c4e781bd29f315) | string | HTTP Path of Databricks SQL Warehouse | True |
Service Principal Connection
Auth ID: oAuthClientCredentials
Applicable: All regions
Service Principal Connection
This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs
| Name | Type | Description | Required |
|---|---|---|---|
| Client ID | string | True | |
| Client Secret | securestring | True | |
| Tenant | string | True | |
| Server Hostname (Example: adb-3980263885549757139.2.azuredatabricks.net) | string | Server name of Databricks workspace | True |
| HTTP Path (Example: /sql/1.0/warehouses/a9c4e781bd29f315) | string | HTTP Path of Databricks SQL Warehouse | True |
Default [DEPRECATED]
Applicable: All regions
This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Cancel statement execution |
Requests that an executing statement be canceled. Callers must poll for status to see the terminal state. |
| Check status and get results |
Get the status, manifest and results of the statement |
| Execute a SQL statement |
Execute a SQL statement and optionally await its results for a specified time. |
| Get result by chunk index |
After the statement execution has SUCCEEDED, this request can be used to fetch any chunk by index. |
Cancel statement execution
Requests that an executing statement be canceled. Callers must poll for status to see the terminal state.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Statement ID
|
statement_id | True | string |
Statement ID |
Check status and get results
Get the status, manifest and results of the statement
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Statement ID
|
statement_id | True | string |
Statement ID |
Returns
Statement execution response
- Body
- SqlStatementResponse
Execute a SQL statement
Execute a SQL statement and optionally await its results for a specified time.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
warehouse_id
|
warehouse_id | True | string |
Target warehouse ID |
|
statement
|
statement | True | string |
The SQL statement to execute. The statement can optionally be parameterized, see parameters |
|
name
|
name | True | string |
Parameter marker name |
|
type
|
type | string |
Parameter data type |
|
|
value
|
value | string |
Parameter value |
|
|
catalog
|
catalog | string |
Default catalog for execution |
|
|
schema
|
schema | string |
Default schema for execution |
|
|
disposition
|
disposition | string |
Result fetching mode |
|
|
format
|
format | string |
Result set format |
|
|
on_wait_timeout
|
on_wait_timeout | string |
Action on timeout |
|
|
wait_timeout
|
wait_timeout | string |
Result wait timeout |
|
|
byte_limit
|
byte_limit | integer |
Result byte limit |
|
|
row_limit
|
row_limit | integer |
Result row limit |
Returns
Statement execution response
- Body
- SqlStatementResponse
Get result by chunk index
After the statement execution has SUCCEEDED, this request can be used to fetch any chunk by index.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Statement ID
|
statement_id | True | string |
Statement ID |
|
Chunk index
|
chunk_index | True | string |
Chunk index |
Returns
- Body
- SqlResultData
Definitions
SqlBaseChunkInfo
Metadata for a result set chunk
| Name | Path | Type | Description |
|---|---|---|---|
|
byte_count
|
byte_count | integer |
Number of bytes in the result chunk |
|
chunk_index
|
chunk_index | integer |
Position in the sequence of result set chunks |
|
row_count
|
row_count | integer |
Number of rows in the result chunk |
|
row_offset
|
row_offset | integer |
Starting row offset in the result set |
SqlColumnInfo
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
Column name |
|
position
|
position | integer |
Column position (0-based) |
|
type_interval_type
|
type_interval_type | string |
Interval type format |
|
type_name
|
type_name | SqlColumnInfoTypeName |
The name of the base data type. This doesn't include details for complex types such as STRUCT, MAP or ARRAY. |
|
type_precision
|
type_precision | integer |
Number of digits for DECIMAL type |
|
type_scale
|
type_scale | integer |
Number of decimal places for DECIMAL type |
|
type_text
|
type_text | string |
Full SQL type specification |
SqlColumnInfoTypeName
The name of the base data type. This doesn't include details for complex types such as STRUCT, MAP or ARRAY.
The name of the base data type. This doesn't include details for complex types such as STRUCT, MAP or ARRAY.
SqlStatementResponse
Statement execution response
| Name | Path | Type | Description |
|---|---|---|---|
|
manifest
|
manifest | SqlResultManifest |
Result set schema and metadata |
|
result
|
result | SqlResultData | |
|
statement_id
|
statement_id | string |
Statement ID |
|
status
|
status | SqlStatementStatus |
Statement execution status |
SqlResultManifest
Result set schema and metadata
| Name | Path | Type | Description |
|---|---|---|---|
|
chunks
|
chunks | array of SqlBaseChunkInfo |
Result chunk metadata |
|
format
|
format | string | |
|
schema
|
schema | SqlResultSchema |
Result set column definitions |
|
total_byte_count
|
total_byte_count | integer |
Total bytes in result set |
|
total_chunk_count
|
total_chunk_count | integer |
Total number of chunks |
|
total_row_count
|
total_row_count | integer |
Total number of rows |
|
truncated
|
truncated | boolean |
Result truncation status |
SqlStatementStatus
Statement execution status
| Name | Path | Type | Description |
|---|---|---|---|
|
error
|
error | SqlServiceError | |
|
state
|
state | SqlStatementState |
Statement execution state |
SqlStatementState
SqlServiceError
| Name | Path | Type | Description |
|---|---|---|---|
|
error_code
|
error_code | string | |
|
message
|
message | string |
Error message |
SqlResultSchema
Result set column definitions
| Name | Path | Type | Description |
|---|---|---|---|
|
column_count
|
column_count | integer | |
|
columns
|
columns | array of SqlColumnInfo |
SqlResultData
| Name | Path | Type | Description |
|---|---|---|---|
|
byte_count
|
byte_count | integer |
Bytes in result chunk |
|
chunk_index
|
chunk_index | integer |
Chunk position |
|
data_array
|
data_array | SqlJsonArray |
Array of arrays with string values |
|
external_links
|
external_links | array of SqlExternalLink | |
|
next_chunk_index
|
next_chunk_index | integer |
Next chunk index |
|
next_chunk_internal_link
|
next_chunk_internal_link | string |
Next chunk link |
|
row_count
|
row_count | integer |
Rows in chunk |
|
row_offset
|
row_offset | integer |
Starting row offset |
SqlJsonArray
Array of arrays with string values
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
array of string |
SqlExternalLink
| Name | Path | Type | Description |
|---|---|---|---|
|
byte_count
|
byte_count | integer |
Bytes in chunk |
|
chunk_index
|
chunk_index | integer |
Chunk position |
|
expiration
|
expiration | date-time |
Link expiration time |
|
external_link
|
external_link | string | |
|
http_headers
|
http_headers | object |
Required HTTP headers |
|
next_chunk_index
|
next_chunk_index | integer |
Next chunk index |
|
next_chunk_internal_link
|
next_chunk_internal_link | string |
Next chunk link |
|
row_count
|
row_count | integer |
Rows in chunk |
|
row_offset
|
row_offset | integer |
Starting row offset |