feat(docs): add ClickHouse connector to docs package

Canner · Jul 6, 2023 · 942adb3 · 942adb3
1 parent 85eecf5
commit 942adb3
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 2 deletions.
diff --git a/packages/doc/docs/connectors.mdx b/packages/doc/docs/connectors.mdx
@@ -8,6 +8,7 @@ We support the following data warehouses to connect with, you can choose multipl
 | [DuckDB](./connectors/duckdb)         | ✅ Yes | ✅ Yes      | ❌ No             |
 | [Snowflake](./connectors/snowflake)   | ✅ Yes | ✅ Yes      | ❌ No             |
 | [BigQuery](./connectors/bigquery)     | ✅ Yes | ✅ Yes      | ❌ No             |
+| [ClickHouse](./connectors/clickhouse) | ✅ Yes | ✅ Yes      | ❌ No             |
 
 \* Fetching rows only when we need them, it has better performance with large query results.
 

diff --git a/packages/doc/docs/connectors/clickhouse.mdx b/packages/doc/docs/connectors/clickhouse.mdx
@@ -0,0 +1,67 @@
+# ClickHouse
+
+Connect with your ClickHouse servers via the official [Node.js Driver](https://clickhouse.com/docs/en/integrations/language-clients/nodejs).
+
+## Installation
+
+1. Install package
+
+   ```bash
+   npm i @vulcan-sql/extension-driver-clickhouse
+   ```
+
+   :::info
+   If you run VulcanSQL with Docker, you should use the command `vulcan-install @vulcan-sql/extension-driver-clickhouse` instead.
+
+   :::
+
+2. Update `vulcan.yaml`, and enable the extension.
+
+   ```yaml
+   extensions:
+     ...
+     // highlight-next-line
+     snow: '@vulcan-sql/extension-driver-clickhouse' # Add this line
+   ```
+
+3. Create a new profile in `profiles.yaml` or in your profile files. For example:
+
+   ```yaml
+   - name: ch # profile name
+     type: clickhouse
+     connection:
+       host: www.example.com:8123
+       request_timeout: 60000
+       compression:
+         request: true
+       max_open_connections: 10
+       username: user
+       password: pass
+       database: hello-clickhouse
+     allow: '*'
+   ```
+
+## Configuration
+
+Please check [arguments of ClickHouse Client](https://clickhouse.com/docs/en/integrations/language-clients/nodejs) for further information.
+
+| Name                 | Required | Default               | Description                                                                                                                                                                                                                                                       |
+| -------------------- | -------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| host                 | N        | http://localhost:8123 | ClickHouse instance URL.                                                                                                                                                                                                                                          |
+| request_timeout      | N        | 30000                 | The request timeout in milliseconds.                                                                                                                                                                                                                              |
+| max_open_connections | N        | Infinity              | Maximum number of sockets to allow per host.                                                                                                                                                                                                                      |
+| compression          | N        |                       | Data applications operating with large datasets over the wire can benefit from enabling compression. Currently, only GZIP is supported using zlib.Please see [Compression docs](https://clickhouse.com/docs/en/integrations/language-clients/nodejs#compression). |
+| username             | N        | default               | The name of the user on whose behalf requests are made.                                                                                                                                                                                                           |
+| password             | N        |                       | The user password.                                                                                                                                                                                                                                                |
+| application          | N        | VulcanSQL             | The name of the application using the Node.js client.                                                                                                                                                                                                             |
+| database             | N        | default               | Database name to use.                                                                                                                                                                                                                                             |
+| clickhouse_settings  | N        |                       | ClickHouse settings to apply to all requests. please see the [Advance Settings](https://clickhouse.com/docs/en/operations/settings), and [Definition](https://github.com/ClickHouse/clickhouse-js/blob/0.1.1/src/settings.ts)                                     |
+| tls                  | N        |                       | Configure TLS certificates. Please see [TLS docs](https://clickhouse.com/docs/en/integrations/language-clients/nodejs#tls-certificates).                                                                                                                          |
+| session_id           | N        |                       | ClickHouse Session ID to send with every request.                                                                                                                                                                                                                 |
+| keep_alive           | N        |                       | HTTP Keep-Alive related settings. Please see [Keep Alive docs](https://clickhouse.com/docs/en/integrations/language-clients/nodejs#keep-alive)                                                                                                                    |
+
+## ⚠️ Caution
+
+ClickHouse driver currently not yet support for caching datasets feature.
+
+If you use the ClickHouse driver and setup the cache options in API Schema yaml, it will throw error.
diff --git a/packages/extension-driver-clickhouse/package.json b/packages/extension-driver-clickhouse/package.json
@@ -15,8 +15,8 @@
     "data-warehouse",
     "data-lake",
     "api-builder",
-    "snowflake",
-    "snow"
+    "clickhouse",
+    "ch"
   ],
   "repository": {
     "type": "git",

diff --git a/packages/extension-driver-clickhouse/src/lib/clickhouseDataSource.ts b/packages/extension-driver-clickhouse/src/lib/clickhouseDataSource.ts
@@ -120,6 +120,8 @@ export class ClickHouseDataSource extends DataSource<any, ClickHouseOptions> {
       const [namesRow, typesRow, ...dataRows] = rows;
       names = JSON.parse(namesRow.text);
       types = JSON.parse(typesRow.text);
+      // ClickHouse stream only called once and return all data row in one chuck, so we need to push each row to the stream by loop.
+      // Please see https://clickhouse.com/docs/en/integrations/language-clients/nodejs#resultset-and-row-abstractions
       dataRows.forEach((row) => dataRowStream.push(row.text));
     });
     await new Promise((resolve) => {