Multiple connectors: replace dashes with underscores in catalog, schema, table, and volume names and paths (#553)

Author: Paul-Cornell

snippets/destination_connectors/databricks_delta_table_rest_create.mdx

@@ -16,10 +16,10 @@ curl --request 'POST' --location \
         "client_secret": "<client-secret>",
         "volume": "<volume>",
         "catalog": "<catalog>",
-        "volume_path": "<volume-path>",
+        "volume_path": "<volume_path>",
         "schema": "<schema>",
         "database": "<database>",
-        "table_name": "<table-name>"
+        "table_name": "<table_name>"
     }
 }'
 ```

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="<client-secret>",
                     volume="<volume>",
                     catalog="<catalog>",
-                    volume_path="<volume-path>",
+                    volume_path="<volume_path>",
                     schema="<schema>",
                     database="<database>",
-                    table_name="<table-name>"
+                    table_name="<table_name>"
                 )
             )
         )

snippets/destination_connectors/databricks_volumes_rest_create.mdx

@@ -13,7 +13,7 @@ curl --request 'POST' --location \
         "catalog": "<catalog>",
         "schema": "<schema>",
         "volume": "<volume>",
-        "volume_path": "<volume-path>",
+        "volume_path": "<volume_path>",
 
         # For Databricks OAuth machine-to-machine (M2M) authentication:
         "client_secret": "<client-secret>",

snippets/destination_connectors/databricks_volumes_sdk.mdx

@@ -20,7 +20,7 @@ with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as clien
                     catalog="<catalog>",
                     schema="<schema>",
                     volume="<volume>",
-                    volume_path="<volume-path>",
+                    volume_path="<volume_path>",
 
                     # For Databricks OAuth machine-to-machine (M2M) authentication:
                     client_secret="<client-secret>",

snippets/destination_connectors/postgresql_rest_create.mdx

@@ -14,7 +14,7 @@ curl --request 'POST' --location \
         "port": "<port>",
         "username": "<username>",
         "password": "<password>",
-        "table_name": "<table-name>",
+        "table_name": "<table_name>",
         "batch_size": <batch-size>
     }
 }'

snippets/destination_connectors/postgresql_sdk.mdx

@@ -21,7 +21,7 @@ with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as clien
                     port="<port>",
                     username="<username>",
                     password="<password>",
-                    table_name="<table-name>",
+                    table_name="<table_name>",
                     batch_size=<batch-size>
                 )
             )

snippets/destination_connectors/snowflake_rest_create.mdx

@@ -18,7 +18,7 @@ curl --request 'POST' --location \
         "role": "<role>",
         "password": "<password>",
         "record_id_key": "<record-id-key>",
-        "table_name": "<table-name>",
+        "table_name": "<table_name>",
         "batch_size": <batch-size>
     }
 }'

snippets/destination_connectors/snowflake_sdk.mdx

@@ -25,7 +25,7 @@ with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as clien
                     role="<role>",
                     password="<password>",
                     record_id_key="<record-id-key>",
-                    table_name="<table-name>",
+                    table_name="<table_name>",
                     batch_size=<batch-size>
                 )
             )

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 `<database>` and `<schema>` will have the same values.
 
-- `<table-name>` (_required_): The name of the target table in Unity Catalog.
+- `<table_name>` (_required_): The name of the target table in Unity Catalog.
 - `<schema>`: 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 `<schema>` and `<database>` will have the same values.
 
 - `<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.
-
+- `<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.
 
+<Note>
+    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.
+</Note>
 

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.
 
+<Note>
+    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.
+</Note>
+
 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).