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.

UpdateColumnInput

Input object expected by the query or mutation

input UpdateColumnInput {
  deletedAt: DateTime
  externalDescription: String
  sourceOrder: Int
  dataType: String
  externalId: String
  id: String!
  isNullable: Boolean
  isPii: Boolean
  isPrimaryKey: Boolean
  name: String
}

Fields​

UpdateColumnInput.deletedAt ● DateTime scalar general​

If present, indicates when the column was deleted

UpdateColumnInput.externalDescription ● String scalar general​

The external documentation for this column

UpdateColumnInput.sourceOrder ● Int scalar general​

The original column position index as imported from the source warehouse

UpdateColumnInput.dataType ● String scalar general​

The data type for the column. For example: INTEGER

UpdateColumnInput.externalId ● String scalar general​

The technical column identifier from the warehouse structure

UpdateColumnInput.id ● String! non-null scalar general​

The id of the column you are looking for

UpdateColumnInput.isNullable ● Boolean scalar general​

True if this column is nullable

UpdateColumnInput.isPii ● Boolean scalar general​

The PII status to apply to the column

UpdateColumnInput.isPrimaryKey ● Boolean scalar general​

The PrimaryKey status to apply to the column

UpdateColumnInput.name ● String scalar general​

The column name

Example​

{
  "deletedAt": "2025-09-20T12:00:00.000Z",
  "externalDescription": "Contains customer email",
  "sourceOrder": 0,
  "dataType": "STRING",
  "externalId": "customer.email",
  "id": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "isNullable": true,
  "isPii": true,
  "isPrimaryKey": true,
  "name": "email"
}

Member Of​