From 76214abc2bed7f1b11c6e8be9e30fcbf149c620e Mon Sep 17 00:00:00 2001 From: Jack Eadie Date: Tue, 26 Mar 2024 08:32:49 +1100 Subject: [PATCH] `databricks` as a data connector docs (#125) * databricks as a data connector docs * fix refence in YAML * fix 'from: ' --- .../content/en/data-connectors/databricks.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 spiceaidocs/content/en/data-connectors/databricks.md diff --git a/spiceaidocs/content/en/data-connectors/databricks.md b/spiceaidocs/content/en/data-connectors/databricks.md new file mode 100644 index 00000000..e7092b84 --- /dev/null +++ b/spiceaidocs/content/en/data-connectors/databricks.md @@ -0,0 +1,28 @@ +--- +type: docs +title: 'Databricks Data Connector' +linkTitle: 'Databricks Data Connector' +description: 'Databricks Data Connector Documentation' +--- + +Databricks as a connector for federated SQL query against Databrick's [Delta Lake](https://docs.databricks.com/en/delta/index.html). + +## Configuration +### Secrets +- `token`: An active personal access token for the Databricks instance (equivalent to `DATABRICKS_TOKEN`). +- Other keys provided in the secret are directly passed to the underlying object store (e.g. `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` if backed by AWS S3). + +`spice login databricks` can be used to configure secrets for the Spice runtime (including AWS object store keys). + +### Parameters +- `endpoint`: The HTTPS endpoint of the Databricks host storing the desired tables. + +## Example + +```yaml +datasets: + - from: databricks:spiceai.datasets.my_awesome_table // A reference to a table in the Databricks unity catalog + name: my_delta_lake_table + params: + endpoint: "https://dbc-a1b2345c-d6e7.cloud.databricks.com" +```