Drizzled Public API Documentation

Public Member Functions | Protected Attributes
drizzled::sys_var Class Reference

#include <sys_var.h>

Inheritance diagram for drizzled::sys_var:
drizzled::sys_var_bool_ptr drizzled::sys_var_const_str drizzled::sys_var_const_str_ptr drizzled::sys_var_const_string drizzled::sys_var_const_string_val drizzled::sys_var_constrained_value< T > drizzled::sys_var_fs_path drizzled::sys_var_global drizzled::sys_var_last_insert_id drizzled::sys_var_readonly drizzled::sys_var_session drizzled::sys_var_size_t_ptr drizzled::sys_var_std_string drizzled::sys_var_str drizzled::sys_var_timestamp drizzled::sys_var_uint32_t_ptr drizzled::sys_var_uint64_t_ptr

List of all members.

Public Member Functions

 sys_var (const std::string &name_arg, sys_after_update_func func=NULL, sys_check_func check_func_arg=NULL)
void setName (const std::string &name_in)
const std::string & getName () const
const std::vector< std::string > & getAliases () const
struct option * getOptionLimits () const
void setOptionLimits (struct option *in_option_limits)
sys_after_update_func getAfterUpdateTrigger () const
virtual bool check (Session *session, set_var *var)
bool check_enum (Session *session, set_var *var, const TYPELIB *enum_names)
virtual bool update (Session *session, set_var *var)=0
virtual void set_default (Session *, sql_var_t)
virtual SHOW_TYPE show_type ()
virtual unsigned char * value_ptr (Session *, sql_var_t)=0
virtual bool check_type (sql_var_t type)
virtual bool check_update_type (Item_result type)
virtual bool check_default (sql_var_t)
Item * item (Session *, sql_var_t)
virtual bool is_readonly () const

Protected Attributes

std::string name
sys_check_func check_func
sys_after_update_func after_update
struct option * option_limits
bool m_allow_empty_value

Detailed Description

A class which represents a variable, either global or session-local.

Definition at line 79 of file sys_var.h.

Member Function Documentation

sys_after_update_func drizzled::sys_var::getAfterUpdateTrigger ( ) const [inline]

Returns the function pointer for after update trigger, or NULL if none.

Definition at line 143 of file sys_var.h.

const std::vector<std::string>& drizzled::sys_var::getAliases ( ) const [inline]

Returns a vector of strings representing aliases for this variable's name.

Definition at line 120 of file sys_var.h.

const std::string& drizzled::sys_var::getName ( ) const [inline]

Returns the name of the variable.

Note:

So that we can exist in a Registry. We really need to formalize that

Definition at line 112 of file sys_var.h.

struct option* drizzled::sys_var::getOptionLimits ( ) const [inline, read]

Returns a pointer to the variable's option limits

Definition at line 127 of file sys_var.h.

Item * drizzled::sys_var::item ( Session *  session,
sql_var_t  var_type 
)

Return an Item for a variable.

Used with @[global.]variable_name.

If type is not given, return local value if exists, else global.

Definition at line 798 of file sys_var.cc.

References drizzled::memory::Root::strdup().

void drizzled::sys_var::setOptionLimits ( struct option *  in_option_limits) [inline]

Sets the pointer to the variable's option limits

Parameters:
Pointerto the option limits option variable

Definition at line 136 of file sys_var.h.

Member Data Documentation

sys_after_update_func drizzled::sys_var::after_update [protected]

Function pointer triggered after the variable's value is updated

Definition at line 84 of file sys_var.h.

bool drizzled::sys_var::m_allow_empty_value [protected]

Does variable allow an empty value?

Definition at line 86 of file sys_var.h.

std::string drizzled::sys_var::name [protected]

The name of the variable

Definition at line 82 of file sys_var.h.

struct option* drizzled::sys_var::option_limits [protected]

Updated by by sys_var_init()

Definition at line 85 of file sys_var.h.

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