userver: userver/ydb/credentials.hpp Source File
Loading...
Searching...
No Matches
credentials.hpp
Go to the documentation of this file.
1#pragma once
2
3/// @file userver/ydb/credentials.hpp
4/// @brief @copybrief ydb::CredentialsProviderComponent
5
6#include <memory>
7#include <string>
8
9#include <userver/components/component_base.hpp>
10#include <userver/yaml_config/fwd.hpp>
11
12#include <ydb-cpp-sdk/v2/client/types/fwd.h>
13
14USERVER_NAMESPACE_BEGIN
15
16namespace ydb {
17
18// clang-format off
19
20/// @ingroup userver_components
21///
22/// @brief Credentials provider component for creating custom credentials provider factory
23///
24/// Allows use custom credentials provider implementation
25/// Required if `ydb::YdbComponent` comnponent config contains `databases.<dbname>.credentials`
26///
27/// see https://ydb.tech/docs/en/concepts/auth
28
29// clang-format on
30
32public:
33 using components::ComponentBase::ComponentBase;
34
35 /// @brief Create credentials provider factory
36 ///
37 /// @param credentials credentials config (`databases.<dbname>.credentials`
38 /// from `ydb::YdbComponent` component config)
41 ) const = 0;
42};
43
44} // namespace ydb
45
46USERVER_NAMESPACE_END