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

Inherits drizzled::plugin::Plugin.

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

Collaboration diagram for drizzled::plugin::TableFunction:
[legend]

Classes

class  Generator

Public Types

enum  ColumnType {
  BOOLEAN , NUMBER , STRING , VARBINARY ,
  SIZE
}
Public Types inherited from drizzled::plugin::Plugin
typedef std::pair< const std::string, const std::string > map_key
typedef std::unique_ptr< plugin::Plugin, deleter_fn > owned_ptr
typedef std::map< const map_key, owned_ptr > 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 Generator * generator (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
Public Member Functions inherited from drizzled::plugin::Plugin
 Plugin (const std::string &name, const std::string &type_name)
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 TableFunction * getFunction (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.

Member Enumeration Documentation

◆ ColumnType

enum drizzled::plugin::TableFunction::ColumnType

Definition at line 88 of file table_function.h.

Constructor & Destructor Documentation

◆ TableFunction()

drizzled::plugin::TableFunction::TableFunction ( const char * schema_arg,
const char * table_arg )
inline

Definition at line 72 of file table_function.h.

Member Function Documentation

◆ add_field() [1/3]

void drizzled::plugin::TableFunction::add_field ( const char * label,
TableFunction::ColumnType type,
bool is_default_null = true )

Definition at line 160 of file table_function.cc.

◆ add_field() [2/3]

void drizzled::plugin::TableFunction::add_field ( const char * label,
TableFunction::ColumnType type,
uint32_t field_length,
bool is_default_null = false )

Definition at line 167 of file table_function.cc.

◆ add_field() [3/3]

void drizzled::plugin::TableFunction::add_field ( const char * label,
uint32_t field_length = MAXIMUM_IDENTIFIER_LENGTH )

Definition at line 154 of file table_function.cc.

◆ addPlugin()

bool drizzled::plugin::TableFunction::addPlugin ( plugin::TableFunction & tool)
static

Definition at line 122 of file table_function.cc.

◆ define()

void drizzled::plugin::TableFunction::define ( message::Table & arg)
inline

Definition at line 138 of file table_function.h.

◆ generator()

plugin::TableFunction::Generator * drizzled::plugin::TableFunction::generator ( Field ** arg)
virtual

Definition at line 149 of file table_function.cc.

◆ getFunction()

plugin::TableFunction * drizzled::plugin::TableFunction::getFunction ( const std::string & arg)
static

Definition at line 128 of file table_function.cc.

◆ getIdentifierTableName()

const std::string & drizzled::plugin::TableFunction::getIdentifierTableName ( )
inline

Definition at line 148 of file table_function.h.

◆ getNames()

void drizzled::plugin::TableFunction::getNames ( const std::string & arg,
std::set< std::string > & set_of_names )
static

Definition at line 133 of file table_function.cc.

◆ getPath()

const std::string & drizzled::plugin::TableFunction::getPath ( )
inline

Definition at line 158 of file table_function.h.

◆ getSchemaHome()

const std::string & drizzled::plugin::TableFunction::getSchemaHome ( )
inline

Definition at line 153 of file table_function.h.

◆ getTableLabel()

const std::string & drizzled::plugin::TableFunction::getTableLabel ( )
inline

Definition at line 143 of file table_function.h.

◆ init()

void drizzled::plugin::TableFunction::init ( )
private

Definition at line 112 of file table_function.cc.

◆ removePlugin()

void drizzled::plugin::TableFunction::removePlugin ( TableFunction & )
inlinestatic

Definition at line 82 of file table_function.h.

◆ visible()

virtual bool drizzled::plugin::TableFunction::visible ( ) const
inlinevirtual

Definition at line 181 of file table_function.h.

Member Data Documentation

◆ identifier

identifier::Table drizzled::plugin::TableFunction::identifier
private

Definition at line 63 of file table_function.h.

◆ local_path

std::string drizzled::plugin::TableFunction::local_path
private

Definition at line 64 of file table_function.h.

◆ original_table_label

std::string drizzled::plugin::TableFunction::original_table_label
private

Definition at line 65 of file table_function.h.

◆ proto

message::Table drizzled::plugin::TableFunction::proto
private

Definition at line 62 of file table_function.h.


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