Starburst Galaxy

  •  Get started

  •  Working with data

  •  Data engineering

  •  Developer tools

  •  Cluster administration

  •  Troubleshooting

  • Galaxy status

  •  Reference
  • Apache Pinot catalogs #

    You can use an Apache Pinot™ catalog to query data stored in an Apache Pinot™ database:

    Follow these steps to begin creating a catalog for Apache Pinot:

    • In the navigation menu, select Catalogs.
    • Click Create catalog.
    • On the Select a data source pane, click the Apache Pinot icon.

      Select a data source

    • Follow the instructions in the next sections to configure your Apache Pinot 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

    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 #

    The connection to the database requires username and password authentication and details to connect to the database server, typically hostname or IP address and port. The following sections detail the setup for the supported cloud providers.

    A connection to the database can be established directly, if the Starburst Galaxy IP range/CIDR is allowed to connect.

    If the database is only accessible inside the virtual private cloud (VPC) of the cloud provider, you can use an SSH tunnel with a bastion host in the VPC.

    Apache Pinot connection #

    Your Pinot cluster must fulfill the following requirements:

    • The controllers must be publicly accessible.
    • Brokers must be accessible to the IP ranges of the region where the Pinot cluster is located.

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

    • Controller host: The IP address of the controller host and port. Separate multiple host:port pairs with commas. For example, host1:port1,host2:port2,host3:port3.
    • Controller user: The controller username for the basic authentication method.
    • Controller password: The controller password for the basic authentication method.
    • Broker host: You must provide this detail if the controller’s broker API endpoint returns a private IP address.
    • The details provided for the Controller host and Controller password fields are used to automatically populate the Broker user and Broker password fields. To use different credentials, uncheck the box.
    • Broker user: Broker username for the basic authentication method.
    • Broker password: Broker password for the basic authentication method.
    • Use TLS: Defaults to true. Click to disable for clusters not secured with TLS.

    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.

    Test connection

    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 to data and metadata in Pinot. It supports the following features: