MySQL 9.0.0
Source Code Documentation
index_element_impl.h
Go to the documentation of this file.
1/* Copyright (c) 2014, 2024, Oracle and/or its affiliates.
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6
7 This program is designed to work with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have either included with
13 the program or referenced in the documentation.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License, version 2.0, for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
23
24#ifndef DD__INDEX_ELEMENT_IMPL_INCLUDED
25#define DD__INDEX_ELEMENT_IMPL_INCLUDED
26
27#include <stddef.h>
28#include <sys/types.h>
29#include <new>
30
31#include "m_string.h"
32#include "sql/dd/impl/types/index_impl.h" // dd::Index_impl
33#include "sql/dd/impl/types/weak_object_impl.h" // dd::Weak_object_impl
34#include "sql/dd/sdi_fwd.h"
35#include "sql/dd/string_type.h"
36#include "sql/dd/types/index_element.h" // dd::Index_element
37
38namespace dd {
39
40///////////////////////////////////////////////////////////////////////////
41
42class Column;
43class Index;
44class Object_key;
45class Object_table;
46class Open_dictionary_tables_ctx;
47class Raw_record;
48class Sdi_rcontext;
49class Sdi_wcontext;
50class Weak_object;
51
52///////////////////////////////////////////////////////////////////////////
53
55 public:
58 m_length(-1),
60 m_hidden(false),
63
66 m_length(-1),
68 m_hidden(false),
71
73 Column *column);
74
75 ~Index_element_impl() override = default;
76
77 public:
78 const Object_table &object_table() const override;
79
80 bool validate() const override;
81
82 bool store_attributes(Raw_record *r) override;
83
84 bool restore_attributes(const Raw_record &r) override;
85
86 void serialize(Sdi_wcontext *wctx, Sdi_writer *w) const override;
87
88 bool deserialize(Sdi_rcontext *rctx, const RJ_Value &val) override;
89
92 }
93
94 public:
96
97 /////////////////////////////////////////////////////////////////////////
98 // index.
99 /////////////////////////////////////////////////////////////////////////
100
101 const Index &index() const override { return *m_index; }
102
103 Index &index() override { return *m_index; }
104
105 /////////////////////////////////////////////////////////////////////////
106 // column.
107 /////////////////////////////////////////////////////////////////////////
108
109 const Column &column() const override { return *m_column; }
110
111 Column &column() override { return *m_column; }
112
113 /////////////////////////////////////////////////////////////////////////
114 // ordinal_position.
115 /////////////////////////////////////////////////////////////////////////
116
117 uint ordinal_position() const override { return m_ordinal_position; }
118
119 /////////////////////////////////////////////////////////////////////////
120 // length.
121 /////////////////////////////////////////////////////////////////////////
122
123 uint length() const override { return m_length; }
124
125 void set_length(uint length) override { m_length = length; }
126
127 void set_length_null(bool) override { m_length = (uint)-1; }
128
129 bool is_length_null() const override { return m_length == (uint)-1; }
130
131 /////////////////////////////////////////////////////////////////////////
132 // is_hidden.
133 /////////////////////////////////////////////////////////////////////////
134
135 bool is_hidden() const override { return m_hidden; }
136
137 void set_hidden(bool hidden) override { m_hidden = hidden; }
138
139 /////////////////////////////////////////////////////////////////////////
140 // order.
141 /////////////////////////////////////////////////////////////////////////
142
143 enum_index_element_order order() const override { return m_order; }
144
146
147 bool is_prefix() const override;
148
149 public:
151 return new (std::nothrow) Index_element_impl(index, nullptr);
152 }
153
154 static Index_element_impl *clone(const Index_element_impl &other,
156
157 public:
158 void debug_print(String_type &outb) const override;
159
160 public:
161 Object_key *create_primary_key() const override;
162 bool has_new_primary_key() const override;
163
164 private:
165 // Fields
168
170
172
173 // References to other objects
176};
177
178///////////////////////////////////////////////////////////////////////////
179
180} // namespace dd
181
182#endif // DD__INDEX_ELEMENT_IMPL_INCLUDED
Kerberos Client Authentication nullptr
Definition: auth_kerberos_client_plugin.cc:251
Definition: column.h:88
Definition: index_element_impl.h:54
bool m_hidden
Definition: index_element_impl.h:171
bool store_attributes(Raw_record *r) override
Definition: index_element_impl.cc:101
bool deserialize(Sdi_rcontext *rctx, const RJ_Value &val) override
Re-establishes the state of *this by reading sdi information from the rapidjson DOM subobject provide...
Definition: index_element_impl.cc:134
Column & column() override
Definition: index_element_impl.h:111
uint ordinal_position() const override
Definition: index_element_impl.h:117
void set_length(uint length) override
Definition: index_element_impl.h:125
static void register_tables(Open_dictionary_tables_ctx *otx)
Definition: index_element_impl.cc:223
bool has_new_primary_key() const override
Indicates that object is guaranteed to have primary key value which doesn't exist in database (e....
Definition: index_element_impl.cc:167
Index_impl * m_index
Definition: index_element_impl.h:174
uint m_length
Definition: index_element_impl.h:167
const Index & index() const override
Definition: index_element_impl.h:101
Index & index() override
Definition: index_element_impl.h:103
bool is_hidden() const override
Definition: index_element_impl.h:135
void set_ordinal_position(uint ordinal_position)
Definition: index_element_impl.h:90
bool restore_attributes(const Raw_record &r) override
Definition: index_element_impl.cc:77
void set_order(enum_index_element_order order) override
Definition: index_element_impl.h:145
void set_length_null(bool) override
Definition: index_element_impl.h:127
uint length() const override
Definition: index_element_impl.h:123
Index_element_impl(Index_impl *index, Column *column)
Definition: index_element_impl.h:64
void serialize(Sdi_wcontext *wctx, Sdi_writer *w) const override
Converts *this into json.
Definition: index_element_impl.cc:122
Column * m_column
Definition: index_element_impl.h:175
static Index_element_impl * restore_item(Index_impl *index)
Definition: index_element_impl.h:150
enum_index_element_order m_order
Definition: index_element_impl.h:169
uint m_ordinal_position
Definition: index_element_impl.h:166
bool is_length_null() const override
Definition: index_element_impl.h:129
bool validate() const override
Definition: index_element_impl.cc:65
Object_key * create_primary_key() const override
Definition: index_element_impl.cc:162
void debug_print(String_type &outb) const override
Definition: index_element_impl.cc:145
~Index_element_impl() override=default
const Object_table & object_table() const override
Definition: index_element_impl.cc:217
Index_element_impl()
Definition: index_element_impl.h:56
enum_index_element_order order() const override
Definition: index_element_impl.h:143
static Index_element_impl * clone(const Index_element_impl &other, Index_impl *index)
Definition: index_element_impl.cc:196
bool is_prefix() const override
Check if index element represents prefix key part on the column.
Definition: index_element_impl.cc:180
void set_hidden(bool hidden) override
Definition: index_element_impl.h:137
const Column & column() const override
Definition: index_element_impl.h:109
Definition: index_element.h:46
enum_index_element_order
Definition: index_element.h:52
@ ORDER_ASC
Definition: index_element.h:52
Definition: index_impl.h:59
Definition: index.h:51
Definition: object_key.h:38
This class represents all data dictionary table like mysql.tables, mysql.columns and more.
Definition: object_table.h:72
Auxiliary class for opening dictionary tables.
Definition: transaction_impl.h:76
Definition: raw_record.h:46
Opaque context which keeps reusable resoureces needed during deserialization.
Definition: sdi.cc:231
Opaque context which keeps reusable resources needed during serialization.
Definition: sdi.cc:129
Definition: weak_object_impl.h:48
The version of the current data dictionary table definitions.
Definition: dictionary_client.h:43
RJ_Writer Sdi_writer
Alias for the rapidjson Writer type to use in serialization.
Definition: sdi_fwd.h:64
rapidjson::GenericValue< RJ_Encoding, RJ_Allocator > RJ_Value
Definition: sdi_fwd.h:49
Char_string_template< String_type_allocator > String_type
Definition: string_type.h:51
const mysql_service_registry_t * r
Definition: pfs_example_plugin_employee.cc:86
This header provides Rapidjson Type Aliases.