query.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/storages/query.hpp
/// @brief @copybrief storages::Query
 
#include <optional>
#include <string>
 
#include <userver/utils/strong_typedef.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace tracing {
class Span;
}  // namespace tracing
 
namespace storages {
 
/// @brief Holds a query, its name and logging mode
/// @note You may write a query in `.sql` file and generate a header file with Query from it.
///       See @ref scripts/docs/en/userver/sql_files.md for more information.
class Query {
public:
    using Name = USERVER_NAMESPACE::utils::StrongTypedef<struct NameTag, std::string>;
 
    enum class LogMode { kFull, kNameOnly };
 
    Query() = default;
 
    Query(const char* statement, std::optional<Name> name = std::nullopt, LogMode log_mode = LogMode::kFull);
 
    Query(std::string statement, std::optional<Name> name = std::nullopt, LogMode log_mode = LogMode::kFull);
 
    const std::optional<Name>& GetName() const;
 
    const std::string& Statement() const;
 
    /// @brief Fills provided span with connection info
    void FillSpanTags(tracing::Span&) const;
 
private:
    std::string statement_{};
    std::optional<Name> name_{};
    LogMode log_mode_ = LogMode::kFull;
};
 
}  // namespace storages
 
USERVER_NAMESPACE_END