Skip to main content

Column

Semantic column definition. Capability flags control filtering, sorting, grouping, and catalog visibility; values is exhaustive, samples is illustrative, and dictionary-backed columns suppress both value lists from semantic catalog output.

nameName (string)required

Physical column name, unless a computed expression in options.sql.expr replaces it for supported SQL targets.

kindKind (string)

Semantic column kind: categorical or time.

Possible values: [categorical, time]

Default value: categorical
description object

Human-readable explanation of the column.

anyOf
string
filterableFilterable (boolean)

Whether the column can be used in filter conditions.

Default value: true
sortableSortable (boolean)

Whether the column can be used for result ordering.

Default value: true
groupableGroupable (boolean)

Whether the column can be selected or used for grouping.

Default value: true
visibleVisible (boolean)

Whether the column is exposed in the semantic catalog. Hidden columns remain available to authored filters and templates.

Default value: true
synonymsstring[]

Alternative terms that may refer to the column.

valuesstring[]

Exhaustive values for a low-cardinality column. Omitted from semantic catalog output when dictionary is set.

samplesstring[]

Illustrative, non-exhaustive example values. Omitted from semantic catalog output when dictionary is set.

dictionary object

Dictionary used to resolve canonical values and surface-form synonyms.

anyOf
builtin object
anyOf
object
external object
anyOf
string
options object

Target-specific column bindings, including an optional computed SQL expression.

anyOf
object
Column
{
  "name": "string",
  "kind": "categorical",
  "description": "string",
  "filterable": true,
  "sortable": true,
  "groupable": true,
  "visible": true,
  "synonyms": [
    "string"
  ],
  "values": [
    "string"
  ],
  "samples": [
    "string"
  ],
  "dictionary": {
    "builtin": {},
    "external": "string"
  },
  "options": {}
}