For the complete documentation index, see llms.txt. This page is also available as Markdown.

DataObjectFilterInput

Input object for filtering a list of data objects.

input DataObjectFilterInput {
  ancestors: [ID!]
  canHavePermissions: Boolean
  dataSources: [ID!]
  dataTypes: [String!]
  exclude: [String!]
  excludedTypes: [String!]
  fullNames: [String!]
  hasTags: [TagFilter!]
  includeDataSource: Boolean
  includeDeleted: Boolean
  owners: [String!]
  parents: [ID!]
  search: String
  types: [String!]
  whatAbacRule: WhatAbacRuleInput
}

Fields

ancestors ● [ID!] list scalar

Limit only to data objects with given ancestors.

canHavePermissions ● Boolean scalar

Only returns data objects of types that can have permissions assigned to them (e.g. this will exclude columns). This is false by default.

dataSources ● [ID!] list scalar

Limit only to data objects in specific data sources.

dataTypes ● [String!] list scalar

Limit to certain data types (typically for columns).

exclude ● [String!] list scalar

Excluded a fixed list of data objects.

excludedTypes ● [String!] list scalar

Do not returns data objects with the given types. Cannot be used together with the types filter.

fullNames ● [String!] list scalar

Filter on the full names of the data object.

hasTags ● [TagFilter!] list input

Filters by the tags that the data object has.

includeDataSource ● Boolean scalar

If true, also data top-level data object of type datasource is included.

includeDeleted ● Boolean scalar

If true, also deleted (unknown) data objects are included.

owners ● [String!] list scalar

Limit the data objects for which any of the given users is an owner.

parents ● [ID!] list scalar

Limit only to data objects with given (direct) parents.

The search string to use (will do a case-insensitive 'contains').

types ● [String!] list scalar

Limit only to data object with given types. Cannot be used together with the excludedTypes filter.

whatAbacRule ● WhatAbacRuleInput input

Return only data objects matched by the given WHAT ABAC rule. The rule's scope is mandatory. ANDed with all other filter fields (e.g. types, search, dataSources). permissions / globalPermissions on the rule are ignored.

Member Of

dataObjects query

Last updated

Was this helpful?