# MongoDB

[MongoDB](https://www.mongodb.com) is a popular document database. It can be
accessed using SQL via the [MongoDB Connector for BI][link-bi-connector], also
known as _BI Connector_.

<CommunitySupportedDriver dataSource="MongoDB" />

<WarningBox>

BI Connector for MongoDB Atlas, cloud-based MongoDB service, is approaching
[end-of-life](https://www.mongodb.com/docs/atlas/bi-connection/#std-label-bi-connection).
It will be deprecated and no longer supported in June 2025.

</WarningBox>

## Prerequisites

<InfoBox>

To use Cube with MongoDB you need to install the [MongoDB Connector for
BI][mongobi-download]. [Learn more about setup for MongoDB
here][cube-blog-mongodb].

</InfoBox>

- [MongoDB Connector for BI][mongobi-download]
- The hostname for the [MongoDB][mongodb] database server
- The username/password for the [MongoDB][mongodb] database server

## Setup

### Manual

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

```dotenv
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][mongobi-with-remote-db].

## Environment Variables

| Environment Variable | Description                                                                         | Possible Values           | Required |
| -------------------- | ----------------------------------------------------------------------------------- | ------------------------- | :------: |
| <EnvVar>CUBEJS_DB_HOST</EnvVar>     | The host URL for a database                                                         | A valid database host URL |    ✅    |
| <EnvVar>CUBEJS_DB_PORT</EnvVar>     | The port for the database connection                                                | A valid port number       |    ❌    |
| <EnvVar>CUBEJS_DB_NAME</EnvVar>     | The name of the database to connect to                                              | A valid database name     |    ✅    |
| <EnvVar>CUBEJS_DB_USER</EnvVar>     | The username used to connect to the database                                        | A valid database username |    ✅    |
| <EnvVar>CUBEJS_DB_PASS</EnvVar>     | The password used to connect to the database                                        | A valid database password |    ✅    |
| <EnvVar>CUBEJS_DB_SSL</EnvVar>      | If `true`, enables SSL encryption for database connections from Cube                | `true`, `false`           |    ✅    |
| <EnvVar>CUBEJS_DB_MAX_POOL</EnvVar> | The maximum number of concurrent database connections to pool. Default is `8`       | A valid number            |    ❌    |
| <EnvVar>CUBEJS_CONCURRENCY</EnvVar> | The number of [concurrent queries][ref-data-source-concurrency] to the data source | A valid number |    ❌    |

[ref-data-source-concurrency]: /product/configuration/concurrency#data-source-concurrency

## Pre-Aggregation Feature Support

### count_distinct_approx

Measures of type
[`count_distinct_approx`][ref-schema-ref-types-formats-countdistinctapprox] can
not be used in pre-aggregations when using MongoDB as a source database.

## Pre-Aggregation Build Strategies

<InfoBox>

To learn more about pre-aggregation build strategies, [head
here][ref-caching-using-preaggs-build-strats].

</InfoBox>

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

By default, MongoDB uses [batching][self-preaggs-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
<EnvVar>CUBEJS_DB_SSL</EnvVar> environment variable to `true`. For more information on how to
configure custom certificates, please check out [Enable SSL Connections to the
Database][ref-recipe-enable-ssl].

[mongodb]: https://www.mongodb.com/
[mongobi-with-remote-db]:
  https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#example-configuration-file
[cube-blog-mongodb]:
  https://cube.dev/blog/building-mongodb-dashboard-using-nodejs
[mongobi-download]: https://www.mongodb.com/download-center/bi-connector
[ref-caching-using-preaggs-build-strats]:
  /product/caching/using-pre-aggregations#pre-aggregation-build-strategies
[ref-recipe-enable-ssl]:
  /product/configuration/recipes/using-ssl-connections-to-data-source
[ref-schema-ref-types-formats-countdistinctapprox]: /product/data-modeling/reference/types-and-formats#count_distinct_approx
[self-preaggs-batching]: #batching
[link-bi-connector]: https://www.mongodb.com/docs/bi-connector/current/