Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

​
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:
  4. When finished, click Create connection.

​
What’s next?

Now that your database is set up, you can: