Environment Variables
Cube defines a number of environment variables that can be used to change behavior. Some of these variables can also be set via configuration options.
To see a complete list of environment variables for a specific data source, please use the Connecting to Data Sources page.
The secret key used to sign and verify JWTs. Generated on project scaffold with
npx cubejs-cli create
.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid string | N/A | N/A |
An application ID used to uniquely identify the Cube deployment. Can be different for multitenant setups.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid string | cubejs | cubejs |
The AWS Access Key ID to use for database connections.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid AWS Access Key ID | N/A | N/A |
The AWS Secret Access Key to use for database connections.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid AWS Secret Access Key | N/A | N/A |
The AWS region to use for database connections.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid AWS region | N/A | N/A |
The S3 path to store AWS Athena query results made by Cube.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid S3 path | N/A | N/A |
The name of the AWS Athena workgroup in which the query is being started.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Athena Workgroup | N/A | N/A |
The name of the AWS Athena catalog to use for queries.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Athena Catalog name | N/A | N/A |
The name of the schema to use as information_schema
filter. Reduces count of
tables loaded during schema generation.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid schema name | N/A | N/A |
The cache and queue driver to use for the Cube deployment.
Possible Values | Default in Development | Default in Production |
---|---|---|
redis , memory | memory | redis |
The number of concurrent connections each query queue has to the database.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid number | See database-specific page | See database-specific page |
The hostname of the Cube Store deployment
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid hostname | localhost | N/A |
The port of the Cube Store deployment.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid port number | 3030 | 3030 |
A comma-separated list of data source names. Data sources defined here can be
used to decorate CUBEJS_DB_*
environment variables.
Possible Values | Default in Development | Default in Production |
---|---|---|
A comma-separated list of strings | N/A | N/A |
CUBEJS_DATASOURCES=default,datasource1
A Base64 encoded JSON key file for connecting to Google BigQuery.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Google BigQuery JSON key file encoded as a Base64 string | N/A | N/A |
The path to a JSON key file for connecting to Google BigQuery.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Google BigQuery JSON key file | N/A | N/A |
The Google BigQuery dataset location to connect to. Required if used with
pre-aggregations outside of US. If not set then BQ driver will fail with
Dataset was not found in location US
error.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Google BigQuery regional location | N/A | N/A |
The Google BigQuery project ID to connect to.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Google BigQuery Project ID | N/A | N/A |
Whether the ClickHouse user has read-only access or not.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | N/A | N/A |
To accept the license terms for the Databricks JDBC driver, this must be set to
true
.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | N/A | N/A |
The personal access token used to authenticate the Databricks connection.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Databricks access token | N/A | N/A |
The URL for a JDBC connection.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid JDBC URL | N/A | N/A |
A domain name within an MS SQL database to connect to.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid domain name within a MS SQL database | N/A | N/A |
The ID of the API key from elastic.co. Required when using Elastic Cloud.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Elastic.co API key ID | N/A | N/A |
The API key from elastic.co. Required when using Elastic Cloud.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Elastic.co API key | N/A | N/A |
If true
, then use the Open Distro for Elasticsearch.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | N/A | N/A |
By default, queries return data in JDBC format, but you can also return data in standard Elasticsearch JDBC, JSON, CSV, YAML or raw formats (only JSON and JDBC are currently supported).
Possible Values | Default in Development | Default in Production |
---|---|---|
json , jdbc | N/A | N/A |
The name of a bucket in cloud storage to store the database export snapshots.
When using multiple data sources, this environment variable can be decorated with a data source.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid bucket in the configured cloud storage | N/A | N/A |
CUBEJS_DB_EXPORT_BUCKET=exports-20210505
# Decorated with a data source named `datasource1`
CUBEJS_DS_DATASOURCE1_DB_EXPORT_BUCKET=exports-20210505
The cloud provider where the bucket is hosted.
When using multiple data sources, this environment variable can be decorated with a data source.
Possible Values | Default in Development | Default in Production |
---|---|---|
gcp , s3 | N/A | N/A |
CUBEJS_DB_EXPORT_BUCKET_TYPE=gcp
# Decorated with a data source named `datasource1`
CUBEJS_DS_DATASOURCE1_DB_EXPORT_BUCKET_TYPE=gcp
The AWS Access Key ID to use for the export bucket.
When using multiple data sources, this environment variable can be decorated with a data source.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid AWS Access Key ID | N/A | N/A |
The AWS Secret Access Key to use for the export bucket.
When using multiple data sources, this environment variable can be decorated with a data source.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid AWS Secret Access Key | N/A | N/A |
The AWS region of the export bucket.
When using multiple data sources, this environment variable can be decorated with a data source.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid AWS region | N/A | N/A |
The mount path to use for a Databricks DBFS mount.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid mount path | N/A | N/A |
An ARN of an AWS IAM role with permission to write to the configured bucket (see
CUBEJS_DB_EXPORT_BUCKET
).
When using multiple data sources, this environment variable can be decorated with a data source.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid ARN to an IAM Role associated with the target Redshift data source | N/A | N/A |
A Base64 encoded JSON key file for connecting to Google Cloud.
When using multiple data sources, this environment variable can be decorated with a data source.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Google Cloud JSON key file encoded as a Base64 string | N/A | N/A |
The name of the integration used in the database. Only required when using Snowflake and Google Cloud Storage.
When using multiple data sources, this environment variable can be decorated with a data source.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid string matching the name of the integration in Snowflake | N/A | N/A |
The host URL for a database.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid database host URL | N/A | N/A |
The maximum number of concurrent database connections to pool.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid number | See database-specific page | See database-specific page |
The name of the database to connect to.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid database name | N/A | N/A |
The password used to connect to the database.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid database password | N/A | N/A |
The port for the database connection.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid port number | N/A | N/A |
The catalog within Presto/Trino to connect to.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid catalog name within a Presto/Trino database | N/A | N/A |
The timeout value for any queries made to the database by Cube.
Possible Values | Default in Development | Default in Production |
---|---|---|
A number in seconds or a duration string | 10m | 10m |
The Snowflake account identifier to use when connecting to the database.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Snowflake account ID | N/A | N/A |
The type of authenticator to use with Snowflake. Use SNOWFLAKE
with
username/password, or SNOWFLAKE_JWT
with key pairs.
Possible Values | Default in Development | Default in Production |
---|---|---|
SNOWFLAKE , SNOWFLAKE_JWT | SNOWFLAKE | SNOWFLAKE |
If true
, keep the Snowflake connection alive
indefinitely.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | N/A | N/A |
The password for the private RSA key. Only required for encrypted keys.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid password for the encrypted private RSA key | N/A | N/A |
The path to the private RSA key folder.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid path to the private RSA key | N/A | N/A |
The Snowflake region to use when connecting to the database.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Snowflake region | N/A | N/A |
The Snowflake role to use when connecting to the database.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Snowflake role in the account | N/A | N/A |
The Snowflake warehouse to use when connecting to the database.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Snowflake warehouse in the account | N/A | N/A |
If true
, enables SSL encryption for database connections from Cube.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | N/A | N/A |
A database from the list of supported databases.
Possible Values | Default in Development | Default in Production |
---|---|---|
Any valid database supported by Cube | N/A | N/A |
The URL for a database.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid database URL | N/A | N/A |
The username used to connect to the database.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid database username | N/A | N/A |
If true
, enables development mode.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | true | false |
If true
, it enables dropping pre-aggregations that Refresh Worker doesn't
touch within CUBEJS_TOUCH_PRE_AGG_TIMEOUT
.
Pre-aggregations are touched whenever they are rebuilt or a Refresh Worker
checks its freshness. The first drop will be initiated when the Refresh Worker
is able to check freshness for every scheduledRefresh: true
pre-aggregation.
If you have multiple Refresh Workers with different schema versions sharing the
same Cube Store cluster, then touches from both refresh workers are respected.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | true | true |
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Firebolt account name | N/A | N/A |
The Firebolt API endpoint. Used for authentication.
Possible Values | Default in Development | Default in Production |
---|---|---|
api.dev.firebolt.io , api.staging.firebolt.io , api.app.firebolt.io | N/A | N/A |
The name of the Firebolt engine to connect to.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Firebolt engine name | N/A | N/A |
A GitHub Personal Access Token to avoid API rate limiting when downloading Cube Store.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid GitHub PAT | false | false |
Enables JSON Web Key (JWK)-based authentication in Cube.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid URL to a JSON Web Key Set | N/A | N/A |
Any supported algorithm for decoding JWTs.
Possible Values | Default in Development | Default in Production |
---|---|---|
HS256 , RS256 | N/A | N/A |
An audience value which will be used to enforce the aud
claim from inbound
JWTs.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid aud claim | N/A | N/A |
A namespace within the decoded JWT under which any custom claims can be found.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid string | N/A | N/A |
An issuer value which will be used to enforce the iss
claim from inbound
JWTs.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid iss claim | N/A | N/A |
The secret key used to sign and verify JWTs. Similar to
CUBEJS_API_SECRET
.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid string | N/A | N/A |
A subject value which will be used to enforce the sub
claim from inbound
JWTs.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid sub claim | N/A | N/A |
The logging level for Cube.
Possible Values | Default in Development | Default in Production |
---|---|---|
error , info , trace , warn | warn | warn |
The maximum number of partitions each pre-aggregation in a cube can use.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid number | 10000 | 10000 |
The port to listen to Postgres-compatible connections on.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid port number | N/A | N/A |
If true
, this instance of Cube will build pre-aggregations, even if it is an
API instance.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | true | false * |
If Cube is configured to act as a refresh worker instance using
CUBEJS_REFRESH_WORKER
, then
CUBEJS_PRE_AGGREGATIONS_BUILDER
will be true
.
The schema name to use for storing pre-aggregations.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid string | dev_pre_aggregations | prod_pre_aggregations |
The password used to connect to the Redis server.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Redis password | N/A | N/A |
The maximum number of connections to keep active in the Redis connection pool
for a single appId
(tenant). Must be higher
than CUBEJS_REDIS_POOL_MIN
.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid number of connections | 1000 | 1000 |
The minimum number of connections to keep active in the Redis connection pool
for a single appId
(tenant). Must be lower
than CUBEJS_REDIS_POOL_MAX
.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid number of connections | 2 | 2 |
If true
, then the connection to the Redis server is protected by TLS
authentication.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | false | false |
The host URL for a Redis server.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Redis host URL | N/A | N/A |
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | false | false |
If true
, this instance of Cube will only refresh pre-aggregations.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | false | false |
If true
, this instance of Cube will only query rollup pre-aggregations.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | false | false |
How many pre-aggregations refresh worker will build in parallel. Please note changing this param doesn't change queue concurrency and it should be adjusted accordingly
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid number of concurrent refresh processes | N/A | N/A |
A comma-separated list of timezones to schedule refreshes
for. Used in conjunction with
CUBEJS_SCHEDULED_REFRESH_CONCURRENCY
.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid timezone from the tz database | N/A | N/A |
The path where Cube loads schemas from.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid path containing Cube schemas | schema | schema |
Required password to access SQL API.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid string | N/A | N/A |
The port to listen to MySQL compatibility connections on.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid port number | N/A | N/A |
A name of specific user who will be allowed to change security context.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid string | N/A | N/A |
Required username to access SQL API.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid string | N/A | N/A |
If true
, then send telemetry to Cube.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | true | true |
The number of seconds without a touch before pre-aggregation is considered
orphaned and marked for removal. Please see
CUBEJS_DROP_PRE_AGG_WITHOUT_TOUCH
to
learn more.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid number | 86400 | 86400 |
If true
, then use WebSocket for data fetching.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | true | true |
The Access Key ID for AWS. Required when using AWS S3.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid AWS Access Key ID | N/A | N/A |
The Secret Access Key for AWS. Required when using AWS S3.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid AWS Secret Access Key | N/A | N/A |
The number of minutes after which Cube Store should refresh AWS credentials. Required when using an AWS instance role.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid number in minutes | 180 | 180 |
The address/port pair for Cube Store's MySQL-compatible interface.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid address/port pair | 0.0.0.0:3306 | 0.0.0.0:3306 |
A path on the local filesystem to store a local replica of the data. Must be
unique on each node and different from CUBESTORE_REMOTE_DIR
.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid path on the local filesystem with read/write access | .cubestore/data | .cubestore/data |
A Base64-encoded JSON key file for connecting to Google Cloud. Required when using Google Cloud Storage
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Google BigQuery JSON key file encoded as a Base64 string | N/A | N/A |
The path to a JSON key file for connecting to Google Cloud. Required when using Google Cloud Storage.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid Google Cloud JSON key file | N/A | N/A |
The name of a bucket in GCS. Required when using GCS
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid bucket name in the Google Cloud account | N/A | N/A |
The path in a GCS bucket to store pre-aggregations. Optional
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid path prefix | N/A | N/A |
The address/port pair for Cube Store's HTTP interface.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid address/port pair | 0.0.0.0:3030 | 0.0.0.0:3030 |
The port for Cube Store to listen to HTTP connections on. Ignored when
CUBESTORE_HTTP_BIND_ADDR
is set.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid port number | 3030 | 3030 |
The number of parallel tasks that process non-interactive jobs like data insertion, compaction etc.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid number | 4 | 4 |
The logging level for Cube Store.
Possible Values | Default in Development | Default in Production |
---|---|---|
error , warn , info , debug , trace | error | error |
The address/port pair for the router node in the cluster.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid address/port pair | N/A | N/A |
The port for the router node to listen for connections on. Ignored when
CUBESTORE_META_ADDR
is set.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid port number | N/A | N/A |
The Access Key ID for minIO. Required when using minIO.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid minIO Access Key ID | N/A | N/A |
The name of the bucket that you want to use minIO. Required when using minIO.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid bucket name | N/A | N/A |
The number of minutes after which Cube Store should refresh minIO credentials.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid number in minutes | 180 | 180 |
The region of a bucket in AWS. Optional when using minIO.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid S3 region name, an empty string if not present | N/A | N/A |
The Secret Access Key for minIO. Required when using minIO.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid minIO Secret Access Key | N/A | N/A |
The minIO server endpoint. Required when using minIO.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid minIO endpoint | N/A | N/A |
CUBESTORE_MINIO_SERVER_ENDPOINT=http://localhost:9000
If true
, prevents uploading serialized pre-aggregations to cloud storage.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | false | false |
The port for Cube Store to listen to connections on. Ignored when
CUBESTORE_BIND_ADDR
is set.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid port number | 3306 | 3306 |
The timeout for SQL queries in seconds.
Possible Values | Default in Development | Default in Production |
---|---|---|
A number in seconds | 120 | 120 |
A path on the local filesystem to store metadata and datasets from all nodes as if it were remote storage. Not required if using GCS/S3. Not recommended for production usage
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid path on the local filesystem with read/write access | N/A | N/A |
The name of a bucket in AWS S3. Required when using AWS S3.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid bucket name in the AWS account | N/A | N/A |
| The region of a bucket in AWS S3. Required when using AWS S3.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid AWS region | N/A | N/A |
The path in a AWS S3 bucket to store pre-aggregations. Optional.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid path prefix | N/A | N/A |
The number of Cube Store sub-processes that handle SELECT
queries.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid number | 4 | 4 |
The full name and port number of the Cube Store server. Must be unique for each instance in cluster mode.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid address/port pair | localhost | localhost |
The maximum number of rows to keep in a single chunk of data right after insertion.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid number | 262144 | 262144 |
The port for Cube Store workers to listen to connections on. When set, the node will start as a worker in the cluster
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid port number | N/A | N/A |
A comma-separated list of address/port pairs for Cube Store workers.
Possible Values | Default in Development | Default in Production |
---|---|---|
A comma-separated list of address/port pairs | N/A | N/A |
CUBESTORE_WORKERS=worker-1:3123,localhost:3124,123.124.125.128:3123
If true
, enables debug logging.
Possible Values | Default in Development | Default in Production |
---|---|---|
true , false | false | false |
The port for a Cube deployment to listen to API connections on.
Possible Values | Default in Development | Default in Production |
---|---|---|
A valid port number | 4000 | 4000 |
Did you find this page useful?