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

​
Setup

1

Create a database user for Omni

In your MySQL database, run the following command to create a database user for Omni:
Create Omni user
CREATE USER omni IDENTIFIED WITH mysql_native_password BY '<password>';
Next, run the following command to grant the Omni user access to the database:
Grant SELECT permissions to Omni user
GRANT SELECT ON database_name.* 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 MySQL.
  2. Run the following commands to grant the Omni user the required privileges:
    Grant Omni user permissions to upload schema
    GRANT SELECT, CREATE, INSERT, UPDATE, DELETE ON upload_schema_name.* TO 'omni'@'%';
3

Allowlist Omni's IP addresses

If access to the MySQL 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 MySQL 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: