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 general​

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 general​

The column belongs to this table ID

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

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​

{
  "table": {
    "entityEditors": [
      {
        "sourceUser": {
          "unifiedUser": {
            "teamIds": []
          }
        }
      }
    ],
    "externalLinks": [
      {}
    ],
    "ownerEntities": [
      {
        "ownerLabel": {},
        "user": {
          "ownerEntities": []
        }
      }
    ],
    "schema": {
      "database": {
        "warehouse": {}
      }
    },
    "tagEntities": [
      {
        "tag": {}
      }
    ],
    "teamOwnerEntities": [
      {
        "team": {
          "teamOwnerEntities": []
        }
      }
    ]
  },
  "tagEntities": []
}

Returned By​

Member Of​