mysql_column.h

Go to the documentation of this file.

/*
  Copyright (c) 2022, 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 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 ROUTER_SRC_MYSQL_REST_SERVICE_SRC_HELPER_MYSQL_COLUMN_H_
#define ROUTER_SRC_MYSQL_REST_SERVICE_SRC_HELPER_MYSQL_COLUMN_H_
 
#include <string>
 
#include <mysql.h>
 
#include "helper/mysql_column_types.h"
 
namespace helper {
 
struct Column {
  Column() : type{MYSQL_TYPE_NULL}, type_json{JsonType::kNull} {}
 
  Column(const std::string &column_name, const char *t, bool primary = false,
         bool auto_increment = false, const bool p_is_bound = false)
      : name{column_name},
        is_primary{primary},
        is_auto_increment{auto_increment},
        is_bound{p_is_bound} {
    auto info = from_mysql_txt_column_type(t);
    type = info.type_mysql;
    type_json = info.type_json;
    type_txt = t;
    length = info.length;
  }
 
  explicit Column(const MYSQL_FIELD *field, const bool p_is_bound = false)
      : name{field->name, field->name_length},
        type(field->type),
        type_txt(txt_from_mysql_column_type(field)),
        length(field->length),
        type_json{from_mysql_column_type(field)},
        is_primary{IS_PRI_KEY(field->flags) > 0},
        is_auto_increment{(field->flags & AUTO_INCREMENT_FLAG) > 0},
        is_bound{p_is_bound} {}
 
 public:
  std::string name;
  enum_field_types type{MYSQL_TYPE_NULL};
  std::string type_txt;
  uint64_t length{0};
  JsonType type_json{JsonType::kNull};
  bool is_primary{false};
  bool is_auto_increment{false};
  // Column was generated for output parameters, configured with MYSQL_BIND
  bool is_bound{false};
};
 
}  // namespace helper
 
#endif  // ROUTER_SRC_MYSQL_REST_SERVICE_SRC_HELPER_MYSQL_COLUMN_H_