storages::mysql::Component Class Reference

#include </data/code/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
        sample-sql-component:
            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:

Public Member Functions
	Component (const components::ComponentConfig &config, const components::ComponentContext &context)
	Component constructor.
	~Component () override
	Component destructor.
std::shared_ptr< storages::mysql::Cluster >	GetCluster () const
	Cluster accessor.
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override

Static Public Member Functions
static yaml_config::Schema	GetStaticConfigSchema ()

Protected Types
using	LoggableComponentBase = ComponentBase
	Legacy alias, use ComponentBase instead.

Member Typedef Documentation

LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Legacy alias, use ComponentBase instead.

Definition at line 67 of file component_base.hpp.

Member Function Documentation

GetComponentHealth()

ComponentHealth components::ComponentBase::GetComponentHealth ( ) const

inlineoverridevirtualinherited

Override this function to inform the world of the state of your component.

Warning

The function is called concurrently from multiple threads.

Reimplemented from components::RawComponentBase.

Reimplemented in server::handlers::Restart.

Definition at line 35 of file component_base.hpp.

OnAllComponentsAreStopping()

void components::ComponentBase::OnAllComponentsAreStopping ( )

inlineoverridevirtualinherited

Component may use this function to stop doing work before the stop of the components that depend on it.

Base components may override it and make final to do some work before the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in urabbitmq::ConsumerComponentBase, and components::Server.

Definition at line 58 of file component_base.hpp.

OnAllComponentsLoaded()

void components::ComponentBase::OnAllComponentsLoaded ( )

inlineoverridevirtualinherited

Component may use this function to finalize registration of other components that depend on it (for example, handler components register in server component, and the latter uses OnAllComponentsLoaded() to start processing requests).

Base components may override it and make final to do some work after the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in urabbitmq::ConsumerComponentBase, components::Server, and server::handlers::Ping.

Definition at line 51 of file component_base.hpp.

OnLoadingCancelled()

void components::ComponentBase::OnLoadingCancelled ( )

inlineoverridevirtualinherited

Called once if the creation of any other component failed. If the current component expects some other component to take any action with the current component, this call is a signal that such action may never happen due to components loading was cancelled. Application components might not want to override it.

Reimplemented from components::RawComponentBase.

Definition at line 42 of file component_base.hpp.

---

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

• userver/storages/mysql/component.hpp