extend-nosql-database

Last updated on May 21, 2026

注意

The Extend NoSQL Database is currently in closed alpha.

Overview

Extend NoSQL Database allows Extend Apps to store data in an Amazon DocumentDB (with MongoDB compatibility) database. It provides a managed, scalable database solution that eliminates the complexity of setting up and maintaining your own database infrastructure. This allows developers to focus on building innovative features and functionality.

Extend NoSQL Database can be attached to all types of Extend Apps. This unlocks a wide range of use cases that require persistent data storage capabilities.

Provision Extend NoSQL Cluster

You can provision the Extend NoSQL cluster once you have been approved as a Closed Alpha tester. This action can be performed at the Publisher or Studio namespace level.

1. Go to the Development Utilities menu and click Extend Database Integration. Select the Extend NoSQL Database profile based on your needs, then click the Create NoSQL Database button.

   

2. Wait for the cluster to be provisioned for a few minutes.

   

3. The status changes to AVAILABLE once the cluster is provisioned.

   

4. To integrate your Extend App with the Extend NoSQL Database, proceed to the Setting up Extend NoSQL Database for your Extend App section.

Update Extend NoSQL Cluster Database Profile

You can update the database profile if you need to change the cluster size. This action can be performed at the Publisher or Studio namespace level.

1. In the Extend Database Integration menu, click the Edit button.

   

2. Select the Extend NoSQL Database profile based on your needs, then click the Update button.

   

3. In the confirmation dialog, type UPDATE to confirm the update action and click the Update button.

   

4. Wait for the cluster to be updated.

   

5. The status changes back to AVAILABLE once the cluster is updated.

   

Delete Extend NoSQL Cluster

You can delete the cluster when you no longer need it, and it can only be deleted when it is in AVAILABLE status. This action can be performed at the Publisher or Studio namespace level.

1. In the Extend Database Integration menu, click the Delete Cluster button.

   

2. In the confirmation dialog, type DELETE to confirm the deletion and click the Delete Instance button.

   

3. The page returns to the Extend Database Integration page once the cluster is deleted.

Setting up Extend NoSQL Database for your Extend App

This action can be performed at the Game namespace level, and you can only create the database when the NoSQL cluster is in AVAILABLE status.

1. In your Extend App details, switch to the NoSQL Database tab and click the Add NoSQL Database button.

   

2. Enter your database name and password, then click the Add button.

   

3. Take note of the information in the Database Summary page.

   

   The database host, name, username, and password are automatically added to your Extend App secrets and variables as DOCDB_HOST, DOCDB_DATABASE_NAME, DOCDB_USERNAME, and DOCDB_PASSWORD, respectively.

Connecting your Extend App to Extend NoSQL Database

1. Add MongoDB v2 driver to your Extend App.

   Go

   Run the following go get command to get the latest version of MongoDB driver.

   go get go.mongodb.org/mongo-driver/v2/mongo

   It is recommended to run the go mod tidy command afterward.

   go mod tidy

2. Configure the MongoDB v2 driver to connect to the NoSQL Database. Use the DOCDB_HOST, DOCDB_USERNAME, DOCDB_PASSWORD, and DOCDB_CA_CERT_FILE_PATH environment variables to construct the connection string.

   Go

   import (
       ...
       "go.mongodb.org/mongo-driver/v2/mongo"
       "go.mongodb.org/mongo-driver/v2/mongo/options"
       ...
   )
   
   ...
   
   docdbHost := os.Getenv("DOCDB_HOST")
   docdbUsername := os.Getenv("DOCDB_USERNAME")
   docdbPassword := os.Getenv("DOCDB_PASSWORD")
   docdbCaCertFilePath := os.Getenv("DOCDB_CA_CERT_FILE_PATH")
   
   connectionString := fmt.Sprintf("mongodb://%s:%s@%s/?tls=true&tlsCAFile=%s", docdbUsername, docdbPassword, docdbHost, docdbCaCertFilePath)
   
   client, err := mongo.Connect(options.Client().
       ApplyURI(connectionString).
       SetRetryWrites(false).
       SetMinPoolSize(5).
       SetMaxPoolSize(30))
   
   ...

   important

   For compatibility with Amazon DocumentDB, SetRetryWrites must be set to false.

   important

   TLS is enabled by default on the cluster. The option tls must be set to true. The TLS certificate is automatically added and is exposed by DOCDB_CA_CERT_FILE_PATH environment variable.

3. Connect to the MongoDB database and use it to insert, update, find, or delete documents. Use the DOCDB_DATABASE_NAME environment variable for the database name.

   Go

   ...
   
   docdbDatabaseName := os.Getenv("DOCDB_DATABASE_NAME")
   
   database := client.Database(docdbDatabaseName)
   
   ...

   ヒント

   To learn how to insert, update, find, or delete documents, see the MongoDB Go Driver tutorial.

Accessing the Extend NoSQL Database through Extend TCP Tunneling

You can connect to your Extend NoSQL Database from a local development environment using Extend TCP Tunneling via the Extend Helper CLI. You can only perform this action when the NoSQL cluster is in AVAILABLE status.

1. Make sure the Extend Helper CLI is set up. Then add the following permission to the IAM client you use with it.

   • For AGS Private Cloud customers:
     • ADMIN:NAMESPACE:{namespace}:EXTEND:TUNNEL [READ]
   • For AGS Shared Cloud customers:
     • Extend > TCP Tunneling (Read)

2. Copy the Resource Name information from the NoSQL Database tab.

3. Start Extend TCP Tunneling to the Extend NoSQL Database using Extend Helper CLI. Pass the Resource Name information from step 2 as the --resource-name option parameter.

   extend-helper-cli tunnel --resource-name <Resource Name> --namespace <namespace> --local-port <port>

   important

   Authentication may fail if your system clock is not synchronized. Ensure your local time is accurate before running the command.

   ヒント

   You can also copy the full command from the Tunnel Command information in the NoSQL Database tab.

4. Make sure you have downloaded the AWS DocumentDB TLS certificate from https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem (TLS is enabled and requires the certificate to connect).

5. Use your MongoDB client (such as MongoDB Compass, Studio 3T, or mongosh) to connect to the Extend NoSQL Database through the local port you specified in step 3. Use your database name, username, and password from the information you noted when setting up the database. The connection string should look like the following.

   mongodb://<username>:<password>@localhost:<port>/<database-name>?serverSelectionTimeoutMS=10000&tls=true&tlsCAFile=<path-to-certs-file>&tlsAllowInvalidHostnames=true

   important

   Make sure to include serverSelectionTimeoutMS=10000 option in the connection string. Otherwise, you may have trouble connecting. You may also try to use a bigger value than 10000 if you still have a problem connecting.

   The option tlsAllowInvalidHostnames=true is used to allow TLS connected via localhost.

Samples

The sample Extend App below is an Extend Service Extension guild service that stores its data in Extend NoSQL Database.

Go

git clone https://github.com/AccelByte/extend-service-extension-with-mongodb-go.git

Observability

You can monitor your NoSQL cluster performance through a Grafana Cloud dashboard. The dashboard provides panels displaying key performance metrics including CPU utilization, latency, IOPS, database connections, etc., allowing you to identify bottlenecks and optimize your application's database usage.

1. In the NoSQL Database tab, click the Database Dashboard button.

   

2. A new tab opens with the Grafana Cloud login page. Log in with AccelByte credentials by clicking the Sign in with Admin Portal button.

   

3. Once you are logged in, you will see the dashboard.