Skip to main content

Documentation index: llms.txt. This page is also available as markdown: append .md to this URL or send Accept: text/markdown.

Column

A column represents a single field within a table. Each column is linked to a table and contains metadata such as data type, description, and technical identifiers.

type Column {
  id: ID!
  dataType: String!
  descriptionRaw: String
  externalDescription: String
  externalDescriptionSource: ColumnExternalDescriptionSource
  externalId: String!
  isDescriptionGenerated: Boolean
  isNullable: Boolean!
  isPii: Boolean
  isPrimaryKey: Boolean
  name: String!
  sourceOrder: Int
  accountId: String!
  databaseId: String!
  describedByColumnId: String
  schemaId: String!
  sourceId: String!
  tableId: String!
  table: Table!
  tagEntities: [TagEntity!]!
  createdAt: Timestamp!
  deletedAt: Timestamp
  updatedAt: Timestamp!
  description: String!
}

Fields​

Column.id ● ID! non-null scalar general​

Unique Catalog identifier of the resource

Column.dataType ● String! non-null scalar general​

The data type for the column. For example: INTEGER

Column.descriptionRaw ● String scalar general​

The Catalog documentation for this column

Column.externalDescription ● String scalar general​

The documentation from the source for this column

Column.externalDescriptionSource ● ColumnExternalDescriptionSource enum columns​

The source of the documentation for this column

Column.externalId ● String! non-null scalar general​

The technical column identifier from the warehouse internal structure

Column.isDescriptionGenerated ● Boolean scalar general​

True if the description has been generated, false otherwise

Column.isNullable ● Boolean! non-null scalar general​

True if this column is nullable

Column.isPii ● Boolean scalar general​

True if this column is PII related

Column.isPrimaryKey ● Boolean scalar general​

True if this column is a primary key

Column.name ● String! non-null scalar general​

The column name

Column.sourceOrder ● Int scalar general​

The original column position index as imported from the source warehouse

Column.accountId ● String! non-null scalar general​

The column belongs to this account ID

Column.databaseId ● String! non-null scalar general​

The column belongs to this database ID

Column.describedByColumnId ● String scalar general​

The column is described by this column id

Column.schemaId ● String! non-null scalar general​

The column belongs to this schema ID

Column.sourceId ● String! non-null scalar general​

The column belongs to this source ID

Column.tableId ● String! non-null scalar general​

The column belongs to this table ID

Column.table ● Table! non-null object tables​

The column belongs to this table ID

Column.tagEntities ● [TagEntity!]! non-null object tags​

The tag entities belonging to this column

Column.createdAt ● Timestamp! non-null scalar general​

Date and time the resource was created

Column.deletedAt ● Timestamp scalar general​

Date and time the resource was deleted

Column.updatedAt ● Timestamp! non-null scalar general​

Date and time the resource was last updated

Column.description ● String! non-null scalar general​

The column custom description or the external one if empty

Example​

{
  "id": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "dataType": "STRING",
  "descriptionRaw": "Contains customer email",
  "externalDescription": "Contains customer email",
  "externalDescriptionSource": "COALESCE",
  "externalId": "customer.email",
  "isDescriptionGenerated": false,
  "isNullable": true,
  "isPii": false,
  "isPrimaryKey": true,
  "name": "email",
  "sourceOrder": 0,
  "accountId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "databaseId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "describedByColumnId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "schemaId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "sourceId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "tableId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "table": {
    "deprecatedAt": 1758555879800,
    "descriptionStateLexical": {
      "root": {
        "children": [
          {
            "type": "paragraph",
            "version": 1
          }
        ],
        "direction": null,
        "format": "",
        "indent": 0,
        "type": "root",
        "version": 1
      }
    },
    "lastQueriedAt": 1758555879800,
    "lastRefreshedAt": 1758555879800,
    "numberOfQueries": 100,
    "popularity": 80,
    "slug": "c-customers-table",
    "tableSize": 32,
    "tableType": "TABLE",
    "transformationSource": "COALESCE",
    "url": "https://app.snowflake.com/",
    "verifiedAt": 1758555879800,
    "deprecatedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
    "entityEditors": [
      {
        "dashboardId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
        "sourceUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
        "sourceUser": {
          "avatarUrl": "https://example.com/avatar.png",
          "email": "john.doe@example.com",
          "unifiedId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
          "unifiedUser": {
            "role": "CONTRIBUTOR",
            "status": "ACTIVATED",
            "teamIds": [
              "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"
            ],
            "userId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
            "createdAt": 1758555879800
          },
          "deletedAt": 1758555879800,
          "updatedAt": 1758555879800
        },
        "termId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
        "refreshedAt": 1758555879800
      }
    ],
    "externalLinks": [
      {
        "technology": "GITLAB"
      }
    ],
    "lastDescribedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
    "ownerEntities": [
      {
        "ownerLabelId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
        "ownerLabel": {
          "label": "Data Steward"
        },
        "user": {
          "firstName": "John",
          "lastName": "Doe",
          "ownerEntities": [],
          "fullName": "John Doe"
        }
      }
    ],
    "schema": {
      "description": "Default Postgres schema",
      "isHidden": false,
      "database": {
        "warehouse": {
          "origin": "EXTRACTION",
          "type": "COMMUNICATION"
        }
      }
    },
    "tagEntities": [
      {
        "tagId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
        "tag": {
          "color": "ALERT_COLOR",
          "linkedTermId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"
        }
      }
    ],
    "teamOwnerEntities": [
      {
        "teamId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
        "team": {
          "slackChannel": "#emea-sales",
          "slackGroup": "@emea-sales",
          "source": "Slack",
          "teamOwnerEntities": []
        }
      }
    ],
    "verifiedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
    "isDeprecated": false,
    "isVerified": false
  },
  "tagEntities": []
}

Returned By​

Member Of​