Queries
appConfig
Type: AppConfig
Fetch configurations Used by DataHub UI
assertion
Type: Assertion
Fetch an Assertion by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
autoComplete
Type: AutoCompleteResults
Autocomplete a search query against a specific DataHub Entity Type
Arguments
Name | Description |
---|---|
inputAutoCompleteInput! |
autoCompleteForMultiple
Type: AutoCompleteMultipleResults
Autocomplete a search query against a specific set of DataHub Entity Types
Arguments
Name | Description |
---|---|
inputAutoCompleteMultipleInput! |
batchGetStepStates
Type: BatchGetStepStatesResult!
Batch fetch the state for a set of steps.
Arguments
Name | Description |
---|---|
inputBatchGetStepStatesInput! |
browse
Type: BrowseResults
Hierarchically browse a specific type of DataHub Entity by path Used by explore in the UI
Arguments
Name | Description |
---|---|
inputBrowseInput! |
browsePaths
Type: [BrowsePath!]
Retrieve the browse paths corresponding to an entity
Arguments
Name | Description |
---|---|
inputBrowsePathsInput! |
chart
Type: Chart
Fetch a Chart by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
container
Type: Container
Fetch an Entity Container by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
corpGroup
Type: CorpGroup
Fetch a CorpGroup, representing a DataHub platform group by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
corpUser
Type: CorpUser
Fetch a CorpUser, representing a DataHub platform user, by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
dashboard
Type: Dashboard
Fetch a Dashboard by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
dataFlow
Type: DataFlow
Fetch a Data Flow (or Data Pipeline) by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
dataJob
Type: DataJob
Fetch a Data Job (or Data Task) by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
dataPlatform
Type: DataPlatform
Fetch a Data Platform by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
dataset
Type: Dataset
Fetch a Dataset by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
domain
Type: Domain
Fetch a Domain by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
entities
Type: [Entity]
Gets entities based on their urns
Arguments
Name | Description |
---|---|
urns[String!]! |
entity
Type: Entity
Gets an entity based on its urn
Arguments
Name | Description |
---|---|
urnString! |
entityExists
Type: Boolean
Get whether or not not an entity exists
Arguments
Name | Description |
---|---|
urnString! |
executionRequest
Type: ExecutionRequest
Get an execution request urn: The primary key associated with the execution request.
Arguments
Name | Description |
---|---|
urnString! |
getAccessToken
Type: AccessToken
Generates an access token for DataHub APIs for a particular user & of a particular type Deprecated, use createAccessToken instead
Arguments
Name | Description |
---|---|
inputGetAccessTokenInput! |
getAnalyticsCharts
Type: [AnalyticsChartGroup!]!
Retrieves a set of server driven Analytics Charts to render in the UI
getEntityCounts
Type: EntityCountResults
Fetches the number of entities ingested by type
Arguments
Name | Description |
---|---|
inputEntityCountInput |
getGrantedPrivileges
Type: Privileges
Get all granted privileges for the given actor and resource
Arguments
Name | Description |
---|---|
inputGetGrantedPrivilegesInput! |
getHighlights
Type: [Highlight!]!
Retrieves a set of server driven Analytics Highlight Cards to render in the UI
getInviteToken
Type: InviteToken
Get invite token
Arguments
Name | Description |
---|---|
inputGetInviteTokenInput! |
getMetadataAnalyticsCharts
Type: [AnalyticsChartGroup!]!
Retrieves a set of charts regarding the ingested metadata
Arguments
Name | Description |
---|---|
inputMetadataAnalyticsInput! |
getRootGlossaryNodes
Type: GetRootGlossaryNodesResult
Get all GlossaryNodes without a parentNode
Arguments
Name | Description |
---|---|
inputGetRootGlossaryEntitiesInput! |
getRootGlossaryTerms
Type: GetRootGlossaryTermsResult
Get all GlossaryTerms without a parentNode
Arguments
Name | Description |
---|---|
inputGetRootGlossaryEntitiesInput! |
getSchemaBlame
Type: GetSchemaBlameResult
Returns the most recent changes made to each column in a dataset at each dataset version.
Arguments
Name | Description |
---|---|
inputGetSchemaBlameInput! |
getSchemaVersionList
Type: GetSchemaVersionListResult
Returns the list of schema versions for a dataset.
Arguments
Name | Description |
---|---|
inputGetSchemaVersionListInput! |
getSecretValues
Type: [SecretValue!]
Fetch the values of a set of secrets. The caller must have the MANAGE_SECRETS privilege to use.
Arguments
Name | Description |
---|---|
inputGetSecretValuesInput! |
globalViewsSettings
Type: GlobalViewsSettings
Fetch the Global Settings related to the Views feature. Requires the 'Manage Global Views' Platform Privilege.
glossaryNode
Type: GlossaryNode
Fetch a Glossary Node by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
glossaryTerm
Type: GlossaryTerm
Fetch a Glossary Term by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
ingestionSource
Type: IngestionSource
Fetch a specific ingestion source urn: The primary key associated with the ingestion source.
Arguments
Name | Description |
---|---|
urnString! |
isAnalyticsEnabled
Type: Boolean!
Deprecated, use appConfig Query instead Whether the analytics feature is enabled in the UI
listAccessTokens
Type: ListAccessTokenResult!
List access tokens stored in DataHub.
Arguments
Name | Description |
---|---|
inputListAccessTokenInput! |
listDomains
Type: ListDomainsResult
List all DataHub Domains
Arguments
Name | Description |
---|---|
inputListDomainsInput! |
listGlobalViews
Type: ListViewsResult
List Global DataHub Views
Arguments
Name | Description |
---|---|
inputListGlobalViewsInput! |
listGroups
Type: ListGroupsResult
List all DataHub Groups
Arguments
Name | Description |
---|---|
inputListGroupsInput! |
listIngestionSources
Type: ListIngestionSourcesResult
List all ingestion sources
Arguments
Name | Description |
---|---|
inputListIngestionSourcesInput! |
listMyViews
Type: ListViewsResult
List DataHub Views owned by the current user
Arguments
Name | Description |
---|---|
inputListMyViewsInput! |
listPolicies
Type: ListPoliciesResult
List all DataHub Access Policies
Arguments
Name | Description |
---|---|
inputListPoliciesInput! |
listPosts
Type: ListPostsResult
List all Posts
Arguments
Name | Description |
---|---|
inputListPostsInput! |
listQueries
Type: ListQueriesResult
List Dataset Queries
Arguments
Name | Description |
---|---|
inputListQueriesInput! | Input required for listing queries |
listRecommendations
Type: ListRecommendationsResult
Fetch recommendations for a particular scenario
Arguments
Name | Description |
---|---|
inputListRecommendationsInput! |
listRoles
Type: ListRolesResult
List all DataHub Roles
Arguments
Name | Description |
---|---|
inputListRolesInput! |
listSecrets
Type: ListSecretsResult
List all secrets stored in DataHub (no values)
Arguments
Name | Description |
---|---|
inputListSecretsInput! |
listTests
Type: ListTestsResult
List all DataHub Tests
Arguments
Name | Description |
---|---|
inputListTestsInput! |
listUsers
Type: ListUsersResult
List all DataHub Users
Arguments
Name | Description |
---|---|
inputListUsersInput! |
me
Type: AuthenticatedUser
Fetch details associated with the authenticated user, provided via an auth cookie or header
mlFeature
Type: MLFeature
Incubating: Fetch a ML Feature by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
mlFeatureTable
Type: MLFeatureTable
Incubating: Fetch a ML Feature Table by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
mlModel
Type: MLModel
Incubating: Fetch an ML Model by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
mlModelGroup
Type: MLModelGroup
Incubating: Fetch an ML Model Group by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
mlPrimaryKey
Type: MLPrimaryKey
Incubating: Fetch a ML Primary Key by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
notebook
Type: Notebook
Fetch a Notebook by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
scrollAcrossEntities
Type: ScrollResults
Search DataHub entities by providing a pointer reference for scrolling through results.
Arguments
Name | Description |
---|---|
inputScrollAcrossEntitiesInput! |
scrollAcrossLineage
Type: ScrollAcrossLineageResults
Search across the results of a graph query on a node, uses scroll API
Arguments
Name | Description |
---|---|
inputScrollAcrossLineageInput! |
search
Type: SearchResults
Full text search against a specific DataHub Entity Type
Arguments
Name | Description |
---|---|
inputSearchInput! |
searchAcrossEntities
Type: SearchResults
Search DataHub entities
Arguments
Name | Description |
---|---|
inputSearchAcrossEntitiesInput! |
searchAcrossLineage
Type: SearchAcrossLineageResults
Search across the results of a graph query on a node
Arguments
Name | Description |
---|---|
inputSearchAcrossLineageInput! |
tag
Type: Tag
Fetch a Tag by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
test
Type: Test
Fetch a Test by primary key (urn)
Arguments
Name | Description |
---|---|
urnString! |
versionedDataset
Type: VersionedDataset
Fetch a Dataset by primary key (urn) at a point in time based on aspect versions (versionStamp)
Arguments
Name | Description |
---|---|
urnString! | |
versionStampString |