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

​
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

import UploadSchemaCallout from “/snippets/connect-data/upload-schema-callout.mdx”;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:
    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. Defaults to 3306.
    Default Schema YesThe default schema to use for queries
    Include Databases NoA comma-separated list of databases 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
    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
    Query Timeout NoMaximum time in seconds before a query times out
  4. When finished, click Create connection.

​
What’s next?

Now that your MySQL is set up, you can: