Annotation

The catalog lets you add a description and tags to tables and columns. This combination is called an annotation. Bulk updates from the CLI are also supported; see the Codatum CLI documentation for details.

For tag definitions and types, see Tag.

Targets

Target	What you can do	Example UI location
Table	Add a description and tags	Overview on the table detail, or the description/tag columns in the list
Column	Add a description and tags	Columns on the table detail

Adding tags to tables/columns

Add these from the table list or detail in the catalog.

• Table: Add tag in Overview, or Add tag in the tag column of the list.
• Column: Add tag on the Columns tab.

You can only add a table tag to a table, and a column tag to a column.

If a description was synced from the warehouse, you view and edit it in the same Description field in the catalog. See Table metadata sync for how syncing works.

Difference from saved queries

The description and tags on a saved query are managed as query-side metadata, separate from table annotations. You can edit them from the catalog's Queries list/detail, or from the Query screen.

Permissions

To edit a description or tags on a table or column, you need run permission on at least one of the related connections. Viewing depends on read permission on the related connections.

Creating and editing tag definitions is controlled by workspace role (see Tag).

For details, see Catalog.

Search

Descriptions and tags are included in keyword search. For search across resource types, see Quick search.