MySQL  8.0.22
Source Code Documentation
Field_new_decimal Class Reference

#include <field.h>

Inheritance diagram for Field_new_decimal:
Field_num Field

Public Member Functions

 Field_new_decimal (uchar *ptr_arg, uint32 len_arg, uchar *null_ptr_arg, uchar null_bit_arg, uchar auto_flags_arg, const char *field_name_arg, uint8 dec_arg, bool zero_arg, bool unsigned_arg)
 
 Field_new_decimal (uint32 len_arg, bool is_nullable_arg, const char *field_name_arg, uint8 dec_arg, bool unsigned_arg)
 
enum_field_types type () const final
 
enum ha_base_keytype key_type () const final
 
Item_result result_type () const final
 
type_conversion_status reset () final
 
type_conversion_status store_value (const my_decimal *decimal_value)
 Store decimal value in the binary buffer. More...
 
void set_value_on_overflow (my_decimal *decimal_value, bool sign) const
 Generate max/min decimal value in case of overflow. More...
 
type_conversion_status store (const char *to, size_t length, const CHARSET_INFO *charset) final
 
type_conversion_status store (double nr) final
 
type_conversion_status store (longlong nr, bool unsigned_val) final
 
type_conversion_status store_time (MYSQL_TIME *ltime, uint8 dec) final
 Store MYSQL_TIME value with the given amount of decimal digits into a field. More...
 
type_conversion_status store_decimal (const my_decimal *) final
 Storing decimal in integer fields. More...
 
double val_real () const final
 
longlong val_int () const final
 
my_decimalval_decimal (my_decimal *) const final
 Return decimal value of integer field. More...
 
bool get_date (MYSQL_TIME *ltime, my_time_flags_t fuzzydate) const final
 
bool get_time (MYSQL_TIME *ltime) const final
 
Stringval_str (String *, String *) const final
 
int cmp (const uchar *, const uchar *) const final
 
size_t make_sort_key (uchar *buff, size_t length) const final
 Writes a copy of the current value in the record buffer, suitable for sorting using byte-by-byte comparison. More...
 
bool zero_pack () const final
 
void sql_type (String &str) const final
 
uint32 max_display_length () const final
 
uint32 pack_length () const final
 
uint pack_length_from_metadata (uint field_metadata) const final
 Returns the number of bytes field uses in row-based replication row packed size. More...
 
bool compatible_field_size (uint field_metadata, Relay_log_info *, uint16, int *order_var) const final
 Check to see if field size is compatible with destination. More...
 
uint is_equal (const Create_field *new_field) const final
 Check whether two numeric fields can be considered 'equal' for table alteration purposes. More...
 
Field_new_decimalclone (MEM_ROOT *mem_root) const final
 Makes a shallow copy of the Field object. More...
 
const ucharunpack (uchar *to, const uchar *from, uint param_data) final
 Unpack a decimal field from row data. More...
 
bool send_to_protocol (Protocol *protocol) const final
 Send the value of this field over the protocol using the correct Protocol::store*() function which matches the type of the field. More...
 
void set_keep_precision (bool arg)
 
- Public Member Functions inherited from Field_num
 Field_num (uchar *ptr_arg, uint32 len_arg, uchar *null_ptr_arg, uchar null_bit_arg, uchar auto_flags_arg, const char *field_name_arg, uint8 dec_arg, bool zero_arg, bool unsigned_arg)
 Numeric fields base class constructor. More...
 
bool is_unsigned () const final
 Whether the field is signed or not. More...
 
enum Derivation derivation () const final
 
uint repertoire () const final
 
const CHARSET_INFOcharset () const final
 
void prepend_zeros (String *value) const
 
uint decimals () const final
 
bool eq_def (const Field *field) const final
 
uint row_pack_length () const final
 
type_conversion_status check_int (const CHARSET_INFO *cs, const char *str, size_t length, const char *int_end, int error)
 Test if given number is a int. More...
 
type_conversion_status get_int (const CHARSET_INFO *cs, const char *from, size_t len, longlong *rnd, ulonglong unsigned_max, longlong signed_min, longlong signed_max)
 
- Public Member Functions inherited from Field
 Field (const Field &)=default
 
void operator= (Field &)=delete
 
bool has_insert_default_general_value_expression () const
 Checks if the field is marked as having a general expression to generate default values. More...
 
bool has_insert_default_datetime_value_expression () const
 Checks if the field is marked as having a datetime value expression to generate default values on inserts. More...
 
bool has_update_default_datetime_value_expression () const
 Checks if the field is marked as having a datetime value expression to generate default values on updates. More...
 
ucharget_null_ptr ()
 
virtual void set_field_length (uint32 length)
 
bool is_flag_set (unsigned flag) const
 
void set_flag (unsigned flag)
 
void clear_flag (unsigned flag)
 
uint32 all_flags () const
 
bool is_gcol () const
 
bool is_virtual_gcol () const
 
void set_hidden (dd::Column::enum_hidden_type hidden)
 Sets the hidden type for this field. More...
 
dd::Column::enum_hidden_type hidden () const
 
bool is_hidden_from_user () const
 
bool is_field_for_functional_index () const
 
 Field (uchar *ptr_arg, uint32 length_arg, uchar *null_ptr_arg, uchar null_bit_arg, uchar auto_flags_arg, const char *field_name_arg)
 This is used as a table name when the table structure is not set up. More...
 
virtual ~Field ()=default
 
void reset_warnings ()
 
void set_tmp_nullable ()
 Turn on temporary nullability for the field. More...
 
void reset_tmp_nullable ()
 Turn off temporary nullability for the field. More...
 
void reset_tmp_null ()
 Reset temporary NULL value for field. More...
 
void set_tmp_null ()
 Set field to temporary value NULL. More...
 
bool is_tmp_nullable () const
 
bool is_tmp_null () const
 
virtual type_conversion_status store_packed (longlong nr)
 Store a temporal value in packed longlong format into a field. More...
 
type_conversion_status store_time (MYSQL_TIME *ltime)
 Store MYSQL_TYPE value into a field when the number of fractional digits is not important or is not know. More...
 
type_conversion_status store (const char *to, size_t length, const CHARSET_INFO *cs, enum_check_fields check_level)
 
virtual longlong val_time_temporal () const
 Returns TIME value in packed longlong format. More...
 
virtual longlong val_date_temporal () const
 Returns DATE/DATETIME value in packed longlong format. More...
 
virtual longlong val_time_temporal_at_utc () const
 
virtual longlong val_date_temporal_at_utc () const
 
longlong val_temporal_by_field_type () const
 Returns "native" packed longlong representation of a TIME or DATE/DATETIME field depending on field type. More...
 
Stringval_str (String *str) const
 
Stringval_int_as_str (String *val_buffer, bool unsigned_flag) const
 Interpret field value as an integer but return the result as a string. More...
 
virtual bool str_needs_quotes () const
 
virtual Item_result numeric_context_result_type () const
 Returns Item_result type of a field when it appears in numeric context such as: SELECT time_column + 1; SELECT SUM(time_column); Examples: More...
 
virtual Item_result cmp_type () const
 
virtual Item_result cast_to_int_type () const
 
bool gcol_expr_is_equal (const Create_field *field) const
 Check whether generated columns' expressions are the same. More...
 
virtual bool eq (const Field *field) const
 
virtual uint32 pack_length_in_rec () const
 
int save_field_metadata (uchar *first_byte)
 
virtual uint32 data_length (ptrdiff_t row_offset=0) const
 
virtual uint32 max_data_length () const
 Get the maximum size of the data in packed format. More...
 
virtual bool get_timestamp (struct timeval *tm, int *warnings) const
 Returns a UTC component in struct timeval format. More...
 
virtual void store_timestamp (const timeval *)
 Stores a timestamp value in timeval format in a field. More...
 
virtual void set_default ()
 
void evaluate_insert_default_function ()
 Evaluates the INSERT default function and stores the result in the field. More...
 
void evaluate_update_default_function ()
 Evaluates the UPDATE default function, if one exists, and stores the result in the record buffer. More...
 
virtual bool binary () const
 
virtual uint32 key_length () const
 
virtual enum_field_types real_type () const
 
virtual enum_field_types binlog_type () const
 
int cmp (const uchar *str) const
 
virtual int cmp_max (const uchar *a, const uchar *b, uint max_len) const
 
virtual int cmp_binary (const uchar *a, const uchar *b, uint32 max_length=~0L) const
 
virtual int cmp_offset (ptrdiff_t row_offset) const
 
virtual int cmp_binary_offset (ptrdiff_t row_offset) const
 
virtual int key_cmp (const uchar *a, const uchar *b) const
 
virtual int key_cmp (const uchar *str, uint length) const
 
virtual bool is_text_key_type () const
 
bool is_null (ptrdiff_t row_offset=0) const
 Check whether the full table's row is NULL or the Field has value NULL. More...
 
bool is_real_null (ptrdiff_t row_offset=0) const
 Check whether the Field has value NULL (temporary or actual). More...
 
bool is_null_in_record (const uchar *record) const
 Check if the Field has value NULL or the record specified by argument has value NULL for this Field. More...
 
void set_null (ptrdiff_t row_offset=0)
 Set field to value NULL. More...
 
void set_notnull (ptrdiff_t row_offset=0)
 Set field to value NOT NULL. More...
 
type_conversion_status check_constraints (int mysql_errno)
 Check NOT NULL constraint on the field after temporary nullability is disabled. More...
 
void set_check_for_truncated_fields (enum_check_fields check_for_truncated_fields)
 Remember the value of THD::check_for_truncated_fields to handle possible NOT-NULL constraint errors after BEFORE-trigger execution is finished. More...
 
bool is_nullable () const
 
uint null_offset (const uchar *record) const
 
uint null_offset () const
 
void set_null_ptr (uchar *p_null_ptr, uint p_null_bit)
 
virtual void make_send_field (Send_field *send_field) const
 Populates a Send_field object with metadata about the column represented by this Field object. More...
 
virtual bool optimize_range (uint idx, uint part) const
 
virtual bool can_be_compared_as_longlong () const
 
virtual void mem_free ()
 
virtual Fieldnew_field (MEM_ROOT *root, TABLE *new_table) const
 
Fieldnew_field (MEM_ROOT *root, TABLE *new_table, uchar *new_ptr, uchar *new_null_ptr, uint new_null_bit) const
 
virtual Fieldnew_key_field (MEM_ROOT *root, TABLE *new_table, uchar *new_ptr, uchar *new_null_ptr, uint new_null_bit) const
 
Fieldnew_key_field (MEM_ROOT *root, TABLE *new_table, uchar *new_ptr) const
 
void move_field (uchar *ptr_arg, uchar *null_ptr_arg, uchar null_bit_arg)
 
virtual void move_field_offset (ptrdiff_t ptr_diff)
 
virtual void get_image (uchar *buff, size_t length, const CHARSET_INFO *) const
 
virtual void set_image (const uchar *buff, size_t length, const CHARSET_INFO *)
 
virtual size_t get_key_image (uchar *buff, size_t length, imagetype type) const
 
virtual void set_key_image (const uchar *buff, size_t length)
 
longlong val_int_offset (ptrdiff_t row_offset)
 
longlong val_int (uchar *new_ptr)
 
Stringval_str (String *str, uchar *new_ptr)
 
virtual ucharpack (uchar *to, const uchar *from, size_t max_length) const
 Pack the field into a format suitable for storage and transfer. More...
 
ucharpack (uchar *to) const
 
const ucharunpack (const uchar *from)
 
virtual ucharpack_with_metadata_bytes (uchar *to, const uchar *from, uint max_length) const
 This function does the same thing as pack(), except for the difference that max_length does not mean the number of bytes in the output, but the maximum field length from the input (which must be exactly field->max_field_length()). More...
 
virtual bool pack_diff (uchar **to, ulonglong value_options) const
 Write the field for the binary log in diff format. More...
 
virtual uint max_packed_col_length () const
 This is a wrapper around pack_length() used by filesort() to determine how many bytes we need for packing "addon fields". More...
 
uint offset (uchar *record) const
 
void copy_data (ptrdiff_t src_record_offset)
 
const CHARSET_INFOcharset_for_protocol () const
 
virtual const CHARSET_INFOsort_charset () const
 
virtual bool has_charset () const
 
virtual bool match_collation_to_optimize_range () const
 
virtual void set_derivation (enum Derivation)
 
bool set_warning (Sql_condition::enum_severity_level level, unsigned int code, int cut_increment)
 Produce warning or note about data saved into field. More...
 
bool set_warning (Sql_condition::enum_severity_level level, uint code, int cut_increment, const char *view_db, const char *view_name)
 Produce warning or note about data saved into field. More...
 
bool warn_if_overflow (int op_result)
 Process decimal library return codes and issue warnings for overflow and truncation. More...
 
virtual void init (TABLE *table_arg)
 
longlong convert_decimal2longlong (const my_decimal *val, bool unsigned_flag, bool *has_overflow)
 Conversion from decimal to longlong. More...
 
virtual uint32 char_length () const
 
virtual geometry_type get_geometry_type () const
 
void dbug_print () const
 
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)
 
virtual void hash (ulong *nr, ulong *nr2) const
 
virtual ulonglong get_max_int_value () const
 Get the upper limit of the MySQL integral and floating-point type. More...
 
virtual const uchardata_ptr () const
 Return a const pointer to the actual data in the record buffer. More...
 
const ucharfield_ptr () const
 Return a const pointer to where the field is stored in the record buffer. More...
 
ucharfield_ptr ()
 Return a pointer to where the field is stored in the record buffer. More...
 
void set_field_ptr (uchar *ptr_arg)
 
virtual bool is_updatable () const
 Checks whether a string field is part of write_set. More...
 
bool is_part_of_actual_key (THD *thd, uint cur_index, KEY *cur_index_info) const
 Check whether field is part of the index taking the index extensions flag into account. More...
 
Key_map get_covering_prefix_keys () const
 Get covering prefix keys. More...
 
virtual bool is_array () const
 Whether the field is a typed array. More...
 
virtual uint32 get_length_bytes () const
 Return number of bytes the field's length takes. More...
 
bool handle_old_value () const
 Whether field's old valued have to be handled. More...
 
virtual void set_field_index (uint16 field_index)
 Sets field index. More...
 
uint16 field_index () const
 Returns field index. More...
 

Static Public Member Functions

static Fieldcreate_from_item (const Item *item)
 
- Static Public Member Functions inherited from Field
static bool type_can_have_key_part (enum_field_types)
 Check whether a field type can be partially indexed by a key. More...
 
static enum_field_types field_type_merge (enum_field_types, enum_field_types)
 Return type of which can carry value of both given types in UNION result. More...
 
static Item_result result_merge_type (enum_field_types)
 Detect Item_result by given field type of UNION merge result. More...
 

Public Attributes

uint precision
 
uint bin_size
 
- Public Attributes inherited from Field_num
const uint8 dec
 
bool zerofill
 True if the column was declared with the ZEROFILL attribute. More...
 
- Public Attributes inherited from Field
TABLEtable
 
const char * orig_db_name {nullptr}
 Pointer to original database name, only non-NULL for a temporary table. More...
 
const char * orig_table_name {nullptr}
 Pointer to original table name, only non-NULL for a temporary table. More...
 
const char ** table_name
 
const char * field_name
 
LEX_CSTRING comment
 
Key_map key_start
 
Key_map part_of_key
 Keys that includes this field except of prefix keys. More...
 
Key_map part_of_prefixkey
 Prefix keys. More...
 
Key_map part_of_sortkey
 
Key_map part_of_key_not_extended
 All keys that include this field, but not extended by the storage engine to include primary key columns. More...
 
uint32 field_length
 
uchar null_bit
 
uchar auto_flags
 Bitmap of flags indicating if field value is auto-generated by default and/or on update, and in which way. More...
 
bool is_created_from_null_item
 If true, this field was created in create_tmp_field_from_item from a NULL value. More...
 
bool m_indexed
 True if this field belongs to some index (unlike part_of_key, the index might have only a prefix). More...
 
LEX_CSTRING m_engine_attribute = EMPTY_CSTR
 
LEX_CSTRING m_secondary_engine_attribute = EMPTY_CSTR
 
Value_generatorgcol_info {nullptr}
 
bool stored_in_db
 
Value_generatorm_default_val_expr {nullptr}
 Holds the expression to be used to generate default values. More...
 

Private Member Functions

int do_save_field_metadata (uchar *first_byte) const final
 Save the field metadata for new decimal fields. More...
 

Private Attributes

bool m_keep_precision {false}
 Normally, the underlying decimal code will degrade values' excessive precision. More...
 

Additional Inherited Members

- Public Types inherited from Field
enum  enum_auto_flags {
  NONE = 0, NEXT_NUMBER = 1, DEFAULT_NOW = 2, ON_UPDATE_NOW = 4,
  GENERATED_FROM_EXPRESSION = 8
}
 Flags for Field::auto_flags / Create_field::auto_flags bitmaps. More...
 
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 }
 
- Static Public Attributes inherited from Field
static constexpr size_t MAX_VARCHAR_WIDTH {65535}
 
static constexpr size_t MAX_TINY_BLOB_WIDTH {255}
 
static constexpr size_t MAX_SHORT_BLOB_WIDTH {65535}
 
static constexpr size_t MAX_MEDIUM_BLOB_WIDTH {16777215}
 
static constexpr size_t MAX_LONG_BLOB_WIDTH {4294967295}
 
- Protected Member Functions inherited from Field
ucharpack_int16 (uchar *to, const uchar *from, size_t max_length) const
 
const ucharunpack_int16 (uchar *to, const uchar *from) const
 
ucharpack_int24 (uchar *to, const uchar *from, size_t max_length) const
 
const ucharunpack_int24 (uchar *to, const uchar *from) const
 
ucharpack_int32 (uchar *to, const uchar *from, size_t max_length) const
 
const ucharunpack_int32 (uchar *to, const uchar *from) const
 
ucharpack_int64 (uchar *to, const uchar *from, size_t max_length) const
 
const ucharunpack_int64 (uchar *to, const uchar *from) const
 
- Protected Attributes inherited from Field
ucharptr
 Holds the position to the field in record. More...
 
- Static Protected Attributes inherited from Field
static uchar dummy_null_buffer = ' '
 

Constructor & Destructor Documentation

◆ Field_new_decimal() [1/2]

Field_new_decimal::Field_new_decimal ( uchar ptr_arg,
uint32  len_arg,
uchar null_ptr_arg,
uchar  null_bit_arg,
uchar  auto_flags_arg,
const char *  field_name_arg,
uint8  dec_arg,
bool  zero_arg,
bool  unsigned_arg 
)

◆ Field_new_decimal() [2/2]

Field_new_decimal::Field_new_decimal ( uint32  len_arg,
bool  is_nullable_arg,
const char *  field_name_arg,
uint8  dec_arg,
bool  unsigned_arg 
)

Member Function Documentation

◆ clone()

Field_new_decimal* Field_new_decimal::clone ( MEM_ROOT mem_root) const
inlinefinalvirtual

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_rootMEM_ROOT to use for memory allocation.
Return values
NULLIf memory allocation failed.

Implements Field.

◆ cmp()

int Field_new_decimal::cmp ( const uchar a,
const uchar b 
) const
finalvirtual

Implements Field.

◆ compatible_field_size()

bool Field_new_decimal::compatible_field_size ( uint  field_metadata,
Relay_log_info ,
uint16  ,
int *  order_var 
) const
finalvirtual

Check to see if field size is compatible with destination.

This method is used in row-based replication to verify that the slave's field size is less than or equal to the master's field size. The encoded field metadata (from the master or source) is decoded and compared to the size of this field (the slave or destination).

Parameters
field_metadataEncoded size in field metadata
order_varPointer to variable where the order between the source field and this field will be returned.
Returns
true

Reimplemented from Field.

◆ create_from_item()

Field * Field_new_decimal::create_from_item ( const Item item)
static

◆ do_save_field_metadata()

int Field_new_decimal::do_save_field_metadata ( uchar metadata_ptr) const
finalprivatevirtual

Save the field metadata for new decimal fields.

Saves the precision in the first byte and decimals() in the second byte of the field metadata array at index of *metadata_ptr and (metadata_ptr + 1).

Parameters
metadata_ptrFirst byte of field metadata
Returns
number of bytes written to metadata_ptr

Reimplemented from Field.

◆ get_date()

bool Field_new_decimal::get_date ( MYSQL_TIME ltime,
my_time_flags_t  fuzzydate 
) const
finalvirtual

Reimplemented from Field_num.

◆ get_time()

bool Field_new_decimal::get_time ( MYSQL_TIME ltime) const
finalvirtual

Reimplemented from Field_num.

◆ is_equal()

uint Field_new_decimal::is_equal ( const Create_field new_field) const
finalvirtual

Check whether two numeric fields can be considered 'equal' for table alteration purposes.

Fields are equal if they are of the same type and retain the same pack length.

Reimplemented from Field_num.

◆ key_type()

enum ha_base_keytype Field_new_decimal::key_type ( ) const
inlinefinalvirtual

Reimplemented from Field.

◆ make_sort_key()

size_t Field_new_decimal::make_sort_key ( uchar buff,
size_t  length 
) const
finalvirtual

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
buffThe buffer, assumed to be at least length bytes.
lengthNumber of bytes to write.
Return values
Thenumber of bytes actually written.
Note
This is now only used by replication; filesort makes its own sort keys based off of Items, not Fields.

Implements Field.

◆ max_display_length()

uint32 Field_new_decimal::max_display_length ( ) const
inlinefinalvirtual

Implements Field.

◆ pack_length()

uint32 Field_new_decimal::pack_length ( ) const
inlinefinalvirtual

Reimplemented from Field.

◆ pack_length_from_metadata()

uint Field_new_decimal::pack_length_from_metadata ( uint  field_metadata) const
finalvirtual

Returns the number of bytes field uses in row-based replication row packed size.

This method is used in row-based replication to determine the number of bytes that the field consumes in the row record format. This is used to skip fields in the master that do not exist on the slave.

Parameters
field_metadataEncoded size in field metadata
Returns
The size of the field based on the field metadata.

Reimplemented from Field_num.

◆ reset()

type_conversion_status Field_new_decimal::reset ( )
finalvirtual

Reimplemented from Field.

◆ result_type()

Item_result Field_new_decimal::result_type ( ) const
inlinefinalvirtual

Reimplemented from Field_num.

◆ send_to_protocol()

bool Field_new_decimal::send_to_protocol ( Protocol protocol) const
finalvirtual

Send the value of this field over the protocol using the correct Protocol::store*() function which matches the type of the field.

Reimplemented from Field.

◆ set_keep_precision()

void Field_new_decimal::set_keep_precision ( bool  arg)
inline

◆ set_value_on_overflow()

void Field_new_decimal::set_value_on_overflow ( my_decimal decimal_value,
bool  sign 
) const

Generate max/min decimal value in case of overflow.

Parameters
decimal_valuebuffer for value
signsign of value which caused overflow

◆ sql_type()

void Field_new_decimal::sql_type ( String str) const
finalvirtual

Implements Field.

◆ store() [1/3]

type_conversion_status Field_new_decimal::store ( const char *  to,
size_t  length,
const CHARSET_INFO charset 
)
finalvirtual

Implements Field.

◆ store() [2/3]

type_conversion_status Field_new_decimal::store ( double  nr)
finalvirtual

Implements Field.

◆ store() [3/3]

type_conversion_status Field_new_decimal::store ( longlong  nr,
bool  unsigned_val 
)
finalvirtual

Implements Field.

◆ store_decimal()

type_conversion_status Field_new_decimal::store_decimal ( const my_decimal val)
finalvirtual

Storing decimal in integer fields.

Parameters
valvalue for storing
Note
This method is used by all integer fields, real/decimal redefine it
Return values
TYPE_OKStorage of value went fine without warnings or errors
!TYPE_OKWarning/error as indicated by type_conversion_status enum value

Reimplemented from Field_num.

◆ store_time()

type_conversion_status Field_new_decimal::store_time ( MYSQL_TIME ltime,
uint8  dec_arg 
)
finalvirtual

Store MYSQL_TIME value with the given amount of decimal digits into a field.

This is called when storing a date in a string.

Note, the "dec" parameter represents number of digits of the Item that previously created the MYSQL_TIME value. It's needed when we store the value into a CHAR/VARCHAR/TEXT field to display the proper amount of fractional digits. For other field types the "dec" value does not matter and is ignored.

Parameters
ltimeTime, date or datetime value.
dec_argNumber of decimals in ltime.
Return values
falseon success
trueon error
Note
Needs to be changed if/when we want to support different time formats.

Reimplemented from Field_num.

◆ store_value()

type_conversion_status Field_new_decimal::store_value ( const my_decimal decimal_value)

Store decimal value in the binary buffer.

Checks if decimal_value fits into field size. If it does, stores the decimal in the buffer using binary format. Otherwise sets maximal number that can be stored in the field.

Parameters
decimal_valuemy_decimal
Return values
0ok
1error

◆ type()

enum_field_types Field_new_decimal::type ( ) const
inlinefinalvirtual

Implements Field.

◆ unpack()

const uchar * Field_new_decimal::unpack ( uchar to,
const uchar from,
uint  param_data 
)
finalvirtual

Unpack a decimal field from row data.

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

Parameters
toDestination of the data
fromSource of the data
param_dataPrecision (upper) and decimal (lower) values
Returns
New pointer into memory based on from + length of the data

Reimplemented from Field.

◆ val_decimal()

my_decimal * Field_new_decimal::val_decimal ( my_decimal decimal_value) const
finalvirtual

Return decimal value of integer field.

Parameters
decimal_valuebuffer for storing decimal value
Note
This method is used by all integer fields, real/decimal redefine it. All longlong values fit in our decimal buffer which cal store 8*9=72 digits of integer number
Returns
pointer to decimal buffer with value of field

Reimplemented from Field_num.

◆ val_int()

longlong Field_new_decimal::val_int ( void  ) const
finalvirtual

Implements Field.

◆ val_real()

double Field_new_decimal::val_real ( void  ) const
finalvirtual

Implements Field.

◆ val_str()

String * Field_new_decimal::val_str ( String val_buffer,
String  
) const
finalvirtual

Implements Field.

◆ zero_pack()

bool Field_new_decimal::zero_pack ( ) const
inlinefinalvirtual

Reimplemented from Field.

Member Data Documentation

◆ bin_size

uint Field_new_decimal::bin_size

◆ m_keep_precision

bool Field_new_decimal::m_keep_precision {false}
private

Normally, the underlying decimal code will degrade values' excessive precision.

E.g. value 0.0 stored as decimal(10,4) will be returned as decimal(4,4). This is fine for general purpose, but isn't usable for multi-valued index. Field_typed_array uses a field for conversion and it expects the value read from it to be exactly same as it would be stored in SE, i.e with preserved precision. Otherwise, SE won't be able to index it. TRUE here tells underlying DECIMAL reading code to keep the precision as is.

◆ precision

uint Field_new_decimal::precision

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