> ## Documentation Index
> Fetch the complete documentation index at: https://cubed3-feat-druid-driver-streaming.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# MongoDB

> Query MongoDB from Cube through the BI Connector’s SQL interface, including community-driver and Atlas deprecation caveats.

[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*.

<Warning>
  The driver for MongoDB is community-supported and is not maintained by Cube or the database vendor.
</Warning>

<Warning>
  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.
</Warning>

## Prerequisites

<Info>
  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].
</Info>

* [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 theme={null}
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 |
| ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------- | :------: |
| [`CUBEJS_DB_HOST`](/reference/configuration/environment-variables#cubejs_db_host)         | The host URL for a database                                                        | A valid database host URL |     ✅    |
| [`CUBEJS_DB_PORT`](/reference/configuration/environment-variables#cubejs_db_port)         | The port for the database connection                                               | A valid port number       |     ❌    |
| [`CUBEJS_DB_NAME`](/reference/configuration/environment-variables#cubejs_db_name)         | The name of the database to connect to                                             | A valid database name     |     ✅    |
| [`CUBEJS_DB_USER`](/reference/configuration/environment-variables#cubejs_db_user)         | The username used to connect to the database                                       | A valid database username |     ✅    |
| [`CUBEJS_DB_PASS`](/reference/configuration/environment-variables#cubejs_db_pass)         | The password used to connect to the database                                       | A valid database password |     ✅    |
| [`CUBEJS_DB_SSL`](/reference/configuration/environment-variables#cubejs_db_ssl)           | If `true`, enables SSL encryption for database connections from Cube               | `true`, `false`           |     ✅    |
| [`CUBEJS_DB_MAX_POOL`](/reference/configuration/environment-variables#cubejs_db_max_pool) | The maximum number of concurrent database connections to pool. Default is `8`      | A valid number            |     ❌    |
| [`CUBEJS_CONCURRENCY`](/reference/configuration/environment-variables#cubejs_concurrency) | The number of [concurrent queries][ref-data-source-concurrency] to the data source | A valid number            |     ❌    |

[ref-data-source-concurrency]: /admin/connect-to-data/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

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

| 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
[`CUBEJS_DB_SSL`](/reference/configuration/environment-variables#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][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]: /docs/pre-aggregations/using-pre-aggregations#pre-aggregation-build-strategies

[ref-recipe-enable-ssl]: /recipes/configuration/using-ssl-connections-to-data-source

[ref-schema-ref-types-formats-countdistinctapprox]: /reference/data-modeling/measures#type

[self-preaggs-batching]: #batching

[link-bi-connector]: https://www.mongodb.com/docs/bi-connector/current/