#include <field.h>
Public Types | |
enum | utype { NONE, NEXT_NUMBER, TIMESTAMP_OLD_FIELD, TIMESTAMP_DN_FIELD, TIMESTAMP_UN_FIELD, TIMESTAMP_DNUN_FIELD } |
Public Member Functions | |
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 |
virtual int | store (const char *to, uint32_t length, const charset_info_st *const cs)=0 |
virtual int | store (double nr)=0 |
virtual int | store (int64_t nr, bool unsigned_val)=0 |
virtual int | store_decimal (const type::Decimal *d)=0 |
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 <ime, type::timestamp_t t_type) |
virtual double | val_real () const =0 |
virtual int64_t | val_int () const =0 |
virtual type::Decimal * | val_decimal (type::Decimal *) const |
String * | val_str_internal (String *str) const |
virtual String * | val_str (String *, String *) const =0 |
virtual bool | str_needs_quotes () |
virtual Item_result | result_type () const =0 |
virtual Item_result | cmp_type () const |
virtual Item_result | cast_to_int_type () const |
virtual bool | eq (Field *field) |
virtual bool | eq_def (Field *field) |
virtual bool | is_timestamp () const |
virtual uint32_t | pack_length () 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 uint32_t | max_data_length () const |
virtual int | reset (void) |
virtual void | reset_fields () |
virtual void | set_default () |
virtual bool | binary () const |
virtual bool | zero_pack () const |
virtual enum ha_base_keytype | key_type () const |
virtual uint32_t | key_length () const |
virtual enum_field_types | type () const =0 |
virtual enum_field_types | real_type () const |
virtual int | cmp_max (const unsigned char *a, const unsigned char *b, uint32_t max_len) |
virtual int | cmp (const unsigned char *, const unsigned char *)=0 |
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) |
virtual uint32_t | decimals () const |
virtual uint32_t | size_of () const =0 |
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 void | sort_string (unsigned char *buff, uint32_t length)=0 |
virtual bool | optimize_range (uint32_t idx, uint32_t part) |
virtual bool | can_be_compared_as_int64_t () const |
virtual void | free () |
virtual Field * | new_field (memory::Root *, Table *, bool keep_type) |
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 <ime, uint32_t fuzzydate) const |
virtual bool | get_time (type::Time <ime) const |
virtual const charset_info_st * | charset (void) const |
virtual const charset_info_st * | sort_charset (void) const |
virtual bool | has_charset (void) const |
virtual void | set_charset (const charset_info_st *const) |
virtual enum Derivation | derivation (void) const |
virtual void | set_derivation (enum Derivation) |
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 | max_display_length ()=0 |
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) |
Static Public Member Functions | |
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) |
Public Attributes | |
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 |
Private Attributes | |
Table * | table |
uint16_t | field_index |
Friends | |
class | CopyField |
class | Item_avg_field |
class | Item_std_field |
class | Item_sum_num |
class | Item_sum_sum |
class | Item_sum_str |
class | Item_sum_count |
class | Item_sum_avg |
class | Item_sum_std |
class | Item_sum_min |
class | Item_sum_max |
class | Item_func_group_concat |
bool | reopen_table (Session *, Table *, bool) |
Class representing a Field in a Table
The value stored in the Field object is stored in the unsigned char pointer member variable called ptr. The val_xxx() methods retrieve this raw byte value and convert the byte into the appropriate output (int, decimal, etc).
The store_xxx() methods take various input and convert the input into the raw bytes stored in the ptr member variable.
|
inlinevirtual |
Returns true for fields which, when compared with constant items, can be casted to int64_t. In this case we will at 'fix_fields' stage cast the constant items to int64_ts and at the execution stage use field->val_int() for comparison. Used to optimize clauses like 'a_column BETWEEN date_const AND date_const'.
Reimplemented in drizzled::field::Int64, drizzled::Field_datetime, drizzled::Field_date, drizzled::field::Size, drizzled::field::Boolean, drizzled::field::Epoch, drizzled::field::Microtime, and drizzled::field::Time.
Definition at line 359 of file field.h.
Referenced by drizzled::Item_field::result_as_int64_t().
Field * drizzled::Field::clone | ( | memory::Root * | root, |
Table * | new_table | ||
) |
This is used to generate a field in Table from TableShare
Definition at line 1133 of file field.cc.
References drizzled::memory::Root::memdup().
int64_t drizzled::Field::convert_decimal2int64_t | ( | const type::Decimal * | val, |
bool | unsigned_flag, | ||
int * | err | ||
) |
Conversion from decimal to int64_t with checking overflow and setting correct value (min/max) in case of overflow.
val | value which have to be converted |
unsigned_flag | type of integer in which we convert val |
err | variable to pass error code |
Definition at line 1040 of file field.cc.
References warn_if_overflow().
Referenced by drizzled::Field_num::store_decimal().
|
virtual |
Return the "real size" of the data in memory. For varstrings, this does not include the length bytes.
Definition at line 717 of file field.cc.
References pack_length().
|
virtual |
Returns true if the fields are equally defined
true | This Field is equally defined to supplied Field |
false | This Field is NOT equally defined to supplied Field |
Reimplemented in drizzled::Field_enum, and drizzled::Field_num.
Definition at line 1146 of file field.cc.
References pack_length().
Referenced by drizzled::check_simple_equality(), drizzled::create_tmp_field(), drizzled::Field_num::eq_def(), and drizzled::Field_enum::eq_def().
|
static |
Return type of which can carry value of both given types in UNION result.
a | type for merging |
b | type for merging |
type | of field |
Definition at line 687 of file field.cc.
Referenced by drizzled::Item_type_holder::join_types().
|
inlinevirtual |
Copy a field part into an output buffer.
This function makes a copy of field part of size equal to or less than "length" parameter value. For fields of string types (VARCHAR, TEXT) the rest of buffer is padded by zero byte.
output | buffer |
output | buffer size |
For variable length character fields (i.e. UTF-8) the "length" parameter means a number of output buffer bytes as if all field characters have maximal possible size (mbmaxlen). In the other words, "length" parameter is a number of characters multiplied by field_charset->mbmaxlen.
Number | of copied bytes (excluding padded zero bytes – see above). |
Reimplemented in drizzled::Field_blob, and drizzled::Field_varstring.
Definition at line 421 of file field.h.
Referenced by drizzled::matching_cond().
|
virtual |
Get the maximum size of the data in packed format.
Reimplemented in drizzled::Field_blob, and drizzled::Field_str.
Definition at line 732 of file field.cc.
References pack_length().
|
virtual |
Pack the field into a format suitable for storage and transfer.
To implement packing functionality, only the virtual function should be overridden. The other functions are just convenience functions and hence should not be overridden.
The value of low_byte_first
is dependent on how the packed data is going to be used: for local use, e.g., temporary store on disk or in memory, use the native format since that is faster. For data that is going to be transfered to other machines (e.g., when writing data to the binary log), data should always be stored in little-endian format.
max_length
characters.to | Pointer to memory area where representation of field should be put. |
from | Pointer to memory area where record representation of field is stored. |
max_length | Maximum length of the field, as given in the column definition. For example, for CHAR(1000) , the max_length is 1000. This information is sometimes needed to decide how to pack the data. |
low_byte_first | true if integers should be stored little-endian, false if native format should be used. Note that for little-endian machines, the value of this flag is a moot point since the native format is little-endian. |
Reimplemented in drizzled::Field_blob, drizzled::Field_varstring, drizzled::field::Int64, drizzled::field::Int32, drizzled::field::Size, and drizzled::Field_real.
Definition at line 955 of file field.cc.
References pack_length().
Referenced by drizzled::SortParam::make_sortkey().
|
virtual |
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 in drizzled::Field_null, drizzled::Field_blob, drizzled::field::Int64, drizzled::Field_enum, drizzled::Field_decimal, drizzled::Field_datetime, drizzled::Field_date, drizzled::field::Int32, drizzled::field::Size, drizzled::Field_double, drizzled::Field_varstring, drizzled::field::Epoch, drizzled::field::Microtime, drizzled::field::Time, drizzled::field::IPv6, drizzled::field::Uuid, and drizzled::field::Boolean.
Definition at line 707 of file field.cc.
References field_length.
Referenced by build_template(), drizzled::calc_group_buffer(), calc_row_difference(), drizzled::calc_used_field_length(), create_index(), create_table_def(), drizzled::create_tmp_table(), drizzled::CreateField::CreateField(), data_length(), eq_def(), drizzled::field_conv(), drizzled::FileSort::get_addon_fields(), innobase_col_to_mysql(), drizzled::TransactionServices::isFieldUpdated(), max_data_length(), pack(), pack_length_in_rec(), drizzled::CopyField::set(), drizzled::setup_copy_fields(), ha_innobase::store_key_val_for_row(), unpack(), and used_length().
|
virtual |
Returns size (in bytes) used to store field data on storage (i.e. it returns the maximal size of the field in a row of the table, which is located on disk).
Definition at line 712 of file field.cc.
References pack_length().
|
static |
Detect Item_result by given field type of UNION merge result.
field_type | given field type |
Definition at line 695 of file field.cc.
Referenced by drizzled::Item_type_holder::join_types(), and drizzled::Item_type_holder::result_type().
void drizzled::Field::set_datetime_warning | ( | DRIZZLE_ERROR::enum_warning_level | level, |
drizzled::error_t | code, | ||
const char * | str, | ||
uint32_t | str_len, | ||
type::timestamp_t | ts_type, | ||
int | cuted_increment | ||
) |
Produce warning or note about datetime string data saved into field.
level | level of message (Note/Warning/Error) |
code | error code of message to be produced |
str | string value which we tried to save |
str_length | length of string which we tried to save |
ts_type | type of datetime value (datetime/date/time) |
cuted_increment | whenever we should increase cut fields count or not |
Definition at line 1237 of file field.cc.
References field_name, and set_warning().
Referenced by drizzled::Field_date::store_time().
void drizzled::Field::set_datetime_warning | ( | DRIZZLE_ERROR::enum_warning_level | level, |
drizzled::error_t | code, | ||
int64_t | nr, | ||
type::timestamp_t | ts_type, | ||
int | cuted_increment | ||
) |
Produce warning or note about integer datetime value saved into field.
level | level of message (Note/Warning/Error) |
code | error code of message to be produced |
nr | numeric value which we tried to save |
ts_type | type of datetime value (datetime/date/time) |
cuted_increment | whenever we should increase cut fields count or not |
Definition at line 1252 of file field.cc.
References field_name, and set_warning().
void drizzled::Field::set_datetime_warning | ( | DRIZZLE_ERROR::enum_warning_level | level, |
const drizzled::error_t | code, | ||
double | nr, | ||
type::timestamp_t | ts_type | ||
) |
Produce warning or note about double datetime data saved into field.
level | level of message (Note/Warning/Error) |
code | error code of message to be produced |
nr | double value which we tried to save |
ts_type | type of datetime value (datetime/date/time) |
Definition at line 1269 of file field.cc.
References field_name, and set_warning().
bool drizzled::Field::set_warning | ( | DRIZZLE_ERROR::enum_warning_level | level, |
drizzled::error_t | code, | ||
int | cuted_increment | ||
) |
Produce warning or note about data saved into field.
level | - level of message (Note/Warning/Error) |
code | - error code of message to be produced |
cuted_increment | - whenever we should increase cut fields count or not |
if count_cuted_fields == CHECK_FIELD_IGNORE then we ignore notes. This allows us to avoid notes in optimisation, like convert_constant_item().
1 | if count_cuted_fields == CHECK_FIELD_IGNORE and error level is not NOTE |
0 | otherwise |
Definition at line 1217 of file field.cc.
References drizzled::Session::cuted_fields, field_name, drizzled::Table::in_use, drizzled::Session::row_count, and table.
Referenced by drizzled::Field_num::check_int(), drizzled::do_cut_string(), drizzled::do_cut_string_complex(), set_datetime_warning(), drizzled::set_field_to_null_with_conversions(), drizzled::Field_date::store_time(), and warn_if_overflow().
|
virtual |
This is called when storing a date in a string.
Reimplemented in drizzled::Field_decimal, drizzled::Field_date, drizzled::Field_datetime, and drizzled::field::Microtime.
|
static |
Check whether a field type can be partially indexed by a key.
This is a static method, rather than a virtual function, because we need to check the type of a non-Field in alter_table().
type | field type |
true | Type can have a prefixed key |
false | Type can not have a prefixed key |
Definition at line 859 of file field.cc.
Referenced by drizzled::prepare_alter_table().
|
virtual |
Unpack a field from row data.
This method is used to unpack a field from a master whose size of the field is less than that of the slave.
The param_data
parameter is a two-byte integer (stored in the least significant 16 bits of the unsigned integer) usually consisting of two parts: the real type in the most significant byte and a original pack length in the least significant byte.
The exact layout of the param_data
field is given by the Table_map_log_event::save_field_metadata()
.
This is the default method for unpacking a field. It just copies the memory block in byte order (of original pack length bytes or length of field, whichever is smaller).
to | Destination of the data |
from | Source of the data |
param_data | Real type and original pack length of the field data |
low_byte_first | If this flag is true , all composite entities (e.g., lengths) should be unpacked in little-endian format; otherwise, the entities are unpacked in native order. |
Reimplemented in drizzled::Field_blob, drizzled::Field_varstring, drizzled::field::Int64, drizzled::Field_decimal, drizzled::field::Int32, drizzled::field::Size, and drizzled::Field_real.
Definition at line 968 of file field.cc.
References pack_length().
Referenced by drizzled::Field_decimal::unpack(), and drizzled::unpack_addon_fields().
|
virtual |
Returns the number of bytes actually used to store the data of the field. So for a varstring it includes both lenght byte(s) and string data, and anything after data_length() bytes are unused.
Reimplemented in drizzled::Field_varstring.
Definition at line 722 of file field.cc.
References pack_length().
int drizzled::Field::warn_if_overflow | ( | int | op_result | ) |
Process decimal library return codes and issue warnings for overflow and truncation.
op_result | decimal library return code (E_DEC_* see include/decimal.h) |
E_DEC_OVERFLOW | there was overflow E_DEC_TRUNCATED there was truncation |
0 | no error or there was some other error except overflow or truncation |
Definition at line 871 of file field.cc.
References set_warning().
Referenced by convert_decimal2int64_t(), drizzled::Field_decimal::store(), and drizzled::Field_decimal::store_value().
str_ref drizzled::Field::comment |
A comment about the field
Definition at line 103 of file field.h.
Referenced by drizzled::CreateField::CreateField().
|
private |
uint32_t drizzled::Field::field_length |
Length of this field in bytes
Definition at line 129 of file field.h.
Referenced by drizzled::calc_group_buffer(), drizzled::CreateField::CreateField(), drizzled::field_conv(), drizzled::Field_varstring::pack_length(), and pack_length().
const char* drizzled::Field::field_name |
Name of the field
Definition at line 102 of file field.h.
Referenced by drizzled::Field_num::check_int(), create_index(), create_table_def(), drizzled::create_tmp_field_from_field(), drizzled::CreateField::CreateField(), ha_innobase::innobase_initialize_autoinc(), drizzled::prepare_alter_table(), drizzled::Item_field::reset_field(), set_datetime_warning(), drizzled::set_field_to_null_with_conversions(), set_warning(), drizzled::TransactionServices::setDeleteHeader(), and drizzled::TransactionServices::setUpdateHeader().
bool drizzled::Field::is_created_from_null_item |
If true, this field was created in create_tmp_field_from_item from a NULL value. This means that the type of the field is just a guess, and the type may be freely coerced to another type.
Definition at line 161 of file field.h.
Referenced by drizzled::create_tmp_field_from_item(), and drizzled::Item_type_holder::get_real_type().
key_map drizzled::Field::key_start |
The field is part of the following keys
Definition at line 106 of file field.h.
Referenced by drizzled::make_join_statistics(), and drizzled::update_const_equal_items().
unsigned char drizzled::Field::null_bit |
Bit used to test null bit
Definition at line 152 of file field.h.
Referenced by build_template(), drizzled::Table::compare_records(), drizzled::create_tmp_table(), field_in_record_is_null(), drizzled::CopyField::set(), and set_field_in_record_to_null().
unsigned char* drizzled::Field::null_ptr |
Byte where null_bit is
Definition at line 72 of file field.h.
Referenced by build_template(), calc_row_difference(), drizzled::Table::compare_records(), create_table_def(), drizzled::create_tmp_table(), field_in_record_is_null(), drizzled::CopyField::set(), and set_field_in_record_to_null().
Table* drizzled::Field::orig_table |
Pointer to the original Table. What is "the original table"?
Definition at line 101 of file field.h.
Referenced by drizzled::change_to_use_tmp_fields(), and drizzled::create_tmp_field_from_field().
unsigned char* drizzled::Field::ptr |
Position to field in record. Stores raw field value
Definition at line 71 of file field.h.
Referenced by drizzled::create_tmp_table(), drizzled::CreateField::CreateField(), drizzled::TransactionServices::deleteRecord(), drizzled::field_conv(), get_field_offset(), drizzled::Field_blob::get_key_image(), innobase_col_to_mysql(), drizzled::TransactionServices::isFieldUpdated(), drizzled::SortParam::make_sortkey(), drizzled::Field_blob::pack(), drizzled::Field_blob::pack_key(), drizzled::CopyField::set(), drizzled::Field_datetime::store_time(), drizzled::Field_date::store_time(), drizzled::Field_decimal::store_value(), and drizzled::unpack_addon_fields().
|
private |
Pointer to the Table object containing this Field
Definition at line 81 of file field.h.
Referenced by drizzled::remove_eq_conds(), and set_warning().