OBJECT

DataCloud

A Data Cloud connection
Available in Tableau Cloud February 2024 / Server 2024.2 and later.

link GraphQL Schema definition

  • type DataCloud implements Database, Warnable, Certifiable, CanHaveLabels, Taggable {
  • # Unique identifier used with the Metadata API. Not the same as the locally
  • # unique identifier used with the REST API.
  • id: ID!
  • # Vizportal ID of this database, for use in client-to-server communications
  • vizportalId: String!
  • # Locally unique identifier used with the REST API.
  • luid: String!
  • # Name shown in server and desktop clients
  • name: String
  • # Connection type shortname
  • connectionType: String
  • # True if this database is embedded in Tableau content, e.g., a packaged workbook
  • isEmbedded: Boolean
  • # User modifiable description of this database
  • description: String
  • # The ID of the project in which the database is visible. Will be empty if the
  • # database is not in a project.
  • projectVizportalUrlId: String
  • # The name of the project in which the database is visible. Will be empty if the
  • # database is not in a project.
  • projectName: String
  • # Contact for this database
  • contact: TableauUser
  • # True if this database contains an active data quality certification
  • isCertified: Boolean!
  • # True if this database has its permission locked
  • isControlledPermissionsEnabled: Boolean
  • # True if this database has been grouped with other databases
  • isGrouped: Boolean
  • # Notes related to this database being marked as certified
  • certificationNote: String @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" )
  • # User who marked this database as certified
  • certifier: TableauUser @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" )
  • # True if the database has an active data quality warning
  • hasActiveWarning: Boolean!
  • # The optional data quality warning on a database
  • dataQualityWarning: DataQualityWarning @deprecated( reason: "Use 'dataQualityWarnings'" )
  • # The data quality warnings on a database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • dataQualityWarnings(
  • filter: DataQualityWarning_Filter,
  • orderBy: DataQualityWarningSortOrder,
  • permissionMode: PermissionMode
  • ): [DataQualityWarning!]!
  • # The data quality warnings on a database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • dataQualityWarningsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: DataQualityWarning_Filter,
  • orderBy: DataQualityWarningSortOrder,
  • permissionMode: PermissionMode
  • ): DataQualityWarningsConnection
  • # The data quality certifications on a database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • dataQualityCertifications(
  • filter: DataQualityCertification_Filter,
  • orderBy: DataQualityCertificationSortOrder,
  • permissionMode: PermissionMode
  • ): [DataQualityCertification!]!
  • # The data quality certifications on a database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • dataQualityCertificationsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: DataQualityCertification_Filter,
  • orderBy: DataQualityCertificationSortOrder,
  • permissionMode: PermissionMode
  • ): DataQualityCertificationsConnection
  • # The labels on a database. Available in Tableau Cloud March 2023 / Server 2023.1
  • # and later.
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • labels(
  • filter: Label_Filter,
  • orderBy: LabelSortOrder,
  • permissionMode: PermissionMode
  • ): [Label!]!
  • # The labels on a database. Available in Tableau Cloud March 2023 / Server 2023.1
  • # and later.
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • labelsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Label_Filter,
  • orderBy: LabelSortOrder,
  • permissionMode: PermissionMode
  • ): LabelsConnection
  • # Data quality warnings upstream from this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamDataQualityWarnings(
  • filter: DataQualityWarning_Filter,
  • orderBy: DataQualityWarningSortOrder,
  • permissionMode: PermissionMode
  • ): [DataQualityWarning!]!
  • # Data quality warnings upstream from this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamDataQualityWarningsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: DataQualityWarning_Filter,
  • orderBy: DataQualityWarningSortOrder,
  • permissionMode: PermissionMode
  • ): DataQualityWarningsConnection
  • # Labels upstream from this database. Available in Tableau Cloud March 2023 /
  • # Server 2023.1 and later.
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamLabels(
  • filter: Label_Filter,
  • orderBy: LabelSortOrder,
  • permissionMode: PermissionMode
  • ): [Label!]!
  • # Labels upstream from this database. Available in Tableau Cloud March 2023 /
  • # Server 2023.1 and later.
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamLabelsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Label_Filter,
  • orderBy: LabelSortOrder,
  • permissionMode: PermissionMode
  • ): LabelsConnection
  • # Tags associated with the database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • tags(filter: Tag_Filter, orderBy: TagSortOrder): [Tag!]!
  • # Tags associated with the database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • tagsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Tag_Filter,
  • orderBy: TagSortOrder
  • ): TagsConnection
  • # Databases upstream of this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamDatabases(
  • filter: Database_Filter,
  • orderBy: DatabaseSortOrder,
  • permissionMode: PermissionMode
  • ): [Database!]!
  • # Databases upstream of this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamDatabasesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Database_Filter,
  • orderBy: DatabaseSortOrder,
  • permissionMode: PermissionMode
  • ): DatabasesConnection
  • # Tables upstream of this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamTables(
  • filter: DatabaseTable_Filter,
  • orderBy: DatabaseTableSortOrder,
  • permissionMode: PermissionMode
  • ): [DatabaseTable!]!
  • # Tables upstream of this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamTablesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: DatabaseTable_Filter,
  • orderBy: DatabaseTableSortOrder,
  • permissionMode: PermissionMode
  • ): DatabaseTablesConnection
  • # Virtual connection tables upstream of this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamVirtualConnections(
  • filter: VirtualConnection_Filter,
  • orderBy: VirtualConnectionSortOrder,
  • permissionMode: PermissionMode
  • ): [VirtualConnection!]!
  • # Virtual connection tables upstream of this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamVirtualConnectionsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: VirtualConnection_Filter,
  • orderBy: VirtualConnectionSortOrder,
  • permissionMode: PermissionMode
  • ): VirtualConnectionsConnection
  • # Virtual connection tables upstream of this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamVirtualConnectionTables(
  • filter: VirtualConnectionTable_Filter,
  • orderBy: VirtualConnectionTableSortOrder,
  • permissionMode: PermissionMode
  • ): [VirtualConnectionTable!]!
  • # Virtual connection tables upstream of this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamVirtualConnectionTablesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: VirtualConnectionTable_Filter,
  • orderBy: VirtualConnectionTableSortOrder,
  • permissionMode: PermissionMode
  • ): VirtualConnectionTablesConnection
  • # Flows upstream of this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamFlows(
  • filter: Flow_Filter,
  • orderBy: FlowSortOrder,
  • permissionMode: PermissionMode
  • ): [Flow!]!
  • # Flows upstream of this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamFlowsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Flow_Filter,
  • orderBy: FlowSortOrder,
  • permissionMode: PermissionMode
  • ): FlowsConnection
  • # Datasources upstream of this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamDatasources(
  • filter: PublishedDatasource_Filter,
  • orderBy: PublishedDatasourceSortOrder,
  • permissionMode: PermissionMode
  • ): [PublishedDatasource!]!
  • # Datasources upstream of this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • upstreamDatasourcesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: PublishedDatasource_Filter,
  • orderBy: PublishedDatasourceSortOrder,
  • permissionMode: PermissionMode
  • ): PublishedDatasourcesConnection
  • # Databases downstream of this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamDatabases(
  • filter: Database_Filter,
  • orderBy: DatabaseSortOrder,
  • permissionMode: PermissionMode
  • ): [Database!]!
  • # Databases downstream of this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamDatabasesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Database_Filter,
  • orderBy: DatabaseSortOrder,
  • permissionMode: PermissionMode
  • ): DatabasesConnection
  • # Tables downstream of this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamTables(
  • filter: DatabaseTable_Filter,
  • orderBy: DatabaseTableSortOrder,
  • permissionMode: PermissionMode
  • ): [DatabaseTable!]!
  • # Tables downstream of this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamTablesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: DatabaseTable_Filter,
  • orderBy: DatabaseTableSortOrder,
  • permissionMode: PermissionMode
  • ): DatabaseTablesConnection
  • # Virtual connection tables downstream of this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamVirtualConnections(
  • filter: VirtualConnection_Filter,
  • orderBy: VirtualConnectionSortOrder,
  • permissionMode: PermissionMode
  • ): [VirtualConnection!]!
  • # Virtual connection tables downstream of this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamVirtualConnectionsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: VirtualConnection_Filter,
  • orderBy: VirtualConnectionSortOrder,
  • permissionMode: PermissionMode
  • ): VirtualConnectionsConnection
  • # Virtual connection tables downstream of this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamVirtualConnectionTables(
  • filter: VirtualConnectionTable_Filter,
  • orderBy: VirtualConnectionTableSortOrder,
  • permissionMode: PermissionMode
  • ): [VirtualConnectionTable!]!
  • # Virtual connection tables downstream of this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamVirtualConnectionTablesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: VirtualConnectionTable_Filter,
  • orderBy: VirtualConnectionTableSortOrder,
  • permissionMode: PermissionMode
  • ): VirtualConnectionTablesConnection
  • # Flows downstream of this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamFlows(
  • filter: Flow_Filter,
  • orderBy: FlowSortOrder,
  • permissionMode: PermissionMode
  • ): [Flow!]!
  • # Flows downstream of this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamFlowsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Flow_Filter,
  • orderBy: FlowSortOrder,
  • permissionMode: PermissionMode
  • ): FlowsConnection
  • # Published datasources connected to the database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamDatasources(
  • filter: PublishedDatasource_Filter,
  • orderBy: PublishedDatasourceSortOrder,
  • permissionMode: PermissionMode
  • ): [PublishedDatasource!]!
  • # Published datasources connected to the database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamDatasourcesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: PublishedDatasource_Filter,
  • orderBy: PublishedDatasourceSortOrder,
  • permissionMode: PermissionMode
  • ): PublishedDatasourcesConnection
  • # Lenses connected to the database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamLenses(
  • filter: Lens_Filter,
  • orderBy: LensSortOrder,
  • permissionMode: PermissionMode
  • ): [Lens!]!
  • # Lenses connected to the database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamLensesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Lens_Filter,
  • orderBy: LensSortOrder,
  • permissionMode: PermissionMode
  • ): LensesConnection
  • # Workbooks connected to the database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamWorkbooks(
  • filter: Workbook_Filter,
  • orderBy: WorkbookSortOrder,
  • permissionMode: PermissionMode
  • ): [Workbook!]!
  • # Workbooks connected to the database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamWorkbooksConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Workbook_Filter,
  • orderBy: WorkbookSortOrder,
  • permissionMode: PermissionMode
  • ): WorkbooksConnection
  • # Dashboards connected to the database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamDashboards(
  • filter: Dashboard_Filter,
  • orderBy: DashboardSortOrder,
  • permissionMode: PermissionMode
  • ): [Dashboard!]!
  • # Dashboards connected to the database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamDashboardsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Dashboard_Filter,
  • orderBy: DashboardSortOrder,
  • permissionMode: PermissionMode
  • ): DashboardsConnection
  • # Sheets connected to the database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamSheets(
  • filter: Sheet_Filter,
  • orderBy: SheetSortOrder,
  • permissionMode: PermissionMode
  • ): [Sheet!]!
  • # Sheets connected to the database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamSheetsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Sheet_Filter,
  • orderBy: SheetSortOrder,
  • permissionMode: PermissionMode
  • ): SheetsConnection
  • # Metrics connected to the database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamMetrics(
  • filter: Metric_Filter,
  • orderBy: MetricSortOrder,
  • permissionMode: PermissionMode
  • ): [Metric!]!
  • # Metrics connected to the database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamMetricsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Metric_Filter,
  • orderBy: MetricSortOrder,
  • permissionMode: PermissionMode
  • ): MetricsConnection
  • # Owners connected to the database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • downstreamOwners(
  • filter: TableauUser_Filter,
  • orderBy: TableauUserSortOrder
  • ): [TableauUser!]!
  • # Owners connected to the database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • downstreamOwnersConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: TableauUser_Filter,
  • orderBy: TableauUserSortOrder
  • ): TableauUsersConnection
  • # The custom SQL queries that reference this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • referencedByQueries(
  • filter: CustomSQLTable_Filter,
  • orderBy: CustomSQLTableSortOrder,
  • permissionMode: PermissionMode
  • ): [CustomSQLTable]
  • # The custom SQL queries that reference this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • referencedByQueriesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: CustomSQLTable_Filter,
  • orderBy: CustomSQLTableSortOrder,
  • permissionMode: PermissionMode
  • ): CustomSQLTablesConnection
  • # Tables belonging to this database
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • tables(
  • filter: DatabaseTable_Filter,
  • orderBy: DatabaseTableSortOrder,
  • permissionMode: PermissionMode
  • ): [DatabaseTable]
  • # Tables belonging to this database
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • tablesConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: DatabaseTable_Filter,
  • orderBy: DatabaseTableSortOrder,
  • permissionMode: PermissionMode
  • ): DatabaseTablesConnection
  • # Metric definitions downstream from this database.
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamMetricDefinitions(
  • filter: MetricDefinition_Filter,
  • orderBy: MetricDefinitionSortOrder,
  • permissionMode: PermissionMode
  • ): [MetricDefinition]!
  • # Metric definitions downstream from this database.
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • downstreamMetricDefinitionsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: MetricDefinition_Filter,
  • orderBy: MetricDefinitionSortOrder,
  • permissionMode: PermissionMode
  • ): MetricDefinitionsConnection
  • }