userver: userver/storages/clickhouse.hpp Source File
Loading...
Searching...
No Matches
clickhouse.hpp
Go to the documentation of this file.
1#pragma once
2
3/// @file userver/storages/clickhouse.hpp
4/// This file is mainly for documentation purposes and inclusion of all headers
5/// that are required for working with ClickHouse µserver component.
6
7#include <userver/storages/clickhouse/cluster.hpp>
8#include <userver/storages/clickhouse/component.hpp>
9#include <userver/storages/clickhouse/execution_result.hpp>
10#include <userver/storages/clickhouse/options.hpp>
11#include <userver/storages/clickhouse/query.hpp>
12
13/// @page clickhouse_driver ClickHouse Driver
14///
15/// 🐙 **userver** provides access to ClickHouse databases servers via
16/// components::ClickHouse. The uClickHouse driver is asynchronous, it suspends
17/// current coroutine for carrying out network I/O.
18///
19/// @section feature Features
20/// - Connection pooling;
21/// - Variadic template query parameter passing;
22/// - Query result extraction to C++ types;
23/// - Mapping C++ types to native ClickHouse types.
24///
25/// @section info More information
26/// - For configuration see components::ClickHouse
27/// - For cluster operations see storages::clickhouse::Cluster
28/// - For mapping C++ types to Clickhouse types see @ref clickhouse_io
29///
30/// ----------
31///
32/// @htmlonly <div class="bottom-nav"> @endhtmlonly
33/// ⇦ @ref scripts/docs/en/userver/redis.md |
34/// @ref scripts/docs/en/userver/development/stability.md ⇨
35/// @htmlonly </div> @endhtmlonly
36
37USERVER_NAMESPACE_BEGIN
38
39/// @brief Top namespace for uClickHouse driver.
40///
41/// For more information see @ref clickhouse_driver.
42namespace storages::clickhouse {}
43
44/// @brief uClickHouse input-output.
45///
46/// Namespace containing classes and functions for defining datatype
47/// input-output and specifying mapping between C++ and ClickHouse types.
48namespace storages::clickhouse::io {}
49
50/// @brief uClickHouse columns.
51///
52/// Namespace containing definitions of supported ClickHouse column types.
53/// For more information see @ref userver_clickhouse_types
55
56USERVER_NAMESPACE_END