Connecting to the Database
Cube.js currently provides connectors to the following databases:
| Database | Cube.js DB Type |
|---|---|
| PostgreSQL | postgres |
| MySQL | mysql |
| AWS Athena | athena |
| AWS Redshift | redshift |
| MongoDB (via MongoDB Connector for BI) | mongobi |
| Google BigQuery | bigquery |
| MS SQL | mssql |
| ClickHouse | clickhouse |
| Snowflake | snowflake |
| Presto | prestodb |
| Hive / SparkSQL (thrift) | hive |
| Oracle | oracle |
If you'd like to connect to a database which is not yet supported, you can create a Cube.js-compilant driver package. Here's a simple step-by-step guide.
When you create a new Cube.js service with the Cube.js CLI, the .env will be
generated to manage all connection credentials. The set of variables could be different based on your database type. For example, for PostgreSQL the .env will look like this:
CUBEJS_DB_HOST=<YOUR_DB_HOST_HERE>
CUBEJS_DB_NAME=<YOUR_DB_NAME_HERE>
CUBEJS_DB_USER=<YOUR_DB_USER_HERE>
CUBEJS_DB_PASS=<YOUR_DB_PASS_HERE>
CUBEJS_DB_TYPE=postgres
CUBEJS_API_SECRET=secret
The table below shows which environment variables are used for different databases:
| Database | Credentials |
|---|---|
| PostgreSQL, MySQL, AWS Redshift, MS SQL, ClickHouse, Hive/SparkSQL, Oracle | CUBEJS_DB_HOST, CUBEJS_DB_PORT, CUBEJS_DB_NAME, CUBEJS_DB_USER, CUBEJS_DB_PASS |
| AWS Athena | CUBEJS_AWS_KEY, CUBEJS_AWS_SECRET, CUBEJS_AWS_REGION, CUBEJS_AWS_S3_OUTPUT_LOCATION |
| Google Bigquery | CUBEJS_DB_BQ_PROJECT_ID, CUBEJS_DB_BQ_KEY_FILE or CUBEJS_DB_BQ_CREDENTIALS |
| MongoDB | CUBEJS_DB_HOST, CUBEJS_DB_NAME, CUBEJS_DB_PORT, CUBEJS_DB_USER, CUBEJS_DB_PASS, CUBEJS_DB_SSL, CUBEJS_DB_SSL_CA, CUBEJS_DB_SSL_CERT, CUBEJS_DB_SSL_CIPHERS, CUBEJS_DB_SSL_PASSPHRASE |
| Snowflake | CUBEJS_DB_SNOWFLAKE_ACCOUNT, CUBEJS_DB_SNOWFLAKE_REGION, CUBEJS_DB_SNOWFLAKE_WAREHOUSE, CUBEJS_DB_NAME, CUBEJS_DB_USER, CUBEJS_DB_PASS |
| Presto | CUBEJS_DB_HOST, CUBEJS_DB_PORT, CUBEJS_DB_CATALOG, CUBEJS_DB_SCHEMA, CUBEJS_DB_USER, CUBEJS_DB_PASS |
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.
Use CUBEJS_DB_SSL=true to enable SSL as MongoDB Atlas requires it. CUBEJS_DB_SSL_CA, CUBEJS_DB_SSL_CERT, CUBEJS_DB_SSL_CIPHERS, CUBEJS_DB_SSL_PASSPHRASE can be left blank.
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.
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 CUBEJS_DB_BQ_KEY_FILE environment variable with a path to JSON key file.
Another way is to encode the key file with base64:
$ cat /path/to/key-file.json | base64
Now you can set the CUBEJS_DB_BQ_CREDENTIALS environment variable with the base64-encoded key.
Cube.js supports connection to multiple databases out-of-the-box. Please refer to Multitenancy Guide to learn more.
Cube.js supports connection via SSL for Postgres and Mongo. To enable it set
CUBEJS_DB_SSL environment variable to true.
