← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/field.h

  • Committer: Jay Pipes
  • Date: 2009-02-28 20:43:31 UTC
  • mto: (910.2.6 mordred-noatomics)
  • mto: This revision was merged to the branch mainline in revision 912.
  • Revision ID: jpipes@serialcoder-20090228204331-6x804cdbfzyy9w8i
Merged in remove-timezone work

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/field.h
25
25
#ifndef DRIZZLED_FIELD_H
26
26
#define DRIZZLED_FIELD_H
27
27
 
28
 
#include "drizzled/sql_error.h"
29
 
#include "drizzled/decimal.h"
30
 
#include "drizzled/key_map.h"
31
 
#include "drizzled/sql_list.h"
32
 
#include "drizzled/structs.h"
33
 
#include "drizzled/charset_info.h"
34
 
#include "drizzled/item_result.h"
35
 
 
 
28
#include <drizzled/sql_error.h>
 
29
#include <drizzled/my_decimal.h>
 
30
#include <drizzled/sql_bitmap.h>
 
31
#include <drizzled/sql_list.h>
 
32
/* System-wide common data structures */
 
33
#include <drizzled/structs.h>
36
34
#include <string>
37
 
#include <vector>
38
 
 
39
 
namespace drizzled
40
 
{
41
35
 
42
36
#define DATETIME_DEC                     6
43
37
#define DOUBLE_TO_STRING_CONVERSION_BUFFER_SIZE FLOATING_POINT_BUFFER
44
38
 
45
 
#ifdef DEBUG
46
 
#define ASSERT_COLUMN_MARKED_FOR_READ assert(!getTable() || (getTable()->read_set == NULL || isReadSet()))
47
 
#define ASSERT_COLUMN_MARKED_FOR_WRITE assert(!getTable() || (getTable()->write_set == NULL || isWriteSet()))
48
 
#else
49
 
#define ASSERT_COLUMN_MARKED_FOR_READ assert(getTable())
50
 
#define ASSERT_COLUMN_MARKED_FOR_WRITE assert(getTable())
51
 
#endif
52
 
 
53
 
typedef struct st_typelib TYPELIB;
54
 
 
55
39
const uint32_t max_field_size= (uint32_t) 4294967295U;
56
40
 
57
 
class SendField;
58
 
class CreateField;
59
 
class TableShare;
 
41
class Table;
 
42
class Send_field;
 
43
class Protocol;
 
44
class Create_field;
 
45
class virtual_column_info;
 
46
 
 
47
class TABLE_SHARE;
 
48
 
60
49
class Field;
61
 
struct CacheField;
62
50
 
 
51
struct st_cache_field;
63
52
int field_conv(Field *to,Field *from);
64
53
 
65
 
/**
66
 
 * Class representing a Field in a Table
67
 
 *
68
 
 * @details
69
 
 *
70
 
 * The value stored in the Field object is stored in the
71
 
 * unsigned char pointer member variable called ptr.  The
72
 
 * val_xxx() methods retrieve this raw byte value and
73
 
 * convert the byte into the appropriate output (int, decimal, etc).
74
 
 *
75
 
 * The store_xxx() methods take various input and convert
76
 
 * the input into the raw bytes stored in the ptr member variable.
77
 
 */
 
54
inline uint32_t get_enum_pack_length(int elements)
 
55
{
 
56
  return elements < 256 ? 1 : 2;
 
57
}
 
58
 
78
59
class Field
79
60
{
80
 
  /* Prevent use of these */
81
 
  Field(const Field&);
 
61
  Field(const Item &);                          /* Prevent use of these */
82
62
  void operator=(Field &);
83
 
 
84
 
public:
85
 
  unsigned char *ptr; /**< Position to field in record. Stores raw field value */
86
 
  unsigned char *null_ptr; /**< Byte where null_bit is */
87
 
 
88
 
  /**
89
 
   * Pointer to the Table object containing this Field
90
 
   *
91
 
   * @note You can use table->in_use as replacement for current_session member
92
 
   * only inside of val_*() and store() members (e.g. you can't use it in cons)
93
 
   */
94
 
private:
95
 
  Table *table;
96
 
public:
97
 
  Table *getTable()
98
 
  {
99
 
    assert(table);
100
 
    return table;
101
 
  }
102
 
 
103
 
  Table *getTable() const
104
 
  {
105
 
    assert(table);
106
 
    return table;
107
 
  }
108
 
 
109
 
  void setTable(Table *table_arg)
110
 
  {
111
 
    table= table_arg;
112
 
  }
113
 
 
114
 
  Table *orig_table; /**< Pointer to the original Table. @TODO What is "the original table"? */
115
 
  const char *field_name; /**< Name of the field */
116
 
  LEX_STRING comment; /**< A comment about the field */
117
 
 
118
 
  /** The field is part of the following keys */
119
 
  key_map       key_start;
120
 
  key_map part_of_key;
121
 
  key_map part_of_key_not_clustered;
122
 
  key_map part_of_sortkey;
123
 
 
124
 
  /*
125
 
    We use three additional unireg types for TIMESTAMP for hysterical
126
 
    raisins and limitations in the MySQL FRM file format.
127
 
 
128
 
    A good TODO is to clean this up as we can support just about
129
 
    anything in the table proto message now.
130
 
  */
131
 
  enum utype
132
 
  {
133
 
    NONE,
134
 
    NEXT_NUMBER,
135
 
    TIMESTAMP_OLD_FIELD,
136
 
    TIMESTAMP_DN_FIELD,
137
 
    TIMESTAMP_UN_FIELD,
138
 
    TIMESTAMP_DNUN_FIELD
139
 
  };
140
 
 
141
 
  utype unireg_check;
142
 
  uint32_t field_length; /**< Length of this field in bytes */
143
 
  uint32_t flags;
144
 
private:
145
 
  uint16_t field_index; /**< Index of this Field in Table::fields array */
146
 
 
147
 
public:
148
 
 
149
 
  uint16_t position() const
150
 
  {
151
 
    return field_index;
152
 
  }
153
 
 
154
 
  void setPosition(uint32_t arg)
155
 
  {
156
 
    field_index= arg;
157
 
  }
158
 
 
159
 
  unsigned char null_bit; /**< Bit used to test null bit */
 
63
public:
 
64
  static void *operator new(size_t size) {return sql_alloc(size); }
 
65
  static void *operator new(size_t size, MEM_ROOT *mem_root)
 
66
  { return (void*) alloc_root(mem_root, (uint32_t) size); }
 
67
 
 
68
  static void operator delete(void *, size_t)
 
69
  { TRASH(ptr_arg, size); }
 
70
 
 
71
  unsigned char         *ptr;                   // Position to field in record
 
72
  unsigned char         *null_ptr;              // Byte where null_bit is
 
73
  /*
 
74
    Note that you can use table->in_use as replacement for current_session member
 
75
    only inside of val_*() and store() members (e.g. you can't use it in cons)
 
76
  */
 
77
  Table *table;         // Pointer for table
 
78
  Table *orig_table;            // Pointer to original table
 
79
  const char    **table_name, *field_name;
 
80
  LEX_STRING    comment;
 
81
  /* Field is part of the following keys */
 
82
  key_map       key_start, part_of_key, part_of_key_not_clustered;
 
83
  key_map       part_of_sortkey;
 
84
  /*
 
85
    We use three additional unireg types for TIMESTAMP to overcome limitation
 
86
    of current binary format of .frm file. We'd like to be able to support
 
87
    NOW() as default and on update value for such fields but unable to hold
 
88
    this info anywhere except unireg_check field. This issue will be resolved
 
89
    in more clean way with transition to new text based .frm format.
 
90
    See also comment for Field_timestamp::Field_timestamp().
 
91
  */
 
92
  enum utype  { NONE,
 
93
                NEXT_NUMBER,
 
94
                TIMESTAMP_OLD_FIELD,
 
95
                TIMESTAMP_DN_FIELD, TIMESTAMP_UN_FIELD, TIMESTAMP_DNUN_FIELD};
 
96
  enum imagetype { itRAW, itMBR};
 
97
 
 
98
  utype         unireg_check;
 
99
  uint32_t      field_length;           // Length of field
 
100
  uint32_t      flags;
 
101
  uint16_t        field_index;            // field number in fields array
 
102
  unsigned char         null_bit;               // Bit used to test null bit
160
103
  /**
161
104
     If true, this field was created in create_tmp_field_from_item from a NULL
162
105
     value. This means that the type of the field is just a guess, and the type
164
107
 
165
108
     @see create_tmp_field_from_item
166
109
     @see Item_type_holder::get_real_type
 
110
 
167
111
   */
168
112
  bool is_created_from_null_item;
169
113
 
170
 
  static void *operator new(size_t size);
171
 
  static void *operator new(size_t size, memory::Root *mem_root);
172
 
  static void operator delete(void *, size_t)
173
 
  { }
174
 
  static void operator delete(void *, memory::Root *)
175
 
  { }
 
114
  /* Virtual column data */
 
115
  virtual_column_info *vcol_info;
 
116
  /*
 
117
    Indication that the field is physically stored in tables
 
118
    rather than just generated on SQL queries.
 
119
    As of now, false can only be set for generated-only virtual columns.
 
120
  */
 
121
  bool is_stored;
176
122
 
177
 
  Field(unsigned char *ptr_arg,
178
 
        uint32_t length_arg,
179
 
        unsigned char *null_ptr_arg,
180
 
        unsigned char null_bit_arg,
181
 
        utype unireg_check_arg,
 
123
  Field(unsigned char *ptr_arg,uint32_t length_arg,unsigned char *null_ptr_arg,
 
124
        unsigned char null_bit_arg, utype unireg_check_arg,
182
125
        const char *field_name_arg);
183
126
  virtual ~Field() {}
184
 
 
185
 
  bool hasDefault() const
186
 
  {
187
 
    return not (flags & NO_DEFAULT_VALUE_FLAG);
188
 
  }
189
 
 
190
127
  /* Store functions returns 1 on overflow and -1 on fatal error */
191
 
  virtual int store(const char *to,
192
 
                    uint32_t length,
 
128
  virtual int store(const char *to, uint32_t length,
193
129
                    const CHARSET_INFO * const cs)=0;
194
130
  virtual int store(double nr)=0;
195
131
  virtual int store(int64_t nr, bool unsigned_val)=0;
196
132
  virtual int store_decimal(const my_decimal *d)=0;
197
 
  int store_and_check(enum_check_fields check_level,
198
 
                      const char *to,
199
 
                      uint32_t length,
200
 
                      const CHARSET_INFO * const cs);
201
 
  /**
202
 
    This is called when storing a date in a string.
203
 
 
204
 
    @note
205
 
      Needs to be changed if/when we want to support different time formats.
206
 
  */
207
 
  virtual int store_time(DRIZZLE_TIME *ltime, enum enum_drizzle_timestamp_type t_type);
208
 
  virtual double val_real()=0;
209
 
  virtual int64_t val_int()=0;
 
133
  int store(const char *to, uint32_t length,
 
134
            const CHARSET_INFO * const cs,
 
135
            enum_check_fields check_level);
 
136
  virtual int store_time(DRIZZLE_TIME *ltime,
 
137
                         enum enum_drizzle_timestamp_type t_type);
 
138
  virtual double val_real(void)=0;
 
139
  virtual int64_t val_int(void)=0;
210
140
  virtual my_decimal *val_decimal(my_decimal *);
211
 
  String *val_str_internal(String *str)
212
 
  {
213
 
    return val_str(str, str);
214
 
  }
 
141
  inline String *val_str(String *str) { return val_str(str, str); }
215
142
  /*
216
143
     val_str(buf1, buf2) gets two buffers and should use them as follows:
217
144
     if it needs a temp buffer to convert result to string - use buf1
224
151
     an unnecessary free (and later, may be an alloc).
225
152
     This trickery is used to decrease a number of malloc calls.
226
153
  */
227
 
  virtual String *val_str(String*, String *)=0;
 
154
  virtual String *val_str(String*,String *)=0;
 
155
  String *val_int_as_str(String *val_buffer, bool unsigned_flag);
228
156
  /*
229
157
   str_needs_quotes() returns true if the value returned by val_str() needs
230
158
   to be quoted when used in constructing an SQL query.
237
165
     Check whether a field type can be partially indexed by a key.
238
166
 
239
167
     This is a static method, rather than a virtual function, because we need
240
 
     to check the type of a non-Field in alter_table().
 
168
     to check the type of a non-Field in mysql_alter_table().
241
169
 
242
170
     @param type  field type
243
171
 
247
175
       false Type can not have a prefixed key
248
176
  */
249
177
  static bool type_can_have_key_part(enum_field_types);
250
 
  /**
251
 
    Return type of which can carry value of both given types in UNION result.
252
 
 
253
 
    @param a  type for merging
254
 
    @param b  type for merging
255
 
 
256
 
    @retval
257
 
      type of field
258
 
  */
259
178
  static enum_field_types field_type_merge(enum_field_types, enum_field_types);
260
179
 
261
180
  /**
269
188
  static Item_result result_merge_type(enum_field_types);
270
189
 
271
190
  virtual bool eq(Field *field);
272
 
  /**
273
 
   * Returns true if the fields are equally defined
274
 
   *
275
 
   * @retval
276
 
   *  true  This Field is equally defined to supplied Field
277
 
   * @retval
278
 
   *  false This Field is NOT equally defined to supplied Field
279
 
   */
280
191
  virtual bool eq_def(Field *field);
281
192
 
282
 
  /**
283
 
   * Returns size (in bytes) used to store field data in memory
284
 
   * (i.e. it returns the maximum size of the field in a row of the table,
285
 
   * which is located in RAM).
286
 
   */
 
193
  /*
 
194
    pack_length() returns size (in bytes) used to store field data in memory
 
195
    (i.e. it returns the maximum size of the field in a row of the table,
 
196
    which is located in RAM).
 
197
  */
287
198
  virtual uint32_t pack_length() const;
288
199
 
289
 
  /**
290
 
   * Returns size (in bytes) used to store field data on
291
 
   * storage (i.e. it returns the maximal size of the field in a row of the
292
 
   * table, which is located on disk).
293
 
   */
 
200
  /*
 
201
    pack_length_in_rec() returns size (in bytes) used to store field data on
 
202
    storage (i.e. it returns the maximal size of the field in a row of the
 
203
    table, which is located on disk).
 
204
  */
294
205
  virtual uint32_t pack_length_in_rec() const;
295
 
 
296
 
  /**
297
 
   * Return the "real size" of the data in memory.
298
 
   * For varstrings, this does _not_ include the length bytes.
299
 
   */
 
206
  virtual int compatible_field_size(uint32_t field_metadata);
 
207
  virtual uint32_t pack_length_from_metadata(uint32_t field_metadata);
 
208
 
 
209
  /*
 
210
    This method is used to return the size of the data in a row-based
 
211
    replication row record. The default implementation of returning 0 is
 
212
    designed to allow fields that do not use metadata to return true (1)
 
213
    from compatible_field_size() which uses this function in the comparison.
 
214
    The default value for field metadata for fields that do not have
 
215
    metadata is 0. Thus, 0 == 0 means the fields are compatible in size.
 
216
 
 
217
    Note: While most classes that override this method return pack_length(),
 
218
    the classes Field_varstring, and Field_blob return
 
219
    field_length + 1, field_length, and pack_length_no_ptr() respectfully.
 
220
  */
 
221
  virtual uint32_t row_pack_length();
 
222
  virtual int save_field_metadata(unsigned char *first_byte);
 
223
 
 
224
  /*
 
225
    data_length() return the "real size" of the data in memory.
 
226
    For varstrings, this does _not_ include the length bytes.
 
227
  */
300
228
  virtual uint32_t data_length();
301
 
  /**
302
 
   * Returns the number of bytes actually used to store the data
303
 
   * of the field. So for a varstring it includes both lenght byte(s) and
304
 
   * string data, and anything after data_length() bytes are unused.
305
 
   */
 
229
  /*
 
230
    used_length() returns the number of bytes actually used to store the data
 
231
    of the field. So for a varstring it includes both lenght byte(s) and
 
232
    string data, and anything after data_length() bytes are unused.
 
233
  */
306
234
  virtual uint32_t used_length();
307
235
  virtual uint32_t sort_length() const;
308
236
 
322
250
  virtual uint32_t key_length() const;
323
251
  virtual enum_field_types type() const =0;
324
252
  virtual enum_field_types real_type() const;
325
 
  virtual int cmp_max(const unsigned char *a, const unsigned char *b, uint32_t max_len);
 
253
  inline  int cmp(const unsigned char *str) { return cmp(ptr,str); }
 
254
  virtual int cmp_max(const unsigned char *a, const unsigned char *b,
 
255
                      uint32_t max_len);
326
256
  virtual int cmp(const unsigned char *,const unsigned char *)=0;
327
 
  int cmp_internal(const unsigned char *str) { return cmp(ptr,str); }
328
257
  virtual int cmp_binary(const unsigned char *a,const unsigned char *b,
329
258
                         uint32_t max_length=UINT32_MAX);
330
259
  virtual int cmp_offset(uint32_t row_offset);
343
272
  // For new field
344
273
  virtual uint32_t size_of() const =0;
345
274
 
346
 
  bool is_null(ptrdiff_t row_offset= 0);
347
 
  bool is_real_null(ptrdiff_t row_offset= 0);
 
275
  bool is_null(my_ptrdiff_t row_offset= 0);
 
276
  bool is_real_null(my_ptrdiff_t row_offset= 0);
348
277
  bool is_null_in_record(const unsigned char *record);
349
 
  bool is_null_in_record_with_offset(ptrdiff_t offset);
350
 
  void set_null(ptrdiff_t row_offset= 0);
351
 
  void set_notnull(ptrdiff_t row_offset= 0);
 
278
  bool is_null_in_record_with_offset(my_ptrdiff_t offset);
 
279
  void set_null(my_ptrdiff_t row_offset= 0);
 
280
  void set_notnull(my_ptrdiff_t row_offset= 0);
352
281
  bool maybe_null(void);
353
282
  bool real_maybe_null(void);
354
283
 
355
 
  virtual void make_field(SendField *);
 
284
  enum {
 
285
    LAST_NULL_BYTE_UNDEF= 0
 
286
  };
 
287
 
 
288
  /*
 
289
    Find the position of the last null byte for the field.
 
290
 
 
291
    SYNOPSIS
 
292
      last_null_byte()
 
293
 
 
294
    DESCRIPTION
 
295
      Return a pointer to the last byte of the null bytes where the
 
296
      field conceptually is placed.
 
297
 
 
298
    RETURN VALUE
 
299
      The position of the last null byte relative to the beginning of
 
300
      the record. If the field does not use any bits of the null
 
301
      bytes, the value 0 (LAST_NULL_BYTE_UNDEF) is returned.
 
302
   */
 
303
  size_t last_null_byte() const;
 
304
 
 
305
  virtual void make_field(Send_field *);
356
306
  virtual void sort_string(unsigned char *buff,uint32_t length)=0;
357
307
  virtual bool optimize_range(uint32_t idx, uint32_t part);
358
 
  /**
359
 
   * Returns true for fields which, when compared with constant
360
 
   * items, can be casted to int64_t. In this case we will at 'fix_fields'
361
 
   * stage cast the constant items to int64_ts and at the execution stage
362
 
   * use field->val_int() for comparison.  Used to optimize clauses like
363
 
   * 'a_column BETWEEN date_const AND date_const'.
364
 
   */
365
 
  virtual bool can_be_compared_as_int64_t() const
366
 
  {
367
 
    return false;
368
 
  }
 
308
  /*
 
309
    This should be true for fields which, when compared with constant
 
310
    items, can be casted to int64_t. In this case we will at 'fix_fields'
 
311
    stage cast the constant items to int64_ts and at the execution stage
 
312
    use field->val_int() for comparison.  Used to optimize clauses like
 
313
    'a_column BETWEEN date_const, date_const'.
 
314
  */
 
315
  virtual bool can_be_compared_as_int64_t() const { return false; }
369
316
  virtual void free() {}
370
 
  virtual Field *new_field(memory::Root *root,
371
 
                           Table *new_table,
 
317
  virtual Field *new_field(MEM_ROOT *root, Table *new_table,
372
318
                           bool keep_type);
373
 
  virtual Field *new_key_field(memory::Root *root, Table *new_table,
374
 
                               unsigned char *new_ptr,
375
 
                               unsigned char *new_null_ptr,
 
319
  virtual Field *new_key_field(MEM_ROOT *root, Table *new_table,
 
320
                               unsigned char *new_ptr, unsigned char *new_null_ptr,
376
321
                               uint32_t new_null_bit);
377
 
  /** This is used to generate a field in Table from TableShare */
378
 
  Field *clone(memory::Root *mem_root, Table *new_table);
379
 
  void move_field(unsigned char *ptr_arg,unsigned char *null_ptr_arg,unsigned char null_bit_arg)
 
322
  Field *clone(MEM_ROOT *mem_root, Table *new_table);
 
323
  inline void move_field(unsigned char *ptr_arg,unsigned char *null_ptr_arg,unsigned char null_bit_arg)
380
324
  {
381
 
    ptr= ptr_arg;
382
 
    null_ptr= null_ptr_arg;
383
 
    null_bit= null_bit_arg;
 
325
    ptr=ptr_arg; null_ptr=null_ptr_arg; null_bit=null_bit_arg;
384
326
  }
385
 
  void move_field(unsigned char *ptr_arg) { ptr=ptr_arg; }
386
 
  virtual void move_field_offset(ptrdiff_t ptr_diff)
 
327
  inline void move_field(unsigned char *ptr_arg) { ptr=ptr_arg; }
 
328
  virtual void move_field_offset(my_ptrdiff_t ptr_diff)
387
329
  {
388
 
    ptr= ADD_TO_PTR(ptr,ptr_diff, unsigned char*);
 
330
    ptr=ADD_TO_PTR(ptr,ptr_diff, unsigned char*);
389
331
    if (null_ptr)
390
 
      null_ptr= ADD_TO_PTR(null_ptr,ptr_diff,unsigned char*);
391
 
  }
392
 
  virtual void get_image(unsigned char *buff, uint32_t length, const CHARSET_INFO * const)
393
 
  {
394
 
    memcpy(buff,ptr,length);
395
 
  }
396
 
  virtual void get_image(std::basic_string<unsigned char> &buff, uint32_t length, const CHARSET_INFO * const)
397
 
  {
398
 
    buff.append(ptr,length);
399
 
  }
400
 
  virtual void set_image(const unsigned char *buff,uint32_t length, const CHARSET_INFO * const)
401
 
  {
402
 
    memcpy(ptr,buff,length);
403
 
  }
404
 
 
405
 
  /**
406
 
   * Copy a field part into an output buffer.
407
 
   *
408
 
   * @details
409
 
   *
410
 
   * This function makes a copy of field part of size equal to or
411
 
   * less than "length" parameter value.
412
 
   * For fields of string types (VARCHAR, TEXT) the rest of buffer
413
 
   * is padded by zero byte.
414
 
   *
415
 
   * @param output buffer
416
 
   * @param output buffer size
417
 
   *
418
 
   * @note
419
 
   *
420
 
   * For variable length character fields (i.e. UTF-8) the "length"
421
 
   * parameter means a number of output buffer bytes as if all field
422
 
   * characters have maximal possible size (mbmaxlen). In the other words,
423
 
   * "length" parameter is a number of characters multiplied by
424
 
   * field_charset->mbmaxlen.
425
 
   *
426
 
   * @retval
427
 
   *   Number of copied bytes (excluding padded zero bytes -- see above).
428
 
   */
429
 
  virtual uint32_t get_key_image(unsigned char *buff, uint32_t length)
 
332
      null_ptr=ADD_TO_PTR(null_ptr,ptr_diff,unsigned char*);
 
333
  }
 
334
  virtual void get_image(unsigned char *buff, uint32_t length,
 
335
                         const CHARSET_INFO * const)
 
336
    { memcpy(buff,ptr,length); }
 
337
  virtual void get_image(std::basic_string<unsigned char> &buff,
 
338
                         uint32_t length,
 
339
                         const CHARSET_INFO * const)
 
340
    { buff.append(ptr,length); }
 
341
  virtual void set_image(const unsigned char *buff,uint32_t length,
 
342
                         const CHARSET_INFO * const)
 
343
    { memcpy(ptr,buff,length); }
 
344
 
 
345
 
 
346
  /*
 
347
    Copy a field part into an output buffer.
 
348
 
 
349
    SYNOPSIS
 
350
      Field::get_key_image()
 
351
      buff   [out] output buffer
 
352
      length       output buffer size
 
353
      type         itMBR for geometry blobs, otherwise itRAW
 
354
 
 
355
    DESCRIPTION
 
356
      This function makes a copy of field part of size equal to or
 
357
      less than "length" parameter value.
 
358
      For fields of string types (CHAR, VARCHAR, TEXT) the rest of buffer
 
359
      is padded by zero byte.
 
360
 
 
361
    NOTES
 
362
      For variable length character fields (i.e. UTF-8) the "length"
 
363
      parameter means a number of output buffer bytes as if all field
 
364
      characters have maximal possible size (mbmaxlen). In the other words,
 
365
      "length" parameter is a number of characters multiplied by
 
366
      field_charset->mbmaxlen.
 
367
 
 
368
    RETURN
 
369
      Number of copied bytes (excluding padded zero bytes -- see above).
 
370
  */
 
371
 
 
372
  virtual uint32_t get_key_image(unsigned char *buff, uint32_t length, imagetype)
430
373
  {
431
374
    get_image(buff, length, &my_charset_bin);
432
375
    return length;
433
376
  }
434
 
  virtual uint32_t get_key_image(std::basic_string<unsigned char> &buff, uint32_t length)
 
377
  virtual uint32_t get_key_image(std::basic_string<unsigned char> &buff,
 
378
                                 uint32_t length, imagetype)
435
379
  {
436
380
    get_image(buff, length, &my_charset_bin);
437
381
    return length;
438
382
  }
439
383
  virtual void set_key_image(const unsigned char *buff,uint32_t length)
440
 
  {
441
 
    set_image(buff,length, &my_charset_bin);
442
 
  }
443
 
  int64_t val_int_offset(uint32_t row_offset)
 
384
  { set_image(buff,length, &my_charset_bin); }
 
385
  inline int64_t val_int_offset(uint32_t row_offset)
444
386
  {
445
387
    ptr+=row_offset;
446
388
    int64_t tmp=val_int();
448
390
    return tmp;
449
391
  }
450
392
 
451
 
  int64_t val_int_internal(const unsigned char *new_ptr)
 
393
  inline int64_t val_int(const unsigned char *new_ptr)
452
394
  {
453
395
    unsigned char *old_ptr= ptr;
454
396
    int64_t return_value;
455
 
    ptr= const_cast<unsigned char*>(new_ptr);
 
397
    ptr= (unsigned char*) new_ptr;
456
398
    return_value= val_int();
457
399
    ptr= old_ptr;
458
400
    return return_value;
459
401
  }
460
 
 
461
 
  String *val_str_internal(String *str, const unsigned char *new_ptr)
 
402
  inline String *val_str(String *str, const unsigned char *new_ptr)
462
403
  {
463
404
    unsigned char *old_ptr= ptr;
464
 
    ptr= const_cast<unsigned char*>(new_ptr);
465
 
    val_str_internal(str);
 
405
    ptr= (unsigned char*) new_ptr;
 
406
    val_str(str);
466
407
    ptr= old_ptr;
467
408
    return str;
468
409
  }
469
410
 
470
 
  /**
471
 
    Pack the field into a format suitable for storage and transfer.
472
 
 
473
 
    To implement packing functionality, only the virtual function
474
 
    should be overridden. The other functions are just convenience
475
 
    functions and hence should not be overridden.
476
 
 
477
 
    The value of <code>low_byte_first</code> is dependent on how the
478
 
    packed data is going to be used: for local use, e.g., temporary
479
 
    store on disk or in memory, use the native format since that is
480
 
    faster. For data that is going to be transfered to other machines
481
 
    (e.g., when writing data to the binary log), data should always be
482
 
    stored in little-endian format.
483
 
 
484
 
    @note The default method for packing fields just copy the raw bytes
485
 
    of the record into the destination, but never more than
486
 
    <code>max_length</code> characters.
487
 
 
488
 
    @param to
489
 
    Pointer to memory area where representation of field should be put.
490
 
 
491
 
    @param from
492
 
    Pointer to memory area where record representation of field is
493
 
    stored.
494
 
 
495
 
    @param max_length
496
 
    Maximum length of the field, as given in the column definition. For
497
 
    example, for <code>CHAR(1000)</code>, the <code>max_length</code>
498
 
    is 1000. This information is sometimes needed to decide how to pack
499
 
    the data.
500
 
 
501
 
    @param low_byte_first
502
 
    @c true if integers should be stored little-endian, @c false if
503
 
    native format should be used. Note that for little-endian machines,
504
 
    the value of this flag is a moot point since the native format is
505
 
    little-endian.
506
 
  */
507
411
  virtual unsigned char *pack(unsigned char *to,
508
412
                              const unsigned char *from,
509
413
                              uint32_t max_length,
511
415
 
512
416
  unsigned char *pack(unsigned char *to, const unsigned char *from);
513
417
 
514
 
  /**
515
 
    Unpack a field from row data.
516
 
 
517
 
    This method is used to unpack a field from a master whose size of
518
 
    the field is less than that of the slave.
519
 
 
520
 
    The <code>param_data</code> parameter is a two-byte integer (stored
521
 
    in the least significant 16 bits of the unsigned integer) usually
522
 
    consisting of two parts: the real type in the most significant byte
523
 
    and a original pack length in the least significant byte.
524
 
 
525
 
    The exact layout of the <code>param_data</code> field is given by
526
 
    the <code>Table_map_log_event::save_field_metadata()</code>.
527
 
 
528
 
    This is the default method for unpacking a field. It just copies
529
 
    the memory block in byte order (of original pack length bytes or
530
 
    length of field, whichever is smaller).
531
 
 
532
 
    @param   to         Destination of the data
533
 
    @param   from       Source of the data
534
 
    @param   param_data Real type and original pack length of the field
535
 
                        data
536
 
 
537
 
    @param low_byte_first
538
 
    If this flag is @c true, all composite entities (e.g., lengths)
539
 
    should be unpacked in little-endian format; otherwise, the entities
540
 
    are unpacked in native order.
541
 
 
542
 
    @return  New pointer into memory based on from + length of the data
543
 
  */
544
418
  virtual const unsigned char *unpack(unsigned char* to,
545
419
                                      const unsigned char *from,
546
420
                                      uint32_t param_data,
552
426
  const unsigned char *unpack(unsigned char* to,
553
427
                              const unsigned char *from);
554
428
 
555
 
  virtual unsigned char *pack_key(unsigned char* to,
556
 
                                  const unsigned char *from,
557
 
                                  uint32_t max_length,
558
 
                                  bool low_byte_first)
 
429
  virtual unsigned char *pack_key(unsigned char* to, const unsigned char *from,
 
430
                          uint32_t max_length, bool low_byte_first)
 
431
  {
 
432
    return pack(to, from, max_length, low_byte_first);
 
433
  }
 
434
  virtual unsigned char *pack_key_from_key_image(unsigned char* to,
 
435
                                                 const unsigned char *from,
 
436
                                                 uint32_t max_length,
 
437
                                                 bool low_byte_first)
559
438
  {
560
439
    return pack(to, from, max_length, low_byte_first);
561
440
  }
566
445
  {
567
446
    return unpack(to, from, max_length, low_byte_first);
568
447
  }
 
448
  virtual uint32_t packed_col_length(const unsigned char *to, uint32_t length);
569
449
  virtual uint32_t max_packed_col_length(uint32_t max_length)
570
 
  {
571
 
    return max_length;
572
 
  }
573
 
 
574
 
  uint32_t offset(const unsigned char *record)
 
450
  { return max_length;}
 
451
 
 
452
  virtual int pack_cmp(const unsigned char *a,const unsigned char *b,
 
453
                       uint32_t key_length_arg,
 
454
                       bool insert_or_update);
 
455
  virtual int pack_cmp(const unsigned char *b,
 
456
                       uint32_t key_length_arg,
 
457
                       bool insert_or_update);
 
458
 
 
459
  uint32_t offset(unsigned char *record)
575
460
  {
576
461
    return (uint32_t) (ptr - record);
577
462
  }
578
463
  void copy_from_tmp(int offset);
579
 
  uint32_t fill_cache_field(CacheField *copy);
 
464
  uint32_t fill_cache_field(struct st_cache_field *copy);
580
465
  virtual bool get_date(DRIZZLE_TIME *ltime,uint32_t fuzzydate);
581
466
  virtual bool get_time(DRIZZLE_TIME *ltime);
582
467
  virtual const CHARSET_INFO *charset(void) const { return &my_charset_bin; }
583
468
  virtual const CHARSET_INFO *sort_charset(void) const { return charset(); }
584
469
  virtual bool has_charset(void) const { return false; }
585
470
  virtual void set_charset(const CHARSET_INFO * const)
586
 
  {}
 
471
  { }
587
472
  virtual enum Derivation derivation(void) const
588
 
  {
589
 
    return DERIVATION_IMPLICIT;
590
 
  }
 
473
  { return DERIVATION_IMPLICIT; }
591
474
  virtual void set_derivation(enum Derivation)
592
 
  {}
593
 
  /**
594
 
    Produce warning or note about data saved into field.
595
 
 
596
 
    @param level            - level of message (Note/Warning/Error)
597
 
    @param code             - error code of message to be produced
598
 
    @param cuted_increment  - whenever we should increase cut fields count or not
599
 
 
600
 
    @note
601
 
      This function won't produce warning and increase cut fields counter
602
 
      if count_cuted_fields == CHECK_FIELD_IGNORE for current thread.
603
 
 
604
 
      if count_cuted_fields == CHECK_FIELD_IGNORE then we ignore notes.
605
 
      This allows us to avoid notes in optimisation, like convert_constant_item().
606
 
 
607
 
    @retval
608
 
      1 if count_cuted_fields == CHECK_FIELD_IGNORE and error level is not NOTE
609
 
    @retval
610
 
      0 otherwise
611
 
  */
612
 
  bool set_warning(DRIZZLE_ERROR::enum_warning_level,
613
 
                   unsigned int code,
 
475
  { }
 
476
  bool set_warning(DRIZZLE_ERROR::enum_warning_level, unsigned int code,
614
477
                   int cuted_increment);
615
 
  /**
616
 
    Produce warning or note about datetime string data saved into field.
617
 
 
618
 
    @param level            level of message (Note/Warning/Error)
619
 
    @param code             error code of message to be produced
620
 
    @param str              string value which we tried to save
621
 
    @param str_length       length of string which we tried to save
622
 
    @param ts_type          type of datetime value (datetime/date/time)
623
 
    @param cuted_increment  whenever we should increase cut fields count or not
624
 
 
625
 
    @note
626
 
      This function will always produce some warning but won't increase cut
627
 
      fields counter if count_cuted_fields ==FIELD_CHECK_IGNORE for current
628
 
      thread.
629
 
  */
630
 
  void set_datetime_warning(DRIZZLE_ERROR::enum_warning_level,
631
 
                            uint32_t code,
632
 
                            const char *str,
633
 
                            uint32_t str_len,
634
 
                            enum enum_drizzle_timestamp_type ts_type,
635
 
                            int cuted_increment);
636
 
  /**
637
 
    Produce warning or note about integer datetime value saved into field.
638
 
 
639
 
    @param level            level of message (Note/Warning/Error)
640
 
    @param code             error code of message to be produced
641
 
    @param nr               numeric value which we tried to save
642
 
    @param ts_type          type of datetime value (datetime/date/time)
643
 
    @param cuted_increment  whenever we should increase cut fields count or not
644
 
 
645
 
    @note
646
 
      This function will always produce some warning but won't increase cut
647
 
      fields counter if count_cuted_fields == FIELD_CHECK_IGNORE for current
648
 
      thread.
649
 
  */
650
 
  void set_datetime_warning(DRIZZLE_ERROR::enum_warning_level,
651
 
                            uint32_t code,
652
 
                            int64_t nr,
653
 
                            enum enum_drizzle_timestamp_type ts_type,
654
 
                            int cuted_increment);
655
 
  /**
656
 
    Produce warning or note about double datetime data saved into field.
657
 
 
658
 
    @param level            level of message (Note/Warning/Error)
659
 
    @param code             error code of message to be produced
660
 
    @param nr               double value which we tried to save
661
 
    @param ts_type          type of datetime value (datetime/date/time)
662
 
 
663
 
    @note
664
 
      This function will always produce some warning but won't increase cut
665
 
      fields counter if count_cuted_fields == FIELD_CHECK_IGNORE for current
666
 
      thread.
667
 
  */
668
 
  void set_datetime_warning(DRIZZLE_ERROR::enum_warning_level,
669
 
                            const uint32_t code,
670
 
                            double nr,
671
 
                            enum enum_drizzle_timestamp_type ts_type);
672
 
  bool check_overflow(int op_result)
 
478
  void set_datetime_warning(DRIZZLE_ERROR::enum_warning_level, uint32_t code,
 
479
                            const char *str, uint32_t str_len,
 
480
                            enum enum_drizzle_timestamp_type ts_type, int cuted_increment);
 
481
  void set_datetime_warning(DRIZZLE_ERROR::enum_warning_level, uint32_t code,
 
482
                            int64_t nr, enum enum_drizzle_timestamp_type ts_type,
 
483
                            int cuted_increment);
 
484
  void set_datetime_warning(DRIZZLE_ERROR::enum_warning_level, const uint32_t code,
 
485
                            double nr, enum enum_drizzle_timestamp_type ts_type);
 
486
  inline bool check_overflow(int op_result)
673
487
  {
674
488
    return (op_result == E_DEC_OVERFLOW);
675
489
  }
676
 
  /**
677
 
    Process decimal library return codes and issue warnings for overflow and
678
 
    truncation.
679
 
 
680
 
    @param op_result  decimal library return code (E_DEC_* see include/decimal.h)
681
 
 
682
 
    @retval
683
 
      E_DEC_OVERFLOW   there was overflow
684
 
      E_DEC_TRUNCATED  there was truncation
685
 
    @retval
686
 
      0  no error or there was some other error except overflow or truncation
687
 
  */
688
490
  int warn_if_overflow(int op_result);
689
491
  void init(Table *table_arg);
690
492
 
691
493
  /* maximum possible display length */
692
494
  virtual uint32_t max_display_length()= 0;
693
495
 
694
 
  virtual uint32_t is_equal(CreateField *new_field);
695
 
  /**
696
 
    Conversion from decimal to int64_t with checking overflow and
697
 
    setting correct value (min/max) in case of overflow.
698
 
 
699
 
    @param val             value which have to be converted
700
 
    @param unsigned_flag   type of integer in which we convert val
701
 
    @param err             variable to pass error code
702
 
 
703
 
    @return
704
 
      value converted from val
705
 
  */
706
 
  int64_t convert_decimal2int64_t(const my_decimal *val,
707
 
                                  bool unsigned_flag,
708
 
                                  int *err);
 
496
  virtual uint32_t is_equal(Create_field *new_field);
 
497
  /* convert decimal to int64_t with overflow check */
 
498
  int64_t convert_decimal2int64_t(const my_decimal *val, bool unsigned_flag,
 
499
                                    int *err);
709
500
  /* The max. number of characters */
710
 
  uint32_t char_length() const
 
501
  inline uint32_t char_length() const
711
502
  {
712
503
    return field_length / charset()->mbmaxlen;
713
504
  }
714
505
 
715
 
  enum column_format_type column_format() const
 
506
  inline enum column_format_type column_format() const
716
507
  {
717
508
    return (enum column_format_type)
718
509
      ((flags >> COLUMN_FORMAT_FLAGS) & COLUMN_FORMAT_MASK);
721
512
  /* Hash value */
722
513
  virtual void hash(uint32_t *nr, uint32_t *nr2);
723
514
  friend bool reopen_table(Session *,Table *,bool);
724
 
 
725
 
  friend class CopyField;
 
515
  friend int cre_myisam(char * name, register Table *form, uint32_t options,
 
516
                        uint64_t auto_increment_value);
 
517
  friend class Copy_field;
726
518
  friend class Item_avg_field;
727
519
  friend class Item_std_field;
728
520
  friend class Item_sum_num;
735
527
  friend class Item_sum_max;
736
528
  friend class Item_func_group_concat;
737
529
 
738
 
  bool isReadSet();
739
 
  bool isWriteSet();
740
 
  void setReadSet(bool arg= true);
741
 
  void setWriteSet(bool arg= true);
742
 
};
743
 
 
744
 
std::ostream& operator<<(std::ostream& output, const Field &field);
745
 
 
746
 
} /* namespace drizzled */
747
 
 
748
 
/** @TODO Why is this in the middle of the file???*/
749
 
#include "drizzled/create_field.h"
750
 
 
751
 
namespace drizzled
752
 
{
 
530
private:
 
531
  /*
 
532
    Primitive for implementing last_null_byte().
 
533
 
 
534
    SYNOPSIS
 
535
      do_last_null_byte()
 
536
 
 
537
    DESCRIPTION
 
538
      Primitive for the implementation of the last_null_byte()
 
539
      function. This represents the inheritance interface and can be
 
540
      overridden by subclasses.
 
541
   */
 
542
  virtual size_t do_last_null_byte() const;
753
543
 
754
544
/**
755
 
 * A class for sending field information to a client.
756
 
 *
757
 
 * @details
758
 
 *
759
 
 * Send_field is basically a stripped-down POD class for
760
 
 * representing basic information about a field...
761
 
 */
762
 
class SendField
 
545
   Retrieve the field metadata for fields.
 
546
 
 
547
   This default implementation returns 0 and saves 0 in the metadata_ptr
 
548
   value.
 
549
 
 
550
   @param   metadata_ptr   First byte of field metadata
 
551
 
 
552
   @returns 0 no bytes written.
 
553
*/
 
554
  virtual int do_save_field_metadata(unsigned char *)
 
555
  { return 0; }
 
556
};
 
557
 
 
558
/*
 
559
  Create field class for CREATE TABLE
 
560
*/
 
561
 
 
562
class Create_field :public Sql_alloc
763
563
{
764
564
public:
 
565
  const char *field_name;
 
566
  const char *change;                   // If done with alter table
 
567
  const char *after;                    // Put column after this one
 
568
  LEX_STRING comment;                   // Comment for field
 
569
  Item  *def;                           // Default value
 
570
  enum  enum_field_types sql_type;
 
571
  /*
 
572
    At various stages in execution this can be length of field in bytes or
 
573
    max number of characters.
 
574
  */
 
575
  uint32_t length;
 
576
  /*
 
577
    The value of `length' as set by parser: is the number of characters
 
578
    for most of the types, or of bytes for BLOBs or numeric types.
 
579
  */
 
580
  uint32_t char_length;
 
581
  uint32_t  decimals, flags, pack_length, key_length;
 
582
  Field::utype unireg_check;
 
583
  TYPELIB *interval;                    // Which interval to use
 
584
  TYPELIB *save_interval;               // Temporary copy for the above
 
585
                                        // Used only for UCS2 intervals
 
586
  List<String> interval_list;
 
587
  const CHARSET_INFO *charset;
 
588
  Field *field;                         // For alter table
 
589
 
 
590
  uint8_t       interval_id;    // For rea_create_table
 
591
  uint32_t      offset,pack_flag;
 
592
 
 
593
  /* Virtual column expression statement */
 
594
  virtual_column_info *vcol_info;
 
595
  /*
 
596
    Indication that the field is phycically stored in tables
 
597
    rather than just generated on SQL queries.
 
598
    As of now, FALSE can only be set for generated-only virtual columns.
 
599
  */
 
600
  bool is_stored;
 
601
 
 
602
  Create_field() :after(0) {}
 
603
  Create_field(Field *field, Field *orig_field);
 
604
  /* Used to make a clone of this object for ALTER/CREATE TABLE */
 
605
  Create_field *clone(MEM_ROOT *mem_root) const
 
606
    { return new (mem_root) Create_field(*this); }
 
607
  void create_length_to_internal_length(void);
 
608
 
 
609
  inline enum column_format_type column_format() const
 
610
  {
 
611
    return (enum column_format_type)
 
612
      ((flags >> COLUMN_FORMAT_FLAGS) & COLUMN_FORMAT_MASK);
 
613
  }
 
614
 
 
615
  /* Init for a tmp table field. To be extended if need be. */
 
616
  void init_for_tmp_table(enum_field_types sql_type_arg,
 
617
                          uint32_t max_length, uint32_t decimals,
 
618
                          bool maybe_null, bool is_unsigned);
 
619
 
 
620
  bool init(Session *session, char *field_name, enum_field_types type, char *length,
 
621
            char *decimals, uint32_t type_modifier, Item *default_value,
 
622
            Item *on_update_value, LEX_STRING *comment, char *change,
 
623
            List<String> *interval_list, const CHARSET_INFO * const cs,
 
624
            uint32_t uint_geom_type,
 
625
            enum column_format_type column_format,
 
626
            virtual_column_info *vcol_info);
 
627
};
 
628
 
 
629
 
 
630
/*
 
631
  A class for sending info to the client
 
632
*/
 
633
 
 
634
class Send_field {
 
635
 public:
765
636
  const char *db_name;
766
 
  const char *table_name;
767
 
  const char *org_table_name;
768
 
  const char *col_name;
769
 
  const char *org_col_name;
 
637
  const char *table_name,*org_table_name;
 
638
  const char *col_name,*org_col_name;
770
639
  uint32_t length;
771
 
  uint32_t charsetnr;
772
 
  uint32_t flags;
773
 
  uint32_t decimals;
 
640
  uint32_t charsetnr, flags, decimals;
774
641
  enum_field_types type;
775
 
  SendField() {}
 
642
  Send_field() {}
776
643
};
777
644
 
778
 
/**
779
 
 * A class for quick copying data to fields
780
 
 */
781
 
class CopyField :public memory::SqlAlloc
782
 
{
 
645
 
 
646
/*
 
647
  A class for quick copying data to fields
 
648
*/
 
649
 
 
650
class Copy_field :public Sql_alloc {
783
651
  /**
784
652
    Convenience definition of a copy function returned by
785
653
    get_copy_func.
786
654
  */
787
 
  typedef void Copy_func(CopyField*);
 
655
  typedef void Copy_func(Copy_field*);
788
656
  Copy_func *get_copy_func(Field *to, Field *from);
789
657
public:
790
 
  unsigned char *from_ptr;
791
 
  unsigned char *to_ptr;
792
 
  unsigned char *from_null_ptr;
793
 
  unsigned char *to_null_ptr;
 
658
  unsigned char *from_ptr,*to_ptr;
 
659
  unsigned char *from_null_ptr,*to_null_ptr;
794
660
  bool *null_row;
795
 
  uint32_t from_bit;
796
 
  uint32_t to_bit;
797
 
  uint32_t from_length;
798
 
  uint32_t to_length;
799
 
  Field *from_field;
800
 
  Field *to_field;
 
661
  uint32_t      from_bit,to_bit;
 
662
  uint32_t from_length,to_length;
 
663
  Field *from_field,*to_field;
801
664
  String tmp;                                   // For items
802
665
 
803
 
  CopyField() {}
804
 
  ~CopyField() {}
 
666
  Copy_field() {}
 
667
  ~Copy_field() {}
805
668
  void set(Field *to,Field *from,bool save);    // Field to field
806
669
  void set(unsigned char *to,Field *from);              // Field to string
807
 
  void (*do_copy)(CopyField *);
808
 
  void (*do_copy2)(CopyField *);                // Used to handle null values
 
670
  void (*do_copy)(Copy_field *);
 
671
  void (*do_copy2)(Copy_field *);               // Used to handle null values
809
672
};
810
673
 
 
674
 
 
675
Field *make_field(TABLE_SHARE *share, MEM_ROOT *root, unsigned char *ptr, uint32_t field_length,
 
676
                  unsigned char *null_pos, unsigned char null_bit,
 
677
                  uint32_t pack_flag, enum_field_types field_type,
 
678
                  const CHARSET_INFO * cs,
 
679
                  Field::utype unireg_check,
 
680
                  TYPELIB *interval, const char *field_name);
 
681
 
811
682
uint32_t pack_length_to_packflag(uint32_t type);
 
683
enum_field_types get_blob_type_from_length(uint32_t length);
812
684
uint32_t calc_pack_length(enum_field_types type,uint32_t length);
813
685
int set_field_to_null(Field *field);
814
686
int set_field_to_null_with_conversions(Field *field, bool no_conversions);
815
687
 
816
 
/**
817
 
 * Tests if the given string contains important data:
818
 
 * not spaces for character string, or any data for binary string.
819
 
 *
820
 
 * @param pointer to the character set to use
821
 
 * @param String to test
822
 
 * @param String end
823
 
 *
824
 
 * @retval
825
 
 *  false - If string does not have important data
826
 
 * @retval
827
 
 *  true  - If string has some important data
828
 
 */
829
 
bool test_if_important_data(const CHARSET_INFO * const cs,
830
 
                            const char *str,
831
 
                            const char *strend);
832
 
 
833
 
} /* namespace drizzled */
 
688
 
 
689
bool
 
690
test_if_important_data(const CHARSET_INFO * const cs,
 
691
                       const char *str,
 
692
                       const char *strend);
 
693
 
834
694
 
835
695
#endif /* DRIZZLED_FIELD_H */