diff --git a/snippets/destination_connectors/databricks_volumes_rest_create.mdx b/snippets/destination_connectors/databricks_volumes_rest_create.mdx index 251119db..da5d3a70 100644 --- a/snippets/destination_connectors/databricks_volumes_rest_create.mdx +++ b/snippets/destination_connectors/databricks_volumes_rest_create.mdx @@ -14,8 +14,13 @@ curl --request 'POST' --location \ "schema": "", "volume": "", "volume_path": "", + + # For Databricks OAuth machine-to-machine (M2M) authentication: "client_secret": "", "client_id": "" + + # For Databricks personal access token authentication: + "token": "" } }' ``` \ No newline at end of file diff --git a/snippets/destination_connectors/databricks_volumes_sdk.mdx b/snippets/destination_connectors/databricks_volumes_sdk.mdx index 7631d861..acf4cd37 100644 --- a/snippets/destination_connectors/databricks_volumes_sdk.mdx +++ b/snippets/destination_connectors/databricks_volumes_sdk.mdx @@ -21,8 +21,13 @@ with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as clien schema="", volume="", volume_path="", + + # For Databricks OAuth machine-to-machine (M2M) authentication: client_secret="", client_id="" + + # For Databricks personal access token authentication: + token="" ) ) ) diff --git a/snippets/general-shared-text/databricks-volumes-api-placeholders.mdx b/snippets/general-shared-text/databricks-volumes-api-placeholders.mdx index c3d4848f..dd22b80e 100644 --- a/snippets/general-shared-text/databricks-volumes-api-placeholders.mdx +++ b/snippets/general-shared-text/databricks-volumes-api-placeholders.mdx @@ -1,7 +1,10 @@ - `` (_required_) - A unique name for this connector. - `` (_required_) - The Databricks workspace host URL. -- `` (_required_) - The **Client ID** (or **UUID** or **Application ID**) value for the Databricks managed service principal that has the appropriate privileges to the volume. -- `` (_required_) - The associated OAuth **Secret** value for the Databricks managed service principal that has the appropriate privileges to the volume. +- `` (_required_) - For Databricks OAuth machine-to-machine (M2M) authentication, + the **Client ID** (or **UUID** or **Application ID**) value for the Databricks managed service principal that has the appropriate privileges to the volume. +- `` (_required_) - For Databricks OAuth M2M authentication, + the associated OAuth **Secret** value for the Databricks managed service principal that has the appropriate privileges to the volume. +- `` (_required_) - For Databricks personal access token authentication, the personal access token's value. - `` (_required_) - The name of the catalog to use. - `` - The name of the associated schema. If not specified, `default` is used. - `` (_required_) - The name of the associated volume. diff --git a/snippets/general-shared-text/databricks-volumes-platform.mdx b/snippets/general-shared-text/databricks-volumes-platform.mdx index e9829256..970a0a9d 100644 --- a/snippets/general-shared-text/databricks-volumes-platform.mdx +++ b/snippets/general-shared-text/databricks-volumes-platform.mdx @@ -6,6 +6,10 @@ Fill in the following fields: - **Schema** : The name of the associated schema. If not specified, **default** is used. - **Volume** (_required_): The name of the associated volume. - **Volume Path** : Any optional path to access within the volume. -- **Client Secret** (_required_): The associated OAuth **Secret** value for the Databricks managed service principal that has the appropriate privileges to the volume. -- **Client ID** (_required_): The **Client ID** (or **UUID** or **Application ID**) value for the Databricks managed service principal that has appropriate privileges to the volume. +- For **Authentication Method**, if you select **Service Principal**, you must also specify the following: + + - **Client Secret** (_required_): The associated OAuth **Secret** value for the Databricks managed service principal that has the appropriate privileges to the volume. + - **Client ID** (_required_): The **Client ID** (or **UUID** or **Application ID**) value for the Databricks managed service principal that has appropriate privileges to the volume. + +- For **Authentication Method**, if you select **Token**, you must also specify the Databricks personal access token's value in the **Token** field. diff --git a/snippets/general-shared-text/databricks-volumes.mdx b/snippets/general-shared-text/databricks-volumes.mdx index 81c875a5..5725399d 100644 --- a/snippets/general-shared-text/databricks-volumes.mdx +++ b/snippets/general-shared-text/databricks-volumes.mdx @@ -20,25 +20,47 @@ [Azure](https://learn.microsoft.com/azure/databricks/dev-tools/auth/), or [GCP](https://docs.gcp.databricks.com/dev-tools/auth/index.html). - For the [Unstructured UI](/ui/overview) or the [Unstructured API](/api-reference/overview), only Databricks OAuth machine-to-machine (M2M) authentication is supported for - [AWS](https://docs.databricks.com/dev-tools/auth/oauth-m2m.html), - [Azure](https://learn.microsoft.com/azure/databricks/dev-tools/auth/oauth-m2m), and - [GCP](https://docs.gcp.databricks.com/dev-tools/auth/oauth-m2m.html). - You will need the the **Client ID** (or **UUID** or **Application** ID) and OAuth **Secret** (client secret) values for the corresponding service principal. - Note that for Azure, only Databricks managed service principals are supported. Microsoft Entra ID managed service principals are not supported. + For the [Unstructured UI](/ui/overview) or the [Unstructured API](/api-reference/overview), the following Databricks authentication types are supported: + + - Databricks OAuth machine-to-machine (M2M) authentication for + [AWS](https://docs.databricks.com/dev-tools/auth/oauth-m2m.html), + [Azure](https://learn.microsoft.com/azure/databricks/dev-tools/auth/oauth-m2m), or + [GCP](https://docs.gcp.databricks.com/dev-tools/auth/oauth-m2m.html). + + You will need the the **Client ID** (or **UUID** or **Application** ID) and OAuth **Secret** (client secret) values for the corresponding service principal. + Note that for Azure, only Databricks managed service principals are supported. Microsoft Entra ID managed service principals are not supported. - The following video shows how to create a Databricks managed service principal: + The following video shows how to create a Databricks managed service principal: - + + - Databricks personal access token authentication for + [AWS](https://docs.databricks.com/dev-tools/auth/pat.html), + [Azure](https://learn.microsoft.com/azure/databricks/dev-tools/auth/pat), or + [GCP](https://docs.gcp.databricks.com/dev-tools/auth/pat.html). + + You will need the personal access token's value. + + The following video shows how to create a Databricks personal access token: + + + For [Unstructured Ingest](/ingestion/overview), the following Databricks authentication types are supported: - For Databricks personal access token authentication for diff --git a/snippets/source_connectors/databricks_volumes_rest_create.mdx b/snippets/source_connectors/databricks_volumes_rest_create.mdx index f96e5c8e..4a368a6d 100644 --- a/snippets/source_connectors/databricks_volumes_rest_create.mdx +++ b/snippets/source_connectors/databricks_volumes_rest_create.mdx @@ -10,12 +10,17 @@ curl --request 'POST' --location \ "type": "databricks_volumes", "config": { "host": "", - "client_id": "" - "client_secret": "", "catalog": "", "schema": "", "volume": "", - "volume_path": "" + "volume_path": "", + + # For Databricks OAuth machine-to-machine (M2M) authentication: + "client_id": "" + "client_secret": "" + + # For Databricks personal access token authentication: + "token": "" } }' ``` \ No newline at end of file diff --git a/snippets/source_connectors/databricks_volumes_sdk.mdx b/snippets/source_connectors/databricks_volumes_sdk.mdx index 9a71b57c..fd4b3e35 100644 --- a/snippets/source_connectors/databricks_volumes_sdk.mdx +++ b/snippets/source_connectors/databricks_volumes_sdk.mdx @@ -17,12 +17,17 @@ with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as clien type=SourceConnectorType.DATABRICKS_VOLUMES, config=DatabricksVolumesConnectorConfigInput( catalog="", - client_id="", - client_secret="", host="", schema_="", volume="", - volume_path="" + volume_path="", + + # For Databricks OAuth machine-to-machine (M2M) authentication: + client_id="", + client_secret="" + + # For Databricks personal access token authentication: + token="" ) ) )