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.

GetColumnsScope

Allow to refine selection of the results using multiple scopes. Note: all scopes are additive

input GetColumnsScope {
  name: String
  nameContains: String
  description: String
  databaseId: String
  databaseIds: [String!]
  ids: [String!]
  hasColumnJoins: Boolean
  isDocumented: Boolean
  isPii: Boolean
  isPrimaryKey: Boolean
  schemaId: String
  schemaIds: [String!]
  sourceId: String
  sourceIds: [String!]
  tableId: String
  tableIds: [String!]
  withDeleted: Boolean
  withHidden: Boolean
}

Fields​

GetColumnsScope.name ● String scalar general​

Scope by column name

GetColumnsScope.nameContains ● String scalar general​

Scope by a substring of the column name

GetColumnsScope.description ● String scalar general​

Scope by description

GetColumnsScope.databaseId ● String scalar general​

Scope by database

GetColumnsScope.databaseIds ● [String!] list scalar general​

Scope by database IDs

GetColumnsScope.ids ● [String!] list scalar general​

Scope by ids

GetColumnsScope.hasColumnJoins ● Boolean scalar general​

Scope by hasColumnJoins

GetColumnsScope.isDocumented ● Boolean scalar general​

Scope by documentation status (either documented in the Catalog or an external source)

GetColumnsScope.isPii ● Boolean scalar general​

Scope by isPii (personally identifiable information)

GetColumnsScope.isPrimaryKey ● Boolean scalar general​

Scope by isPrimaryKey

GetColumnsScope.schemaId ● String scalar general​

Scope by schema ID

GetColumnsScope.schemaIds ● [String!] list scalar general​

Scope by schema IDs

GetColumnsScope.sourceId ● String scalar general​

Scope by source ID

GetColumnsScope.sourceIds ● [String!] list scalar general​

Scope by source IDs

GetColumnsScope.tableId ● String scalar general​

Scope by table ID

GetColumnsScope.tableIds ● [String!] list scalar general​

Scope by table IDs

GetColumnsScope.withDeleted ● Boolean scalar general​

Scope by withDeleted, whether to include deleted assets

GetColumnsScope.withHidden ● Boolean scalar general​

Scope by withHidden, whether to include hidden assets

Example​

{
  "name": "email",
  "nameContains": "email",
  "description": "Contains customer email",
  "databaseId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "databaseIds": [
    "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"
  ],
  "ids": [
    "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"
  ],
  "hasColumnJoins": true,
  "isDocumented": true,
  "isPii": true,
  "isPrimaryKey": true,
  "schemaId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "schemaIds": [
    "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"
  ],
  "sourceId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "sourceIds": [
    "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"
  ],
  "tableId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",
  "tableIds": [
    "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"
  ],
  "withDeleted": false,
  "withHidden": false
}

Member Of​