@clickhouse/client 0.0.7 → 0.0.9
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/README.md +3 -366
- package/dist/client.d.ts +13 -2
- package/dist/client.js +18 -1
- package/dist/client.js.map +1 -1
- package/dist/connection/adapter/base_http_adapter.d.ts +2 -1
- package/dist/connection/adapter/base_http_adapter.js +9 -6
- package/dist/connection/adapter/base_http_adapter.js.map +1 -1
- package/dist/connection/adapter/http_search_params.d.ts +2 -1
- package/dist/connection/adapter/http_search_params.js +4 -1
- package/dist/connection/adapter/http_search_params.js.map +1 -1
- package/dist/connection/adapter/https_adapter.d.ts +1 -0
- package/dist/connection/adapter/https_adapter.js +21 -0
- package/dist/connection/adapter/https_adapter.js.map +1 -1
- package/dist/connection/connection.d.ts +12 -0
- package/dist/connection/connection.js.map +1 -1
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -12,383 +12,20 @@
|
|
|
12
12
|
</a>
|
|
13
13
|
</p>
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## About
|
|
16
16
|
|
|
17
17
|
Official Node.js client for [ClickHouse](https://clickhouse.com/), written purely in TypeScript, thoroughly tested with actual ClickHouse versions.
|
|
18
18
|
|
|
19
19
|
It is focused on data streaming for both inserts and selects using standard [Node.js Streaming API](https://nodejs.org/docs/latest-v14.x/api/stream.html).
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## Documentation
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
| Node.js | ClickHouse | Status |
|
|
26
|
-
| ------- | ---------- | ------ |
|
|
27
|
-
| 14.x | 22.8 | ✔ |
|
|
28
|
-
| 16.x | 22.8 | ✔ |
|
|
29
|
-
| 18.x | 22.8 | ✔ |
|
|
30
|
-
| 14.x | 22.9 | ✔ |
|
|
31
|
-
| 16.x | 22.9 | ✔ |
|
|
32
|
-
| 18.x | 22.9 | ✔ |
|
|
33
|
-
|
|
34
|
-
## Installation
|
|
35
|
-
|
|
36
|
-
```bash
|
|
37
|
-
npm i @clickhouse/client
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
## Connection
|
|
41
|
-
|
|
42
|
-
Currently, only HTTP(s) protocol is supported.
|
|
43
|
-
|
|
44
|
-
A very basic connection to a single local ClickHouse instance with default settings (for example, if it is running as a Docker container as described in the [contribution guide](./CONTRIBUTING.md)):
|
|
45
|
-
|
|
46
|
-
```ts
|
|
47
|
-
import { createClient } from '@clickhouse/client'
|
|
48
|
-
|
|
49
|
-
const client = createClient()
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
Basic HTTPS connection:
|
|
53
|
-
|
|
54
|
-
```ts
|
|
55
|
-
import { createClient } from '@clickhouse/client'
|
|
56
|
-
|
|
57
|
-
const client = createClient({
|
|
58
|
-
host: `https://<YOUR_CLICKHOUSE_HOST>:8443`,
|
|
59
|
-
password: '<YOUR_CLICKHOUSE_PASSWORD>',
|
|
60
|
-
database: '<YOUR_CLICKHOUSE_DATABASE>',
|
|
61
|
-
})
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
Using custom ClickHouse settings and forced HTTP compression (GZIP) for both request and response:
|
|
65
|
-
|
|
66
|
-
```ts
|
|
67
|
-
import { createClient } from '@clickhouse/client'
|
|
68
|
-
|
|
69
|
-
const client = createClient({
|
|
70
|
-
host: `https://<YOUR_CLICKHOUSE_HOST>:8443`,
|
|
71
|
-
password: '<YOUR_CLICKHOUSE_PASSWORD>',
|
|
72
|
-
database: '<YOUR_CLICKHOUSE_DATABASE>',
|
|
73
|
-
compression: {
|
|
74
|
-
request: true,
|
|
75
|
-
response: true,
|
|
76
|
-
},
|
|
77
|
-
clickhouse_settings: {
|
|
78
|
-
insert_quorum: '2',
|
|
79
|
-
},
|
|
80
|
-
})
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
Closing the connection:
|
|
84
|
-
|
|
85
|
-
```ts
|
|
86
|
-
await client.close()
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
### Connection settings overview
|
|
90
|
-
|
|
91
|
-
See [ClickHouseClientConfigOptions](https://github.com/ClickHouse/clickhouse-js/blob/60c484a3492420baed4b4c6c33cc0845262285e7/src/client.ts#L13-L35)
|
|
92
|
-
|
|
93
|
-
```ts
|
|
94
|
-
export interface ClickHouseClientConfigOptions {
|
|
95
|
-
// a valid URL, for example, https://myclickhouseserver.org:8123
|
|
96
|
-
// if unset, defaults to http://localhost:8123
|
|
97
|
-
host?: string
|
|
98
|
-
|
|
99
|
-
// milliseconds, default 10_000
|
|
100
|
-
connect_timeout?: number
|
|
101
|
-
|
|
102
|
-
// milliseconds, default 300_000
|
|
103
|
-
request_timeout?: number
|
|
104
|
-
|
|
105
|
-
// For HTTP protocol, the connection pool has infinite size by default
|
|
106
|
-
// it can be overriden with this setting
|
|
107
|
-
max_open_connections?: number
|
|
108
|
-
|
|
109
|
-
// HTTP compression settings. Uses GZIP.
|
|
110
|
-
// For more details, see https://clickhouse.com/docs/en/interfaces/http/#compression
|
|
111
|
-
compression?: {
|
|
112
|
-
// enabled by default - the server will compress the data it sends to you in the response
|
|
113
|
-
response?: boolean
|
|
114
|
-
// disabled by default - the server will decompress the data which you pass in the request
|
|
115
|
-
request?: boolean
|
|
116
|
-
}
|
|
117
|
-
|
|
118
|
-
// if not set, 'default' is used
|
|
119
|
-
username?: string
|
|
120
|
-
|
|
121
|
-
// if not set, an empty password is used
|
|
122
|
-
password?: string
|
|
123
|
-
|
|
124
|
-
// used to identify the connection on the server side, if not set, uses 'clickhouse-js'
|
|
125
|
-
application?: string
|
|
126
|
-
|
|
127
|
-
// if not set, 'default' is used
|
|
128
|
-
database?: string
|
|
129
|
-
|
|
130
|
-
// additional settings to send with every query, such as `date_time_input_format` or `insert_quorum`
|
|
131
|
-
// see https://clickhouse.com/docs/en/operations/settings/settings/
|
|
132
|
-
// typings should support most of the options listed there
|
|
133
|
-
clickhouse_settings?: ClickHouseSettings
|
|
134
|
-
|
|
135
|
-
// logger settings
|
|
136
|
-
log?: {
|
|
137
|
-
// disabled by default, can be enabled using this setting
|
|
138
|
-
enable?: boolean
|
|
139
|
-
// use it to override default clickhouse-js logger with your own implementation
|
|
140
|
-
LoggerClass?: new (enabled: boolean) => Logger
|
|
141
|
-
}
|
|
142
|
-
}
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
See also:
|
|
146
|
-
|
|
147
|
-
- [ClickHouseSettings](https://github.com/ClickHouse/clickhouse-js/blob/730b1b2516e2d47dc9a32b1d8d0b8ba8ceb95ead/src/settings.ts#L10-L1201)
|
|
148
|
-
|
|
149
|
-
- [Logger](https://github.com/ClickHouse/clickhouse-js/blob/ebdcab7a5d00d53bbbe46cce45c14bbcfda93f0c/src/logger.ts)
|
|
150
|
-
|
|
151
|
-
## Supported formats
|
|
152
|
-
|
|
153
|
-
| Format | Input (array) | Input (stream) | Input (object) | Output (JSON) | Output (text) |
|
|
154
|
-
| ------------------------------------------ | ------------- | -------------- | -------------- | ------------- | ------------- |
|
|
155
|
-
| JSON | ❌ | ❌ | ✔️ | ✔️ | ✔️ |
|
|
156
|
-
| JSONObjectEachRow | ❌ | ❌ | ✔️ | ✔️ | ✔️ |
|
|
157
|
-
| JSONEachRow | ✔️ | ✔️ | ❌️ | ✔️ | ✔️ |
|
|
158
|
-
| JSONStringsEachRow | ✔️ | ✔️ | ❌️ | ✔️ | ✔️ |
|
|
159
|
-
| JSONCompactEachRow | ✔️ | ✔️ | ❌️ | ✔️ | ✔️ |
|
|
160
|
-
| JSONCompactStringsEachRow | ✔️ | ✔️ | ❌️ | ✔️ | ✔️ |
|
|
161
|
-
| JSONCompactEachRowWithNames | ✔️ | ✔️ | ❌️ | ✔️ | ✔️ |
|
|
162
|
-
| JSONCompactEachRowWithNamesAndTypes | ✔️ | ✔️ | ❌️ | ✔️ | ✔️ |
|
|
163
|
-
| JSONCompactStringsEachRowWithNames | ✔️ | ✔️ | ❌️ | ✔️ | ✔️ |
|
|
164
|
-
| JSONCompactStringsEachRowWithNamesAndTypes | ✔️ | ✔️ | ❌️ | ✔️ | ✔️ |
|
|
165
|
-
| CSV | ❌ | ✔️ | ❌ | ❌ | ✔️ |
|
|
166
|
-
| CSVWithNames | ❌ | ✔️ | ❌ | ❌ | ✔️ |
|
|
167
|
-
| CSVWithNamesAndTypes | ❌ | ✔️ | ❌ | ❌ | ✔️ |
|
|
168
|
-
| TabSeparated | ❌ | ✔️ | ❌ | ❌ | ✔️ |
|
|
169
|
-
| TabSeparatedRaw | ❌ | ✔️ | ❌ | ❌ | ✔️ |
|
|
170
|
-
| TabSeparatedWithNames | ❌ | ✔️ | ❌ | ❌ | ✔️ |
|
|
171
|
-
| TabSeparatedWithNamesAndTypes | ❌ | ✔️ | ❌ | ❌ | ✔️ |
|
|
172
|
-
| CustomSeparated | ❌ | ✔️ | ❌ | ❌ | ✔️ |
|
|
173
|
-
| CustomSeparatedWithNames | ❌ | ✔️ | ❌ | ❌ | ✔️ |
|
|
174
|
-
| CustomSeparatedWithNamesAndTypes | ❌ | ✔️ | ❌ | ❌ | ✔️ |
|
|
175
|
-
|
|
176
|
-
The entire list of ClickHouse input and output formats is available [here](https://clickhouse.com/docs/en/interfaces/formats).
|
|
177
|
-
|
|
178
|
-
## Supported ClickHouse data types
|
|
179
|
-
|
|
180
|
-
| Type | Status | JS type |
|
|
181
|
-
| -------------- | --------------- | ------------------------------------- |
|
|
182
|
-
| UInt8/16/32 | ✔️ | number |
|
|
183
|
-
| UInt64/128/256 | ✔️❗- see below | string |
|
|
184
|
-
| Int8/16/32 | ✔️ | number |
|
|
185
|
-
| Int64/128/256 | ✔️❗- see below | string |
|
|
186
|
-
| Float32/64 | ✔️ | number |
|
|
187
|
-
| Decimal | ✔️❗- see below | number |
|
|
188
|
-
| Boolean | ✔️ | boolean |
|
|
189
|
-
| String | ✔️ | string |
|
|
190
|
-
| FixedString | ✔️ | string |
|
|
191
|
-
| UUID | ✔️ | string |
|
|
192
|
-
| Date32/64 | ✔️❗- see below | string |
|
|
193
|
-
| DateTime32/64 | ✔️❗- see below | string |
|
|
194
|
-
| Enum | ✔️ | string |
|
|
195
|
-
| LowCardinality | ✔️ | string |
|
|
196
|
-
| Array(T) | ✔️ | Array\<JS type for T> |
|
|
197
|
-
| JSON | ✔️ | object |
|
|
198
|
-
| Nested | ❌ | - |
|
|
199
|
-
| Tuple | ✔️ | Tuple |
|
|
200
|
-
| Nullable(T) | ✔️ | JS type for T or null |
|
|
201
|
-
| IPv4 | ✔️ | string |
|
|
202
|
-
| IPv6 | ✔️ | string |
|
|
203
|
-
| Point | ✔️ | [ number, number ] |
|
|
204
|
-
| Ring | ✔️ | Array\<Point> |
|
|
205
|
-
| Polygon | ✔️ | Array\<Ring> |
|
|
206
|
-
| MultiPolygon | ✔️ | Array\<Polygon> |
|
|
207
|
-
| Map(K, V) | ✔️ | Record\<JS type for K, JS type for V> |
|
|
208
|
-
|
|
209
|
-
The entire list of supported ClickHouse formats is available [here](https://clickhouse.com/docs/en/sql-reference/data-types/).
|
|
210
|
-
|
|
211
|
-
### Date* / DateTime* types caveats:
|
|
212
|
-
|
|
213
|
-
Since we use data streaming for inserts without the `VALUES` clause (which does additional type conversion), Date\* type columns can be only inserted as strings and not as Unix time epoch. It can be possibly changed with the future ClickHouse database releases. Please refer to the corresponding [integration tests](https://github.com/ClickHouse/clickhouse-js/blob/ba387d7f4ce375a60982ac2d99cb47391cf76cec/__tests__/integration/date_time.test.ts) for more examples.
|
|
214
|
-
|
|
215
|
-
### Decimal\* types caveats:
|
|
216
|
-
|
|
217
|
-
Since we do not use `VALUES` clause and there is no additional type conversion, it is not possible to insert Decimal* type columns as strings, only as numbers. This is a suboptimal approach as it might end in float precision loss. Thus, it is recommended to avoid JSON* formats when using Decimals as of now. Consider TabSeparated* / CSV* / CustomSeparated\* formats families for that kind of workflows. Please refer to the [data types tests](https://github.com/ClickHouse/clickhouse-js/blob/c1b70c82f525c39edb3ca1ee05cb5e6b43dba5b3/__tests__/integration/data_types.test.ts#L98-L131) for more concrete examples on how to avoid precision loss.
|
|
218
|
-
|
|
219
|
-
### NB: Int64, Int128, Int256, UInt64, UInt128, UInt256
|
|
220
|
-
|
|
221
|
-
Though the server can accept it as a number, it is by default returned as a string in JSON\* family output formats to avoid integer overflow as max values for these types are bigger than `Number.MAX_SAFE_INTEGER`.
|
|
222
|
-
|
|
223
|
-
This behavior, however, can be modified with [`output_format_json_quote_64bit_integers` setting](https://clickhouse.com/docs/en/operations/settings/settings/#output_format_json_quote_64bit_integers).
|
|
224
|
-
|
|
225
|
-
## ClickHouse client API overview
|
|
226
|
-
|
|
227
|
-
### Query
|
|
228
|
-
|
|
229
|
-
Used for most statements that can have a response, such as `SELECT`, or for sending DDLs such as `CREATE TABLE`. For data insertion, please consider using the dedicated method `insert` which is described next.
|
|
230
|
-
|
|
231
|
-
```ts
|
|
232
|
-
interface QueryParams {
|
|
233
|
-
// Query to execute that might return some data
|
|
234
|
-
// IMPORTANT: do not specify the FORMAT clause here
|
|
235
|
-
// use `format` param instead.
|
|
236
|
-
query: string
|
|
237
|
-
// Desired OUTPUT data format to be appended the query as ` FORMAT $format`
|
|
238
|
-
// It is extracted to the separate param
|
|
239
|
-
// as we may need to apply some additional request logic
|
|
240
|
-
// based on the desired format
|
|
241
|
-
format?: DataFormat
|
|
242
|
-
// ClickHouse settings that can be applied on query level, such as `date_time_input_format`
|
|
243
|
-
clickhouse_settings?: ClickHouseSettings
|
|
244
|
-
// See https://clickhouse.com/docs/en/interfaces/http/#cli-queries-with-parameters for more details
|
|
245
|
-
// IMPORTANT: that you should not prefix it with `param_` here, client will do that for you
|
|
246
|
-
query_params?: Record<string, unknown>
|
|
247
|
-
// A query can be aborted using this standard AbortSignal instance
|
|
248
|
-
// Please refer to the usage examples for more details
|
|
249
|
-
abort_signal?: AbortSignal
|
|
250
|
-
}
|
|
251
|
-
|
|
252
|
-
class ClickHouseClient {
|
|
253
|
-
query(params: QueryParams): Promise<Rows> {}
|
|
254
|
-
// ...
|
|
255
|
-
}
|
|
256
|
-
```
|
|
257
|
-
|
|
258
|
-
#### ResultSet response abstraction
|
|
259
|
-
|
|
260
|
-
Provides several convenience methods for data processing of select results in your application.
|
|
261
|
-
|
|
262
|
-
```ts
|
|
263
|
-
class ResultSet {
|
|
264
|
-
// Consume the entire stream and get the contents as a string
|
|
265
|
-
// Can be used with any DataFormat
|
|
266
|
-
// Should be called only once
|
|
267
|
-
text(): Promise<string> {}
|
|
268
|
-
// Consume the entire stream and get the contents as a JS object
|
|
269
|
-
// Can be used only with JSON formats
|
|
270
|
-
// Should be called only once
|
|
271
|
-
json<T>(): Promise<T> {}
|
|
272
|
-
// Returns a readable stream for responses that can be streamed (i.e. all except JSON)
|
|
273
|
-
// Every iteration provides an array of `Row` instances
|
|
274
|
-
// Should be called only once
|
|
275
|
-
// NB: if called for the second time, the second stream will be just empty
|
|
276
|
-
stream(): Stream.Readable {}
|
|
277
|
-
}
|
|
278
|
-
|
|
279
|
-
interface Row {
|
|
280
|
-
// Get the content of an individual row as a plain string
|
|
281
|
-
text(): string
|
|
282
|
-
// Get the content of an individual row as a JS object
|
|
283
|
-
json<T>(): T
|
|
284
|
-
}
|
|
285
|
-
```
|
|
286
|
-
|
|
287
|
-
### Insert
|
|
288
|
-
|
|
289
|
-
Primary method for data insertion. It can work with both `Stream.Readable` (all formats except `JSON`) and plain `Array<T>` (`JSON*` family formats only). It is recommended to avoid arrays in case of large inserts to reduce application memory consumption, and consider streaming for most of the use cases.
|
|
290
|
-
|
|
291
|
-
Should be awaited, but it does not return anything.
|
|
292
|
-
|
|
293
|
-
```ts
|
|
294
|
-
interface InsertParams<T> {
|
|
295
|
-
// Table name to insert the data into
|
|
296
|
-
table: string
|
|
297
|
-
// Stream.Readable will work for all formats except JSON
|
|
298
|
-
// Array will work only for JSON* formats
|
|
299
|
-
values: ReadonlyArray<T> | Stream.Readable
|
|
300
|
-
// Desired INPUT data format to be appended the statement as ` FORMAT $format`
|
|
301
|
-
// It is extracted to the separate param
|
|
302
|
-
// as we may need to apply some additional request logic
|
|
303
|
-
// based on the desired format
|
|
304
|
-
format?: DataFormat
|
|
305
|
-
// ClickHouse settings that can be applied on statement level, such as `insert_quorum`
|
|
306
|
-
clickhouse_settings?: ClickHouseSettings
|
|
307
|
-
// See https://clickhouse.com/docs/en/interfaces/http/#cli-queries-with-parameters for more details
|
|
308
|
-
// IMPORTANT: that you should not prefix it with `param_` here, client will do that for you
|
|
309
|
-
query_params?: Record<string, unknown>
|
|
310
|
-
// A query can be aborted using this standard AbortSignal instance
|
|
311
|
-
// Please refer to the usage examples for more details
|
|
312
|
-
abort_signal?: AbortSignal
|
|
313
|
-
}
|
|
314
|
-
|
|
315
|
-
class ClickHouseClient {
|
|
316
|
-
insert(params: InsertParams): Promise<void> {}
|
|
317
|
-
// ...
|
|
318
|
-
}
|
|
319
|
-
```
|
|
320
|
-
|
|
321
|
-
### Exec
|
|
322
|
-
|
|
323
|
-
Can be used for statements that do not have any output, when format clause is not applicable, or when you are not interested in the response at all. An example of such statement can be `CREATE TABLE` or `ALTER TABLE`.
|
|
324
|
-
|
|
325
|
-
Should be awaited.
|
|
326
|
-
|
|
327
|
-
Optionally, it returns a readable stream that can be consumed on the application side if you need it for some reason. But in that case you might consider using `query` instead.
|
|
328
|
-
|
|
329
|
-
```ts
|
|
330
|
-
interface ExecParams {
|
|
331
|
-
// Statement to execute
|
|
332
|
-
query: string
|
|
333
|
-
// ClickHouse settings that can be applied on query level, such as `date_time_input_format`
|
|
334
|
-
clickhouse_settings?: ClickHouseSettings
|
|
335
|
-
// See https://clickhouse.com/docs/en/interfaces/http/#cli-queries-with-parameters for more details
|
|
336
|
-
// IMPORTANT: that you should not prefix it with `param_` here, client will do that for you
|
|
337
|
-
query_params?: Record<string, unknown>
|
|
338
|
-
// A query can be aborted using this standard AbortSignal instance
|
|
339
|
-
// Please refer to the usage examples for more details
|
|
340
|
-
abort_signal?: AbortSignal
|
|
341
|
-
}
|
|
342
|
-
|
|
343
|
-
class ClickHouseClient {
|
|
344
|
-
exec(params: ExecParams): Promise<Stream.Readable> {}
|
|
345
|
-
// ...
|
|
346
|
-
}
|
|
347
|
-
```
|
|
348
|
-
|
|
349
|
-
### Ping
|
|
350
|
-
|
|
351
|
-
Might be useful to check the connectivity to the ClickHouse server. Returns `true` if server can be reached. Can throw a standard Node.js Error such as `ECONNREFUSED`.
|
|
352
|
-
|
|
353
|
-
```ts
|
|
354
|
-
class ClickHouseClient {
|
|
355
|
-
ping(): Promise<boolean> {}
|
|
356
|
-
// ...
|
|
357
|
-
}
|
|
358
|
-
```
|
|
359
|
-
|
|
360
|
-
### Close
|
|
361
|
-
|
|
362
|
-
Use it in your application graceful shutdown handler, as it properly closes all the open connections.
|
|
363
|
-
|
|
364
|
-
```ts
|
|
365
|
-
class ClickHouseClient {
|
|
366
|
-
close(): Promise<void> {}
|
|
367
|
-
// ...
|
|
368
|
-
}
|
|
369
|
-
```
|
|
23
|
+
See the [ClickHouse website](https://clickhouse.com/docs/en/integrations/language-clients/nodejs) for the full documentation entry.
|
|
370
24
|
|
|
371
25
|
## Usage examples
|
|
372
26
|
|
|
373
27
|
You can find code samples in the [examples](./examples) folder (with [README](./examples/README.md)).
|
|
374
28
|
|
|
375
|
-
See also:
|
|
376
|
-
|
|
377
|
-
- [Memory leaks test using Brown University benchmarks files](https://github.com/ClickHouse/clickhouse-js/blob/60c484a3492420baed4b4c6c33cc0845262285e7/benchmarks/leaks/memory_leak_brown.ts#L72-L80)
|
|
378
|
-
|
|
379
|
-
## Known limitations
|
|
380
|
-
|
|
381
|
-
- Browser usage is not supported.
|
|
382
|
-
- There are no data mappers for the result sets, so only language primitives are used.
|
|
383
|
-
- There are some [Decimal* and Date* / DateTime\* data types caveats](#date--datetime-types-caveats).
|
|
384
|
-
- Nested data type is currently not officially supported.
|
|
385
|
-
|
|
386
|
-
## Tips for performance optimizations
|
|
387
|
-
|
|
388
|
-
- To reduce application memory consumption, consider using streams for large inserts when applicable.
|
|
389
|
-
- Node.js HTTP(s) Agent has infinite max open sockets by default. In some cases, you might want to limit that by using `ClickHouseClientConfigOptions.max_open_connections` setting.
|
|
390
|
-
- We have response (for example, select queries) compression enabled by default, but insert compression is disabled. When using large inserts, you might want to enable request compression as well. You can use `ClickHouseClientConfigOptions.compression.request` for that.
|
|
391
|
-
|
|
392
29
|
## Contributing
|
|
393
30
|
|
|
394
31
|
Check out our [contributing guide](./CONTRIBUTING.md).
|
package/dist/client.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
+
/// <reference types="node" />
|
|
2
3
|
import Stream from 'stream';
|
|
3
4
|
import { Logger } from './logger';
|
|
4
5
|
import { type DataFormat } from './data_formatter';
|
|
@@ -28,14 +29,24 @@ export interface ClickHouseClientConfigOptions {
|
|
|
28
29
|
application?: string;
|
|
29
30
|
/** Database name to use. Default value: `default`. */
|
|
30
31
|
database?: string;
|
|
31
|
-
/** ClickHouse settings to apply to all requests. Default value: {}
|
|
32
|
+
/** ClickHouse settings to apply to all requests. Default value: {} */
|
|
32
33
|
clickhouse_settings?: ClickHouseSettings;
|
|
33
34
|
log?: {
|
|
34
|
-
/** Enable logging. Default value: false.
|
|
35
|
+
/** Enable logging. Default value: false. */
|
|
35
36
|
enable?: boolean;
|
|
36
37
|
/** A class to instantiate a custom logger implementation. */
|
|
37
38
|
LoggerClass?: new (enabled: boolean) => Logger;
|
|
38
39
|
};
|
|
40
|
+
tls?: BasicTLSOptions | MutualTLSOptions;
|
|
41
|
+
session_id?: string;
|
|
42
|
+
}
|
|
43
|
+
interface BasicTLSOptions {
|
|
44
|
+
ca_cert: Buffer;
|
|
45
|
+
}
|
|
46
|
+
interface MutualTLSOptions {
|
|
47
|
+
ca_cert: Buffer;
|
|
48
|
+
cert: Buffer;
|
|
49
|
+
key: Buffer;
|
|
39
50
|
}
|
|
40
51
|
export interface BaseParams {
|
|
41
52
|
/** ClickHouse settings that can be applied on query level. */
|
package/dist/client.js
CHANGED
|
@@ -26,12 +26,27 @@ function createUrl(host) {
|
|
|
26
26
|
}
|
|
27
27
|
function normalizeConfig(config, loggingEnabled) {
|
|
28
28
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
|
|
29
|
+
let tls = undefined;
|
|
30
|
+
if (config.tls) {
|
|
31
|
+
if ('cert' in config.tls && 'key' in config.tls) {
|
|
32
|
+
tls = {
|
|
33
|
+
type: 'Mutual',
|
|
34
|
+
...config.tls,
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
else {
|
|
38
|
+
tls = {
|
|
39
|
+
type: 'Basic',
|
|
40
|
+
...config.tls,
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
}
|
|
29
44
|
return {
|
|
30
45
|
url: createUrl((_a = config.host) !== null && _a !== void 0 ? _a : 'http://localhost:8123'),
|
|
31
46
|
connect_timeout: (_b = config.connect_timeout) !== null && _b !== void 0 ? _b : 10000,
|
|
32
47
|
request_timeout: (_c = config.request_timeout) !== null && _c !== void 0 ? _c : 300000,
|
|
33
48
|
max_open_connections: (_d = config.max_open_connections) !== null && _d !== void 0 ? _d : Infinity,
|
|
34
|
-
|
|
49
|
+
tls,
|
|
35
50
|
compression: {
|
|
36
51
|
decompress_response: (_f = (_e = config.compression) === null || _e === void 0 ? void 0 : _e.response) !== null && _f !== void 0 ? _f : true,
|
|
37
52
|
compress_request: (_h = (_g = config.compression) === null || _g === void 0 ? void 0 : _g.request) !== null && _h !== void 0 ? _h : false,
|
|
@@ -45,6 +60,7 @@ function normalizeConfig(config, loggingEnabled) {
|
|
|
45
60
|
enable: loggingEnabled,
|
|
46
61
|
LoggerClass: (_q = (_p = config.log) === null || _p === void 0 ? void 0 : _p.LoggerClass) !== null && _q !== void 0 ? _q : logger_1.Logger,
|
|
47
62
|
},
|
|
63
|
+
session_id: config.session_id,
|
|
48
64
|
};
|
|
49
65
|
}
|
|
50
66
|
class ClickHouseClient {
|
|
@@ -82,6 +98,7 @@ class ClickHouseClient {
|
|
|
82
98
|
},
|
|
83
99
|
query_params: params.query_params,
|
|
84
100
|
abort_signal: params.abort_signal,
|
|
101
|
+
session_id: this.config.session_id,
|
|
85
102
|
};
|
|
86
103
|
}
|
|
87
104
|
async query(params) {
|
package/dist/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA2B;
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA2B;AAE3B,6CAAgE;AAChE,qCAAiC;AACjC,mCAA6C;AAC7C,qDAIyB;AACzB,qCAAoC;AAsFpC,SAAS,cAAc,CAAC,EAAE,GAAG,EAAoB;IAC/C,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;IACD,0BAA0B;AAC5B,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,eAAe,CACtB,MAAqC,EACrC,cAAuB;;IAEvB,IAAI,GAAG,GAA0B,SAAS,CAAA;IAC1C,IAAI,MAAM,CAAC,GAAG,EAAE;QACd,IAAI,MAAM,IAAI,MAAM,CAAC,GAAG,IAAI,KAAK,IAAI,MAAM,CAAC,GAAG,EAAE;YAC/C,GAAG,GAAG;gBACJ,IAAI,EAAE,QAAQ;gBACd,GAAG,MAAM,CAAC,GAAG;aACd,CAAA;SACF;aAAM;YACL,GAAG,GAAG;gBACJ,IAAI,EAAE,OAAO;gBACb,GAAG,MAAM,CAAC,GAAG;aACd,CAAA;SACF;KACF;IACD,OAAO;QACL,GAAG,EAAE,SAAS,CAAC,MAAA,MAAM,CAAC,IAAI,mCAAI,uBAAuB,CAAC;QACtD,eAAe,EAAE,MAAA,MAAM,CAAC,eAAe,mCAAI,KAAM;QACjD,eAAe,EAAE,MAAA,MAAM,CAAC,eAAe,mCAAI,MAAO;QAClD,oBAAoB,EAAE,MAAA,MAAM,CAAC,oBAAoB,mCAAI,QAAQ;QAC7D,GAAG;QACH,WAAW,EAAE;YACX,mBAAmB,EAAE,MAAA,MAAA,MAAM,CAAC,WAAW,0CAAE,QAAQ,mCAAI,IAAI;YACzD,gBAAgB,EAAE,MAAA,MAAA,MAAM,CAAC,WAAW,0CAAE,OAAO,mCAAI,KAAK;SACvD;QACD,QAAQ,EAAE,MAAA,MAAM,CAAC,QAAQ,mCAAI,SAAS;QACtC,QAAQ,EAAE,MAAA,MAAM,CAAC,QAAQ,mCAAI,EAAE;QAC/B,WAAW,EAAE,MAAA,MAAM,CAAC,WAAW,mCAAI,eAAe;QAClD,QAAQ,EAAE,MAAA,MAAM,CAAC,QAAQ,mCAAI,SAAS;QACtC,mBAAmB,EAAE,MAAA,MAAM,CAAC,mBAAmB,mCAAI,EAAE;QACrD,GAAG,EAAE;YACH,MAAM,EAAE,cAAc;YACtB,WAAW,EAAE,MAAA,MAAA,MAAM,CAAC,GAAG,0CAAE,WAAW,mCAAI,eAAM;SAC/C;QACD,UAAU,EAAE,MAAM,CAAC,UAAU;KAC9B,CAAA;AACH,CAAC;AAID,MAAa,gBAAgB;IAK3B,YAAY,SAAwC,EAAE;;QAJtD;;;;;WAAyC;QACzC;;;;;WAAuC;QACvC;;;;;WAAuB;QAGrB,MAAM,cAAc,GAAG,OAAO,CAC5B,CAAA,MAAA,MAAM,CAAC,GAAG,0CAAE,MAAM,KAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB,CACxD,CAAA;QACD,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;QACrD,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAE3B,IAAI,CAAC,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QACrE,IAAI,CAAC,UAAU,GAAG,IAAA,6BAAgB,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IAC9D,CAAC;IAEO,aAAa,CAAC,MAAkB;QACtC,OAAO;YACL,mBAAmB,EAAE;gBACnB,GAAG,IAAI,CAAC,MAAM,CAAC,mBAAmB;gBAClC,GAAG,MAAM,CAAC,mBAAmB;aAC9B;YACD,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;SACnC,CAAA;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,MAAmB;;QAC7B,MAAM,MAAM,GAAG,MAAA,MAAM,CAAC,MAAM,mCAAI,MAAM,CAAA;QACtC,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAC/C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;YACzC,KAAK;YACL,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;SAC9B,CAAC,CAAA;QACF,OAAO,IAAI,kBAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACtC,CAAC;IAED,IAAI,CAAC,MAAkB;QACrB,MAAM,KAAK,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;QACrD,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YAC1B,KAAK;YACL,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;SAC9B,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CAAI,MAAuB;QACrC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,oBAAoB,CAAA;QAEpD,oBAAoB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC3C,MAAM,KAAK,GAAG,eAAe,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,MAAM,EAAE,CAAA;QAEnE,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YAC3B,KAAK;YACL,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;YAC3C,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;SAC9B,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,IAAI;QACR,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAA;IACrC,CAAC;IAED,KAAK,CAAC,KAAK;QACT,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAA;IACtC,CAAC;CACF;AAlED,4CAkEC;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,SAAgB,oBAAoB,CAClC,MAAuB,EACvB,MAAkB;IAElB,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QACtB,CAAC,IAAA,gBAAQ,EAAC,MAAM,CAAC;QACjB,OAAO,MAAM,KAAK,QAAQ,EAC1B;QACA,MAAM,IAAI,KAAK,CACb,gFAAgF;YAC9E,QAAQ,OAAO,MAAM,EAAE,CAC1B,CAAA;KACF;IAED,IAAI,IAAA,gBAAQ,EAAC,MAAM,CAAC,EAAE;QACpB,IAAI,IAAA,qCAAoB,EAAC,MAAM,CAAC,EAAE;YAChC,IAAI,MAAM,CAAC,kBAAkB,EAAE;gBAC7B,MAAM,IAAI,KAAK,CACb,cAAc,MAAM,sDAAsD,CAC3E,CAAA;aACF;SACF;aAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE;YACrC,MAAM,IAAI,KAAK,CACb,cAAc,MAAM,qDAAqD,CAC1E,CAAA;SACF;KACF;AACH,CAAC;AA5BD,oDA4BC;AAED;;;;;;;;GAQG;AACH,SAAgB,YAAY,CAC1B,MAAuB,EACvB,MAAkB;IAElB,IAAI,IAAA,gBAAQ,EAAC,MAAM,CAAC,EAAE;QACpB,yEAAyE;QACzE,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE;YAC9B,OAAO,MAAM,CAAA;SACd;QACD,wBAAwB;QACxB,OAAO,gBAAM,CAAC,QAAQ,CACpB,MAAM,EACN,IAAA,iBAAS,EAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,2BAAU,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC,EAC/C,UAAU,CACX,CAAA;KACF;IACD,eAAe;IACf,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACzB,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,2BAAU,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;KACjE;IACD,wCAAwC;IACxC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,OAAO,IAAA,2BAAU,EAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAClC;IACD,MAAM,IAAI,KAAK,CACb,gCAAgC,OAAO,MAAM,SAAS,MAAM,SAAS,CACtE,CAAA;AACH,CAAC;AA3BD,oCA2BC;AAED,SAAgB,YAAY,CAC1B,MAAsC;IAEtC,OAAO,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAA;AACrC,CAAC;AAJD,oCAIC;AAED,SAAS,UAAU,CAAC,GAAiC;IACnD,IAAI,GAAG,EAAE;QACP,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;KACnB;AACH,CAAC"}
|
|
@@ -13,11 +13,12 @@ export interface RequestParams {
|
|
|
13
13
|
compress_request?: boolean;
|
|
14
14
|
}
|
|
15
15
|
export declare abstract class BaseHttpAdapter implements Connection {
|
|
16
|
-
|
|
16
|
+
protected readonly config: ConnectionParams;
|
|
17
17
|
private readonly logger;
|
|
18
18
|
protected readonly agent: Http.Agent;
|
|
19
19
|
protected readonly headers: Http.OutgoingHttpHeaders;
|
|
20
20
|
protected constructor(config: ConnectionParams, logger: Logger, agent: Http.Agent);
|
|
21
|
+
protected buildDefaultHeaders(username: string, password: string): Http.OutgoingHttpHeaders;
|
|
21
22
|
protected abstract createClientRequest(url: URL, params: RequestParams): Http.ClientRequest;
|
|
22
23
|
protected request(params: RequestParams): Promise<Stream.Readable>;
|
|
23
24
|
ping(): Promise<boolean>;
|
|
@@ -26,11 +26,6 @@ function withHttpSettings(clickhouse_settings, compression) {
|
|
|
26
26
|
...clickhouse_settings,
|
|
27
27
|
};
|
|
28
28
|
}
|
|
29
|
-
function buildDefaultHeaders(username, password) {
|
|
30
|
-
return {
|
|
31
|
-
Authorization: `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`,
|
|
32
|
-
};
|
|
33
|
-
}
|
|
34
29
|
function decompressResponse(response) {
|
|
35
30
|
const encoding = response.headers['content-encoding'];
|
|
36
31
|
if (encoding === 'gzip') {
|
|
@@ -78,7 +73,12 @@ class BaseHttpAdapter {
|
|
|
78
73
|
writable: true,
|
|
79
74
|
value: void 0
|
|
80
75
|
});
|
|
81
|
-
this.headers = buildDefaultHeaders(config.username, config.password);
|
|
76
|
+
this.headers = this.buildDefaultHeaders(config.username, config.password);
|
|
77
|
+
}
|
|
78
|
+
buildDefaultHeaders(username, password) {
|
|
79
|
+
return {
|
|
80
|
+
Authorization: `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`,
|
|
81
|
+
};
|
|
82
82
|
}
|
|
83
83
|
async request(params) {
|
|
84
84
|
return new Promise((resolve, reject) => {
|
|
@@ -199,6 +199,7 @@ class BaseHttpAdapter {
|
|
|
199
199
|
database: this.config.database,
|
|
200
200
|
clickhouse_settings,
|
|
201
201
|
query_params: params.query_params,
|
|
202
|
+
session_id: params.session_id,
|
|
202
203
|
});
|
|
203
204
|
return await this.request({
|
|
204
205
|
method: 'POST',
|
|
@@ -213,6 +214,7 @@ class BaseHttpAdapter {
|
|
|
213
214
|
database: this.config.database,
|
|
214
215
|
clickhouse_settings: params.clickhouse_settings,
|
|
215
216
|
query_params: params.query_params,
|
|
217
|
+
session_id: params.session_id,
|
|
216
218
|
});
|
|
217
219
|
return await this.request({
|
|
218
220
|
method: 'POST',
|
|
@@ -227,6 +229,7 @@ class BaseHttpAdapter {
|
|
|
227
229
|
clickhouse_settings: params.clickhouse_settings,
|
|
228
230
|
query_params: params.query_params,
|
|
229
231
|
query: params.query,
|
|
232
|
+
session_id: params.session_id,
|
|
230
233
|
});
|
|
231
234
|
await this.request({
|
|
232
235
|
method: 'POST',
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base_http_adapter.js","sourceRoot":"","sources":["../../../src/connection/adapter/base_http_adapter.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA2B;AAE3B,gDAAuB;AACvB,uCAAwC;AAUxC,6DAAqD;AACrD,mDAA8C;AAC9C,uCAAiD;AAYjD,SAAS,oBAAoB,CAAC,UAAmB;IAC/C,OAAO,OAAO,CAAC,UAAU,IAAI,GAAG,IAAI,UAAU,IAAI,UAAU,GAAG,GAAG,CAAC,CAAA;AACrE,CAAC;AAED,SAAS,aAAa,CAAC,MAAW;IAChC,OAAO,qBAAqB,IAAI,MAAM,CAAA;AACxC,CAAC;AAED,SAAS,gBAAgB,CACvB,mBAAwC,EACxC,WAAqB;IAErB,OAAO;QACL,GAAG,CAAC,WAAW;YACb,CAAC,CAAC;gBACE,uBAAuB,EAAE,CAAC;aAC3B;YACH,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,mBAAmB;KACvB,CAAA;AACH,CAAC;AAED,SAAS,
|
|
1
|
+
{"version":3,"file":"base_http_adapter.js","sourceRoot":"","sources":["../../../src/connection/adapter/base_http_adapter.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA2B;AAE3B,gDAAuB;AACvB,uCAAwC;AAUxC,6DAAqD;AACrD,mDAA8C;AAC9C,uCAAiD;AAYjD,SAAS,oBAAoB,CAAC,UAAmB;IAC/C,OAAO,OAAO,CAAC,UAAU,IAAI,GAAG,IAAI,UAAU,IAAI,UAAU,GAAG,GAAG,CAAC,CAAA;AACrE,CAAC;AAED,SAAS,aAAa,CAAC,MAAW;IAChC,OAAO,qBAAqB,IAAI,MAAM,CAAA;AACxC,CAAC;AAED,SAAS,gBAAgB,CACvB,mBAAwC,EACxC,WAAqB;IAErB,OAAO;QACL,GAAG,CAAC,WAAW;YACb,CAAC,CAAC;gBACE,uBAAuB,EAAE,CAAC;aAC3B;YACH,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,mBAAmB;KACvB,CAAA;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,QAA8B;IAKxD,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAErD,IAAI,QAAQ,KAAK,MAAM,EAAE;QACvB,OAAO;YACL,QAAQ,EAAE,gBAAM,CAAC,QAAQ,CACvB,QAAQ,EACR,cAAI,CAAC,YAAY,EAAE,EACnB,SAAS,UAAU,CAAC,GAAG;gBACrB,IAAI,GAAG,EAAE;oBACP,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;iBACnB;YACH,CAAC,CACF;SACF,CAAA;KACF;SAAM,IAAI,QAAQ,KAAK,SAAS,EAAE;QACjC,OAAO;YACL,KAAK,EAAE,IAAI,KAAK,CAAC,wBAAwB,QAAQ,EAAE,CAAC;SACrD,CAAA;KACF;IAED,OAAO,EAAE,QAAQ,EAAE,CAAA;AACrB,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAW;IACvC,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,CAAA;AACnC,CAAC;AAED,MAAsB,eAAe;IAEnC,YACqB,MAAwB,EAC1B,MAAc,EACZ,KAAiB;;;;;mBAFjB;;;;;;mBACF;;;;;;mBACE;;QAJrB;;;;;WAAoD;QAMlD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;IAC3E,CAAC;IAES,mBAAmB,CAC3B,QAAgB,EAChB,QAAgB;QAEhB,OAAO;YACL,aAAa,EAAE,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,IAAI,QAAQ,EAAE,CAAC,CAAC,QAAQ,CACrE,QAAQ,CACT,EAAE;SACJ,CAAA;IACH,CAAC;IAOS,KAAK,CAAC,OAAO,CAAC,MAAqB;QAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YAExB,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;YAE5D,SAAS,OAAO,CAAC,GAAU;gBACzB,sBAAsB,EAAE,CAAA;gBACxB,MAAM,CAAC,GAAG,CAAC,CAAA;YACb,CAAC;YAED,MAAM,UAAU,GAAG,KAAK,EACtB,SAA+B,EAChB,EAAE;gBACjB,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,CAAA;gBAE1C,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAA;gBAEzD,IAAI,oBAAoB,CAAC,mBAAmB,CAAC,EAAE;oBAC7C,OAAO,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAA;iBACzC;gBAED,IAAI,oBAAoB,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE;oBAC9C,OAAO,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAA;iBAC7C;qBAAM;oBACL,MAAM,CAAC,IAAA,kBAAU,EAAC,MAAM,IAAA,iBAAS,EAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;iBAClE;YACH,CAAC,CAAA;YAED,SAAS,SAAS;gBAChB,sBAAsB,EAAE,CAAA;gBACxB,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE;oBACpB;;;yBAGK;gBACP,CAAC,CAAC,CAAA;gBACF,OAAO,CAAC,OAAO,EAAE,CAAA;gBACjB,MAAM,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,CAAA;YACpC,CAAC;YAED,SAAS,aAAa;gBACpB,wCAAwC;gBACxC,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAA;YACxD,CAAC;YAED,SAAS,OAAO;gBACd,4EAA4E;gBAC5E,qGAAqG;gBACrG,sBAAsB,EAAE,CAAA;gBACxB,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE;oBACpB;;;yBAGK;gBACP,CAAC,CAAC,CAAA;gBACF,MAAM,CAAC,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAA;YAC/C,CAAC;YAED,SAAS,OAAO;gBACd,kFAAkF;gBAClF,6FAA6F;gBAC7F,uGAAuG;gBACvG,uHAAuH;gBACvH,YAAY,CAAC,sBAAsB,CAAC,CAAA;YACtC,CAAC;YAED,SAAS,sBAAsB;gBAC7B,OAAO,CAAC,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;gBAC9C,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;gBACxC,OAAO,CAAC,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;gBAC5C,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;gBACxC,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;gBACxC,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE;oBACrC,IAAI,aAAa,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;wBACtC,MAAM,CAAC,YAAY,CAAC,mBAAmB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;qBAChE;yBAAM;wBACL,wCAAwC;wBACxC,MAAM,CAAC,YAAY,CAAC,cAAc,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;qBAC3D;iBACF;YACH,CAAC;YAED,IAAI,MAAM,CAAC,YAAY,EAAE;gBACvB,qEAAqE;gBACrE,4EAA4E;gBAC5E,uCAAuC;gBACvC,wDAAwD;gBACxD,MAAM,CAAC,YAAY,CAAC,gBAAgB,CAAC,OAAO,EAAE,aAAa,EAAE;oBAC3D,IAAI,EAAE,IAAI;iBACX,CAAC,CAAA;aACH;YAED,OAAO,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;YAClC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;YAChC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAC5B,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAC5B,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAE5B,IAAI,CAAC,MAAM,CAAC,IAAI;gBAAE,OAAO,OAAO,CAAC,GAAG,EAAE,CAAA;YAEtC,MAAM,UAAU,GAAG,IAAA,gBAAQ,EAAC,MAAM,CAAC,IAAI,CAAC;gBACtC,CAAC,CAAC,MAAM,CAAC,IAAI;gBACb,CAAC,CAAC,gBAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;YAEvC,MAAM,QAAQ,GAAG,CAAC,GAAiC,EAAQ,EAAE;gBAC3D,IAAI,GAAG,EAAE;oBACP,sBAAsB,EAAE,CAAA;oBACxB,MAAM,CAAC,GAAG,CAAC,CAAA;iBACZ;YACH,CAAC,CAAA;YAED,IAAI,MAAM,CAAC,gBAAgB,EAAE;gBAC3B,gBAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,cAAI,CAAC,UAAU,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;aAClE;iBAAM;gBACL,gBAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;aAC/C;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,IAAI;QACR,6BAA6B;QAC7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAClC,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,IAAA,4BAAY,EAAC,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;SAC/D,CAAC,CAAA;QACF,QAAQ,CAAC,OAAO,EAAE,CAAA;QAClB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,MAAkB;QAC5B,MAAM,mBAAmB,GAAG,gBAAgB,CAC1C,MAAM,CAAC,mBAAmB,EAC1B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAC5C,CAAA;QACD,MAAM,YAAY,GAAG,IAAA,mCAAc,EAAC;YAClC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;YAC9B,mBAAmB;YACnB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,UAAU,EAAE,MAAM,CAAC,UAAU;SAC9B,CAAC,CAAA;QAEF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,IAAA,4BAAY,EAAC,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC;YACxE,IAAI,EAAE,MAAM,CAAC,KAAK;YAClB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,mBAAmB,EAAE,mBAAmB,CAAC,uBAAuB,KAAK,CAAC;SACvE,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,MAAkB;QAC3B,MAAM,YAAY,GAAG,IAAA,mCAAc,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;SAC9B,CAAC,CAAA;QAEF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,IAAA,4BAAY,EAAC,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC;YACxE,IAAI,EAAE,MAAM,CAAC,KAAK;YAClB,YAAY,EAAE,MAAM,CAAC,YAAY;SAClC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAoB;QAC/B,MAAM,YAAY,GAAG,IAAA,mCAAc,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;SAC9B,CAAC,CAAA;QAEF,MAAM,IAAI,CAAC,OAAO,CAAC;YACjB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,IAAA,4BAAY,EAAC,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC;YACxE,IAAI,EAAE,MAAM,CAAC,MAAM;YACnB,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,gBAAgB,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,gBAAgB;SAC3D,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE;YAChE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAA;SACrB;IACH,CAAC;IAEO,WAAW,CACjB,MAAqB,EACrB,QAA8B,EAC9B,cAAsB;QAEtB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,cAAc,CAAA;QAE5C,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,4BAA4B,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,GAAG,CAAC,QAAQ,GAC9D,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAChD,IAAI,QAAQ,CAAC,UAAU,IAAI,QAAQ,IAAI,CACxC,CAAA;IACH,CAAC;IAES,UAAU,CAAC,MAAqB;QACxC,OAAO;YACL,GAAG,IAAI,CAAC,OAAO;YACf,GAAG,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACpE,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACnE,CAAA;IACH,CAAC;CACF;AA9OD,0CA8OC"}
|
|
@@ -4,6 +4,7 @@ declare type ToSearchParamsOptions = {
|
|
|
4
4
|
clickhouse_settings?: ClickHouseSettings;
|
|
5
5
|
query_params?: Record<string, unknown>;
|
|
6
6
|
query?: string;
|
|
7
|
+
session_id?: string;
|
|
7
8
|
};
|
|
8
|
-
export declare function toSearchParams({ database, query, query_params, clickhouse_settings, }: ToSearchParamsOptions): URLSearchParams | undefined;
|
|
9
|
+
export declare function toSearchParams({ database, query, query_params, clickhouse_settings, session_id, }: ToSearchParamsOptions): URLSearchParams | undefined;
|
|
9
10
|
export {};
|
|
@@ -4,7 +4,7 @@ exports.toSearchParams = void 0;
|
|
|
4
4
|
const data_formatter_1 = require("../../data_formatter/");
|
|
5
5
|
// TODO validate max length of the resulting query
|
|
6
6
|
// https://stackoverflow.com/questions/812925/what-is-the-maximum-possible-length-of-a-query-string
|
|
7
|
-
function toSearchParams({ database, query, query_params, clickhouse_settings, }) {
|
|
7
|
+
function toSearchParams({ database, query, query_params, clickhouse_settings, session_id, }) {
|
|
8
8
|
if (clickhouse_settings === undefined &&
|
|
9
9
|
query_params === undefined &&
|
|
10
10
|
query === undefined &&
|
|
@@ -30,6 +30,9 @@ function toSearchParams({ database, query, query_params, clickhouse_settings, })
|
|
|
30
30
|
if (query) {
|
|
31
31
|
params.set('query', query);
|
|
32
32
|
}
|
|
33
|
+
if (session_id) {
|
|
34
|
+
params.set('session_id', session_id);
|
|
35
|
+
}
|
|
33
36
|
return params;
|
|
34
37
|
}
|
|
35
38
|
exports.toSearchParams = toSearchParams;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"http_search_params.js","sourceRoot":"","sources":["../../../src/connection/adapter/http_search_params.ts"],"names":[],"mappings":";;;AAAA,0DAA8E;
|
|
1
|
+
{"version":3,"file":"http_search_params.js","sourceRoot":"","sources":["../../../src/connection/adapter/http_search_params.ts"],"names":[],"mappings":";;;AAAA,0DAA8E;AAW9E,kDAAkD;AAClD,mGAAmG;AACnG,SAAgB,cAAc,CAAC,EAC7B,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,mBAAmB,EACnB,UAAU,GACY;IACtB,IACE,mBAAmB,KAAK,SAAS;QACjC,YAAY,KAAK,SAAS;QAC1B,KAAK,KAAK,SAAS;QACnB,QAAQ,KAAK,SAAS,EACtB;QACA,OAAM;KACP;IAED,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAA;IAEpC,IAAI,YAAY,KAAK,SAAS,EAAE;QAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YACvD,MAAM,CAAC,GAAG,CAAC,SAAS,GAAG,EAAE,EAAE,IAAA,kCAAiB,EAAC,KAAK,CAAC,CAAC,CAAA;SACrD;KACF;IAED,IAAI,mBAAmB,KAAK,SAAS,EAAE;QACrC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE;YAC9D,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAA,oCAAmB,EAAC,KAAK,CAAC,CAAC,CAAA;aAC5C;SACF;KACF;IAED,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;KACjC;IAED,IAAI,KAAK,EAAE;QACT,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;KAC3B;IAED,IAAI,UAAU,EAAE;QACd,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,UAAU,CAAC,CAAA;KACrC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AA7CD,wCA6CC"}
|
|
@@ -6,5 +6,6 @@ import type { Logger } from '../../logger';
|
|
|
6
6
|
import type Http from 'http';
|
|
7
7
|
export declare class HttpsAdapter extends BaseHttpAdapter implements Connection {
|
|
8
8
|
constructor(config: ConnectionParams, logger: Logger);
|
|
9
|
+
protected buildDefaultHeaders(username: string, password: string): Http.OutgoingHttpHeaders;
|
|
9
10
|
protected createClientRequest(url: URL, params: RequestParams): Http.ClientRequest;
|
|
10
11
|
}
|
|
@@ -8,13 +8,34 @@ const base_http_adapter_1 = require("./base_http_adapter");
|
|
|
8
8
|
const https_1 = __importDefault(require("https"));
|
|
9
9
|
class HttpsAdapter extends base_http_adapter_1.BaseHttpAdapter {
|
|
10
10
|
constructor(config, logger) {
|
|
11
|
+
var _a, _b, _c;
|
|
11
12
|
const agent = new https_1.default.Agent({
|
|
12
13
|
keepAlive: true,
|
|
13
14
|
timeout: config.request_timeout,
|
|
14
15
|
maxSockets: config.max_open_connections,
|
|
16
|
+
ca: (_a = config.tls) === null || _a === void 0 ? void 0 : _a.ca_cert,
|
|
17
|
+
key: ((_b = config.tls) === null || _b === void 0 ? void 0 : _b.type) === 'Mutual' ? config.tls.key : undefined,
|
|
18
|
+
cert: ((_c = config.tls) === null || _c === void 0 ? void 0 : _c.type) === 'Mutual' ? config.tls.cert : undefined,
|
|
15
19
|
});
|
|
16
20
|
super(config, logger, agent);
|
|
17
21
|
}
|
|
22
|
+
buildDefaultHeaders(username, password) {
|
|
23
|
+
var _a, _b;
|
|
24
|
+
if (((_a = this.config.tls) === null || _a === void 0 ? void 0 : _a.type) === 'Mutual') {
|
|
25
|
+
return {
|
|
26
|
+
'X-ClickHouse-User': username,
|
|
27
|
+
'X-ClickHouse-Key': password,
|
|
28
|
+
'X-ClickHouse-SSL-Certificate-Auth': 'on',
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
if (((_b = this.config.tls) === null || _b === void 0 ? void 0 : _b.type) === 'Basic') {
|
|
32
|
+
return {
|
|
33
|
+
'X-ClickHouse-User': username,
|
|
34
|
+
'X-ClickHouse-Key': password,
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
return super.buildDefaultHeaders(username, password);
|
|
38
|
+
}
|
|
18
39
|
createClientRequest(url, params) {
|
|
19
40
|
return https_1.default.request(params.url, {
|
|
20
41
|
method: params.method,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"https_adapter.js","sourceRoot":"","sources":["../../../src/connection/adapter/https_adapter.ts"],"names":[],"mappings":";;;;;;AACA,2DAAqD;AAGrD,kDAAyB;AAGzB,MAAa,YAAa,SAAQ,mCAAe;IAC/C,YAAY,MAAwB,EAAE,MAAc
|
|
1
|
+
{"version":3,"file":"https_adapter.js","sourceRoot":"","sources":["../../../src/connection/adapter/https_adapter.ts"],"names":[],"mappings":";;;;;;AACA,2DAAqD;AAGrD,kDAAyB;AAGzB,MAAa,YAAa,SAAQ,mCAAe;IAC/C,YAAY,MAAwB,EAAE,MAAc;;QAClD,MAAM,KAAK,GAAG,IAAI,eAAK,CAAC,KAAK,CAAC;YAC5B,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,MAAM,CAAC,eAAe;YAC/B,UAAU,EAAE,MAAM,CAAC,oBAAoB;YACvC,EAAE,EAAE,MAAA,MAAM,CAAC,GAAG,0CAAE,OAAO;YACvB,GAAG,EAAE,CAAA,MAAA,MAAM,CAAC,GAAG,0CAAE,IAAI,MAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS;YAC/D,IAAI,EAAE,CAAA,MAAA,MAAM,CAAC,GAAG,0CAAE,IAAI,MAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SAClE,CAAC,CAAA;QACF,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;IAC9B,CAAC;IAEkB,mBAAmB,CACpC,QAAgB,EAChB,QAAgB;;QAEhB,IAAI,CAAA,MAAA,IAAI,CAAC,MAAM,CAAC,GAAG,0CAAE,IAAI,MAAK,QAAQ,EAAE;YACtC,OAAO;gBACL,mBAAmB,EAAE,QAAQ;gBAC7B,kBAAkB,EAAE,QAAQ;gBAC5B,mCAAmC,EAAE,IAAI;aAC1C,CAAA;SACF;QACD,IAAI,CAAA,MAAA,IAAI,CAAC,MAAM,CAAC,GAAG,0CAAE,IAAI,MAAK,OAAO,EAAE;YACrC,OAAO;gBACL,mBAAmB,EAAE,QAAQ;gBAC7B,kBAAkB,EAAE,QAAQ;aAC7B,CAAA;SACF;QACD,OAAO,KAAK,CAAC,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;IACtD,CAAC;IAES,mBAAmB,CAC3B,GAAQ,EACR,MAAqB;QAErB,OAAO,eAAK,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE;YAC/B,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;SACjC,CAAC,CAAA;IACJ,CAAC;CACF;AA3CD,oCA2CC"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
+
/// <reference types="node" />
|
|
2
3
|
import type Stream from 'stream';
|
|
3
4
|
import type { Logger } from '../logger';
|
|
4
5
|
import type { ClickHouseSettings } from '../settings';
|
|
@@ -11,15 +12,26 @@ export interface ConnectionParams {
|
|
|
11
12
|
decompress_response: boolean;
|
|
12
13
|
compress_request: boolean;
|
|
13
14
|
};
|
|
15
|
+
tls?: TLSParams;
|
|
14
16
|
username: string;
|
|
15
17
|
password: string;
|
|
16
18
|
database: string;
|
|
17
19
|
}
|
|
20
|
+
export declare type TLSParams = {
|
|
21
|
+
ca_cert: Buffer;
|
|
22
|
+
type: 'Basic';
|
|
23
|
+
} | {
|
|
24
|
+
ca_cert: Buffer;
|
|
25
|
+
cert: Buffer;
|
|
26
|
+
key: Buffer;
|
|
27
|
+
type: 'Mutual';
|
|
28
|
+
};
|
|
18
29
|
export interface BaseParams {
|
|
19
30
|
query: string;
|
|
20
31
|
clickhouse_settings?: ClickHouseSettings;
|
|
21
32
|
query_params?: Record<string, unknown>;
|
|
22
33
|
abort_signal?: AbortSignal;
|
|
34
|
+
session_id?: string;
|
|
23
35
|
}
|
|
24
36
|
export interface InsertParams extends BaseParams {
|
|
25
37
|
values: string | Stream.Readable;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"connection.js","sourceRoot":"","sources":["../../src/connection/connection.ts"],"names":[],"mappings":";;;AAEA,uCAAqD;
|
|
1
|
+
{"version":3,"file":"connection.js","sourceRoot":"","sources":["../../src/connection/connection.ts"],"names":[],"mappings":";;;AAEA,uCAAqD;AAsDrD,SAAgB,gBAAgB,CAC9B,MAAwB,EACxB,MAAc;IAEd,oCAAoC;IACpC,QAAQ,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE;QAC3B,KAAK,OAAO;YACV,OAAO,IAAI,qBAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACxC,KAAK,QAAQ;YACX,OAAO,IAAI,sBAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QACzC;YACE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;KACzD;AACH,CAAC;AAbD,4CAaC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@clickhouse/client",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.9",
|
|
4
4
|
"description": "Official JS client for ClickHouse DB",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"keywords": [
|
|
@@ -24,6 +24,7 @@
|
|
|
24
24
|
"lint": "eslint . --ext .ts",
|
|
25
25
|
"lint:fix": "eslint --fix . --ext .ts",
|
|
26
26
|
"test": "jest --reporters jest-silent-reporter --testPathPattern=__tests__ --globalSetup='<rootDir>/__tests__/setup.integration.ts'",
|
|
27
|
+
"test:tls": "jest --testMatch='**/__tests__/tls/*.test.ts'",
|
|
27
28
|
"test:unit": "jest --reporters jest-silent-reporter --testMatch='**/__tests__/{unit,utils}/*.test.ts'",
|
|
28
29
|
"test:integration": "jest --reporters jest-silent-reporter --runInBand --testPathPattern=__tests__/integration --globalSetup='<rootDir>/__tests__/setup.integration.ts'",
|
|
29
30
|
"test:integration:local_cluster": "CLICKHOUSE_TEST_ENVIRONMENT=local_cluster jest --reporters jest-silent-reporter --runInBand --testPathPattern=__tests__/integration --globalSetup='<rootDir>/__tests__/setup.integration.ts'",
|