Quickstart: Create a database and connect to it
Learn how to create a Firestore with MongoDB compatibility database and connect to it with the
mongosh tool.
Before you begin
-
In the Google Cloud console, go to the project selector page.
-
Select or create a Google Cloud project.
-
Verify that billing is enabled for your Google Cloud project.
-
Make sure that you have the following role or roles on the project: Cloud Datastore Owner
Check for the roles
-
In the Google Cloud console, go to the IAM page.
Go to IAM - Select the project.
-
In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.
- For all rows that specify or include you, check the Role column to see whether the list of roles includes the required roles.
Grant the roles
-
In the Google Cloud console, go to the IAM page.
Go to IAM - Select the project.
- Click Grant access.
-
In the New principals field, enter your user identifier. This is typically the email address for a Google Account.
- In the Select a role list, select a role.
- To grant additional roles, click Add another role and add each additional role.
- Click Save.
-
- Install the
mongoshtool
Create a Firestore with MongoDB compatibility database and retrieve the connection string
In the Google Cloud console, create a new Firestore Enterprise edition database. Firestore with MongoDB compatibility requires Firestore Enterprise edition:-
In the Google Cloud console, go to the Databases page.
- Click Create a Firestore Database.
- Enter a database ID.
- Select Enterprise Edition.
- Select a location for your database.
Click Create Database.
When the database completes initialization, the console opens the Firestore Studio for your database.
-
In the Connect to Firestore using an external MongoDB tool section, copy the connection string.
The connection string depends on the UID of the database (system-generated) and the location of database:
UID.LOCATION.firestore.goog
Create a user for SCRAM authentication
In the Google Cloud console, create a new database user and assign the user Identity and Access Management permissions.
-
In the Google Cloud console, go to the Databases page.
- Select the database from the list of databases.
- In the navigation menu, click Auth.
- Click Add User.
- Enter a username.
- Select an Identity and Access Management role for the user.
- Click create. The database creates a user and shows you the user's generated password. Copy and save this password. You will not be able to retrieve this password later..
Connect using mongosh
Use the connection string, username, and password to connect to your
database, run mongosh locally with the following configuration options.
mongosh 'mongodb://USERNAME:PASSWORD@CONNECTION_STRING:443/DATABASE_ID?loadBalanced=true&authMechanism=SCRAM-SHA-256&tls=true&retryWrites=false'
Replace the following:
- USERNAME: the name of the database user you created.
- PASSWORD: the generated password for the database user you created.
- CONNECTION_STRING: the database connection string.
- DATABASE_ID: a database ID
Once connected, you can create and read data, for example:
db.pages.insertOne({ message: "Hello World!"})
db.pages.find({})
exit