Starburst Documentation
Starburst Galaxy
  •  Get started
  •  Working with data
  •  Data engineering
  •  Developer tools
  •  Cluster administration
  •  Security and compliance
  •  Troubleshooting
  • Galaxy status
  •  Reference

    • starburst galaxy > working with data > create catalogs > non object storage > Snowflake catalogs

    Snowflake catalogs #

    You can use a Snowflake catalog to configure access to Snowflake in the following deployments:

    Follow these steps to begin creating a catalog for Snowflake:

    • In the navigation menu, select Data, then Catalogs.
    • Click Create catalog.

    • On the Select a data source pane, click the Snowflake icon.

      Select a data source

    • Follow the instructions in the next sections to configure your Snowflake connection.

    Select a cloud provider #

    The Cloud provider configuration is necessary to allow Starburst Galaxy to correctly match catalogs and clusters.

    The data source configured in a catalog, and the cluster must operate in the same cloud provider and region for performance and cost reasons.

    Select cloud provider

    If you select the Google Cloud icon, a pop-up note reminds you that Snowflake can only be used with Google Cloud as a read only catalog. No write operations can be performed.

    Define catalog name and description #

    The Catalog name is visible in the query editor and other clients. It is used to identify the catalog when writing SQL or showing the catalog and its nested schemas and tables in client applications.

    The name is displayed in the query editor, and in the output of a SHOW CATALOGS command. It is used to fully qualify the name of any table in SQL queries following the catalogname.schemaname.tablename syntax. For example, you can run the following query in the sample cluster without first setting the catalog or schema context: SELECT * FROM tpch.sf1.nation;.

    The Description is a short, optional paragraph that provides further details about the catalog. It appears in the Starburst Galaxy user interface and can help other users determine what data can be accessed with the catalog.

    Enter catalog name and description

    Configure the connection #

    Read further to learn about each supported connection method. The following sections detail the setup for the supported cloud providers.

    • Connect directly
      The connection to the database requires a username, password authentication, and the details necessary to connect to the database server, typically hostname or IP address and port.

    • PrivateLink Starburst Galaxy supports AWS PrivateLink for Snowflake catalogs.

    Snowflake configuration #

    The user credentials must belong to a user that has been granted permissions to use the Snowflake role with the required access rights.

    To configure the connection to your Snowflake cluster, you must provide the following details:

    • Snowflake account identifier: which specifies your Snowflake account ID in a URL-friendly lowercase form, where <account_name> can include additional <account_locator> and <cloud_region_id> or <cloud_region_id>.<cloud> segments that identify the cloud platform and region where your account is hosted. The identifier can take different forms, depending on the specifics of your Snowflake account. The most common forms are:

      • <orgname>-<account_name> For example, starburstdata-gh41406.
      • <account_locator> For example, gh41406.
      • <account_locator>.<cloud_region_id> For example, gh41406.east-us-2.
      • <account_locator>.<cloud_region_id>.<cloud> For example, gh41406.east-us-2.aws.

      See account identifiers to learn more about Snowflake identifier formats.

    • Username: enter a Snowflake username.

    • Password: specify the password for this username.

    • Database name: specify the database you want to connect to.

    • Warehouse name: specify the warehouse you want to connect to.

    • Snowflake role: select a role with the required access rights.

      Snowflake connection dialog

    • The Enable parallel mode toggle is disabled by default. Leave disabled to continue using single-thread query mode, which conserves resources. Otherwise, click to enable parallel mode.

      With parallel mode enabled, this catalog takes advantage of a feature of the Snowflake JDBC driver to fetch query results over multiple parallel connections. For most queries, this translates to faster performance.

      Snowflake connection dialog

      Snowflake parallel mode is a public preview feature. Contact Starburst support with questions or feedback.

    Test the connection #

    Once you have configured the connection details, click Test connection to confirm data access is working. If the test is successful, you can save the catalog.

    If the test fails, look over your entries in the configuration fields, correct any errors, and try again. If the test continues to fail, Galaxy provides diagnostic information that you can use to fix the data source configuration in the cloud provider system.

    Connect catalog #

    Click Connect catalog, and proceed to set permissions where you can grant access to certain roles.

    Set permissions #

    This optional step allows you to configure read-only access or full read and write access to the catalog.

    Use the following steps to assign read-only access to all roles:

    1. Select the Read-only catalog switch to grant a set of roles read-only access to the catalog’s schemas, tables, and views.
    2. Next, use the drop-down menu in the Role-level permissions section to specify the roles that have read-only access.
    3. Click Save access controls.

    You can specify read-only access and read-write access separately for different sets of roles. That is, one set of roles can get full read and write access to all schemas, tables, and views in the catalog, while another set of roles gets read-only access.

    Use the following steps to assign read/write access to some or all roles:

    1. Leave the Read-only catalog switch cleared.
    2. In the Role-level permissions section:
      • Expand the drop-down menu in the Roles with read and write access field and select one or more roles to grant read and write access to.
      • Expand the drop-down menu in the Roles with read access field and select one or more roles from the list to grant read-only access to.
    3. Click Save access controls.

      Set permissions for read and write screenshot

    Add to cluster #

    You can add your catalog to a cluster later by editing a cluster. Click Skip to proceed to the catalogs page.

    Use the following steps to add your catalog to an existing cluster or create a new cluster in the same cloud region:

    • In the Add to cluster section, expand the menu in the Select cluster field.
    • Select one or more existing clusters from the drop down menu.
    • Click Create a new cluster to create a new cluster in the same region, and add it to the cluster selection menu.

    • Click Add to cluster to view your new catalog’s configuration.

        Add to cluster

    The Pending changes to clusters dialog appears when you try to add a catalog to a running cluster.

    • In the Pending changes to cluster dialog, click Return to catalogs to edit the catalog or create a new catalog.
    • Click Go to clusters to confirm the addition of the catalog to the running cluster.

    • On the Clusters page, click the Update icon beside the running cluster, to add the catalog.

        pending changes to cluster dialog

    SQL support #

    The catalog provides read access and write access to data and metadata in the Snowflake database. It supports the following features:

    The following section provides details for the SQL support with Snowflake catalogs.

    Data management details #

    If a WHERE clause is specified, the DELETE operation only works if the predicate in the clause can be fully pushed down to the data source.