1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
|
/* Copyright (c) 2016, 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__PARAMETER_INCLUDED
#define DD__PARAMETER_INCLUDED
#include "my_inttypes.h"
#include "sql/dd/types/column.h" // dd::Column::enum_column_types
#include "sql/dd/types/entity_object.h" // dd::Entity_object
namespace dd {
///////////////////////////////////////////////////////////////////////////
class Routine;
class Parameter_impl;
class Parameter_type_element;
namespace tables {
class Parameters;
}
///////////////////////////////////////////////////////////////////////////
class Parameter : virtual public Entity_object {
public:
typedef Collection<Parameter_type_element *>
Parameter_type_element_collection;
typedef Parameter_impl Impl;
typedef tables::Parameters DD_table;
public:
~Parameter() override = default;
public:
enum enum_parameter_mode { PM_IN = 1, PM_OUT, PM_INOUT };
public:
/////////////////////////////////////////////////////////////////////////
// Is name null?
/////////////////////////////////////////////////////////////////////////
virtual void set_name_null(bool is_null) = 0;
virtual bool is_name_null() const = 0;
/////////////////////////////////////////////////////////////////////////
// Routine.
/////////////////////////////////////////////////////////////////////////
virtual const Routine &routine() const = 0;
virtual Routine &routine() = 0;
/////////////////////////////////////////////////////////////////////////
// ordinal_position.
/////////////////////////////////////////////////////////////////////////
virtual uint ordinal_position() const = 0;
/////////////////////////////////////////////////////////////////////////
// mode
/////////////////////////////////////////////////////////////////////////
virtual enum_parameter_mode mode() const = 0;
virtual void set_mode(enum_parameter_mode mode) = 0;
virtual void set_parameter_mode_null(bool is_null) = 0;
virtual bool is_parameter_mode_null() const = 0;
/////////////////////////////////////////////////////////////////////////
// data type.
/////////////////////////////////////////////////////////////////////////
virtual enum_column_types data_type() const = 0;
virtual void set_data_type(enum_column_types type) = 0;
/////////////////////////////////////////////////////////////////////////
// display type
/////////////////////////////////////////////////////////////////////////
virtual const String_type &data_type_utf8() const = 0;
virtual void set_data_type_utf8(const String_type &data_type_utf8) = 0;
/////////////////////////////////////////////////////////////////////////
// is_zerofill.
/////////////////////////////////////////////////////////////////////////
virtual bool is_zerofill() const = 0;
virtual void set_zerofill(bool zerofill) = 0;
/////////////////////////////////////////////////////////////////////////
// is_unsigned.
/////////////////////////////////////////////////////////////////////////
virtual bool is_unsigned() const = 0;
virtual void set_unsigned(bool unsigned_flag) = 0;
/////////////////////////////////////////////////////////////////////////
// char_length.
/////////////////////////////////////////////////////////////////////////
virtual size_t char_length() const = 0;
virtual void set_char_length(size_t char_length) = 0;
/////////////////////////////////////////////////////////////////////////
// numeric_precision.
/////////////////////////////////////////////////////////////////////////
virtual uint numeric_precision() const = 0;
virtual void set_numeric_precision(uint numeric_precision) = 0;
/////////////////////////////////////////////////////////////////////////
// numeric_scale.
/////////////////////////////////////////////////////////////////////////
virtual uint numeric_scale() const = 0;
virtual void set_numeric_scale(uint numeric_scale) = 0;
virtual void set_numeric_scale_null(bool is_null) = 0;
virtual bool is_numeric_scale_null() const = 0;
/////////////////////////////////////////////////////////////////////////
// datetime_precision.
/////////////////////////////////////////////////////////////////////////
virtual uint datetime_precision() const = 0;
virtual void set_datetime_precision(uint datetime_precision) = 0;
/////////////////////////////////////////////////////////////////////////
// collation.
/////////////////////////////////////////////////////////////////////////
virtual Object_id collation_id() const = 0;
virtual void set_collation_id(Object_id collation_id) = 0;
/////////////////////////////////////////////////////////////////////////
// Options.
/////////////////////////////////////////////////////////////////////////
virtual const Properties &options() const = 0;
virtual Properties &options() = 0;
virtual bool set_options(const String_type &options_raw) = 0;
/////////////////////////////////////////////////////////////////////////
// Elements.
/////////////////////////////////////////////////////////////////////////
virtual Parameter_type_element *add_element() = 0;
virtual const Parameter_type_element_collection &elements() const = 0;
virtual size_t elements_count() const = 0;
};
///////////////////////////////////////////////////////////////////////////
} // namespace dd
#endif // DD__PARAMETER_INCLUDED
|