Create connection

The database dialect.

A descriptive name for the connection

The hostname or IP address of the database server.

• MotherDuck - Not required
• Snowflake - Provide only the account identifier (e.g., myaccount not myaccount.snowflakecomputing.com)
• BigQuery - Automatically determined from the service account

The port number for the database connection.

Not required for Snowflake, MotherDuck, BigQuery, Databricks, and Athena.

The default database/catalog to connect to.

• BigQuery - Provide the project ID
• Athena - Provide the data catalog

The username to authenticate with.

• MotherDuck - Not required
• BigQuery - Provide client email from the service account

The password to authenticate with.

• BigQuery - This must be the JSON service account key file content
• Snowflake with keypair authentication - Can be omitted

The default role for users accessing the connection. Available roles include:

• VIEWER - Can view the model
• QUERIER - Can view and query the model
• QUERY_TOPICS - Can query specific topics. Equivalent to Restricted Querier.
• MODELER - Can edit and model the data
• CONNECTION_ADMIN - Full administrative access to the connection
• NO_ACCESS - No access to the model
• Custom roles defined for your organization

Required for:

• Snowflake - Specify the warehouse
• Databricks - Specify the HTTP path

Comma-separated list of schemas to include. Leave empty to include all schemas.

Comma-separated list of other catalogs/databases to include. Only applicable for databases that support multi-catalog queries: BigQuery, Snowflake, MotherDuck, Databricks, Trino, Athena.

Required for MSSQL. The default schema to use.

The timeout in seconds for queries. Maximum value is 3600 (1 hour). Only applicable for databases that support query timeouts.

Required for BigQuery and Athena connections.

• BigQuery - Specify a region like us
• Athena - Specify an AWS region like us-east-1

Applicable for BigQuery. Maximum bytes that can be billed for a BigQuery query.

Schema to use for data input (upload) tables. If not specified, a suitable default will be chosen.

The timezone to use for the system.

The timezone to use for queries.

Whether to allow users to specify their own timezones.

Whether to prefix generated view names with their schema and catalog, e.g. my_catalog_public__orders instead of orders. Defaults to true for dialects that support multiple catalogs, and false otherwise. See View name generation for more information.

Applicable for MSSQL, Exasol, and ClickHouse. Whether to trust the server certificate.

Applicable for Snowflake only. An RSA key for keypair authentication. Omni will automatically add PEM headers if none are provided.

Applicable for Oracle. Whether to accept the license terms.

Applicable for BigQuery, MSSQL, Snowflake, Databricks, and Athena. The authentication method to use.

Applicable for Athena. The AWS role ARN to assume for the connection.

Whether to enable the database's semantic layer integration:

• Snowflake - Snowflake semantic views
• Databricks - Databricks Unity Catalog

Applicable for Snowflake and Databricks. Whether to enable database semantic layer topics.

Applicable for Snowflake. The audience for external OAuth authentication.

Applicable for Snowflake. The authorization URL for external OAuth authentication.

Applicable for Snowflake. The token URL for external OAuth authentication.

Applicable for Snowflake. Override for the host value.

Whether to automatically infer relationships from column-name conventions during schema refresh.

Applicable for Postgres and Snowflake. Whether to automatically infer relationships from foreign key constraints.

Applicable for Snowflake and Databricks. The OAuth client ID for native OAuth.

Applicable for Snowflake and Databricks. The unencrypted OAuth client secret for native OAuth.

Applicable for all dialects. Comma-separated list of schemas to offload. See Offloading schemas for more information.

Applicable for Athena and Databricks. Whether to use machine authentication.

Connection ID