Create connection
Creates a new database connection. See the Parameters
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Body
Required for all dialects except BigQuery, Snowflake, Databricks, and Athena. The password to authenticate with. Must not be blank, except for Trino, where a blank value is allowed.
- BigQuery - This must be the JSON service account key file content
- Snowflake with keypair authentication - Can be omitted
- Databricks with OAuth User authentication - Can be omitted; required for Personal Access Token and OAuth M2M authentication
The default role for users accessing the connection. Available roles include:
VIEWER- Can view the modelQUERIER- Can view and query the modelQUERY_TOPICS- Can query specific topics. Equivalent to Restricted Querier.MODELER- Can edit and model the dataCONNECTION_ADMIN- Full administrative access to the connectionNO_ACCESS- No access to the model- Custom roles defined for your organization
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 only, not Fabric. Whether to use strict encryption (encrypt=strict, TDS 8.0) for the connection. The connection starts with TLS and always validates the server certificate, which overrides trustServerCertificate.
Requires a TDS 8.0 endpoint: SQL Server 2022 or later, or Azure SQL.
Applicable for Snowflake only. Passphrase for privateKey when it's encrypted. The key must use PBKDF2 at 1,000,000 iterations or fewer (OpenSSL's own default is 2,048). Omni uses the passphrase once to decrypt the key, then stores the key under its own encryption at rest; the passphrase itself isn't retained.
1024Whether to enable the database's semantic layer integration:
- Snowflake - Snowflake semantic views
- Databricks - Databricks Unity Catalog
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. The Snowflake account identifier. Optional when used with hostOverride and port. Snowflake can usually infer the account identifier from the hostname, so this is only needed for key-pair authentication through a proxy, tunnel, or PrivateLink where the hostname doesn't identify the account.
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. Schemas to offload. See Offloading schemas for more information.
Applicable for MSSQL only. Whether to request read-only routing (ApplicationIntent=ReadOnly) for the connection, so read queries can run on a readable secondary.
SQL Server uses the primary when no readable secondary is available. Omni's own upload writes always use the primary, even when this setting is on. When you test the connection, Omni shows a warning, without failing, if it can't verify that the session is read-only.

