Skip to main content

Input objects

AcceptRoleInput

Input provided when accepting a DataHub role using an invite token

Arguments

NameDescription
inviteToken
String!

The token needed to accept the role

ActorFilterInput

Input required when creating or updating an Access Policies Determines which actors the Policy applies to

Arguments

NameDescription
users
[String!]

A disjunctive set of users to apply the policy to

groups
[String!]

A disjunctive set of groups to apply the policy to

resourceOwners
Boolean!

Whether the filter should return TRUE for owners of a particular resource Only applies to policies of type METADATA, which have a resource associated with them

allUsers
Boolean!

Whether the filter should apply to all users

allGroups
Boolean!

Whether the filter should apply to all groups

AddGroupMembersInput

Input required to add members to an external DataHub group

Arguments

NameDescription
groupUrn
String!

The group to add members to

userUrns
[String!]!

The members to add to the group

AddLinkInput

Input provided when adding the association between a Metadata Entity and a Link

Arguments

NameDescription
linkUrl
String!

The url of the link to add or remove

label
String!

A label to attach to the link

resourceUrn
String!

The urn of the resource or entity to attach the link to, for example a dataset urn

AddNativeGroupMembersInput

Input required to add members to a native DataHub group

Arguments

NameDescription
groupUrn
String!

The group to add members to

userUrns
[String!]!

The members to add to the group

AddOwnerInput

Input provided when adding the association between a Metadata Entity and an user or group owner

Arguments

NameDescription
ownerUrn
String!

The primary key of the Owner to add or remove

ownerEntityType
OwnerEntityType!

The owner type, either a user or group

type
OwnershipType

The ownership type for the new owner. If none is provided, then a new NONE will be added.

resourceUrn
String!

The urn of the resource or entity to attach or remove the owner from, for example a dataset urn

AddOwnersInput

Input provided when adding multiple associations between a Metadata Entity and an user or group owner

Arguments

NameDescription
owners
[OwnerInput!]!

The primary key of the Owner to add or remove

resourceUrn
String!

The urn of the resource or entity to attach or remove the owner from, for example a dataset urn

AddTagsInput

Input provided when adding tags to an asset

Arguments

NameDescription
tagUrns
[String!]!

The primary key of the Tags

resourceUrn
String!

The target Metadata Entity to add or remove the Tag to

subResourceType
SubResourceType

An optional type of a sub resource to attach the Tag to

subResource
String

An optional sub resource identifier to attach the Tag to

AddTermsInput

Input provided when adding Terms to an asset

Arguments

NameDescription
termUrns
[String!]!

The primary key of the Glossary Term to add or remove

resourceUrn
String!

The target Metadata Entity to add or remove the Glossary Term from

subResourceType
SubResourceType

An optional type of a sub resource to attach the Glossary Term to

subResource
String

An optional sub resource identifier to attach the Glossary Term to

AndFilterInput

A list of disjunctive criterion for the filter. (or operation to combine filters)

Arguments

NameDescription
and
[FacetFilterInput!]

A list of and criteria the filter applies to the query

AspectParams

Params to configure what list of aspects should be fetched by the aspects property

Arguments

NameDescription
autoRenderOnly
Boolean

Only fetch auto render aspects

AutoCompleteInput

Input for performing an auto completion query against a single Metadata Entity

Arguments

NameDescription
type
EntityType

Entity type to be autocompleted against

query
String!

The raw query string

field
String

An optional entity field name to autocomplete on

limit
Int

The maximum number of autocomplete results to be returned

filters
[FacetFilterInput!]

Faceted filters applied to autocomplete results

orFilters
[AndFilterInput!]

A list of disjunctive criterion for the filter. (or operation to combine filters)

AutoCompleteMultipleInput

Input for performing an auto completion query against a a set of Metadata Entities

Arguments

NameDescription
types
[EntityType!]

Entity types to be autocompleted against Optional, if none supplied, all searchable types will be autocompleted against

query
String!

The raw query string

field
String

An optional field to autocomplete against

limit
Int

The maximum number of autocomplete results

filters
[FacetFilterInput!]

Faceted filters applied to autocomplete results

orFilters
[AndFilterInput!]

A list of disjunctive criterion for the filter. (or operation to combine filters)

viewUrn
String

Optional - A View to apply when generating results

BatchAddOwnersInput

Input provided when adding owners to a batch of assets

Arguments

NameDescription
owners
[OwnerInput!]!

The primary key of the owners

resources
[ResourceRefInput]!

The target assets to attach the owners to

BatchAddTagsInput

Input provided when adding tags to a batch of assets

Arguments

NameDescription
tagUrns
[String!]!

The primary key of the Tags

resources
[ResourceRefInput!]!

The target assets to attach the tags to

BatchAddTermsInput

Input provided when adding glossary terms to a batch of assets

Arguments

NameDescription
termUrns
[String!]!

The primary key of the Glossary Terms

resources
[ResourceRefInput]!

The target assets to attach the glossary terms to

BatchAssignRoleInput

Input provided when batch assigning a role to a list of users

Arguments

NameDescription
roleUrn
String

The urn of the role to assign to the actors. If undefined, will remove the role.

actors
[String!]!

The urns of the actors to assign the role to

BatchDatasetUpdateInput

Arguments provided to batch update Dataset entities

Arguments

NameDescription
urn
String!

Primary key of the Dataset to which the update will be applied

update
DatasetUpdateInput!

Arguments provided to update the Dataset

BatchGetStepStatesInput

Input arguments required for fetching step states

Arguments

NameDescription
ids
[String!]!

The unique ids for the steps to retrieve

BatchRemoveOwnersInput

Input provided when removing owners from a batch of assets

Arguments

NameDescription
ownerUrns
[String!]!

The primary key of the owners

resources
[ResourceRefInput]!

The target assets to remove the owners from

BatchRemoveTagsInput

Input provided when removing tags from a batch of assets

Arguments

NameDescription
tagUrns
[String!]!

The primary key of the Tags

resources
[ResourceRefInput]!

The target assets to remove the tags from

BatchRemoveTermsInput

Input provided when removing glossary terms from a batch of assets

Arguments

NameDescription
termUrns
[String!]!

The primary key of the Glossary Terms

resources
[ResourceRefInput]!

The target assets to remove the glossary terms from

BatchSetDataProductInput

Input properties required for batch setting a DataProduct on other entities

Arguments

NameDescription
dataProductUrn
String

The urn of the data product you are setting on a group of resources. If this is null, the Data Product will be unset for the given resources.

resourceUrns
[String!]!

The urns of the entities the given data product should be set on

BatchSetDomainInput

Input provided when adding tags to a batch of assets

Arguments

NameDescription
domainUrn
String

The primary key of the Domain, or null if the domain will be unset

resources
[ResourceRefInput!]!

The target assets to attach the Domain

BatchUpdateDeprecationInput

Input provided when updating the deprecation status for a batch of assets.

Arguments

NameDescription
deprecated
Boolean!

Whether the Entity is marked as deprecated.

decommissionTime
Long

Optional - The time user plan to decommission this entity

note
String

Optional - Additional information about the entity deprecation plan

resources
[ResourceRefInput]!

The target assets to attach the tags to

BatchUpdateSoftDeletedInput

Input provided when updating the soft-deleted status for a batch of assets

Arguments

NameDescription
urns
[String!]!

The urns of the assets to soft delete

deleted
Boolean!

Whether to mark the asset as soft-deleted (hidden)

BatchUpdateStepStatesInput

Input arguments required for updating step states

Arguments

NameDescription
states
[StepStateInput!]!

Set of step states. If the id does not exist, it will be created.

BrowseInput

Input required for browse queries

Arguments

NameDescription
type
EntityType!

The browse entity type

path
[String!]

The browse path

start
Int

The starting point of paginated results

count
Int

The number of elements included in the results

filters
[FacetFilterInput!]
Deprecated: Use `orFilters`- they are more expressive

Deprecated in favor of the more expressive orFilters field Facet filters to apply to search results. These will be 'AND'-ed together.

orFilters
[AndFilterInput!]

A list of disjunctive criterion for the filter. (or operation to combine filters)

BrowsePathsInput

Inputs for fetching the browse paths for a Metadata Entity

Arguments

NameDescription
type
EntityType!

The browse entity type

urn
String!

The entity urn

CancelIngestionExecutionRequestInput

Input for cancelling an execution request input

Arguments

NameDescription
ingestionSourceUrn
String!

Urn of the ingestion source

executionRequestUrn
String!

Urn of the specific execution request to cancel

ChartEditablePropertiesUpdate

Update to writable Chart fields

Arguments

NameDescription
description
String!

Writable description aka documentation for a Chart

ChartUpdateInput

Arguments provided to update a Chart Entity

Arguments

NameDescription
ownership
OwnershipUpdate

Update to ownership

globalTags
GlobalTagsUpdate

Deprecated, use tags field instead Update to global tags

tags
GlobalTagsUpdate

Update to tags

editableProperties
ChartEditablePropertiesUpdate

Update to editable properties

ContainerEntitiesInput

Input required to fetch the entities inside of a container.

Arguments

NameDescription
query
String

Optional query filter for particular entities inside the container

start
Int

The offset of the result set

count
Int

The number of entities to include in result set

filters
[FacetFilterInput!]

Optional Facet filters to apply to the result set

CorpGroupUpdateInput

Arguments provided to update a CorpGroup Entity

Arguments

NameDescription
description
String

DataHub description of the group

slack
String

Slack handle for the group

email
String

Email address for the group

CorpUserUpdateInput

Arguments provided to update a CorpUser Entity

Arguments

NameDescription
displayName
String

Display name to show on DataHub

title
String

Title to show on DataHub

aboutMe
String

About me section of the user

teams
[String!]

Teams that the user belongs to

skills
[String!]

Skills that the user possesses

pictureLink
String

A URL which points to a picture which user wants to set as a profile photo

slack
String

The slack handle of the user

phone
String

Phone number for the user

email
String

Email address for the user

CreateAccessTokenInput

Arguments

NameDescription
type
AccessTokenType!

The type of the Access Token.

actorUrn
String!

The actor associated with the Access Token.

duration
AccessTokenDuration!

The duration for which the Access Token is valid.

name
String!

The name of the token to be generated.

description
String

Description of the token if defined.

CreateDataProductInput

Input required for creating a DataProduct.

Arguments

NameDescription
properties
CreateDataProductPropertiesInput!

Properties about the Query

domainUrn
String!

The primary key of the Domain

CreateDataProductPropertiesInput

Input properties required for creating a DataProduct

Arguments

NameDescription
name
String!

A display name for the DataProduct

description
String

An optional description for the DataProduct

CreateDomainInput

Input required to create a new Domain.

Arguments

NameDescription
id
String

Optional! A custom id to use as the primary key identifier for the domain. If not provided, a random UUID will be generated as the id.

name
String!

Display name for the Domain

description
String

Optional description for the Domain

CreateGlossaryEntityInput

Input required to create a new Glossary Entity - a Node or a Term.

Arguments

NameDescription
id
String

Optional! A custom id to use as the primary key identifier for the domain. If not provided, a random UUID will be generated as the id.

name
String!

Display name for the Node or Term

description
String

Description for the Node or Term

parentNode
String

Optional parent node urn for the Glossary Node or Term

CreateGroupInput

Input for creating a new group

Arguments

NameDescription
id
String

Optional! A custom id to use as the primary key identifier for the group. If not provided, a random UUID will be generated as the id.

name
String!

The display name of the group

description
String

The description of the group

CreateIngestionExecutionRequestInput

Input for creating an execution request input

Arguments

NameDescription
ingestionSourceUrn
String!

Urn of the ingestion source to execute

CreateInviteTokenInput

Input provided when creating an invite token

Arguments

NameDescription
roleUrn
String

The urn of the role to create the invite token for

CreateNativeUserResetTokenInput

Input required to generate a password reset token for a native user.

Arguments

NameDescription
userUrn
String!

The urn of the user to reset the password of

CreatePostInput

Input provided when creating a Post

Arguments

NameDescription
postType
PostType!

The type of post

content
UpdatePostContentInput!

The content of the post

CreateQueryInput

Input required for creating a Query. Requires the 'Edit Queries' privilege for all query subjects.

Arguments

NameDescription
properties
CreateQueryPropertiesInput!

Properties about the Query

subjects
[CreateQuerySubjectInput!]!

Subjects for the query

CreateQueryPropertiesInput

Input properties required for creating a Query

Arguments

NameDescription
name
String

An optional display name for the Query

description
String

An optional description for the Query

statement
QueryStatementInput!

The Query contents

CreateQuerySubjectInput

Input required for creating a Query. For now, only datasets are supported.

Arguments

NameDescription
datasetUrn
String!

The urn of the dataset that is the subject of the query

CreateSecretInput

Input arguments for creating a new Secret

Arguments

NameDescription
name
String!

The name of the secret for reference in ingestion recipes

value
String!

The value of the secret, to be encrypted and stored

description
String

An optional description for the secret

CreateTagInput

Input required to create a new Tag

Arguments

NameDescription
id
String

Optional! A custom id to use as the primary key identifier for the Tag. If not provided, a random UUID will be generated as the id.

name
String!

Display name for the Tag

description
String

Optional description for the Tag

CreateTestConnectionRequestInput

Input for creating a test connection request

Arguments

NameDescription
recipe
String!

A JSON-encoded recipe

version
String

Advanced: The version of the ingestion framework to use

CreateTestInput

Arguments

NameDescription
id
String

Advanced: a custom id for the test.

name
String!

The name of the Test

category
String!

The category of the Test (user defined)

description
String

Description of the test

definition
TestDefinitionInput!

The test definition

CreateViewInput

Input provided when creating a DataHub View

Arguments

NameDescription
viewType
DataHubViewType!

The type of View

name
String!

The name of the View

description
String

An optional description of the View

definition
DataHubViewDefinitionInput!

The view definition itself

DashboardEditablePropertiesUpdate

Update to writable Dashboard fields

Arguments

NameDescription
description
String!

Writable description aka documentation for a Dashboard

DashboardUpdateInput

Arguments provided to update a Dashboard Entity

Arguments

NameDescription
ownership
OwnershipUpdate

Update to ownership

globalTags
GlobalTagsUpdate

Deprecated, use tags field instead Update to global tags

tags
GlobalTagsUpdate

Update to tags

editableProperties
DashboardEditablePropertiesUpdate

Update to editable properties

DataFlowEditablePropertiesUpdate

Update to writable Data Flow fields

Arguments

NameDescription
description
String!

Writable description aka documentation for a Data Flow

DataFlowUpdateInput

Arguments provided to update a Data Flow aka Pipeline Entity

Arguments

NameDescription
ownership
OwnershipUpdate

Update to ownership

globalTags
GlobalTagsUpdate

Deprecated, use tags field instead Update to global tags

tags
GlobalTagsUpdate

Update to tags

editableProperties
DataFlowEditablePropertiesUpdate

Update to editable properties

DataHubViewDefinitionInput

Input required for creating a DataHub View Definition

Arguments

NameDescription
entityTypes
[EntityType!]!

A set of entity types that the view applies for. If left empty, then ALL entities will be in scope.

filter
DataHubViewFilterInput!

A set of filters to apply.

DataHubViewFilterInput

Input required for creating a DataHub View Definition

Arguments

NameDescription
operator
LogicalOperator!

The operator used to combine the filters.

filters
[FacetFilterInput!]!

A set of filters combined via an operator. If left empty, then no filters will be applied.

DataJobEditablePropertiesUpdate

Update to writable Data Job fields

Arguments

NameDescription
description
String!

Writable description aka documentation for a Data Job

DataJobUpdateInput

Arguments provided to update a Data Job aka Task Entity

Arguments

NameDescription
ownership
OwnershipUpdate

Update to ownership

globalTags
GlobalTagsUpdate

Deprecated, use tags field instead Update to global tags

tags
GlobalTagsUpdate

Update to tags

editableProperties
DataJobEditablePropertiesUpdate

Update to editable properties

DataProductEntitiesInput

Input required to fetch the entities inside of a Data Product.

Arguments

NameDescription
query
String

Optional query filter for particular entities inside the Data Product

start
Int

The offset of the result set

count
Int

The number of entities to include in result set

filters
[FacetFilterInput!]

Optional Facet filters to apply to the result set

DatasetDeprecationUpdate

An update for the deprecation information for a Metadata Entity

Arguments

NameDescription
deprecated
Boolean!

Whether the dataset is deprecated

decommissionTime
Long

The time user plan to decommission this dataset

note
String!

Additional information about the dataset deprecation plan

DatasetEditablePropertiesUpdate

Update to writable Dataset fields

Arguments

NameDescription
description
String!

Writable description aka documentation for a Dataset

DatasetUpdateInput

Arguments provided to update a Dataset Entity

Arguments

NameDescription
ownership
OwnershipUpdate

Update to ownership

deprecation
DatasetDeprecationUpdate

Update to deprecation status

institutionalMemory
InstitutionalMemoryUpdate

Update to institutional memory, ie documentation

globalTags
GlobalTagsUpdate

Deprecated, use tags field instead Update to global tags

tags
GlobalTagsUpdate

Update to tags

editableSchemaMetadata
EditableSchemaMetadataUpdate

Update to editable schema metadata of the dataset

editableProperties
DatasetEditablePropertiesUpdate

Update to editable properties

DescriptionUpdateInput

Incubating. Updates the description of a resource. Currently supports DatasetField descriptions only

Arguments

NameDescription
description
String!

The new description

resourceUrn
String!

The primary key of the resource to attach the description to, eg dataset urn

subResourceType
SubResourceType

An optional sub resource type

subResource
String

A sub resource identifier, eg dataset field path

DomainEntitiesInput

Input required to fetch the entities inside of a Domain.

Arguments

NameDescription
query
String

Optional query filter for particular entities inside the domain

start
Int

The offset of the result set

count
Int

The number of entities to include in result set

filters
[FacetFilterInput!]

Optional Facet filters to apply to the result set

EditableSchemaFieldInfoUpdate

Update to writable schema field metadata

Arguments

NameDescription
fieldPath
String!

Flattened name of a field identifying the field the editable info is applied to

description
String

Edited description of the field

globalTags
GlobalTagsUpdate

Tags associated with the field

EditableSchemaMetadataUpdate

Update to editable schema metadata of the dataset

Arguments

NameDescription
editableSchemaFieldInfo
[EditableSchemaFieldInfoUpdate!]!

Update to writable schema field metadata

EntityCountInput

Input for the get entity counts endpoint

Arguments

NameDescription
types
[EntityType!]

EntityRequestContext

Context that defines an entity page requesting recommendations

Arguments

NameDescription
type
EntityType!

Type of the enity being displayed

urn
String!

Urn of the entity being displayed

FacetFilterInput

Facet filters to apply to search results

Arguments

NameDescription
field
String!

Name of field to filter by

value
String
Deprecated: Prefer `values` for single elements

Value of the field to filter by. Deprecated in favor of values, which should accept a single element array for a value

values
[String!]

Values, one of which the intended field should match.

negated
Boolean

If the filter should or should not be matched

condition
FilterOperator

Condition for the values. How to If unset, assumed to be equality

FilterInput

A set of filter criteria

Arguments

NameDescription
and
[FacetFilterInput!]!

A list of conjunctive filters

GetAccessTokenInput

Input required to fetch a new Access Token.

Arguments

NameDescription
type
AccessTokenType!

The type of the Access Token.

actorUrn
String!

The actor associated with the Access Token.

duration
AccessTokenDuration!

The duration for which the Access Token is valid.

GetGrantedPrivilegesInput

Input for getting granted privileges

Arguments

NameDescription
actorUrn
String!

Urn of the actor

resourceSpec
ResourceSpec

Spec to identify resource. If empty, gets privileges granted to the actor

GetInviteTokenInput

Input provided when getting an invite token

Arguments

NameDescription
roleUrn
String

The urn of the role to get the invite token for

GetQuickFiltersInput

Input for getting Quick Filters

Arguments

NameDescription
viewUrn
String

Optional - A View to apply when generating results

GetRootGlossaryEntitiesInput

Input required when getting Business Glossary entities

Arguments

NameDescription
start
Int!

The starting offset of the result set returned

count
Int!

The number of Glossary Entities in the returned result set

GetSchemaBlameInput

Input for getting schema changes computed at a specific version.

Arguments

NameDescription
datasetUrn
String!

The dataset urn

version
String

Changes after this version are not shown. If not provided, this is the latestVersion.

GetSchemaVersionListInput

Input for getting list of schema versions.

Arguments

NameDescription
datasetUrn
String!

The dataset urn

GetSecretValuesInput

Input arguments for retrieving the plaintext values of a set of secrets

Arguments

NameDescription
secrets
[String!]!

A list of secret names

GlobalTagsUpdate

Deprecated, use addTag or removeTag mutation instead Update to the Tags associated with a Metadata Entity

Arguments

NameDescription
tags
[TagAssociationUpdate!]

The new set of tags

InstitutionalMemoryMetadataUpdate

An institutional memory to add to a Metadata Entity TODO Add a USER or GROUP actor enum

Arguments

NameDescription
url
String!

Link to a document or wiki page or another internal resource

description
String

Description of the resource

author
String!

The corp user urn of the author of the metadata

createdAt
Long

The time at which this metadata was created

InstitutionalMemoryUpdate

An update for the institutional memory information for a Metadata Entity

Arguments

NameDescription
elements
[InstitutionalMemoryMetadataUpdate!]!

The individual references in the institutional memory

LineageEdge

Arguments

NameDescription
downstreamUrn
String!

Urn of the source entity. This urn is downstream of the destinationUrn.

upstreamUrn
String!

Urn of the destination entity. This urn is upstream of the destinationUrn

LineageInput

Input for the list lineage property of an Entity

Arguments

NameDescription
direction
LineageDirection!

The direction of the relationship, either incoming or outgoing from the source entity

start
Int

The starting offset of the result set

count
Int

The number of results to be returned

separateSiblings
Boolean

Optional flag to not merge siblings in the response. They are merged by default.

startTimeMillis
Long

An optional starting time to filter on

endTimeMillis
Long

An optional ending time to filter on

ListAccessTokenInput

Input arguments for listing access tokens

Arguments

NameDescription
start
Int

The starting offset of the result set

count
Int

The number of results to be returned

filters
[FacetFilterInput!]

Facet filters to apply to search results

ListDomainsInput

Input required when listing DataHub Domains

Arguments

NameDescription
start
Int

The starting offset of the result set returned

count
Int

The maximum number of Domains to be returned in the result set

query
String

Optional search query

ListGlobalViewsInput

Input provided when listing DataHub Global Views

Arguments

NameDescription
start
Int

The starting offset of the result set returned

count
Int

The maximum number of Views to be returned in the result set

query
String

Optional search query

ListGroupsInput

Input required when listing DataHub Groups

Arguments

NameDescription
start
Int

The starting offset of the result set returned

count
Int

The maximum number of Policies to be returned in the result set

query
String

Optional search query

ListIngestionSourcesInput

Input arguments for listing Ingestion Sources

Arguments

NameDescription
start
Int

The starting offset of the result set

count
Int

The number of results to be returned

query
String

An optional search query

ListMyViewsInput

Input provided when listing DataHub Views

Arguments

NameDescription
start
Int

The starting offset of the result set returned

count
Int

The maximum number of Views to be returned in the result set

query
String

Optional search query

viewType
DataHubViewType

Optional - List the type of View to filter for.

ListPoliciesInput

Input required when listing DataHub Access Policies

Arguments

NameDescription
start
Int

The starting offset of the result set returned

count
Int

The maximum number of Policies to be returned in the result set

query
String

Optional search query

ListPostsInput

Input provided when listing existing posts

Arguments

NameDescription
start
Int

The starting offset of the result set returned

count
Int

The maximum number of Roles to be returned in the result set

query
String

Optional search query

ListQueriesInput

Input required for listing query entities

Arguments

NameDescription
start
Int

The starting offset of the result set returned

count
Int

The maximum number of Queries to be returned in the result set

query
String

A raw search query

source
QuerySource

An optional source for the query

datasetUrn
String

An optional Urn for the parent dataset that the query is associated with.

ListRecommendationsInput

Input arguments for fetching UI recommendations

Arguments

NameDescription
userUrn
String!

Urn of the actor requesting recommendations

requestContext
RecommendationRequestContext

Context provider by the caller requesting recommendations

limit
Int

Max number of modules to return

ListRolesInput

Input provided when listing existing roles

Arguments

NameDescription
start
Int

The starting offset of the result set returned

count
Int

The maximum number of Roles to be returned in the result set

query
String

Optional search query

ListSecretsInput

Input for listing DataHub Secrets

Arguments

NameDescription
start
Int

The starting offset of the result set

count
Int

The number of results to be returned

query
String

An optional search query

ListTestsInput

Input required when listing DataHub Tests

Arguments

NameDescription
start
Int

The starting offset of the result set returned

count
Int

The maximum number of Domains to be returned in the result set

query
String

Optional query string to match on

ListUsersInput

Input required when listing DataHub Users

Arguments

NameDescription
start
Int

The starting offset of the result set returned

count
Int

The maximum number of Policies to be returned in the result set

query
String

Optional search query

MetadataAnalyticsInput

Input to fetch metadata analytics charts

Arguments

NameDescription
entityType
EntityType

Entity type to fetch analytics for (If empty, queries across all entities)

domain
String

Urn of the domain to fetch analytics for (If empty or GLOBAL, queries across all domains)

query
String

Search query to filter down result (If empty, does not apply any search query)

NotebookEditablePropertiesUpdate

Update to writable Notebook fields

Arguments

NameDescription
description
String!

Writable description aka documentation for a Notebook

NotebookUpdateInput

Arguments provided to update a Notebook Entity

Arguments

NameDescription
ownership
OwnershipUpdate

Update to ownership

tags
GlobalTagsUpdate

Update to tags

editableProperties
NotebookEditablePropertiesUpdate

Update to editable properties

OwnerInput

Input provided when adding an owner to an asset

Arguments

NameDescription
ownerUrn
String!

The primary key of the Owner to add or remove

ownerEntityType
OwnerEntityType!

The owner type, either a user or group

type
OwnershipType

The ownership type for the new owner. If none is provided, then a new NONE will be added.

OwnershipUpdate

An update for the ownership information for a Metadata Entity

Arguments

NameDescription
owners
[OwnerUpdate!]!

The updated list of owners

OwnerUpdate

An owner to add to a Metadata Entity TODO Add a USER or GROUP actor enum

Arguments

NameDescription
owner
String!

The owner URN, either a corpGroup or corpuser

type
OwnershipType!

The owner type

PolicyMatchCriterionInput

Criterion to define relationship between field and values

Arguments

NameDescription
field
String!

The name of the field that the criterion refers to e.g. entity_type, entity_urn, domain

values
[String!]!

Values. Matches criterion if any one of the values matches condition (OR-relationship)

condition
PolicyMatchCondition!

The name of the field that the criterion refers to

PolicyMatchFilterInput

Filter object that encodes a complex filter logic with OR + AND

Arguments

NameDescription
criteria
[PolicyMatchCriterionInput!]

List of criteria to apply

PolicyUpdateInput

Input provided when creating or updating an Access Policy

Arguments

NameDescription
type
PolicyType!

The Policy Type

name
String!

The Policy name

state
PolicyState!

The Policy state

description
String

A Policy description

resources
ResourceFilterInput

The set of resources that the Policy privileges apply to

privileges
[String!]!

The set of privileges that the Policy grants

actors
ActorFilterInput!

The set of actors that the Policy privileges are granted to

QueryStatementInput

Input required for creating a Query Statement

Arguments

NameDescription
value
String!

The query text

language
QueryLanguage!

The query language

RecommendationRequestContext

Context that defines the page requesting recommendations i.e. for search pages, the query/filters. for entity pages, the entity urn and tab

Arguments

NameDescription
scenario
ScenarioType!

Scenario in which the recommendations will be displayed

searchRequestContext
SearchRequestContext

Additional context for defining the search page requesting recommendations

entityRequestContext
EntityRequestContext

Additional context for defining the entity page requesting recommendations

RelatedTermsInput

Input provided when adding Terms to an asset

Arguments

NameDescription
urn
String!

The Glossary Term urn to add or remove this relationship to/from

termUrns
[String!]!

The primary key of the Glossary Term to add or remove

relationshipType
TermRelationshipType!

The type of relationship we're adding or removing to/from for a Glossary Term

RelationshipsInput

Input for the list relationships field of an Entity

Arguments

NameDescription
types
[String!]!

The types of relationships to query, representing an OR

direction
RelationshipDirection!

The direction of the relationship, either incoming or outgoing from the source entity

start
Int

The starting offset of the result set

count
Int

The number of results to be returned

RemoveGroupMembersInput

Input required to remove members from an external DataHub group

Arguments

NameDescription
groupUrn
String!

The group to remove members from

userUrns
[String!]!

The members to remove from the group

RemoveLinkInput

Input provided when removing the association between a Metadata Entity and a Link

Arguments

NameDescription
linkUrl
String!

The url of the link to add or remove, which uniquely identifies the Link

resourceUrn
String!

The urn of the resource or entity to attach the link to, for example a dataset urn

RemoveNativeGroupMembersInput

Input required to remove members from a native DataHub group

Arguments

NameDescription
groupUrn
String!

The group to remove members from

userUrns
[String!]!

The members to remove from the group

RemoveOwnerInput

Input provided when removing the association between a Metadata Entity and an user or group owner

Arguments

NameDescription
ownerUrn
String!

The primary key of the Owner to add or remove

resourceUrn
String!

The urn of the resource or entity to attach or remove the owner from, for example a dataset urn

ReportOperationInput

Input provided to report an asset operation

Arguments

NameDescription
urn
String!

The urn of the asset (e.g. dataset) to report the operation for

operationType
OperationType!

The type of operation that was performed. Required

customOperationType
String

A custom type of operation. Required if operation type is CUSTOM.

sourceType
OperationSourceType!

The source or reporter of the operation

customProperties
[StringMapEntryInput!]

A list of key-value parameters to include

partition
String

An optional partition identifier

numAffectedRows
Long

Optional: The number of affected rows

timestampMillis
Long

Optional: Provide a timestamp associated with the operation. If not provided, one will be generated for you based on the current time.

ResourceFilterInput

Input required when creating or updating an Access Policies Determines which resources the Policy applies to

Arguments

NameDescription
type
String

The type of the resource the policy should apply to Not required because in the future we want to support filtering by type OR by domain

resources
[String!]

A list of specific resource urns to apply the filter to

allResources
Boolean

Whether of not to apply the filter to all resources of the type

filter
PolicyMatchFilterInput

Whether of not to apply the filter to all resources of the type

ResourceRefInput

Reference to a resource to apply an action to

Arguments

NameDescription
resourceUrn
String!

The urn of the resource being referenced

subResourceType
SubResourceType

An optional type of a sub resource to attach the Tag to

subResource
String

An optional sub resource identifier to attach the Tag to

ResourceSpec

Spec to identify resource

Arguments

NameDescription
resourceType
EntityType!

Resource type

resourceUrn
String!

Resource urn

RollbackIngestionInput

Input for rolling back an ingestion execution

Arguments

NameDescription
runId
String!

An ingestion run ID

ScrollAcrossEntitiesInput

Input arguments for a full text search query across entities, specifying a starting pointer. Allows paging beyond 10k results

Arguments

NameDescription
types
[EntityType!]

Entity types to be searched. If this is not provided, all entities will be searched.

query
String!

The query string

scrollId
String

The starting point of paginated results, an opaque ID the backend understands as a pointer

keepAlive
String

The amount of time to keep the point in time snapshot alive, takes a time unit based string ex: 5m or 30s

count
Int

The number of elements included in the results

orFilters
[AndFilterInput!]

A list of disjunctive criterion for the filter. (or operation to combine filters)

viewUrn
String

Optional - A View to apply when generating results

searchFlags
SearchFlags

Flags controlling search options

ScrollAcrossLineageInput

Input arguments for a search query over the results of a multi-hop graph query, uses scroll API

Arguments

NameDescription
urn
String

Urn of the source node

direction
LineageDirection!

The direction of the relationship, either incoming or outgoing from the source entity

types
[EntityType!]

Entity types to be searched. If this is not provided, all entities will be searched.

query
String

The query string

scrollId
String

The starting point of paginated results, an opaque ID the backend understands as a pointer

keepAlive
String

The amount of time to keep the point in time snapshot alive, takes a time unit based string ex: 5m or 30s

count
Int

The number of elements included in the results

orFilters
[AndFilterInput!]

A list of disjunctive criterion for the filter. (or operation to combine filters)

startTimeMillis
Long

An optional starting time to filter on

endTimeMillis
Long

An optional ending time to filter on

searchFlags
SearchFlags

Flags controlling search options

SearchAcrossEntitiesInput

Input arguments for a full text search query across entities

Arguments

NameDescription
types
[EntityType!]

Entity types to be searched. If this is not provided, all entities will be searched.

query
String!

The query string

start
Int

The starting point of paginated results

count
Int

The number of elements included in the results

filters
[FacetFilterInput!]
Deprecated: Use `orFilters`- they are more expressive

Deprecated in favor of the more expressive orFilters field Facet filters to apply to search results. These will be 'AND'-ed together.

orFilters
[AndFilterInput!]

A list of disjunctive criterion for the filter. (or operation to combine filters)

viewUrn
String

Optional - A View to apply when generating results

searchFlags
SearchFlags

Flags controlling search options

SearchAcrossLineageInput

Input arguments for a search query over the results of a multi-hop graph query

Arguments

NameDescription
urn
String

Urn of the source node

direction
LineageDirection!

The direction of the relationship, either incoming or outgoing from the source entity

types
[EntityType!]

Entity types to be searched. If this is not provided, all entities will be searched.

query
String

The query string

start
Int

The starting point of paginated results

count
Int

The number of elements included in the results

filters
[FacetFilterInput!]
Deprecated: Use `orFilters`- they are more expressive

Deprecated in favor of the more expressive orFilters field Facet filters to apply to search results. These will be 'AND'-ed together.

orFilters
[AndFilterInput!]

A list of disjunctive criterion for the filter. (or operation to combine filters)

startTimeMillis
Long

An optional starting time to filter on

endTimeMillis
Long

An optional ending time to filter on

searchFlags
SearchFlags

Flags controlling search options

SearchFlags

Set of flags to control search behavior

Arguments

NameDescription
skipCache
Boolean

Whether to skip cache

maxAggValues
Int

The maximum number of values in an facet aggregation

fulltext
Boolean

Structured or unstructured fulltext query

skipHighlighting
Boolean

Whether to skip highlighting

skipAggregates
Boolean

Whether to skip aggregates/facets

SearchInput

Input arguments for a full text search query

Arguments

NameDescription
type
EntityType!

The Metadata Entity type to be searched against

query
String!

The raw query string

start
Int

The offset of the result set

count
Int

The number of entities to include in result set

filters
[FacetFilterInput!]
Deprecated: Use `orFilters`- they are more expressive

Deprecated in favor of the more expressive orFilters field Facet filters to apply to search results. These will be 'AND'-ed together.

orFilters
[AndFilterInput!]

A list of disjunctive criterion for the filter. (or operation to combine filters)

searchFlags
SearchFlags

Flags controlling search options

SearchRequestContext

Context that defines a search page requesting recommendatinos

Arguments

NameDescription
query
String!

Search query

filters
[FacetFilterInput!]

Faceted filters applied to search results

StepStateInput

The input required to update the state of a step

Arguments

NameDescription
id
String!

The globally unique id for the step

properties
[StringMapEntryInput]!

The new properties for the step

StringMapEntryInput

String map entry input

Arguments

NameDescription
key
String!

The key of the map entry

value
String

The value fo the map entry

TagAssociationInput

Input provided when updating the association between a Metadata Entity and a Tag

Arguments

NameDescription
tagUrn
String!

The primary key of the Tag to add or remove

resourceUrn
String!

The target Metadata Entity to add or remove the Tag to

subResourceType
SubResourceType

An optional type of a sub resource to attach the Tag to

subResource
String

An optional sub resource identifier to attach the Tag to

TagAssociationUpdate

Deprecated, use addTag or removeTag mutation instead A tag update to be applied

Arguments

NameDescription
tag
TagUpdateInput!

The tag being applied

TagUpdateInput

Deprecated, use addTag or removeTag mutations instead An update for a particular Tag entity

Arguments

NameDescription
urn
String!

The primary key of the Tag

name
String!

The display name of a Tag

description
String

Description of the tag

ownership
OwnershipUpdate

Ownership metadata of the tag

TermAssociationInput

Input provided when updating the association between a Metadata Entity and a Glossary Term

Arguments

NameDescription
termUrn
String!

The primary key of the Glossary Term to add or remove

resourceUrn
String!

The target Metadata Entity to add or remove the Glossary Term from

subResourceType
SubResourceType

An optional type of a sub resource to attach the Glossary Term to

subResource
String

An optional sub resource identifier to attach the Glossary Term to

TestDefinitionInput

Arguments

NameDescription
json
String

The string representation of the Test

UpdateCorpUserViewsSettingsInput

Input required to update a users settings.

Arguments

NameDescription
defaultView
String

The URN of the View that serves as this user's personal default. If not provided, any existing default view will be removed.

UpdateDataProductInput

Input properties required for update a DataProduct

Arguments

NameDescription
name
String

A display name for the DataProduct

description
String

An optional description for the DataProduct

UpdateDeprecationInput

Input provided when setting the Deprecation status for an Entity.

Arguments

NameDescription
urn
String!

The urn of the Entity to set deprecation for.

deprecated
Boolean!

Whether the Entity is marked as deprecated.

decommissionTime
Long

Optional - The time user plan to decommission this entity

note
String

Optional - Additional information about the entity deprecation plan

UpdateEmbedInput

Input required to set or clear information related to rendering a Data Asset inside of DataHub.

Arguments

NameDescription
urn
String!

The URN associated with the Data Asset to update. Only dataset, dashboard, and chart urns are currently supported.

renderUrl
String

Set or clear a URL used to render an embedded asset.

UpdateGlobalViewsSettingsInput

Input required to update Global View Settings.

Arguments

NameDescription
defaultView
String

The URN of the View that serves as the Global, or organization-wide, default. If this field is not provided, the existing Global Default will be cleared.

UpdateIngestionSourceConfigInput

Input parameters for creating / updating an Ingestion Source

Arguments

NameDescription
recipe
String!

A JSON-encoded recipe

version
String

The version of DataHub Ingestion Framework to use when executing the recipe.

executorId
String!

The id of the executor to use for executing the recipe

debugMode
Boolean

Whether or not to run ingestion in debug mode

UpdateIngestionSourceInput

Input arguments for creating / updating an Ingestion Source

Arguments

NameDescription
name
String!

A name associated with the ingestion source

type
String!

The type of the source itself, e.g. mysql, bigquery, bigquery-usage. Should match the recipe.

description
String

An optional description associated with the ingestion source

schedule
UpdateIngestionSourceScheduleInput

An optional schedule for the ingestion source. If not provided, the source is only available for run on-demand.

config
UpdateIngestionSourceConfigInput!

A set of type-specific ingestion source configurations

UpdateIngestionSourceScheduleInput

Input arguments for creating / updating the schedule of an Ingestion Source

Arguments

NameDescription
interval
String!

The cron-formatted interval describing when the job should be executed

timezone
String!

The name of the timezone in which the cron interval should be scheduled (e.g. America/Los Angeles)

UpdateLineageInput

Input required in order to upsert lineage edges

Arguments

NameDescription
edgesToAdd
[LineageEdge]!

New lineage edges to upsert

edgesToRemove
[LineageEdge]!

Lineage edges to remove. Takes precedence over edgesToAdd - so edges existing both edgesToAdd and edgesToRemove will be removed.

UpdateMediaInput

Input provided for filling in a post content

Arguments

NameDescription
type
MediaType!

The type of media

location
String!

The location of the media (a URL)

UpdateNameInput

Input for updating the name of an entity

Arguments

NameDescription
name
String!

The new name

urn
String!

The primary key of the resource to update the name for

UpdateParentNodeInput

Input for updating the parent node of a resource. Currently only GlossaryNodes and GlossaryTerms have parentNodes.

Arguments

NameDescription
parentNode
String

The new parent node urn. If parentNode is null, this will remove the parent from this entity

resourceUrn
String!

The primary key of the resource to update the parent node for

UpdatePostContentInput

Input provided for filling in a post content

Arguments

NameDescription
contentType
PostContentType!

The type of post content

title
String!

The title of the post

description
String

Optional content of the post

link
String

Optional link that the post is associated with

media
UpdateMediaInput

Optional media contained in the post

UpdateQueryInput

Input required for updating an existing Query. Requires the 'Edit Queries' privilege for all query subjects.

Arguments

NameDescription
properties
UpdateQueryPropertiesInput

Properties about the Query

subjects
[UpdateQuerySubjectInput!]

Subjects for the query

UpdateQueryPropertiesInput

Input properties required for creating a Query. Any non-null fields will be updated if provided.

Arguments

NameDescription
name
String

An optional display name for the Query

description
String

An optional description for the Query

statement
QueryStatementInput

The Query contents

UpdateQuerySubjectInput

Input required for creating a Query. For now, only datasets are supported.

Arguments

NameDescription
datasetUrn
String!

The urn of the dataset that is the subject of the query

UpdateTestInput

Arguments

NameDescription
name
String!

The name of the Test

category
String!

The category of the Test (user defined)

description
String

Description of the test

definition
TestDefinitionInput!

The test definition

UpdateUserSettingInput

Input for updating a user setting

Arguments

NameDescription
name
UserSetting!

The name of the setting

value
Boolean!

The new value of the setting

UpdateViewInput

Input provided when updating a DataHub View

Arguments

NameDescription
name
String

The name of the View

description
String

An optional description of the View

definition
DataHubViewDefinitionInput

The view definition itself