Last Updated: 2024-01-18

Background

When setting up a MongoDB catalog in Starburst Galaxy, the type of access available varies based on your deployment configuration. If your MongoDB instance is a single node or has replica sets within the same cloud provider region, Starburst Galaxy supports both read and write access. However, if your MongoDB instance has replica sets spanning multiple cloud provider regions, the Galaxy catalog only supports read-only access.

In the case of a MongoDB Atlas federated database instance, the Starburst Galaxy catalog provides read-only access. It's important to note that Starburst Galaxy also supports tables where all rows adhere to the same schema.

Scope of tutorial

In this tutorial, you will learn how to configure a MongoDB catalog in Starburst Galaxy.

Learning objectives

Once you've completed this tutorial, you will be able to:

Configure a MongoDB catalog using Starburst Galaxy.
Access your own MongoDB data source using Starburst Galaxy.

Prerequisites

You need a Starburst Galaxy account to complete this tutorial. Please see Starburst Galaxy: Getting started for instructions on setting up a free account.
This tutorial comes with a bring your own storage requirement. Before proceeding with this lesson, you must already have a MongoDB account set up.

If this is not the case, please set this up first then return to this tutorial.

About Starburst tutorials

Starburst tutorials are designed to get you up and running quickly by providing bite-sized, hands-on educational resources. Each tutorial explores a single feature or topic through a series of guided, step-by-step instructions.

As you navigate through the tutorial you should follow along using your own Starburst Galaxy account. This will help consolidate the learning process by mixing theory and practice.

Background

Now it's time to pivot over to Starburst Galaxy to begin the process of connecting your MongoDB datasource.

Starburst Galaxy separates users by role. Configuring a new catalog will require access to a role with appropriate privileges. Today, you'll be using the accountadmin role.

This is a quick step, but an important one.

Step 1: Sign into Starburst Galaxy

Sign into Starburst Galaxy in the usual way. If you have not already set up an account, you can do that here.

Step 2: Set your role

Your current role is listed in the top right-hand corner of the screen.

Check your role, to ensure that it is set to accountadmin.
If it is set to anything else, use the drop-down menu to select the correct role.

Background

The steps below will show you how to start the process of configuring a new catalog.

Step 1: Create a new catalog

In the left-hand navigation bar, click Catalogs.
Click the Create catalog button.

Step 2: Select MongoDB

Starburst Galaxy allows the creation of catalogs for a number of different data sources.

Click the MongoDB tile.

Step 3: Input cloud provider, name, and description

MongoDB works with all three major cloud providers: AWS, Azure, and GCP. You will need to select which one you want to use for this catalog.

Additionally, the catalog needs both a name and description.

Select your cloud provider.
Provide a meaningful Catalog name.
Provide a meaningful Description.
Scroll down to continue the configuration process.

When you connect Starburst Galaxy to a new datasource, it is necessary to undergo an authentication process. This helps ensure that you are connecting the right data source and that you have the appropriate permissions.

Step 1: Choose the connection type

Now it's time to choose a connection type. There are three options:

Connect directly: Choose this option if your database has a public IP that allows direct connection from Galaxy.
Connect via SSH tunnel: Choose this option if your database is protected by a firewall on a private network.
PrivateLink: Choose this option if you have enabled PrivateLink for your Galaxy account and have already worked with your Starburst technical resource to configure a PrivateLink between Galaxy and your AWS VPC.

Step 2: Enter MongoDB connection details

Next, you need to connect Starburst Galaxy to MongoDB. To do this, you're going to enter details from your MongoDB account to create the connection.

In the Hosts field, enter the host name. For example, galaxy.q45v5o8.mongodb.net.

Select your region(s).
Enter your Username.
Enter your Password.
Select Use DNS seed list (SRV) if you have DNS seed list configured. Note: Mongo Atlas users will have a DNS seed list configured.
Select Use TLS if your database has been configured to connect with TLS. Note: Mongo Atlas users will have TLS configured.
If you are using a Federated database, select Federated Database.

Background

Every new catalog connection includes a test before you connect it. This helps to ensure that you have input the correct credentials and allows you to quickly fix any problems before actually connecting.

Step 1: Test and Connect

You're almost there! Time to test the connection and then complete the process of creating your new MongoDB catalog.

Click the Test connection button.
Confirm that you see the Hooray! You can now add this catalog to a cluster message.
Click the Connect catalog button.

Background

Starburst Galaxy allows you to configure your catalog in a number of ways regarding access controls. The most important of these involves granting write access or restricting the catalog to read-only access.

Take some time to consider whether you require write access, or whether read-only access will be sufficient.

Step 1: Select read access

Select the appropriate read access for your situation.

If you want to restrict the write access, move the read-only catalog slider to the right. Otherwise, leave it as is.
Click the Save access controls button.

Background

The catalog is now created, but you are not able to use it until you add it to a cluster. Clusters can include many catalogs. You can either add the new MongoDB catalog to an existing cluster, or do this at a later stage.

Step 1: Add catalog to cluster or skip

You can add a catalog to a cluster at any time.

If you want to add the catalog to a cluster later, click Skip
If you want to add the catalog to a cluster now, select the cluster name from the drop-down menu and click Add to cluster.

Tutorial complete

Congratulations! You have reached the end of this tutorial, and the end of this stage of your journey.

You're all set! Now you can query the data in your MongoDB datasource.

Continuous learning

At Starburst, we believe in continuous learning. This tutorial provides the foundation for further training available on this platform, and you can return to it as many times as you like. Future tutorials will make use of the concepts used here.

Next steps

Starburst has lots of other tutorials to help you get up and running quickly. Each one breaks down an individual problem and guides you to a solution using a step-by-step approach to learning.

Tutorials available

Visit the Tutorials section to view the full list of tutorials and keep moving forward on your journey!