userver: storages::clickhouse::CommandControl Struct Reference
No Matches
storages::clickhouse::CommandControl Struct Referencefinal

#include <userver/storages/clickhouse/options.hpp>

Detailed Description

A structure to control timeouts for ClickHouse queries

There is a single parameter, execute, which limits the overall time the driver spends executing a query, which includes:

  • connecting to ClickHouse server, if there are no connections available and connection pool still has space for new connections;
  • waiting for a connection to become idle if there are no idle connections and connection pool already has reached its max size;
  • executing the statement;
  • waiting for all the results to arrive.

In case of a timeout the client gets an exception and the driver drops the connection (no further reuse will take place), otherwise the connection is returned to the pool.

Definition at line 27 of file options.hpp.

Public Member Functions

constexpr CommandControl (std::chrono::milliseconds execute)

Public Attributes

std::chrono::milliseconds execute
 Overall timeout for a command being executed.

Constructor & Destructor Documentation

◆ CommandControl()

constexpr storages::clickhouse::CommandControl::CommandControl ( std::chrono::milliseconds execute)

Definition at line 31 of file options.hpp.

Member Data Documentation

◆ execute

std::chrono::milliseconds storages::clickhouse::CommandControl::execute

Overall timeout for a command being executed.

Definition at line 29 of file options.hpp.

The documentation for this struct was generated from the following file: