Skip to main content

​
Requirements

To follow the steps in this guide, you’ll need:
  • Organization Admin permissions in Omni
  • Permissions in StarRocks that allow you to create database users

​
Setup

1

Create a database user for Omni

In your StarRocks database, run the following command to create a database user for Omni:
Create Omni user
Next, run the following command to grant the Omni user access to the database:
Grant SELECT permissions to Omni user
2

Allowlist Omni's IP addresses

If access to the StarRocks 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.
3

Create the connection in Omni

  1. In Omni, click Settings > Connections.
  2. Click the StarRocks option.
  3. On the connection setup page, fill in the connection details:
    ​
    required
    A user-friendly name for the connection, which will be used throughout Omni.
    ​
    required
    The address of the database server.
    ​
    default:"9030"
    required
    The port number for the database connection.
    ​
    required
    The username for database authentication.
    ​
    required
    The password for database authentication.
    ​
    required
    The timezone used by the database.
    ​
    required
    The timezone to use for Omni queries. If a timezone is specified, data will be converted from the Database Timezone to the selected timezone.
    ​
    When enabled, users can override the connection timezone with their own when querying.
    ​
    default:"enabled"
    When enabled, Omni will automatically infer relationships between tables based on column name matching during schema refreshes. Defaults to enabled.
    ​
    default:"900"
    Maximum time in seconds before a query times out.
    ​
    required
    Select the minimum level of access users should have to models in the connection.
  4. When finished, click Create connection.

​
What’s next?

Now that your database is set up, you can: