Skip to main content

​
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 sidebar.
  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:
    ​
    required
    A user-friendly name for the connection, which will be used throughout Omni.
    ​
    required
    The address of the database server.
    ​
    default:"8443"
    required
    The port number for the database connection.
    ​
    required
    The username for database authentication.
    ​
    required
    The password for database authentication.
    ​
    Whether to trust the server's SSL/TLS certificate without validation. Enable this option when connecting to a database that uses a self-signed certificate or a certificate signed by an internal certificate authority that Omni cannot otherwise verify.
    ​
    required
    The timezone used by the database.
    ​
    required
    The timezone to use for Omni queries. If a timezone is specified, data will be converted from the Database Timezone to the selected timezone.
    ​
    When enabled, users can override the connection timezone with their own when querying.
    ​
    required
    Select the minimum level of access users should have to models in the connection.
  4. When finished, click Create connection.

​
What’s next?

Now that your database is set up, you can: