userver: storages::mysql::Component Class Reference
No Matches
storages::mysql::Component Class Referencefinal

#include </data/code/service_template/third_party/userver/mysql/include/userver/storages/mysql/component.hpp>

Detailed Description

MySQL/MariaDB client component.

Provides access to a MySQL/MariaDB cluster.

Static configuration example:

# yaml
initial_pool_size: 3
max_pool_size: 15

The component will lookup connection data in secdist.json via its name.

Secdist format:

Connection settings are described as a JSON object mysql_settings, containing descriptions of MySQL/MariaDB clusters.

'mysql_settings': {
'sample-sql-component': {
# First host is considered a primary, all others - secondaries.
# This behavior is hard-coded and the mysql driver doesn't perform
# automatic primary [re]discovery.
'hosts': ['localhost'],
'port': 13307,
'password': '',
'user': 'root',
'database': 'sample_db',

Important note: the uMySQL driver does NOT perform an automatic primary detection and always considers the first host in hosts list an only primary node in the cluster.

Static options (more to come)

Name Description Default value
initial_pool_size initial connection pool size (per host) 5
max_pool_size maximum connection pool size (per host) 10

Definition at line 54 of file component.hpp.

+ Inheritance diagram for storages::mysql::Component:
+ Collaboration diagram for storages::mysql::Component:

Public Member Functions

 Component (const components::ComponentConfig &config, const components::ComponentContext &context)
 Component constructor.
 ~Component () override
 Component destructor.
std::shared_ptr< storages::mysql::ClusterGetCluster () const
 Cluster accessor.
- Public Member Functions inherited from components::LoggableComponentBase
 LoggableComponentBase (const ComponentConfig &, const ComponentContext &)
 LoggableComponentBase (LoggableComponentBase &&)=delete
 LoggableComponentBase (const LoggableComponentBase &)=delete
 ~LoggableComponentBase () override=default
ComponentHealth GetComponentHealth () const override
void OnLoadingCancelled () override
void OnAllComponentsLoaded () override
void OnAllComponentsAreStopping () override

Static Public Member Functions

static yaml_config::Schema GetStaticConfigSchema ()
- Static Public Member Functions inherited from components::LoggableComponentBase
static yaml_config::Schema GetStaticConfigSchema ()

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