@clickhouse/client-common 1.0.2 → 1.1.0
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 +1 -1
- package/dist/client.d.ts +13 -2
- package/dist/client.js +15 -7
- package/dist/client.js.map +1 -1
- package/dist/config.d.ts +1 -1
- package/dist/connection.d.ts +4 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
package/dist/client.d.ts
CHANGED
|
@@ -12,9 +12,19 @@ export interface BaseQueryParams {
|
|
|
12
12
|
/** AbortSignal instance to cancel a request in progress. */
|
|
13
13
|
abort_signal?: AbortSignal;
|
|
14
14
|
/** A specific `query_id` that will be sent with this request.
|
|
15
|
-
*
|
|
15
|
+
* If it is not set, a random identifier will be generated automatically by the client. */
|
|
16
16
|
query_id?: string;
|
|
17
|
+
/** A specific ClickHouse Session id for this query.
|
|
18
|
+
* If it is not set, {@link BaseClickHouseClientConfigOptions.session_id} will be used.
|
|
19
|
+
* @default undefined (no override) */
|
|
17
20
|
session_id?: string;
|
|
21
|
+
/** When defined, overrides the credentials from the {@link BaseClickHouseClientConfigOptions.username}
|
|
22
|
+
* and {@link BaseClickHouseClientConfigOptions.password} settings for this particular request.
|
|
23
|
+
* @default undefined (no override) */
|
|
24
|
+
auth?: {
|
|
25
|
+
username: string;
|
|
26
|
+
password: string;
|
|
27
|
+
};
|
|
18
28
|
}
|
|
19
29
|
export interface QueryParams extends BaseQueryParams {
|
|
20
30
|
/** Statement to execute. */
|
|
@@ -43,7 +53,7 @@ export type InsertResult = {
|
|
|
43
53
|
* Indicates whether the INSERT statement was executed on the server.
|
|
44
54
|
* Will be `false` if there was no data to insert.
|
|
45
55
|
* For example: if {@link InsertParams.values} was an empty array,
|
|
46
|
-
* the client does not any requests to the server, and {@link executed} is false.
|
|
56
|
+
* the client does not send any requests to the server, and {@link executed} is false.
|
|
47
57
|
*/
|
|
48
58
|
executed: boolean;
|
|
49
59
|
/**
|
|
@@ -83,6 +93,7 @@ export interface InsertParams<Stream = unknown, T = unknown> extends BaseQueryPa
|
|
|
83
93
|
}
|
|
84
94
|
export declare class ClickHouseClient<Stream = unknown> {
|
|
85
95
|
private readonly clientClickHouseSettings;
|
|
96
|
+
private readonly connectionParams;
|
|
86
97
|
private readonly connection;
|
|
87
98
|
private readonly makeResultSet;
|
|
88
99
|
private readonly valuesEncoder;
|
package/dist/client.js
CHANGED
|
@@ -11,6 +11,12 @@ class ClickHouseClient {
|
|
|
11
11
|
writable: true,
|
|
12
12
|
value: void 0
|
|
13
13
|
});
|
|
14
|
+
Object.defineProperty(this, "connectionParams", {
|
|
15
|
+
enumerable: true,
|
|
16
|
+
configurable: true,
|
|
17
|
+
writable: true,
|
|
18
|
+
value: void 0
|
|
19
|
+
});
|
|
14
20
|
Object.defineProperty(this, "connection", {
|
|
15
21
|
enumerable: true,
|
|
16
22
|
configurable: true,
|
|
@@ -45,11 +51,11 @@ class ClickHouseClient {
|
|
|
45
51
|
? new config.log.LoggerClass()
|
|
46
52
|
: new client_common_1.DefaultLogger();
|
|
47
53
|
const configWithURL = (0, config_1.prepareConfigWithURL)(config, logger, config.impl.handle_specific_url_params ?? null);
|
|
48
|
-
|
|
49
|
-
this.logWriter = connectionParams.log_writer;
|
|
50
|
-
this.clientClickHouseSettings = connectionParams.clickhouse_settings;
|
|
54
|
+
this.connectionParams = (0, config_1.getConnectionParams)(configWithURL, logger);
|
|
55
|
+
this.logWriter = this.connectionParams.log_writer;
|
|
56
|
+
this.clientClickHouseSettings = this.connectionParams.clickhouse_settings;
|
|
51
57
|
this.sessionId = config.session_id;
|
|
52
|
-
this.connection = config.impl.make_connection(configWithURL, connectionParams);
|
|
58
|
+
this.connection = config.impl.make_connection(configWithURL, this.connectionParams);
|
|
53
59
|
this.makeResultSet = config.impl.make_result_set;
|
|
54
60
|
this.valuesEncoder = config.impl.values_encoder;
|
|
55
61
|
}
|
|
@@ -63,9 +69,10 @@ class ClickHouseClient {
|
|
|
63
69
|
async query(params) {
|
|
64
70
|
const format = params.format ?? 'JSON';
|
|
65
71
|
const query = formatQuery(params.query, format);
|
|
72
|
+
const queryParams = this.withClientQueryParams(params);
|
|
66
73
|
const { stream, query_id } = await this.connection.query({
|
|
67
74
|
query,
|
|
68
|
-
...
|
|
75
|
+
...queryParams,
|
|
69
76
|
});
|
|
70
77
|
return this.makeResultSet(stream, format, query_id, (err) => {
|
|
71
78
|
this.logWriter.error({
|
|
@@ -73,7 +80,7 @@ class ClickHouseClient {
|
|
|
73
80
|
module: 'Client',
|
|
74
81
|
message: 'Error while processing the ResultSet.',
|
|
75
82
|
args: {
|
|
76
|
-
session_id:
|
|
83
|
+
session_id: queryParams.session_id,
|
|
77
84
|
query,
|
|
78
85
|
query_id,
|
|
79
86
|
},
|
|
@@ -151,7 +158,8 @@ class ClickHouseClient {
|
|
|
151
158
|
query_params: params.query_params,
|
|
152
159
|
abort_signal: params.abort_signal,
|
|
153
160
|
query_id: params.query_id,
|
|
154
|
-
session_id: this.sessionId,
|
|
161
|
+
session_id: params.session_id ?? this.sessionId,
|
|
162
|
+
auth: params.auth,
|
|
155
163
|
};
|
|
156
164
|
}
|
|
157
165
|
}
|
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":";;;AAWA,6DAA0E;AAG1E,qCAAoE;AA8GpE,MAAa,gBAAgB;IAS3B,YACE,MAAyE;QAT1D;;;;;WAA4C;QAC5C;;;;;WAAkC;QAClC;;;;;WAA8B;QAC9B;;;;;WAAoC;QACpC;;;;;WAAoC;QACpC;;;;;WAAkB;QAClB;;;;;WAAoB;QAKnC,MAAM,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,WAAW;YACrC,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE;YAC9B,CAAC,CAAC,IAAI,6BAAa,EAAE,CAAA;QACvB,MAAM,aAAa,GAAG,IAAA,6BAAoB,EACxC,MAAM,EACN,MAAM,EACN,MAAM,CAAC,IAAI,CAAC,0BAA0B,IAAI,IAAI,CAC/C,CAAA;QACD,IAAI,CAAC,gBAAgB,GAAG,IAAA,4BAAmB,EAAC,aAAa,EAAE,MAAM,CAAC,CAAA;QAClE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAA;QACjD,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,CAAA;QACzE,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,UAAU,CAAA;QAClC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAC3C,aAAa,EACb,IAAI,CAAC,gBAAgB,CACtB,CAAA;QACD,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAA;QAChD,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAA;IACjD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CACT,MAAqC;QAErC,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,WAAW,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAA;QACtD,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;YACvD,KAAK;YACL,GAAG,WAAW;SACf,CAAC,CAAA;QACF,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE;YAC1D,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;gBACnB,GAAG;gBACH,MAAM,EAAE,QAAQ;gBAChB,OAAO,EAAE,uCAAuC;gBAChD,IAAI,EAAE;oBACJ,UAAU,EAAE,WAAW,CAAC,UAAU;oBAClC,KAAK;oBACL,QAAQ;iBACT;aACF,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAC,MAAqB;QACjC,MAAM,KAAK,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;QACrD,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;YACnC,KAAK;YACL,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC;SACtC,CAAC,CAAA;IACJ,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,qBAAqB,CAAC,MAAM,CAAC;SACtC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAI,MAA+B;QAC7C,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/D,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;QAC1C,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,oBAAoB,CAAA;QACpD,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAE9D,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YAC1C,KAAK;YACL,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;YAC9D,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC;SACtC,CAAC,CAAA;QACF,OAAO,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAA;IACtC,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;IAEO,qBAAqB,CAAC,MAAuB;QACnD,OAAO;YACL,mBAAmB,EAAE;gBACnB,GAAG,IAAI,CAAC,wBAAwB;gBAChC,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,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,SAAS;YAC/C,IAAI,EAAE,MAAM,CAAC,IAAI;SAClB,CAAA;IACH,CAAC;CACF;AAjJD,4CAiJC;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,CAAC;QACxC,IAAI,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YACzB,cAAc,GAAG,CAAC,CAAA;YAClB,MAAK;QACP,CAAC;IACH,CAAC;IACD,IAAI,cAAc,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;IACvC,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAY;IACzC,OAAO,CACL,GAAG,KAAK,SAAS;QACjB,GAAG,KAAK,IAAI;QACZ,OAAO,GAAG,KAAK,QAAQ;QACvB,8CAA8C;QAC9C,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CACpD,CAAA;AACH,CAAC;AAED,SAAS,cAAc,CACrB,MAAuB,EACvB,MAAkB;IAElB,IAAI,WAAW,GAAG,EAAE,CAAA;IACpB,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACjC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/D,WAAW,GAAG,KAAK,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAA;QACjD,CAAC;aAAM,IACL,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC;YACrC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAChC,CAAC;YACD,WAAW,GAAG,eAAe,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAA;QACnE,CAAC;IACH,CAAC;IACD,OAAO,eAAe,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,WAAW,WAAW,MAAM,EAAE,CAAA;AAC5E,CAAC"}
|
package/dist/config.d.ts
CHANGED
|
@@ -60,7 +60,7 @@ export interface BaseClickHouseClientConfigOptions {
|
|
|
60
60
|
level?: ClickHouseLogLevel;
|
|
61
61
|
};
|
|
62
62
|
/** ClickHouse Session id to attach to the outgoing requests.
|
|
63
|
-
* @default empty string */
|
|
63
|
+
* @default empty string (no session) */
|
|
64
64
|
session_id?: string;
|
|
65
65
|
/** @deprecated since version 1.0.0. Use {@link http_headers} instead. <br/>
|
|
66
66
|
* Additional HTTP headers to attach to the outgoing requests.
|
package/dist/connection.d.ts
CHANGED
|
@@ -28,6 +28,10 @@ export interface ConnBaseQueryParams {
|
|
|
28
28
|
abort_signal?: AbortSignal;
|
|
29
29
|
session_id?: string;
|
|
30
30
|
query_id?: string;
|
|
31
|
+
auth?: {
|
|
32
|
+
username: string;
|
|
33
|
+
password: string;
|
|
34
|
+
};
|
|
31
35
|
}
|
|
32
36
|
export interface ConnInsertParams<Stream> extends ConnBaseQueryParams {
|
|
33
37
|
values: string | Stream;
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const _default: "1.0
|
|
1
|
+
declare const _default: "1.1.0";
|
|
2
2
|
export default _default;
|
package/dist/version.js
CHANGED
package/package.json
CHANGED