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 Postgres that allow you to create database users

​
Setup

1

Create an Omni database user

  1. In your Postgres database, run the following command to create a database user for Omni:
    Create Omni user
    CREATE USER omni WITH ENCRYPTED PASSWORD '<password>';
GRANT CONNECT ON DATABASE database_name to omni;
\c database_name
GRANT SELECT ON ALL SEQUENCES IN SCHEMA public TO omni;
GRANT SELECT ON ALL TABLES IN SCHEMA public TO omni;
  2. Grant permissions to the Omni user. If you’re using a schema other than public, run the following to grant usage to Omni:
    Grant usage to the Omni user
    GRANT USAGE ON SCHEMA schema_name TO omni
  3. Lastly, ensure any tables created in the future will be accessible:
    Grant permissions to future tables to the Omni user
    ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT ON tables TO omni;
ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT ON sequences TO omni;
2

Set up a table upload schema

This step is optional. However, we recommend completing it as part of the initial set up or you won’t be able to use uploaded files like CSVs in joins.
In this step, you’ll create a dedicated schema to use for table uploads. This schema can’t be used for other modeled tables.
  1. Create the schema in Postgres.
  2. Run the following commands to grant the Omni user the required privileges:
    Grant Omni user permissions to upload schema
    GRANT USAGE, CREATE ON SCHEMA upload_schema_name TO omni;
3

Allowlist Omni's IP addresses

If access to the Postgres database 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.
4

Create the connection in Omni

  1. In Omni, click Settings > Connections.
  2. Click the Postgres 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: