MySQL

Prerequisites

The hostname for the MySQL (opens in a new tab) database server
The username/password for the MySQL (opens in a new tab) database server
The name of the database to use within the MySQL (opens in a new tab) database server

Setup

Manual

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

CUBEJS_DB_TYPE=mysql
CUBEJS_DB_HOST=my.mysql.host
CUBEJS_DB_NAME=my_mysql_database
CUBEJS_DB_USER=mysql_user
CUBEJS_DB_PASS=**********

Environment Variables

Environment Variable	Description	Possible Values	Required
`CUBEJS_DB_HOST`	The host URL for a database	A valid database host URL	✅
`CUBEJS_DB_SOCKET_PATH`	See connecting via a Unix socket	A valid path to a socket	❌
`CUBEJS_DB_PORT`	The port for the database connection	A valid port number	❌
`CUBEJS_DB_NAME`	The name of the database to connect to	A valid database name	✅
`CUBEJS_DB_USER`	The username used to connect to the database	A valid database username	✅
`CUBEJS_DB_PASS`	The password used to connect to the database	A valid database password	✅
`CUBEJS_DB_SSL`	If `true`, enables SSL encryption for database connections from Cube	`true`, `false`	❌
`CUBEJS_DB_MAX_POOL`	The maximum number of concurrent database connections to pool. Default is `8`	A valid number	❌
`CUBEJS_DB_MYSQL_USE_NAMED_TIMEZONES`	The flag to use time zone names or numeric offsets for time zone conversion. Default is `false`	`true`, `false`	❌
`CUBEJS_CONCURRENCY`	The number of concurrent queries to the data source	A valid number	❌

Pre-Aggregation Feature Support

count_distinct_approx

Measures of type count_distinct_approx can not be used in pre-aggregations when using MySQL as a source database.

Pre-Aggregation Build Strategies

To learn more about pre-aggregation build strategies, head here.

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

By default, MySQL uses batching to build pre-aggregations.

Batching

No extra configuration is required to configure batching for MySQL.

Export Bucket

MySQL does not support export buckets.

SSL

To enable SSL-encrypted connections between Cube and MySQL, 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 Database.

Additional configuration

Connecting via a Unix socket

To connect to a local MySQL database using a Unix socket, use the CUBEJS_DB_SOCKET_PATH environment variable, for example:

CUBEJS_DB_SOCKET_PATH=/var/run/mysqld/mysqld.sock

When doing so, CUBEJS_DB_HOST will be ignored.

Connecting to MySQL 8

MySQL 8 uses a new default authentication plugin (caching_sha2_password) whereas previous version used mysql_native_password. Please see this answer on StackOverflow (opens in a new tab) for a workaround.

For additional details, check the relevant issue (opens in a new tab) on GitHub.

MongoDB Oracle