The ARClusterMetadata class encapsulates a connection to the ReplicaSet Cluster metadata server. More...

#include <cluster_metadata_ar.h>

Inheritance diagram for ARClusterMetadata:

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

	ARClusterMetadata (const ARClusterMetadata &)=delete

ARClusterMetadata &	operator= (const ARClusterMetadata &)=delete

	~ARClusterMetadata () override
	Destructor. More...

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 &, std::size_t &instance_id, std::string &routing_guidelines) override
	Returns cluster defined in the metadata given set of the metadata servers (cluster members) More...

mysqlrouter::ClusterType	get_cluster_type () override
	Returns cluster type this object is suppsed to handle. More...

void	setup_notifications_listener (const metadata_cache::ClusterTopology &, const GRNotificationListener::NotificationClb &) override

void	shutdown_notifications_listener () override
	Deinitializes the notifications listener thread. More...

Public Member Functions inherited from ClusterMetadata
	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
	MetaData ()=default

	MetaData (const MetaData &)=delete

MetaData &	operator= (const MetaData &)=delete

virtual	~MetaData ()=default

Private Member Functions
metadata_cache::ClusterTopology	fetch_topology_from_member (mysqlrouter::MySQLSession &session, unsigned view_id, const std::string &cluster_id="")
	Returns the current cluster topology according to the metadata of the given metadata server. More...

bool	get_member_view_id (mysqlrouter::MySQLSession &session, const std::string &cluster_id, uint64_t &result)
	Returns metadata view id the given member holds. More...

Private Attributes
uint64_t	view_id_

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 > >

Protected Member Functions inherited from ClusterMetadata
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 inherited from ClusterMetadata
mysql_ssl_mode	ssl_mode_

mysqlrouter::SSLOptions	ssl_options_

metadata_cache::MetadataCacheMySQLSessionConfig	session_config_

std::shared_ptr< mysqlrouter::MySQLSession >	metadata_connection_

RouterOptions	router_options_

Detailed Description

The ARClusterMetadata class encapsulates a connection to the ReplicaSet Cluster metadata server.

Constructor & Destructor Documentation

◆ ARClusterMetadata() [1/2]

ARClusterMetadata::ARClusterMetadata	(	const metadata_cache::MetadataCacheMySQLSessionConfig &	session_config,
		const mysqlrouter::SSLOptions &	ssl_options,
		uint64_t	view_id
	)

inline

Constructor.

Parameters

session_config	Metadata MySQL session configuration
ssl_options	SSL related options to use for MySQL connections
view_id	last known view_id of the cluster metadata

◆ ARClusterMetadata() [2/2]

ARClusterMetadata::ARClusterMetadata ( const ARClusterMetadata & )

explicitdelete

◆ ~ARClusterMetadata()

ARClusterMetadata::~ARClusterMetadata ( )

overridedefault

Destructor.

Disconnect and release the connection to the metadata node.

Member Function Documentation

◆ fetch_cluster_topology()

stdx::expected< metadata_cache::ClusterTopology, std::error_code > ARClusterMetadata::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 &	,
		std::size_t &	instance_id,
		std::string &	routing_guidelines
	)

overridevirtual

Returns cluster defined in the metadata given set of the metadata servers (cluster members)

Parameters

	terminated	flag indicating that the process is cterminating, allowing the function to leave earlier if possible
[in,out]	target_cluster	object identifying the Cluster this operation refers to
	router_id	id of the router in the cluster metadata
	metadata_servers	set of the metadata servers to use to fetch the metadata
	needs_writable_node	flag indicating if the caller needs us to query for writable node
[out]	instance_id	id of the server the metadata was fetched from
	routing_guidelines	Routing Guidelines document

Returns: object containing cluster topology information in case of success, or error code in case of failure

Exceptions

metadata_cache::metadata_error If fetching metadata fails.

Implements MetaData.

◆ fetch_topology_from_member()

metadata_cache::ClusterTopology ARClusterMetadata::fetch_topology_from_member	(	mysqlrouter::MySQLSession &	session,
		unsigned	view_id,
		const std::string &	cluster_id = `""`
	)

private

Returns the current cluster topology according to the metadata of the given metadata server.

Parameters

session	active connection to the member that is checked for the metadata
view_id	last known view_id of the cluster metadata
cluster_id	ID of the cluster this operation refers to

Returns: vector of the cluster members

◆ get_cluster_type()

mysqlrouter::ClusterType ARClusterMetadata::get_cluster_type ( )

inlineoverridevirtual

Returns cluster type this object is suppsed to handle.

Implements MetaData.

◆ get_member_view_id()

bool ARClusterMetadata::get_member_view_id	(	mysqlrouter::MySQLSession &	session,
		const std::string &	cluster_id,
		uint64_t &	result
	)

private

Returns metadata view id the given member holds.

Parameters

	session	active connection to the member that is checked for the view id
	cluster_id	ID of the cluster this operation refers to
[out]	result	member's metadata view_id

Return values

true	on success
false	otherwise.

◆ operator=()

ARClusterMetadata & ARClusterMetadata::operator= ( const ARClusterMetadata & )

delete

◆ setup_notifications_listener()

void ARClusterMetadata::setup_notifications_listener	(	const metadata_cache::ClusterTopology &	,
		const GRNotificationListener::NotificationClb &
	)

inlineoverridevirtual

Implements MetaData.

◆ shutdown_notifications_listener()

void ARClusterMetadata::shutdown_notifications_listener ( )

inlineoverridevirtual

Deinitializes the notifications listener thread.

Implements MetaData.

Member Data Documentation

◆ view_id_

uint64_t ARClusterMetadata::view_id_

private

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

router/src/metadata_cache/src/cluster_metadata_ar.h
router/src/metadata_cache/src/cluster_metadata_ar.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ARClusterMetadata() [1/2]

◆ ARClusterMetadata() [2/2]

◆ ~ARClusterMetadata()

Member Function Documentation

◆ fetch_cluster_topology()

◆ fetch_topology_from_member()

◆ get_cluster_type()

◆ get_member_view_id()

◆ operator=()

◆ setup_notifications_listener()

◆ shutdown_notifications_listener()

Member Data Documentation

◆ view_id_