MySQL 8.0.31
Source Code Documentation
Mysql::Tools::Upgrade::Program Class Reference
Inheritance diagram for Mysql::Tools::Upgrade::Program:
[legend]

Public Member Functions

 Program ()
 
string get_version () override
 Returns string describing current version of this program. More...
 
int get_first_release_year () override
 Returns year of first release of this program. More...
 
string get_description () override
 Returns string describing shortly current program. More...
 
void short_usage () override
 Prints program invocation message. More...
 
int get_error_code () override
 Return error code. More...
 
int execute (const vector< string > &) override
 Returns 0 (success) unconditionally, along with a deprecation message. More...
 
void create_options () override
 Creates all options that will be provided. More...
 
void error (const Message_data &message) override
 Handles general errors. More...
 
- Public Member Functions inherited from Mysql::Tools::Base::Abstract_connection_program
MYSQLcreate_connection () override
 Provides new connection to MySQL database server based on option values. More...
 
CHARSET_INFOget_current_charset () const
 Retrieves charset that will be used in new MySQL connections. More...
 
void set_current_charset (CHARSET_INFO *charset)
 Sets charset that will be used in new MySQL connections. More...
 
- Public Member Functions inherited from Mysql::Tools::Base::Abstract_program
 ~Abstract_program () override
 
const std::string get_name ()
 Returns null-terminated string with name of current program. More...
 
my_optionget_options_array ()
 Returns pointer to array of options for usage in handle_options. More...
 
void run (int argc, char **argv)
 Does all initialization and exit work, calls execute(). More...
 
virtual int execute (const std::vector< std::string > &positional_options)=0
 Runs main program code. More...
 
- Public Member Functions inherited from Mysql::Tools::Base::Options::Composite_options_provider
void add_providers (I_options_provider *first,...)
 Adds new providers to list. More...
 
void add_provider (I_options_provider *options_provider)
 Adds new provider to list. More...
 
void options_parsed () override
 This callback is to be called after all options were parsed. More...
 
std::vector< my_optiongenerate_options () override
 Aggregates all options from itsself and all contained providers. More...
 
- Public Member Functions inherited from Mysql::Tools::Base::Options::Abstract_options_provider
Simple_optioncreate_new_option (std::string name, std::string description)
 Creates and attach new simple option. More...
 
Disabled_optioncreate_new_disabled_option (std::string name, std::string description)
 Creates and attach new disabled option. More...
 
Char_array_optioncreate_new_option (char **value, std::string name, std::string description)
 Creates and attach new string option stored in char* type object. More...
 
Password_optioncreate_new_password_option (std::optional< std::string > *value, std::string name, std::string description)
 Creates and attach new password option. More...
 
String_optioncreate_new_option (std::optional< std::string > *value, std::string name, std::string description)
 Creates and attach new string option. More...
 
Number_option< int32 > * create_new_option (int32 *value, std::string name, std::string description)
 Creates and attach new 32-bit signed number option. More...
 
Number_option< uint32 > * create_new_option (uint32 *value, std::string name, std::string description)
 Creates and attach new 32-bit unsigned number option. More...
 
Number_option< int64 > * create_new_option (int64 *value, std::string name, std::string description)
 Creates and attach new 64-bit signed number option. More...
 
Number_option< uint64 > * create_new_option (uint64 *value, std::string name, std::string description)
 Creates and attach new 64-bit unsigned number option. More...
 
Number_option< double > * create_new_option (double *value, std::string name, std::string description)
 Creates and attach new floating-point number option. More...
 
Bool_optioncreate_new_option (bool *value, std::string name, std::string description)
 Creates and attach new boolean option with value received from argument. More...
 
template<typename T_type , typename T_typelib >
Enum_option< T_type, T_typelib > * create_new_enum_option (T_type *value, const T_typelib *type, std::string name, std::string description)
 
- Public Member Functions inherited from Mysql::Tools::Base::Options::I_option_changed_listener
virtual ~I_option_changed_listener ()=default
 
- Public Member Functions inherited from Mysql::Tools::Base::I_connection_factory
virtual ~I_connection_factory ()=default
 

Private Member Functions

int print_error (int exit_code, string message)
 Prints error occurred in main routine. More...
 
int print_message (int exit_code, string message)
 

Private Attributes

MYSQLm_mysql_connection
 
bool m_write_binlog
 
bool m_upgrade_systables_only
 
bool m_skip_sys_schema
 
bool m_check_version
 
bool m_ignore_errors
 
bool m_verbose
 
bool m_temporary_verbose
 Enabled during some queries execution to force printing all notes and warnings regardless "verbose" option. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Mysql::Tools::Base::Abstract_connection_program
 Abstract_connection_program ()
 
- Protected Member Functions inherited from Mysql::Tools::Base::Abstract_program
 Abstract_program ()
 
- Protected Member Functions inherited from Mysql::Tools::Base::Options::Abstract_options_provider
 Abstract_options_provider ()
 
 ~Abstract_options_provider () override
 
void set_option_changed_listener (I_option_changed_listener *listener) override
 Sets optional option changes listener to which all changes in all options contained in this provider should be reported. More...
 

Constructor & Destructor Documentation

◆ Program()

Mysql::Tools::Upgrade::Program::Program ( )
inline

Member Function Documentation

◆ create_options()

void Mysql::Tools::Upgrade::Program::create_options ( )
inlineoverridevirtual

Creates all options that will be provided.

Implements Mysql::Tools::Base::Options::Abstract_options_provider.

◆ error()

void Mysql::Tools::Upgrade::Program::error ( const Message_data message)
inlineoverridevirtual

Handles general errors.

Implements Mysql::Tools::Base::Abstract_program.

◆ execute()

int Mysql::Tools::Upgrade::Program::execute ( const vector< string > &  )
inlineoverride

Returns 0 (success) unconditionally, along with a deprecation message.

Returns
0 (success)

◆ get_description()

string Mysql::Tools::Upgrade::Program::get_description ( )
inlineoverridevirtual

Returns string describing shortly current program.

Implements Mysql::Tools::Base::Abstract_program.

◆ get_error_code()

int Mysql::Tools::Upgrade::Program::get_error_code ( )
inlineoverridevirtual

Return error code.

Implements Mysql::Tools::Base::Abstract_program.

◆ get_first_release_year()

int Mysql::Tools::Upgrade::Program::get_first_release_year ( )
inlineoverridevirtual

Returns year of first release of this program.

Implements Mysql::Tools::Base::Abstract_program.

◆ get_version()

string Mysql::Tools::Upgrade::Program::get_version ( )
inlineoverridevirtual

Returns string describing current version of this program.

Implements Mysql::Tools::Base::Abstract_program.

◆ print_error()

int Mysql::Tools::Upgrade::Program::print_error ( int  exit_code,
string  message 
)
inlineprivate

Prints error occurred in main routine.

◆ print_message()

int Mysql::Tools::Upgrade::Program::print_message ( int  exit_code,
string  message 
)
inlineprivate

◆ short_usage()

void Mysql::Tools::Upgrade::Program::short_usage ( )
inlineoverridevirtual

Prints program invocation message.

Implements Mysql::Tools::Base::Abstract_program.

Member Data Documentation

◆ m_check_version

bool Mysql::Tools::Upgrade::Program::m_check_version
private

◆ m_ignore_errors

bool Mysql::Tools::Upgrade::Program::m_ignore_errors
private

◆ m_mysql_connection

MYSQL* Mysql::Tools::Upgrade::Program::m_mysql_connection
private

◆ m_skip_sys_schema

bool Mysql::Tools::Upgrade::Program::m_skip_sys_schema
private

◆ m_temporary_verbose

bool Mysql::Tools::Upgrade::Program::m_temporary_verbose
private

Enabled during some queries execution to force printing all notes and warnings regardless "verbose" option.

◆ m_upgrade_systables_only

bool Mysql::Tools::Upgrade::Program::m_upgrade_systables_only
private

◆ m_verbose

bool Mysql::Tools::Upgrade::Program::m_verbose
private

◆ m_write_binlog

bool Mysql::Tools::Upgrade::Program::m_write_binlog
private

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