@clickhouse/client-common - npm Package Compare versions

Comparing version 0.2.10 to 0.3.0-beta.1

dist/client.d.ts

@@ -33,3 +33,3 @@ import type { ClickHouseLogLevel, ClickHouseSettings, Connection, ConnectionParams, ConnExecResult, Logger, WithClickHouseSummary } from '@clickhouse/client-common';
     request_timeout?: number;
-    /** Maximum number of sockets to allow per host. Default value: `Infinity`. */
+    /** Maximum number of sockets to allow per host. Default value: `10`. */
     max_open_connections?: number;
@@ -36,0 +36,0 @@ compression?: {

dist/client.js

@@ -175,4 +175,4 @@ "use strict";
         url: createUrl(config.host ?? 'http://localhost:8123'),
-        request_timeout: config.request_timeout ?? 300000,
-        max_open_connections: config.max_open_connections ?? Infinity,
+        request_timeout: config.request_timeout ?? 30000,
+        max_open_connections: config.max_open_connections ?? 10,
         compression: {
@@ -186,5 +186,5 @@ decompress_response: config.compression?.response ?? true,
         clickhouse_settings: config.clickhouse_settings ?? {},
-        logWriter: new client_common_1.LogWriter(config?.log?.LoggerClass
+        log_writer: new client_common_1.LogWriter(config?.log?.LoggerClass
             ? new config.log.LoggerClass()
-            : new client_common_1.DefaultLogger(), config.log?.level),
+            : new client_common_1.DefaultLogger(), 'Connection', config.log?.level),
         additional_headers: config.additional_headers,
@@ -191,0 +191,0 @@ };

dist/connection.d.ts

@@ -16,3 +16,3 @@ import type { WithClickHouseSummary } from './clickhouse_types';
     clickhouse_settings: ClickHouseSettings;
-    logWriter: LogWriter;
+    log_writer: LogWriter;
     application_id?: string;
@@ -47,2 +47,3 @@ additional_headers?: Record<string, string>;
 };
+export type ConnOperation = 'Ping' | 'Query' | 'Insert' | 'Exec';
 export interface Connection<Stream> {
@@ -49,0 +50,0 @@ ping(): Promise<ConnPingResult>;

dist/index.d.ts

@@ -6,3 +6,3 @@ /** Should be re-exported by the implementation */
 export { ClickHouseError } from './error';
-export { ClickHouseLogLevel, type ErrorLogParams, type Logger, type LogParams, } from './logger';
+export { ClickHouseLogLevel, type ErrorLogParams, type WarnLogParams, type Logger, type LogParams, } from './logger';
 export type { ClickHouseSummary, WithClickHouseSummary, ResponseJSON, InputJSON, InputJSONObjectEachRow, } from './clickhouse_types';
@@ -14,5 +14,5 @@ export { type ClickHouseSettings, type MergeTreeSettings, SettingsMap, } from './settings';
 export { withCompressionHeaders, isSuccessfulResponse, toSearchParams, transformUrl, withHttpSettings, } from './utils';
-export { LogWriter, DefaultLogger } from './logger';
+export { LogWriter, DefaultLogger, type LogWriterParams } from './logger';
 export { parseError } from './error';
-export type { Connection, ConnectionParams, ConnInsertResult, ConnExecResult, ConnQueryResult, ConnBaseQueryParams, ConnBaseResult, ConnInsertParams, ConnPingResult, } from './connection';
+export type { Connection, ConnectionParams, ConnInsertResult, ConnExecResult, ConnQueryResult, ConnBaseQueryParams, ConnBaseResult, ConnInsertParams, ConnPingResult, ConnOperation, } from './connection';
 export { type RawDataFormat, type JSONDataFormat, formatQuerySettings, formatQueryParams, } from './data_formatter';

dist/logger.d.ts

@@ -9,2 +9,5 @@ export interface LogParams {
 };
+export type WarnLogParams = LogParams & {
+    err?: Error;
+};
 export interface Logger {
@@ -14,3 +17,3 @@ trace(params: LogParams): void;
     info(params: LogParams): void;
-    warn(params: LogParams): void;
+    warn(params: WarnLogParams): void;
     error(params: ErrorLogParams): void;
@@ -22,14 +25,18 @@ }
     info({ module, message, args }: LogParams): void;
-    warn({ module, message, args }: LogParams): void;
+    warn({ module, message, args, err }: WarnLogParams): void;
     error({ module, message, args, err }: ErrorLogParams): void;
 }
+export type LogWriterParams<Method extends keyof Logger> = Omit<Parameters<Logger[Method]>[0], 'module'> & {
+    module?: string;
+};
 export declare class LogWriter {
     private readonly logger;
+    private readonly module;
     private readonly logLevel;
-    constructor(logger: Logger, logLevel?: ClickHouseLogLevel);
-    trace(params: LogParams): void;
-    debug(params: LogParams): void;
-    info(params: LogParams): void;
-    warn(params: LogParams): void;
-    error(params: ErrorLogParams): void;
+    constructor(logger: Logger, module: string, logLevel?: ClickHouseLogLevel);
+    trace(params: LogWriterParams<'trace'>): void;
+    debug(params: LogWriterParams<'debug'>): void;
+    info(params: LogWriterParams<'info'>): void;
+    warn(params: LogWriterParams<'warn'>): void;
+    error(params: LogWriterParams<'error'>): void;
 }
@@ -36,0 +43,0 @@ export declare enum ClickHouseLogLevel {

dist/logger.js

@@ -6,15 +6,49 @@ "use strict";
     trace({ module, message, args }) {
-        console.trace(formatMessage({ module, message }), args);
+        const params = [
+            formatMessage({ module, message, level: 'TRACE' }),
+        ];
+        if (args) {
+            params.push('Arguments:', args);
+        }
+        console.debug(...params);
     }
     debug({ module, message, args }) {
-        console.debug(formatMessage({ module, message }), args);
+        const params = [
+            formatMessage({ module, message, level: 'DEBUG' }),
+        ];
+        if (args) {
+            params.push('Arguments:', args);
+        }
+        console.debug(...params);
     }
     info({ module, message, args }) {
-        console.info(formatMessage({ module, message }), args);
+        const params = [
+            formatMessage({ module, message, level: 'INFO' }),
+        ];
+        if (args) {
+            params.push('Arguments:', args);
+        }
+        console.info(...params);
     }
-    warn({ module, message, args }) {
-        console.warn(formatMessage({ module, message }), args);
+    warn({ module, message, args, err }) {
+        const params = [
+            formatMessage({ module, message, level: 'WARN' }),
+        ];
+        if (args) {
+            params.push('Arguments:', args);
+        }
+        if (err) {
+            params.push('Caused by:', err);
+        }
+        console.warn(...params);
     }
     error({ module, message, args, err }) {
-        console.error(formatMessage({ module, message }), args, err);
+        const params = [
+            formatMessage({ module, message, level: 'ERROR' }),
+        ];
+        if (args) {
+            params.push('Arguments:', args);
+        }
+        params.push('Caused by:', err);
+        console.error(...params);
     }
@@ -24,3 +58,3 @@ }
 class LogWriter {
-    constructor(logger, logLevel) {
+    constructor(logger, module, logLevel) {
         Object.defineProperty(this, "logger", {
@@ -32,2 +66,8 @@ enumerable: true,
         });
+        Object.defineProperty(this, "module", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: module
+        });
         Object.defineProperty(this, "logLevel", {
@@ -41,3 +81,2 @@ enumerable: true,
         this.info({
-            module: 'Logger',
             message: `Log level is set to ${ClickHouseLogLevel[this.logLevel]}`,
@@ -48,3 +87,6 @@ });
         if (this.logLevel <= ClickHouseLogLevel.TRACE) {
-            this.logger.trace(params);
+            this.logger.trace({
+                ...params,
+                module: params.module ?? this.module,
+            });
         }
@@ -54,3 +96,6 @@ }
         if (this.logLevel <= ClickHouseLogLevel.DEBUG) {
-            this.logger.debug(params);
+            this.logger.debug({
+                ...params,
+                module: params.module ?? this.module,
+            });
         }
@@ -60,3 +105,6 @@ }
         if (this.logLevel <= ClickHouseLogLevel.INFO) {
-            this.logger.info(params);
+            this.logger.info({
+                ...params,
+                module: params.module ?? this.module,
+            });
         }
@@ -66,3 +114,6 @@ }
         if (this.logLevel <= ClickHouseLogLevel.WARN) {
-            this.logger.warn(params);
+            this.logger.warn({
+                ...params,
+                module: params.module ?? this.module,
+            });
         }
@@ -72,3 +123,6 @@ }
         if (this.logLevel <= ClickHouseLogLevel.ERROR) {
-            this.logger.error(params);
+            this.logger.error({
+                ...params,
+                module: params.module ?? this.module,
+            });
         }
@@ -87,5 +141,6 @@ }
 })(ClickHouseLogLevel = exports.ClickHouseLogLevel || (exports.ClickHouseLogLevel = {}));
-function formatMessage({ module, message, }) {
-    return `[@clickhouse/client][${module}] ${message}`;
+function formatMessage({ level, module, message, }) {
+    const ts = new Date().toISOString();
+    return `[${ts}][${level}][@clickhouse/client][${module}] ${message}`;
 }
 //# sourceMappingURL=logger.js.map

dist/utils/index.d.ts

 export * from './connection';
 export * from './string';
 export * from './url';
+export * from './permutations';

dist/utils/index.js

@@ -20,2 +20,3 @@ "use strict";
 __exportStar(require("./url"), exports);
+__exportStar(require("./permutations"), exports);
 //# sourceMappingURL=index.js.map

dist/utils/url.d.ts

@@ -13,5 +13,5 @@ import type { ClickHouseSettings } from '../settings';
     session_id?: string;
-    query_id?: string;
+    query_id: string;
 };
-export declare function toSearchParams({ database, query, query_params, clickhouse_settings, session_id, query_id, }: ToSearchParamsOptions): URLSearchParams | undefined;
+export declare function toSearchParams({ database, query, query_params, clickhouse_settings, session_id, query_id, }: ToSearchParamsOptions): URLSearchParams;
 export {};

dist/utils/url.js

@@ -27,9 +27,4 @@ "use strict";
 function toSearchParams({ database, query, query_params, clickhouse_settings, session_id, query_id, }) {
-    if (clickhouse_settings === undefined &&
-        query_params === undefined &&
-        query === undefined &&
-        database === 'default') {
-        return;
-    }
     const params = new URLSearchParams();
+    params.set('query_id', query_id);
     if (query_params !== undefined) {
@@ -56,5 +51,2 @@ for (const [key, value] of Object.entries(query_params)) {
     }
-    if (query_id) {
-        params.set('query_id', query_id);
-    }
     return params;
@@ -61,0 +53,0 @@ }

dist/version.d.ts

@@ -1,2 +0,2 @@
-declare const _default: "0.2.10";
+declare const _default: "0.3.0-beta.1";
 export default _default;

dist/version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '0.2.10';
+exports.default = '0.3.0-beta.1';
 //# sourceMappingURL=version.js.map

package.json

@@ -5,3 +5,3 @@ {
   "homepage": "https://clickhouse.com",
-  "version": "0.2.10",
+  "version": "0.3.0-beta.1",
   "license": "Apache-2.0",
@@ -8,0 +8,0 @@ "keywords": [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

237153

increased by1.7%

Number of package files

60

increased by5.26%

Lines of code

3180

increased by2.22%

No dependency changes