Follow these steps to begin creating a catalog for MongoDB:
On the Select a data source pane, click the MongoDB icon.
When configuring a MongoDB catalog in Starburst Galaxy, there are different access characteristics depending on whether your deployment uses a single cloud provider region or multiple cloud provider regions:
For a MongoDB Atlas federated database instance, the Starburst Galaxy catalog supports read-only access. Additionally, Starburst Galaxy supports tables with all rows conforming to same schema.
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.
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
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.
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.
Starburst Galaxy supports AWS PrivateLink for MongoDB catalogs.
To configure the connection to your MongoDB or Atlas data platform, provide the following details:
mongodb://user:password@host1:port1, the host value is
host1:port1. For a MongoDB cluster using replica sets with the connection
host value is
host1:port1,host2:port2,host3:port3. If you do not provide a
port, MongoDB uses port
27017 by default.
mongodb. In the connection string
mongodb+srv://cluster.example.mongodb.net/myFirstDatabase, the host value
cluster.example.mongodb.net. Only a single host is allowed when using
If you are using MongoDB Atlas and wish to connect directly, add the Starburst Galaxy IP Range/CIDR for your region to the Atlas IP Access List.
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.
Another way to resolve a connection failure is by temporarily opening traffic to the internet. To do this, add 0.0.0.0/0 to the MongoDB Atlas IP Access List. Once you receive a successful connection notification, delete 0.0.0.0/0 from the list.
Click Connect catalog, and proceed to set permissions where you can grant access to certain roles.
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:
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:
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:
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.
On the Clusters page, click the Update icon beside the running cluster, to add the catalog.
The catalog provides read access and write access to data and metadata in MongoDB. It supports the following features:
The following sections provide MongoDB catalog-specific information regarding SQL support.
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?
Is the information on this page helpful?