Schemas

Attach labels and attributes to schemas and their objects

Two kinds of metadata sit alongside a schema. Labels are coloured chips for quick visual grouping of schemas. Custom attributes are structured values, such as a data steward or a retention period, that you can set on the schema and on the objects inside it.

In the app: Data Model › Schemas › your schema › Info tab (labels) or Attributes tab

When to use which

  • Use a label for a short tag you want to see at a glance on the Schemas page: “Finance”, “Deprecated”, “Sample”.
  • Use a custom attribute for data you want to fill in consistently and report on: steward email, retention policy, source system, sensitivity.

See Attributes vs labels vs glossary terms for the long answer.

Before you start

  • Editing needs Read/Write access to the schema.
  • Labels are defined once for the whole organization. If the label you want doesn’t exist, an organization admin adds it. See Organization labels.
  • Attributes come from attribute groups. A group must be attached to the schema before its attributes appear on the schema’s objects.

Add or remove labels on a schema

  1. Open the schema’s Info tab.
  2. On the LABELS card, click the edit icon. The Edit Labels dialog opens.
  3. Click labels to select or deselect them.
  4. Click Save.

You can also pick labels when you create the schema. Labels apply to schemas only; tables and columns don’t have labels.

Set custom attribute values

  1. Attach an attribute group to the schema: Settings tab › Attribute Groups › Add Group. See Schema settings.
  2. Open the object you want to describe:
    • the schema itself (its Attributes tab),
    • a table (the table’s Attributes tab),
    • a column (the column’s Attributes tab),
    • a view, procedure, function or script (its Attributes tab).
  3. Fill in the fields. Each group appears as its own section.
  4. Click Save.

The schema’s Info tab also shows its attribute values read-only, with a link to the Attributes tab.

[screenshot]
A table's Attributes tab with one attribute group section partly filled in.