drizzle
C++ MySQL-protocol-compatible database server
Loading...
Searching...
No Matches
drizzled::Field_enum Class Reference
Inheritance diagram for drizzled::Field_enum:
[legend]
Collaboration diagram for drizzled::Field_enum:
[legend]

Public Member Functions

 Field_enum (unsigned char *ptr_arg, uint32_t len_arg, unsigned char *null_ptr_arg, unsigned char null_bit_arg, const char *field_name_arg, TYPELIB *typelib_arg, const charset_info_st *const charset_arg)
Field * new_field (memory::Root *root, Table *new_table, bool keep_type)
enum ha_base_keytype key_type () const
int store (const char *to, uint32_t length, const charset_info_st *const)
int store (double nr)
int store (int64_t nr, bool unsigned_val)
double val_real (void) const
int64_t val_int (void) const
String * val_str (String *, String *) const
int cmp (const unsigned char *, const unsigned char *)
void sort_string (unsigned char *buff, uint32_t length)
void store_type (uint64_t value)
bool eq_def (Field *field)
enum_field_types type () const
enum Item_result cmp_type () const
enum Item_result cast_to_int_type () const
uint32_t pack_length () const
uint32_t size_of () const
enum_field_types real_type () const
virtual bool zero_pack () const
bool optimize_range (uint32_t, uint32_t)
bool has_charset (void) const
const charset_info_st * sort_charset (void) const
Public Member Functions inherited from drizzled::Field_str
 Field_str (unsigned char *ptr_arg, uint32_t len_arg, unsigned char *null_ptr_arg, unsigned char null_bit_arg, const char *field_name_arg, const charset_info_st *const charset)
Item_result result_type () const
uint32_t decimals () const
int store (double nr)
int store_decimal (const type::Decimal *)
uint32_t size_of () const
const charset_info_st * charset (void) const
void set_charset (const charset_info_st *const charset_arg)
enum Derivation derivation (void) const
virtual void set_derivation (enum Derivation derivation_arg)
bool binary () const
uint32_t max_display_length ()
type::Decimal * val_decimal (type::Decimal *) const
virtual bool str_needs_quotes ()
uint32_t max_data_length () const
Public Member Functions inherited from drizzled::Field
Table * getTable ()
Table * getTable () const
void setTable (Table *table_arg)
bool isUnsigned () const
uint16_t position () const
void setPosition (uint32_t arg)
 Field (unsigned char *ptr_arg, uint32_t length_arg, unsigned char *null_ptr_arg, unsigned char null_bit_arg, utype unireg_check_arg, const char *field_name_arg)
 This is used as a table name when the table structure is not set up.
bool hasDefault () const
int store_and_check (enum_check_fields check_level, const char *to, uint32_t length, const charset_info_st *const cs)
virtual int store_time (type::Time &ltime, type::timestamp_t t_type)
String * val_str_internal (String *str) const
virtual bool eq (Field *field)
virtual bool is_timestamp () const
virtual uint32_t pack_length_in_rec () const
virtual uint32_t data_length ()
virtual uint32_t used_length ()
virtual uint32_t sort_length () const
virtual int reset (void)
virtual void reset_fields ()
virtual void set_default ()
virtual uint32_t key_length () const
virtual int cmp_max (const unsigned char *a, const unsigned char *b, uint32_t max_len)
int cmp_internal (const unsigned char *str)
virtual int cmp_binary (const unsigned char *a, const unsigned char *b, uint32_t max_length=UINT32_MAX)
virtual int cmp_offset (uint32_t row_offset)
virtual int cmp_binary_offset (uint32_t row_offset)
virtual int key_cmp (const unsigned char *a, const unsigned char *b)
virtual int key_cmp (const unsigned char *str, uint32_t length)
bool is_null (ptrdiff_t row_offset=0) const
bool is_real_null (ptrdiff_t row_offset=0) const
bool is_null_in_record (const unsigned char *record) const
bool is_null_in_record_with_offset (ptrdiff_t offset) const
void set_null (ptrdiff_t row_offset=0)
void set_notnull (ptrdiff_t row_offset=0)
bool maybe_null (void) const
bool real_maybe_null (void) const
virtual void make_field (SendField *)
virtual bool can_be_compared_as_int64_t () const
virtual void free ()
virtual Field * new_key_field (memory::Root *root, Table *new_table, unsigned char *new_ptr, unsigned char *new_null_ptr, uint32_t new_null_bit)
Field * clone (memory::Root *, Table *)
void move_field (unsigned char *ptr_arg, unsigned char *null_ptr_arg, unsigned char null_bit_arg)
void move_field (unsigned char *ptr_arg)
virtual void move_field_offset (ptrdiff_t ptr_diff)
virtual void get_image (unsigned char *buff, uint32_t length, const charset_info_st *const)
virtual void get_image (std::basic_string< unsigned char > &buff, uint32_t length, const charset_info_st *const)
virtual void set_image (const unsigned char *buff, uint32_t length, const charset_info_st *const)
virtual uint32_t get_key_image (unsigned char *buff, uint32_t length)
virtual uint32_t get_key_image (std::basic_string< unsigned char > &buff, uint32_t length)
virtual void set_key_image (const unsigned char *buff, uint32_t length)
int64_t val_int_offset (uint32_t row_offset)
int64_t val_int_internal (const unsigned char *new_ptr)
String * val_str_internal (String *str, const unsigned char *new_ptr)
virtual unsigned char * pack (unsigned char *to, const unsigned char *from, uint32_t max_length, bool low_byte_first)
unsigned char * pack (unsigned char *to, const unsigned char *from)
virtual const unsigned char * unpack (unsigned char *to, const unsigned char *from, uint32_t param_data, bool low_byte_first)
const unsigned char * unpack (unsigned char *to, const unsigned char *from)
virtual unsigned char * pack_key (unsigned char *to, const unsigned char *from, uint32_t max_length, bool low_byte_first)
virtual const unsigned char * unpack_key (unsigned char *to, const unsigned char *from, uint32_t max_length, bool low_byte_first)
virtual uint32_t max_packed_col_length (uint32_t max_length)
uint32_t offset (const unsigned char *record)
void copy_from_tmp (int offset)
uint32_t fill_cache_field (CacheField *copy)
virtual bool get_date (type::Time &ltime, uint32_t fuzzydate) const
virtual bool get_time (type::Time &ltime) const
bool set_warning (DRIZZLE_ERROR::enum_warning_level, drizzled::error_t code, int cuted_increment)
void set_datetime_warning (DRIZZLE_ERROR::enum_warning_level, drizzled::error_t code, const char *str, uint32_t str_len, type::timestamp_t ts_type, int cuted_increment)
void set_datetime_warning (DRIZZLE_ERROR::enum_warning_level, drizzled::error_t code, int64_t nr, type::timestamp_t ts_type, int cuted_increment)
void set_datetime_warning (DRIZZLE_ERROR::enum_warning_level, const drizzled::error_t code, double nr, type::timestamp_t ts_type)
bool check_overflow (int op_result)
int warn_if_overflow (int op_result)
void init (Table *table_arg)
virtual uint32_t is_equal (CreateField *new_field)
int64_t convert_decimal2int64_t (const type::Decimal *val, bool unsigned_flag, int *err)
uint32_t char_length () const
enum column_format_type column_format () const
virtual void hash (uint32_t *nr, uint32_t *nr2) const
bool isReadSet () const
bool isWriteSet ()
void setReadSet (bool arg=true)
void setWriteSet (bool arg=true)

Public Attributes

TYPELIB * typelib
Public Attributes inherited from drizzled::Field
unsigned char * ptr
unsigned char * null_ptr
Table * orig_table
const char * field_name
str_ref comment
key_map key_start
key_map part_of_key
key_map part_of_key_not_clustered
key_map part_of_sortkey
utype unireg_check
uint32_t field_length
uint32_t flags
unsigned char null_bit
bool is_created_from_null_item

Static Public Attributes

static const int max_supported_elements = 0x10000

Additional Inherited Members

Public Types inherited from drizzled::Field
enum  utype {
  NONE , NEXT_NUMBER , TIMESTAMP_OLD_FIELD , TIMESTAMP_DN_FIELD ,
  TIMESTAMP_UN_FIELD , TIMESTAMP_DNUN_FIELD
}
Static Public Member Functions inherited from drizzled::Field
static void * operator new (size_t size)
static void * operator new (size_t size, memory::Root *mem_root)
static void operator delete (void *, size_t)
static void operator delete (void *, memory::Root *)
static bool type_can_have_key_part (enum_field_types)
static enum_field_types field_type_merge (enum_field_types, enum_field_types)
static Item_result result_merge_type (enum_field_types)
Protected Member Functions inherited from drizzled::Field_str
int report_if_important_data (const char *ptr, const char *end)
Protected Member Functions inherited from drizzled::Field
void pack_num (uint64_t arg, unsigned char *destination=NULL)
void pack_num (uint32_t arg, unsigned char *destination=NULL)
uint64_t unpack_num (uint64_t &destination, const unsigned char *arg=NULL) const
uint32_t unpack_num (uint32_t &destination, const unsigned char *arg=NULL) const
Protected Attributes inherited from drizzled::Field_str
const charset_info_st * field_charset
enum Derivation field_derivation

Detailed Description

Definition at line 28 of file field/enum.h.

Constructor & Destructor Documentation

◆ Field_enum()

drizzled::Field_enum::Field_enum ( unsigned char * ptr_arg,
uint32_t len_arg,
unsigned char * null_ptr_arg,
unsigned char null_bit_arg,
const char * field_name_arg,
TYPELIB * typelib_arg,
const charset_info_st *const charset_arg )
inline

Definition at line 41 of file field/enum.h.

Member Function Documentation

◆ cast_to_int_type()

enum Item_result drizzled::Field_enum::cast_to_int_type ( ) const
inlinevirtual

Reimplemented from drizzled::Field.

Definition at line 78 of file field/enum.h.

◆ cmp()

int drizzled::Field_enum::cmp ( const unsigned char * a_ptr,
const unsigned char * b_ptr )
virtual

Implements drizzled::Field.

Definition at line 159 of file enum.cc.

◆ cmp_type()

enum Item_result drizzled::Field_enum::cmp_type ( ) const
inlinevirtual

Reimplemented from drizzled::Field.

Definition at line 74 of file field/enum.h.

◆ eq_def()

bool drizzled::Field_enum::eq_def ( Field * field)
virtual

Returns true if the fields are equally defined

Return values
trueThis Field is equally defined to supplied Field
falseThis Field is NOT equally defined to supplied Field

Reimplemented from drizzled::Field.

Definition at line 1151 of file field.cc.

◆ has_charset()

bool drizzled::Field_enum::has_charset ( void ) const
inlinevirtual

Reimplemented from drizzled::Field.

Definition at line 99 of file field/enum.h.

◆ key_type()

enum ha_base_keytype drizzled::Field_enum::key_type ( ) const
inlinevirtual

Reimplemented from drizzled::Field.

Definition at line 59 of file field/enum.h.

◆ new_field()

Field * drizzled::Field_enum::new_field ( memory::Root * root,
Table * new_table,
bool keep_type )
virtual

Reimplemented from drizzled::Field.

Definition at line 181 of file enum.cc.

◆ optimize_range()

bool drizzled::Field_enum::optimize_range ( uint32_t ,
uint32_t  )
inlinevirtual

Reimplemented from drizzled::Field.

Definition at line 95 of file field/enum.h.

◆ pack_length()

uint32_t drizzled::Field_enum::pack_length ( ) const
inlinevirtual

Returns size (in bytes) used to store field data in memory (i.e. it returns the maximum size of the field in a row of the table, which is located in RAM).

Reimplemented from drizzled::Field.

Definition at line 82 of file field/enum.h.

◆ real_type()

enum_field_types drizzled::Field_enum::real_type ( ) const
inlinevirtual

Reimplemented from drizzled::Field.

Definition at line 87 of file field/enum.h.

◆ size_of()

uint32_t drizzled::Field_enum::size_of ( ) const
inlinevirtual

Implements drizzled::Field.

Definition at line 83 of file field/enum.h.

◆ sort_charset()

const charset_info_st * drizzled::Field_enum::sort_charset ( void ) const
inlinevirtual

Reimplemented from drizzled::Field.

Definition at line 104 of file field/enum.h.

◆ sort_string()

void drizzled::Field_enum::sort_string ( unsigned char * buff,
uint32_t length )
virtual

Implements drizzled::Field.

Definition at line 170 of file enum.cc.

◆ store() [1/3]

int drizzled::Field_enum::store ( const char * from,
uint32_t length,
const charset_info_st * const  )
virtual

Given a supplied string, looks up the string in the internal typelib and stores the found key. Upon not finding an entry in the typelib, we always throw an error.

Implements drizzled::Field_str.

Definition at line 59 of file enum.cc.

◆ store() [2/3]

int drizzled::Field_enum::store ( double nr)
virtual

Implements drizzled::Field.

Definition at line 94 of file enum.cc.

◆ store() [3/3]

int drizzled::Field_enum::store ( int64_t from,
bool unsigned_val )
virtual
Note
MySQL allows 0 values, saying that 0 is "the index of the blank string error", whatever that means. Uhm, Drizzle doesn't allow this. To store an ENUM column value using an integer, you must specify the 1-based index of the enum column definition's key.

Implements drizzled::Field_str.

Definition at line 106 of file enum.cc.

◆ store_type()

void drizzled::Field_enum::store_type ( uint64_t value)

Definition at line 40 of file enum.cc.

◆ type()

enum_field_types drizzled::Field_enum::type ( ) const
inlinevirtual

Implements drizzled::Field.

Definition at line 70 of file field/enum.h.

◆ val_int()

int64_t drizzled::Field_enum::val_int ( void ) const
virtual

Implements drizzled::Field.

Definition at line 127 of file enum.cc.

◆ val_real()

double drizzled::Field_enum::val_real ( void ) const
virtual

Implements drizzled::Field.

Definition at line 122 of file enum.cc.

◆ val_str()

String * drizzled::Field_enum::val_str ( String * ,
String * val_ptr ) const
virtual

Implements drizzled::Field.

Definition at line 141 of file enum.cc.

◆ zero_pack()

virtual bool drizzled::Field_enum::zero_pack ( ) const
inlinevirtual

Reimplemented from drizzled::Field.

Definition at line 91 of file field/enum.h.

Member Data Documentation

◆ max_supported_elements

const int drizzled::Field_enum::max_supported_elements = 0x10000
static

Definition at line 37 of file field/enum.h.

◆ typelib

TYPELIB* drizzled::Field_enum::typelib

Internal storage for the string values of the ENUM

Definition at line 40 of file field/enum.h.


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