Drizzled Public API Documentation

drizzled::plugin::TableFunction Class Reference
Inheritance diagram for drizzled::plugin::TableFunction:
drizzled::plugin::Plugin CharacterSetsTool CmpmemTool CmpTool CumulativeCommandsTool CumulativeUserStatsTool CurrentCommandsTool DataDictionary drizzle_plugin::AnalysisTableTool drizzle_plugin::error_dictionary::Errors drizzle_plugin::StatsTableTool EngineStateHistory ForeignKeysTool function_dictionary::Functions GlobalStatementsTool InformationSchema InnodbInternalTables InnodbReplicationTable InnodbStatusTool InnodbSysColumnsTool InnodbSysFieldsTool InnodbSysForeignColsTool InnodbSysForeignTool InnodbSysIndexesTool InnodbSysTableStatsTool InnodbSysTablesTool InnodbTrxTool ModulesTool performance_dictionary::SessionUsage plugin::catalog::tables::Cache plugin::catalog::tables::Catalogs PluginsTool ProcesslistTool ProtocolTool ScoreboardStatsTool session_dictionary::Savepoints session_dictionary::Sessions session_dictionary::Variables SessionStatementsTool show_dictionary::Show StateTool StatusTool table_cache_dictionary::TableCache table_cache_dictionary::TableDefinitionCache TablesTool trigger_dictionary::Table user_locks::barriers::UserBarriers user_locks::UserLocks utility_dictionary::Counter utility_dictionary::Environmental utility_dictionary::RandomNumber utility_dictionary::RandomString

Classes

class  Generator
 

Public Types

enum  ColumnType {
  BOOLEAN, NUMBER, STRING, VARBINARY,
  SIZE
}
 
typedef std::pair< const
std::string, const std::string > 
map_key
 
typedef std::map< const
map_key, plugin::Plugin * > 
map
 
typedef std::vector< Plugin * > vector
 

Public Member Functions

 TableFunction (const char *schema_arg, const char *table_arg)
 
void define (message::Table &arg)
 
const std::string & getTableLabel ()
 
const std::string & getIdentifierTableName ()
 
const std::string & getSchemaHome ()
 
const std::string & getPath ()
 
virtual Generatorgenerator (Field **arg)
 
void add_field (const char *label, message::Table::Field::FieldType type, uint32_t length=0)
 
void add_field (const char *label, uint32_t field_length=MAXIMUM_IDENTIFIER_LENGTH)
 
void add_field (const char *label, TableFunction::ColumnType type, bool is_default_null=true)
 
void add_field (const char *label, TableFunction::ColumnType type, uint32_t field_length, bool is_default_null=false)
 
virtual bool visible () const
 
virtual void shutdownPlugin ()
 
virtual void prime ()
 
virtual void startup (drizzled::Session &)
 
void activate ()
 
void deactivate ()
 
bool isActive () const
 
const std::string & getName () const
 
void setModule (module::Module *module)
 
const std::string & getTypeName () const
 
virtual bool removeLast () const
 
const std::string & getModuleName () const
 

Static Public Member Functions

static bool addPlugin (TableFunction *function)
 
static void removePlugin (TableFunction *)
 
static TableFunctiongetFunction (const std::string &arg)
 
static void getNames (const std::string &arg, std::set< std::string > &set_of_names)
 

Private Member Functions

void setName ()
 
void init ()
 

Private Attributes

message::Table proto
 
identifier::Table identifier
 
std::string local_path
 
std::string original_table_label
 

Detailed Description

Definition at line 60 of file table_function.h.


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