For the complete documentation index, see llms.txt. This page is also available as Markdown.

Column Attributes

Column attributes let you attach descriptive metadata to individual columns of a dataset, in the same way that dataset attributes describe whole datasets and check attributes describe checks.

Use column attributes to capture column-level business context such as sensitivity (e.g. PII, confidential), data domain, classification, or ownership. Once set, column attributes can be:

  • Viewed on the dataset's column cards and in the column information panel.

  • Set programmatically through the Soda Cloud REST API, to keep Soda in sync with a data catalog or governance tool.

  • Used in Data Standards to target columns by their attribute values instead of (or in addition to) their names. See Use column attributes in Data Standards.

Column attributes are part of Data Standards and are only available when Data Standards is enabled for your organization. If you do not see the options described below, Data Standards is not enabled on your plan.

Defining a column attribute

Column attributes use the same attribute catalog as datasets and checks. Before you can set a value on a column, an attribute with the Column resource type must exist.

Learn how to create one: Check and dataset attributes. When creating the attribute, select Column as the Resource Type.

Setting column attribute values

You set values per column from the dataset page.

1

Open the dataset page and locate the column you want to annotate in the Columns list.

2

Open the column's context menu (⋮) and select Edit Attributes.

3

In the Edit Attributes dialog, set a value for each column attribute. All attributes are optional, and the available input depends on the attribute type (single select, multi select, checkbox, text, number, or date).

4

Click Save to apply the changes.

Viewing column attributes

Once set, a column's attribute values appear:

  • As tags on the column card, next to the column's data type.

  • In the Custom Column Attributes section of the column information panel.

Column attribute values appear as tags on each column card.

Set column attributes via the REST API

You can set or update column attribute values in bulk with the Soda Cloud REST API, which is the recommended way to keep column metadata in sync with an external data catalog or governance tool.

Use the POST /api/v1/datasets/{datasetId}/columnAttributes endpoint. The request body maps each column name to a map of attribute name → value. Setting one attribute on a column leaves the column's other attribute values untouched. If any column name, attribute name, or value type is invalid, the entire request is rejected and no changes are persisted.

The caller must have the Configure Dataset (CONFIGURE_DATASET) permission on the dataset.

See the full request and response schema in the auto-generated API reference: REST API.

Use column attributes in Data Standards

Column attributes can drive Data Standards: a standard's match block can target columns by their attribute values (equals, any_of, grouped with all_of / any_of, and exclude) instead of, or in addition to, their names. This lets a single standard apply, for example, to every column tagged with a given sensitivity.

The full Data Standards match syntax is documented with Data Standards.


You are not logged in to Soda and are viewing the default public documentation. Learn more about Documentation access & licensing.

If you do have a Soda license, make sure to log in to Soda Cloud in this same browser.

Last updated

Was this helpful?