Skip to main content

Upload existing Descriptions

Import Does Not Overwrite

This process imports initial descriptions only. It does not overwrite existing user-written descriptions in Catalog.

Upload your existing table and column descriptions into Catalog using a CSV file. This works well when you have descriptions in spreadsheets, exported from another tool, or from a warehouse that Catalog doesn't ingest directly.

When To Use This Method

Upload existing descriptions is ideal when:

  • Descriptions from an unconnected warehouse—You've exported table and column descriptions from a warehouse that Catalog doesn't connect to, or you need to load them before the connection is set up.
  • Retrofitting older assets—Legacy tables and columns lack descriptions; you've documented them elsewhere and need to bulk load.
  • Importing from spreadsheets or other tools—Descriptions live in Excel, Google Sheets, or a data dictionary tool and you want them in Catalog.

If your descriptions already exist in a source that Catalog ingests, they are brought in automatically. See Ingested descriptions from source. Use this CSV upload only when descriptions come from elsewhere. For ongoing bulk edits after import, use the Metadata Editor.

CSV Format

Send your descriptions in the following CSV format. Required columns:

  • type_d—Type of the asset: table or column.
  • key—Database path of the asset. Must match Catalog's asset keys exactly (including warehouse or source name if your Catalog uses it).
    • Table: <database_name>.<schema_name>.<table_name>
    • Column: <database_name>.<schema_name>.<table_name>.<column_name>
  • description—The description for the asset. Markdown is supported for table descriptions only.

Example row (table):

type_d,key,description
table,my_db.my_schema.my_table,"This table stores customer records."

Example row (column):

type_d,key,description
column,my_db.my_schema.my_table.customer_id,"Unique identifier for each customer."
Key Must Match Catalog

The key must match the asset path as it appears in Catalog. The key column should not contain duplicates and no empty values should be provided in any of the columns. If your Catalog includes a warehouse or source name in the path, include it. Assets that don't exist in Catalog will be skipped.

Pre-Submission Checklist

Before sending your CSV:

  • Valid CSV with no malformed rows.
  • No duplicate keys in the key column.
  • No empty values in any column.
  • Use quote_all when exporting to CSV (recommended).

Load to Catalog - CSV Template

Submit Your File

Send the CSV to your Catalog Sales Rep or catalog-support@coalesce.io. We'll ingest the file and inform you of the results.

Troubleshooting

SymptomLikely causeAction
Descriptions not appliedKey format doesn't match Catalog, or assets don't existCheck that keys match Catalog's asset paths (for example, include warehouse/source name). Confirm assets exist in Catalog.
Duplicates or empty valuesInvalid CSV dataValidate the CSV before sending. Remove duplicate keys and ensure no empty cells.
Existing descriptions unchangedExpected behaviorImport does not overwrite user-written descriptions.

For bulk edits after import, use the Metadata Editor.