Drizzled Public API Documentation

drizzled::ForeignKeyInfo Class Reference

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. More...
 
 ForeignKeyInfo ()
 This is the default constructor. All properties are set to default values for their types.
 
const lex_string_tgetForeignId () const
 Gets the foreign id. More...
 
const lex_string_tgetReferencedDb () const
 Gets the name of the referenced database. More...
 
const lex_string_tgetReferencedTable () const
 Gets the name of the referenced table. More...
 
const lex_string_tgetUpdateMethod () const
 Gets the update method. More...
 
const lex_string_tgetDeleteMethod () const
 Gets the delete method. More...
 
const lex_string_tgetReferencedKeyName () const
 Gets the name of the referenced key. More...
 
const List< lex_string_t > & getForeignFields () const
 Gets the foreign fields. More...
 
const List< lex_string_t > & getReferencedFields () const
 Gets the referenced fields. More...
 

Private Attributes

lex_string_tforeign_id
 
lex_string_treferenced_db
 
lex_string_treferenced_table
 
lex_string_tupdate_method
 
lex_string_tdelete_method
 
lex_string_treferenced_key_name
 
List< lex_string_tforeign_fields
 
List< lex_string_treferenced_fields
 

Detailed Description

Definition at line 614 of file table.h.

Constructor & Destructor Documentation

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 630 of file table.h.

Member Function Documentation

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

Gets the delete method.

@ retval the delete method

Definition at line 708 of file table.h.

References delete_method.

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

Gets the foreign fields.

@ retval the foreign fields

Definition at line 730 of file table.h.

References foreign_fields.

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

Gets the foreign id.

@ retval the foreign id

Definition at line 664 of file table.h.

References foreign_id.

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 675 of file table.h.

References referenced_db.

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

Gets the referenced fields.

@ retval the referenced fields

Definition at line 741 of file table.h.

References referenced_fields.

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 719 of file table.h.

References referenced_key_name.

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 686 of file table.h.

References referenced_table.

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

Gets the update method.

@ retval the update method

Definition at line 697 of file table.h.

References update_method.

Member Data Documentation

lex_string_t* drizzled::ForeignKeyInfo::delete_method
private

The delete method.

Definition at line 765 of file table.h.

Referenced by getDeleteMethod().

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

The foreign fields.

Definition at line 773 of file table.h.

Referenced by getForeignFields().

lex_string_t* drizzled::ForeignKeyInfo::foreign_id
private

The foreign id.

Definition at line 749 of file table.h.

Referenced by getForeignId().

lex_string_t* drizzled::ForeignKeyInfo::referenced_db
private

The name of the reference database.

Definition at line 753 of file table.h.

Referenced by getReferencedDb().

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

The referenced fields.

Definition at line 777 of file table.h.

Referenced by getReferencedFields().

lex_string_t* drizzled::ForeignKeyInfo::referenced_key_name
private

The name of the referenced key.

Definition at line 769 of file table.h.

Referenced by getReferencedKeyName().

lex_string_t* drizzled::ForeignKeyInfo::referenced_table
private

The name of the reference table.

Definition at line 757 of file table.h.

Referenced by getReferencedTable().

lex_string_t* drizzled::ForeignKeyInfo::update_method
private

The update method.

Definition at line 761 of file table.h.

Referenced by getUpdateMethod().


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