MongoDB

The driver for MongoDB is community-supported and is not supported by Cube or the vendor.

Prerequisites

To use Cube with MongoDB you need to install the MongoDB Connector for BI. Learn more about setup for MongoDB here.

MongoDB Connector for BI
The hostname for the MongoDB database server
The username/password for the MongoDB database server

Setup

Manual

Add the following to a .env file in your Cube project:

CUBEJS_DB_TYPE=mongobi
# The MongoBI connector host. If using on local machine, it should be either `localhost` or `127.0.0.1`:
CUBEJS_DB_HOST=my.mongobi.host
# The default port of the MongoBI connector service
CUBEJS_DB_PORT=3307
CUBEJS_DB_NAME=my_mongodb_database
CUBEJS_DB_USER=mongodb_server_user
CUBEJS_DB_PASS=mongodb_server_password
# MongoBI requires SSL connections, so set the following to `true`:
CUBEJS_DB_SSL=true

If you are connecting to a local MongoBI Connector, which is pointing to a local MongoDB instance, If MongoBI Connector and MongoDB are both running locally, then the above should work. To connect to a remote MongoDB instance, first configure mongosqld appropriately. See here for an example config file.

Environment Variables

Environment Variable	Description	Possible Values	Required	Supports multiple data sources?
`CUBEJS_DB_HOST`	The host URL for a database	A valid database host URL	✅	✅
`CUBEJS_DB_PORT`	The port for the database connection	A valid port number	❌	✅
`CUBEJS_DB_NAME`	The name of the database to connect to	A valid database name	✅	✅
`CUBEJS_DB_USER`	The username used to connect to the database	A valid database username	✅	✅
`CUBEJS_DB_PASS`	The password used to connect to the database	A valid database password	✅	✅
`CUBEJS_DB_SSL`	If `true`, enables SSL encryption for database connections from Cube	`true`, `false`	✅	✅
`CUBEJS_CONCURRENCY`	The number of concurrent connections each queue has to the database. Default is `2`	A valid number	❌	❌
`CUBEJS_DB_MAX_POOL`	The maximum number of concurrent database connections to pool. Default is `8`	A valid number	❌	✅

Pre-Aggregation Feature Support

countDistinctApprox

Measures of type countDistinctApprox can not be used in pre-aggregations when using MongoDB as a source database.

Pre-Aggregation Build Strategies

To learn more about pre-aggregation build strategies, head here.

Feature	Works with read-only mode?	Is default?
Batching	✅	✅
Export Bucket	-	-

By default, MongoDB uses batching to build pre-aggregations.

Batching

No extra configuration is required to configure batching for MongoDB.

Export Bucket

MongoDB does not support export buckets.

SSL

To enable SSL-encrypted connections between Cube and MongoDB, set the CUBEJS_DB_SSL environment variable to true. For more information on how to configure custom certificates, please check out Enable SSL Connections to the Database.

Did you find this page useful?