To use Cube with MongoDB you need to install the MongoDB Connector for BI (opens in a new tab). Learn more about setup for MongoDB here (opens in a new tab).
- MongoDB Connector for BI (opens in a new tab)
- The hostname for the MongoDB (opens in a new tab) database server
- The username/password for the MongoDB (opens in a new tab) database server
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
mongosqld appropriately. See here for an example config
file (opens in a new tab).
|Environment Variable||Description||Possible Values||Required||Supports multiple data sources?|
|The host URL for a database||A valid database host URL||✅||✅|
|The port for the database connection||A valid port number||❌||✅|
|The name of the database to connect to||A valid database name||✅||✅|
|The username used to connect to the database||A valid database username||✅||✅|
|The password used to connect to the database||A valid database password||✅||✅|
|The number of concurrent connections each queue has to the database. Default is ||A valid number||❌||❌|
|The maximum number of concurrent database connections to pool. Default is ||A valid number||❌||✅|
Measures of type
not be used in pre-aggregations when using MongoDB as a source database.
To learn more about pre-aggregation build strategies, head here.
|Feature||Works with read-only mode?||Is default?|
By default, MongoDB uses batching to build pre-aggregations.
No extra configuration is required to configure batching for MongoDB.
MongoDB does not support export buckets.
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