Chain maker implemented in Mysql_dump application, constructs chain based on command line options that are compatible with these available in previous implementation. More...

#include <mysqldump_tool_chain_maker.h>

Inheritance diagram for Mysql::Tools::Dump::Mysqldump_tool_chain_maker:

[legend]

Public Member Functions
	Mysqldump_tool_chain_maker (I_connection_provider connection_provider, std::function< bool(const Mysql::Tools::Base::Message_data &)> message_handler, Simple_id_generator object_id_generator, Mysqldump_tool_chain_maker_options options, Mysql::Tools::Base::Abstract_program *program)

	~Mysqldump_tool_chain_maker () override

I_object_reader *	create_chain (Chain_data chain_data, I_dump_task dump_task) override
	Creates new chain for specified dump task. More...

void	delete_chain (uint64 chain_id, I_object_reader *chain) override
	Frees resources used by specified chain. More...

void	register_progress_watcher (I_progress_watcher *new_progress_watcher) override
	Add new Progress Watcher to report to. More...

uint64	get_id () const override
	Returns an application unique ID of this chain element object. More...

Public Member Functions inherited from Mysql::Tools::Dump::I_chain_element
	~I_chain_element () override

Public Member Functions inherited from Mysql::Tools::Dump::I_progress_reporter
virtual	~I_progress_reporter ()

Public Member Functions inherited from Mysql::Tools::Dump::Abstract_chain_element
Abstract_chain_element &	operator= (Abstract_chain_element &&other)=delete
	Disable move assignment to avoid Wvirtual-move-assign warning. More...

Protected Member Functions
void	item_completion_in_child_callback (Item_processing_data *item_processed) override
	This callback can be requested to be called by child for any object processing. More...

Protected Member Functions inherited from Mysql::Tools::Dump::Abstract_chain_element
	Abstract_chain_element (std::function< bool(const Mysql::Tools::Base::Message_data &)> message_handler, Simple_id_generator object_id_generator)

template<typename TType , typename TClass >
bool	try_process_task (Item_processing_data item_to_process, void(TClass::processing_func)(TType , Item_processing_data ))
	Process task object with specified function if that task object can be casted to type TType. More...

template<typename TType , typename TClass >
bool	try_process_task (Item_processing_data item_to_process, void(TClass::processing_func)(TType *))
	Process task object with specified function if that task object can be casted to type TType. More...

void	object_processing_starts (Item_processing_data *item_to_process)

Item_processing_data *	object_to_be_processed_in_child (Item_processing_data current_item_data, I_chain_element child_chain_element)

Item_processing_data *	new_task_created (I_dump_task *dump_task_created)

Item_processing_data *	new_chain_created (Chain_data new_chain_data, Item_processing_data parent_processing_data, I_chain_element *child_chain_element)

Item_processing_data *	new_chain_created (Item_processing_data current_item_data, I_dump_task dump_task_created)

void	object_processing_ends (Item_processing_data *processed_item)

uint64	generate_new_object_id ()

Simple_id_generator *	get_object_id_generator () const

void	pass_message (const Mysql::Tools::Base::Message_data &message_data)
	Passes message to message callback. More...

std::function< bool(const Mysql::Tools::Base::Message_data &)> *	get_message_handler () const

virtual bool	need_callbacks_in_child ()

Protected Member Functions inherited from Mysql::Tools::Dump::Abstract_progress_reporter
bool	have_progress_watcher ()
	Specifies if have any Progress Watcher registered. More...

void	report_new_chain_created (Item_processing_data *new_chain_creator)
	Reports new non-empty chain being created by Chain Maker or new row fetched from table by Table Reader. More...

void	report_object_processing_started (Item_processing_data *process_data)
	Report new object(table, row or any other) was started processing by specified Object Reader, Table Reader, Formatter or Row Formatter. More...

void	report_object_processing_ended (Item_processing_data *finished_process_data)
	Report object(table, row or any other) finished being processed. More...

virtual void	report_crawler_completed (I_crawler *crawler)
	Reports crawler ended enumerating objects and creating chains for them. More...

void	register_progress_watchers_in_child (I_progress_reporter *reporter)

Protected Member Functions inherited from Mysql::Tools::Dump::Abstract_mysql_chain_element_extension
	Abstract_mysql_chain_element_extension (I_connection_provider connection_provider, std::function< bool(const Mysql::Tools::Base::Message_data &)> message_handler, const Mysql_chain_element_options *options)

Mysql::Tools::Base::Mysql_query_runner *	get_runner () const

I_connection_provider *	get_connection_provider () const

uint64	get_server_version ()

std::string	get_server_version_string ()

int	compare_no_case_latin_with_db_string (const std::string &latin_name, const std::string &db_name)

std::optional< std::string >	get_create_statement (Mysql::Tools::Base::Mysql_query_runner *runner, const std::string &database_name, const std::string &object_name, const std::string &object_type, uint field_id=1)
	Gets CREATE statement for specified object. More...

std::string	quote_name (const std::string &name)
	Quotes char string, taking into account compatible mode. More...

std::string	get_quoted_object_full_name (const Abstract_data_object *object)

std::string	get_quoted_object_full_name (const std::string &database_name, const std::string &object_name)

const Mysql_chain_element_options *	get_mysql_chain_element_options () const

CHARSET_INFO *	get_charset () const

Private Member Functions
void	mysql_thread_callback (bool is_starting)

void	stop_queues () override

Private Attributes
Mysqldump_tool_chain_maker_options *	m_options

Mysql_object_reader *	m_main_object_reader

std::map< int, Object_queue * >	m_object_queues

std::vector< I_chain_element * >	m_all_created_elements

Mysql::Tools::Base::Abstract_program *	m_program

Detailed Description

Chain maker implemented in Mysql_dump application, constructs chain based on command line options that are compatible with these available in previous implementation.

Constructor & Destructor Documentation

◆ Mysqldump_tool_chain_maker()

Mysqldump_tool_chain_maker::Mysqldump_tool_chain_maker	(	I_connection_provider *	connection_provider,
		std::function< bool(const Mysql::Tools::Base::Message_data &)> *	message_handler,
		Simple_id_generator *	object_id_generator,
		Mysqldump_tool_chain_maker_options *	options,
		Mysql::Tools::Base::Abstract_program *	program
	)

◆ ~Mysqldump_tool_chain_maker()

Mysqldump_tool_chain_maker::~Mysqldump_tool_chain_maker ( )

override

Member Function Documentation

◆ create_chain()

I_object_reader * Mysqldump_tool_chain_maker::create_chain	(	Chain_data *	chain_data,
		I_dump_task *	dump_task
	)

overridevirtual

Creates new chain for specified dump task.

May return null if do not want to process specified object.

Implements Mysql::Tools::Dump::I_chain_maker.

◆ delete_chain()

void Mysqldump_tool_chain_maker::delete_chain	(	uint64	chain_id,
		I_object_reader *	chain
	)

overridevirtual

Frees resources used by specified chain.

Implements Mysql::Tools::Dump::I_chain_maker.

◆ get_id()

uint64 Mysql::Tools::Dump::Mysqldump_tool_chain_maker::get_id ( ) const

inlineoverridevirtual

Returns an application unique ID of this chain element object.

This helps progress watching with multiple parts of chain during all objects processing.

Reimplemented from Mysql::Tools::Dump::Abstract_chain_element.

◆ item_completion_in_child_callback()

void Mysql::Tools::Dump::Mysqldump_tool_chain_maker::item_completion_in_child_callback ( Item_processing_data * item_processed )

inlineoverrideprotectedvirtual

This callback can be requested to be called by child for any object processing.

This will be called when the object processing has completed. Note that this function may be called from multiple threads so all implementations must be thread-safe.

Reimplemented from Mysql::Tools::Dump::Abstract_chain_element.

◆ mysql_thread_callback()

void Mysqldump_tool_chain_maker::mysql_thread_callback ( bool is_starting )

private

◆ register_progress_watcher()

void Mysql::Tools::Dump::Mysqldump_tool_chain_maker::register_progress_watcher ( I_progress_watcher * new_progress_watcher )

inlineoverridevirtual

Add new Progress Watcher to report to.

Reimplemented from Mysql::Tools::Dump::Abstract_chain_element.

◆ stop_queues()

void Mysqldump_tool_chain_maker::stop_queues ( )

overrideprivatevirtual

Implements Mysql::Tools::Dump::I_chain_maker.

Member Data Documentation

◆ m_all_created_elements

std::vector<I_chain_element *> Mysql::Tools::Dump::Mysqldump_tool_chain_maker::m_all_created_elements

private

◆ m_main_object_reader

Mysql_object_reader* Mysql::Tools::Dump::Mysqldump_tool_chain_maker::m_main_object_reader

private

◆ m_object_queues

std::map<int, Object_queue *> Mysql::Tools::Dump::Mysqldump_tool_chain_maker::m_object_queues

private

◆ m_options

Mysqldump_tool_chain_maker_options* Mysql::Tools::Dump::Mysqldump_tool_chain_maker::m_options

private

◆ m_program

Mysql::Tools::Base::Abstract_program* Mysql::Tools::Dump::Mysqldump_tool_chain_maker::m_program

private

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

client/dump/mysqldump_tool_chain_maker.h
client/dump/mysqldump_tool_chain_maker.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Mysqldump_tool_chain_maker()

◆ ~Mysqldump_tool_chain_maker()

Member Function Documentation

◆ create_chain()

◆ delete_chain()

◆ get_id()

◆ item_completion_in_child_callback()

◆ mysql_thread_callback()

◆ register_progress_watcher()

◆ stop_queues()

Member Data Documentation

◆ m_all_created_elements

◆ m_main_object_reader

◆ m_object_queues

◆ m_options

◆ m_program