Skip to main content
These guides walk through what Orion needs to connect to each supported data source, and how to grant that access. Most connections are configured once at the tenant level by an administrator. Every guide ends the same way: take the connection details you produced and enter them in Orion under Configuration → Data Sources → Add Data Source. See Data Sources Management for a tour of that page. If you’d rather not enter them yourself, share the details with your Gravity contact and we’ll configure the connection for you.

How Orion connects

A few principles apply to every connection:

Read-only

Orion only ever issues read queries (SELECT and metadata introspection). It never runs DDL, DML, or stored procedures against your systems.

Least privilege

We recommend a dedicated service user or service account scoped to just the data you want Orion to analyze.

Encrypted at rest

Any credentials you share (passwords, keys, secrets) are encrypted at rest in our database.
For private databases that aren’t publicly reachable (behind a VPC, private subnet, firewall, or VPN), allowlist Orion’s egress IPs so we can reach them. All Orion services egress through the same set of IPs, so a single allowlist entry covers everything. Your production egress IP range is provided by your Gravity contact during onboarding.

Choose your data source

BigQuery

Snowflake

Databricks

Looker

PostgreSQL

MySQL

Redshift

Amazon Athena

Microsoft Fabric

Delta Lake

dbt

Setup guides for Shopify and Google Analytics are coming soon. In the meantime, your Gravity contact can provide documentation for connecting these sources.

BigQuery

Orion connects to BigQuery using service account impersonation. You create a service account in your project and grant Orion’s service account permission to impersonate it. No credentials or keys are ever shared.
For every Google Cloud Console step below, make sure you are in the correct GCP project. Most setups use a single project for both the service account and the source data. If your datasets live in a different project from the one that runs Orion’s queries, see Querying datasets in another project.
1

Create a service account

  1. Go to Google Cloud Console → IAM & Admin → Service Accounts
  2. Click Create Service Account
  3. Name: external-orion-data-access (or your preferred naming)
  4. Description: “Service account for Orion data access”
  5. Click Create and Continue
  6. Skip role assignment for now → click Done
We’ll refer to this as the BigQuery Service Account going forward.
2

Enable service account impersonation

Before this step, the Orion team will provide you with a service account email address (the Orion Service Account) associated with your Orion instance.
  1. Navigate to IAM & Admin → Service Accounts
  2. Find the BigQuery Service Account you just created
  3. Select the Principals With Access tab and click Grant Access
  4. Add principal: the Orion Service Account email you received from Orion
  5. Assign role: Service Account Token Creator
  6. Click Save
3

Create a scratch dataset and grant edit access

  1. Navigate to BigQuery
  2. Create a new dataset, a dedicated dataset reserved for Orion’s use (we recommend a descriptive name like orion_scratch)
  3. Grant the BigQuery Service Account Data Editor access to this dataset
The scratch dataset must be in the same region (or multi-region) as the datasets you wish to query via Orion.
Orion uses this dataset to efficiently stream query results to a binary format optimized for quick analysis. Temp tables created here are automatically cleaned up.
4

Grant table-level access

In BigQuery, for each dataset or table you want to share:
  1. Select the dataset → click Share Dataset
  2. Add the BigQuery Service Account email
  3. Assign role: BigQuery Data Viewer
  4. Click Add, then Done
5

Grant project-level access

  1. Navigate to IAM
  2. Locate your BigQuery Service Account and click Edit
  3. Assign the roles: BigQuery Job User, BigQuery Connection User, and BigQuery Read Session User
  4. Click Save
6

Enter the connection in Orion

In Orion, go to Configuration → Data Sources, click Add Data Source, and choose BigQuery. The form asks for exactly what the steps above produced:The Configure BigQuery Connection form in OrionNo credentials need to be shared.
One project or two? Most customers keep the service account, scratch dataset, and source data in a single project and leave Data Project ID blank. Fill it in only when your datasets live in a different project from the one running Orion’s queries. See Querying datasets in another project.

Querying datasets in another project

Orion separates the project that runs your queries from the project that stores your data. The two roles map to the two form fields:
  • Project ID is the compute and billing project. The service account, the scratch dataset, and every query job live here. Grant BigQuery Job User, BigQuery Connection User, and BigQuery Read Session User on this project (step 5), plus Data Editor on the scratch dataset (step 3).
  • Data Project ID is where your source datasets live. Grant the service account BigQuery Data Viewer on those datasets (step 4).
When both are the same project, leave Data Project ID blank and Orion uses Project ID for everything. When your data lives elsewhere, set Data Project ID to that project. Orion then qualifies your tables against it while still running jobs and writing scratch results in Project ID. The service account still only needs impersonation set up once, in the project where it was created.

Per-user OAuth (optional)

By default, Orion queries BigQuery through the shared service account above. With per-user OAuth, Orion instead runs each person’s BigQuery queries under their own Google identity, so what each user can see in Orion follows the BigQuery permissions they already have, rather than a single shared service account.
Per-user OAuth builds on the service account setup above, so complete that first. The service account is still used for unattended work such as scheduled refreshes with no individual owner and schema introspection.
Use it when you want each person’s data access in Orion to match their existing BigQuery roles.
1

Create an OAuth client in Google Cloud

  1. In APIs & Services → OAuth consent screen, set the User type to Internal so only your Google Workspace users can sign in
  2. In APIs & Services → Credentials, click Create Credentials → OAuth client ID
  3. Application type: Web application
  4. Add the Authorized redirect URI provided by your Gravity contact. It points at Orion’s OAuth callback, for example https://g.runorion.com/datasource/bq-oauth/callback
  5. Click Create, then copy the Client ID and Client Secret
2

Enter the OAuth client in Orion

On the BigQuery data source (Configuration → Data Sources), open the Connection tab, click Edit, and set:Save. The client ID and secret are sent to Orion’s gateway and stored encrypted; they are never written to Orion’s database. To rotate the secret later, enter the new values and save again. Leave them blank to keep the current ones.
3

Each user connects their Google account

The first time someone opens a project that uses this data source, Orion prompts them to connect. They click Connect BigQuery, sign in with Google, and consent once. From then on their queries run under their own identity.
Each person must sign in with the Google account whose email matches their Orion sign-in. If your team signs in to Orion with Google (SSO), this matches automatically.
A couple of things to know:
  • Scheduled work runs as its creator. A metric or workflow that someone schedules runs under that person’s connected account. Work with no individual owner uses the service account.
  • If a user disconnects or loses BigQuery access, their scheduled work pauses until they reconnect. This is deliberate: Orion never falls back to broader access than the user has.
↑ Back to all data sources

Snowflake

Orion connects to Snowflake using key pair authentication. You create a dedicated service user, grant it read-only access to the data you want analyzed, and associate a public key with it. Orion holds the matching private key to authenticate. Connection information Required grants (on the role you configure for the connection)
Key pair authentication setup
1

Generate an encrypted key pair

Generate an encrypted private-public key pair (RSA 2048 or 3072 recommended).
The private key stays on your system. The public key (rsa_key.pub) is added to the Snowflake user.
2

Create (or reuse) a service user

Assign the relevant role with the grants listed above.
3

Associate the public key with the service user

4

Enter the connection in Orion

In Orion, go to Configuration → Data Sources, click Add Data Source, and choose Snowflake. Enter the connection information from the table above (account, user, warehouse, role; database and schema are optional) and upload the private key file. Provide the passphrase if the key is encrypted.
What we store: Orion uses the private key to authenticate connections. We store the encrypted key and passphrases in our database, and we encrypt your encrypted key. See the Snowflake key pair documentation. ↑ Back to all data sources

Databricks

Orion connects to Databricks using a dedicated Service Principal and a SQL Warehouse for compute. We strongly recommend OAuth M2M authentication.
1

Create a Service Principal

We recommend a dedicated Service Principal for Orion. Follow the official documentation to create one.
2

Create credentials

OAuth M2M (recommended)

Follow the official documentation to create a Client ID and Client Secret. Copy the Client Secret immediately; you only get one chance to see it.

Personal Access Token (legacy)

Follow the official documentation. PATs are legacy and being phased out by Databricks, so prefer OAuth M2M.
3

Create or identify a SQL Warehouse

SQL Warehouses are the compute resources used to execute queries. Either identify an existing warehouse, or create a dedicated one following the official documentation. Make note of the warehouse’s HTTP Path.
4

Grant access

Grant the Service Principal read access to all catalogs, schemas, and tables you want Orion to analyze, plus access to the SQL Warehouse used to execute queries.
5

Configure the connection in Orion

In Orion, go to Configuration → Data Sources, click Add Data Source, and choose Databricks. Give the connection a name and optional description, then fill in:
Optionally include a Databricks Catalog to limit the scope of data a given connection can access.
↑ Back to all data sources

Looker

Orion connects to Looker using a dedicated user account with analyst-level (read-only) permissions plus API credentials. You’ll also grant the account access to the Spaces (folders) that hold your dashboards and Looks. Standard deployment: We request a Looker account for the email orion@gravity.foundation, with permissions matching those of a typical analyst at your organization. Orion only needs read access. Required permissions (in addition to analyst-level access)
  • Models (docs): can be scoped to necessary models via model sets; includes the explore permission
  • see_system_activity, see_lookml, see_sql
  • see_user_dashboards (or provide PDFs of sample dashboards instead)
  • create_custom_fields: enables building custom fields via + Add
  • login_special_email: only if using non-email (third-party) authentication
Content access (Spaces / folders) Model permissions and content access are configured separately in Looker. The Orion user also needs view access to the Spaces where your dashboards and Looks are stored:
1

Open the folder

Navigate to the folder(s) containing your key dashboards.
2

Manage access

Click Manage Access on the folder.
3

Add the Orion user

Add the Orion user (or a group it belongs to) with View access.
Without this step, the Orion user will have model and query permissions but won’t be able to see any saved dashboard content. See Managing access to folders.
API credentials: Generate API keys for orion@gravity.foundation (docs). Then, in Orion, go to Configuration → Data Sources, click Add Data Source, choose Looker, and enter your Looker base URL, the client_id, and the client_secret. Third-party authentication: If you use Okta or another third-party provider, add the login_special_email permission. Navigate to the Roles section of the Admin panel (https://[organization].cloud.looker.com/admin/roles) and, if you don’t already have external users, create a new permission set. See the Looker documentation.

LookML augmentation (optional)

Beyond querying dashboards and Looks, Orion can read your LookML business logic directly from its GitHub repository, reusing the dimensions, measures, and joins you have already defined to write better SQL. Setup takes about 10 minutes and needs a GitHub repository admin for one step.
The GitHub account that owns the token you create must have Read access to the LookML repository (see Step 9). A valid token from an account without repo access fails with a “repository not found” error. If you are not a repo admin, loop one in for Step 9.
1

Open the Looker datasource

On the Configuration → Data Sources page, open the Looker datasource and select the Augmentation tab.The Coffee Rush Looker datasource in Orion Configuration, with the Connection, Refresh Data, Augmentation, Schema, and Migration tabs
2

Start token creation

Click the Create token link to open GitHub.The Create token link beneath the Personal Access Token field on the Augmentation tab
3

Create a fine-grained PAT

On GitHub, begin creating a fine-grained personal access token.GitHub's fine-grained personal access tokens page with the Generate new token button
4

Set the resource owner and expiration

  • Resource owner: select the organization or account where the Looker GitHub repository lives.
  • Expiration (TTL): set the token expiration. We recommend the longest your security policy allows; GitHub’s maximum for fine-grained tokens is 1 year (366 days). The new fine-grained token form with token name, resource owner, and expiration fields
When this token expires, Orion can no longer pull your LookML repo. Schema sync and the nightly enrichment that reads your LookML will fail with an authentication error, and any insights that depend on that business logic go stale until you issue a new token and update the connection. Set a reminder to rotate the token before it expires.
5

Select the repository

Choose the Looker repository from the dropdown.
6

Set permissions

Grant read-only access, nothing more:
  • Contents: Read-only
  • Metadata: Read-only Repository access set to the LookML repo, with Contents and Metadata permissions set to Read-only
7

Create the token

Generate the token and copy it. You will not be able to view it again.
8

Save the configuration

Back in Orion, enter the repository URL, the PAT, and the rest of the configuration (see the Augmentation tab in Step 2), then save.
9

Grant the token's account access to the repository

The account that owns the token must have at least Read access to the LookML repo, or Orion authenticates but cannot see the repo and the connection fails with “repository not found.”A repository admin:
  1. In GitHub, open the LookML repository → Settings → Collaborators and teams (under Access).
  2. Under Manage access, click Add people (or Add teams if you manage access by team).
  3. Enter the username of the account tied to the token, or the service account created for Orion.
  4. Set the role to Read. No write or admin access is required.
  5. Send the invitation.
  6. The account owner accepts the invite. Until they do, access does not take effect and the connection will still fail.
  7. Return to the Orion connection and reconnect. The LookML repository's Collaborators and teams page in GitHub, under Settings, with the Add people option
Use a shared service account rather than an individual’s personal account. If a person leaves or loses access, a personal-account token breaks the connection.
10

Test the connection

On the Augmentation tab, click Test Connection. This verifies that Orion can reach the repository with the token and branch you configured, without running a full sync.
  • Success: the connection is valid. Orion can authenticate and see the repo. Click Sync Now to pull the LookML files. When it finishes, Status shows Synced, along with the file count and the latest commit.
  • Failure: read the error message:
    • “Repository or branch not found” usually means the token’s account lacks Read access to the repo (revisit Step 9), or the branch name is wrong. Leave Branch blank to use the repo default, or enter the correct branch.
    • “Authentication failed” means the token is invalid or expired. Generate a new one (Steps 3-7) and re-enter it.
    • “Access forbidden” means the token is missing a permission or, if your org enforces SSO, has not been SSO-authorized for the organization.
Once the test passes and the first sync completes, Orion is reading your LookML. ↑ Back to all data sources

PostgreSQL

Orion connects to PostgreSQL with username/password authentication. Create a dedicated read-only user and grant it SELECT on the schemas and tables you want analyzed. Connection information Required grants
Setup
1

Create the service user

2

Configure PostgreSQL for connections

In postgresql.conf: set listen_addresses = '*' so PostgreSQL accepts connections, and ssl = on for SSL connections.
3

Configure client authentication

In pg_hba.conf:
4

Restart and grant

Restart the PostgreSQL service, then assign the grants listed above to the service user.
5

Enter the connection in Orion

In Orion, go to Configuration → Data Sources, click Add Data Source, and choose Postgres. Enter the connection information from the table above (host, port, database, user, password, SSL mode).
What we store: username/password authentication; we encrypt your plain-text password in our database. See the PostgreSQL docs on connection parameters, access control, and client authentication. ↑ Back to all data sources

MySQL

Orion connects to MySQL with username/password authentication. Create a dedicated user and grant it read-only access to the target database. Connection information
In MySQL, a “database” and a “schema” are the same thing. The Database value above is the schema Orion will read from.
Required grants
Setup
1

Create the service user

Replace <host_or_%> with the IP/CIDR Orion will connect from (e.g. 'orion_svc'@'10.0.0.0/8'), or use '%' to allow any source.
2

Configure MySQL for connections

Ensure MySQL accepts remote connections in my.cnf (or mysqld.cnf):
Optionally require SSL for this user only: ALTER USER 'orion_svc'@'<host_or_%>' REQUIRE SSL;
3

Restart and grant

Restart the MySQL service, then assign the grants listed above to the service user.
4

Enter the connection in Orion

In Orion, go to Configuration → Data Sources, click Add Data Source, and choose MySQL. Enter the connection information from the table above (host, port, database, user, password, SSL mode, and the CA certificate if applicable).
What we store: username/password authentication; we encrypt your plain-text password at rest. If you provide an SSL CA certificate, we encrypt the PEM contents alongside it. See the MySQL docs on access control and encrypted connections. ↑ Back to all data sources

Redshift

Orion connects to Amazon Redshift (cluster or Serverless workgroup) over the standard PostgreSQL wire protocol (port 5439) using username/password authentication. Orion only ever issues read (SELECT) queries. Connection details Database user & permissions
On Redshift, a user can only see a table in information_schema if it has been granted access, so these grants also determine what Orion can discover.
Orion does not need INSERT / UPDATE / DELETE / CREATE, so please do not grant write access.
Network access: Orion connects from our infrastructure, so the endpoint must be reachable on the Redshift port. Allow inbound traffic on port 5439 from Orion’s egress IP range in the cluster’s VPC security group. See the docs on managing Redshift security groups. Enter the connection in Orion: go to Configuration → Data Sources, click Add Data Source, choose Amazon Redshift, and enter the connection details from the table above. ↑ Back to all data sources

Amazon Athena

Orion connects to Amazon Athena to run serverless SQL over data in S3. Table and column metadata comes from your AWS Glue Data Catalog; queries run through Athena and write their results to an S3 output location you control. Orion only ever issues read (SELECT) queries against your tables. Authentication uses an IAM access key for a dedicated user. You create the user, attach a least-privilege policy, and enter the access key ID and secret in Orion.
Every Athena query must write its results somewhere in S3. This is an Athena requirement, not an Orion one: the output location (or a workgroup that enforces one) is where Athena stages query output before Orion reads it. The IAM user therefore needs write access to that one output prefix, even though it only reads your actual data.
Connection details
Orion reads the chosen workgroup’s query history to learn which tables and columns your team queries most. That history includes the SQL text of every query run in the workgroup. If that is a concern, point Orion at a dedicated workgroup rather than one shared with sensitive ad-hoc queries.
IAM setup
1

Create a dedicated IAM user

In the AWS IAM console, create a user for Orion (we suggest orion-athena) with programmatic access, then create an access key for it. Copy the Access Key ID and Secret Access Key; the secret is only shown once.
2

Attach a least-privilege policy

Attach a policy granting Athena execution, read-only Glue catalog access, read access to the S3 buckets holding your data, and read/write access to the S3 output location. Scope the resource ARNs to your own buckets, workgroup, and catalog. The policy below is a starting point:
Tighten ListQueryExecutions / BatchGetQueryExecution and the Glue and Athena actions to specific workgroup, catalog, and database ARNs if you want to lock the user down further. The ListQueryExecutions / BatchGetQueryExecution pair is only used for the query-history enrichment described above; omit them if you’d rather not expose query history.
3

Confirm the workgroup and output location

Make sure the workgroup you name exists in the chosen region, and that either the workgroup enforces an output location or the S3 Output Location you enter is writable by the IAM user. If the workgroup enforces its own output location, that setting wins over the value you enter in Orion.
4

Enter the connection in Orion

In Orion, go to Configuration → Data Sources, click Add Data Source, and choose Amazon Athena. Enter the connection details from the table above. Leave Workgroup and Data Catalog at their defaults (primary / AwsDataCatalog) unless you use custom ones, and set Database only if you want to limit schema discovery to one Glue database.
Network access: Athena and Glue are reached over their public AWS API endpoints, so no VPC allowlisting is required for the connection itself. If your S3 buckets restrict access by source IP or VPC endpoint policy, allow Orion’s egress IP range (provided by your Gravity contact) to reach them. What we store: the IAM access key ID and secret access key, encrypted at rest in our database. To rotate the key later, enter the new values on the data source’s Connection tab and save; leave the secret blank to keep the current one. Known limitations
  • IAM access key only. Cross-account IAM role assumption is a planned fast-follow; today the connection uses a long-lived access key, so rotate it on your normal cadence.
  • Output location is mandatory. Athena cannot run a query without a place to write results, so the workgroup must enforce one or you must supply the S3 Output Location.
  • dbt enrichment is supported on Athena connections (see dbt); semantic enrichment from a Looker connection can also be projected onto Athena schemas.
↑ Back to all data sources

Microsoft Fabric

Orion connects to a Microsoft Fabric Warehouse using a Service Principal (App Registration) in your Microsoft Entra ID tenant. Orion connects over TDS (the SQL endpoint) using ODBC Driver 18 with Service Principal authentication, with no interactive login required. Azure App Registration
  1. Create an App Registration in your Entra ID tenant (docs)
  2. Note the Application (client) ID and Directory (tenant) ID
  3. Create a Client Secret under Certificates & secrets (docs) and note the secret value (not the Secret ID). Recommended expiry: 12 months
Fabric Admin Portal settings (must be enabled by a Fabric Administrator)
  1. Navigate to Fabric Admin Portal → Tenant settings → Developer settings
  2. Enable Service principals can use Fabric APIs
  3. Scope to a security group containing the Orion Service Principal (recommended), or enable for the entire organization
Workspace access: Open the workspace containing your Warehouse, click Manage access → Add people or groups, search for the App Registration name, and assign the Viewer role (minimum). Contributor is recommended for full metadata access. Warehouse SQL endpoint: Open the Warehouse in Fabric, click Settings → SQL connection string. The hostname looks like xxxxxxxx.datawarehouse.fabric.microsoft.com. Note the Database name (the Warehouse name). Credentials summary Enter the connection in Orion: go to Configuration → Data Sources, click Add Data Source, choose Microsoft Fabric Warehouse, and enter the credentials from the table above.
Orion uses read-only SQL (SELECT only) to discover your schema via INFORMATION_SCHEMA, run agent-generated queries, and stream results into its analysis pipeline. It never executes DDL, DML, or stored procedures. If you use dbt with Fabric, Orion can enrich metadata with dbt models and lineage; see dbt.
↑ Back to all data sources

Delta Lake

Orion connects to Delta Lake tables on Azure Data Lake Storage Gen2 (abfss://) or Google Cloud Storage (gs://). Orion reads the Delta table directly via its transaction log. There is no warehouse, cluster, or notebook to provision. You provide two things: a Table URI pointing at a Delta table folder (or a parent folder containing many Delta tables), and credentials with read access to that location.
Orion only performs read-only scans against your storage account / bucket: no writes, no vacuums, no schema changes.
Storage account access
  • The Table URI looks like abfss://<container>@<storage-account>.dfs.core.windows.net/<path>
  • <path> can point to a single Delta table folder (containing a _delta_log/ subdirectory) or a parent folder; in the parent case, Orion exposes every Delta table found underneath
  • Confirm hierarchical namespace is enabled on the storage account (required for abfss://)
Credentials (pick one)

SAS token (preferred)

Read-only and time-bounded (docs). Scope to the container, permissions read + list (sp=rl), expiry 90 days or longer. Send the token query string (with or without a leading ?).

Account key

Read/write, full access, only if SAS is not viable. Either the raw account key, or the full connection string.
What you enter in Orion (under Configuration → Data Sources → Add Data Source → Delta Lake): Table URI (full abfss://... string), storage account name (required for SAS tokens), and one of SAS token or account key.
Parent-folder mode: point the Table URI at a parent directory (e.g. abfss://.../silver/) and Orion discovers every Delta table underneath on schema sync. Partition columns need no setup; Orion reads them from the Delta log for query pruning automatically.
↑ Back to all data sources

dbt

If you use dbt, Orion can enrich an existing warehouse connection with your dbt model descriptions and lineage. You connect Orion to your dbt project’s GitHub repository with a read-only fine-grained access token.
1

Create a GitHub Personal Access Token

  1. Navigate to Settings → Developer Settings → Personal access tokens → Fine-grained tokens
  2. Click Generate new token
  3. Set your organization as the resource owner (if required)
  4. Configure permissions: Contents → Read access (Metadata is auto-added)
  5. Under Repository access, select Only select repositories and add your dbt project repo only
  6. Click Generate token, then copy and save it immediately; it won’t be shown again
2

Configure the Orion connection

  1. In Orion, go to Configuration → Data Sources
  2. Click the data source tile you want to enrich, then click Edit. (The same options appear when first adding a data source.)
  3. Check Add schema enrichment for enhanced metadata and select dbt project
  4. Set dbt Source Type to GitHub Repository
  5. Enter the Repository URL (your dbt project’s GitHub URL) and Personal Access Token
  6. Click Save Changes A data source in edit mode with schema enrichment enabled and dbt project selected
Make sure there’s no trailing slash at the end of the Repository URL.
dbt Source Type also supports dbt Cloud (host URL, environment ID, and auth token) and Upload manifest.json if you’d rather not connect the GitHub repository.
Standard dbt projects only require these two fields, Repository URL and Personal Access Token. Additional fields are optional.
↑ Back to all data sources