@cleverbrush/knex-clickhouse 1.1.9 → 1.1.11

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import Knex from 'knex';
-import ClickhouseDriver, { type ClickHouseSettings } from '@clickhouse/client';
+import ClickhouseDriver, { ClickHouseClient, type ClickHouseSettings } from '@clickhouse/client';
 import { retry } from '@cleverbrush/async';
+export { type ClickHouseClient };
 type AdditionalClientOptions = {
     /**
      * Options for retrying the query,
@@ -19,11 +20,10 @@ export declare class ClickhouseKnexClient extends Knex.Client {
     _escapeBinding(value: any): any;
     /**
      *
-     * @param {import('@clickhouse/client').ClickHouseClient} connection
      * @param {import('@clickhouse/client').QueryParams} obj
      * @returns
      */
-    _query(connection: any, obj: any): Promise<any>;
+    _query(connection: ClickHouseClient, obj: any): Promise<any>;
     /**
      *
      * @param {import('@clickhouse/client').ResultSet} obj
@@ -38,5 +38,4 @@ export declare class ClickhouseKnexClient extends Knex.Client {
  *
  * @returns {import('knex').Knex<any, unknown[]>}
  */
-export declare const getClickhouseConnection: (config?: Knex.Knex.Config<any> & AdditionalClientOptions, clickHouseSettings?: ClickHouseSettings) => Knex.Knex<any, unknown[]>;
-export {};
+export declare const getClickhouseConnection: (config?: Knex.Knex.Config<any> & AdditionalClientOptions, clickHouseSettings?: ClickHouseSettings, preQueryCallback?: (connection: ClickHouseClient) => Promise<void>) => Knex.Knex<any, unknown[]>;

package/dist/index.js

@@ -101,7 +101,6 @@ export class ClickhouseKnexClient extends Knex.Client {
     }
     /**
      *
-     * @param {import('@clickhouse/client').ClickHouseClient} connection
      * @param {import('@clickhouse/client').QueryParams} obj
      * @returns
      */
@@ -133,6 +132,10 @@ export class ClickhouseKnexClient extends Knex.Client {
             format: 'JSONCompact'
         };
         obj.finalQuery = query;
+        const { preQueryCallback } = this.config;
+        if (typeof preQueryCallback === 'function') {
+            await Promise.resolve(preQueryCallback(connection));
+        }
         switch (method) {
             case 'select':
             case 'first':
@@ -270,12 +273,25 @@ const registerKnexClickhouseExtensions = (knex) => {
  *
  * @returns {import('knex').Knex<any, unknown[]>}
  */
-export const getClickhouseConnection = (config = {}, clickHouseSettings) => {
+export const getClickhouseConnection = (config = {}, clickHouseSettings, 
+/**
+ * If defined, this function will be called before each query
+ * and awaited if it returns a promise.
+ *
+ * Could be useful in some cases. For example you want first to check
+ * if the server is not in idle state (for example Clickhouse Cloud have idling options)
+ * and if it is, you want to wake it up before sending the query.
+ *
+ * if the function throws an error this error will not be caught and will propagate to the caller.
+ * Therefore the query will not be executed.
+ */
+preQueryCallback) => {
     const connection = Knex({
         ...config,
         client: ClickhouseKnexClient,
         // @ts-ignore
-        clickHouseSettings
+        clickHouseSettings,
+        preQueryCallback
     });
     registerKnexClickhouseExtensions(connection);
     return connection;

package/package.json

@@ -5,9 +5,9 @@
         "email": "andrew_zol@cleverbrush.com"
     },
     "dependencies": {
-        "@cleverbrush/async": "^1.1.9",
-        "@cleverbrush/deep": "^1.1.9",
-        "@clickhouse/client": "^1.0.1"
+        "@cleverbrush/async": "^1.1.11",
+        "@cleverbrush/deep": "^1.1.11",
+        "@clickhouse/client": "^1.7.0"
     },
     "peerDependencies": {
         "knex": ">=3.1.0"
@@ -37,5 +37,5 @@
     },
     "type": "module",
     "types": "./dist/index.d.ts",
-    "version": "1.1.9"
+    "version": "1.1.11"
 }