Skip to main content
In this guide, you’ll learn how to connect your ClickHouse database to Omni.

​
Requirements

To follow the steps in this guide, you’ll need:
  • Organization Admin permissions in Omni
  • Permissions in ClickHouse that allow you to access connection credentials

​
Setup

1

Retrieve ClickHouse connection details

  1. In ClickHouse, navigate to the warehouse you want to connect to Omni.
  2. Click Connect in the side navigation.
  3. A dialog like the following will display: Connection details
The information you need is highlighted in the above image, specifically:
  • Username - In the above image, the username is ClickHouse’s default (default), but this may differ for you.
    If you want to use a different (non-default) Clickhouse user, verify that the user has, at a minimum, SELECT permissions for:
    • All schemas you want to include in the Omni model
    • INFORMATION_SCHEMA.SCHEMATA
    • INFORMATION_SCHEMA.TABLES
  • Password
  • Host - This is a string similar to https://<some-string>.eastus2.azure.clickhouse.cloud
  • Port - In the above image, the port is 8443
Keep this information handy - you’ll need it to complete the setup.
2

Allowlist Omni's IP addresses

If access to ClickHouse is limited by IP address, you’ll need to add Omni’s IPs to the allowlist before you create the database connection.Omni’s IP addresses can be found on an individual connection’s page, accessed by navigating to Settings > Connections and clicking a connection.
3

Create the connection in Omni

  1. In Omni, click Settings > Connections.
  2. Click the Clickhouse option.
  3. On the connection setup page, fill in the connection details:
    NameRequired?Description
    Display Name YesA user-friendly name for the connection, which will be used throughout Omni
    Host YesThe hostname or IP address of the database server
    Port YesThe port number for the database connection
    Default Schema YesThe default schema to use for queries
    Include Schemas NoA comma-separated list of schemas to include in the connection
    Offloaded Schemas NoA comma-separated list of schemas to include in the connection, which will only load on demand. This setting is good for very large schemas or dbt dev schemas.
    Schema for Table Uploads NoThe name of the schema to use for table (CSV) uploads. If left blank, you can upload tables but they won’t be pushed to the database or be available for use in joins.
    Username YesThe username for database authentication
    Password YesThe password for database authentication
    Trust Server Certificate NoWhether to trust the server’s SSL/TLS certificate without validation
    Database Timezone YesThe timezone used by the database
    Query Timezone YesThe timezone to use for Omni queries. If a timezone is specified, data will be converted from the Database timezone to the selected timezone.
    Allow User-Specific Timezones NoAllow users to override the connection timezone with their own when querying
  4. When finished, click Create connection.

​
What’s next?

Now that your ClickHouse is set up, you can: