Connection

This page describes the schema used for data source connections, including all fields, types, and enums.

Connection

id · ID! · required

Unique identifier for the connection.

details · ConnectionDetails! · required

Configuration and metadata for the connection. See ConnectionDetails.

status · JobStatus! · required

Job execution status for connection operations like metadata refresh. See JobStatus.

ConnectionDetails

name · String! · required

Human-readable name for the connection.

description · String! · required

Description of the connection and its purpose.

dataSourceType · DataSourceType! · required

The category of data source. See DataSourceType.

connectionType · ConnectionType! · required

The specific type of data source connection. See ConnectionType.

Enums

DataSourceType

The category of data source. It accepts the following values:

Data Source Type	Description
DATA_SOURCE_TYPE_UNSPECIFIED	Type not specified
WAREHOUSE	Data warehouse (Snowflake, BigQuery, Redshift, etc.)
BI_TOOL	Business intelligence tool (Tableau, etc.)

ConnectionType

The specific type of data source connection. It accepts the following values:

Connection Type	Description
CONNECTION_TYPE_UNSPECIFIED	Type not specified
REDSHIFT	Amazon Redshift data warehouse
SNOWFLAKE	Snowflake data warehouse
TABLEAU	Tableau business intelligence platform
BIGQUERY	Google BigQuery data warehouse
POSTGRES	PostgreSQL database
SQL_SERVER	Microsoft SQL Server database
DATABRICKS	Databricks analytics platform
MYSQL	MySQL database
CLICKHOUSE	ClickHouse database

Additional Resources

Connection Queries

Query connection information and status

JobStatus Schema

Learn about job execution status tracking

Refresh Connection

Trigger connection metadata refresh

Domain Objects

Understand domain and table management