drizzle
C++ MySQL-protocol-compatible database server
Loading...
Searching...
No Matches
drizzled::ForeignKeyInfo Class Reference

This class defines the information for foreign keys. More...

#include <table.h>

Collaboration diagram for drizzled::ForeignKeyInfo:
[legend]

Public Member Functions

 ForeignKeyInfo (lex_string_t *in_foreign_id, lex_string_t *in_referenced_db, lex_string_t *in_referenced_table, lex_string_t *in_update_method, lex_string_t *in_delete_method, lex_string_t *in_referenced_key_name, List< lex_string_t > in_foreign_fields, List< lex_string_t > in_referenced_fields)
 This is the constructor with all properties set.
 ForeignKeyInfo ()
 This is the default constructor. All properties are set to default values for their types.
const lex_string_t * getForeignId () const
 Gets the foreign id.
const lex_string_t * getReferencedDb () const
 Gets the name of the referenced database.
const lex_string_t * getReferencedTable () const
 Gets the name of the referenced table.
const lex_string_t * getUpdateMethod () const
 Gets the update method.
const lex_string_t * getDeleteMethod () const
 Gets the delete method.
const lex_string_t * getReferencedKeyName () const
 Gets the name of the referenced key.
const List< lex_string_t > & getForeignFields () const
 Gets the foreign fields.
const List< lex_string_t > & getReferencedFields () const
 Gets the referenced fields.

Private Attributes

lex_string_t * foreign_id
lex_string_t * referenced_db
lex_string_t * referenced_table
lex_string_t * update_method
lex_string_t * delete_method
lex_string_t * referenced_key_name
List< lex_string_t > foreign_fields
List< lex_string_t > referenced_fields

Detailed Description

This class defines the information for foreign keys.

ForeignKeyInfo

Definition at line 641 of file drizzled/table.h.

Constructor & Destructor Documentation

◆ ForeignKeyInfo() [1/2]

drizzled::ForeignKeyInfo::ForeignKeyInfo ( lex_string_t * in_foreign_id,
lex_string_t * in_referenced_db,
lex_string_t * in_referenced_table,
lex_string_t * in_update_method,
lex_string_t * in_delete_method,
lex_string_t * in_referenced_key_name,
List< lex_string_t > in_foreign_fields,
List< lex_string_t > in_referenced_fields )
inline

This is the constructor with all properties set.

Parameters
[in]in_foreign_idThe id of the foreign key
[in]in_referenced_dbThe referenced database name of the foreign key
[in]in_referenced_tableThe referenced table name of the foreign key
[in]in_update_methodThe update method of the foreign key.
[in]in_delete_methodThe delete method of the foreign key.
[in]in_referenced_key_nameThe name of referenced key
[in]in_foreign_fieldsThe foreign fields
[in]in_referenced_fieldsThe referenced fields

Definition at line 657 of file drizzled/table.h.

◆ ForeignKeyInfo() [2/2]

drizzled::ForeignKeyInfo::ForeignKeyInfo ( )
inline

This is the default constructor. All properties are set to default values for their types.

Definition at line 680 of file drizzled/table.h.

Member Function Documentation

◆ getDeleteMethod()

const lex_string_t * drizzled::ForeignKeyInfo::getDeleteMethod ( ) const
inline

Gets the delete method.

@ retval the delete method

Definition at line 735 of file drizzled/table.h.

◆ getForeignFields()

const List< lex_string_t > & drizzled::ForeignKeyInfo::getForeignFields ( ) const
inline

Gets the foreign fields.

@ retval the foreign fields

Definition at line 757 of file drizzled/table.h.

◆ getForeignId()

const lex_string_t * drizzled::ForeignKeyInfo::getForeignId ( ) const
inline

Gets the foreign id.

@ retval the foreign id

Definition at line 691 of file drizzled/table.h.

◆ getReferencedDb()

const lex_string_t * drizzled::ForeignKeyInfo::getReferencedDb ( ) const
inline

Gets the name of the referenced database.

@ retval the name of the referenced database

Definition at line 702 of file drizzled/table.h.

◆ getReferencedFields()

const List< lex_string_t > & drizzled::ForeignKeyInfo::getReferencedFields ( ) const
inline

Gets the referenced fields.

@ retval the referenced fields

Definition at line 768 of file drizzled/table.h.

◆ getReferencedKeyName()

const lex_string_t * drizzled::ForeignKeyInfo::getReferencedKeyName ( ) const
inline

Gets the name of the referenced key.

@ retval the name of the referenced key

Definition at line 746 of file drizzled/table.h.

◆ getReferencedTable()

const lex_string_t * drizzled::ForeignKeyInfo::getReferencedTable ( ) const
inline

Gets the name of the referenced table.

@ retval the name of the referenced table

Definition at line 713 of file drizzled/table.h.

◆ getUpdateMethod()

const lex_string_t * drizzled::ForeignKeyInfo::getUpdateMethod ( ) const
inline

Gets the update method.

@ retval the update method

Definition at line 724 of file drizzled/table.h.

Member Data Documentation

◆ delete_method

lex_string_t* drizzled::ForeignKeyInfo::delete_method
private

The delete method.

Definition at line 792 of file drizzled/table.h.

◆ foreign_fields

List<lex_string_t> drizzled::ForeignKeyInfo::foreign_fields
private

The foreign fields.

Definition at line 800 of file drizzled/table.h.

◆ foreign_id

lex_string_t* drizzled::ForeignKeyInfo::foreign_id
private

The foreign id.

Definition at line 776 of file drizzled/table.h.

◆ referenced_db

lex_string_t* drizzled::ForeignKeyInfo::referenced_db
private

The name of the reference database.

Definition at line 780 of file drizzled/table.h.

◆ referenced_fields

List<lex_string_t> drizzled::ForeignKeyInfo::referenced_fields
private

The referenced fields.

Definition at line 804 of file drizzled/table.h.

◆ referenced_key_name

lex_string_t* drizzled::ForeignKeyInfo::referenced_key_name
private

The name of the referenced key.

Definition at line 796 of file drizzled/table.h.

◆ referenced_table

lex_string_t* drizzled::ForeignKeyInfo::referenced_table
private

The name of the reference table.

Definition at line 784 of file drizzled/table.h.

◆ update_method

lex_string_t* drizzled::ForeignKeyInfo::update_method
private

The update method.

Definition at line 788 of file drizzled/table.h.


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