MySQL  8.0.18
Source Code Documentation
dd::Foreign_key Class Referenceabstract

#include <foreign_key.h>

Inheritance diagram for dd::Foreign_key:
dd::Entity_object dd::Weak_object dd::Foreign_key_impl

Public Types

enum  enum_rule {
  RULE_NO_ACTION = 1, RULE_RESTRICT, RULE_CASCADE, RULE_SET_NULL,
  RULE_SET_DEFAULT
}
 
enum  enum_match_option { OPTION_NONE = 1, OPTION_PARTIAL, OPTION_FULL }
 
typedef Collection< Foreign_key_element * > Foreign_key_elements
 
typedef Foreign_key_impl Impl
 
typedef tables::Foreign_keys DD_table
 

Public Member Functions

virtual ~Foreign_key ()
 
virtual const Tabletable () const =0
 
virtual Tabletable ()=0
 
virtual const String_typeunique_constraint_name () const =0
 
virtual void set_unique_constraint_name (const String_type &name)=0
 
virtual enum_match_option match_option () const =0
 
virtual void set_match_option (enum_match_option match_option)=0
 
virtual enum_rule update_rule () const =0
 
virtual void set_update_rule (enum_rule update_rule)=0
 
virtual enum_rule delete_rule () const =0
 
virtual void set_delete_rule (enum_rule delete_rule)=0
 
virtual const String_typereferenced_table_catalog_name () const =0
 
virtual void set_referenced_table_catalog_name (const String_type &name)=0
 
virtual const String_typereferenced_table_schema_name () const =0
 
virtual void set_referenced_table_schema_name (const String_type &name)=0
 
virtual const String_typereferenced_table_name () const =0
 
virtual void set_referenced_table_name (const String_type &name)=0
 
virtual Foreign_key_elementadd_element ()=0
 
virtual const Foreign_key_elementselements () const =0
 
virtual Foreign_key_elementselements ()=0
 
virtual void serialize (Sdi_wcontext *wctx, Sdi_writer *w) const =0
 Converts *this into json. More...
 
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 provided. More...
 
- Public Member Functions inherited from dd::Entity_object
virtual Object_id id () const =0
 The unique dictionary object id. More...
 
virtual bool is_persistent () const =0
 Is dictionary object persistent in dictionary tables ? More...
 
virtual const String_typename () const =0
 
virtual void set_name (const String_type &name)=0
 
- Public Member Functions inherited from dd::Weak_object
virtual void debug_print (String_type &outb) const =0
 
 Weak_object ()
 
 Weak_object (const Weak_object &)=default
 
virtual ~Weak_object ()
 

Member Typedef Documentation

◆ DD_table

◆ Foreign_key_elements

◆ Impl

Member Enumeration Documentation

◆ enum_match_option

Enumerator
OPTION_NONE 
OPTION_PARTIAL 
OPTION_FULL 

◆ enum_rule

Enumerator
RULE_NO_ACTION 
RULE_RESTRICT 
RULE_CASCADE 
RULE_SET_NULL 
RULE_SET_DEFAULT 

Constructor & Destructor Documentation

◆ ~Foreign_key()

virtual dd::Foreign_key::~Foreign_key ( )
inlinevirtual

Member Function Documentation

◆ add_element()

virtual Foreign_key_element* dd::Foreign_key::add_element ( )
pure virtual

Implemented in dd::Foreign_key_impl.

◆ delete_rule()

virtual enum_rule dd::Foreign_key::delete_rule ( ) const
pure virtual

Implemented in dd::Foreign_key_impl.

◆ deserialize()

virtual bool dd::Foreign_key::deserialize ( Sdi_rcontext rctx,
const RJ_Value val 
)
pure virtual

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
Returns
Return values
falsesuccess
truefailure

Implemented in dd::Foreign_key_impl.

◆ elements() [1/2]

virtual const Foreign_key_elements& dd::Foreign_key::elements ( ) const
pure virtual

Implemented in dd::Foreign_key_impl.

◆ elements() [2/2]

virtual Foreign_key_elements* dd::Foreign_key::elements ( )
pure virtual

Implemented in dd::Foreign_key_impl.

◆ match_option()

virtual enum_match_option dd::Foreign_key::match_option ( ) const
pure virtual

Implemented in dd::Foreign_key_impl.

◆ referenced_table_catalog_name()

virtual const String_type& dd::Foreign_key::referenced_table_catalog_name ( ) const
pure virtual

Implemented in dd::Foreign_key_impl.

◆ referenced_table_name()

virtual const String_type& dd::Foreign_key::referenced_table_name ( ) const
pure virtual

Implemented in dd::Foreign_key_impl.

◆ referenced_table_schema_name()

virtual const String_type& dd::Foreign_key::referenced_table_schema_name ( ) const
pure virtual

Implemented in dd::Foreign_key_impl.

◆ serialize()

virtual void dd::Foreign_key::serialize ( Sdi_wcontext wctx,
Sdi_writer w 
) const
pure virtual

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

Implemented in dd::Foreign_key_impl.

◆ set_delete_rule()

virtual void dd::Foreign_key::set_delete_rule ( enum_rule  delete_rule)
pure virtual

Implemented in dd::Foreign_key_impl.

◆ set_match_option()

virtual void dd::Foreign_key::set_match_option ( enum_match_option  match_option)
pure virtual

Implemented in dd::Foreign_key_impl.

◆ set_referenced_table_catalog_name()

virtual void dd::Foreign_key::set_referenced_table_catalog_name ( const String_type name)
pure virtual

Implemented in dd::Foreign_key_impl.

◆ set_referenced_table_name()

virtual void dd::Foreign_key::set_referenced_table_name ( const String_type name)
pure virtual

Implemented in dd::Foreign_key_impl.

◆ set_referenced_table_schema_name()

virtual void dd::Foreign_key::set_referenced_table_schema_name ( const String_type name)
pure virtual

Implemented in dd::Foreign_key_impl.

◆ set_unique_constraint_name()

virtual void dd::Foreign_key::set_unique_constraint_name ( const String_type name)
pure virtual

Implemented in dd::Foreign_key_impl.

◆ set_update_rule()

virtual void dd::Foreign_key::set_update_rule ( enum_rule  update_rule)
pure virtual

Implemented in dd::Foreign_key_impl.

◆ table() [1/2]

virtual const Table& dd::Foreign_key::table ( ) const
pure virtual

Implemented in dd::Foreign_key_impl.

◆ table() [2/2]

virtual Table& dd::Foreign_key::table ( )
pure virtual

Implemented in dd::Foreign_key_impl.

◆ unique_constraint_name()

virtual const String_type& dd::Foreign_key::unique_constraint_name ( ) const
pure virtual

Implemented in dd::Foreign_key_impl.

◆ update_rule()

virtual enum_rule dd::Foreign_key::update_rule ( ) const
pure virtual

Implemented in dd::Foreign_key_impl.


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