MySQL

Prerequisites

The hostname for the MySQL database server
The username/password for the MySQL database server
The name of the database to use within the MySQL 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	Supports multiple data sources?
`CUBEJS_DB_HOST`	The host URL for a database	A valid database host URL	✅	✅
`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_CONCURRENCY`	The number of concurrent connections each queue has to the database. Default is `2`	A valid number	❌	❌
`CUBEJS_DB_MAX_POOL`	The maximum number of concurrent database connections to pool. Default is `8`	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.

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

Local/Docker

To connect to a local MySQL database using a Unix socket, use CUBEJS_DB_SOCKET_PATH. When 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 the SSL section above for more details.

Did you find this page useful?