@clickhouse/client-web 0.3.1 → 1.0.1
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/LICENSE +2 -2
- package/README.md +12 -0
- package/dist/client.d.ts +17 -9
- package/dist/client.js +9 -13
- package/dist/client.js.map +1 -1
- package/dist/config.d.ts +3 -0
- package/dist/config.js +13 -0
- package/dist/config.js.map +1 -0
- package/dist/connection/web_connection.d.ts +1 -5
- package/dist/connection/web_connection.js +1 -1
- package/dist/connection/web_connection.js.map +1 -1
- package/dist/index.d.ts +3 -1
- package/dist/index.js +1 -2
- package/dist/index.js.map +1 -1
- package/dist/result_set.d.ts +8 -5
- package/dist/result_set.js +31 -5
- package/dist/result_set.js.map +1 -1
- package/dist/utils/encoder.js.map +1 -1
- package/dist/utils/stream.js.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +2 -2
package/LICENSE
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
Copyright 2016-
|
|
1
|
+
Copyright 2016-2024 ClickHouse, Inc.
|
|
2
2
|
|
|
3
3
|
Apache License
|
|
4
4
|
Version 2.0, January 2004
|
|
@@ -188,7 +188,7 @@ Copyright 2016-2023 ClickHouse, Inc.
|
|
|
188
188
|
same "printed page" as the copyright notice for easier
|
|
189
189
|
identification within third-party archives.
|
|
190
190
|
|
|
191
|
-
Copyright 2016-
|
|
191
|
+
Copyright 2016-2024 ClickHouse, Inc.
|
|
192
192
|
|
|
193
193
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
194
194
|
you may not use this file except in compliance with the License.
|
package/README.md
CHANGED
|
@@ -4,9 +4,21 @@
|
|
|
4
4
|
</p>
|
|
5
5
|
<br/>
|
|
6
6
|
<p align="center">
|
|
7
|
+
<a href="https://www.npmjs.com/package/@clickhouse/client">
|
|
8
|
+
<img alt="NPM Version" src="https://img.shields.io/npm/v/%40clickhouse%2Fclient?color=%233178C6&logo=npm">
|
|
9
|
+
</a>
|
|
10
|
+
|
|
11
|
+
<a href="https://www.npmjs.com/package/@clickhouse/client">
|
|
12
|
+
<img alt="NPM Downloads" src="https://img.shields.io/npm/dw/%40clickhouse%2Fclient?color=%233178C6&logo=npm">
|
|
13
|
+
</a>
|
|
14
|
+
|
|
7
15
|
<a href="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests.yml">
|
|
8
16
|
<img src="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests.yml/badge.svg?branch=main">
|
|
9
17
|
</a>
|
|
18
|
+
|
|
19
|
+
<img src="https://sonarcloud.io/api/project_badges/measure?project=ClickHouse_clickhouse-js&metric=alert_status">
|
|
20
|
+
|
|
21
|
+
<img src="https://sonarcloud.io/api/project_badges/measure?project=ClickHouse_clickhouse-js&metric=coverage">
|
|
10
22
|
</p>
|
|
11
23
|
|
|
12
24
|
## About
|
package/dist/client.d.ts
CHANGED
|
@@ -1,15 +1,23 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { DataFormat, InputJSON, InputJSONObjectEachRow, InsertParams, InsertResult, IsSame, QueryParamsWithFormat } from '@clickhouse/client-common';
|
|
2
2
|
import { ClickHouseClient } from '@clickhouse/client-common';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
export type WebClickHouseClient = Omit<
|
|
3
|
+
import type { WebClickHouseClientConfigOptions } from './config';
|
|
4
|
+
import type { ResultSet } from './result_set';
|
|
5
|
+
/** If the Format is not a literal type, fall back to the default behavior of the ResultSet,
|
|
6
|
+
* allowing to call all methods with all data shapes variants,
|
|
7
|
+
* and avoiding generated types that include all possible DataFormat literal values. */
|
|
8
|
+
export type QueryResult<Format extends DataFormat> = IsSame<Format, DataFormat> extends true ? ResultSet<unknown> : ResultSet<Format>;
|
|
9
|
+
export type WebClickHouseClient = Omit<WebClickHouseClientImpl, 'insert'> & {
|
|
10
|
+
/** See {@link ClickHouseClient.insert}.
|
|
11
|
+
*
|
|
12
|
+
* ReadableStream is removed from possible insert values
|
|
13
|
+
* until it is supported by all major web platforms. */
|
|
10
14
|
insert<T>(params: Omit<InsertParams<ReadableStream, T>, 'values'> & {
|
|
11
15
|
values: ReadonlyArray<T> | InputJSON<T> | InputJSONObjectEachRow<T>;
|
|
12
16
|
}): Promise<InsertResult>;
|
|
13
|
-
query(params: QueryParams): Promise<BaseResultSet<ReadableStream<Row[]>>>;
|
|
14
17
|
};
|
|
18
|
+
declare class WebClickHouseClientImpl extends ClickHouseClient<ReadableStream> {
|
|
19
|
+
/** See {@link ClickHouseClient.query}. */
|
|
20
|
+
query<Format extends DataFormat>(params: QueryParamsWithFormat<Format>): Promise<QueryResult<Format>>;
|
|
21
|
+
}
|
|
15
22
|
export declare function createClient(config?: WebClickHouseClientConfigOptions): WebClickHouseClient;
|
|
23
|
+
export {};
|
package/dist/client.js
CHANGED
|
@@ -2,20 +2,16 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.createClient = void 0;
|
|
4
4
|
const client_common_1 = require("@clickhouse/client-common");
|
|
5
|
-
const
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
const config_1 = require("./config");
|
|
6
|
+
class WebClickHouseClientImpl extends client_common_1.ClickHouseClient {
|
|
7
|
+
/** See {@link ClickHouseClient.query}. */
|
|
8
|
+
query(params) {
|
|
9
|
+
return super.query(params);
|
|
10
|
+
}
|
|
11
|
+
}
|
|
8
12
|
function createClient(config) {
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
};
|
|
12
|
-
return new client_common_1.ClickHouseClient({
|
|
13
|
-
impl: {
|
|
14
|
-
make_connection: (params) => new connection_1.WebConnection({ ...params, keep_alive }),
|
|
15
|
-
make_result_set: (stream, format, query_id) => new result_set_1.ResultSet(stream, format, query_id),
|
|
16
|
-
values_encoder: new utils_1.WebValuesEncoder(),
|
|
17
|
-
close_stream: (stream) => stream.cancel(),
|
|
18
|
-
},
|
|
13
|
+
return new WebClickHouseClientImpl({
|
|
14
|
+
impl: config_1.WebImpl,
|
|
19
15
|
...(config || {}),
|
|
20
16
|
});
|
|
21
17
|
}
|
package/dist/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../packages/client-web/src/client.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../packages/client-web/src/client.ts"],"names":[],"mappings":";;;AASA,6DAA4D;AAE5D,qCAAkC;AAuBlC,MAAM,uBAAwB,SAAQ,gCAAgC;IACpE,0CAA0C;IAC1C,KAAK,CACH,MAAqC;QAErC,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,CAA+B,CAAA;IAC1D,CAAC;CACF;AAED,SAAgB,YAAY,CAC1B,MAAyC;IAEzC,OAAO,IAAI,uBAAuB,CAAC;QACjC,IAAI,EAAE,gBAAO;QACb,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;KAClB,CAAC,CAAA;AACJ,CAAC;AAPD,oCAOC"}
|
package/dist/config.d.ts
ADDED
package/dist/config.js
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.WebImpl = void 0;
|
|
4
|
+
const connection_1 = require("./connection");
|
|
5
|
+
const result_set_1 = require("./result_set");
|
|
6
|
+
const utils_1 = require("./utils");
|
|
7
|
+
exports.WebImpl = {
|
|
8
|
+
make_connection: (_, params) => new connection_1.WebConnection(params),
|
|
9
|
+
make_result_set: ((stream, format, query_id) => new result_set_1.ResultSet(stream, format, query_id)),
|
|
10
|
+
values_encoder: new utils_1.WebValuesEncoder(),
|
|
11
|
+
close_stream: (stream) => stream.cancel(),
|
|
12
|
+
};
|
|
13
|
+
//# sourceMappingURL=config.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../packages/client-web/src/config.ts"],"names":[],"mappings":";;;AAMA,6CAA4C;AAC5C,6CAAwC;AACxC,mCAA0C;AAI7B,QAAA,OAAO,GAAkD;IACpE,eAAe,EAAE,CAAC,CAAC,EAAE,MAAwB,EAAE,EAAE,CAAC,IAAI,0BAAa,CAAC,MAAM,CAAC;IAC3E,eAAe,EAAE,CAAC,CAChB,MAAsB,EACtB,MAAkB,EAClB,QAAgB,EAChB,EAAE,CAAC,IAAI,sBAAS,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAQ;IACpD,cAAc,EAAE,IAAI,wBAAgB,EAAE;IACtC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE;CAC1C,CAAA"}
|
|
@@ -2,11 +2,7 @@ import type { ConnBaseQueryParams, Connection, ConnectionParams, ConnInsertParam
|
|
|
2
2
|
type WebInsertParams<T> = Omit<ConnInsertParams<ReadableStream<T>>, 'values'> & {
|
|
3
3
|
values: string;
|
|
4
4
|
};
|
|
5
|
-
export type WebConnectionParams = ConnectionParams
|
|
6
|
-
keep_alive: {
|
|
7
|
-
enabled: boolean;
|
|
8
|
-
};
|
|
9
|
-
};
|
|
5
|
+
export type WebConnectionParams = ConnectionParams;
|
|
10
6
|
export declare class WebConnection implements Connection<ReadableStream> {
|
|
11
7
|
private readonly params;
|
|
12
8
|
private readonly defaultHeaders;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"web_connection.js","sourceRoot":"","sources":["../../../../packages/client-web/src/connection/web_connection.ts"],"names":[],"mappings":";;;AASA,6DAOkC;AAClC,oCAAoC;
|
|
1
|
+
{"version":3,"file":"web_connection.js","sourceRoot":"","sources":["../../../../packages/client-web/src/connection/web_connection.ts"],"names":[],"mappings":";;;AASA,6DAOkC;AAClC,oCAAoC;AAWpC,MAAa,aAAa;IAExB,YAA6B,MAA2B;QAA5C;;;;mBAAiB,MAAM;WAAqB;QADvC;;;;;WAAsC;QAErD,IAAI,CAAC,cAAc,GAAG;YACpB,aAAa,EAAE,SAAS,IAAI,CAAC,GAAG,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE;YACvE,GAAG,MAAM,EAAE,YAAY;SACxB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CACT,MAA2B;QAE3B,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC5C,MAAM,mBAAmB,GAAG,IAAA,gCAAgB,EAC1C,MAAM,CAAC,mBAAmB,EAC1B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAC5C,CAAA;QACD,MAAM,YAAY,GAAG,IAAA,8BAAc,EAAC;YAClC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;YAC9B,mBAAmB;YACnB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,QAAQ;SACT,CAAC,CAAA;QACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAClC,MAAM,EAAE,MAAM,CAAC,KAAK;YACpB,MAAM;YACN,YAAY;SACb,CAAC,CAAA;QACF,OAAO;YACL,QAAQ;YACR,MAAM,EAAE,QAAQ,CAAC,IAAI,IAAI,IAAI,cAAc,EAAc;SAC1D,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,MAA2B;QAE3B,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC5C,MAAM,YAAY,GAAG,IAAA,8BAAc,EAAC;YAClC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;YAC9B,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;YAC/C,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,QAAQ;SACT,CAAC,CAAA;QACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAClC,MAAM,EAAE,MAAM,CAAC,KAAK;YACpB,MAAM;YACN,YAAY;SACb,CAAC,CAAA;QACF,OAAO;YACL,MAAM,EAAE,QAAQ,CAAC,IAAI,IAAI,IAAI,cAAc,EAAc;YACzD,QAAQ;SACT,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,MAA0B;QAE1B,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC5C,MAAM,YAAY,GAAG,IAAA,8BAAc,EAAC;YAClC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;YAC9B,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;YAC/C,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,QAAQ;SACT,CAAC,CAAA;QACF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAC7B,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,MAAM;YACN,YAAY;SACb,CAAC,CAAA;QACF,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACtB,MAAM,GAAG,CAAC,IAAI,EAAE,CAAA,CAAC,yCAAyC;QAC5D,CAAC;QACD,OAAO;YACL,QAAQ;SACT,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI;QACR,mDAAmD;QACnD,kDAAkD;QAClD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;gBAClC,MAAM,EAAE,qBAAqB;aAC9B,CAAC,CAAA;YACF,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;gBAC3B,MAAM,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAA;YAC9B,CAAC;YACD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;QAC1B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,KAAK;iBACN,CAAA;YACH,CAAC;YACD,MAAM,KAAK,CAAA,CAAC,sBAAsB;QACpC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK;QACT,OAAM;IACR,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,EACpB,MAAM,EACN,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,MAAM,GAOP;QACC,MAAM,GAAG,GAAG,IAAA,4BAAY,EAAC;YACvB,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG;YACpB,QAAQ;YACR,YAAY;SACb,CAAC,CAAC,QAAQ,EAAE,CAAA;QAEb,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAE7C,IAAI,UAAU,GAAG,KAAK,CAAA;QACtB,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YAC9B,UAAU,GAAG,IAAI,CAAA;YACjB,eAAe,CAAC,KAAK,EAAE,CAAA;QACzB,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;QAE/B,IAAI,SAAS,GAAG,KAAK,CAAA;QACrB,IAAI,MAAM,EAAE,YAAY,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,CAAC,YAAY,CAAC,OAAO,GAAG,GAAG,EAAE;gBACjC,SAAS,GAAG,IAAI,CAAA;gBAChB,eAAe,CAAC,KAAK,EAAE,CAAA;YACzB,CAAC,CAAA;QACH,CAAC;QAED,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAA,sCAAsB,EAAC;gBACrC,OAAO,EAAE,IAAI,CAAC,cAAc;gBAC5B,gBAAgB,EAAE,KAAK;gBACvB,mBAAmB,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,mBAAmB;aACjE,CAAC,CAAA;YACF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAChC,IAAI,EAAE,MAAM;gBACZ,OAAO;gBACP,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO;gBACzC,MAAM,EAAE,MAAM,IAAI,MAAM;gBACxB,MAAM,EAAE,eAAe,CAAC,MAAM;aAC/B,CAAC,CAAA;YACF,YAAY,CAAC,OAAO,CAAC,CAAA;YACrB,IAAI,IAAA,oCAAoB,EAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1C,OAAO,QAAQ,CAAA;YACjB,CAAC;iBAAM,CAAC;gBACN,OAAO,OAAO,CAAC,MAAM,CACnB,IAAA,0BAAU,EACR,MAAM,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,IAAI,IAAI,cAAc,EAAc,CAAC,CACnE,CACF,CAAA;YACH,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,YAAY,CAAC,OAAO,CAAC,CAAA;YACrB,IAAI,SAAS,EAAE,CAAC;gBACd,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC,CAAA;YACjE,CAAC;YACD,IAAI,UAAU,EAAE,CAAC;gBACf,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAA;YACpD,CAAC;YACD,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;gBACzB,gCAAgC;gBAChC,OAAO,OAAO,CAAC,MAAM,CAAC,IAAA,0BAAU,EAAC,GAAG,CAAC,CAAC,CAAA;YACxC,CAAC;YACD,mBAAmB;YACnB,MAAM,GAAG,CAAA;QACX,CAAC;IACH,CAAC;CACF;AAtLD,sCAsLC;AAED,SAAS,UAAU,CAAC,QAA4B;IAC9C,OAAO,QAAQ,IAAI,MAAM,CAAC,UAAU,EAAE,CAAA;AACxC,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
+
export type { WebClickHouseClient as ClickHouseClient, QueryResult, } from './client';
|
|
1
2
|
export { createClient } from './client';
|
|
3
|
+
export { type WebClickHouseClientConfigOptions as ClickHouseClientConfigOptions } from './config';
|
|
2
4
|
export { ResultSet } from './result_set';
|
|
3
5
|
/** Re-export @clickhouse/client-common types */
|
|
4
|
-
export { type BaseClickHouseClientConfigOptions, type
|
|
6
|
+
export { type BaseClickHouseClientConfigOptions, type BaseQueryParams, type QueryParams, type ExecParams, type InsertParams, type InsertValues, type CommandParams, type CommandResult, type ExecResult, type InsertResult, type DataFormat, type RawDataFormat, type JSONDataFormat, type StreamableDataFormat, type StreamableJSONDataFormat, type SingleDocumentJSONFormat, type Logger, type LogParams, type ErrorLogParams, type WarnLogParams, type ClickHouseSettings, type MergeTreeSettings, type Row, type ResponseJSON, type InputJSON, type InputJSONObjectEachRow, type BaseResultSet, type PingResult, ClickHouseError, ClickHouseLogLevel, SettingsMap, } from '@clickhouse/client-common';
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.SettingsMap = exports.
|
|
3
|
+
exports.SettingsMap = exports.ClickHouseLogLevel = exports.ClickHouseError = exports.ResultSet = exports.createClient = void 0;
|
|
4
4
|
var client_1 = require("./client");
|
|
5
5
|
Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return client_1.createClient; } });
|
|
6
6
|
var result_set_1 = require("./result_set");
|
|
@@ -9,6 +9,5 @@ Object.defineProperty(exports, "ResultSet", { enumerable: true, get: function ()
|
|
|
9
9
|
var client_common_1 = require("@clickhouse/client-common");
|
|
10
10
|
Object.defineProperty(exports, "ClickHouseError", { enumerable: true, get: function () { return client_common_1.ClickHouseError; } });
|
|
11
11
|
Object.defineProperty(exports, "ClickHouseLogLevel", { enumerable: true, get: function () { return client_common_1.ClickHouseLogLevel; } });
|
|
12
|
-
Object.defineProperty(exports, "ClickHouseClient", { enumerable: true, get: function () { return client_common_1.ClickHouseClient; } });
|
|
13
12
|
Object.defineProperty(exports, "SettingsMap", { enumerable: true, get: function () { return client_common_1.SettingsMap; } });
|
|
14
13
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/client-web/src/index.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/client-web/src/index.ts"],"names":[],"mappings":";;;AAIA,mCAAuC;AAA9B,sGAAA,YAAY,OAAA;AAErB,2CAAwC;AAA/B,uGAAA,SAAS,OAAA;AAElB,gDAAgD;AAChD,2DAgCkC;AAHhC,gHAAA,eAAe,OAAA;AACf,mHAAA,kBAAkB,OAAA;AAClB,4GAAA,WAAW,OAAA"}
|
package/dist/result_set.d.ts
CHANGED
|
@@ -1,13 +1,16 @@
|
|
|
1
|
-
import type { BaseResultSet, DataFormat, Row } from '@clickhouse/client-common';
|
|
2
|
-
export declare class ResultSet implements BaseResultSet<ReadableStream<Row[]
|
|
1
|
+
import type { BaseResultSet, DataFormat, ResultJSONType, ResultStream, Row } from '@clickhouse/client-common';
|
|
2
|
+
export declare class ResultSet<Format extends DataFormat | unknown> implements BaseResultSet<ReadableStream<Row[]>, Format> {
|
|
3
3
|
private _stream;
|
|
4
4
|
private readonly format;
|
|
5
5
|
readonly query_id: string;
|
|
6
6
|
private isAlreadyConsumed;
|
|
7
|
-
constructor(_stream: ReadableStream, format:
|
|
7
|
+
constructor(_stream: ReadableStream, format: Format, query_id: string);
|
|
8
|
+
/** See {@link BaseResultSet.text} */
|
|
8
9
|
text(): Promise<string>;
|
|
9
|
-
json
|
|
10
|
-
|
|
10
|
+
/** See {@link BaseResultSet.json} */
|
|
11
|
+
json<T>(): Promise<ResultJSONType<T, Format>>;
|
|
12
|
+
/** See {@link BaseResultSet.stream} */
|
|
13
|
+
stream<T>(): ResultStream<Format, ReadableStream<Row<T, Format>[]>>;
|
|
11
14
|
close(): Promise<void>;
|
|
12
15
|
private markAsConsumed;
|
|
13
16
|
}
|
package/dist/result_set.js
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ResultSet = void 0;
|
|
4
4
|
const client_common_1 = require("@clickhouse/client-common");
|
|
5
|
+
const client_common_2 = require("@clickhouse/client-common");
|
|
5
6
|
const utils_1 = require("./utils");
|
|
6
7
|
class ResultSet {
|
|
7
8
|
constructor(_stream, format, query_id) {
|
|
@@ -30,17 +31,41 @@ class ResultSet {
|
|
|
30
31
|
value: false
|
|
31
32
|
});
|
|
32
33
|
}
|
|
34
|
+
/** See {@link BaseResultSet.text} */
|
|
33
35
|
async text() {
|
|
34
36
|
this.markAsConsumed();
|
|
35
37
|
return (0, utils_1.getAsText)(this._stream);
|
|
36
38
|
}
|
|
39
|
+
/** See {@link BaseResultSet.json} */
|
|
37
40
|
async json() {
|
|
38
|
-
|
|
39
|
-
|
|
41
|
+
// JSONEachRow, etc.
|
|
42
|
+
if ((0, client_common_1.isStreamableJSONFamily)(this.format)) {
|
|
43
|
+
const result = [];
|
|
44
|
+
const reader = this.stream().getReader();
|
|
45
|
+
// eslint-disable-next-line no-constant-condition
|
|
46
|
+
while (true) {
|
|
47
|
+
const { done, value } = await reader.read();
|
|
48
|
+
if (done) {
|
|
49
|
+
break;
|
|
50
|
+
}
|
|
51
|
+
for (const row of value) {
|
|
52
|
+
result.push(row.json());
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
return result;
|
|
56
|
+
}
|
|
57
|
+
// JSON, JSONObjectEachRow, etc.
|
|
58
|
+
if ((0, client_common_1.isNotStreamableJSONFamily)(this.format)) {
|
|
59
|
+
const text = await (0, utils_1.getAsText)(this._stream);
|
|
60
|
+
return JSON.parse(text);
|
|
61
|
+
}
|
|
62
|
+
// should not be called for CSV, etc.
|
|
63
|
+
throw new Error(`Cannot decode ${this.format} as JSON`);
|
|
40
64
|
}
|
|
65
|
+
/** See {@link BaseResultSet.stream} */
|
|
41
66
|
stream() {
|
|
42
67
|
this.markAsConsumed();
|
|
43
|
-
(0,
|
|
68
|
+
(0, client_common_2.validateStreamFormat)(this.format);
|
|
44
69
|
let decodedChunk = '';
|
|
45
70
|
const decoder = new TextDecoder('utf-8');
|
|
46
71
|
const transform = new TransformStream({
|
|
@@ -62,7 +87,7 @@ class ResultSet {
|
|
|
62
87
|
rows.push({
|
|
63
88
|
text,
|
|
64
89
|
json() {
|
|
65
|
-
return
|
|
90
|
+
return JSON.parse(text);
|
|
66
91
|
},
|
|
67
92
|
});
|
|
68
93
|
}
|
|
@@ -78,11 +103,12 @@ class ResultSet {
|
|
|
78
103
|
decodedChunk = '';
|
|
79
104
|
},
|
|
80
105
|
});
|
|
81
|
-
|
|
106
|
+
const pipeline = this._stream.pipeThrough(transform, {
|
|
82
107
|
preventClose: false,
|
|
83
108
|
preventAbort: false,
|
|
84
109
|
preventCancel: false,
|
|
85
110
|
});
|
|
111
|
+
return pipeline;
|
|
86
112
|
}
|
|
87
113
|
async close() {
|
|
88
114
|
this.markAsConsumed();
|
package/dist/result_set.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"result_set.js","sourceRoot":"","sources":["../../../packages/client-web/src/result_set.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"result_set.js","sourceRoot":"","sources":["../../../packages/client-web/src/result_set.ts"],"names":[],"mappings":";;;AAOA,6DAGkC;AAClC,6DAAgE;AAChE,mCAAmC;AAEnC,MAAa,SAAS;IAIpB,YACU,OAAuB,EACd,MAAc,EACf,QAAgB;QAFhC;;;;mBAAQ,OAAO;WAAgB;QAC/B;;;;mBAAiB,MAAM;WAAQ;QAC/B;;;;mBAAgB,QAAQ;WAAQ;QAJ1B;;;;mBAAoB,KAAK;WAAA;IAK9B,CAAC;IAEJ,qCAAqC;IACrC,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,cAAc,EAAE,CAAA;QACrB,OAAO,IAAA,iBAAS,EAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAChC,CAAC;IAED,qCAAqC;IACrC,KAAK,CAAC,IAAI;QACR,oBAAoB;QACpB,IAAI,IAAA,sCAAsB,EAAC,IAAI,CAAC,MAAoB,CAAC,EAAE,CAAC;YACtD,MAAM,MAAM,GAAQ,EAAE,CAAA;YACtB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAK,CAAC,SAAS,EAAE,CAAA;YAC3C,iDAAiD;YACjD,OAAO,IAAI,EAAE,CAAC;gBACZ,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;gBAC3C,IAAI,IAAI,EAAE,CAAC;oBACT,MAAK;gBACP,CAAC;gBACD,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;oBACxB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;gBACzB,CAAC;YACH,CAAC;YACD,OAAO,MAAa,CAAA;QACtB,CAAC;QACD,gCAAgC;QAChC,IAAI,IAAA,yCAAyB,EAAC,IAAI,CAAC,MAAoB,CAAC,EAAE,CAAC;YACzD,MAAM,IAAI,GAAG,MAAM,IAAA,iBAAS,EAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACzB,CAAC;QACD,qCAAqC;QACrC,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,CAAC,MAAM,UAAU,CAAC,CAAA;IACzD,CAAC;IAED,uCAAuC;IACvC,MAAM;QACJ,IAAI,CAAC,cAAc,EAAE,CAAA;QACrB,IAAA,oCAAoB,EAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAEjC,IAAI,YAAY,GAAG,EAAE,CAAA;QACrB,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAA;QACxC,MAAM,SAAS,GAAG,IAAI,eAAe,CAAC;YACpC,KAAK;gBACH,EAAE;YACJ,CAAC;YACD,SAAS,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC/B,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACnB,UAAU,CAAC,SAAS,EAAE,CAAA;gBACxB,CAAC;gBACD,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;gBACrC,MAAM,IAAI,GAAU,EAAE,CAAA;gBACtB,iDAAiD;gBACjD,OAAO,IAAI,EAAE,CAAC;oBACZ,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;oBACtC,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;wBACf,MAAM,IAAI,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;wBACvC,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA;wBAC1C,IAAI,CAAC,IAAI,CAAC;4BACR,IAAI;4BACJ,IAAI;gCACF,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;4BACzB,CAAC;yBACF,CAAC,CAAA;oBACJ,CAAC;yBAAM,CAAC;wBACN,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;4BAChB,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;wBAC1B,CAAC;wBACD,MAAK;oBACP,CAAC;gBACH,CAAC;YACH,CAAC;YACD,KAAK;gBACH,YAAY,GAAG,EAAE,CAAA;YACnB,CAAC;SACF,CAAC,CAAA;QAEF,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,EAAE;YACnD,YAAY,EAAE,KAAK;YACnB,YAAY,EAAE,KAAK;YACnB,aAAa,EAAE,KAAK;SACrB,CAAC,CAAA;QACF,OAAO,QAAe,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,cAAc,EAAE,CAAA;QACrB,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAA;IAC7B,CAAC;IAEO,cAAc;QACpB,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;QAC/C,CAAC;QACD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAA;IAC/B,CAAC;CACF;AAxGD,8BAwGC;AAED,MAAM,4BAA4B,GAAG,kCAAkC,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"encoder.js","sourceRoot":"","sources":["../../../../packages/client-web/src/utils/encoder.ts"],"names":[],"mappings":";;;AAKA,6DAAsD;AACtD,qCAAmC;AAEnC,MAAa,gBAAgB;IAC3B,YAAY,CACV,MAAuB,EACvB,MAAkB;QAElB,aAAa,CAAC,MAAM,CAAC,CAAA;QACrB,eAAe;QACf,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;
|
|
1
|
+
{"version":3,"file":"encoder.js","sourceRoot":"","sources":["../../../../packages/client-web/src/utils/encoder.ts"],"names":[],"mappings":";;;AAKA,6DAAsD;AACtD,qCAAmC;AAEnC,MAAa,gBAAgB;IAC3B,YAAY,CACV,MAAuB,EACvB,MAAkB;QAElB,aAAa,CAAC,MAAM,CAAC,CAAA;QACrB,eAAe;QACf,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,0BAAU,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAClE,CAAC;QACD,wCAAwC;QACxC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,IAAA,0BAAU,EAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACnC,CAAC;QACD,MAAM,IAAI,KAAK,CACb,gCAAgC,OAAO,MAAM,SAAS,MAAM,SAAS,CACtE,CAAA;IACH,CAAC;IAED,oBAAoB,CAAc,MAAuB;QACvD,aAAa,CAAC,MAAM,CAAC,CAAA;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACzD,MAAM,IAAI,KAAK,CACb,4DAA4D;gBAC1D,QAAQ,OAAO,MAAM,EAAE,CAC1B,CAAA;QACH,CAAC;IACH,CAAC;CACF;AA5BD,4CA4BC;AAED,SAAS,aAAa,CAAC,MAAe;IACpC,IAAI,IAAA,iBAAQ,EAAC,MAAM,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CACb,yEAAyE,CAC1E,CAAA;IACH,CAAC;AACH,CAAC"}
|
package/dist/utils/stream.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../../../packages/client-web/src/utils/stream.ts"],"names":[],"mappings":";;;AAAA,SAAgB,QAAQ,CAAC,GAAQ;IAC/B,OAAO,CACL,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,IAAI,OAAO,GAAG,CAAC,WAAW,KAAK,UAAU,CAC3E,CAAA;AACH,CAAC;AAJD,4BAIC;AAEM,KAAK,UAAU,SAAS,CAAC,MAAsB;IACpD,IAAI,MAAM,GAAG,EAAE,CAAA;IACf,IAAI,MAAM,GAAG,KAAK,CAAA;IAElB,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAA;IACrC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAA;IAEjC,OAAO,CAAC,MAAM,EAAE;
|
|
1
|
+
{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../../../packages/client-web/src/utils/stream.ts"],"names":[],"mappings":";;;AAAA,SAAgB,QAAQ,CAAC,GAAQ;IAC/B,OAAO,CACL,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,IAAI,OAAO,GAAG,CAAC,WAAW,KAAK,UAAU,CAC3E,CAAA;AACH,CAAC;AAJD,4BAIC;AAEM,KAAK,UAAU,SAAS,CAAC,MAAsB;IACpD,IAAI,MAAM,GAAG,EAAE,CAAA;IACf,IAAI,MAAM,GAAG,KAAK,CAAA;IAElB,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAA;IACrC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAA;IAEjC,OAAO,CAAC,MAAM,EAAE,CAAC;QACf,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;QAC3C,MAAM,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;QACrD,MAAM,GAAG,IAAI,CAAA;IACf,CAAC;IAED,QAAQ;IACR,MAAM,IAAI,WAAW,CAAC,MAAM,EAAE,CAAA;IAC9B,OAAO,MAAM,CAAA;AACf,CAAC;AAhBD,8BAgBC"}
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const _default: "0.
|
|
1
|
+
declare const _default: "1.0.1";
|
|
2
2
|
export default _default;
|
package/dist/version.js
CHANGED
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@clickhouse/client-web",
|
|
3
3
|
"description": "Official JS client for ClickHouse DB - Web API implementation",
|
|
4
4
|
"homepage": "https://clickhouse.com",
|
|
5
|
-
"version": "0.
|
|
5
|
+
"version": "1.0.1",
|
|
6
6
|
"license": "Apache-2.0",
|
|
7
7
|
"keywords": [
|
|
8
8
|
"clickhouse",
|
|
@@ -20,6 +20,6 @@
|
|
|
20
20
|
"dist"
|
|
21
21
|
],
|
|
22
22
|
"dependencies": {
|
|
23
|
-
"@clickhouse/client-common": "0.
|
|
23
|
+
"@clickhouse/client-common": "1.0.1"
|
|
24
24
|
}
|
|
25
25
|
}
|