OBJECT

CustomSQLTable

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.

link GraphQL Schema definition

  • type CustomSQLTable implements Table {
  • # Unique identifier used by the metadata API. Not the same as the numeric ID used
  • # on server
  • id: ID!
  • # Name shown in server and desktop clients
  • name: String
  • # A custom SQL tables is always embedded in Tableau content
  • isEmbedded: Boolean
  • # User modifiable description of this table
  • description: String
  • # True if this query table has been marked as certified
  • isCertified: Boolean
  • # Notes related to the query table being marked as certified
  • certificationNote: String
  • # Text of the query
  • query: String
  • # Connection type shortname
  • connectionType: String
  • # Columns contained in this table
  • #
  • # 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.
  • columns(
  • filter: Column_Filter,
  • orderBy: ColumnSortOrder,
  • permissionMode: PermissionMode
  • ): [Column!]!
  • # Columns contained in this table
  • #
  • # 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.
  • columnsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Column_Filter,
  • orderBy: ColumnSortOrder,
  • permissionMode: PermissionMode
  • ): ColumnsConnection
  • # Actual tables that this query references.
  • #
  • # 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!]!
  • # Actual tables that this query references.
  • #
  • # 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
  • # Database this query is executed on
  • database: Database
  • # Databases upstream of this table
  • #
  • # 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 table
  • #
  • # 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 table
  • #
  • # 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 table
  • #
  • # 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
  • # Flows upstream of this table
  • #
  • # 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 table
  • #
  • # 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 table
  • #
  • # 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 table
  • #
  • # 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 table
  • #
  • # 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 table
  • #
  • # 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 table
  • #
  • # 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 table
  • #
  • # 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
  • # Flows downstream of this table
  • #
  • # 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 table
  • #
  • # 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 table
  • #
  • # 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 table
  • #
  • # 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
  • # Workbooks connected to the table
  • #
  • # 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 table
  • #
  • # 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
  • # Sheets connected to the table
  • #
  • # 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 table
  • #
  • # 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
  • # Dashboards connected to the table
  • #
  • # 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 table
  • #
  • # 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
  • # Metrics connected downstream from the table
  • #
  • # 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 downstream from the table
  • #
  • # 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 of workbooks and published datasources connected to the table
  • #
  • # 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 of workbooks and published datasources connected to the table
  • #
  • # 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
  • }