@clickhouse/client-common - npm Package Compare versions

Comparing version 0.2.6 to 0.2.7

dist/clickhouse_types.d.ts

@@ -25,1 +25,14 @@ export interface ResponseJSON<T = unknown> {
 export type InputJSONObjectEachRow<T = unknown> = Record<string, T>;
+export interface ClickHouseSummary {
+    read_rows: string;
+    read_bytes: string;
+    written_rows: string;
+    written_bytes: string;
+    total_rows_to_read: string;
+    result_rows: string;
+    result_bytes: string;
+    elapsed_ns: string;
+}
+export interface WithClickHouseSummary {
+    summary?: ClickHouseSummary;
+}

dist/client.d.ts

@@ -1,2 +0,2 @@
-import type { ClickHouseLogLevel, ClickHouseSettings, Connection, ConnectionParams, ConnInsertResult, ConnQueryResult, Logger } from '@clickhouse/client-common';
+import type { ClickHouseLogLevel, ClickHouseSettings, Connection, ConnectionParams, ConnInsertResult, Logger, WithClickHouseSummary, ConnExecResult } from '@clickhouse/client-common';
 import { type DataFormat } from '@clickhouse/client-common';
@@ -48,3 +48,3 @@ import type { InputJSON, InputJSONObjectEachRow } from './clickhouse_types';
     password?: string;
-    /** The name of the application using the nodejs client.
+    /** The name of the application using the JS client.
      * Default: empty. */
@@ -89,7 +89,7 @@ application?: string;
 export type CommandParams = ExecParams;
-export interface CommandResult {
+export type CommandResult = {
     query_id: string;
-}
+} & WithClickHouseSummary;
 export type InsertResult = ConnInsertResult;
-export type ExecResult<Stream> = ConnQueryResult<Stream>;
+export type ExecResult<Stream> = ConnExecResult<Stream>;
 export type PingResult = ConnPingResult;
@@ -96,0 +96,0 @@ export type InsertValues<Stream, T = unknown> = ReadonlyArray<T> | Stream | InputJSON<T> | InputJSONObjectEachRow<T>;

dist/client.js

@@ -86,5 +86,5 @@ "use strict";
     async command(params) {
-        const { stream, query_id } = await this.exec(params);
+        const { stream, query_id, summary } = await this.exec(params);
         await this.closeStream(stream);
-        return { query_id };
+        return { query_id, summary };
     }
@@ -91,0 +91,0 @@ /**

dist/connection.d.ts

@@ -0,1 +1,2 @@
+import type { WithClickHouseSummary } from './clickhouse_types';
 import type { LogWriter } from './logger';
@@ -36,4 +37,4 @@ import type { ClickHouseSettings } from './settings';
 }
-export type ConnInsertResult = ConnBaseResult;
-export type ConnExecResult<Stream> = ConnQueryResult<Stream>;
+export type ConnInsertResult = ConnBaseResult & WithClickHouseSummary;
+export type ConnExecResult<Stream> = ConnQueryResult<Stream> & WithClickHouseSummary;
 export type ConnPingResult = {
@@ -40,0 +41,0 @@ success: true;

dist/index.d.ts

@@ -7,3 +7,3 @@ /** Should be re-exported by the implementation */
 export { ClickHouseLogLevel, type ErrorLogParams, type Logger, type LogParams, } from './logger';
-export type { ResponseJSON, InputJSON, InputJSONObjectEachRow, } from './clickhouse_types';
+export type { ClickHouseSummary, WithClickHouseSummary, ResponseJSON, InputJSON, InputJSONObjectEachRow, } from './clickhouse_types';
 export { type ClickHouseSettings, type MergeTreeSettings, SettingsMap, } from './settings';
@@ -10,0 +10,0 @@ /** For implementations usage only */

dist/version.d.ts

@@ -1,2 +0,2 @@
-declare const _default: "0.2.6";
+declare const _default: "0.2.7";
 export default _default;

dist/version.js

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

package.json

@@ -5,3 +5,3 @@ {
   "homepage": "https://clickhouse.com",
-  "version": "0.2.6",
+  "version": "0.2.7",
   "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

229498

increased by0.24%

Lines of code

3052

increased by0.46%

No dependency changes