object_table_definition_impl.h

Go to the documentation of this file.

/* Copyright (c) 2014, 2025, 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 DD__OBJECT_TABLE_DEFINITION_IMPL_INCLUDED
#define DD__OBJECT_TABLE_DEFINITION_IMPL_INCLUDED
 
#include <assert.h>
#include <map>
#include <memory>
#include <vector>
 
#include "sql/dd/string_type.h"                    // dd::String_type
#include "sql/dd/types/object_table_definition.h"  // dd::Object_table_definition
#include "sql/mysqld.h"                            // lower_case_table_names
 
namespace dd {
 
class Properties;
 
///////////////////////////////////////////////////////////////////////////
 
class Object_table_definition_impl : public Object_table_definition {
 public:
  typedef std::map<String_type, int> Element_numbers;
  typedef std::map<int, String_type> Element_definitions;
 
 private:
  enum class Label {
    NAME,
    FIELDS,
    INDEXES,
    FOREIGN_KEYS,
    OPTIONS,
    LABEL,
    POSITION,
    DEFINITION,
    ELEMENT
  };
 
  static const char *key(Label label) {
    switch (label) {
      case Label::NAME:
        return "name";
      case Label::FIELDS:
        return "fields";
      case Label::INDEXES:
        return "indexes";
      case Label::FOREIGN_KEYS:
        return "foreign_keys";
      case Label::OPTIONS:
        return "options";
      case Label::LABEL:
        return "lbl";
      case Label::POSITION:
        return "pos";
      case Label::DEFINITION:
        return "def";
      case Label::ELEMENT:
        return "elem";
      default:
        assert(false);
        return "";
    }
  }
 
  static bool s_dd_tablespace_encrypted;
 
  String_type m_schema_name;
  String_type m_table_name;
 
  String_type m_ddl_statement;
 
  Element_numbers m_field_numbers;
  Element_definitions m_field_definitions;
 
  Element_numbers m_index_numbers;
  Element_definitions m_index_definitions;
 
  Element_numbers m_foreign_key_numbers;
  Element_definitions m_foreign_key_definitions;
 
  Element_numbers m_option_numbers;
  Element_definitions m_option_definitions;
 
  std::vector<String_type> m_dml_statements;
 
  void add_element(int element_number, const String_type &element_name,
                   const String_type &element_definition,
                   Element_numbers *element_numbers,
                   Element_definitions *element_definitions) {
    assert(element_numbers != nullptr && element_definitions != nullptr &&
           element_numbers->find(element_name) == element_numbers->end() &&
           element_definitions->find(element_number) ==
               element_definitions->end());
 
    (*element_numbers)[element_name] = element_number;
    (*element_definitions)[element_number] = element_definition;
  }
 
  int element_number(const String_type &element_name,
                     const Element_numbers &element_numbers) const {
    assert(element_numbers.find(element_name) != element_numbers.end());
    return element_numbers.find(element_name)->second;
  }
 
  void get_element_properties(dd::Properties *properties,
                              const Element_numbers &element_numbers,
                              const Element_definitions &element_defs) const;
 
  bool set_element_properties(const String_type &prop_str,
                              Element_numbers *element_numbers,
                              Element_definitions *element_defs);
 
 public:
  Object_table_definition_impl() = default;
 
  Object_table_definition_impl(const String_type &schema_name,
                               const String_type &table_name,
                               const String_type &ddl_statement)
      : m_schema_name(schema_name),
        m_table_name(table_name),
        m_ddl_statement(ddl_statement) {}
 
  ~Object_table_definition_impl() override = default;
 
  static void set_dd_tablespace_encrypted(bool is_encrypted) {
    s_dd_tablespace_encrypted = is_encrypted;
  }
 
  static bool is_dd_tablespace_encrypted() { return s_dd_tablespace_encrypted; }
 
  /**
    Get the collation which is used for names related to the file
    system (e.g. a schema name or table name). This collation is
    case sensitive or not, depending on the setting of lower_case-
    table_names.
 
    @return Pointer to CHARSET_INFO.
   */
 
  static const CHARSET_INFO *fs_name_collation() {
    if (lower_case_table_names == 0) return &my_charset_utf8mb3_bin;
    return &my_charset_utf8mb3_tolower_ci;
  }
 
  /**
    Get the collation which is used for the name field in the table.
    Table collation UTF8_BIN is used when collation for the name field
    is not specified. Tables using different collation must override this
    method.
 
    TODO: Changing table collation is not supporting during upgrade as of now.
          To support this, static definition of this method should be avoided
          and should provide a possibility to have different collations for
          actual and target table definition.
 
    @return Pointer to CHARSET_INFO.
  */
  static const CHARSET_INFO *name_collation() {
    return &my_charset_utf8mb3_bin;
  }
 
  /**
    Convert to lowercase if lower_case_table_names == 2. This is needed
    e.g when reconstructing name keys from a dictionary object in order
    to remove the object.
 
    @param          src  String to possibly convert to lowercase.
    @param [in,out] buf  Buffer for storing lowercase'd string. Supplied
                         by the caller.
 
    @returns  A pointer to the src string if l_c_t_n != 2
    @returns  A pointer to the buf supplied by the caller, into which
             the src string has been copied and lowercase'd, if l_c_t_n == 2
   */
 
  static const char *fs_name_case(const String_type &src, char *buf) {
    const char *tmp_name = src.c_str();
    if (lower_case_table_names == 2) {
      // Lower case table names == 2 is tested on OSX.
      /* purecov: begin tested */
      my_stpcpy(buf, tmp_name);
      my_casedn_str(fs_name_collation(), buf);
      tmp_name = buf;
      /* purecov: end */
    }
    return tmp_name;
  }
 
  const String_type &get_table_name() const { return m_table_name; }
 
  void set_table_name(const String_type &name) override { m_table_name = name; }
 
  void set_schema_name(const String_type &name) { m_schema_name = name; }
 
  void add_field(int field_number, const String_type &field_name,
                 const String_type field_definition) override {
    add_element(field_number, field_name, field_definition, &m_field_numbers,
                &m_field_definitions);
  }
 
  void add_sql_mode_field(int field_number, const String_type &field_name);
 
  void add_index(int index_number, const String_type &index_name,
                 const String_type &index_definition) override {
    add_element(index_number, index_name, index_definition, &m_index_numbers,
                &m_index_definitions);
  }
 
  virtual void add_foreign_key(int foreign_key_number,
                               const String_type &foreign_key_name,
                               const String_type &foreign_key_definition) {
    add_element(foreign_key_number, foreign_key_name, foreign_key_definition,
                &m_foreign_key_numbers, &m_foreign_key_definitions);
  }
 
  virtual void add_option(int option_number, const String_type &option_name,
                          const String_type &option_definition) {
    add_element(option_number, option_name, option_definition,
                &m_option_numbers, &m_option_definitions);
  }
 
  virtual void add_populate_statement(const String_type &statement) {
    m_dml_statements.push_back(statement);
  }
 
  virtual int field_number(const String_type &field_name) const {
    return element_number(field_name, m_field_numbers);
  }
 
  virtual int index_number(const String_type &index_name) const {
    return element_number(index_name, m_index_numbers);
  }
 
  virtual int option_number(const String_type &option_name) const {
    return element_number(option_name, m_option_numbers);
  }
 
  String_type get_ddl() const override;
 
  const std::vector<String_type> &get_dml() const override {
    return m_dml_statements;
  }
 
  void store_into_properties(Properties *table_def_properties) const override;
 
  virtual bool restore_from_string(const String_type &ddl_statement) {
    m_ddl_statement = ddl_statement;
    return false;
  }
 
  bool restore_from_properties(const Properties &table_def_properties) override;
};
 
///////////////////////////////////////////////////////////////////////////
 
}  // namespace dd
 
#endif  // DD__OBJECT_TABLE_DEFINITION_IMPL_INCLUDED