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.

This guide covers connecting Omni to Starburst Galaxy, Starburst’s managed Trino service.
In Trino, a catalog is what other databases call a database — it’s a configured connection to an underlying data source (such as Iceberg, Hive, Postgres, or Snowflake). A Trino cluster can expose multiple catalogs, each containing schemas and tables. Throughout this guide, the Omni connection field labeled Database refers to a Trino catalog.

Requirements

To follow the steps in this guide, you’ll need:
  • Organization Admin permissions in Omni
  • In Starburst Galaxy:
    • Permissions that allow you to create roles, users, and assign privileges. The accountadmin role includes all these permissions.
    • An existing Galaxy cluster

Setup

1

Create a Galaxy role for Omni

In this step, you’ll create a dedicated Galaxy role for Omni. You’ll assign privileges to the role in a later step.
  1. In Galaxy, navigate to Access > Roles and privileges.
  2. Click Create role.
  3. Enter a name (for example, omni) and an optional description.
  4. Check the Grant to the creating role checkbox. This grants the new role to your current role so that you can continue to administer it.
  5. Click Create role.
2

Grant privileges to the role

Next, you’ll grant privileges to the Omni role that will allow it to access the cluster and the catalogs and schemas it contains.
1

Grant cluster access to the role

Start by granting the role permission to run queries on the cluster Omni will connect to.
  1. On the Roles and privileges page, click the omni role you just created.
  2. Open the Privileges tab.
  3. Click Add privileges.
  4. Click the Cluster tab.
  5. In the Cluster alias dropdown, select the cluster Omni will connect to.
  6. Set Do you want to allow access? to Allow.
  7. Under What can they do?, select Use cluster. The dialog should look like the following:
    Configured cluster access privileges for the Omni role in the Starburst Galaxy UI
2

Grant data privileges to the role

Next, grant the role access to the catalogs and schemas you want to model in Omni.
  1. Still on the Add privileges dialog, click the Data tab.
  2. In the Scope dropdown, select a catalog you want Omni to access. You can also toggle a catalog open to grant access on a per-schema basis:
    List of schemas in a catalog in the Starburst Galaxy UI
  3. Set Do you want to allow access? to Allow.
  4. Under What can they do?, select Select from table. The dialog should look like the following:
    Configured data access privileges for the Omni role in the Starburst Galaxy UI
  5. Repeat this for every catalog and schema you want Omni to query.
  6. Click Save privileges.
3

Create the Omni user in Galaxy

Next, you’ll create a dedicated Galaxy user for Omni and assign it the role you configured.
  1. In Galaxy, navigate to Access > Users.
  2. Click Create user.
  3. Enter an email address for the new user (for example, omni@yourcompany.com).
    Galaxy will send an invitation email to this address. You’ll need access to the inbox to complete the account setup and set a password.
  4. In Roles, select the omni role you created earlier.
  5. In Default role, select the omni role. The dialog should look like the following:
    Initial settings for creating an Omni user in the Starburst Galaxy UI
  6. Click Add user.
  7. Open the invitation email and follow the link to set the user’s password. Save the password somewhere secure — you’ll need it when configuring the Omni connection.
4

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.
To use table uploads, the Galaxy omni role needs write access to a dedicated schema in a writable catalog. This schema can’t be used for other modeled tables.Generally, the steps to set up a table upload schema will look like:
  1. Verify that the Galaxy connector (data source) associated with the catalog supports write operations. Some connectors - like Google Sheets and Salesforce - are read-only and can’t be used for table uploads.
  2. In the underlying data source (e.g., Postgres, MySQL), create a schema in a catalog that the Galaxy omni role has access to.
  3. Verify that the new schema is accessible to Galaxy.
  4. In Galaxy, add privileges to the Galaxy omni role that will allow the Omni Galaxy user to:
    • Access the catalog and schema used for table uploads
    • Create new tables in the schema
    • Select from, insert into, update, and delete from tables in the schema
5

Get the connection details from Galaxy

  1. In Galaxy, navigate to Partner connect.
  2. Click the Connection info section to open it.
  3. Select the cluster you want to connect to Omni.
  4. In the Other clients section, note the Host and Port values — you’ll need these in the next step. The port for Galaxy is always 443.
Highlighted Other Clients connection info in the Starburst Galaxy UI
6

Allowlist Omni's IP addresses

If your Galaxy cluster restricts access by IP address, add Omni’s IPs to the allowlist.Omni’s IP addresses can be found on an individual connection’s page in Omni, accessed by navigating to Settings > Connections and clicking a connection.If your cluster doesn’t restrict access by IP, skip this step.
7

Create the connection in Omni

  1. In Omni, click Settings > Connections.
  2. Click the Trino option.
  3. On the connection setup page, fill in the connection details:
    Database
    required
    The name of the Trino catalog Omni should connect to.
    Username
    required
    The Omni Starburst user’s email address, followed by / and the role name. The role suffix tells Galaxy which role to use for the session. The omni role should be the default for this user, but adding the role suffix explicitly sets the role.For example, if the user is omni@yourcompany.com and the role is omni, enter omni@yourcompany.com/omni.
  4. When finished, click Create connection.
Galaxy clusters auto-suspend after an idle period (configurable per cluster). The first query Omni runs after suspension will be slower while Galaxy resumes the cluster. This is expected behavior and doesn’t require any additional setup.

What’s next?

Now that your database is set up, you can: