Skip to content

Commit fc3d600

Browse files
claudespicelukekim
claudespice
authored and
lukekim
committed
fix: Add missing sql_warehouse mode to Databricks v1.10.x and v1.11.x docs
The versioned Databricks docs only listed spark_connect and delta_lake as valid modes, but sql_warehouse existed in both v1.10 and v1.11 releases. The mode parameter description, endpoint description, and client_timeout applicability were all incomplete.
1 parent bb1c00a commit fc3d600

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

  • website/versioned_docs

‎website/versioned_docs/version-1.10.x/components/data-connectors/databricks.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,12 @@ Use the [secret replacement syntax](../secret-stores) to reference a secret, e.g
6262

6363
| Parameter Name | Description |
6464
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
65-
| `mode` | The execution mode for querying against Databricks. The default is `spark_connect`. Possible values:<br /> <ul><li>`spark_connect`: Use Spark Connect to query against Databricks. Requires a Spark cluster to be available.</li><li>`delta_lake`: Query directly from Delta Tables. Requires the object store credentials to be provided.</li></ul> |
66-
| `databricks_endpoint` | The endpoint of the Databricks instance. Required for both modes. |
65+
| `mode` | The execution mode for querying against Databricks. The default is `spark_connect`. Possible values:<br /> <ul><li>`spark_connect`: Use Spark Connect to query against Databricks. Requires a Spark cluster to be available.</li><li>`delta_lake`: Query directly from Delta Tables. Requires the object store credentials to be provided.</li><li>`sql_warehouse`: Query through a Databricks SQL Warehouse. Requires `databricks_sql_warehouse_id`.</li></ul> |
66+
| `databricks_endpoint` | The endpoint of the Databricks instance. Required for all modes. |
6767
| `databricks_sql_warehouse_id` | The ID of the SQL Warehouse in Databricks to use for the query. Only valid when `mode` is `sql_warehouse`. |
6868
| `databricks_cluster_id` | The ID of the compute cluster in Databricks to use for the query. Only valid when `mode` is `spark_connect`. |
6969
| `databricks_use_ssl` | If true, use a TLS connection to connect to the Databricks endpoint. Default is `true`. |
70-
| `client_timeout` | Optional. Applicable only in `delta_lake` mode. Specifies timeout for object store operations. Default value is `30s` E.g. `client_timeout: 60s` |
70+
| `client_timeout` | Optional. Specifies timeout for operations. In `delta_lake` mode, applies to object store operations. In `sql_warehouse` mode, applies per-HTTP-call. Default value is `30s`. E.g. `client_timeout: 60s` |
7171
| `databricks_token` | The Databricks API token to authenticate with the Unity Catalog API. Can't be used with `databricks_client_id` and `databricks_client_secret`. |
7272
| `databricks_client_id` | The Databricks Service Principal Client ID. Can't be used with `databricks_token`. |
7373
| `databricks_client_secret` | The Databricks Service Principal Client Secret. Can't be used with `databricks_token`. |

‎website/versioned_docs/version-1.11.x/components/data-connectors/databricks.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,12 @@ Use the [secret replacement syntax](../secret-stores/) to reference a secret, e.
6262

6363
| Parameter Name | Description |
6464
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
65-
| `mode` | The execution mode for querying against Databricks. The default is `spark_connect`. Possible values:<br /> <ul><li>`spark_connect`: Use Spark Connect to query against Databricks. Requires a Spark cluster to be available.</li><li>`delta_lake`: Query directly from Delta Tables. Requires the object store credentials to be provided.</li></ul> |
66-
| `databricks_endpoint` | The endpoint of the Databricks instance. Required for both modes. |
65+
| `mode` | The execution mode for querying against Databricks. The default is `spark_connect`. Possible values:<br /> <ul><li>`spark_connect`: Use Spark Connect to query against Databricks. Requires a Spark cluster to be available.</li><li>`delta_lake`: Query directly from Delta Tables. Requires the object store credentials to be provided.</li><li>`sql_warehouse`: Query through a Databricks SQL Warehouse. Requires `databricks_sql_warehouse_id`.</li></ul> |
66+
| `databricks_endpoint` | The endpoint of the Databricks instance. Required for all modes. |
6767
| `databricks_sql_warehouse_id` | The ID of the SQL Warehouse in Databricks to use for the query. Only valid when `mode` is `sql_warehouse`. |
6868
| `databricks_cluster_id` | The ID of the compute cluster in Databricks to use for the query. Only valid when `mode` is `spark_connect`. |
6969
| `databricks_use_ssl` | If true, use a TLS connection to connect to the Databricks endpoint. Default is `true`. |
70-
| `client_timeout` | Optional. Applicable only in `delta_lake` mode. Specifies timeout for object store operations. Default value is `30s` E.g. `client_timeout: 60s` |
70+
| `client_timeout` | Optional. Specifies timeout for operations. In `delta_lake` mode, applies to object store operations. In `sql_warehouse` mode, applies per-HTTP-call. Default value is `30s`. E.g. `client_timeout: 60s` |
7171
| `databricks_token` | The Databricks API token to authenticate with the Unity Catalog API. Can't be used with `databricks_client_id` and `databricks_client_secret`. |
7272
| `databricks_client_id` | The Databricks Service Principal Client ID. Can't be used with `databricks_token`. |
7373
| `databricks_client_secret` | The Databricks Service Principal Client Secret. Can't be used with `databricks_token`. |

0 commit comments

Comments
 (0)