Skip to content

Commit

Permalink
Add more param doc entries
Browse files Browse the repository at this point in the history
  • Loading branch information
slvrtrn committed Jul 11, 2024
1 parent 244d582 commit 5367048
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions packages/client-common/src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,19 @@ export type QueryResult<Stream, Format extends DataFormat> =
: BaseResultSet<Stream, Format>

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<Stream> = 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
}

Expand Down

0 comments on commit 5367048

Please sign in to comment.