Back to Cube

Materialize

docs/content/product/configuration/data-sources/materialize.mdx

1.6.432.8 KB
Original Source

Materialize

<WarningBox>

The driver for Materialize is supported by its vendor. Please report any issues to their Slack.

</WarningBox>

Prerequisites

Setup

Manual

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

dotenv
CUBEJS_DB_TYPE=materialize
CUBEJS_DB_HOST=my.materialize.host
CUBEJS_DB_PORT=6875
CUBEJS_DB_NAME=materialize
CUBEJS_DB_USER=materialize
CUBEJS_DB_PASS=materialize
CUBEJS_DB_MATERIALIZE_CLUSTER=quickstart

Environment Variables

Environment VariableDescriptionPossible ValuesRequired
<EnvVar>CUBEJS_DB_HOST</EnvVar>The host URL for a databaseA valid database host URL
<EnvVar>CUBEJS_DB_PORT</EnvVar>The port for the database connectionA valid port number
<EnvVar>CUBEJS_DB_NAME</EnvVar>The name of the database to connect toA valid database name
<EnvVar>CUBEJS_DB_USER</EnvVar>The username used to connect to the databaseA valid database username
<EnvVar>CUBEJS_DB_PASS</EnvVar>The password used to connect to the databaseA valid database password
<EnvVar>CUBEJS_DB_MAX_POOL</EnvVar>The maximum number of concurrent database connections to pool. Default is 8A valid number
<EnvVar>CUBEJS_DB_MATERIALIZE_CLUSTER</EnvVar>The name of the Materialize cluster to connect toA valid cluster name
<EnvVar>CUBEJS_CONCURRENCY</EnvVar>The number of concurrent queries to the data sourceA valid number

SSL

To enable SSL-encrypted connections between Cube and Materialize, set the <EnvVar>CUBEJS_DB_SSL</EnvVar> environment variable to true. For more information on how to configure custom certificates, please check out Enable SSL Connections to the Database.