Field_varstring Class Reference

Inheritance diagram for Field_varstring:

Collaboration diagram for Field_varstring:

Public Member Functions
	Field_varstring (uchar *ptr_arg, uint32 len_arg, uint length_bytes_arg, uchar *null_ptr_arg, uchar null_bit_arg, enum utype unireg_check_arg, const char *field_name_arg, TABLE_SHARE *share, const CHARSET_INFO *cs)
	Field_varstring (uint32 len_arg, bool maybe_null_arg, const char *field_name_arg, TABLE_SHARE *share, const CHARSET_INFO *cs)
enum_field_types	type () const
bool	match_collation_to_optimize_range () const
enum ha_base_keytype	key_type () const
uint	row_pack_length () const
bool	zero_pack () const
type_conversion_status	reset (void)
uint32	pack_length () const
uint32	key_length () const
uint32	sort_length () const
type_conversion_status	store (const char *to, uint length, const CHARSET_INFO *charset)
type_conversion_status	store (longlong nr, bool unsigned_val)
type_conversion_status	store (double nr)
double	val_real (void)
longlong	val_int (void)
String *	val_str (String *, String *)
my_decimal *	val_decimal (my_decimal *)
int	cmp_max (const uchar *, const uchar *, uint max_length)
int	cmp (const uchar *a, const uchar *b)
void	make_sort_key (uchar *buff, uint length)
uint	get_key_image (uchar *buff, uint length, imagetype type)
void	set_key_image (const uchar *buff, uint length)
void	sql_type (String &str) const
virtual uchar *	pack (uchar *to, const uchar *from, uint max_length, bool low_byte_first)
virtual const uchar *	unpack (uchar *to, const uchar *from, uint param_data, bool low_byte_first)
int	cmp_binary (const uchar *a, const uchar *b, uint32 max_length=~0L)
int	key_cmp (const uchar *, const uchar *)
int	key_cmp (const uchar *str, uint length)
uint	packed_col_length (const uchar *to, uint length)
uint	max_packed_col_length (uint max_length)
uint32	data_length ()
enum_field_types	real_type () const
bool	has_charset (void) const
Field *	new_field (MEM_ROOT *root, TABLE *new_table, bool keep_type)
Field *	new_key_field (MEM_ROOT *root, TABLE *new_table, uchar *new_ptr, uchar *new_null_ptr, uint new_null_bit)
Field_varstring *	clone (MEM_ROOT *mem_root) const
Field_varstring *	clone () const
uint	is_equal (Create_field *new_field)
void	hash (ulong *nr, ulong *nr2)
Public Member Functions inherited from Field_longstr
	Field_longstr (uchar *ptr_arg, uint32 len_arg, uchar *null_ptr_arg, uchar null_bit_arg, utype unireg_check_arg, const char *field_name_arg, const CHARSET_INFO *charset_arg)
type_conversion_status	store_decimal (const my_decimal *d)
uint32	max_data_length () const
Public Member Functions inherited from Field_str
	Field_str (uchar *ptr_arg, uint32 len_arg, uchar *null_ptr_arg, uchar null_bit_arg, utype unireg_check_arg, const char *field_name_arg, const CHARSET_INFO *charset)
Item_result	result_type () const
Item_result	numeric_context_result_type () const
uint	decimals () const
void	make_field (Send_field *field)
uint	repertoire (void) const
const CHARSET_INFO *	charset (void) const
void	set_charset (const CHARSET_INFO *charset_arg)
enum Derivation	derivation (void) const
virtual void	set_derivation (enum Derivation derivation_arg)
bool	binary () const
uint32	max_display_length ()
virtual bool	str_needs_quotes ()
Public Member Functions inherited from Field
bool	has_insert_default_function () const
bool	has_update_default_function () const
	Field (uchar *ptr_arg, uint32 length_arg, uchar *null_ptr_arg, uchar 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.
virtual type_conversion_status	store_packed (longlong nr)
virtual type_conversion_status	store_time (MYSQL_TIME *ltime, uint8 dec)
type_conversion_status	store_time (MYSQL_TIME *ltime)
type_conversion_status	store (const char *to, uint length, const CHARSET_INFO *cs, enum_check_fields check_level)
virtual longlong	val_time_temporal ()
virtual longlong	val_date_temporal ()
longlong	val_temporal_by_field_type ()
String *	val_str (String *str)
String *	val_int_as_str (String *val_buffer, my_bool unsigned_flag)
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 uint32	pack_length_in_rec () const
virtual bool	compatible_field_size (uint metadata, Relay_log_info *rli, uint16 mflags, int *order)
virtual uint	pack_length_from_metadata (uint field_metadata)
virtual int	save_field_metadata (uchar *first_byte)
virtual void	reset_fields ()
virtual bool	get_timestamp (struct timeval *tm, int *warnings)
virtual void	store_timestamp (const timeval *tm)
void	store_timestamp (my_time_t sec)
virtual void	set_default ()
void	evaluate_insert_default_function ()
void	evaluate_update_default_function ()
virtual enum_field_types	binlog_type () const
int	cmp (const uchar *str)
virtual int	cmp_offset (uint row_offset)
virtual int	cmp_binary_offset (uint row_offset)
bool	is_temporal () const
bool	is_temporal_with_date () const
bool	is_temporal_with_time () const
bool	is_temporal_with_date_and_time () const
bool	is_null (my_ptrdiff_t row_offset=0) const
bool	is_real_null (my_ptrdiff_t row_offset=0) const
bool	is_null_in_record (const uchar *record) const
void	set_null (my_ptrdiff_t row_offset=0)
void	set_notnull (my_ptrdiff_t row_offset=0)
bool	maybe_null (void) const
bool	real_maybe_null (void) const
uint	null_offset (const uchar *record) const
uint	null_offset () const
void	set_null_ptr (uchar *p_null_ptr, uint p_null_bit)
size_t	last_null_byte () const
virtual bool	optimize_range (uint idx, uint part)
virtual bool	can_be_compared_as_longlong () const
virtual void	free ()
Field *	new_key_field (MEM_ROOT *root, TABLE *new_table, uchar *new_ptr)
void	move_field (uchar *ptr_arg, uchar *null_ptr_arg, uchar null_bit_arg)
void	move_field (uchar *ptr_arg)
virtual void	move_field_offset (my_ptrdiff_t ptr_diff)
virtual void	get_image (uchar *buff, uint length, const CHARSET_INFO *cs)
virtual void	set_image (const uchar *buff, uint length, const CHARSET_INFO *cs)
longlong	val_int_offset (uint row_offset)
longlong	val_int (const uchar *new_ptr)
String *	val_str (String *str, const uchar *new_ptr)
virtual bool	send_binary (Protocol *protocol)
uchar *	pack (uchar *to, const uchar *from)
const uchar *	unpack (uchar *to, const uchar *from)
uint	offset (uchar *record)
void	copy_from_tmp (int offset)
uint	fill_cache_field (struct st_cache_field *copy)
virtual bool	get_date (MYSQL_TIME *ltime, uint fuzzydate)
virtual bool	get_time (MYSQL_TIME *ltime)
virtual const CHARSET_INFO *	charset_for_protocol (void) const
virtual const CHARSET_INFO *	sort_charset (void) const
bool	set_warning (Sql_condition::enum_warning_level, unsigned int code, int cuted_increment) const
bool	check_overflow (int op_result)
bool	check_truncated (int op_result)
bool	warn_if_overflow (int op_result)
void	init (TABLE *table_arg)
longlong	convert_decimal2longlong (const my_decimal *val, bool unsigned_flag, bool *has_overflow)
virtual uint32	char_length ()
virtual geometry_type	get_geometry_type ()
void	dbug_print ()
ha_storage_media	field_storage_type () const
void	set_storage_type (ha_storage_media storage_type_arg)
column_format_type	column_format () const
void	set_column_format (column_format_type column_format_arg)
virtual type_conversion_status	validate_stored_val (THD *thd)

Public Attributes
uint32	length_bytes

Static Public Attributes
static const uint	MAX_SIZE = UINT_MAX16

Additional Inherited Members
Public Types inherited from Field
enum	utype {   NONE, DATE, SHIELD, NOEMPTY,   CASEUP, PNR, BGNR, PGNR,   YES, NO, REL, CHECK,   EMPTY, UNKNOWN_FIELD, CASEDN, NEXT_NUMBER,   INTERVAL_FIELD, BIT_FIELD, TIMESTAMP_OLD_FIELD, CAPITALIZE,   BLOB_FIELD, TIMESTAMP_DN_FIELD, TIMESTAMP_UN_FIELD, TIMESTAMP_DNUN_FIELD }
enum	geometry_type {   GEOM_GEOMETRY = 0, GEOM_POINT = 1, GEOM_LINESTRING = 2, GEOM_POLYGON = 3,   GEOM_MULTIPOINT = 4, GEOM_MULTILINESTRING = 5, GEOM_MULTIPOLYGON = 6, GEOM_GEOMETRYCOLLECTION = 7 }
enum	imagetype { itRAW, itMBR }
enum	{ LAST_NULL_BYTE_UNDEF = 0 }
Static Public Member Functions inherited from Field
static void *	operator new (size_t size) throw ()
static void *	operator new (size_t size, MEM_ROOT *mem_root) throw ()
static void	operator delete (void *ptr, MEM_ROOT *mem_root)
static void	operator delete (void *ptr_arg, size_t size) throw ()
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 Field_longstr
type_conversion_status	report_if_important_data (const char *ptr, const char *end, bool count_spaces) const
type_conversion_status	check_string_copy_error (const char *well_formed_error_pos, const char *cannot_convert_error_pos, const char *from_end_pos, const char *end, bool count_spaces, const CHARSET_INFO *cs) const
Static Protected Member Functions inherited from Field
static void	handle_int16 (uchar *to, const uchar *from, bool low_byte_first_from, bool low_byte_first_to)
static void	handle_int24 (uchar *to, const uchar *from, bool low_byte_first_from, bool low_byte_first_to)
static void	handle_int32 (uchar *to, const uchar *from, bool low_byte_first_from, bool low_byte_first_to)
static void	handle_int64 (uchar *to, const uchar *from, bool low_byte_first_from, bool low_byte_first_to)
Protected Attributes inherited from Field_str
const CHARSET_INFO *	field_charset
enum Derivation	field_derivation

Detailed Description

Definition at line 3160 of file field.h.

Member Function Documentation

Field_varstring* Field_varstring::clone ( MEM_ROOT *  mem_root ) const

inlinevirtual

Makes a shallow copy of the Field object.

Note

This member function must be overridden in all concrete subclasses. Several of the Field subclasses are concrete even though they are not leaf classes, so the compiler will not always catch this.

Parameters

mem_root

MEM_ROOT to use for memory allocation.

Return values

NULL	If memory allocation failed.

Implements Field.

Definition at line 3242 of file field.h.

Field_varstring* Field_varstring::clone ( ) const

inlinevirtual

Makes a shallow copy of the Field object.

Note

This member function must be overridden in all concrete subclasses. Several of the Field subclasses are concrete even though they are not leaf classes, so the compiler will not always catch this.

Return values

NULL	If memory allocation failed.

Implements Field.

Definition at line 3247 of file field.h.

uint Field_varstring::is_equal ( Create_field *  new_field )

virtual

Whether a field being created is compatible with a existing one.

Used by the ALTER TABLE code to evaluate whether the new definition of a table is compatible with the old definition so that it can determine if data needs to be copied over (table data change).

Reimplemented from Field_str.

Definition at line 7555 of file field.cc.

int Field_varstring::key_cmp ( const uchar *  a, const uchar *  b  )

virtual

Compare to key segments (always 2 byte length prefix).

Note

This is used only to compare key segments created for index_read(). (keys are created and compared in key.cc)

Reimplemented from Field.

Definition at line 7322 of file field.cc.

int Field_varstring::key_cmp ( const uchar *  key_ptr, uint  max_key_length  )

virtual

Note

varstring and blob keys are ALWAYS stored with a 2 byte length prefix

Reimplemented from Field.

Definition at line 7297 of file field.cc.

void Field_varstring::make_sort_key ( uchar *  buff, uint  length  )

virtual

Writes a copy of the current value in the record buffer, suitable for sorting using byte-by-byte comparison. Integers are always in big-endian regardless of hardware architecture. At most length bytes are written into the buffer.

Parameters

buff	The buffer, assumed to be at least length bytes.
length	Number of bytes to write.

Implements Field.

Definition at line 7333 of file field.cc.

uchar * Field_varstring::pack ( uchar *  to, const uchar *  from, uint  max_length, bool  low_byte_first  )

virtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Reimplemented from Field.

Definition at line 7395 of file field.cc.

type_conversion_status Field_varstring::store ( double  nr )

inlinevirtual

Store double value in Field_string or Field_varstring.

Pretty prints double number into field_length characters buffer.

Parameters

nr

number

Reimplemented from Field_str.

Definition at line 3211 of file field.h.

Here is the call graph for this function:

const uchar * Field_varstring::unpack ( uchar *  to, const uchar *  from, uint  param_data, bool  low_byte_first  )

virtual

Unpack a varstring field from row data.

This method is used to unpack a varstring field from a master whose size of the field is less than that of the slave.

Note

The string length is always packed little-endian.

Parameters

to	Destination of the data
from	Source of the data
param_data	Length bytes from the master's field data

Returns

New pointer into memory based on from + length of the data

Reimplemented from Field.

Definition at line 7432 of file field.cc.

---

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

• sql/field.h
• sql/field.cc