From 4dd3236e405bf89c5280f9bbe048660345baf93f Mon Sep 17 00:00:00 2001 From: Paul Cornell Date: Fri, 21 Mar 2025 11:11:21 -0700 Subject: [PATCH] Multiple connectors: replace dashes with underscores in catalog, schema, table, and volume names and paths --- .../databricks_delta_table_rest_create.mdx | 4 ++-- .../databricks_delta_table_sdk.mdx | 4 ++-- .../databricks_volumes_rest_create.mdx | 2 +- .../databricks_volumes_sdk.mdx | 2 +- .../postgresql_rest_create.mdx | 2 +- snippets/destination_connectors/postgresql_sdk.mdx | 2 +- .../destination_connectors/snowflake_rest_create.mdx | 2 +- snippets/destination_connectors/snowflake_sdk.mdx | 2 +- .../databricks-delta-table-api-placeholders.mdx | 9 ++++++--- .../databricks-delta-table-cli-api.mdx | 5 +++++ .../databricks-delta-table-platform.mdx | 5 +++++ .../general-shared-text/databricks-delta-table.mdx | 12 +++++++++++- .../databricks-volumes-api-placeholders.mdx | 7 ++++++- .../databricks-volumes-cli-api.mdx | 5 +++++ .../databricks-volumes-platform.mdx | 5 +++++ snippets/general-shared-text/databricks-volumes.mdx | 4 ++++ snippets/general-shared-text/duckdb.mdx | 6 +++--- snippets/general-shared-text/motherduck.mdx | 6 +++--- .../postgresql-api-placeholders.mdx | 2 +- .../snowflake-api-placeholders.mdx | 2 +- snippets/general-shared-text/snowflake.mdx | 4 ++-- .../databricks_volumes_rest_create.mdx | 2 +- .../source_connectors/postgresql_rest_create.mdx | 2 +- snippets/source_connectors/postgresql_sdk.mdx | 2 +- snippets/source_connectors/snowflake_rest_create.mdx | 2 +- snippets/source_connectors/snowflake_sdk.mdx | 2 +- 26 files changed, 72 insertions(+), 30 deletions(-) diff --git a/snippets/destination_connectors/databricks_delta_table_rest_create.mdx b/snippets/destination_connectors/databricks_delta_table_rest_create.mdx index baab508e..e70ac572 100644 --- a/snippets/destination_connectors/databricks_delta_table_rest_create.mdx +++ b/snippets/destination_connectors/databricks_delta_table_rest_create.mdx @@ -16,10 +16,10 @@ curl --request 'POST' --location \ "client_secret": "", "volume": "", "catalog": "", - "volume_path": "", + "volume_path": "", "schema": "", "database": "", - "table_name": "" + "table_name": "" } }' ``` \ No newline at end of file diff --git a/snippets/destination_connectors/databricks_delta_table_sdk.mdx b/snippets/destination_connectors/databricks_delta_table_sdk.mdx index 27777143..465eb33c 100644 --- a/snippets/destination_connectors/databricks_delta_table_sdk.mdx +++ b/snippets/destination_connectors/databricks_delta_table_sdk.mdx @@ -23,10 +23,10 @@ with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as clien client_secret="", volume="", catalog="", - volume_path="", + volume_path="", schema="", database="", - table_name="" + table_name="" ) ) ) diff --git a/snippets/destination_connectors/databricks_volumes_rest_create.mdx b/snippets/destination_connectors/databricks_volumes_rest_create.mdx index da5d3a70..a1a37ac7 100644 --- a/snippets/destination_connectors/databricks_volumes_rest_create.mdx +++ b/snippets/destination_connectors/databricks_volumes_rest_create.mdx @@ -13,7 +13,7 @@ curl --request 'POST' --location \ "catalog": "", "schema": "", "volume": "", - "volume_path": "", + "volume_path": "", # For Databricks OAuth machine-to-machine (M2M) authentication: "client_secret": "", diff --git a/snippets/destination_connectors/databricks_volumes_sdk.mdx b/snippets/destination_connectors/databricks_volumes_sdk.mdx index acf4cd37..a70e2f89 100644 --- a/snippets/destination_connectors/databricks_volumes_sdk.mdx +++ b/snippets/destination_connectors/databricks_volumes_sdk.mdx @@ -20,7 +20,7 @@ with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as clien catalog="", schema="", volume="", - volume_path="", + volume_path="", # For Databricks OAuth machine-to-machine (M2M) authentication: client_secret="", diff --git a/snippets/destination_connectors/postgresql_rest_create.mdx b/snippets/destination_connectors/postgresql_rest_create.mdx index e23e5ac8..f0975d97 100644 --- a/snippets/destination_connectors/postgresql_rest_create.mdx +++ b/snippets/destination_connectors/postgresql_rest_create.mdx @@ -14,7 +14,7 @@ curl --request 'POST' --location \ "port": "", "username": "", "password": "", - "table_name": "", + "table_name": "", "batch_size": } }' diff --git a/snippets/destination_connectors/postgresql_sdk.mdx b/snippets/destination_connectors/postgresql_sdk.mdx index 65d4bfa1..b7bd5adb 100644 --- a/snippets/destination_connectors/postgresql_sdk.mdx +++ b/snippets/destination_connectors/postgresql_sdk.mdx @@ -21,7 +21,7 @@ with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as clien port="", username="", password="", - table_name="", + table_name="", batch_size= ) ) diff --git a/snippets/destination_connectors/snowflake_rest_create.mdx b/snippets/destination_connectors/snowflake_rest_create.mdx index 31c6b971..88525df7 100644 --- a/snippets/destination_connectors/snowflake_rest_create.mdx +++ b/snippets/destination_connectors/snowflake_rest_create.mdx @@ -18,7 +18,7 @@ curl --request 'POST' --location \ "role": "", "password": "", "record_id_key": "", - "table_name": "", + "table_name": "", "batch_size": } }' diff --git a/snippets/destination_connectors/snowflake_sdk.mdx b/snippets/destination_connectors/snowflake_sdk.mdx index ec5f8c0a..8ed90260 100644 --- a/snippets/destination_connectors/snowflake_sdk.mdx +++ b/snippets/destination_connectors/snowflake_sdk.mdx @@ -25,7 +25,7 @@ with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as clien role="", password="", record_id_key="", - table_name="", + table_name="", batch_size= ) ) diff --git a/snippets/general-shared-text/databricks-delta-table-api-placeholders.mdx b/snippets/general-shared-text/databricks-delta-table-api-placeholders.mdx index 2c7c95da..7693e473 100644 --- a/snippets/general-shared-text/databricks-delta-table-api-placeholders.mdx +++ b/snippets/general-shared-text/databricks-delta-table-api-placeholders.mdx @@ -8,13 +8,16 @@ If the target table and volume are in the same schema (formerly known as a database), then `` and `` will have the same values. -- `` (_required_): The name of the target table in Unity Catalog. +- `` (_required_): The name of the target table in Unity Catalog. - ``: The name of the schema (formerly known as a database) in Unity Catalog for the target volume. The default is `default` if not otherwise specified. If the target volume and table are in the same schema (formerly known as a database), then `` and `` will have the same values. - `` (_required_): The name of the target volume in Unity Catalog. -- ``: Any target folder path inside of the volume to use instead of the volume's root. If not otherwise specified, processing occurs at the volume's root. - +- ``: Any target folder path inside of the volume to use instead of the volume's root. If not otherwise specified, processing occurs at the volume's root. + + Using dashes (`-`) in the names of catalogs, schemas (formerly known as databases), tables, and volumes might cause isolated issues with the connector. It is + recommended to use underscores (`_`) instead of dashes in the names of catalogs, schemas, tables, and volumes. + diff --git a/snippets/general-shared-text/databricks-delta-table-cli-api.mdx b/snippets/general-shared-text/databricks-delta-table-cli-api.mdx index ff71233e..9adae486 100644 --- a/snippets/general-shared-text/databricks-delta-table-cli-api.mdx +++ b/snippets/general-shared-text/databricks-delta-table-cli-api.mdx @@ -22,6 +22,11 @@ The following environment variables: - `DATABRICKS_TABLE` - The name of the table inside of the schema (formerly known as a database), represented by `--table-name` (CLI) or `table_name` (Python). The default is `elements` if not otherwise specified. + + Using dashes (`-`) in the names of catalogs, schemas (formerly known as databases), tables, and volumes might cause isolated issues with the connector. It is + recommended to use underscores (`_`) instead of dashes in the names of catalogs, schemas, tables, and volumes. + + For the SQL-based implementation, add these environment variables: - `DATABRICKS_RECORD_ID_KEY` - The name of the column that uniquely identifies each record in the table, represented by `--record-id-key` (CLI) or `record_id_key` (Python). diff --git a/snippets/general-shared-text/databricks-delta-table-platform.mdx b/snippets/general-shared-text/databricks-delta-table-platform.mdx index 4805157a..9d0509eb 100644 --- a/snippets/general-shared-text/databricks-delta-table-platform.mdx +++ b/snippets/general-shared-text/databricks-delta-table-platform.mdx @@ -17,3 +17,8 @@ Fill in the following fields: - **Volume** (_required_): The name of the target volume in Unity Catalog. - **Volume Path**: Any target folder path inside of the volume to use instead of the volume's root. If not otherwise specified, processing occurs at the volume's root. + + + Using dashes (`-`) in the names of catalogs, schemas (formerly known as databases), tables, and volumes might cause isolated issues with the connector. It is + recommended to use underscores (`_`) instead of dashes in the names of catalogs, schemas, tables, and volumes. + \ No newline at end of file diff --git a/snippets/general-shared-text/databricks-delta-table.mdx b/snippets/general-shared-text/databricks-delta-table.mdx index 1eac668a..39978d18 100644 --- a/snippets/general-shared-text/databricks-delta-table.mdx +++ b/snippets/general-shared-text/databricks-delta-table.mdx @@ -61,6 +61,11 @@ [GCP](https://docs.gcp.databricks.com/tables/managed.html) within that schema (formerly known as a database). + + Using dashes (`-`) in the names of catalogs, schemas (formerly known as databases), and tables might cause isolated issues with the connector. It is + recommended to use underscores (`_`) instead of dashes in the names of catalogs, schemas, and tables. + + The following video shows how to create a catalog, schema (formerly known as a database), and a table in Unity Catalog if you do not already have them available, and set privileges for someone other than their owner to use them: