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


Environment Variables

Environment VariableDescriptionPossible ValuesRequired
CUBEJS_DB_HOSTThe host URL for a databaseA valid database host URL
CUBEJS_DB_SOCKET_PATHSee connecting via a Unix socketA valid path to a socket
CUBEJS_DB_PORTThe port for the database connectionA valid port number
CUBEJS_DB_NAMEThe name of the database to connect toA valid database name
CUBEJS_DB_USERThe username used to connect to the databaseA valid database username
CUBEJS_DB_PASSThe password used to connect to the databaseA valid database password
CUBEJS_DB_SSLIf true, enables SSL encryption for database connections from Cubetrue, false
CUBEJS_CONCURRENCYThe number of concurrent connections each queue has to the database. Default is 2A valid number
CUBEJS_DB_MAX_POOLThe maximum number of concurrent database connections to pool. Default is 8A valid number

Pre-Aggregation Feature Support


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.

FeatureWorks with read-only mode?Is default?
Export Bucket--

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


No extra configuration is required to configure batching for MySQL.

Export Bucket

MySQL does not support export buckets.


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:


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.