options.h

Go to the documentation of this file.

/*
   Copyright (c) 2021, 2024, Oracle and/or its affiliates.
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License, version 2.0,
   as published by the Free Software Foundation.
 
   This program is designed to work with certain software (including
   but not limited to OpenSSL) that is licensed under separate terms,
   as designated in a particular file or component or in included license
   documentation.  The authors of MySQL hereby grant you an additional
   permission to link the program and your derivative works with the
   separately licensed software that they have either included with
   the program or referenced in the documentation.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License, version 2.0, for more details.
 
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
*/
 
#ifndef OPTIONS_INCLUDED
#define OPTIONS_INCLUDED
 
struct MYSQL;
 
namespace options {
 
/**
  Command line options container
*/
 
class Options {
 public:
  /** Help */
  static bool s_help;
  /** Be loud */
  static bool s_verbose;
  /** Component directory location */
  static char *s_component_dir;
  /** Source keyring - Component or plugin */
  static char *s_source_keyring;
  /** Source Keyring configuration path - If it is not in component dir */
  static char *s_source_keyring_configuration_dir;
  /** Destination keyring - Must be a component */
  static char *s_destination_keyring;
  /** Destination Keyring configuration path - If it is not in component dir */
  static char *s_destination_keyring_configuration_dir;
 
  /*
    Following parameters are needed if migration involves an active MySQL server
  */
 
  /** Flag for online migration */
  static bool s_online_migration;
  /** Hostname */
  static char *s_hostname;
  /** Port */
  static unsigned int s_port;
  /** Socket */
  static char *s_socket;
  /** User name */
  static char *s_username;
  /** Password */
  static char *s_password;
  /** Password to be fetched */
  static bool s_tty_password;
};
 
/**
  Process command line options
 
  @param [in, out] argc      Number of arguments
  @param [in, out] argv      Command line argument array
  @param [out]     exit_code Exit code
 
  @returns status of argument processing
    @retval true  Success
    @retval false Failure
*/
bool process_options(int *argc, char ***argv, int &exit_code);
 
/** Initialize MYSQL connection structures */
void init_connection_basic();
 
/** Deinitialize MYSQL connection structures */
void deinit_connection_basic();
 
class Mysql_connection {
 public:
  explicit Mysql_connection(bool connect);
  ~Mysql_connection();
  bool execute(const std::string &command);
  bool ok() const { return ok_; }
 
 private:
  bool ok_;
  MYSQL *mysql;
};
}  // namespace options
 
#endif  // !OPTIONS_INCLUDED