MySQL 8.4.3
Source Code Documentation
dd::Foreign_key_element_impl Class Reference

#include <foreign_key_element_impl.h>

Inheritance diagram for dd::Foreign_key_element_impl:
[legend]

Public Member Functions

 Foreign_key_element_impl ()
 
 Foreign_key_element_impl (Foreign_key_impl *foreign_key)
 
 Foreign_key_element_impl (const Foreign_key_element_impl &src, Foreign_key_impl *parent, Column *column)
 
 ~Foreign_key_element_impl () override=default
 
const Object_tableobject_table () const override
 
bool validate () const override
 
bool restore_attributes (const Raw_record &r) override
 
bool store_attributes (Raw_record *r) override
 
void serialize (Sdi_wcontext *wctx, Sdi_writer *w) const override
 Converts *this into json. More...
 
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 provided. More...
 
void debug_print (String_type &outb) const override
 
void set_ordinal_position (uint ordinal_position)
 
const Foreign_keyforeign_key () const override
 
Foreign_keyforeign_key () override
 
const Columncolumn () const override
 
void set_column (const Column *column) override
 
uint ordinal_position () const override
 
void set_ordinal_position (int ordinal_position) override
 
const String_typereferenced_column_name () const override
 
void referenced_column_name (const String_type &name) override
 
Object_keycreate_primary_key () const override
 
bool has_new_primary_key () const override
 Indicates that object is guaranteed to have primary key value which doesn't exist in database (e.g. More...
 
- Public Member Functions inherited from dd::Weak_object_impl_< use_pfs >
 Weak_object_impl_ ()=default
 
 ~Weak_object_impl_ () override=default
 
void * operator new (size_t size, const std::nothrow_t &nt) noexcept
 
void operator delete (void *ptr, const std::nothrow_t &nt) noexcept
 
void * operator new (size_t size) noexcept
 
void operator delete (void *ptr) noexcept
 
virtual bool store (Open_dictionary_tables_ctx *otx)
 Store the DD object into DD table. More...
 
bool drop (Open_dictionary_tables_ctx *otx) const
 Drop the DD object from DD table. More...
 
virtual bool restore_children (Open_dictionary_tables_ctx *)
 
virtual bool store_children (Open_dictionary_tables_ctx *)
 
virtual bool drop_children (Open_dictionary_tables_ctx *) const
 
- Public Member Functions inherited from dd::Weak_object
 Weak_object ()=default
 
 Weak_object (const Weak_object &)=default
 
virtual ~Weak_object ()=default
 
- Public Member Functions inherited from dd::Foreign_key_element
 ~Foreign_key_element () override=default
 

Static Public Member Functions

static void register_tables (Open_dictionary_tables_ctx *otx)
 
static Foreign_key_element_implrestore_item (Foreign_key_impl *fk)
 
static Foreign_key_element_implclone (const Foreign_key_element_impl &other, Foreign_key_impl *fk)
 

Private Attributes

Foreign_key_implm_foreign_key
 
const Columnm_column
 
uint m_ordinal_position
 
String_type m_referenced_column_name
 

Additional Inherited Members

- Public Types inherited from dd::Foreign_key_element
typedef Foreign_key_element_impl Impl
 
typedef tables::Foreign_key_column_usage DD_table
 
- Protected Member Functions inherited from dd::Weak_object_impl_< use_pfs >
virtual void set_primary_key_value (const Raw_new_record &)
 
virtual void fix_has_new_primary_key ()
 
bool check_parent_consistency (Entity_object_impl *parent, Object_id parent_id) const
 

Constructor & Destructor Documentation

◆ Foreign_key_element_impl() [1/3]

dd::Foreign_key_element_impl::Foreign_key_element_impl ( )
inline

◆ Foreign_key_element_impl() [2/3]

dd::Foreign_key_element_impl::Foreign_key_element_impl ( Foreign_key_impl foreign_key)
inline

◆ Foreign_key_element_impl() [3/3]

dd::Foreign_key_element_impl::Foreign_key_element_impl ( const Foreign_key_element_impl src,
Foreign_key_impl parent,
Column column 
)

◆ ~Foreign_key_element_impl()

dd::Foreign_key_element_impl::~Foreign_key_element_impl ( )
overridedefault

Member Function Documentation

◆ clone()

Foreign_key_element_impl * dd::Foreign_key_element_impl::clone ( const Foreign_key_element_impl other,
Foreign_key_impl fk 
)
static

◆ column()

const Column & dd::Foreign_key_element_impl::column ( ) const
inlineoverridevirtual

◆ create_primary_key()

Object_key * dd::Foreign_key_element_impl::create_primary_key ( ) const
overridevirtual

◆ debug_print()

void dd::Foreign_key_element_impl::debug_print ( String_type outb) const
overridevirtual

Implements dd::Weak_object.

◆ deserialize()

bool dd::Foreign_key_element_impl::deserialize ( Sdi_rcontext rctx,
const RJ_Value val 
)
overridevirtual

Re-establishes the state of *this by reading sdi information from the rapidjson DOM subobject provided.

Cross-references encountered within this object are tracked in sdictx, so that they can be updated when the entire object graph has been established.

Parameters
rctxstores book-keeping information for the deserialization process
valsubobject of rapidjson DOM containing json representation of this object
Return values
falsesuccess
truefailure

Implements dd::Foreign_key_element.

◆ foreign_key() [1/2]

const Foreign_key & dd::Foreign_key_element_impl::foreign_key ( ) const
overridevirtual

◆ foreign_key() [2/2]

Foreign_key & dd::Foreign_key_element_impl::foreign_key ( )
overridevirtual

◆ has_new_primary_key()

bool dd::Foreign_key_element_impl::has_new_primary_key ( ) const
overridevirtual

Indicates that object is guaranteed to have primary key value which doesn't exist in database (e.g.

because it only will be generated using auto-increment at store() time). So it is ok for store() method to skip lookup of existing object with the same primary key and simply try to insert new object into the table.

Implements dd::Weak_object_impl_< use_pfs >.

◆ object_table()

const Object_table & dd::Foreign_key_element_impl::object_table ( ) const
overridevirtual

◆ ordinal_position()

uint dd::Foreign_key_element_impl::ordinal_position ( ) const
inlineoverridevirtual

◆ referenced_column_name() [1/2]

const String_type & dd::Foreign_key_element_impl::referenced_column_name ( ) const
inlineoverridevirtual

◆ referenced_column_name() [2/2]

void dd::Foreign_key_element_impl::referenced_column_name ( const String_type name)
inlineoverridevirtual

◆ register_tables()

void dd::Foreign_key_element_impl::register_tables ( Open_dictionary_tables_ctx otx)
static

◆ restore_attributes()

bool dd::Foreign_key_element_impl::restore_attributes ( const Raw_record r)
overridevirtual

◆ restore_item()

static Foreign_key_element_impl * dd::Foreign_key_element_impl::restore_item ( Foreign_key_impl fk)
inlinestatic

◆ serialize()

void dd::Foreign_key_element_impl::serialize ( Sdi_wcontext wctx,
Sdi_writer w 
) const
overridevirtual

Converts *this into json.

Converts all member variables that are to be included in the sdi into json by transforming them appropriately and passing them to the rapidjson writer provided.

Parameters
wctxopaque context for data needed by serialization
wrapidjson writer which will perform conversion to json

Implements dd::Foreign_key_element.

◆ set_column()

void dd::Foreign_key_element_impl::set_column ( const Column column)
inlineoverridevirtual

◆ set_ordinal_position() [1/2]

void dd::Foreign_key_element_impl::set_ordinal_position ( int  ordinal_position)
inlineoverridevirtual

◆ set_ordinal_position() [2/2]

void dd::Foreign_key_element_impl::set_ordinal_position ( uint  ordinal_position)
inline

◆ store_attributes()

bool dd::Foreign_key_element_impl::store_attributes ( Raw_record r)
overridevirtual

◆ validate()

bool dd::Foreign_key_element_impl::validate ( ) const
overridevirtual

Member Data Documentation

◆ m_column

const Column* dd::Foreign_key_element_impl::m_column
private

◆ m_foreign_key

Foreign_key_impl* dd::Foreign_key_element_impl::m_foreign_key
private

◆ m_ordinal_position

uint dd::Foreign_key_element_impl::m_ordinal_position
private

◆ m_referenced_column_name

String_type dd::Foreign_key_element_impl::m_referenced_column_name
private

The documentation for this class was generated from the following files: