Trino

Prerequisites

The hostname for the Trino database server
The username/password for the Trino database server
The name of the database to use within the Trino database server

Setup

Manual

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

CUBEJS_DB_TYPE=trino
CUBEJS_DB_HOST=my.trino.host
CUBEJS_DB_USER=trino_user
CUBEJS_DB_PASS=**********
CUBEJS_DB_PRESTO_CATALOG=my_trino_catalog
CUBEJS_DB_SCHEMA=my_trino_schema

Environment Variables

Environment Variable	Description	Possible Values	Required
`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_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_PRESTO_CATALOG`	The catalog within Presto to connect to	A valid catalog name within a Presto database	✅
`CUBEJS_DB_PRESTO_AUTH_TOKEN`	The authentication token to use when connecting to Presto/Trino. It will be sent in the `Authorization` header.	A valid authentication token	❌
`CUBEJS_DB_SCHEMA`	The schema within the database to connect to	A valid schema name within a Presto database	✅
`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_CONCURRENCY`	The number of concurrent queries to the data source	A valid number	❌
`CUBEJS_DB_EXPORT_BUCKET_TYPE`	The export bucket type for pre-aggregations	`s3`, `gcs`	❌
`CUBEJS_DB_EXPORT_BUCKET`	The export bucket to connect to	A valid bucket URL	❌
`CUBEJS_DB_EXPORT_BUCKET_AWS_KEY`	The AWS Access Key ID to use for export bucket writes	A valid AWS Access Key ID	❌
`CUBEJS_DB_EXPORT_BUCKET_AWS_SECRET`	The AWS Secret Access Key to use for export bucket writes	A valid AWS Secret Access Key	❌
`CUBEJS_DB_EXPORT_BUCKET_AWS_REGION`	The AWS region to use for export bucket writes	A valid AWS region	❌
`CUBEJS_DB_EXPORT_GCS_CREDENTIALS`	A Base64 encoded JSON key file for connecting to Google Cloud Storage	A valid Google Cloud JSON key file, encoded as a Base64 string	❌

Pre-Aggregation Feature Support

count_distinct_approx

Measures of type count_distinct_approx can be used in pre-aggregations when using Trino as a source database. To learn more about Trino support for approximate aggregate functions, click here.

Pre-Aggregation Build Strategies

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

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

By default, Trino uses a simple strategy to build pre-aggregations.

Simple

No extra configuration is required to configure simple pre-aggregation builds for Trino.

Export Bucket

Trino supports using both AWS S3 and Google Cloud Storage for export bucket functionality.

AWS S3

Ensure the AWS credentials are correctly configured in IAM to allow reads and writes to the export bucket in S3.

CUBEJS_DB_EXPORT_BUCKET_TYPE=s3
CUBEJS_DB_EXPORT_BUCKET=my.bucket.on.s3
CUBEJS_DB_EXPORT_BUCKET_AWS_KEY=<AWS_KEY>
CUBEJS_DB_EXPORT_BUCKET_AWS_SECRET=<AWS_SECRET>
CUBEJS_DB_EXPORT_BUCKET_AWS_REGION=<AWS_REGION>

Google Cloud Storage

When using an export bucket, remember to assign the Storage Object Admin role to your Google Cloud credentials (CUBEJS_DB_EXPORT_GCS_CREDENTIALS).

CUBEJS_DB_EXPORT_BUCKET=gs://trino-export-bucket
CUBEJS_DB_EXPORT_BUCKET_TYPE=gcs
CUBEJS_DB_EXPORT_GCS_CREDENTIALS=<BASE64_ENCODED_SERVICE_CREDENTIALS_JSON>

SSL

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

Custom headers

The Trino driver supports forwarding custom HTTP headers (e.g., X-Trino-Source, X-Trino-Routing-Group, X-Trino-Client-Tags, or any other custom header) on every request to the Trino coordinator. See the Trino client protocol for the list of headers accepted by Trino. Custom headers can’t be configured via environment variables. Instead, use the driver_factory configuration option to pass a headers object to the driver:

from cube import config

@config('driver_factory')
def driver_factory(ctx: dict) -> dict:
  return {
    'type': 'trino',
    'headers': {
      'X-Trino-Source': 'cube',
      'X-Trino-Routing-Group': 'etl',
      'X-Trino-Client-Tags': 'user=alice@example.com'
    }
  }

module.exports = {
  driverFactory: ({ dataSource }) => ({
    type: "trino",
    headers: {
      "X-Trino-Source": "cube",
      "X-Trino-Routing-Group": "etl",
      "X-Trino-Client-Tags": "user=alice@example.com"
    }
  })
};

In multitenant deployments, you can use the security context to pass per-tenant headers, for example to forward a user token from the API request down to Trino:

from cube import config

@config('driver_factory')
def driver_factory(ctx: dict) -> dict:
  security_context = ctx['securityContext']
  return {
    'type': 'trino',
    'headers': {
      'X-Trino-Client-Tags': f"user={security_context['user_id']}",
      'X-Custom-User-Token': security_context['token']
    }
  }

module.exports = {
  driverFactory: ({ securityContext }) => ({
    type: "trino",
    headers: {
      "X-Trino-Client-Tags": `user=${securityContext.user_id}`,
      "X-Custom-User-Token": securityContext.token
    }
  })
};

Connect to data

Users & Permissions

SSO & Identity Providers

Deployment

Monitoring

AI

Account

Prerequisites

Setup

Manual

Environment Variables

Pre-Aggregation Feature Support

count_distinct_approx

Pre-Aggregation Build Strategies

Simple

Export Bucket

AWS S3

Google Cloud Storage

SSL

Custom headers

​Prerequisites

​Setup

​Manual

​Environment Variables

​Pre-Aggregation Feature Support

​count_distinct_approx

​Pre-Aggregation Build Strategies

​Simple

​Export Bucket

​AWS S3

​Google Cloud Storage

​SSL

​Custom headers

Prerequisites

Setup

Manual

Environment Variables

Pre-Aggregation Feature Support

count_distinct_approx

Pre-Aggregation Build Strategies

Simple

Export Bucket

AWS S3

Google Cloud Storage

SSL

Custom headers