MySQL 8.0.30
Source Code Documentation
partition_index_impl.h
Go to the documentation of this file.
1/* Copyright (c) 2014, 2022, 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 also distributed 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 included with MySQL.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License, version 2.0, for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22
23#ifndef DD__PARTITION_INDEX_IMPL_INCLUDED
24#define DD__PARTITION_INDEX_IMPL_INCLUDED
25
26#include <stddef.h>
27#include <sys/types.h>
28#include <memory>
29#include <new>
30
32#include "sql/dd/impl/types/weak_object_impl.h" // dd::Weak_object_impl
33#include "sql/dd/object_id.h"
34#include "sql/dd/sdi_fwd.h"
35#include "sql/dd/string_type.h"
36#include "sql/dd/types/index.h"
37#include "sql/dd/types/partition_index.h" // dd::Partition_index
38
39namespace dd {
40
41///////////////////////////////////////////////////////////////////////////
42
43class Index;
44class Object_key;
45class Object_table;
46class Open_dictionary_tables_ctx;
47class Partition;
48class Partition_impl;
49class Raw_record;
50class Sdi_rcontext;
51class Sdi_wcontext;
52class Weak_object;
53
54///////////////////////////////////////////////////////////////////////////
55
57 public:
59
61
63 Index *index);
64
65 ~Partition_index_impl() override = default;
66
67 public:
68 const Object_table &object_table() const override;
69
70 bool validate() const override;
71
72 bool restore_attributes(const Raw_record &r) override;
73
74 bool store_attributes(Raw_record *r) override;
75
76 void serialize(Sdi_wcontext *wctx, Sdi_writer *w) const override;
77
78 bool deserialize(Sdi_rcontext *rctx, const RJ_Value &val) override;
79
80 void debug_print(String_type &outb) const override;
81
83
84 virtual uint ordinal_position() const { return -1; }
85
86 public:
88
89 /////////////////////////////////////////////////////////////////////////
90 // Partition.
91 /////////////////////////////////////////////////////////////////////////
92
93 const Partition &partition() const override;
94
95 Partition &partition() override;
96
98
99 /////////////////////////////////////////////////////////////////////////
100 // Index.
101 /////////////////////////////////////////////////////////////////////////
102
103 const Index &index() const override;
104
105 Index &index() override;
106
107 /////////////////////////////////////////////////////////////////////////
108 // Options.
109 /////////////////////////////////////////////////////////////////////////
110
111 const Properties &options() const override { return m_options; }
112
113 Properties &options() override { return m_options; }
114
115 bool set_options(const Properties &options) override {
117 }
118
119 bool set_options(const String_type &options_raw) override {
120 return m_options.insert_values(options_raw);
121 }
122
123 /////////////////////////////////////////////////////////////////////////
124 // se_private_data.
125 /////////////////////////////////////////////////////////////////////////
126
127 const Properties &se_private_data() const override {
128 return m_se_private_data;
129 }
130
132
133 bool set_se_private_data(const String_type &se_private_data_raw) override {
134 return m_se_private_data.insert_values(se_private_data_raw);
135 }
136
139 }
140
141 /////////////////////////////////////////////////////////////////////////
142 // Tablespace.
143 /////////////////////////////////////////////////////////////////////////
144
145 Object_id tablespace_id() const override { return m_tablespace_id; }
146
149 }
150
151 public:
153 return new (std::nothrow) Partition_index_impl(partition, nullptr);
154 }
155
158
159 public:
160 Object_key *create_primary_key() const override;
161 bool has_new_primary_key() const override;
162
163 private:
164 // Fields.
165
168
169 // References to tightly-coupled objects.
170
173
174 // References to loosely-coupled objects.
175
177};
178
179///////////////////////////////////////////////////////////////////////////
180
181/**
182 Used to sort Partition_index objects for the same partition in
183 the same order as Index objects for the table.
184*/
185
188 const dd::Partition_index *pi2) const {
189 return pi1->index().ordinal_position() < pi2->index().ordinal_position();
190 }
191};
192
193///////////////////////////////////////////////////////////////////////////
194
195} // namespace dd
196
197#endif // DD__PARTITION_INDEX_IMPL_INCLUDED
Definition: index.h:50
virtual uint ordinal_position() const =0
Definition: object_key.h:37
This class represents all data dictionary table like mysql.tables, mysql.columns and more.
Definition: object_table.h:71
Auxiliary class for opening dictionary tables.
Definition: transaction_impl.h:75
Definition: partition_impl.h:59
Definition: partition_index_impl.h:56
Properties_impl m_options
Definition: partition_index_impl.h:166
bool set_options(const Properties &options) override
Definition: partition_index_impl.h:115
const Index & index() const override
Definition: partition_index_impl.cc:92
bool set_options(const String_type &options_raw) override
Definition: partition_index_impl.h:119
Partition_impl & partition_impl()
Definition: partition_index_impl.h:97
void set_ordinal_position(uint)
Definition: partition_index_impl.h:82
const Properties & options() const override
Definition: partition_index_impl.h:111
static Partition_index_impl * restore_item(Partition_impl *partition)
Definition: partition_index_impl.h:152
const Object_table & object_table() const override
Definition: partition_index_impl.cc:234
Partition_impl * m_partition
Definition: partition_index_impl.h:171
Object_key * create_primary_key() const override
Definition: partition_index_impl.cc:191
void debug_print(String_type &outb) const override
Definition: partition_index_impl.cc:175
Properties & options() override
Definition: partition_index_impl.h:113
virtual uint ordinal_position() const
Definition: partition_index_impl.h:84
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: partition_index_impl.cc:163
const Partition & partition() const override
Definition: partition_index_impl.cc:84
Object_id m_tablespace_id
Definition: partition_index_impl.h:176
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: partition_index_impl.cc:195
Properties & se_private_data() override
Definition: partition_index_impl.h:131
bool restore_attributes(const Raw_record &r) override
Definition: partition_index_impl.cc:116
const Properties & se_private_data() const override
Definition: partition_index_impl.h:127
Index * m_index
Definition: partition_index_impl.h:172
~Partition_index_impl() override=default
static void register_tables(Open_dictionary_tables_ctx *otx)
Definition: partition_index_impl.cc:240
Partition_index_impl()
Definition: partition_index_impl.cc:67
bool set_se_private_data(const Properties &se_private_data) override
Definition: partition_index_impl.h:137
bool set_se_private_data(const String_type &se_private_data_raw) override
Definition: partition_index_impl.h:133
bool validate() const override
Definition: partition_index_impl.cc:98
Properties_impl m_se_private_data
Definition: partition_index_impl.h:167
void serialize(Sdi_wcontext *wctx, Sdi_writer *w) const override
Converts *this into json.
Definition: partition_index_impl.cc:150
Object_id tablespace_id() const override
Definition: partition_index_impl.h:145
static Partition_index_impl * clone(const Partition_index_impl &other, Partition_impl *partition)
Definition: partition_index_impl.cc:214
bool store_attributes(Raw_record *r) override
Definition: partition_index_impl.cc:137
void set_tablespace_id(Object_id tablespace_id) override
Definition: partition_index_impl.h:147
Definition: partition_index.h:46
virtual const Index & index() const =0
Definition: partition.h:50
The Properties_impl class implements the Properties interface.
Definition: properties_impl.h:76
bool insert_values(const Properties &properties) override
Insert key/value pairs from a different property object.
Definition: properties_impl.cc:103
The Properties class defines an interface for storing key=value pairs, where both key and value may b...
Definition: properties.h:73
Definition: raw_record.h:45
Opaque context which keeps reusable resoureces needed during deserialization.
Definition: sdi.cc:230
Opaque context which keeps reusable resources needed during serialization.
Definition: sdi.cc:128
Definition: weak_object_impl.h:47
The version of the current data dictionary table definitions.
Definition: dictionary_client.h:42
RJ_Writer Sdi_writer
Alias for the rapidjson Writer type to use in serialization.
Definition: sdi_fwd.h:63
unsigned long long Object_id
Definition: object_id.h:30
rapidjson::GenericValue< RJ_Encoding, RJ_Allocator > RJ_Value
Definition: sdi_fwd.h:48
Char_string_template< String_type_allocator > String_type
Definition: string_type.h:50
Definition: options.cc:48
const mysql_service_registry_t * r
Definition: pfs_example_plugin_employee.cc:85
This header provides Rapidjson Type Aliases.
Used to sort Partition_index objects for the same partition in the same order as Index objects for th...
Definition: partition_index_impl.h:186
bool operator()(const dd::Partition_index *pi1, const dd::Partition_index *pi2) const
Definition: partition_index_impl.h:187
unsigned int uint
Definition: uca-dump.cc:29