Drizzled Public API Documentation

drizzled::ForeignKeyInfo Class Reference

List of all members.

Public Member Functions

 ForeignKeyInfo (LEX_STRING *in_foreign_id, LEX_STRING *in_referenced_db, LEX_STRING *in_referenced_table, LEX_STRING *in_update_method, LEX_STRING *in_delete_method, LEX_STRING *in_referenced_key_name, List< LEX_STRING > in_foreign_fields, List< LEX_STRING > 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_STRINGgetForeignId () const
 Gets the foreign id.
const LEX_STRINGgetReferencedDb () const
 Gets the name of the referenced database.
const LEX_STRINGgetReferencedTable () const
 Gets the name of the referenced table.
const LEX_STRINGgetUpdateMethod () const
 Gets the update method.
const LEX_STRINGgetDeleteMethod () const
 Gets the delete method.
const LEX_STRINGgetReferencedKeyName () const
 Gets the name of the referenced key.
const List< LEX_STRING > & getForeignFields () const
 Gets the foreign fields.
const List< LEX_STRING > & getReferencedFields () const
 Gets the referenced fields.

Private Attributes

LEX_STRINGforeign_id
LEX_STRINGreferenced_db
LEX_STRINGreferenced_table
LEX_STRINGupdate_method
LEX_STRINGdelete_method
LEX_STRINGreferenced_key_name
List< LEX_STRINGforeign_fields
List< LEX_STRINGreferenced_fields

Detailed Description

Definition at line 645 of file table.h.


Constructor & Destructor Documentation

drizzled::ForeignKeyInfo::ForeignKeyInfo ( LEX_STRING in_foreign_id,
LEX_STRING in_referenced_db,
LEX_STRING in_referenced_table,
LEX_STRING in_update_method,
LEX_STRING in_delete_method,
LEX_STRING in_referenced_key_name,
List< LEX_STRING in_foreign_fields,
List< LEX_STRING 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 661 of file table.h.


Member Function Documentation

Gets the delete method.

@ retval the delete method

Definition at line 739 of file table.h.

References delete_method.

Gets the foreign fields.

@ retval the foreign fields

Definition at line 761 of file table.h.

References foreign_fields.

Gets the foreign id.

@ retval the foreign id

Definition at line 695 of file table.h.

References foreign_id.

Gets the name of the referenced database.

@ retval the name of the referenced database

Definition at line 706 of file table.h.

References referenced_db.

Gets the referenced fields.

@ retval the referenced fields

Definition at line 772 of file table.h.

References referenced_fields.

Gets the name of the referenced key.

@ retval the name of the referenced key

Definition at line 750 of file table.h.

References referenced_key_name.

Gets the name of the referenced table.

@ retval the name of the referenced table

Definition at line 717 of file table.h.

References referenced_table.

Gets the update method.

@ retval the update method

Definition at line 728 of file table.h.

References update_method.


Member Data Documentation

The delete method.

Definition at line 796 of file table.h.

Referenced by getDeleteMethod().

The foreign fields.

Definition at line 804 of file table.h.

Referenced by getForeignFields().

The foreign id.

Definition at line 780 of file table.h.

Referenced by getForeignId().

The name of the reference database.

Definition at line 784 of file table.h.

Referenced by getReferencedDb().

The referenced fields.

Definition at line 808 of file table.h.

Referenced by getReferencedFields().

The name of the referenced key.

Definition at line 800 of file table.h.

Referenced by getReferencedKeyName().

The name of the reference table.

Definition at line 788 of file table.h.

Referenced by getReferencedTable().

The update method.

Definition at line 792 of file table.h.

Referenced by getUpdateMethod().


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