Connecting to the Database

Notes

Below you can find useful tips for configuring the connection to specific databases.

MongoDB

To use Cube.js with MongoDB you need to install MongoDB Connector for BI. You can download it here. Learn more about setup for MongoDB here.

MongoDB Atlas

Use CUBEJS_DB_SSL=true to enable SSL as MongoDB Atlas requires it. All other SSL-related environment variables can be left unset.

AWS RDS Postgres

Use CUBEJS_DB_SSL=true to enable SSL if you have SSL enabled for your RDS cluster. Download the new certificate here, and provide the contents of the downloaded file to CUBEJS_DB_SSL_CA. All other SSL-related environment variables can be left unset. See Enabling SSL for more details. More info on AWS RDS SSL can be found here.

Google Cloud SQL Postgres

You can connect to an SSL-enabled MySQL database by setting CUBEJS_DB_SSL to true. You may also need to set CUBEJS_DB_SSL_SERVERNAME, depending on how you are connecting to Cloud SQL.

Heroku Postgres

Unless you're using a Private or Shield Heroku Postgres database, Heroku Postgres does not currently support verifiable certificates. Here is the description of the issue from Heroku.

As a workaround you can set rejectUnauthorized option to false in the Cube.js Postgres driver.

const PostgresDriver = require('@cubejs-backend/postgres-driver');
module.exports = {
  driverFactory: () =>
    new PostgresDriver({
      ssl: {
        rejectUnauthorized: false,
      },
    }),
};

AWS Athena

For Athena, you'll need to specify the AWS access and secret keys with the access necessary to run Athena queries, and the target AWS region and S3 output location where query results are stored.

Google BigQuery

In order to connect BigQuery to Cube.js, you need to provide service account credentials. Cube.js requires the service account to have BigQuery Data Viewer and BigQuery Job User roles enabled.

You can set the CUBEJS_DB_BQ_KEY_FILE environment variable with a path to a JSON key file.

CUBEJS_DB_BQ_KEY_FILE=/path/to/key-file.json

You could also encode the key file with Base64:

CUBEJS_DB_BQ_CREDENTIALS=$(cat /path/to/key-file.json | base64)

You can learn more about acquiring Google BigQuery credentials here and here.

MSSQL

To connect to a MSSQL database using Windows Authentication (also sometimes known as trustedConnection), instantiate the driver with trustedConnection: true in your cube.js configuration file:

const MssqlDriver = require('@cubejs-backend/mssql-driver');
module.exports = {
  driverFactory: ({ dataSource }) =>
    new MssqlDriver({ database: dataSource, trustedConnection: true }),
};

MySQL

To connect to a local MySQL database using a UNIX socket use CUBEJS_DB_SOCKET_PATH, by doing so, CUBEJS_DB_HOST will be ignored.

You can connect to an SSL-enabled MySQL database by setting CUBEJS_DB_SSL to true. All other SSL-related environment variables can be left unset. See Enabling SSL for more details.

Druid

You can connect to an HTTPS-enabled Druid database by setting CUBEJS_DB_SSL to true. All other SSL-related environment variables can be left unset. See Enabling SSL for more details.

ClickHouse

You can connect to an HTTPS-enabled ClickHouse database by setting CUBEJS_DB_SSL to true. All other SSL-related environment variables can be left unset. See Enabling SSL for more details.

You can connect to a ClickHouse database when your user's permissions are restricted to read-only, by setting CUBEJS_DB_CLICKHOUSE_READONLY to true.

Databricks JDBC

Starting with v0.26.83 Cube.js provides a driver for Databricks. It's based on the JDBC driver from DataBricks, which requires

installation of Java with JDK. You'll need to specify the JDBC url via CUBEJS_DB_DATABRICKS_URL.

Example:

CUBEJS_DB_TYPE=databricks-jdbc
# CUBEJS_DB_NAME is an optional value
CUBEJS_DB_NAME=default
# You can find it inside specific cluster configuration
CUBEJS_DB_DATABRICKS_URL=jdbc:spark://dbc-XXXXXXX-XXXX.cloud.databricks.com:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/XXXXX/XXXXX;AuthMech=3;UID=token;PWD=XXXXX