Type alias ClickHouseClientConfigOptions

Type declaration

• Optional Experimental http_agent?: http.Agent | https.Agent

  Custom HTTP agent to use for the outgoing HTTP(s) requests. If set, BaseClickHouseClientConfigOptions.max_open_connections, tls and keep_alive options have no effect, as it is part of the default underlying agent configuration.

  • unstable API, might be a subject to change in the future; please provide your feedback in the repository.

  Default

  undefined
  Copy

• Optional keep_alive?: {
      enabled?: boolean;
      idle_socket_ttl?: number;
  }

  HTTP Keep-Alive related settings

  • Optional enabled?: boolean

    Enable or disable HTTP Keep-Alive mechanism.

    Default

    true
    Copy

  • Optional idle_socket_ttl?: number

    For how long keep a particular idle socket alive on the client side (in milliseconds). It is supposed to be a fair bit less that the ClickHouse server KeepAlive timeout, which is by default 3000 ms for pre-23.11 versions.
    When set to 0, the idle socket management feature is disabled.

    Default

    2500
    Copy

• Optional Experimental set_basic_auth_header?: boolean

  Enable or disable the Authorization header with basic auth for the outgoing HTTP(s) requests.

  • unstable API, might be a subject to change in the future; please provide your feedback in the repository.

  Default

  true (enabled)
  Copy

• Optional tls?: BasicTLSOptions | MutualTLSOptions