Interface QueryParams

Hierarchy

Properties

abort_signal? auth? clickhouse_settings? format? query query_id? query_params? session_id?

Properties

Optional abort_signal

abort_signal?: AbortSignal

AbortSignal instance to cancel a request in progress.

Optional auth

auth?: {
    password: string;
    username: string;
}

When defined, overrides the credentials from the BaseClickHouseClientConfigOptions.username and BaseClickHouseClientConfigOptions.password settings for this particular request.

Type declaration

  • password: string
  • username: string

Default

undefined (no override)

Optional clickhouse_settings

clickhouse_settings?: ClickHouseSettings

ClickHouse's settings that can be applied on query level.

Optional format

format?: DataFormat

Format of the resulting dataset.

query

query: string

Statement to execute.

Optional query_id

query_id?: string

A specific query_id that will be sent with this request. If it is not set, a random identifier will be generated automatically by the client.

Optional query_params

query_params?: Record<string, unknown>

Parameters for query binding. https://clickhouse.com/docs/en/interfaces/http/#cli-queries-with-parameters

Optional session_id

session_id?: string

A specific ClickHouse Session id for this query. If it is not set, BaseClickHouseClientConfigOptions.session_id will be used.

Default

undefined (no override)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc