MySQL 8.0.29
Source Code Documentation
column_type_element.h
Go to the documentation of this file.
1/* Copyright (c) 2014, 2021, 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__COLUMN_TYPE_ELEMENT_INCLUDED
24#define DD__COLUMN_TYPE_ELEMENT_INCLUDED
25
26#include "my_inttypes.h"
27#include "sql/dd/sdi_fwd.h" // dd::Sdi_rcontext
28#include "sql/dd/types/weak_object.h" // dd::Weak_object
29
30namespace dd {
31
32///////////////////////////////////////////////////////////////////////////
33
34class Column;
35class Column_type_element_impl;
36
37namespace tables {
38class Column_type_elements;
39}
40
41///////////////////////////////////////////////////////////////////////////
42
43class Column_type_element : virtual public Weak_object {
44 public:
47
48 public:
49 ~Column_type_element() override = default;
50
51 /////////////////////////////////////////////////////////////////////////
52 // Name
53 /////////////////////////////////////////////////////////////////////////
54
55 virtual const String_type &name() const = 0;
56 virtual void set_name(const String_type &name) = 0;
57
58 /////////////////////////////////////////////////////////////////////////
59 // Column
60 /////////////////////////////////////////////////////////////////////////
61
62 virtual const Column &column() const = 0;
63
64 /////////////////////////////////////////////////////////////////////////
65 // Index
66 /////////////////////////////////////////////////////////////////////////
67
68 virtual uint index() const = 0;
69
70 /**
71 Converts *this into json.
72
73 Converts all member variables that are to be included in the sdi
74 into json by transforming them appropriately and passing them to
75 the rapidjson writer provided.
76
77 @param wctx opaque context for data needed by serialization
78 @param w rapidjson writer which will perform conversion to json
79 */
80
81 virtual void serialize(Sdi_wcontext *wctx, Sdi_writer *w) const = 0;
82
83 /**
84 Re-establishes the state of *this by reading sdi information from
85 the rapidjson DOM subobject provided.
86
87 Cross-references encountered within this object are tracked in
88 sdictx, so that they can be updated when the entire object graph
89 has been established.
90
91 @param rctx stores book-keeping information for the
92 deserialization process
93 @param val subobject of rapidjson DOM containing json
94 representation of this object
95 @retval false success
96 @retval true failure
97 */
98
99 virtual bool deserialize(Sdi_rcontext *rctx, const RJ_Value &val) = 0;
100};
101
102///////////////////////////////////////////////////////////////////////////
103
104} // namespace dd
105
106#endif // DD__COLUMN_TYPE_ELEMENT_INCLUDED
Definition: column_type_element_impl.h:51
Definition: column_type_element.h:43
virtual void serialize(Sdi_wcontext *wctx, Sdi_writer *w) const =0
Converts *this into json.
tables::Column_type_elements DD_table
Definition: column_type_element.h:46
virtual void set_name(const String_type &name)=0
virtual const String_type & name() const =0
virtual bool deserialize(Sdi_rcontext *rctx, const RJ_Value &val)=0
Re-establishes the state of *this by reading sdi information from the rapidjson DOM subobject provide...
~Column_type_element() override=default
Column_type_element_impl Impl
Definition: column_type_element.h:45
virtual const Column & column() const =0
virtual uint index() const =0
Definition: column.h:86
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
Base class for all data dictionary objects.
Definition: weak_object.h:41
Definition: column_type_elements.h:37
Some integer typedefs for easier portability.
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
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
This header provides Rapidjson Type Aliases.
unsigned int uint
Definition: uca-dump.cc:29