userver: storages::mysql Namespace Reference
⚠️ This is the documentation for an old userver version. Click here to switch to the latest version.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
storages::mysql Namespace Reference

Top namespace for uMySQL driver. More...

Namespaces

namespace  convert
 Namespace containing helper classes and functions for on-the-flight remapping DbType<->UserType.
 

Classes

class  Cluster
 Client interface for a cluster of MySQL servers. Usually retrieved from components::MySQL. More...
 
struct  CommandControl
 
class  CommandResultSet
 A wrapper for command result set. More...
 
class  Component
 MySQL/MariaDB client component. More...
 
class  CursorResultSet
 A wrapper for read-only cursor. More...
 
class  Date
 a class that represent MySQL DATE type. More...
 
class  DateTime
 a class that represents MySQL DATETIME type. More...
 
struct  ExecutionResult
 Metadata for an execution of a statement that doesn't expect a result set (INSERT, UPDATE, DELETE). More...
 
struct  FieldTag
 Used for extracting statement results as a single field. More...
 
class  MappedStatementResultSet
 An interface for on-the-flight mapping statement result set from DbType into whatever type you provide without additional allocations. More...
 
class  MySQLCommandException
 Command exception - something went wrong with the command. More...
 
class  MySQLException
 Base class for all uMySQL driver exceptions. More...
 
class  MySQLIOException
 IO exception (read/write timeout/cancelled) More...
 
class  MySQLStatementException
 Statement exception - something went wrong with the statement. More...
 
class  MySQLTransactionException
 Transaction exception - something went wrong with the transaction. More...
 
class  MySQLValidationException
 
class  Query
 Query class, which driver executes. More...
 
struct  RowTag
 Used for extracting statement results as rows. More...
 
class  StatementResultSet
 A wrapper for statement execution result. More...
 
class  Transaction
 RAII transaction wrapper, auto-ROLLBACKs on destruction if no prior Commit/Rollback call was made. More...
 

Typedefs

using TimeoutDuration = std::chrono::milliseconds
 
using OptionalCommandControl = std::optional< CommandControl >
 storages::mysql::CommandControl that may not be set.
 

Enumerations

enum class  ClusterHostType {
  kPrimary ,
  kSecondary
}
 Enum for selecting the host type to carry query execution. More...
 

Variables

constexpr FieldTag kFieldTag
 
constexpr RowTag kRowTag {}
 

Detailed Description

Top namespace for uMySQL driver.

For more information see MySQL Driver - EXPERIMENTAL

Typedef Documentation

◆ OptionalCommandControl

storages::mysql::CommandControl that may not be set.

Definition at line 35 of file options.hpp.

◆ TimeoutDuration

using storages::mysql::TimeoutDuration = typedef std::chrono::milliseconds

Definition at line 12 of file options.hpp.

Enumeration Type Documentation

◆ ClusterHostType

Enum for selecting the host type to carry query execution.

Enumerator
kPrimary 

Execute a query on primary host.

kSecondary 

Execute a query on a secondary (replica) host. Fallbacks to primary in standalone topology.

Definition at line 10 of file cluster_host_type.hpp.

Variable Documentation

◆ kFieldTag

constexpr FieldTag storages::mysql::kFieldTag
inlineconstexpr

Definition at line 15 of file row_types.hpp.

◆ kRowTag

constexpr RowTag storages::mysql::kRowTag {}
inlineconstexpr

Definition at line 16 of file row_types.hpp.