MongoDB catalogs #
Use a MongoDB catalog to configure access to a MongoDB or MongoDB Atlas data platform.
There are two cases:
- If the MongoDB instance uses single node deployment or configures replica sets across the same cloud provider region, then the Starburst Galaxy catalog supports read-write access.
- If the MongoDB instance configures replica sets across different cloud provider regions, then the Galaxy catalog supports read-only access.
Create a catalog #
To create a MongoDB catalog, select Catalogs in the main navigation and click Create catalog. On the Select a data source screen, click MongoDB.
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.
Define catalog name and description #
The Name of the catalog 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 when running 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
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.
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.
MongoDB configuration #
To configure the connection to your MongoDB or Atlas data platform, provide the following details:
- Database username, specify a user with sufficient access rights to allow the desired querying. For example, if you only want to query data for analytics, the user does not need to have write access.
- Database password, specify the password for the user.
- Hosts, either a single host or multiple hosts if using MongoDB replica sets.
For example, for a single MongoDB server with a connection string of
mongodb://user:password@host1:port1, the hosts value is
host1:port1. For a MongoDB cluster using replica sets with a connection string of
mongodb://user:password@host1:port1,host2:port2,host3:port3/the hosts value is
host1:port1,host2:port2,host3:port3. If a port is not provided, the default mongodb port of
- Use DNS seed list (SRV), defaults to false. Enable this setting if you are using a DNS Seed List
- Use TLS, defaults to true. Enable this setting if you are connecting to a MongoDB instance with TLS.
Test the connection #
Once you have configured the connection details, use the Test connection button to confirm data access is working. If the test is successful, you can save the catalog.
If the test fails, Starburst Galaxy provides detailed diagnostic information that you can use to fix the database 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 access, read only access, and full read and write access to the catalog.
Click Skip to go straight to adding the catalog to a cluster. If you skip this step, you can add read only access as well as full read and write access to your catalog for any role later. Skipping this step leaves only administrative roles, and the current role while creating the catalog, with access to all schemas and tables within the catalog.
Setting read only permissions grants the specified roles read only access to the catalog. As a result users have read only access to all contained schema, tables, and views.
Setting read/write permissions grants the specified roles full read and write access to the catalog. As a result users have full read and write access to all contained schema, tables, and views.
Use the following steps to assign read/write access to roles:
- In the Role-level permissions section, expand the menu in the Roles with read and write access field.
- From the list, select one or more roles to grant read and write access to.
- Expand the menu in the Roles with read access field.
- Select one or more roles from the list to grant read access to.
Click Save access controls.
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.
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.
SQL support #
The catalog provides read access and write access to data and metadata in MongoDB. It supports the following features:
- Globally available statements
- Read operations
- Write operations:
- Data management:
- Schema and table management:
The following sections provide MongoDB catalog-specific information regarding SQL support.
Schema and table management details #
The catalog supports the following
ALTER TABLE operations:
ALTER TABLE RENAME TO
ALTER TABLE ADD COLUMN
ALTER TABLE DROP COLUMN
Other uses of
ALTER TABLE are not supported.
Is the information on this page helpful?