INTERFACE
Database
A database containing tables
link GraphQL Schema definition
- interface Database {
- # Unique identifier used by the Metadata API. Not the same as the numeric ID used
- # on server
- ID! :
- # Vizportal ID of this database, for use in client-to-server communications
- String! :
- # Locally unique identifier used for the REST API on the Tableau Server
- String! :
- # Name shown in server and desktop clients
- String :
- # Connection type shortname
- String :
- # True if this database is embedded in Tableau content, e.g., a packaged workbook
- Boolean :
- # User modifiable description of this database
- String :
- # The ID of the project in which the database is visible. Will be empty if the
- # database is not in a project.
- String :
- # The name of the project in which the database is visible. Will be empty if the
- # database is not in a project.
- String :
- # Contact for this database
- TableauUser :
- # True if this database contains an active data quality certification
- Boolean! :
- # True if this database has its permission locked
- Boolean :
- # True if this database has been grouped with other databases
- Boolean :
- # Notes related to this database being marked as certified
- String @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) :
- # User who marked this database as certified
- TableauUser @deprecated( reason: "No longer supported. Use 'dataQualityCertifications'" ) :
- # True if the database has an active data quality warning
- Boolean! :
- # The optional data quality warning on a database
- 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.
- (
- DataQualityWarning_Filter, :
- DataQualityWarningSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- DataQualityWarning_Filter, :
- DataQualityWarningSortOrder, :
- 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.
- (
- DataQualityCertification_Filter, :
- DataQualityCertificationSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- DataQualityCertification_Filter, :
- DataQualityCertificationSortOrder, :
- 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.
- (
- Label_Filter, :
- LabelSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- Label_Filter, :
- LabelSortOrder, :
- 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.
- (
- DataQualityWarning_Filter, :
- DataQualityWarningSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- DataQualityWarning_Filter, :
- DataQualityWarningSortOrder, :
- 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.
- (
- Label_Filter, :
- LabelSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- Label_Filter, :
- LabelSortOrder, :
- 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.
- Tag_Filter, : 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.
- (
- String, :
- Int, :
- Int, :
- Tag_Filter, :
- 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.
- (
- Database_Filter, :
- DatabaseSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- Database_Filter, :
- DatabaseSortOrder, :
- 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.
- (
- DatabaseTable_Filter, :
- DatabaseTableSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- DatabaseTable_Filter, :
- DatabaseTableSortOrder, :
- 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.
- (
- VirtualConnection_Filter, :
- VirtualConnectionSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- VirtualConnection_Filter, :
- VirtualConnectionSortOrder, :
- 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.
- (
- VirtualConnectionTable_Filter, :
- VirtualConnectionTableSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- VirtualConnectionTable_Filter, :
- VirtualConnectionTableSortOrder, :
- 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.
- (
- Flow_Filter, :
- FlowSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- Flow_Filter, :
- FlowSortOrder, :
- 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.
- (
- PublishedDatasource_Filter, :
- PublishedDatasourceSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- PublishedDatasource_Filter, :
- PublishedDatasourceSortOrder, :
- 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.
- (
- Database_Filter, :
- DatabaseSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- Database_Filter, :
- DatabaseSortOrder, :
- 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.
- (
- DatabaseTable_Filter, :
- DatabaseTableSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- DatabaseTable_Filter, :
- DatabaseTableSortOrder, :
- 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.
- (
- VirtualConnection_Filter, :
- VirtualConnectionSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- VirtualConnection_Filter, :
- VirtualConnectionSortOrder, :
- 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.
- (
- VirtualConnectionTable_Filter, :
- VirtualConnectionTableSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- VirtualConnectionTable_Filter, :
- VirtualConnectionTableSortOrder, :
- 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.
- (
- Flow_Filter, :
- FlowSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- Flow_Filter, :
- FlowSortOrder, :
- 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.
- (
- PublishedDatasource_Filter, :
- PublishedDatasourceSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- PublishedDatasource_Filter, :
- PublishedDatasourceSortOrder, :
- 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.
- (
- Lens_Filter, :
- LensSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- Lens_Filter, :
- LensSortOrder, :
- 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.
- (
- Workbook_Filter, :
- WorkbookSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- Workbook_Filter, :
- WorkbookSortOrder, :
- 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.
- (
- Dashboard_Filter, :
- DashboardSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- Dashboard_Filter, :
- DashboardSortOrder, :
- 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.
- (
- Sheet_Filter, :
- SheetSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- Sheet_Filter, :
- SheetSortOrder, :
- 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.
- (
- Metric_Filter, :
- MetricSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- Metric_Filter, :
- MetricSortOrder, :
- 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.
- (
- TableauUser_Filter, :
- 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.
- (
- String, :
- Int, :
- Int, :
- TableauUser_Filter, :
- 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.
- (
- CustomSQLTable_Filter, :
- CustomSQLTableSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- CustomSQLTable_Filter, :
- CustomSQLTableSortOrder, :
- 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.
- (
- DatabaseTable_Filter, :
- DatabaseTableSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- DatabaseTable_Filter, :
- DatabaseTableSortOrder, :
- 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.
- (
- MetricDefinition_Filter, :
- MetricDefinitionSortOrder, :
- 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.
- (
- String, :
- Int, :
- Int, :
- MetricDefinition_Filter, :
- MetricDefinitionSortOrder, :
- PermissionMode :
- ): MetricDefinitionsConnection
- }
link Require by
- BinFieldGraphQL type for a binned continuous measure field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_bins.html
- CalculatedFieldGraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_calculatedfields.html
- CloudFileA cloud file connection
- ColumnGraphQL type for a table column
- ColumnFieldColumnFields are a type of field which directly connects to a column in some type of table.
- CombinedFieldGraphQL type for a combined field. Combined fields concatanate fields together into one string.
- CombinedSetFieldGraphQL type for a combined set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html#Combine
- CustomSQLTableA table that represents the result of evaluating a custom SQL query. These "tables" are owned by the Tableau data source (embedded or published) which contains the SQL query, so they only exist within that data source.
- DashboardA dashboard contained in a published workbook.
- DatabaseA database containing tables
- DatabasesConnectionConnection Type for Database
- DatabaseServerA database server connection
- DatabaseTableA table that is contained in a database
- DataCloudA Data Cloud connection *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*
- DatasourceRoot GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm
- DatasourceFieldGraphQL type for a data source field. Data source fields can only exist in embedded data sources which connect to a published data source. A data source field is an embedded data source's 'layered' representation of a field that already exists in the published data source and is mostly a copy of the field in the published data source. Data source fields can get their own descriptions and renames local to the embedded data source, but cannot otherwise be modified in the embedded data source.
- EmbeddedDatasourceA data source embedded in a workbook
- FieldBase GraphQL type for a field
- FieldReferencingFieldBase GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.
- FileA file connection
- FlowFlows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.
- FlowColumnInputFieldColumn input field implementation
- FlowColumnOutputFieldColumn output field implementation
- FlowFieldInputFieldField input field implementation
- FlowFieldOutputFieldField output field implementation
- FlowInputFieldA wrapper for an input field contained in a published flow.
- FlowOutputFieldA wrapper for an output field contained in a published flow.
- GroupFieldGraphQL type for a group field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_groups_creating.html
- HierarchyFieldGraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs_hierarchies.html
- LensLenses are curated, embeddable Ask Data experiences. *Introduced in Tableau Cloud June 2022 / Server 2022.3.* *Retired in Tableau Cloud February 2024 / Server 2024.2.*
- MetricMetrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*
- MetricDefinitionA Tableau Pulse metric definition. *Available in Tableau Cloud June 2024 and later. Tableau Pulse is not available in Tableau Server.*
- PublishedDatasourceA Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks.
- QueryQuery root for Metadata GraphQL interface
- SetFieldGraphQL type for a set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html
- SheetA sheet contained in a published workbook.
- TableA table containing columns
- TableauUserUser on a site on Tableau server
- TagA tag associated with content items
- VirtualConnectionA virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*
- VirtualConnectionTableA table in a virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*
- WebDataConnectorA web data connector
- WorkbookWorkbooks are used to package up Tableau visualizations (which are called "sheets" in the Metadata API) and data models (which are called "embedded data sources" when they are owned by a workbook).