MySQL 9.0.0
Source Code Documentation
foreign_key_element.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__FOREIGN_KEY_ELEMENT_INCLUDED
25#define DD__FOREIGN_KEY_ELEMENT_INCLUDED
26
27#include "my_inttypes.h"
28#include "sql/dd/sdi_fwd.h" // dd::Sdi_wcontext
29#include "sql/dd/types/weak_object.h" // dd::Weak_object
30
31namespace dd {
32
33///////////////////////////////////////////////////////////////////////////
34
35class Column;
36class Foreign_key;
37class Foreign_key_element_impl;
38
39namespace tables {
40class Foreign_key_column_usage;
41}
42
43///////////////////////////////////////////////////////////////////////////
44
45class Foreign_key_element : virtual public Weak_object {
46 public:
49
50 public:
51 ~Foreign_key_element() override = default;
52
53 /////////////////////////////////////////////////////////////////////////
54 // Foreign key.
55 /////////////////////////////////////////////////////////////////////////
56
57 virtual const Foreign_key &foreign_key() const = 0;
58
59 virtual Foreign_key &foreign_key() = 0;
60
61 /////////////////////////////////////////////////////////////////////////
62 // column.
63 /////////////////////////////////////////////////////////////////////////
64
65 virtual const Column &column() const = 0;
66
67 virtual void set_column(const Column *column) = 0;
68
69 /////////////////////////////////////////////////////////////////////////
70 // ordinal_position.
71 /////////////////////////////////////////////////////////////////////////
72
73 virtual uint ordinal_position() const = 0;
74
76
77 /////////////////////////////////////////////////////////////////////////
78 // referenced column name.
79 /////////////////////////////////////////////////////////////////////////
80
81 virtual const String_type &referenced_column_name() const = 0;
82 virtual void referenced_column_name(const String_type &name) = 0;
83
84 /**
85 Converts *this into json.
86
87 Converts all member variables that are to be included in the sdi
88 into json by transforming them appropriately and passing them to
89 the rapidjson writer provided.
90
91 @param wctx opaque context for data needed by serialization
92 @param w rapidjson writer which will perform conversion to json
93
94 */
95
96 virtual void serialize(Sdi_wcontext *wctx, Sdi_writer *w) const = 0;
97
98 /**
99 Re-establishes the state of *this by reading sdi information from
100 the rapidjson DOM subobject provided.
101
102 Cross-references encountered within this object are tracked in
103 sdictx, so that they can be updated when the entire object graph
104 has been established.
105
106 @param rctx stores book-keeping information for the
107 deserialization process
108 @param val subobject of rapidjson DOM containing json
109 representation of this object
110 @retval false success
111 @retval true failure
112 */
113
114 virtual bool deserialize(Sdi_rcontext *rctx, const RJ_Value &val) = 0;
115};
116
117///////////////////////////////////////////////////////////////////////////
118
119} // namespace dd
120
121#endif // DD__FOREIGN_KEY_ELEMENT_INCLUDED
Definition: column.h:88
Definition: foreign_key_element_impl.h:54
Definition: foreign_key_element.h:45
virtual const Column & column() const =0
virtual uint ordinal_position() const =0
virtual void referenced_column_name(const String_type &name)=0
Foreign_key_element_impl Impl
Definition: foreign_key_element.h:47
virtual void set_ordinal_position(int ordinal_position)=0
tables::Foreign_key_column_usage DD_table
Definition: foreign_key_element.h:48
virtual void set_column(const Column *column)=0
~Foreign_key_element() override=default
virtual const String_type & referenced_column_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...
virtual Foreign_key & foreign_key()=0
virtual const Foreign_key & foreign_key() const =0
virtual void serialize(Sdi_wcontext *wctx, Sdi_writer *w) const =0
Converts *this into json.
Definition: foreign_key.h:47
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
Base class for all data dictionary objects.
Definition: weak_object.h:42
Definition: foreign_key_column_usage.h:38
Some integer typedefs for easier portability.
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
This header provides Rapidjson Type Aliases.
case opt name
Definition: sslopt-case.h:29