Documentation
ksqlDB

ksqlDB

ksqlDB driver is in preview. Please contact us if you need help running it in production.

Prerequisites

  • Hostname for the ksqlDB server
  • Username and password to connect to ksqlDB server

If you are using Confluent Cloud, you need to generate API key and use key as username and secret as password.

Setup

Manual

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

CUBEJS_DB_TYPE=ksql
CUBEJS_DB_URL=https://xxxxxx-xxxxx.us-west4.gcp.confluent.cloud:443
CUBEJS_DB_USER=username
CUBEJS_DB_PASS=password

Environment Variables

Environment VariableDescriptionPossible ValuesRequired
CUBEJS_DB_URLThe host URL for ksqlDB with portA valid database host URL
CUBEJS_DB_USERThe username used to connect to the ksqlDB. API key for Confluent Cloud.A valid port number
CUBEJS_DB_PASSThe password used to connect to the ksqlDB. API secret for Confluent Cloud.A valid database name
CUBEJS_CONCURRENCYThe number of concurrent connections each queue has to the DB. Default is 1A valid number

Pre-Aggregations Support

ksqlDB supports only streaming pre-aggregations.