> For the complete documentation index, see [llms.txt](https://docs.decube.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.decube.io/catalog/syncing-metadata-from-source/sync-from-source.md). # Descriptions The Catalog automatically syncs descriptions from your data source tables, columns, and schemas directly into the Decube Catalog. This one-way sync (source → Decube) keeps your cataloged assets aligned with the source-of-truth descriptions in your warehouse. When connecting a source, you can choose whether to manage metadata descriptions manually within the platform or sync them from the connected data source. This lets teams decide their preferred source of truth for descriptions, reducing confusion and ensuring consistent documentation practices. ### What this feature does * Allows you to configure description mode at source connection level. * Adds a single description field in the Catalog UI either: * Synced Description (read-only, from source), or * Description (editable, managed in Decube) * Applies to Schema, Table, and Column descriptions * This is a one-way sync: descriptions ingested from source into Decube. Changes made in Decube are not pushed back to the source. ### Supported sources * Snowflake * Redshift We’ll evaluate other sources based on demand. ### Description Modes {% hint style="info" %} Only one description field is shown in the UI at a time, based on the selected mode at source level. {% endhint %} When connecting to supported data sources, you can choose how descriptions should appear in the Catalog: #### 1. User-managed Descriptions * Editable within Decube. * Displayed as “Description” field in the catalog for column, tables, schemas. * Supports inline editing and change requests. * Used when you want to manage descriptions manually in Decube. #### 2. Synced Descriptions * Pulled from the data source during metadata ingestion * Displayed as “Synced Description” field in the catalog for column, tables, schemas. * Synced descriptions are read-only in the UI — you cannot edit them manually. * Reflects the current state in your source system ### How to Configure Description Mode {% hint style="info" %} This selection does not affect ingestion — both synced and user-managed descriptions are still stored in the backend. Only the UI and CSV export behavior changes. {% endhint %} You can configure the description mode when creating or modifying supported data sources (see [Supported Sources](#supported-sources) above): * Navigate to My Account -> Integrations to connect or modify a Source form. * Scroll to the section “Select which description should show in the catalog” * Choose: * User-managed descriptions (selected by default) * Synced descriptions * This configuration determines which description is shown for all asset types (schema, table, column) in the catalog.
* You can change the description mode at any time from the Modify Source form. * The selected option is applied immediately after changing the mode. * The Catalog UI and Export/Import will switch to show only the newly selected description. * You do not need to re-test or re-validate the connection to modify the setting. * Descriptions not shown in the UI are still stored in Decube. ### Behavior Across Features The table below shows how feature behavior changes based on the description mode selected in the source connection form. | **Feature** | **User-managed** | **Synced** | | --------------------------------------------------------------------- | --------------------------------- | ---------------------------------------- | | [Catalog UI](#where-can-you-see-these-changes-in-the-catalog-ui) | Editable Description shown | Read-only Synced Description shown | | [Change Requests](#where-can-you-see-these-changes-in-the-catalog-ui) | Supported | Not Supported | | [CSV Export (for table)](#csv-export-import-changes) | only `Description` field exported | only `Source Description` field exported | | [CSV Import](#csv-export-import-changes) | Allowed | Not allowed (read-only) | | [API](#api) | Returns both fields | | ### Where can you see these changes in the Catalog UI * For Schema/Table descriptions, navigate to Catalog → Data Sources (Redshift & Snowflake) → Asset details → Asset Attributes modal. * To update a user-managed description, click **Make changes**. * Only one description is displayed at a time — either `Description` (user-managed) or `Synced description`. * Synced descriptions are read-only. You can still click **Make changes** to update other attributes in the modal, such as owners.
* For Column descriptions, navigate to Catalog → Data Sources → Asset details → Schema Tab. * To update a user-managed description, click **Make changes**. * Only one description column is displayed at a time — either `Description` (user-managed) or `Synced description`. * Synced descriptions are read-only. You can still click **Make changes** to update other attributes in the Schema tab, such as tags and classifications.
### CSV Export/Import Changes * The CSV file includes a description column with the following header: * User-managed description: `Description` * Synced description: `Source Description` {% hint style="info" %} Before importing the CSV file into the platform, make sure to remove the `Source Description` column. Since this field is read-only, attempting to import it will result in an “Unknown attribute” error. {% endhint %} * The exported CSV includes the description column matching the source's configured description mode. * To include both descriptions in the exported CSV, check **Include both description and synced description** — both fields are then included in the exported CSV. * You can update the `Description` field (user-managed) through export/import even when the UI shows the synced description. The value is stored, and becomes visible in the Catalog if you later switch back to user-managed mode. * This configuration applies only to supported data sources.
### API * The API returns both `Description` and `Source Description` for Schema, Table, and Column assets. For details, see the [Asset API reference](/public-api/overview/index/assets.md). ### Edge Case Change requests created for description remain valid even if the source is later updated to show synced description. This is an edge case and will not be blocked. ## Beta feedback: we want to hear from you We’re continuing to improve how descriptions work in the Catalog, and your input can help shape what’s next. We’d like to hear from you: * Would you want the ability to push changes made in Decube back to the source system? * Should you be able to edit or comment on Synced Descriptions, even if they are read-only? * Do you find the new selection between user-managed and synced descriptions clear and helpful? Send your thoughts and ideas to — we’re listening! --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.decube.io/catalog/syncing-metadata-from-source/sync-from-source.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.