@clickhouse/client-common 0.2.6 → 0.2.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/clickhouse_types.d.ts +13 -0
- package/dist/client.d.ts +5 -5
- package/dist/client.js +2 -2
- package/dist/client.js.map +1 -1
- package/dist/connection.d.ts +3 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
|
@@ -22,3 +22,16 @@ export interface InputJSON<T = unknown> {
|
|
|
22
22
|
data: T[];
|
|
23
23
|
}
|
|
24
24
|
export type InputJSONObjectEachRow<T = unknown> = Record<string, T>;
|
|
25
|
+
export interface ClickHouseSummary {
|
|
26
|
+
read_rows: string;
|
|
27
|
+
read_bytes: string;
|
|
28
|
+
written_rows: string;
|
|
29
|
+
written_bytes: string;
|
|
30
|
+
total_rows_to_read: string;
|
|
31
|
+
result_rows: string;
|
|
32
|
+
result_bytes: string;
|
|
33
|
+
elapsed_ns: string;
|
|
34
|
+
}
|
|
35
|
+
export interface WithClickHouseSummary {
|
|
36
|
+
summary?: ClickHouseSummary;
|
|
37
|
+
}
|
package/dist/client.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ClickHouseLogLevel, ClickHouseSettings, Connection, ConnectionParams, ConnInsertResult,
|
|
1
|
+
import type { ClickHouseLogLevel, ClickHouseSettings, Connection, ConnectionParams, ConnInsertResult, Logger, WithClickHouseSummary, ConnExecResult } from '@clickhouse/client-common';
|
|
2
2
|
import { type DataFormat } from '@clickhouse/client-common';
|
|
3
3
|
import type { InputJSON, InputJSONObjectEachRow } from './clickhouse_types';
|
|
4
4
|
import type { ConnPingResult } from './connection';
|
|
@@ -45,7 +45,7 @@ export interface ClickHouseClientConfigOptions<Stream> {
|
|
|
45
45
|
username?: string;
|
|
46
46
|
/** The user password. Default: ''. */
|
|
47
47
|
password?: string;
|
|
48
|
-
/** The name of the application using the
|
|
48
|
+
/** The name of the application using the JS client.
|
|
49
49
|
* Default: empty. */
|
|
50
50
|
application?: string;
|
|
51
51
|
/** Database name to use. Default value: `default`. */
|
|
@@ -85,11 +85,11 @@ export interface ExecParams extends BaseQueryParams {
|
|
|
85
85
|
query: string;
|
|
86
86
|
}
|
|
87
87
|
export type CommandParams = ExecParams;
|
|
88
|
-
export
|
|
88
|
+
export type CommandResult = {
|
|
89
89
|
query_id: string;
|
|
90
|
-
}
|
|
90
|
+
} & WithClickHouseSummary;
|
|
91
91
|
export type InsertResult = ConnInsertResult;
|
|
92
|
-
export type ExecResult<Stream> =
|
|
92
|
+
export type ExecResult<Stream> = ConnExecResult<Stream>;
|
|
93
93
|
export type PingResult = ConnPingResult;
|
|
94
94
|
export type InsertValues<Stream, T = unknown> = ReadonlyArray<T> | Stream | InputJSON<T> | InputJSONObjectEachRow<T>;
|
|
95
95
|
export interface InsertParams<Stream = unknown, T = unknown> extends BaseQueryParams {
|
package/dist/client.js
CHANGED
|
@@ -83,9 +83,9 @@ class ClickHouseClient {
|
|
|
83
83
|
* If you are interested in the response data, consider using {@link ClickHouseClient.exec}
|
|
84
84
|
*/
|
|
85
85
|
async command(params) {
|
|
86
|
-
const { stream, query_id } = await this.exec(params);
|
|
86
|
+
const { stream, query_id, summary } = await this.exec(params);
|
|
87
87
|
await this.closeStream(stream);
|
|
88
|
-
return { query_id };
|
|
88
|
+
return { query_id, summary };
|
|
89
89
|
}
|
|
90
90
|
/**
|
|
91
91
|
* Similar to {@link ClickHouseClient.command}, but for the cases where the output is expected,
|
package/dist/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../packages/client-common/src/client.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../packages/client-common/src/client.ts"],"names":[],"mappings":";;;AAUA,6DAIkC;AAuIlC,MAAa,gBAAgB;IAQ3B,YAAY,MAA6C;QAPzD;;;;;WAAmD;QACnD;;;;;WAA+C;QAC/C;;;;;WAAqD;QACrD;;;;;WAAqD;QACrD;;;;;WAAiD;QACjD;;;;;WAAmC;QAGjC,IAAI,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAA;QACnD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,UAAU,CAAA;QAClC,wBAAwB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAC/C,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACpE,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAA;QAChD,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAA;QAC/C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAA;IAC7C,CAAC;IAEO,cAAc,CAAC,MAAuB;QAC5C,OAAO;YACL,mBAAmB,EAAE;gBACnB,GAAG,IAAI,CAAC,gBAAgB,CAAC,mBAAmB;gBAC5C,GAAG,MAAM,CAAC,mBAAmB;aAC9B;YACD,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,UAAU,EAAE,IAAI,CAAC,SAAS;SAC3B,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,MAAmB;QAC7B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAA;QACtC,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAC/C,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;YACvD,KAAK;YACL,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;SAC/B,CAAC,CAAA;QACF,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAA;IACrD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAC,MAAqB;QACjC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC7D,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAC9B,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;IAC9B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,MAAkB;QAC3B,MAAM,KAAK,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;QACrD,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YAChC,KAAK;YACL,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;SAC/B,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAI,MAA+B;QAC7C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,oBAAoB,CAAA;QAEpD,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC9D,MAAM,KAAK,GAAG,eAAe,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,MAAM,EAAE,CAAA;QAEnE,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YAClC,KAAK;YACL,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;YAC9D,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;SAC/B,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAA;IACrC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK;QACT,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAA;IACtC,CAAC;CACF;AA7GD,4CA6GC;AAED,SAAS,WAAW,CAAC,KAAa,EAAE,MAAkB;IACpD,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;IACpB,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAA;IACjC,OAAO,KAAK,GAAG,YAAY,GAAG,MAAM,CAAA;AACtC,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAa;IACvC,IAAI,cAAc,GAAG,KAAK,CAAC,MAAM,CAAA;IACjC,KAAK,IAAI,CAAC,GAAG,cAAc,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QACvC,IAAI,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;YACxB,cAAc,GAAG,CAAC,CAAA;YAClB,MAAK;SACN;KACF;IACD,IAAI,cAAc,KAAK,KAAK,CAAC,MAAM,EAAE;QACnC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;KACtC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,wBAAwB,CAAC,EAAE,GAAG,EAAoB;IACzD,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,EAAE;QACzD,MAAM,IAAI,KAAK,CACb,mDAAmD,GAAG,CAAC,QAAQ,GAAG,CACnE,CAAA;KACF;AACH,CAAC;AAED,SAAS,SAAS,CAAC,IAAY;IAC7B,IAAI;QACF,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,CAAA;KACrB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAA;KAC1E;AACH,CAAC;AAED,SAAS,mBAAmB,CAC1B,MAA6C;IAE7C,OAAO;QACL,cAAc,EAAE,MAAM,CAAC,WAAW;QAClC,GAAG,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,IAAI,uBAAuB,CAAC;QACtD,eAAe,EAAE,MAAM,CAAC,eAAe,IAAI,MAAO;QAClD,oBAAoB,EAAE,MAAM,CAAC,oBAAoB,IAAI,QAAQ;QAC7D,WAAW,EAAE;YACX,mBAAmB,EAAE,MAAM,CAAC,WAAW,EAAE,QAAQ,IAAI,IAAI;YACzD,gBAAgB,EAAE,MAAM,CAAC,WAAW,EAAE,OAAO,IAAI,KAAK;SACvD;QACD,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,SAAS;QACtC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,EAAE;QAC/B,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,SAAS;QACtC,mBAAmB,EAAE,MAAM,CAAC,mBAAmB,IAAI,EAAE;QACrD,SAAS,EAAE,IAAI,yBAAS,CACtB,MAAM,EAAE,GAAG,EAAE,WAAW;YACtB,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE;YAC9B,CAAC,CAAC,IAAI,6BAAa,EAAE,EACvB,MAAM,CAAC,GAAG,EAAE,KAAK,CAClB;KACF,CAAA;AACH,CAAC"}
|
package/dist/connection.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { WithClickHouseSummary } from './clickhouse_types';
|
|
1
2
|
import type { LogWriter } from './logger';
|
|
2
3
|
import type { ClickHouseSettings } from './settings';
|
|
3
4
|
export interface ConnectionParams {
|
|
@@ -33,8 +34,8 @@ export interface ConnQueryResult<Stream> extends ConnBaseResult {
|
|
|
33
34
|
stream: Stream;
|
|
34
35
|
query_id: string;
|
|
35
36
|
}
|
|
36
|
-
export type ConnInsertResult = ConnBaseResult;
|
|
37
|
-
export type ConnExecResult<Stream> = ConnQueryResult<Stream
|
|
37
|
+
export type ConnInsertResult = ConnBaseResult & WithClickHouseSummary;
|
|
38
|
+
export type ConnExecResult<Stream> = ConnQueryResult<Stream> & WithClickHouseSummary;
|
|
38
39
|
export type ConnPingResult = {
|
|
39
40
|
success: true;
|
|
40
41
|
} | {
|
package/dist/index.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ export type { Row, BaseResultSet } from './result';
|
|
|
4
4
|
export { type DataFormat } from './data_formatter';
|
|
5
5
|
export { ClickHouseError } from './error';
|
|
6
6
|
export { ClickHouseLogLevel, type ErrorLogParams, type Logger, type LogParams, } from './logger';
|
|
7
|
-
export type { ResponseJSON, InputJSON, InputJSONObjectEachRow, } from './clickhouse_types';
|
|
7
|
+
export type { ClickHouseSummary, WithClickHouseSummary, ResponseJSON, InputJSON, InputJSONObjectEachRow, } from './clickhouse_types';
|
|
8
8
|
export { type ClickHouseSettings, type MergeTreeSettings, SettingsMap, } from './settings';
|
|
9
9
|
/** For implementations usage only */
|
|
10
10
|
export { encodeJSON, isSupportedRawFormat, decode, validateStreamFormat, } from './data_formatter';
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/client-common/src/index.ts"],"names":[],"mappings":";;;AAAA,kDAAkD;AAClD,mCAciB;AANf,0GAAA,gBAAgB,OAAA;AASlB,iCAAyC;AAAhC,wGAAA,eAAe,OAAA;AACxB,mCAKiB;AAJf,4GAAA,kBAAkB,OAAA;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/client-common/src/index.ts"],"names":[],"mappings":";;;AAAA,kDAAkD;AAClD,mCAciB;AANf,0GAAA,gBAAgB,OAAA;AASlB,iCAAyC;AAAhC,wGAAA,eAAe,OAAA;AACxB,mCAKiB;AAJf,4GAAA,kBAAkB,OAAA;AAYpB,uCAImB;AADjB,uGAAA,WAAW,OAAA;AAGb,qCAAqC;AACrC,mDAKyB;AAJvB,4GAAA,UAAU,OAAA;AACV,sHAAA,oBAAoB,OAAA;AACpB,wGAAA,MAAM,OAAA;AACN,sHAAA,oBAAoB,OAAA;AAOtB,iCAMgB;AALd,+GAAA,sBAAsB,OAAA;AACtB,6GAAA,oBAAoB,OAAA;AACpB,uGAAA,cAAc,OAAA;AACd,qGAAA,YAAY,OAAA;AACZ,yGAAA,gBAAgB,OAAA;AAElB,mCAAmD;AAA1C,mGAAA,SAAS,OAAA;AAAE,uGAAA,aAAa,OAAA;AACjC,iCAAoC;AAA3B,mGAAA,UAAU,OAAA;AAYnB,mDAKyB;AAFvB,qHAAA,mBAAmB,OAAA;AACnB,mHAAA,iBAAiB,OAAA"}
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const _default: "0.2.
|
|
1
|
+
declare const _default: "0.2.7";
|
|
2
2
|
export default _default;
|
package/dist/version.js
CHANGED
package/package.json
CHANGED