Moon ModelerSchema Design Tool for DocumentDB

FREE 14 days trial. No card required.
  • Native DocumentDB Connection A dedicated connection type, new in version 13.5
  • Reverse Engineering Turn existing collections into a diagram
  • Validation Scripts Generate schema validation from your model
  • Excellent ROI Pay once, use forever
How do I create a diagram for a DocumentDB database?

Create a DocumentDB connection in Moon Modeler, enter the cluster host, your credentials and TLS settings, and click Connect and load existing database structure. Moon Modeler reads the collections and draws the diagram for you.

Learn more about Moon Modeler

Can I design a DocumentDB schema before the cluster exists?

Yes. Create a new project, design collections, fields, embedded documents and references on the diagram, and generate scripts once the cluster is ready.

Download Moon Modeler

Connect DocumentDB to Moon Modeler
and Visualize Your Collections

Start with a Free DocumentDB Cluster

Don't have a cluster yet? Azure DocumentDB (with MongoDB compatibility) offers a free tier. In the Azure portal, create a new Azure DocumentDB cluster, check Free tier and pick a location.

The free tier comes with 32 GiB of storage and an estimated cost of zero. High availability is not available on it, so keep it for learning and prototyping, not for production data.

Creating a free tier Azure DocumentDB cluster in the Azure portal
Free tier Azure DocumentDB cluster
New connection dialog in Moon Modeler with MongoDB, CosmosDB and DocumentDB connection types
MongoDB, CosmosDB and DocumentDB connection types in Moon Modeler

Create a DocumentDB Connection

Click Connections on the main toolbar, then Create new connection and select the DocumentDB tab. Enter the host and port of your cluster in the URL field. You can copy them from the connection string of the cluster.

On the Authentication tab, select the authentication type used by your cluster and enter the user name and password of the cluster admin or another database user.

Enable TLS and, if Needed, SSH

DocumentDB clusters expect encrypted connections. Turn on Enable TLS on the SSL/TLS tab. For Amazon DocumentDB, select the Amazon RDS certificate bundle (global-bundle.pem) as the CA Certificate.

Amazon DocumentDB clusters are reachable only from inside their VPC. To connect from your computer, open an SSH tunnel through an EC2 instance on the SSH tab of the connection.

SSH/SSL/TLS connections are supported for MongoDB databases in the Professional Edition.

Read about secure connections

Enable TLS, CA Certificate and Client Key settings of a connection in Moon Modeler
TLS settings of a connection in Moon Modeler

Connect and Load the Database Structure

Save the connection and click Connect and load existing database structure. Moon Modeler reads the collections, fields and embedded documents and creates a project with a diagram — the same way it does for MongoDB.

Add descriptions, notes and references, arrange collections into sub-diagrams and share the result as an interactive HTML report or PDF.

Read about visualization of existing databases

Design New Collections and Generate Scripts

Click New on the main toolbar and select DocumentDB in the New project dialog to start a model from scratch. Design collections visually, define fields, embedded documents and references, and generate validation and creation scripts for your DocumentDB database.

Already have a MongoDB model? Click Convert on the main toolbar and choose Convert to DocumentDB.

Read about DocumentDB schema design

Convert menu in Moon Modeler with Convert to Mongoose, Convert to CosmosDB and Convert to DocumentDB
Convert a MongoDB model to DocumentDB
Frequently Asked Questions on Schema Design for DocumentDB
Can I try DocumentDB schema design for free?

Yes. Azure DocumentDB (with MongoDB compatibility) offers a free tier cluster with 32 GiB of storage, and Moon Modeler comes with a free trial.

How do I connect to Amazon DocumentDB from my computer?

Amazon DocumentDB clusters are reachable only from inside their VPC. Open an SSH tunnel through an EC2 instance on the SSH tab of the connection and enable TLS with the Amazon RDS certificate bundle. Read the Amazon DocumentDB guide.

Should I turn on Retry writes for DocumentDB?

No. DocumentDB connection strings usually include retryWrites=false, so keep Retry writes off in the Moon Modeler connection as well.

Can I generate validation scripts for DocumentDB?

Yes. Design collections visually or load them from the database and generate validation and creation scripts from your model.

Is my data model stored in the cloud?

No. Moon Modeler is a desktop application for Windows, macOS and Linux. Database connections and data models stay on your computer.