@clickhouse/client-common 1.2.0 → 1.4.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 +4 -0
- package/dist/client.d.ts +19 -7
- package/dist/client.js +5 -3
- package/dist/client.js.map +1 -1
- package/dist/config.d.ts +2 -1
- package/dist/config.js.map +1 -1
- package/dist/connection.d.ts +6 -3
- package/dist/data_formatter/formatter.d.ts +11 -11
- package/dist/data_formatter/formatter.js +19 -19
- package/dist/data_formatter/formatter.js.map +1 -1
- package/dist/index.d.ts +3 -3
- package/dist/index.js.map +1 -1
- package/dist/result.d.ts +3 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
|
@@ -33,6 +33,10 @@ export interface ClickHouseSummary {
|
|
|
33
33
|
result_bytes: string;
|
|
34
34
|
elapsed_ns: string;
|
|
35
35
|
}
|
|
36
|
+
export type ResponseHeaders = Record<string, string | string[] | undefined>;
|
|
36
37
|
export interface WithClickHouseSummary {
|
|
37
38
|
summary?: ClickHouseSummary;
|
|
38
39
|
}
|
|
40
|
+
export interface WithResponseHeaders {
|
|
41
|
+
response_headers: ResponseHeaders;
|
|
42
|
+
}
|
package/dist/client.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { BaseClickHouseClientConfigOptions, ClickHouseSettings, ConnExecResult, IsSame, WithClickHouseSummary } from '@clickhouse/client-common';
|
|
1
|
+
import type { BaseClickHouseClientConfigOptions, ClickHouseSettings, ConnExecResult, IsSame, WithClickHouseSummary, WithResponseHeaders } 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 { ImplementationDetails } from './config';
|
|
@@ -40,14 +40,26 @@ export type QueryParamsWithFormat<Format extends DataFormat> = Omit<QueryParams,
|
|
|
40
40
|
* allowing to call all methods with all data shapes variants,
|
|
41
41
|
* and avoiding generated types that include all possible DataFormat literal values. */
|
|
42
42
|
export type QueryResult<Stream, Format extends DataFormat> = IsSame<Format, DataFormat> extends true ? BaseResultSet<Stream, unknown> : BaseResultSet<Stream, Format>;
|
|
43
|
-
export
|
|
44
|
-
/** Statement to execute.
|
|
43
|
+
export type ExecParams = BaseQueryParams & {
|
|
44
|
+
/** Statement to execute (including the FORMAT clause). By default, the query will be sent in the request body;
|
|
45
|
+
* If {@link ExecParamsWithValues.values} are defined, the query is sent as a request parameter,
|
|
46
|
+
* and the values are sent in the request body instead. */
|
|
45
47
|
query: string;
|
|
46
|
-
}
|
|
48
|
+
};
|
|
49
|
+
export type ExecParamsWithValues<Stream> = ExecParams & {
|
|
50
|
+
/** If you have a custom INSERT statement to run with `exec`,
|
|
51
|
+
* the data from this stream will be inserted.
|
|
52
|
+
*
|
|
53
|
+
* NB: the data in the stream is expected to be serialized accordingly to the FORMAT clause
|
|
54
|
+
* used in {@link ExecParams.query} in this case.
|
|
55
|
+
*
|
|
56
|
+
* @see https://clickhouse.com/docs/en/interfaces/formats */
|
|
57
|
+
values: Stream;
|
|
58
|
+
};
|
|
47
59
|
export type CommandParams = ExecParams;
|
|
48
60
|
export type CommandResult = {
|
|
49
61
|
query_id: string;
|
|
50
|
-
} & WithClickHouseSummary;
|
|
62
|
+
} & WithClickHouseSummary & WithResponseHeaders;
|
|
51
63
|
export type InsertResult = {
|
|
52
64
|
/**
|
|
53
65
|
* Indicates whether the INSERT statement was executed on the server.
|
|
@@ -61,7 +73,7 @@ export type InsertResult = {
|
|
|
61
73
|
* Otherwise, either {@link InsertParams.query_id} if it was set, or the id that was generated by the client.
|
|
62
74
|
*/
|
|
63
75
|
query_id: string;
|
|
64
|
-
} & WithClickHouseSummary;
|
|
76
|
+
} & WithClickHouseSummary & WithResponseHeaders;
|
|
65
77
|
export type ExecResult<Stream> = ConnExecResult<Stream>;
|
|
66
78
|
export type PingResult = ConnPingResult;
|
|
67
79
|
export type InsertValues<Stream, T = unknown> = ReadonlyArray<T> | Stream | InputJSON<T> | InputJSONObjectEachRow<T>;
|
|
@@ -121,7 +133,7 @@ export declare class ClickHouseClient<Stream = unknown> {
|
|
|
121
133
|
* but format clause is not applicable. The caller of this method is expected to consume the stream,
|
|
122
134
|
* otherwise, the request will eventually be timed out.
|
|
123
135
|
*/
|
|
124
|
-
exec(params: ExecParams): Promise<ExecResult<Stream>>;
|
|
136
|
+
exec(params: ExecParams | ExecParamsWithValues<Stream>): Promise<ExecResult<Stream>>;
|
|
125
137
|
/**
|
|
126
138
|
* The primary method for data insertion. It is recommended to avoid arrays in case of large inserts
|
|
127
139
|
* to reduce application memory consumption and consider streaming for most of such use cases.
|
package/dist/client.js
CHANGED
|
@@ -70,7 +70,7 @@ class ClickHouseClient {
|
|
|
70
70
|
const format = params.format ?? 'JSON';
|
|
71
71
|
const query = formatQuery(params.query, format);
|
|
72
72
|
const queryParams = this.withClientQueryParams(params);
|
|
73
|
-
const { stream, query_id } = await this.connection.query({
|
|
73
|
+
const { stream, query_id, response_headers } = await this.connection.query({
|
|
74
74
|
query,
|
|
75
75
|
...queryParams,
|
|
76
76
|
});
|
|
@@ -85,7 +85,7 @@ class ClickHouseClient {
|
|
|
85
85
|
query_id,
|
|
86
86
|
},
|
|
87
87
|
});
|
|
88
|
-
});
|
|
88
|
+
}, response_headers);
|
|
89
89
|
}
|
|
90
90
|
/**
|
|
91
91
|
* It should be used for statements that do not have any output,
|
|
@@ -108,8 +108,10 @@ class ClickHouseClient {
|
|
|
108
108
|
*/
|
|
109
109
|
async exec(params) {
|
|
110
110
|
const query = removeTrailingSemi(params.query.trim());
|
|
111
|
+
const values = 'values' in params ? params.values : undefined;
|
|
111
112
|
return await this.connection.exec({
|
|
112
113
|
query,
|
|
114
|
+
values,
|
|
113
115
|
...this.withClientQueryParams(params),
|
|
114
116
|
});
|
|
115
117
|
}
|
|
@@ -122,7 +124,7 @@ class ClickHouseClient {
|
|
|
122
124
|
*/
|
|
123
125
|
async insert(params) {
|
|
124
126
|
if (Array.isArray(params.values) && params.values.length === 0) {
|
|
125
|
-
return { executed: false, query_id: '' };
|
|
127
|
+
return { executed: false, query_id: '', response_headers: {} };
|
|
126
128
|
}
|
|
127
129
|
const format = params.format || 'JSONCompactEachRow';
|
|
128
130
|
this.valuesEncoder.validateInsertValues(params.values, format);
|
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":";;;AAYA,6DAA0E;AAG1E,qCAAoE;AA4HpE,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,gBAAgB,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;YACzE,KAAK;YACL,GAAG,WAAW;SACf,CAAC,CAAA;QACF,OAAO,IAAI,CAAC,aAAa,CACvB,MAAM,EACN,MAAM,EACN,QAAQ,EACR,CAAC,GAAG,EAAE,EAAE;YACN,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,EACD,gBAAgB,CACjB,CAAA;IACH,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,CACR,MAAiD;QAEjD,MAAM,KAAK,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;QACrD,MAAM,MAAM,GAAG,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;QAC7D,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YAChC,KAAK;YACL,MAAM;YACN,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,gBAAgB,EAAE,EAAE,EAAE,CAAA;QAChE,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;AA3JD,4CA2JC;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
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { ResponseHeaders } from './clickhouse_types';
|
|
1
2
|
import type { InsertValues } from './client';
|
|
2
3
|
import type { Connection, ConnectionParams } from './connection';
|
|
3
4
|
import type { DataFormat } from './data_formatter';
|
|
@@ -77,7 +78,7 @@ export interface BaseClickHouseClientConfigOptions {
|
|
|
77
78
|
};
|
|
78
79
|
}
|
|
79
80
|
export type MakeConnection<Stream, Config = BaseClickHouseClientConfigOptionsWithURL> = (config: Config, params: ConnectionParams) => Connection<Stream>;
|
|
80
|
-
export type MakeResultSet<Stream> = <Format extends DataFormat, ResultSet extends BaseResultSet<Stream, Format>>(stream: Stream, format: Format, query_id: string, log_error: (err: Error) => void) => ResultSet;
|
|
81
|
+
export type MakeResultSet<Stream> = <Format extends DataFormat, ResultSet extends BaseResultSet<Stream, Format>>(stream: Stream, format: Format, query_id: string, log_error: (err: Error) => void, response_headers: ResponseHeaders) => ResultSet;
|
|
81
82
|
export interface ValuesEncoder<Stream> {
|
|
82
83
|
validateInsertValues<T = unknown>(values: InsertValues<Stream, T>, format: DataFormat): void;
|
|
83
84
|
/**
|
package/dist/config.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../packages/client-common/src/config.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../packages/client-common/src/config.ts"],"names":[],"mappings":";;;AAKA,qCAAwD;AAqJxD;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAClC,iBAAoD,EACpD,MAAc,EACd,mBAAuD;IAEvD,MAAM,UAAU,GAAG,EAAE,GAAG,iBAAiB,EAAE,CAAA;IAC3C,IAAI,UAAU,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;QAChD,MAAM,CAAC,IAAI,CAAC;YACV,MAAM,EAAE,QAAQ;YAChB,OAAO,EACL,iEAAiE;SACpE,CAAC,CAAA;QACF,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,kBAAkB,CAAA;QACvD,OAAO,UAAU,CAAC,kBAAkB,CAAA;IACtC,CAAC;IACD,IAAI,SAAS,CAAA;IACb,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,CAAC,IAAI,CAAC;YACV,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,0CAA0C;SACpD,CAAC,CAAA;QACF,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QACtC,OAAO,UAAU,CAAC,IAAI,CAAA;IACxB,CAAC;SAAM,CAAC;QACN,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACvC,CAAC;IACD,MAAM,CAAC,GAAG,EAAE,aAAa,CAAC,GAAG,wBAAwB,CACnD,SAAS,EACT,mBAAmB,CACpB,CAAA;IACD,MAAM,MAAM,GAAG,YAAY,CAAC,UAAU,EAAE,aAAa,EAAE,MAAM,CAAC,CAAA;IAC9D,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAClC,GAAG,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;IAChC,CAAC;IACD,MAAM,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,OAAO,MAAkD,CAAA;AAC3D,CAAC;AApCD,oDAoCC;AAED,SAAgB,mBAAmB,CACjC,MAAgD,EAChD,MAAc;IAEd,OAAO;QACL,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,cAAc,EAAE,MAAM,CAAC,WAAW;QAClC,eAAe,EAAE,MAAM,CAAC,eAAe,IAAI,KAAM;QACjD,oBAAoB,EAAE,MAAM,CAAC,oBAAoB,IAAI,EAAE;QACvD,WAAW,EAAE;YACX,mBAAmB,EAAE,MAAM,CAAC,WAAW,EAAE,QAAQ,IAAI,KAAK;YAC1D,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,UAAU,EAAE,IAAI,kBAAS,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC;QAClE,UAAU,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,OAAO,IAAI,IAAI,EAAE;QAC3D,mBAAmB,EAAE,MAAM,CAAC,mBAAmB,IAAI,EAAE;QACrD,YAAY,EAAE,MAAM,CAAC,YAAY,IAAI,EAAE;KACxC,CAAA;AACH,CAAC;AArBD,kDAqBC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAC1B,UAA6C,EAC7C,aAAgD,EAChD,MAAc;IAEd,SAAS,SAAS,CAChB,IAAyB,EACzB,OAA4B,EAC5B,OAAiB,EAAE;QAEnB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,IAAI,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACrC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;YACjD,CAAC;iBAAM,CAAC;gBACN,IAAI,UAAU,GAAwB,IAAI,CAAA;gBAC1C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oBACvB,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;wBAClC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;oBACtB,CAAC;oBACD,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAA;gBAC9B,CAAC;gBACD,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,CAAA;gBACjC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;oBAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;oBAC3C,MAAM,CAAC,IAAI,CAAC;wBACV,MAAM,EAAE,QAAQ;wBAChB,OAAO,EAAE,IAAI,QAAQ,qCAAqC;qBAC3D,CAAC,CAAA;gBACJ,CAAC;gBACD,UAAU,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;YAChC,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAwB,EAAE,GAAG,UAAU,EAAE,CAAA;IACrD,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IAChC,OAAO,MAA2C,CAAA;AACpD,CAAC;AArCD,oCAqCC;AAED,SAAgB,SAAS,CAAC,SAAmC;IAC3D,IAAI,GAAQ,CAAA;IACZ,IAAI,CAAC;QACH,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,YAAY,GAAG,EAAE,CAAC;YAC9D,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAA;QAC1B,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,GAAG,CAAC,uBAAuB,CAAC,CAAA;QACzC,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACb,oIAAoI,CACrI,CAAA;IACH,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1D,MAAM,IAAI,KAAK,CACb,8DAA8D,GAAG,CAAC,QAAQ,EAAE,CAC7E,CAAA;IACH,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAnBD,8BAmBC;AAED;;;;GAIG;AACH,SAAgB,wBAAwB,CACtC,GAAQ,EACR,oBAAwD;IAExD,IAAI,MAAM,GAAsC,EAAE,CAAA;IAClD,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QAC/B,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAA;IAChC,CAAC;IACD,uBAAuB;IACvB,IAAI,GAAG,CAAC,QAAQ,KAAK,EAAE,EAAE,CAAC;QACxB,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAA;IAChC,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnC,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACzC,CAAC;IACD,MAAM,mBAAmB,GAAG,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAA;IACxD,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnC,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAA;QACvC,MAAM,aAAa,GAAG,qBAAqB,CAAA;QAC3C,MAAM,kBAAkB,GAAG,KAAK,CAAA;QAChC,MAAM,gBAAgB,GAAG,cAAc,CAAA;QACvC,mBAAmB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAClC,IAAI,iBAAiB,GAAG,IAAI,CAAA;YAC5B,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAW,CAAA;YACjD,IAAI,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;gBAClC,wBAAwB;gBACxB,MAAM,UAAU,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;gBAClD,IAAI,MAAM,CAAC,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBAC7C,MAAM,CAAC,mBAAmB,GAAG,EAAE,CAAA;gBACjC,CAAC;gBACD,MAAM,CAAC,mBAAmB,CAAC,UAAU,CAAC,GAAG,KAAK,CAAA;YAChD,CAAC;iBAAM,IAAI,GAAG,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC;gBAC9C,OAAO;gBACP,MAAM,UAAU,GAAG,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAA;gBACvD,IAAI,MAAM,CAAC,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBAC7C,MAAM,CAAC,mBAAmB,GAAG,EAAE,CAAA;gBACjC,CAAC;gBACD,MAAM,CAAC,mBAAmB,CAAC,UAAU,CAAC,GAAG,KAAK,CAAA;YAChD,CAAC;iBAAM,IAAI,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAC5C,iBAAiB;gBACjB,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;gBACpD,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;oBACtC,MAAM,CAAC,YAAY,GAAG,EAAE,CAAA;gBAC1B,CAAC;gBACD,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,GAAG,KAAK,CAAA;YACxC,CAAC;iBAAM,CAAC;gBACN,0BAA0B;gBAC1B,QAAQ,GAAG,EAAE,CAAC;oBACZ,KAAK,aAAa;wBAChB,MAAM,CAAC,WAAW,GAAG,KAAK,CAAA;wBAC1B,MAAK;oBACP,KAAK,UAAU;wBACb,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAA;wBACvB,MAAK;oBACP,KAAK,YAAY;wBACf,MAAM,CAAC,UAAU,GAAG,KAAK,CAAA;wBACzB,MAAK;oBACP,KAAK,iBAAiB;wBACpB,MAAM,CAAC,eAAe,GAAG,oBAAoB,CAAC;4BAC5C,GAAG;4BACH,KAAK;4BACL,GAAG,EAAE,CAAC;yBACP,CAAC,CAAA;wBACF,MAAK;oBACP,KAAK,sBAAsB;wBACzB,MAAM,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;4BACjD,GAAG;4BACH,KAAK;4BACL,GAAG,EAAE,CAAC;yBACP,CAAC,CAAA;wBACF,MAAK;oBACP,KAAK,qBAAqB;wBACxB,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;4BACrC,MAAM,CAAC,WAAW,GAAG,EAAE,CAAA;wBACzB,CAAC;wBACD,MAAM,CAAC,WAAW,CAAC,OAAO,GAAG,qBAAqB,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAA;wBAClE,MAAK;oBACP,KAAK,sBAAsB;wBACzB,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;4BACrC,MAAM,CAAC,WAAW,GAAG,EAAE,CAAA;wBACzB,CAAC;wBACD,MAAM,CAAC,WAAW,CAAC,QAAQ,GAAG,qBAAqB,CAAC;4BAClD,GAAG;4BACH,KAAK;yBACN,CAAC,CAAA;wBACF,MAAK;oBACP,KAAK,WAAW;wBACd,IAAI,MAAM,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;4BAC7B,MAAM,CAAC,GAAG,GAAG,EAAE,CAAA;wBACjB,CAAC;wBACD,MAAM,CAAC,GAAG,CAAC,KAAK,GAAG,kBAAkB,CAAC;4BACpC,GAAG;4BACH,KAAK;4BACL,UAAU,EAAE,2BAAkB;yBAC/B,CAAC,CAAA;wBACF,MAAK;oBACP,KAAK,oBAAoB;wBACvB,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;4BACpC,MAAM,CAAC,UAAU,GAAG,EAAE,CAAA;wBACxB,CAAC;wBACD,MAAM,CAAC,UAAU,CAAC,OAAO,GAAG,qBAAqB,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAA;wBACjE,MAAK;oBACP;wBACE,iBAAiB,GAAG,KAAK,CAAA;wBACzB,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;wBACtB,MAAK;gBACT,CAAC;YACH,CAAC;YACD,IAAI,iBAAiB,EAAE,CAAC;gBACtB,uDAAuD;gBACvD,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAC9B,CAAC;QACH,CAAC,CAAC,CAAA;QACF,IAAI,oBAAoB,KAAK,IAAI,EAAE,CAAC;YAClC,MAAM,GAAG,GAAG,oBAAoB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;YAC7C,MAAM,GAAG,GAAG,CAAC,MAAM,CAAA;YACnB,IAAI,aAAa,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBAC3B,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;YAC5D,CAAC;YACD,IAAI,GAAG,CAAC,cAAc,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBAChC,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;YACzD,CAAC;QACH,CAAC;QACD,IAAI,aAAa,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,2BAA2B,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAClE,CAAA;QACH,CAAC;IACH,CAAC;IACD,iEAAiE;IACjE,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,GAAG,GAAG,CAAC,QAAQ,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;IAC7D,OAAO,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;AAChC,CAAC;AApID,4DAoIC;AAED,SAAgB,qBAAqB,CAAC,EACpC,GAAG,EACH,KAAK,GAIN;IACC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;IAC5B,IAAI,OAAO,KAAK,MAAM,IAAI,OAAO,KAAK,GAAG;QAAE,OAAO,IAAI,CAAA;IACtD,IAAI,OAAO,KAAK,OAAO,IAAI,OAAO,KAAK,GAAG;QAAE,OAAO,KAAK,CAAA;IACxD,MAAM,IAAI,KAAK,CACb,IAAI,GAAG,gCAAgC,OAAO,uCAAuC,CACtF,CAAA;AACH,CAAC;AAbD,sDAaC;AAED,SAAgB,oBAAoB,CAAC,EACnC,GAAG,EACH,KAAK,EACL,GAAG,EACH,GAAG,GAMJ;IACC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;IAC5B,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA;IAC9B,IAAI,KAAK,CAAC,MAAM,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,IAAI,GAAG,gCAAgC,OAAO,EAAE,CAAC,CAAA;IACnE,IAAI,GAAG,KAAK,SAAS,IAAI,MAAM,GAAG,GAAG,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CAAC,IAAI,GAAG,WAAW,OAAO,6BAA6B,GAAG,EAAE,CAAC,CAAA;IAC9E,CAAC;IACD,IAAI,GAAG,KAAK,SAAS,IAAI,MAAM,GAAG,GAAG,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CACb,IAAI,GAAG,WAAW,OAAO,gCAAgC,GAAG,EAAE,CAC/D,CAAA;IACH,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAxBD,oDAwBC;AAED,SAAgB,kBAAkB,CAA2B,EAC3D,GAAG,EACH,KAAK,EACL,UAAU,GAOX;IACC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAC5E,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;IAC5B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClC,MAAM,IAAI,KAAK,CACb,IAAI,GAAG,wBAAwB,OAAO,sBAAsB,QAAQ,GAAG,CACxE,CAAA;IACH,CAAC;IACD,OAAO,UAAU,CAAC,OAAc,CAAC,CAAA;AACnC,CAAC;AApBD,gDAoBC"}
|
package/dist/connection.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { WithClickHouseSummary } from './clickhouse_types';
|
|
1
|
+
import type { WithClickHouseSummary, WithResponseHeaders } from './clickhouse_types';
|
|
2
2
|
import type { LogWriter } from './logger';
|
|
3
3
|
import type { ClickHouseSettings } from './settings';
|
|
4
4
|
export interface ConnectionParams {
|
|
@@ -36,7 +36,10 @@ export interface ConnBaseQueryParams {
|
|
|
36
36
|
export interface ConnInsertParams<Stream> extends ConnBaseQueryParams {
|
|
37
37
|
values: string | Stream;
|
|
38
38
|
}
|
|
39
|
-
export interface
|
|
39
|
+
export interface ConnExecParams<Stream> extends ConnBaseQueryParams {
|
|
40
|
+
values?: Stream;
|
|
41
|
+
}
|
|
42
|
+
export interface ConnBaseResult extends WithResponseHeaders {
|
|
40
43
|
query_id: string;
|
|
41
44
|
}
|
|
42
45
|
export interface ConnQueryResult<Stream> extends ConnBaseResult {
|
|
@@ -58,6 +61,6 @@ export interface Connection<Stream> {
|
|
|
58
61
|
close(): Promise<void>;
|
|
59
62
|
query(params: ConnBaseQueryParams): Promise<ConnQueryResult<Stream>>;
|
|
60
63
|
insert(params: ConnInsertParams<Stream>): Promise<ConnInsertResult>;
|
|
61
|
-
exec(params:
|
|
64
|
+
exec(params: ConnExecParams<Stream>): Promise<ConnExecResult<Stream>>;
|
|
62
65
|
command(params: ConnBaseQueryParams): Promise<ConnCommandResult>;
|
|
63
66
|
}
|
|
@@ -1,16 +1,18 @@
|
|
|
1
|
-
declare const
|
|
2
|
-
declare const
|
|
3
|
-
declare const
|
|
4
|
-
declare const
|
|
1
|
+
export declare const StreamableJSONFormats: readonly ["JSONEachRow", "JSONStringsEachRow", "JSONCompactEachRow", "JSONCompactStringsEachRow", "JSONCompactEachRowWithNames", "JSONCompactEachRowWithNamesAndTypes", "JSONCompactStringsEachRowWithNames", "JSONCompactStringsEachRowWithNamesAndTypes"];
|
|
2
|
+
export declare const RecordsJSONFormats: readonly ["JSONObjectEachRow"];
|
|
3
|
+
export declare const SingleDocumentJSONFormats: readonly ["JSON", "JSONStrings", "JSONCompact", "JSONCompactStrings", "JSONColumnsWithMetadata"];
|
|
4
|
+
export declare const SupportedJSONFormats: readonly ["JSONObjectEachRow", "JSON", "JSONStrings", "JSONCompact", "JSONCompactStrings", "JSONColumnsWithMetadata", "JSONEachRow", "JSONStringsEachRow", "JSONCompactEachRow", "JSONCompactStringsEachRow", "JSONCompactEachRowWithNames", "JSONCompactEachRowWithNamesAndTypes", "JSONCompactStringsEachRowWithNames", "JSONCompactStringsEachRowWithNamesAndTypes"];
|
|
5
|
+
export declare const SupportedRawFormats: readonly ["CSV", "CSVWithNames", "CSVWithNamesAndTypes", "TabSeparated", "TabSeparatedRaw", "TabSeparatedWithNames", "TabSeparatedWithNamesAndTypes", "CustomSeparated", "CustomSeparatedWithNames", "CustomSeparatedWithNamesAndTypes", "Parquet"];
|
|
6
|
+
export declare const StreamableFormats: readonly ["JSONEachRow", "JSONStringsEachRow", "JSONCompactEachRow", "JSONCompactStringsEachRow", "JSONCompactEachRowWithNames", "JSONCompactEachRowWithNamesAndTypes", "JSONCompactStringsEachRowWithNames", "JSONCompactStringsEachRowWithNamesAndTypes", "CSV", "CSVWithNames", "CSVWithNamesAndTypes", "TabSeparated", "TabSeparatedRaw", "TabSeparatedWithNames", "TabSeparatedWithNamesAndTypes", "CustomSeparated", "CustomSeparatedWithNames", "CustomSeparatedWithNamesAndTypes", "Parquet"];
|
|
5
7
|
/** CSV, TSV, etc. - can be streamed, but cannot be decoded as JSON. */
|
|
6
|
-
export type RawDataFormat = (typeof
|
|
8
|
+
export type RawDataFormat = (typeof SupportedRawFormats)[number];
|
|
7
9
|
/** Each row is returned as a separate JSON object or an array, and these formats can be streamed. */
|
|
8
|
-
export type StreamableJSONDataFormat = (typeof
|
|
10
|
+
export type StreamableJSONDataFormat = (typeof StreamableJSONFormats)[number];
|
|
9
11
|
/** Returned as a single {@link ResponseJSON} object, cannot be streamed. */
|
|
10
|
-
export type SingleDocumentJSONFormat = (typeof
|
|
12
|
+
export type SingleDocumentJSONFormat = (typeof SingleDocumentJSONFormats)[number];
|
|
11
13
|
/** Returned as a single object { row_1: T, row_2: T, ...} <br/>
|
|
12
14
|
* (i.e. Record<string, T>), cannot be streamed. */
|
|
13
|
-
export type RecordsJSONFormat = (typeof
|
|
15
|
+
export type RecordsJSONFormat = (typeof RecordsJSONFormats)[number];
|
|
14
16
|
/** All allowed JSON formats, whether streamable or not. */
|
|
15
17
|
export type JSONDataFormat = StreamableJSONDataFormat | SingleDocumentJSONFormat | RecordsJSONFormat;
|
|
16
18
|
/** Data formats that are currently supported by the client. <br/>
|
|
@@ -23,9 +25,8 @@ export type JSONDataFormat = StreamableJSONDataFormat | SingleDocumentJSONFormat
|
|
|
23
25
|
* * {@link RecordsJSONFormat}
|
|
24
26
|
* @see https://clickhouse.com/docs/en/interfaces/formats */
|
|
25
27
|
export type DataFormat = JSONDataFormat | RawDataFormat;
|
|
26
|
-
declare const streamableFormat: readonly ["JSONEachRow", "JSONStringsEachRow", "JSONCompactEachRow", "JSONCompactStringsEachRow", "JSONCompactEachRowWithNames", "JSONCompactEachRowWithNamesAndTypes", "JSONCompactStringsEachRowWithNames", "JSONCompactStringsEachRowWithNamesAndTypes", "CSV", "CSVWithNames", "CSVWithNamesAndTypes", "TabSeparated", "TabSeparatedRaw", "TabSeparatedWithNames", "TabSeparatedWithNamesAndTypes", "CustomSeparated", "CustomSeparatedWithNames", "CustomSeparatedWithNamesAndTypes", "Parquet"];
|
|
27
28
|
/** All data formats that can be streamed, whether it can be decoded as JSON or not. */
|
|
28
|
-
export type StreamableDataFormat = (typeof
|
|
29
|
+
export type StreamableDataFormat = (typeof StreamableFormats)[number];
|
|
29
30
|
export declare function isNotStreamableJSONFamily(format: DataFormat): format is SingleDocumentJSONFormat;
|
|
30
31
|
export declare function isStreamableJSONFamily(format: DataFormat): format is StreamableJSONDataFormat;
|
|
31
32
|
export declare function isSupportedRawFormat(dataFormat: DataFormat): boolean;
|
|
@@ -37,4 +38,3 @@ export declare function validateStreamFormat(format: any): format is StreamableD
|
|
|
37
38
|
* @returns string
|
|
38
39
|
*/
|
|
39
40
|
export declare function encodeJSON(value: any, format: DataFormat): string;
|
|
40
|
-
export {};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.encodeJSON = exports.validateStreamFormat = exports.isSupportedRawFormat = exports.isStreamableJSONFamily = exports.isNotStreamableJSONFamily = void 0;
|
|
4
|
-
|
|
3
|
+
exports.encodeJSON = exports.validateStreamFormat = exports.isSupportedRawFormat = exports.isStreamableJSONFamily = exports.isNotStreamableJSONFamily = exports.StreamableFormats = exports.SupportedRawFormats = exports.SupportedJSONFormats = exports.SingleDocumentJSONFormats = exports.RecordsJSONFormats = exports.StreamableJSONFormats = void 0;
|
|
4
|
+
exports.StreamableJSONFormats = [
|
|
5
5
|
'JSONEachRow',
|
|
6
6
|
'JSONStringsEachRow',
|
|
7
7
|
'JSONCompactEachRow',
|
|
@@ -11,20 +11,20 @@ const streamableJSONFormats = [
|
|
|
11
11
|
'JSONCompactStringsEachRowWithNames',
|
|
12
12
|
'JSONCompactStringsEachRowWithNamesAndTypes',
|
|
13
13
|
];
|
|
14
|
-
|
|
15
|
-
|
|
14
|
+
exports.RecordsJSONFormats = ['JSONObjectEachRow'];
|
|
15
|
+
exports.SingleDocumentJSONFormats = [
|
|
16
16
|
'JSON',
|
|
17
17
|
'JSONStrings',
|
|
18
18
|
'JSONCompact',
|
|
19
19
|
'JSONCompactStrings',
|
|
20
20
|
'JSONColumnsWithMetadata',
|
|
21
21
|
];
|
|
22
|
-
|
|
23
|
-
...
|
|
24
|
-
...
|
|
25
|
-
...
|
|
22
|
+
exports.SupportedJSONFormats = [
|
|
23
|
+
...exports.RecordsJSONFormats,
|
|
24
|
+
...exports.SingleDocumentJSONFormats,
|
|
25
|
+
...exports.StreamableJSONFormats,
|
|
26
26
|
];
|
|
27
|
-
|
|
27
|
+
exports.SupportedRawFormats = [
|
|
28
28
|
'CSV',
|
|
29
29
|
'CSVWithNames',
|
|
30
30
|
'CSVWithNamesAndTypes',
|
|
@@ -37,26 +37,26 @@ const supportedRawFormats = [
|
|
|
37
37
|
'CustomSeparatedWithNamesAndTypes',
|
|
38
38
|
'Parquet',
|
|
39
39
|
];
|
|
40
|
-
|
|
41
|
-
...
|
|
42
|
-
...
|
|
40
|
+
exports.StreamableFormats = [
|
|
41
|
+
...exports.StreamableJSONFormats,
|
|
42
|
+
...exports.SupportedRawFormats,
|
|
43
43
|
];
|
|
44
44
|
function isNotStreamableJSONFamily(format) {
|
|
45
|
-
return (
|
|
46
|
-
|
|
45
|
+
return (exports.SingleDocumentJSONFormats.includes(format) ||
|
|
46
|
+
exports.RecordsJSONFormats.includes(format));
|
|
47
47
|
}
|
|
48
48
|
exports.isNotStreamableJSONFamily = isNotStreamableJSONFamily;
|
|
49
49
|
function isStreamableJSONFamily(format) {
|
|
50
|
-
return
|
|
50
|
+
return exports.StreamableJSONFormats.includes(format);
|
|
51
51
|
}
|
|
52
52
|
exports.isStreamableJSONFamily = isStreamableJSONFamily;
|
|
53
53
|
function isSupportedRawFormat(dataFormat) {
|
|
54
|
-
return
|
|
54
|
+
return exports.SupportedRawFormats.includes(dataFormat);
|
|
55
55
|
}
|
|
56
56
|
exports.isSupportedRawFormat = isSupportedRawFormat;
|
|
57
57
|
function validateStreamFormat(format) {
|
|
58
|
-
if (!
|
|
59
|
-
throw new Error(`${format} format is not streamable. Streamable formats: ${
|
|
58
|
+
if (!exports.StreamableFormats.includes(format)) {
|
|
59
|
+
throw new Error(`${format} format is not streamable. Streamable formats: ${exports.StreamableFormats.join(',')}`);
|
|
60
60
|
}
|
|
61
61
|
return true;
|
|
62
62
|
}
|
|
@@ -68,7 +68,7 @@ exports.validateStreamFormat = validateStreamFormat;
|
|
|
68
68
|
* @returns string
|
|
69
69
|
*/
|
|
70
70
|
function encodeJSON(value, format) {
|
|
71
|
-
if (
|
|
71
|
+
if (exports.SupportedJSONFormats.includes(format)) {
|
|
72
72
|
return JSON.stringify(value) + '\n';
|
|
73
73
|
}
|
|
74
74
|
throw new Error(`The client does not support JSON encoding in [${format}] format.`);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../../packages/client-common/src/data_formatter/formatter.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../../packages/client-common/src/data_formatter/formatter.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG;IACnC,aAAa;IACb,oBAAoB;IACpB,oBAAoB;IACpB,2BAA2B;IAC3B,6BAA6B;IAC7B,qCAAqC;IACrC,oCAAoC;IACpC,4CAA4C;CACpC,CAAA;AACG,QAAA,kBAAkB,GAAG,CAAC,mBAAmB,CAAU,CAAA;AACnD,QAAA,yBAAyB,GAAG;IACvC,MAAM;IACN,aAAa;IACb,aAAa;IACb,oBAAoB;IACpB,yBAAyB;CACjB,CAAA;AACG,QAAA,oBAAoB,GAAG;IAClC,GAAG,0BAAkB;IACrB,GAAG,iCAAyB;IAC5B,GAAG,6BAAqB;CAChB,CAAA;AACG,QAAA,mBAAmB,GAAG;IACjC,KAAK;IACL,cAAc;IACd,sBAAsB;IACtB,cAAc;IACd,iBAAiB;IACjB,uBAAuB;IACvB,+BAA+B;IAC/B,iBAAiB;IACjB,0BAA0B;IAC1B,kCAAkC;IAClC,SAAS;CACD,CAAA;AACG,QAAA,iBAAiB,GAAG;IAC/B,GAAG,6BAAqB;IACxB,GAAG,2BAAmB;CACd,CAAA;AAoCV,SAAgB,yBAAyB,CACvC,MAAkB;IAElB,OAAO,CACJ,iCAA+C,CAAC,QAAQ,CAAC,MAAM,CAAC;QAChE,0BAAwC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAC3D,CAAA;AACH,CAAC;AAPD,8DAOC;AAED,SAAgB,sBAAsB,CACpC,MAAkB;IAElB,OAAQ,6BAA2C,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;AACtE,CAAC;AAJD,wDAIC;AAED,SAAgB,oBAAoB,CAAC,UAAsB;IACzD,OAAQ,2BAAyC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;AACxE,CAAC;AAFD,oDAEC;AAED,SAAgB,oBAAoB,CAClC,MAAW;IAEX,IAAI,CAAC,yBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CACb,GAAG,MAAM,kDAAkD,yBAAiB,CAAC,IAAI,CAC/E,GAAG,CACJ,EAAE,CACJ,CAAA;IACH,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAXD,oDAWC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,KAAU,EAAE,MAAkB;IACvD,IAAK,4BAA0C,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACjE,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;IACrC,CAAC;IACD,MAAM,IAAI,KAAK,CACb,iDAAiD,MAAM,WAAW,CACnE,CAAA;AACH,CAAC;AAPD,gCAOC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
export { type BaseQueryParams, type QueryParams, type QueryResult, type ExecParams, type InsertParams, type InsertValues, ClickHouseClient, type CommandParams, type CommandResult, type ExecResult, type InsertResult, type PingResult, } from './client';
|
|
3
3
|
export { type BaseClickHouseClientConfigOptions } from './config';
|
|
4
4
|
export type { Row, BaseResultSet, ResultJSONType, RowJSONType, ResultStream, } from './result';
|
|
5
|
-
export type { DataFormat, RawDataFormat, JSONDataFormat, StreamableDataFormat, StreamableJSONDataFormat, SingleDocumentJSONFormat, } from './data_formatter';
|
|
5
|
+
export type { DataFormat, RawDataFormat, JSONDataFormat, StreamableDataFormat, StreamableJSONDataFormat, SingleDocumentJSONFormat, SupportedJSONFormats, SupportedRawFormats, StreamableFormats, StreamableJSONFormats, SingleDocumentJSONFormats, RecordsJSONFormats, } from './data_formatter';
|
|
6
6
|
export { ClickHouseError } from './error';
|
|
7
7
|
export { ClickHouseLogLevel, type ErrorLogParams, type WarnLogParams, type Logger, type LogParams, } from './logger';
|
|
8
|
-
export type { ClickHouseSummary,
|
|
8
|
+
export type { ClickHouseSummary, InputJSON, InputJSONObjectEachRow, ResponseJSON, ResponseHeaders, WithClickHouseSummary, WithResponseHeaders, } from './clickhouse_types';
|
|
9
9
|
export { type ClickHouseSettings, type MergeTreeSettings, SettingsMap, } from './settings';
|
|
10
10
|
/** For implementations usage only - should not be re-exported */
|
|
11
11
|
export { formatQuerySettings, formatQueryParams, encodeJSON, isSupportedRawFormat, isStreamableJSONFamily, isNotStreamableJSONFamily, validateStreamFormat, } from './data_formatter';
|
|
@@ -13,6 +13,6 @@ export { type ValuesEncoder, type MakeResultSet, type MakeConnection, type Handl
|
|
|
13
13
|
export { withCompressionHeaders, isSuccessfulResponse, toSearchParams, transformUrl, withHttpSettings, } from './utils';
|
|
14
14
|
export { LogWriter, DefaultLogger, type LogWriterParams } from './logger';
|
|
15
15
|
export { parseError } from './error';
|
|
16
|
-
export type { CompressionSettings, Connection, ConnectionParams, ConnInsertResult, ConnExecResult, ConnQueryResult, ConnBaseQueryParams, ConnBaseResult, ConnInsertParams, ConnPingResult, ConnCommandResult, ConnOperation, } from './connection';
|
|
16
|
+
export type { CompressionSettings, Connection, ConnectionParams, ConnInsertResult, ConnExecParams, ConnExecResult, ConnQueryResult, ConnBaseQueryParams, ConnBaseResult, ConnInsertParams, ConnPingResult, ConnCommandResult, ConnOperation, } from './connection';
|
|
17
17
|
export type { QueryParamsWithFormat } from './client';
|
|
18
18
|
export type { IsSame } from './ts_utils';
|
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,mCAaiB;AANf,0GAAA,gBAAgB,OAAA;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/client-common/src/index.ts"],"names":[],"mappings":";;;AAAA,kDAAkD;AAClD,mCAaiB;AANf,0GAAA,gBAAgB,OAAA;AA6BlB,iCAAyC;AAAhC,wGAAA,eAAe,OAAA;AACxB,mCAMiB;AALf,4GAAA,kBAAkB,OAAA;AAepB,uCAImB;AADjB,uGAAA,WAAW,OAAA;AAGb,iEAAiE;AACjE,mDAQyB;AAPvB,qHAAA,mBAAmB,OAAA;AACnB,mHAAA,iBAAiB,OAAA;AACjB,4GAAA,UAAU,OAAA;AACV,sHAAA,oBAAoB,OAAA;AACpB,wHAAA,sBAAsB,OAAA;AACtB,2HAAA,yBAAyB,OAAA;AACzB,sHAAA,oBAAoB,OAAA;AAEtB,mCAUiB;AAJf,+GAAA,qBAAqB,OAAA;AACrB,4GAAA,kBAAkB,OAAA;AAClB,6GAAA,mBAAmB,OAAA;AACnB,8GAAA,oBAAoB,OAAA;AAEtB,iCAMgB;AALd,+GAAA,sBAAsB,OAAA;AACtB,6GAAA,oBAAoB,OAAA;AACpB,uGAAA,cAAc,OAAA;AACd,qGAAA,YAAY,OAAA;AACZ,yGAAA,gBAAgB,OAAA;AAElB,mCAAyE;AAAhE,mGAAA,SAAS,OAAA;AAAE,uGAAA,aAAa,OAAA;AACjC,iCAAoC;AAA3B,mGAAA,UAAU,OAAA"}
|
package/dist/result.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ResponseJSON } from './clickhouse_types';
|
|
1
|
+
import type { ResponseHeaders, ResponseJSON } from './clickhouse_types';
|
|
2
2
|
import type { DataFormat, RawDataFormat, RecordsJSONFormat, SingleDocumentJSONFormat, StreamableDataFormat, StreamableJSONDataFormat } from './data_formatter';
|
|
3
3
|
export type ResultStream<Format extends DataFormat | unknown, Stream> = Format extends StreamableDataFormat ? Stream : Format extends SingleDocumentJSONFormat ? never : Format extends RecordsJSONFormat ? never : Stream;
|
|
4
4
|
export type ResultJSONType<T, F extends DataFormat | unknown> = F extends StreamableJSONDataFormat ? T[] : F extends SingleDocumentJSONFormat ? ResponseJSON<T> : F extends RecordsJSONFormat ? Record<string, T> : F extends RawDataFormat ? never : // happens only when Format could not be inferred from a literal
|
|
@@ -82,4 +82,6 @@ export interface BaseResultSet<Stream, Format extends DataFormat | unknown> {
|
|
|
82
82
|
close(): void;
|
|
83
83
|
/** ClickHouse server QueryID. */
|
|
84
84
|
query_id: string;
|
|
85
|
+
/** Response headers. */
|
|
86
|
+
response_headers: ResponseHeaders;
|
|
85
87
|
}
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const _default: "1.
|
|
1
|
+
declare const _default: "1.4.0";
|
|
2
2
|
export default _default;
|
package/dist/version.js
CHANGED
package/package.json
CHANGED