diff --git a/README.md b/README.md index 473b76794ad53..fde70c91e63d2 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,7 @@ specifying the project name and your database using `-d` flag. Available options * `bigquery` * `redshift` * `mssql` +* `clickhouse` For example, diff --git a/docs/Cube.js-Backend/Connecting-to-the-Database.md b/docs/Cube.js-Backend/Connecting-to-the-Database.md index 4ae1d6de76aed..33382f0aca57d 100644 --- a/docs/Cube.js-Backend/Connecting-to-the-Database.md +++ b/docs/Cube.js-Backend/Connecting-to-the-Database.md @@ -9,13 +9,14 @@ Cube.js currently provides connectors to the following databases: | Database | Cube.js DB Type | | -------------------- |---------------- | -| PostgreSQL | postgres | -| MySQL | mysql | -| AWS Athena | athena | -| AWS Redshift | redshift | +| PostgreSQL | postgres | +| MySQL | mysql | +| AWS Athena | athena | +| AWS Redshift | redshift | | MongoDB (via MongoDB Connector for BI) | mongobi | -| Google BigQuery | bigquery | -| MS SQL | mssql | +| Google BigQuery | bigquery | +| MS SQL | mssql | +| ClickHouse | clickhouse | _If you'd like to connect to a database which is not yet supported, you can create a Cube.js-compilant driver package. [Here's a simple step-by-step guide](https://github.com/statsbotco/cube.js/blob/master/CONTRIBUTING.md#implementing-driver)._ @@ -38,7 +39,7 @@ The table below shows which environment variables are used for different databas | Database | Credentials | | -------------------- |--------------- | -| PostgreSQL, MySQL, AWS Redshift, MS SQL | `CUBEJS_DB_HOST`, `CUBEJS_DB_PORT`, `CUBEJS_DB_NAME`, `CUBEJS_DB_USER`, `CUBEJS_DB_PASS` | +| PostgreSQL, MySQL, AWS Redshift, MS SQL, ClickHouse | `CUBEJS_DB_HOST`, `CUBEJS_DB_PORT`, `CUBEJS_DB_NAME`, `CUBEJS_DB_USER`, `CUBEJS_DB_PASS` | | AWS Athena | `CUBEJS_AWS_KEY`, `CUBEJS_AWS_SECRET`, `CUBEJS_AWS_REGION`, `CUBEJS_AWS_S3_OUTPUT_LOCATION` | | Google Bigquery | `CUBEJS_DB_BQ_PROJECT_ID`, `CUBEJS_DB_BQ_KEY_FILE or CUBEJS_DB_BQ_CREDENTIALS` | | MongoDB | `CUBEJS_DB_HOST`, `CUBEJS_DB_NAME`, `CUBEJS_DB_PORT`, `CUBEJS_DB_USER`, `CUBEJS_DB_PASS`, `CUBEJS_DB_SSL`, `CUBEJS_DB_SSL_CA`, `CUBEJS_DB_SSL_CERT`, `CUBEJS_DB_SSL_CIPHERS`, `CUBEJS_DB_SSL_PASSPHRASE` | diff --git a/docs/Cube.js-ClI/Reference.md b/docs/Cube.js-ClI/Reference.md index c971c64419071..9b6f16a1d010a 100644 --- a/docs/Cube.js-ClI/Reference.md +++ b/docs/Cube.js-ClI/Reference.md @@ -19,7 +19,7 @@ $ cubejs create APP-NAME -d DB-TYPE [-t TEMPLATE] | Parameter | Description | Values | | --------- | ----------- | ------ | -| -d, --db-type | Preconfigure Cube.js app for selected database. | `postgres`, `mysql`, `athena`, `mongobi`, `bigquery`, `redshift`, `mssql` | +| -d, --db-type | Preconfigure Cube.js app for selected database. | `postgres`, `mysql`, `athena`, `mongobi`, `bigquery`, `redshift`, `mssql`, `clickhouse` | | -t, --template