From 5367048d7a2e3b8af369e0f3d2348e0fd1130f5d Mon Sep 17 00:00:00 2001 From: Serge Klochkov Date: Thu, 11 Jul 2024 16:22:00 +0200 Subject: [PATCH] Add more param doc entries --- packages/client-common/src/client.ts | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/packages/client-common/src/client.ts b/packages/client-common/src/client.ts index ea0284bd..60d3ca4d 100644 --- a/packages/client-common/src/client.ts +++ b/packages/client-common/src/client.ts @@ -62,14 +62,19 @@ export type QueryResult = : BaseResultSet export type ExecParams = BaseQueryParams & { - /** Statement to execute. By default, the query will be sent in the request body; + /** Statement to execute (including the FORMAT clause). By default, the query will be sent in the request body; * If {@link ExecParamsWithValues.values} are defined, the query is sent as a request parameter, * and the values are sent in the request body instead. */ query: string } export type ExecParamsWithValues = ExecParams & { /** If you have a custom INSERT statement to run with `exec`, - * the data from this stream will be inserted. */ + * the data from this stream will be inserted. + * + * NB: the data in the stream is expected to be serialized accordingly to the FORMAT clause + * used in {@link ExecParams.query} in this case. + * + * @see https://clickhouse.com/docs/en/interfaces/formats */ values: Stream }