Troubleshoot your connection

View as Markdown

If you need to troubleshoot issues with your connection, such as missing tables or an inability to connect, follow the guidance on this page.

Add Sigma IPs to the allowlist

In some cases, you might need to add Sigma’s IP addresses to the allowlist to successfully connect to your data. This is a necessary step when your warehouse is closed to external connections due to firewalls, security groups, or other IP-based security policies.

Sigma lists its egress IP addresses on all individual Connection page. To see them, follow these steps:

  1. Open the Administration > Connections page.
  2. Select the relevant connection.  If you don’t have a connection to the data source, click Create Connection.
  3. In the Connection Credentials section, see the IPs listed under the Host field.

The IP addresses listed on the connections summary are not applicable to connections over Private Link. If you need the IP addresses for a Private Link connection, contact Sigma Support.

For more guidance specific to individual data platforms:

Permissions for the Snowflake user role

Sigma uses the Snowflake user role specified on the connection. Unless you have the correct privileges granted to the role in Snowflake, you cannot see the data in Sigma.

If the connection uses OAuth, the connection inherits the permissions for each member of the organization directly from Snowflake. To troubleshoot permissions for an individual user or a service account user, confirm the following:

  • The primary role granted to the user provides the relevant access in Snowflake.
  • The user inherits the intended role through your OAuth provider.

Syncing your data and connection indexing

Connection indexing is the process where Sigma scans your data warehouse to discover and catalog all available objects (databases, schemas, tables, views, stored procedures, etc.). This creates Sigma’s internal catalog that powers the UI browsing experience and ensures users can find and access their objects.

Sigma automatically syncs your connection’s metadata to index information from your data warehouse. These long-running queries include:

  • Catalog scans that enumerate tables, views, and schemas in your warehouse.
  • Metadata queries to discover column names, data types, and table structures.
  • Permission checks to determine what objects users can access.

These syncs do not refresh the row-level data that appears in workbooks. Workbooks query your warehouse when you load or refresh an element, so new rows appear regardless of when the last metadata sync ran.

The last sync time shown in the connection browser is the last time Sigma recorded a metadata change for that object, such as a new column or a changed data type. If the metadata has not changed, the last sync time shown does not update, even though syncs continue to run.

For connections that use a service account or other non-OAuth credentials, Sigma typically runs these metadata syncs overnight. Regular overnight syncs help Sigma:

  • Discover new tables, columns, or schema changes.
  • Reflect permission changes in the catalog.
  • Keep the data browser up to date with the warehouse.

Sigma also automatically syncs your connections when a user accesses a schema that hasn’t been checked recently, or when it detects that a catalog may be outdated and has stale data.

OAuth connection indexing

For connections authenticated with OAuth, Sigma does not run overnight syncs unless you configure a service account on the connection. Without a service account, Sigma indexes objects when a user browses or uses the connection, and only indexes the objects that the user can access.

If you need Sigma to index the connection without waiting for a user session, such as when you deploy content to a tenant organization, configure a service account. See the documentation for your data platform:

Manually sync your data

When you make changes in your cloud data warehouse, such as updating the schema for a table or view, you must perform a manual sync so these changes are reflected in Sigma. Syncs can be performed at the connection, database, schema, or table level.

Syncing only occurs at the level selected. To see changes at all levels, you must perform a manual sync at all levels.

You can perform a manual sync using the UI, or programmatically. For guidance on performing a manual sync using the Sigma REST API, see Sync a connection by path.

To perform the manual sync in the UI, follow these steps:

  1. Navigate to Administration > Connections.

  2. Select the relevant connection from the list.

  3. Click Browse connection.

  4. To sync the connection, which discovers updates to the databases available on that connection, click Sync connection metadata () for the connection. The connection browser for Sigma Sample Database with the cursor hovering over the Sync connection metadata button next to the connection name.

    If you want to manually sync a Snowflake connection authenticated with OAuth and with role switching enabled, select More (), then select Sync connection metadata.

  5. To sync an individual database or schema, locate the relevant database, and click More next to the name of the database or schema. Alternatively, find the database or schema by searching for the name.

    From the drop-down menu, select Sync now. The connection browser for Sigma Sample Database with the More menu open next to APPLICATIONS, showing options to sync now, add a shortcut, and view the last sync time.

  6. To sync an individual table, expand the connection, find the database that contains the table, expand that database, find the table, and then click More next to the name of the table. Alternatively, you can find the table by name by searching for it.

    From the drop-down menu, select Sync now. The connection browser with the EXAMPLES database expanded to show the BIKES schema and its tables, with the More menu open next to the STATIONS table showing options to sync now, add a shortcut, and view the last sync time.

Sigma recommends that you manually sync your connections when:

  • You added objects to your database or catalog that do not yet appear in Sigma, such as new tables or views.
  • There are schema changes, like column additions, type changes, or renamed objects.
  • User permissions and access have changed and the catalog needs refreshing.
  • Expected objects like tables aren’t showing up when browsing your connection in Sigma.
  • Object counts or schemas are outdated.