The ClusterMetadata class encapsulates a connection to the Metadata server. More...

#include <cluster_metadata.h>

Inheritance diagram for ClusterMetadata:

Public Member Functions
	ClusterMetadata (const metadata_cache::MetadataCacheMySQLSessionConfig &session_config, const mysqlrouter::SSLOptions &ssl_options)
	Constructor. More...

	ClusterMetadata (const ClusterMetadata &)=delete

ClusterMetadata &	operator= (const ClusterMetadata &)=delete

	~ClusterMetadata () override
	Destructor. More...

bool	connect_and_setup_session (const metadata_cache::metadata_server_t &metadata_server) noexcept override
	Connects with the Metadata server and sets up the session parameters. More...

void	disconnect () noexcept override
	Disconnects from the Metadata server. More...

bool	is_connected_to (const metadata_cache::metadata_server_t &metadata_server) const
	check if the metadata_connection_ connection is connected to metadata_server and alive. More...

stdx::expected< std::shared_ptr< mysqlrouter::MySQLSession >, std::string >	make_connection_shared (const metadata_cache::metadata_server_t &metadata_server)
	make a connection to metadata_server. More...

std::shared_ptr< mysqlrouter::MySQLSession >	get_connection () override
	Gets the object representing the session to the metadata server. More...

bool	update_router_attributes (const metadata_cache::metadata_server_t &rw_server, const unsigned router_id, const metadata_cache::RouterAttributes &router_attributes) override

bool	update_router_last_check_in (const metadata_cache::metadata_server_t &rw_server, const unsigned router_id) override

void	report_guideline_name (const std::string &guideline_name, const metadata_cache::metadata_server_t &rw_server, const unsigned router_id) override

auth_credentials_t	fetch_auth_credentials (const metadata_cache::metadata_server_t &md_server, const mysqlrouter::TargetCluster &target_cluster) override

std::optional< routing_guidelines::Router_info >	fetch_router_info (const uint16_t router_id) override

stdx::expected< std::string, std::error_code >	fetch_routing_guidelines_document (const uint16_t router_id) override

std::optional< metadata_cache::metadata_server_t >	find_rw_server (const std::vector< metadata_cache::ManagedInstance > &instances)

std::optional< metadata_cache::metadata_server_t >	find_rw_server (const std::vector< metadata_cache::ManagedCluster > &clusters)

std::optional< std::chrono::seconds >	get_periodic_stats_update_frequency () noexcept override

Public Member Functions inherited from MetaData
virtual stdx::expected< metadata_cache::ClusterTopology, std::error_code >	fetch_cluster_topology (const std::atomic< bool > &terminated, mysqlrouter::TargetCluster &target_cluster, const unsigned router_id, const metadata_cache::metadata_servers_list_t &metadata_servers, bool needs_writable_node, const std::string &clusterset_id, std::size_t &instance_id, std::string &routing_guidelines)=0

virtual void	setup_notifications_listener (const metadata_cache::ClusterTopology &cluster_topology, const std::function< void()> &callback)=0

virtual void	shutdown_notifications_listener ()=0

virtual mysqlrouter::ClusterType	get_cluster_type ()=0

	MetaData ()=default

	MetaData (const MetaData &)=delete

MetaData &	operator= (const MetaData &)=delete

virtual	~MetaData ()=default

Protected Member Functions
bool	do_connect (mysqlrouter::MySQLSession &connection, const metadata_cache::metadata_server_t &mi)
	Connects a MYSQL connection to the given instance. More...

mysqlrouter::MetadataSchemaVersion	get_and_check_metadata_schema_version (mysqlrouter::MySQLSession &session)

stdx::expected< std::string, std::error_code >	get_select_routing_guidelines_query (const mysqlrouter::MetadataSchemaVersion &schema_version, const uint16_t router_id)

Protected Attributes
mysql_ssl_mode	ssl_mode_

mysqlrouter::SSLOptions	ssl_options_

metadata_cache::MetadataCacheMySQLSessionConfig	session_config_

std::shared_ptr< mysqlrouter::MySQLSession >	metadata_connection_

RouterOptions	router_options_

Additional Inherited Members
Public Types inherited from MetaData
using	JsonAllocator = rapidjson::CrtAllocator

using	JsonDocument = rapidjson::Document

using	auth_credentials_t = std::map< std::string, std::pair< std::string, JsonDocument > >

Detailed Description

The ClusterMetadata class encapsulates a connection to the Metadata server.

It uses the mysqlrouter::MySQLSession to setup, manage and retrieve results.

Constructor & Destructor Documentation

◆ ClusterMetadata() [1/2]

ClusterMetadata::ClusterMetadata	(	const metadata_cache::MetadataCacheMySQLSessionConfig &	session_config,
		const mysqlrouter::SSLOptions &	ssl_options
	)

Constructor.

Parameters

session_config	Metadata MySQL session configuration
ssl_options	SSL related options to use for MySQL connections)

◆ ClusterMetadata() [2/2]

ClusterMetadata::ClusterMetadata ( const ClusterMetadata & )

explicitdelete

◆ ~ClusterMetadata()

ClusterMetadata::~ClusterMetadata ( )

overridedefault

Destructor.

Disconnect and release the connection to the metadata node.

Disconnect and release the connection to the metadata node. (RAII will close the connection in metadata_connection_)

Member Function Documentation

◆ connect_and_setup_session()

bool ClusterMetadata::connect_and_setup_session ( const metadata_cache::metadata_server_t & metadata_server )

overridevirtualnoexcept

Connects with the Metadata server and sets up the session parameters.

Parameters

metadata_server the server instance for which the connection should be attempted.

Returns: a boolean to indicate if the connection and session parameters setup was successful.

Implements MetaData.

◆ disconnect()

void ClusterMetadata::disconnect ( )

inlineoverridevirtualnoexcept

Disconnects from the Metadata server.

Implements MetaData.

◆ do_connect()

bool ClusterMetadata::do_connect	(	mysqlrouter::MySQLSession &	connection,
		const metadata_cache::metadata_server_t &	mi
	)

protected

Connects a MYSQL connection to the given instance.

◆ fetch_auth_credentials()

ClusterMetadata::auth_credentials_t ClusterMetadata::fetch_auth_credentials	(	const metadata_cache::metadata_server_t &	md_server,
		const mysqlrouter::TargetCluster &	target_cluster
	)

overridevirtual

Implements MetaData.

Reimplemented in GRClusterMetadata.

◆ fetch_router_info()

std::optional< routing_guidelines::Router_info > ClusterMetadata::fetch_router_info ( const uint16_t router_id )

overridevirtual

Implements MetaData.

◆ fetch_routing_guidelines_document()

stdx::expected< std::string, std::error_code > ClusterMetadata::fetch_routing_guidelines_document ( const uint16_t router_id )

overridevirtual

Implements MetaData.

◆ find_rw_server() [1/2]

std::optional< metadata_cache::metadata_server_t > ClusterMetadata::find_rw_server ( const std::vector< metadata_cache::ManagedCluster > & clusters )

◆ find_rw_server() [2/2]

std::optional< metadata_cache::metadata_server_t > ClusterMetadata::find_rw_server ( const std::vector< metadata_cache::ManagedInstance > & instances )

◆ get_and_check_metadata_schema_version()

mysqlrouter::MetadataSchemaVersion ClusterMetadata::get_and_check_metadata_schema_version ( mysqlrouter::MySQLSession & session )

protected

◆ get_connection()

std::shared_ptr< mysqlrouter::MySQLSession > ClusterMetadata::get_connection ( )

inlineoverridevirtual

Gets the object representing the session to the metadata server.

Implements MetaData.

◆ get_periodic_stats_update_frequency()

std::optional< std::chrono::seconds > ClusterMetadata::get_periodic_stats_update_frequency ( )

inlineoverridevirtualnoexcept

Implements MetaData.

◆ get_select_routing_guidelines_query()

stdx::expected< std::string, std::error_code > ClusterMetadata::get_select_routing_guidelines_query	(	const mysqlrouter::MetadataSchemaVersion &	schema_version,
		const uint16_t	router_id
	)

inlineprotected

◆ is_connected_to()

bool ClusterMetadata::is_connected_to ( const metadata_cache::metadata_server_t & metadata_server ) const

check if the metadata_connection_ connection is connected to metadata_server and alive.

◆ make_connection_shared()

stdx::expected< std::shared_ptr< mysqlrouter::MySQLSession >, std::string > ClusterMetadata::make_connection_shared ( const metadata_cache::metadata_server_t & metadata_server )

make a connection to metadata_server.

if the metadata_connection_ already is connected to metadata_server, return that instead.

◆ operator=()

ClusterMetadata & ClusterMetadata::operator= ( const ClusterMetadata & )

delete

◆ report_guideline_name()

void ClusterMetadata::report_guideline_name	(	const std::string &	guideline_name,
		const metadata_cache::metadata_server_t &	rw_server,
		const unsigned	router_id
	)

overridevirtual

Implements MetaData.

◆ update_router_attributes()

bool ClusterMetadata::update_router_attributes	(	const metadata_cache::metadata_server_t &	rw_server,
		const unsigned	router_id,
		const metadata_cache::RouterAttributes &	router_attributes
	)

overridevirtual

Implements MetaData.

◆ update_router_last_check_in()

bool ClusterMetadata::update_router_last_check_in	(	const metadata_cache::metadata_server_t &	rw_server,
		const unsigned	router_id
	)

overridevirtual

Implements MetaData.

Member Data Documentation

◆ metadata_connection_

std::shared_ptr<mysqlrouter::MySQLSession> ClusterMetadata::metadata_connection_

protected

◆ router_options_

RouterOptions ClusterMetadata::router_options_

protected

◆ session_config_

metadata_cache::MetadataCacheMySQLSessionConfig ClusterMetadata::session_config_

protected

◆ ssl_mode_

mysql_ssl_mode ClusterMetadata::ssl_mode_

protected

◆ ssl_options_

mysqlrouter::SSLOptions ClusterMetadata::ssl_options_

protected

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

router/src/metadata_cache/src/cluster_metadata.h
router/src/metadata_cache/src/cluster_metadata.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ClusterMetadata() [1/2]

◆ ClusterMetadata() [2/2]

◆ ~ClusterMetadata()

Member Function Documentation

◆ connect_and_setup_session()

◆ disconnect()

◆ do_connect()

◆ fetch_auth_credentials()

◆ fetch_router_info()

◆ fetch_routing_guidelines_document()

◆ find_rw_server() [1/2]

◆ find_rw_server() [2/2]

◆ get_and_check_metadata_schema_version()

◆ get_connection()

◆ get_periodic_stats_update_frequency()

◆ get_select_routing_guidelines_query()

◆ is_connected_to()

◆ make_connection_shared()

◆ operator=()

◆ report_guideline_name()

◆ update_router_attributes()

◆ update_router_last_check_in()

Member Data Documentation

◆ metadata_connection_

◆ router_options_

◆ session_config_

◆ ssl_mode_

◆ ssl_options_