object_filter.h

Go to the documentation of this file.

/*
  Copyright (c) 2015, 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 OBJECT_FILTER_INCLUDED
#define OBJECT_FILTER_INCLUDED
 
#include <optional>
#include <string>
#include <vector>
 
#include "client/base/abstract_program.h"
#include "client/base/composite_options_provider.h"
#include "client/dump/abstract_data_object.h"
 
namespace Mysql {
namespace Tools {
namespace Dump {
 
class Object_filter
    : public Mysql::Tools::Base::Options::Composite_options_provider {
 public:
  explicit Object_filter(Mysql::Tools::Base::Abstract_program *program);
 
  void create_options() override;
 
  bool is_object_included_in_dump(Abstract_data_object *object);
 
  std::vector<std::pair<std::string, std::string>> m_databases_excluded;
  std::vector<std::pair<std::string, std::string>> m_databases_included;
  std::vector<std::pair<std::string, std::string>> m_tables_excluded;
  std::vector<std::pair<std::string, std::string>> m_tables_included;
 
 private:
  bool is_object_included_by_lists(
      const std::string &schema_name, const std::string &object_name,
      std::vector<std::pair<std::string, std::string>> *include_list,
      std::vector<std::pair<std::string, std::string>> *exclude_list);
  void include_databases_callback(char *);
  void exclude_databases_callback(char *);
  void include_tables_callback(char *);
  void exclude_tables_callback(char *);
  void include_routines_callback(char *);
  void exclude_routines_callback(char *);
  void include_triggers_callback(char *);
  void exclude_triggers_callback(char *);
  void include_events_callback(char *);
  void exclude_events_callback(char *);
  void include_users_callback(char *);
  void exclude_users_callback(char *);
 
  bool is_user_included_by_lists(
      const std::string &object_name,
      std::vector<std::pair<std::string, std::string>> *include_list,
      std::vector<std::pair<std::string, std::string>> *exclude_list);
 
  void process_object_inclusion_string(
      std::vector<std::pair<std::string, std::string>> &list,
      bool allow_schema = true, bool is_user_object = false);
 
  std::vector<std::pair<std::string, std::string>> m_routines_excluded;
  std::vector<std::pair<std::string, std::string>> m_routines_included;
  std::vector<std::pair<std::string, std::string>> m_triggers_excluded;
  std::vector<std::pair<std::string, std::string>> m_triggers_included;
  std::vector<std::pair<std::string, std::string>> m_events_excluded;
  std::vector<std::pair<std::string, std::string>> m_events_included;
  std::vector<std::pair<std::string, std::string>> m_users_included;
  std::vector<std::pair<std::string, std::string>> m_users_excluded;
 
  bool m_dump_routines;
  bool m_dump_triggers;
  bool m_dump_events;
  bool m_dump_users;
  std::optional<std::string> m_include_tmp_string;
  Mysql::Tools::Base::Abstract_program *m_program;
};
 
}  // namespace Dump
}  // namespace Tools
}  // namespace Mysql
 
#endif