← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/handler.h

  • Committer: Brian Aker
  • Date: 2009-02-05 09:11:16 UTC
  • Revision ID: brian@tangent.org-20090205091116-iy0ersp6bhyzt1ad
Removed dead variables.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/handler.h
1
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3
3
 *
4
 
 *  Copyright (C) 2008 Sun Microsystems, Inc.
 
4
 *  Copyright (C) 2008 Sun Microsystems
5
5
 *
6
6
 *  This program is free software; you can redistribute it and/or modify
7
7
 *  it under the terms of the GNU General Public License as published by
17
17
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18
18
 */
19
19
 
20
 
#ifndef DRIZZLED_CURSOR_H
21
 
#define DRIZZLED_CURSOR_H
 
20
#ifndef DRIZZLED_HANDLER_H
 
21
#define DRIZZLED_HANDLER_H
22
22
 
23
23
#include <drizzled/xid.h>
24
 
#include <drizzled/discrete_interval.h>
25
 
#include <drizzled/identifier.h>
26
 
#include <drizzled/definitions.h>
27
 
#include <drizzled/key_map.h>
28
 
#include <drizzled/error_t.h>
29
 
 
30
 
/* Definitions for parameters to do with Cursor-routines */
31
 
 
32
 
#include <drizzled/thr_lock.h>
 
24
 
 
25
/* Definitions for parameters to do with handler-routines */
 
26
 
 
27
#include <storage/myisam/keycache.h>
 
28
#include <mysys/thr_lock.h>
 
29
#include <mysys/hash.h>
 
30
#include <drizzled/sql_string.h>
33
31
#include <drizzled/sql_list.h>
 
32
#include <drizzled/handlerton.h>
34
33
#include <drizzled/handler_structs.h>
35
34
#include <drizzled/ha_statistics.h>
36
 
#include <drizzled/atomics.h>
37
 
 
38
 
#include <drizzled/message/table.h>
39
 
 
40
 
#include <bitset>
41
 
#include <algorithm>
42
 
 
43
 
#include "drizzled/visibility.h"
44
 
 
45
 
namespace drizzled
46
 
{
 
35
 
 
36
/* Bits to show what an alter table will do */
 
37
#include <drizzled/sql_bitmap.h>
47
38
 
48
39
#define HA_MAX_ALTER_FLAGS 40
49
 
 
50
 
typedef std::bitset<HA_MAX_ALTER_FLAGS> HA_ALTER_FLAGS;
51
 
 
52
 
class AlterInfo;
53
 
class CreateField;
54
 
class ForeignKeyInfo;
 
40
typedef Bitmap<HA_MAX_ALTER_FLAGS> HA_ALTER_FLAGS;
 
41
 
 
42
 
 
43
typedef bool (*qc_engine_callback)(Session *session, char *table_key,
 
44
                                      uint32_t key_length,
 
45
                                      uint64_t *engine_data);
 
46
 
 
47
 
 
48
/* The handler for a table type.  Will be included in the Table structure */
 
49
 
 
50
class Table;
 
51
class TableList;
 
52
class TABLE_SHARE;
 
53
struct st_foreign_key_info;
 
54
typedef struct st_foreign_key_info FOREIGN_KEY_INFO;
 
55
struct order_st;
 
56
 
55
57
class Item;
56
 
class Item_ident;
 
58
struct st_table_log_memory_entry;
 
59
 
57
60
class LEX;
58
 
class Select_Lex;
59
 
class Select_Lex_Unit;
60
 
class String;
61
 
class Table;
62
 
class TableList;
63
 
class TableShare;
 
61
typedef class st_select_lex SELECT_LEX;
 
62
typedef class st_select_lex_unit SELECT_LEX_UNIT;
 
63
class Alter_info;
64
64
class select_result;
 
65
class Create_field;
65
66
class sys_var_str;
66
 
struct Order;
 
67
class Item_ident;
 
68
typedef struct st_sort_field SORT_FIELD;
67
69
 
68
70
typedef List<Item> List_item;
 
71
 
 
72
typedef struct st_savepoint SAVEPOINT;
 
73
extern uint32_t savepoint_alloc_size;
69
74
extern KEY_CREATE_INFO default_key_create_info;
70
75
 
71
76
/* Forward declaration for condition pushdown to storage engine */
72
77
typedef class Item COND;
73
78
 
74
 
typedef struct system_status_var system_status_var;
75
 
 
76
 
namespace optimizer { class CostVector; }
77
 
namespace plugin { class StorageEngine; }
78
 
 
 
79
typedef struct system_status_var SSV;
 
80
 
 
81
class COST_VECT;
 
82
 
 
83
uint16_t &mrr_persistent_flag_storage(range_seq_t seq, uint32_t idx);
 
84
char* &mrr_get_ptr_by_idx(range_seq_t seq, uint32_t idx);
 
85
 
 
86
uint32_t calculate_key_len(Table *, uint, const unsigned char *, key_part_map);
79
87
/*
80
88
  bitmap with first N+1 bits set
81
89
  (keypart_map for a key prefix of [0..N] keyparts)
97
105
}
98
106
 
99
107
/**
100
 
  The Cursor class is the interface for dynamically loadable
 
108
  The handler class is the interface for dynamically loadable
101
109
  storage engines. Do not add ifdefs and take care when adding or
102
110
  changing virtual functions to avoid vtable confusion
103
111
 
107
115
     storage engine
108
116
 
109
117
  2. KeyTupleFormat - used to pass index search tuples (aka "keys") to
110
 
     storage engine. See optimizer/range.cc for description of this format.
 
118
     storage engine. See opt_range.cc for description of this format.
111
119
 
112
120
  TableRecordFormat
113
121
  =================
132
140
  present, its length is one byte <not-sure> which must be set to 0xFF
133
141
  at all times. </not-sure>
134
142
 
 
143
  If the table has columns of type BIT, then certain bits from those columns
 
144
  may be stored in null_bytes as well. Grep around for Field_bit for
 
145
  details.
 
146
 
135
147
  For blob columns (see Field_blob), the record buffer stores length of the
136
148
  data, following by memory pointer to the blob data. The pointer is owned
137
149
  by the storage engine and is valid until the next operation.
139
151
  If a blob column has NULL value, then its length and blob data pointer
140
152
  must be set to 0.
141
153
*/
142
 
class DRIZZLED_API Cursor
 
154
 
 
155
class handler :public Sql_alloc
143
156
{
144
 
  friend class SEAPITesterCursor;
145
 
  Table &table;               /* The current open table */
146
 
  plugin::StorageEngine &engine;      /* storage engine of this Cursor */
 
157
public:
 
158
  typedef uint64_t Table_flags;
147
159
 
148
160
protected:
 
161
  TABLE_SHARE *table_share;   /* The table definition */
 
162
  Table *table;               /* The current open table */
 
163
  Table_flags cached_table_flags;       /* Set on init() and open() */
 
164
 
149
165
  ha_rows estimation_rows_to_insert;
150
 
 
151
166
public:
152
 
  inline plugin::StorageEngine *getEngine() const       /* table_type for handler */
153
 
  {
154
 
    return &engine;
155
 
  }
 
167
  handlerton *ht;                 /* storage engine of this handler */
156
168
  unsigned char *ref;                           /* Pointer to current row */
157
169
  unsigned char *dup_ref;                       /* Pointer to duplicate row */
158
170
 
159
 
  TableShare *getShare();
160
 
 
161
 
  Table *getTable() const
162
 
  {
163
 
    return &table;
164
 
  }
165
 
 
166
171
  ha_statistics stats;
167
172
  /** MultiRangeRead-related members: */
168
173
  range_seq_t mrr_iter;    /* Interator to traverse the range sequence */
169
174
  RANGE_SEQ_IF mrr_funcs;  /* Range sequence traversal functions */
170
 
 
 
175
  HANDLER_BUFFER *multi_range_buffer; /* MRR buffer info */
171
176
  uint32_t ranges_in_seq; /* Total number of ranges in the traversed sequence */
172
177
  /* true <=> source MRR ranges and the output are ordered */
173
178
  bool mrr_is_output_sorted;
174
179
 
175
180
  /** true <=> we're currently traversing a range in mrr_cur_range. */
176
181
  bool mrr_have_range;
177
 
 
178
 
  bool eq_range;
179
 
 
180
182
  /** Current range (the one we're now returning rows from) */
181
183
  KEY_MULTI_RANGE mrr_cur_range;
182
184
 
183
185
  /** The following are for read_range() */
184
186
  key_range save_end_range, *end_range;
185
 
  KeyPartInfo *range_key_part;
 
187
  KEY_PART_INFO *range_key_part;
186
188
  int key_compare_result_on_equal;
 
189
  bool eq_range;
 
190
  /*
 
191
    true <=> the engine guarantees that returned records are within the range
 
192
    being scanned.
 
193
  */
 
194
  bool in_range_check_pushed_down;
187
195
 
188
196
  uint32_t errkey;                              /* Last dup key */
189
197
  uint32_t key_used_on_scan;
192
200
  uint32_t ref_length;
193
201
  enum {NONE=0, INDEX, RND} inited;
194
202
  bool locked;
 
203
  bool implicit_emptied;                /* Can be !=0 only if HEAP */
 
204
  const Item *pushed_cond;
 
205
 
 
206
  Item *pushed_idx_cond;
 
207
  uint32_t pushed_idx_cond_keyno;  /* The index which the above condition is for */
195
208
 
196
209
  /**
197
210
    next_insert_id is the next value which should be inserted into the
203
216
    get_auto_increment().
204
217
  */
205
218
  uint64_t next_insert_id;
206
 
  uint64_t getNextInsertId()
207
 
  {
208
 
    return next_insert_id;
209
 
  }
210
 
 
211
 
  /**
212
 
    Used by SHOW TABLE STATUS to get the current auto_inc from the engine
213
 
  */
214
 
  uint64_t getAutoIncrement()
215
 
  {
216
 
    return stats.auto_increment_value;
217
 
  }
218
 
 
219
219
  /**
220
220
    insert id for the current row (*autogenerated*; if not
221
221
    autogenerated, it's 0).
229
229
  */
230
230
  Discrete_interval auto_inc_interval_for_cur_row;
231
231
 
232
 
  Cursor(plugin::StorageEngine &engine_arg, Table &share_arg);
233
 
  virtual ~Cursor(void);
234
 
  virtual Cursor *clone(memory::Root *mem_root);
 
232
  handler(handlerton *ht_arg, TABLE_SHARE *share_arg)
 
233
    :table_share(share_arg), table(0),
 
234
    estimation_rows_to_insert(0), ht(ht_arg),
 
235
    ref(0), in_range_check_pushed_down(false),
 
236
    key_used_on_scan(MAX_KEY), active_index(MAX_KEY),
 
237
    ref_length(sizeof(my_off_t)),
 
238
    inited(NONE),
 
239
    locked(false), implicit_emptied(0),
 
240
    pushed_cond(0), pushed_idx_cond(NULL), pushed_idx_cond_keyno(MAX_KEY),
 
241
    next_insert_id(0), insert_id_for_cur_row(0)
 
242
    {}
 
243
  virtual ~handler(void)
 
244
  {
 
245
    assert(locked == false);
 
246
    /* TODO: assert(inited == NONE); */
 
247
  }
 
248
  virtual handler *clone(MEM_ROOT *mem_root);
 
249
  /** This is called after create to allow us to set up cached variables */
 
250
  void init()
 
251
  {
 
252
    cached_table_flags= table_flags();
 
253
  }
235
254
 
236
255
  /* ha_ methods: pubilc wrappers for private virtual API */
237
256
 
238
 
  int ha_open(const identifier::Table &identifier, int mode, int test_if_locked);
239
 
  int startIndexScan(uint32_t idx, bool sorted) __attribute__ ((warn_unused_result));
240
 
  int endIndexScan();
241
 
  int startTableScan(bool scan) __attribute__ ((warn_unused_result));
242
 
  int endTableScan();
 
257
  int ha_open(Table *table, const char *name, int mode, int test_if_locked);
 
258
  int ha_index_init(uint32_t idx, bool sorted);
 
259
  int ha_index_end();
 
260
  int ha_rnd_init(bool scan);
 
261
  int ha_rnd_end();
243
262
  int ha_reset();
244
263
 
245
264
  /* this is necessary in many places, e.g. in HANDLER command */
246
265
  int ha_index_or_rnd_end();
 
266
  Table_flags ha_table_flags() const;
247
267
 
248
268
  /**
249
269
    These functions represent the public interface to *users* of the
250
 
    Cursor class, hence they are *not* virtual. For the inheritance
251
 
    interface, see the (private) functions doInsertRecord(), doUpdateRecord(),
252
 
    and doDeleteRecord() below.
 
270
    handler class, hence they are *not* virtual. For the inheritance
 
271
    interface, see the (private) functions write_row(), update_row(),
 
272
    and delete_row() below.
253
273
  */
254
274
  int ha_external_lock(Session *session, int lock_type);
255
 
  int insertRecord(unsigned char * buf) __attribute__ ((warn_unused_result));
256
 
  int updateRecord(const unsigned char * old_data, unsigned char * new_data) __attribute__ ((warn_unused_result));
257
 
  int deleteRecord(const unsigned char * buf) __attribute__ ((warn_unused_result));
 
275
  int ha_write_row(unsigned char * buf);
 
276
  int ha_update_row(const unsigned char * old_data, unsigned char * new_data);
 
277
  int ha_delete_row(const unsigned char * buf);
258
278
  void ha_release_auto_increment();
259
279
 
 
280
  int ha_check_for_upgrade(HA_CHECK_OPT *check_opt);
260
281
  /** to be actually called to get 'check()' functionality*/
261
282
  int ha_check(Session *session, HA_CHECK_OPT *check_opt);
262
 
 
 
283
  int ha_repair(Session* session, HA_CHECK_OPT* check_opt);
263
284
  void ha_start_bulk_insert(ha_rows rows);
264
285
  int ha_end_bulk_insert();
 
286
  int ha_bulk_update_row(const unsigned char *old_data, unsigned char *new_data,
 
287
                         uint32_t *dup_key_found);
265
288
  int ha_delete_all_rows();
266
289
  int ha_reset_auto_increment(uint64_t value);
 
290
  int ha_optimize(Session* session, HA_CHECK_OPT* check_opt);
267
291
  int ha_analyze(Session* session, HA_CHECK_OPT* check_opt);
268
 
 
 
292
  bool ha_check_and_repair(Session *session);
269
293
  int ha_disable_indexes(uint32_t mode);
270
294
  int ha_enable_indexes(uint32_t mode);
271
295
  int ha_discard_or_import_tablespace(bool discard);
272
 
  void closeMarkForDelete(const char *name);
 
296
  void ha_prepare_for_alter();
 
297
  int ha_rename_table(const char *from, const char *to);
 
298
  int ha_delete_table(const char *name);
 
299
  void ha_drop_table(const char *name);
 
300
 
 
301
  int ha_create(const char *name, Table *form, HA_CREATE_INFO *info);
 
302
 
 
303
  int ha_create_handler_files(const char *name, const char *old_name,
 
304
                              int action_flag, HA_CREATE_INFO *info);
273
305
 
274
306
  void adjust_next_insert_id_after_explicit_value(uint64_t nr);
275
307
  int update_auto_increment();
 
308
  void print_keydup_error(uint32_t key_nr, const char *msg);
 
309
  virtual void print_error(int error, myf errflag);
 
310
  virtual bool get_error_message(int error, String *buf);
 
311
  uint32_t get_dup_key(int error);
 
312
  virtual void change_table_ptr(Table *table_arg, TABLE_SHARE *share);
276
313
 
277
314
  /* Estimates calculation */
278
315
  virtual double scan_time(void)
285
322
  virtual ha_rows multi_range_read_info_const(uint32_t keyno, RANGE_SEQ_IF *seq,
286
323
                                              void *seq_init_param,
287
324
                                              uint32_t n_ranges, uint32_t *bufsz,
288
 
                                              uint32_t *flags, optimizer::CostVector *cost);
 
325
                                              uint32_t *flags, COST_VECT *cost);
289
326
  virtual int multi_range_read_info(uint32_t keyno, uint32_t n_ranges, uint32_t keys,
290
 
                                    uint32_t *bufsz, uint32_t *flags, optimizer::CostVector *cost);
 
327
                                    uint32_t *bufsz, uint32_t *flags, COST_VECT *cost);
291
328
  virtual int multi_range_read_init(RANGE_SEQ_IF *seq, void *seq_init_param,
292
 
                                    uint32_t n_ranges, uint32_t mode);
 
329
                                    uint32_t n_ranges, uint32_t mode,
 
330
                                    HANDLER_BUFFER *buf);
293
331
  virtual int multi_range_read_next(char **range_info);
294
332
 
295
333
 
296
334
  virtual const key_map *keys_to_use_for_scanning();
297
335
  bool has_transactions();
 
336
  virtual uint32_t extra_rec_buf_length() const { return 0; }
298
337
 
299
338
  /**
300
339
    This method is used to analyse the error to see whether the error
301
340
    is ignorable or not, certain handlers can have more error that are
302
 
    ignorable than others. E.g. the partition Cursor can get inserts
 
341
    ignorable than others. E.g. the partition handler can get inserts
303
342
    into a range where there is no partition and this is an ignorable
304
343
    error.
305
344
    HA_ERR_FOUND_DUP_UNIQUE is a special case in MyISAM that means the
313
352
    (table_flags() & (HA_HAS_RECORDS | HA_STATS_RECORDS_IS_EXACT)) != 0
314
353
  */
315
354
  virtual ha_rows records();
316
 
  virtual uint64_t tableSize();
317
 
  virtual uint64_t rowSize();
318
355
  /**
319
356
    Return upper bound of current number of records in the table
320
357
    (max. of how many records one will retrieve when doing a full table scan)
324
361
  virtual ha_rows estimate_rows_upper_bound()
325
362
  { return stats.records+EXTRA_RECORDS; }
326
363
 
 
364
  /**
 
365
    Get the row type from the storage engine.  If this method returns
 
366
    ROW_TYPE_NOT_USED, the information in HA_CREATE_INFO should be used.
 
367
  */
 
368
  virtual enum row_type get_row_type() const { return ROW_TYPE_NOT_USED; }
 
369
 
327
370
  virtual const char *index_type(uint32_t)
328
371
  { assert(0); return "";}
329
372
 
330
373
 
 
374
  /**
 
375
    Signal that the table->read_set and table->write_set table maps changed
 
376
    The handler is allowed to set additional bits in the above map in this
 
377
    call. Normally the handler should ignore all calls until we have done
 
378
    a ha_rnd_init() or ha_index_init(), write_row(), update_row or delete_row()
 
379
    as there may be several calls to this routine.
 
380
  */
 
381
  virtual void column_bitmaps_signal();
331
382
  uint32_t get_index(void) const { return active_index; }
332
383
  virtual int close(void)=0;
333
384
 
334
385
  /**
 
386
    @retval  0   Bulk update used by handler
 
387
    @retval  1   Bulk update not used, normal operation used
 
388
  */
 
389
  virtual bool start_bulk_update() { return 1; }
 
390
  /**
 
391
    @retval  0   Bulk delete used by handler
 
392
    @retval  1   Bulk delete not used, normal operation used
 
393
  */
 
394
  virtual bool start_bulk_delete() { return 1; }
 
395
  /**
 
396
    After this call all outstanding updates must be performed. The number
 
397
    of duplicate key errors are reported in the duplicate key parameter.
 
398
    It is allowed to continue to the batched update after this call, the
 
399
    handler has to wait until end_bulk_update with changing state.
 
400
 
 
401
    @param    dup_key_found       Number of duplicate keys found
 
402
 
 
403
    @retval  0           Success
 
404
    @retval  >0          Error code
 
405
  */
 
406
  virtual int exec_bulk_update(uint32_t *)
 
407
  {
 
408
    assert(false);
 
409
    return HA_ERR_WRONG_COMMAND;
 
410
  }
 
411
  /**
 
412
    Perform any needed clean-up, no outstanding updates are there at the
 
413
    moment.
 
414
  */
 
415
  virtual void end_bulk_update() { return; }
 
416
  /**
 
417
    Execute all outstanding deletes and close down the bulk delete.
 
418
 
 
419
    @retval 0             Success
 
420
    @retval >0            Error code
 
421
  */
 
422
  virtual int end_bulk_delete()
 
423
  {
 
424
    assert(false);
 
425
    return HA_ERR_WRONG_COMMAND;
 
426
  }
 
427
  /**
335
428
     @brief
336
429
     Positions an index cursor to the index specified in the handle. Fetches the
337
430
     row if available. If the key value is null, begin at the first key of the
338
431
     index.
339
432
  */
340
 
  virtual int index_read_map(unsigned char * buf, const unsigned char *key,
 
433
  virtual int index_read_map(unsigned char * buf, const unsigned char * key,
341
434
                             key_part_map keypart_map,
342
435
                             enum ha_rkey_function find_flag)
343
436
  {
344
 
    uint32_t key_len= calculate_key_len(active_index, keypart_map);
 
437
    uint32_t key_len= calculate_key_len(table, active_index, key, keypart_map);
345
438
    return  index_read(buf, key, key_len, find_flag);
346
439
  }
347
440
  /**
354
447
                                 const unsigned char * key,
355
448
                                 key_part_map keypart_map,
356
449
                                 enum ha_rkey_function find_flag);
357
 
  virtual int index_next(unsigned char *) __attribute__ ((warn_unused_result))
 
450
  virtual int index_next(unsigned char *)
358
451
   { return  HA_ERR_WRONG_COMMAND; }
359
452
  virtual int index_prev(unsigned char *)
360
453
   { return  HA_ERR_WRONG_COMMAND; }
363
456
  virtual int index_last(unsigned char *)
364
457
   { return  HA_ERR_WRONG_COMMAND; }
365
458
  virtual int index_next_same(unsigned char *, const unsigned char *, uint32_t);
366
 
 
367
 
private:
368
 
  uint32_t calculate_key_len(uint32_t key_position, key_part_map keypart_map_arg);
369
 
public:
370
 
 
371
459
  /**
372
460
     @brief
373
461
     The following functions works like index_read, but it find the last
376
464
  virtual int index_read_last_map(unsigned char * buf, const unsigned char * key,
377
465
                                  key_part_map keypart_map)
378
466
  {
379
 
    uint32_t key_len= calculate_key_len(active_index, keypart_map);
 
467
    uint32_t key_len= calculate_key_len(table, active_index, key, keypart_map);
380
468
    return index_read_last(buf, key, key_len);
381
469
  }
382
470
  virtual int read_range_first(const key_range *start_key,
384
472
                               bool eq_range, bool sorted);
385
473
  virtual int read_range_next();
386
474
  int compare_key(key_range *range);
 
475
  int compare_key2(key_range *range);
387
476
  virtual int rnd_next(unsigned char *)=0;
388
477
  virtual int rnd_pos(unsigned char *, unsigned char *)=0;
 
478
  /**
 
479
    One has to use this method when to find
 
480
    random position by record as the plain
 
481
    position() call doesn't work for some
 
482
    handlers for random position.
 
483
  */
 
484
  virtual int rnd_pos_by_record(unsigned char *record);
389
485
  virtual int read_first_row(unsigned char *buf, uint32_t primary_key);
 
486
  /**
 
487
    The following function is only needed for tables that may be temporary
 
488
    tables during joins.
 
489
  */
 
490
  virtual int restart_rnd_next(unsigned char *, unsigned char *)
 
491
    { return HA_ERR_WRONG_COMMAND; }
390
492
  virtual int rnd_same(unsigned char *, uint32_t)
391
493
    { return HA_ERR_WRONG_COMMAND; }
392
494
  virtual ha_rows records_in_range(uint32_t, key_range *, key_range *)
393
495
    { return (ha_rows) 10; }
394
496
  virtual void position(const unsigned char *record)=0;
395
 
  virtual int info(uint32_t)=0; // see my_base.h for full description
 
497
  virtual int info(uint)=0; // see my_base.h for full description
396
498
  virtual uint32_t calculate_key_hash_value(Field **)
397
499
  { assert(0); return 0; }
398
500
  virtual int extra(enum ha_extra_function)
421
523
  */
422
524
  virtual void try_semi_consistent_read(bool) {}
423
525
  virtual void unlock_row(void) {}
 
526
  virtual int start_stmt(Session *, thr_lock_type)
 
527
  {return 0;}
424
528
  virtual void get_auto_increment(uint64_t offset, uint64_t increment,
425
529
                                  uint64_t nb_desired_values,
426
530
                                  uint64_t *first_value,
427
 
                                  uint64_t *nb_reserved_values)= 0;
428
 
 
 
531
                                  uint64_t *nb_reserved_values);
429
532
  void set_next_insert_id(uint64_t id)
430
533
  {
431
534
    next_insert_id= id;
446
549
      insert_id_for_cur_row;
447
550
  }
448
551
 
 
552
  virtual void update_create_info(HA_CREATE_INFO *) {}
 
553
  int check_old_types(void);
 
554
  virtual int assign_to_keycache(Session*, HA_CHECK_OPT *)
 
555
  { return HA_ADMIN_NOT_IMPLEMENTED; }
449
556
  /* end of the list of admin commands */
450
557
 
451
558
  virtual int indexes_are_disabled(void) {return 0;}
 
559
  virtual char *update_table_comment(const char * comment)
 
560
  { return (char*) comment;}
452
561
  virtual void append_create_info(String *)
453
562
  {}
454
563
  /**
461
570
    @retval   true            Foreign key defined on table or index
462
571
    @retval   false           No foreign key defined
463
572
  */
 
573
  virtual bool is_fk_defined_on_table_or_index(uint32_t)
 
574
  { return false; }
464
575
  virtual char* get_foreign_key_create_info(void)
465
 
  { return NULL;}  /* gets foreign key create string from InnoDB */
466
 
  /** used in ALTER Table; if changing storage engine is allowed.
467
 
      e.g. not be allowed if table has foreign key constraints in engine.
468
 
   */
469
 
  virtual bool can_switch_engines(void) { return true; }
 
576
  { return(NULL);}  /* gets foreign key create string from InnoDB */
 
577
  /** used in ALTER Table; 1 if changing storage engine is allowed */
 
578
  virtual bool can_switch_engines(void) { return 1; }
470
579
  /** used in REPLACE; is > 0 if table is referred by a FOREIGN KEY */
471
 
  virtual int get_foreign_key_list(Session *, List<ForeignKeyInfo> *)
 
580
  virtual int get_foreign_key_list(Session *, List<FOREIGN_KEY_INFO> *)
472
581
  { return 0; }
473
582
  virtual uint32_t referenced_by_foreign_key() { return 0;}
 
583
  virtual void init_table_handle_for_HANDLER()
 
584
  { return; }       /* prepare InnoDB for HANDLER */
474
585
  virtual void free_foreign_key_create_info(char *) {}
475
 
 
 
586
  /** The following can be called without an open handler */
 
587
  virtual const char *table_type() const =0;
 
588
  /**
 
589
    If frm_error() is called then we will use this to find out what file
 
590
    extentions exist for the storage engine. This is also used by the default
 
591
    rename_table and delete_table method in handler.cc.
 
592
 
 
593
    For engines that have two file name extentions (separate meta/index file
 
594
    and data file), the order of elements is relevant. First element of engine
 
595
    file name extentions array should be meta/index file extention. Second
 
596
    element - data file extention. This order is assumed by
 
597
    prepare_for_repair() when REPAIR Table ... USE_FRM is issued.
 
598
  */
 
599
  virtual const char **bas_ext() const =0;
 
600
 
 
601
  virtual int get_default_no_partitions(HA_CREATE_INFO *) { return 1;}
 
602
  virtual bool get_no_parts(const char *, uint32_t *no_parts)
 
603
  {
 
604
    *no_parts= 0;
 
605
    return 0;
 
606
  }
 
607
 
 
608
  virtual uint32_t index_flags(uint32_t idx, uint32_t part, bool all_parts) const =0;
 
609
 
 
610
  virtual int add_index(Table *, KEY *, uint32_t)
 
611
  { return (HA_ERR_WRONG_COMMAND); }
 
612
  virtual int prepare_drop_index(Table *, uint32_t *, uint32_t)
 
613
  { return (HA_ERR_WRONG_COMMAND); }
 
614
  virtual int final_drop_index(Table *)
 
615
  { return (HA_ERR_WRONG_COMMAND); }
 
616
 
 
617
  uint32_t max_record_length() const
 
618
  { return cmin((unsigned int)HA_MAX_REC_LENGTH, max_supported_record_length()); }
 
619
  uint32_t max_keys() const
 
620
  { return cmin((unsigned int)MAX_KEY, max_supported_keys()); }
 
621
  uint32_t max_key_parts() const
 
622
  { return cmin((unsigned int)MAX_REF_PARTS, max_supported_key_parts()); }
 
623
  uint32_t max_key_length() const
 
624
  { return cmin((unsigned int)MAX_KEY_LENGTH, max_supported_key_length()); }
 
625
  uint32_t max_key_part_length(void) const
 
626
  { return cmin((unsigned int)MAX_KEY_LENGTH, max_supported_key_part_length()); }
 
627
 
 
628
  virtual uint32_t max_supported_record_length(void) const
 
629
  { return HA_MAX_REC_LENGTH; }
 
630
  virtual uint32_t max_supported_keys(void) const { return 0; }
 
631
  virtual uint32_t max_supported_key_parts(void) const { return MAX_REF_PARTS; }
 
632
  virtual uint32_t max_supported_key_length(void) const { return MAX_KEY_LENGTH; }
 
633
  virtual uint32_t max_supported_key_part_length(void) const { return 255; }
 
634
  virtual uint32_t min_record_length(uint32_t) const
 
635
  { return 1; }
 
636
 
 
637
  virtual bool low_byte_first(void) const { return 1; }
 
638
  virtual uint32_t checksum(void) const { return 0; }
 
639
  virtual bool is_crashed(void) const  { return 0; }
 
640
  virtual bool auto_repair(void) const { return 0; }
 
641
 
 
642
 
 
643
#define CHF_CREATE_FLAG 0
 
644
#define CHF_DELETE_FLAG 1
 
645
#define CHF_RENAME_FLAG 2
 
646
 
 
647
 
 
648
  /**
 
649
    @note lock_count() can return > 1 if the table is MERGE or partitioned.
 
650
  */
 
651
  virtual uint32_t lock_count(void) const { return 1; }
476
652
  /**
477
653
    Is not invoked for non-transactional temporary tables.
478
654
 
480
656
    or partitioned.
481
657
 
482
658
    @note that one can NOT rely on table->in_use in store_lock().  It may
483
 
    refer to a different thread if called from abortLockForThread().
 
659
    refer to a different thread if called from mysql_lock_abort_for_thread().
484
660
 
485
661
    @note If the table is MERGE, store_lock() can return less locks
486
662
    than lock_count() claimed. This can happen when the MERGE children
487
663
    are not attached when this is called from another thread.
488
664
  */
489
 
  virtual THR_LOCK_DATA **store_lock(Session *,
 
665
  virtual THR_LOCK_DATA **store_lock(Session *session,
490
666
                                     THR_LOCK_DATA **to,
491
 
                                     enum thr_lock_type)
492
 
  {
493
 
    assert(0); // Impossible programming situation
494
 
 
495
 
    return(to);
496
 
  }
 
667
                                     enum thr_lock_type lock_type)=0;
 
668
 
 
669
  /** Type of table for caching query */
 
670
  virtual uint8_t table_cache_type() { return HA_CACHE_TBL_NONTRANSACT; }
 
671
 
497
672
 
498
673
 /*
499
674
   @retval true   Primary key (if there is one) is clustered
506
681
   return memcmp(ref1, ref2, ref_length);
507
682
 }
508
683
 
509
 
  virtual bool isOrdered(void)
 
684
 /*
 
685
   Condition pushdown to storage engines
 
686
 */
 
687
 
 
688
 /**
 
689
   Push condition down to the table handler.
 
690
 
 
691
   @param  cond   Condition to be pushed. The condition tree must not be
 
692
                  modified by the by the caller.
 
693
 
 
694
   @return
 
695
     The 'remainder' condition that caller must use to filter out records.
 
696
     NULL means the handler will not return rows that do not match the
 
697
     passed condition.
 
698
 
 
699
   @note
 
700
   The pushed conditions form a stack (from which one can remove the
 
701
   last pushed condition using cond_pop).
 
702
   The table handler filters out rows using (pushed_cond1 AND pushed_cond2
 
703
   AND ... AND pushed_condN)
 
704
   or less restrictive condition, depending on handler's capabilities.
 
705
 
 
706
   handler->ha_reset() call empties the condition stack.
 
707
   Calls to rnd_init/rnd_end, index_init/index_end etc do not affect the
 
708
   condition stack.
 
709
 */
 
710
 virtual const COND *cond_push(const COND *cond) { return cond; }
 
711
 
 
712
 /**
 
713
   Pop the top condition from the condition stack of the handler instance.
 
714
 
 
715
   Pops the top if condition stack, if stack is not empty.
 
716
 */
 
717
 virtual void cond_pop(void) { return; }
 
718
 
 
719
 virtual Item *idx_cond_push(uint32_t, Item *idx_cond)
 
720
 { return idx_cond; }
 
721
 
 
722
 /*
 
723
    Part of old fast alter table, to be depricated
 
724
  */
 
725
 virtual bool
 
726
   check_if_incompatible_data(HA_CREATE_INFO *, uint32_t)
 
727
 { return COMPATIBLE_DATA_NO; }
 
728
 
 
729
 /* On-line ALTER Table interface */
 
730
 
 
731
 /**
 
732
    Check if a storage engine supports a particular alter table on-line
 
733
 
 
734
    @param    altered_table     A temporary table show what table is to
 
735
                                change to
 
736
    @param    create_info       Information from the parsing phase about new
 
737
                                table properties.
 
738
    @param    alter_flags       Bitmask that shows what will be changed
 
739
    @param    table_changes     Shows if table layout has changed (for
 
740
                                backwards compatibility with
 
741
                                check_if_incompatible_data
 
742
 
 
743
    @retval   HA_ALTER_ERROR                Unexpected error
 
744
    @retval   HA_ALTER_SUPPORTED_WAIT_LOCK  Supported, but requires DDL lock
 
745
    @retval   HA_ALTER_SUPPORTED_NO_LOCK    Supported
 
746
    @retval   HA_ALTER_NOT_SUPPORTED        Not supported
 
747
 
 
748
    @note
 
749
      The default implementation is implemented to support fast
 
750
      alter table (storage engines that support some changes by
 
751
      just changing the frm file) without any change in the handler
 
752
      implementation.
 
753
 */
 
754
 virtual int check_if_supported_alter(Table *, HA_CREATE_INFO *create_info,
 
755
                                      HA_ALTER_FLAGS * alter_flags, uint32_t table_changes)
 
756
 {
 
757
   if (this->check_if_incompatible_data(create_info, table_changes)
 
758
       == COMPATIBLE_DATA_NO)
 
759
     return(HA_ALTER_NOT_SUPPORTED);
 
760
   else if ((*alter_flags & HA_ALTER_STORED_VCOL).is_set())
 
761
     return(HA_ALTER_NOT_SUPPORTED);
 
762
   else
 
763
     return(HA_ALTER_SUPPORTED_WAIT_LOCK);
 
764
 }
 
765
 /**
 
766
   Tell storage engine to prepare for the on-line alter table (pre-alter)
 
767
 
 
768
   @param     session               The thread handle
 
769
   @param     altered_table     A temporary table show what table is to
 
770
                                change to
 
771
   @param     alter_info        Storage place for data used during phase1
 
772
                                and phase2
 
773
   @param     alter_flags       Bitmask that shows what will be changed
 
774
 
 
775
   @retval   0      OK
 
776
   @retval   error  error code passed from storage engine
 
777
 */
 
778
 virtual int alter_table_phase1(Session *, Table *, HA_CREATE_INFO *, HA_ALTER_INFO *,
 
779
                                HA_ALTER_FLAGS *)
 
780
 {
 
781
   return HA_ERR_UNSUPPORTED;
 
782
 }
 
783
 /**
 
784
    Tell storage engine to perform the on-line alter table (alter)
 
785
 
 
786
    @param    session               The thread handle
 
787
    @param    altered_table     A temporary table show what table is to
 
788
                                change to
 
789
    @param    alter_info        Storage place for data used during phase1
 
790
                                and phase2
 
791
    @param    alter_flags       Bitmask that shows what will be changed
 
792
 
 
793
    @retval  0      OK
 
794
    @retval  error  error code passed from storage engine
 
795
 
 
796
    @note
 
797
      If check_if_supported_alter returns HA_ALTER_SUPPORTED_WAIT_LOCK
 
798
      this call is to be wrapped with a DDL lock. This is currently NOT
 
799
      supported.
 
800
 */
 
801
 virtual int alter_table_phase2(Session *, Table *, HA_CREATE_INFO *, HA_ALTER_INFO *,
 
802
                                HA_ALTER_FLAGS *)
 
803
 {
 
804
   return HA_ERR_UNSUPPORTED;
 
805
 }
 
806
 /**
 
807
    Tell storage engine that changed frm file is now on disk and table
 
808
    has been re-opened (post-alter)
 
809
 
 
810
    @param    session               The thread handle
 
811
    @param    table             The altered table, re-opened
 
812
 */
 
813
 virtual int alter_table_phase3(Session *, Table *)
 
814
 {
 
815
   return HA_ERR_UNSUPPORTED;
 
816
 }
 
817
 
 
818
  /**
 
819
    use_hidden_primary_key() is called in case of an update/delete when
 
820
    (table_flags() and HA_PRIMARY_KEY_REQUIRED_FOR_DELETE) is defined
 
821
    but we don't have a primary key
 
822
  */
 
823
  virtual void use_hidden_primary_key();
 
824
 
 
825
  /**
 
826
    Lock table.
 
827
 
 
828
    @param    session                     Thread handle
 
829
    @param    lock_type               HA_LOCK_IN_SHARE_MODE     (F_RDLCK)
 
830
                                      HA_LOCK_IN_EXCLUSIVE_MODE (F_WRLCK)
 
831
    @param    lock_timeout            -1 default timeout
 
832
                                      0  no wait
 
833
                                      >0 wait timeout in milliseconds.
 
834
 
 
835
   @note
 
836
      lock_timeout >0 is not used by MySQL currently. If the storage
 
837
      engine does not support NOWAIT (lock_timeout == 0) it should
 
838
      return an error. But if it does not support WAIT X (lock_timeout
 
839
      >0) it should treat it as lock_timeout == -1 and wait a default
 
840
      (or even hard-coded) timeout.
 
841
 
 
842
    @retval HA_ERR_WRONG_COMMAND      Storage engine does not support
 
843
                                      lock_table()
 
844
    @retval HA_ERR_UNSUPPORTED        Storage engine does not support NOWAIT
 
845
    @retval HA_ERR_LOCK_WAIT_TIMEOUT  Lock request timed out or
 
846
                                      lock conflict with NOWAIT option
 
847
    @retval HA_ERR_LOCK_DEADLOCK      Deadlock detected
 
848
  */
 
849
  virtual int lock_table(Session *, int, int)
510
850
  {
511
 
    return false;
 
851
    return HA_ERR_WRONG_COMMAND;
512
852
  }
513
 
 
 
853
  /*
 
854
    This procedure defines if the storage engine supports virtual columns.
 
855
    Default false means "not supported".
 
856
  */
 
857
  virtual bool check_if_supported_virtual_columns(void)
 
858
  { return false; }
514
859
 
515
860
protected:
516
861
  /* Service methods for use by storage engines. */
517
 
  void ha_statistic_increment(uint64_t system_status_var::*offset) const;
 
862
  void ha_statistic_increment(ulong SSV::*offset) const;
518
863
  void **ha_data(Session *) const;
 
864
  Session *ha_session(void) const;
 
865
 
 
866
  /**
 
867
    Default rename_table() and delete_table() rename/delete files with a
 
868
    given name and extensions from bas_ext().
 
869
 
 
870
    These methods can be overridden, but their default implementation
 
871
    provide useful functionality.
 
872
  */
 
873
  virtual int rename_table(const char *from, const char *to);
 
874
  /**
 
875
    Delete a table in the engine. Called for base as well as temporary
 
876
    tables.
 
877
  */
 
878
  virtual int delete_table(const char *name);
519
879
 
520
880
private:
521
881
  /* Private helpers */
522
 
  inline void setTransactionReadWrite();
 
882
  inline void mark_trx_read_write();
523
883
private:
524
884
  /*
525
885
    Low-level primitives for storage engines.  These should be
527
887
    the corresponding 'ha_*' method above.
528
888
  */
529
889
 
530
 
  virtual int open(const char *, int , uint32_t ) { assert(0); return -1; }
531
 
  virtual int doOpen(const identifier::Table &identifier, int mode, uint32_t test_if_locked);
532
 
  virtual int doStartIndexScan(uint32_t idx, bool)
 
890
  virtual int open(const char *name, int mode, uint32_t test_if_locked)=0;
 
891
  virtual int index_init(uint32_t idx, bool)
533
892
  { active_index= idx; return 0; }
534
 
  virtual int doEndIndexScan() { active_index= MAX_KEY; return 0; }
 
893
  virtual int index_end() { active_index= MAX_KEY; return 0; }
535
894
  /**
536
 
    doStartTableScan() can be called two times without doEndTableScan() in between
 
895
    rnd_init() can be called two times without rnd_end() in between
537
896
    (it only makes sense if scan=1).
538
897
    then the second call should prepare for the new table scan (e.g
539
898
    if rnd_init allocates the cursor, second call should position it
540
899
    to the start of the table, no need to deallocate and allocate it again
541
900
  */
542
 
  virtual int doStartTableScan(bool scan) __attribute__ ((warn_unused_result)) = 0;
543
 
  virtual int doEndTableScan() { return 0; }
544
 
  virtual int doInsertRecord(unsigned char *)
545
 
  {
546
 
    return HA_ERR_WRONG_COMMAND;
547
 
  }
548
 
 
549
 
  virtual int doUpdateRecord(const unsigned char *, unsigned char *)
550
 
  {
551
 
    return HA_ERR_WRONG_COMMAND;
552
 
  }
553
 
 
554
 
  virtual int doDeleteRecord(const unsigned char *)
 
901
  virtual int rnd_init(bool scan)= 0;
 
902
  virtual int rnd_end() { return 0; }
 
903
  virtual int write_row(unsigned char *)
 
904
  {
 
905
    return HA_ERR_WRONG_COMMAND;
 
906
  }
 
907
 
 
908
  virtual int update_row(const unsigned char *, unsigned char *)
 
909
  {
 
910
    return HA_ERR_WRONG_COMMAND;
 
911
  }
 
912
 
 
913
  virtual int delete_row(const unsigned char *)
555
914
  {
556
915
    return HA_ERR_WRONG_COMMAND;
557
916
  }
561
920
    by that statement.
562
921
  */
563
922
  virtual int reset() { return 0; }
 
923
  virtual Table_flags table_flags(void) const= 0;
564
924
 
565
925
  /**
566
926
    Is not invoked for non-transactional temporary tables.
567
927
 
568
928
    Tells the storage engine that we intend to read or write data
569
 
    from the table. This call is prefixed with a call to Cursor::store_lock()
570
 
    and is invoked only for those Cursor instances that stored the lock.
 
929
    from the table. This call is prefixed with a call to handler::store_lock()
 
930
    and is invoked only for those handler instances that stored the lock.
571
931
 
572
932
    Calls to rnd_init/index_init are prefixed with this call. When table
573
933
    IO is complete, we call external_lock(F_UNLCK).
588
948
  {
589
949
    return 0;
590
950
  }
591
 
  virtual void release_auto_increment(void) { return; }
 
951
  virtual void release_auto_increment(void) { return; };
592
952
  /** admin commands - called from mysql_admin_table */
593
 
  virtual int check(Session *)
 
953
  virtual int check_for_upgrade(HA_CHECK_OPT *)
 
954
  { return 0; }
 
955
  virtual int check(Session *, HA_CHECK_OPT *)
594
956
  { return HA_ADMIN_NOT_IMPLEMENTED; }
595
957
 
 
958
  /**
 
959
     In this method check_opt can be modified
 
960
     to specify CHECK option to use to call check()
 
961
     upon the table.
 
962
  */
 
963
  virtual int repair(Session *, HA_CHECK_OPT *)
 
964
  { return HA_ADMIN_NOT_IMPLEMENTED; }
596
965
  virtual void start_bulk_insert(ha_rows)
597
966
  {}
598
967
  virtual int end_bulk_insert(void) { return 0; }
600
969
                         uint32_t, enum ha_rkey_function)
601
970
   { return  HA_ERR_WRONG_COMMAND; }
602
971
  virtual int index_read_last(unsigned char *, const unsigned char *, uint32_t)
603
 
   { return (errno= HA_ERR_WRONG_COMMAND); }
 
972
   { return (my_errno= HA_ERR_WRONG_COMMAND); }
 
973
  /**
 
974
    This method is similar to update_row, however the handler doesn't need
 
975
    to execute the updates at this point in time. The handler can be certain
 
976
    that another call to bulk_update_row will occur OR a call to
 
977
    exec_bulk_update before the set of updates in this query is concluded.
 
978
 
 
979
    @param    old_data       Old record
 
980
    @param    new_data       New record
 
981
    @param    dup_key_found  Number of duplicate keys found
 
982
 
 
983
    @retval  0   Bulk delete used by handler
 
984
    @retval  1   Bulk delete not used, normal operation used
 
985
  */
 
986
  virtual int bulk_update_row(const unsigned char *, unsigned char *, uint32_t *)
 
987
  {
 
988
    assert(false);
 
989
    return HA_ERR_WRONG_COMMAND;
 
990
  }
604
991
  /**
605
992
    This is called to delete all rows in a table
606
 
    If the Cursor don't support this, then this function will
 
993
    If the handler don't support this, then this function will
607
994
    return HA_ERR_WRONG_COMMAND and MySQL will delete the rows one
608
995
    by one.
609
996
  */
610
997
  virtual int delete_all_rows(void)
611
 
  { return (errno=HA_ERR_WRONG_COMMAND); }
 
998
  { return (my_errno=HA_ERR_WRONG_COMMAND); }
612
999
  /**
613
1000
    Reset the auto-increment counter to the given value, i.e. the next row
614
1001
    inserted will get the given value. This is called e.g. after TRUNCATE
617
1004
  */
618
1005
  virtual int reset_auto_increment(uint64_t)
619
1006
  { return HA_ERR_WRONG_COMMAND; }
620
 
 
621
 
  virtual int analyze(Session *)
622
 
  { return HA_ADMIN_NOT_IMPLEMENTED; }
623
 
 
 
1007
  virtual int optimize(Session *, HA_CHECK_OPT *)
 
1008
  { return HA_ADMIN_NOT_IMPLEMENTED; }
 
1009
  virtual int analyze(Session *, HA_CHECK_OPT *)
 
1010
  { return HA_ADMIN_NOT_IMPLEMENTED; }
 
1011
  virtual bool check_and_repair(Session *)
 
1012
  { return true; }
624
1013
  virtual int disable_indexes(uint32_t)
625
1014
  { return HA_ERR_WRONG_COMMAND; }
626
 
 
627
1015
  virtual int enable_indexes(uint32_t)
628
1016
  { return HA_ERR_WRONG_COMMAND; }
629
 
 
630
1017
  virtual int discard_or_import_tablespace(bool)
631
 
  { return (errno=HA_ERR_WRONG_COMMAND); }
632
 
 
633
 
  /* 
634
 
    @todo this is just for the HEAP engine, it should
635
 
    be removed at some point in the future (and
636
 
    no new engine should ever use it). Right
637
 
    now HEAP does rely on it, so we cannot remove it.
638
 
  */
 
1018
  { return (my_errno=HA_ERR_WRONG_COMMAND); }
 
1019
  virtual void prepare_for_alter(void) { return; }
639
1020
  virtual void drop_table(const char *name);
 
1021
  virtual int create(const char *, Table *, HA_CREATE_INFO *)=0;
 
1022
 
 
1023
  virtual int create_handler_files(const char *, const char *, int, HA_CREATE_INFO *)
 
1024
  { return false; }
 
1025
};
 
1026
 
 
1027
 
 
1028
 
 
1029
/**
 
1030
  A Disk-Sweep MRR interface implementation
 
1031
 
 
1032
  This implementation makes range (and, in the future, 'ref') scans to read
 
1033
  table rows in disk sweeps.
 
1034
 
 
1035
  Currently it is used by MyISAM and InnoDB. Potentially it can be used with
 
1036
  any table handler that has non-clustered indexes and on-disk rows.
 
1037
*/
 
1038
 
 
1039
class DsMrr_impl
 
1040
{
 
1041
public:
 
1042
  typedef void (handler::*range_check_toggle_func_t)(bool on);
 
1043
 
 
1044
  DsMrr_impl()
 
1045
    : h2(NULL) {};
 
1046
 
 
1047
  handler *h; /* The "owner" handler object. It is used for scanning the index */
 
1048
  Table *table; /* Always equal to h->table */
 
1049
private:
 
1050
  /*
 
1051
    Secondary handler object. It is used to retrieve full table rows by
 
1052
    calling rnd_pos().
 
1053
  */
 
1054
  handler *h2;
 
1055
 
 
1056
  /* Buffer to store rowids, or (rowid, range_id) pairs */
 
1057
  unsigned char *rowids_buf;
 
1058
  unsigned char *rowids_buf_cur;   /* Current position when reading/writing */
 
1059
  unsigned char *rowids_buf_last;  /* When reading: end of used buffer space */
 
1060
  unsigned char *rowids_buf_end;   /* End of the buffer */
 
1061
 
 
1062
  bool dsmrr_eof; /* true <=> We have reached EOF when reading index tuples */
 
1063
 
 
1064
  /* true <=> need range association, buffer holds {rowid, range_id} pairs */
 
1065
  bool is_mrr_assoc;
 
1066
 
 
1067
  bool use_default_impl; /* true <=> shortcut all calls to default MRR impl */
 
1068
public:
 
1069
  void init(handler *h_arg, Table *table_arg)
 
1070
  {
 
1071
    h= h_arg;
 
1072
    table= table_arg;
 
1073
  }
 
1074
  int dsmrr_init(handler *h, KEY *key, RANGE_SEQ_IF *seq_funcs,
 
1075
                 void *seq_init_param, uint32_t n_ranges, uint32_t mode,
 
1076
                 HANDLER_BUFFER *buf);
 
1077
  void dsmrr_close();
 
1078
  int dsmrr_fill_buffer(handler *h);
 
1079
  int dsmrr_next(handler *h, char **range_info);
 
1080
 
 
1081
  int dsmrr_info(uint32_t keyno, uint32_t n_ranges, uint32_t keys, uint32_t *bufsz,
 
1082
                 uint32_t *flags, COST_VECT *cost);
 
1083
 
 
1084
  ha_rows dsmrr_info_const(uint32_t keyno, RANGE_SEQ_IF *seq,
 
1085
                            void *seq_init_param, uint32_t n_ranges, uint32_t *bufsz,
 
1086
                            uint32_t *flags, COST_VECT *cost);
 
1087
private:
 
1088
  bool key_uses_partial_cols(uint32_t keyno);
 
1089
  bool choose_mrr_impl(uint32_t keyno, ha_rows rows, uint32_t *flags, uint32_t *bufsz,
 
1090
                       COST_VECT *cost);
 
1091
  bool get_disk_sweep_mrr_cost(uint32_t keynr, ha_rows rows, uint32_t flags,
 
1092
                               uint32_t *buffer_size, COST_VECT *cost);
640
1093
};
641
1094
 
642
1095
extern const char *ha_row_type[];
 
1096
extern const char *tx_isolation_names[];
 
1097
extern const char *binlog_format_names[];
 
1098
extern TYPELIB tx_isolation_typelib;
 
1099
extern TYPELIB myisam_stats_method_typelib;
 
1100
extern uint32_t total_ha, total_ha_2pc;
 
1101
 
 
1102
       /* Wrapper functions */
 
1103
#define ha_commit(session) (ha_commit_trans((session), true))
 
1104
#define ha_rollback(session) (ha_rollback_trans((session), true))
643
1105
 
644
1106
/* basic stuff */
645
 
void ha_init_errors(void);
646
 
 
647
 
class SortField;
648
 
SortField *make_unireg_sortorder(Order *order, uint32_t *length,
649
 
                                 SortField *sortorder);
 
1107
int ha_init_errors(void);
 
1108
int ha_init(void);
 
1109
int ha_end(void);
 
1110
int ha_initialize_handlerton(st_plugin_int *plugin);
 
1111
int ha_finalize_handlerton(st_plugin_int *plugin);
 
1112
 
 
1113
TYPELIB *ha_known_exts(void);
 
1114
void ha_close_connection(Session* session);
 
1115
bool ha_flush_logs(handlerton *db_type);
 
1116
void ha_drop_database(char* path);
 
1117
int ha_create_table(Session *session, const char *path,
 
1118
                    const char *db, const char *table_name,
 
1119
                    HA_CREATE_INFO *create_info,
 
1120
                    bool update_create_info);
 
1121
int ha_delete_table(Session *session, const char *path,
 
1122
                    const char *db, const char *alias, bool generate_warning);
 
1123
 
 
1124
/* statistics and info */
 
1125
bool ha_show_status(Session *session, handlerton *db_type, enum ha_stat_type stat);
 
1126
 
 
1127
int ha_find_files(Session *session,const char *db,const char *path,
 
1128
                  const char *wild, bool dir, List<LEX_STRING>* files);
 
1129
int ha_table_exists_in_engine(Session* session, const char* db, const char* name, handlerton **hton= NULL);
 
1130
 
 
1131
/* key cache */
 
1132
extern "C" int ha_init_key_cache(const char *name, KEY_CACHE *key_cache);
 
1133
int ha_resize_key_cache(KEY_CACHE *key_cache);
 
1134
int ha_change_key_cache_param(KEY_CACHE *key_cache);
 
1135
int ha_change_key_cache(KEY_CACHE *old_key_cache, KEY_CACHE *new_key_cache);
 
1136
int ha_end_key_cache(KEY_CACHE *key_cache);
 
1137
 
 
1138
/* report to InnoDB that control passes to the client */
 
1139
int ha_release_temporary_latches(Session *session);
 
1140
 
 
1141
/* transactions: interface to handlerton functions */
 
1142
int ha_start_consistent_snapshot(Session *session);
 
1143
int ha_commit_or_rollback_by_xid(XID *xid, bool commit);
 
1144
int ha_commit_one_phase(Session *session, bool all);
 
1145
int ha_rollback_trans(Session *session, bool all);
 
1146
int ha_prepare(Session *session);
 
1147
int ha_recover(HASH *commit_list);
 
1148
 
 
1149
/* transactions: these functions never call handlerton functions directly */
 
1150
int ha_commit_trans(Session *session, bool all);
 
1151
int ha_autocommit_or_rollback(Session *session, int error);
 
1152
int ha_enable_transaction(Session *session, bool on);
 
1153
 
 
1154
/* savepoints */
 
1155
int ha_rollback_to_savepoint(Session *session, SAVEPOINT *sv);
 
1156
int ha_savepoint(Session *session, SAVEPOINT *sv);
 
1157
int ha_release_savepoint(Session *session, SAVEPOINT *sv);
 
1158
 
 
1159
/* these are called by storage engines */
 
1160
void trans_register_ha(Session *session, bool all, handlerton *ht);
 
1161
 
 
1162
void table_case_convert(char * name, uint32_t length);
 
1163
const char *table_case_name(HA_CREATE_INFO *info, const char *name);
 
1164
 
 
1165
extern char reg_ext[FN_EXTLEN];
 
1166
extern uint32_t reg_ext_length;
 
1167
extern ulong specialflag;
 
1168
extern uint32_t lower_case_table_names;
 
1169
uint32_t filename_to_tablename(const char *from, char *to, uint32_t to_length);
 
1170
uint32_t tablename_to_filename(const char *from, char *to, uint32_t to_length);
 
1171
 
 
1172
 
 
1173
bool mysql_ha_open(Session *session, TableList *tables, bool reopen);
 
1174
bool mysql_ha_close(Session *session, TableList *tables);
 
1175
bool mysql_ha_read(Session *, TableList *,enum enum_ha_read_modes,char *,
 
1176
                   List<Item> *,enum ha_rkey_function,Item *,ha_rows,ha_rows);
 
1177
void mysql_ha_flush(Session *session);
 
1178
void mysql_ha_rm_tables(Session *session, TableList *tables, bool is_locked);
 
1179
void mysql_ha_cleanup(Session *session);
 
1180
 
 
1181
/*
 
1182
  Storage engine has to assume the transaction will end up with 2pc if
 
1183
   - there is more than one 2pc-capable storage engine available
 
1184
   - in the current transaction 2pc was not disabled yet
 
1185
*/
 
1186
#define trans_need_2pc(session, all)                   ((total_ha_2pc > 1) && \
 
1187
        !((all ? &session->transaction.all : &session->transaction.stmt)->no_2pc))
 
1188
 
 
1189
 
 
1190
bool mysql_xa_recover(Session *session);
 
1191
 
 
1192
SORT_FIELD * make_unireg_sortorder(order_st *order, uint32_t *length,
 
1193
                                   SORT_FIELD *sortorder);
650
1194
int setup_order(Session *session, Item **ref_pointer_array, TableList *tables,
651
 
                List<Item> &fields, List <Item> &all_fields, Order *order);
 
1195
                List<Item> &fields, List <Item> &all_fields, order_st *order);
652
1196
int setup_group(Session *session, Item **ref_pointer_array, TableList *tables,
653
 
                List<Item> &fields, List<Item> &all_fields, Order *order,
 
1197
                List<Item> &fields, List<Item> &all_fields, order_st *order,
654
1198
                bool *hidden_group_fields);
655
 
bool fix_inner_refs(Session *session, List<Item> &all_fields, Select_Lex *select,
 
1199
bool fix_inner_refs(Session *session, List<Item> &all_fields, SELECT_LEX *select,
656
1200
                    Item **ref_pointer_array);
657
1201
 
658
1202
bool handle_select(Session *session, LEX *lex, select_result *result,
659
 
                   uint64_t setup_tables_done_option);
660
 
void free_underlaid_joins(Session *session, Select_Lex *select);
661
 
 
662
 
bool handle_derived(LEX *lex, bool (*processor)(Session *session,
 
1203
                   ulong setup_tables_done_option);
 
1204
bool mysql_select(Session *session, Item ***rref_pointer_array,
 
1205
                  TableList *tables, uint32_t wild_num,  List<Item> &list,
 
1206
                  COND *conds, uint32_t og_num, order_st *order, order_st *group,
 
1207
                  Item *having, order_st *proc_param, uint64_t select_type,
 
1208
                  select_result *result, SELECT_LEX_UNIT *unit,
 
1209
                  SELECT_LEX *select_lex);
 
1210
void free_underlaid_joins(Session *session, SELECT_LEX *select);
 
1211
bool mysql_explain_union(Session *session, SELECT_LEX_UNIT *unit,
 
1212
                         select_result *result);
 
1213
int mysql_explain_select(Session *session, SELECT_LEX *sl, char const *type,
 
1214
                         select_result *result);
 
1215
bool mysql_union(Session *session, LEX *lex, select_result *result,
 
1216
                 SELECT_LEX_UNIT *unit, ulong setup_tables_done_option);
 
1217
bool mysql_handle_derived(LEX *lex, bool (*processor)(Session *session,
663
1218
                                                      LEX *lex,
664
1219
                                                      TableList *table));
665
 
bool derived_prepare(Session *session, LEX *lex, TableList *t);
666
 
bool derived_filling(Session *session, LEX *lex, TableList *t);
667
 
int prepare_create_field(CreateField *sql_field,
 
1220
bool mysql_derived_prepare(Session *session, LEX *lex, TableList *t);
 
1221
bool mysql_derived_filling(Session *session, LEX *lex, TableList *t);
 
1222
void sp_prepare_create_field(Session *session, Create_field *sql_field);
 
1223
int prepare_create_field(Create_field *sql_field,
668
1224
                         uint32_t *blob_columns,
669
 
                         int *timestamps, int *timestamps_with_niladic);
670
 
 
671
 
bool create_table(Session *session,
672
 
                  const identifier::Table &identifier,
673
 
                  HA_CREATE_INFO *create_info,
674
 
                  message::Table &table_proto,
675
 
                  AlterInfo *alter_info,
676
 
                  bool tmp_table, uint32_t select_field_count,
677
 
                  bool is_if_not_exists);
678
 
 
679
 
bool create_table_no_lock(Session *session,
680
 
                          const identifier::Table &identifier,
681
 
                          HA_CREATE_INFO *create_info,
682
 
                          message::Table &table_proto,
683
 
                          AlterInfo *alter_info,
684
 
                          bool tmp_table, uint32_t select_field_count,
685
 
                          bool is_if_not_exists);
686
 
 
687
 
bool create_like_table(Session* session,
688
 
                       identifier::Table::const_reference destination_identifier,
689
 
                       identifier::Table::const_reference source_identifier,
690
 
                       message::Table &create_table_proto,
691
 
                       bool is_if_not_exists,
692
 
                       bool is_engine_set);
693
 
 
694
 
bool rename_table(Session &session,
695
 
                        plugin::StorageEngine *base,
696
 
                        const identifier::Table &old_identifier,
697
 
                        const identifier::Table &new_identifier);
698
 
 
699
 
bool prepare_update(Session *session, TableList *table_list,
700
 
                          Item **conds, uint32_t order_num, Order *order);
701
 
int update_query(Session *session,TableList *tables,List<Item> &fields,
 
1225
                         int *timestamps, int *timestamps_with_niladic,
 
1226
                         int64_t table_flags);
 
1227
bool mysql_create_table(Session *session,const char *db, const char *table_name,
 
1228
                        HA_CREATE_INFO *create_info,
 
1229
                        Alter_info *alter_info,
 
1230
                        bool tmp_table, uint32_t select_field_count);
 
1231
bool mysql_create_table_no_lock(Session *session, const char *db,
 
1232
                                const char *table_name,
 
1233
                                HA_CREATE_INFO *create_info,
 
1234
                                Alter_info *alter_info,
 
1235
                                bool tmp_table, uint32_t select_field_count,
 
1236
                                bool lock_open_lock);
 
1237
 
 
1238
bool mysql_alter_table(Session *session, char *new_db, char *new_name,
 
1239
                       HA_CREATE_INFO *create_info,
 
1240
                       TableList *table_list,
 
1241
                       Alter_info *alter_info,
 
1242
                       uint32_t order_num, order_st *order, bool ignore);
 
1243
bool mysql_recreate_table(Session *session, TableList *table_list);
 
1244
bool mysql_create_like_table(Session *session, TableList *table,
 
1245
                             TableList *src_table,
 
1246
                             HA_CREATE_INFO *create_info);
 
1247
bool mysql_rename_table(handlerton *base, const char *old_db,
 
1248
                        const char * old_name, const char *new_db,
 
1249
                        const char * new_name, uint32_t flags);
 
1250
bool mysql_prepare_update(Session *session, TableList *table_list,
 
1251
                          Item **conds, uint32_t order_num, order_st *order);
 
1252
int mysql_update(Session *session,TableList *tables,List<Item> &fields,
702
1253
                 List<Item> &values,COND *conds,
703
 
                 uint32_t order_num, Order *order, ha_rows limit,
 
1254
                 uint32_t order_num, order_st *order, ha_rows limit,
704
1255
                 enum enum_duplicates handle_duplicates, bool ignore);
705
 
bool prepare_insert(Session *session, TableList *table_list, Table *table,
 
1256
bool mysql_multi_update(Session *session, TableList *table_list,
 
1257
                        List<Item> *fields, List<Item> *values,
 
1258
                        COND *conds, uint64_t options,
 
1259
                        enum enum_duplicates handle_duplicates, bool ignore,
 
1260
                        SELECT_LEX_UNIT *unit, SELECT_LEX *select_lex);
 
1261
bool mysql_prepare_insert(Session *session, TableList *table_list, Table *table,
706
1262
                          List<Item> &fields, List_item *values,
707
1263
                          List<Item> &update_fields,
708
1264
                          List<Item> &update_values, enum_duplicates duplic,
709
1265
                          COND **where, bool select_insert,
710
1266
                          bool check_fields, bool abort_on_warning);
711
 
bool insert_query(Session *session,TableList *table,List<Item> &fields,
 
1267
bool mysql_insert(Session *session,TableList *table,List<Item> &fields,
712
1268
                  List<List_item> &values, List<Item> &update_fields,
713
1269
                  List<Item> &update_values, enum_duplicates flag,
714
1270
                  bool ignore);
715
1271
int check_that_all_fields_are_given_values(Session *session, Table *entry,
716
1272
                                           TableList *table_list);
717
 
int prepare_delete(Session *session, TableList *table_list, Item **conds);
718
 
bool delete_query(Session *session, TableList *table_list, COND *conds,
 
1273
int mysql_prepare_delete(Session *session, TableList *table_list, Item **conds);
 
1274
bool mysql_delete(Session *session, TableList *table_list, COND *conds,
719
1275
                  SQL_LIST *order, ha_rows rows, uint64_t options,
720
1276
                  bool reset_auto_increment);
721
 
bool truncate(Session& session, TableList *table_list);
722
 
TableShare *get_table_share(Session *session, TableList *table_list, char *key,
 
1277
bool mysql_truncate(Session *session, TableList *table_list, bool dont_send_ok);
 
1278
uint32_t create_table_def_key(Session *session, char *key, TableList *table_list,
 
1279
                              bool tmp_table);
 
1280
TABLE_SHARE *get_table_share(Session *session, TableList *table_list, char *key,
723
1281
                             uint32_t key_length, uint32_t db_flags, int *error);
724
 
TableShare *get_cached_table_share(const char *db, const char *table_name);
 
1282
void release_table_share(TABLE_SHARE *share, enum release_type type);
 
1283
TABLE_SHARE *get_cached_table_share(const char *db, const char *table_name);
 
1284
Table *open_ltable(Session *session, TableList *table_list, thr_lock_type update,
 
1285
                   uint32_t lock_flags);
 
1286
Table *open_table(Session *session, TableList *table_list, bool *refresh, uint32_t flags);
 
1287
bool name_lock_locked_table(Session *session, TableList *tables);
725
1288
bool reopen_name_locked_table(Session* session, TableList* table_list, bool link_in);
 
1289
Table *table_cache_insert_placeholder(Session *session, const char *key,
 
1290
                                      uint32_t key_length);
 
1291
bool lock_table_name_if_not_cached(Session *session, const char *db,
 
1292
                                   const char *table_name, Table **table);
 
1293
Table *find_locked_table(Session *session, const char *db,const char *table_name);
 
1294
void detach_merge_children(Table *table, bool clear_refs);
 
1295
bool fix_merge_after_open(TableList *old_child_list, TableList **old_last,
 
1296
                          TableList *new_child_list, TableList **new_last);
 
1297
bool reopen_table(Table *table);
726
1298
bool reopen_tables(Session *session,bool get_locks,bool in_refresh);
 
1299
void close_data_files_and_morph_locks(Session *session, const char *db,
 
1300
                                      const char *table_name);
727
1301
void close_handle_and_leave_table_as_lock(Table *table);
 
1302
bool open_new_frm(Session *session, TABLE_SHARE *share, const char *alias,
 
1303
                  uint32_t db_stat, uint32_t prgflag,
 
1304
                  uint32_t ha_open_flags, Table *outparam,
 
1305
                  TableList *table_desc, MEM_ROOT *mem_root);
728
1306
bool wait_for_tables(Session *session);
729
1307
bool table_is_used(Table *table, bool wait_for_name_lock);
730
 
Table *drop_locked_tables(Session *session, const drizzled::identifier::Table &identifier);
731
 
void abort_locked_tables(Session *session, const drizzled::identifier::Table &identifier);
 
1308
Table *drop_locked_tables(Session *session,const char *db, const char *table_name);
 
1309
void abort_locked_tables(Session *session,const char *db, const char *table_name);
 
1310
void execute_init_command(Session *session, sys_var_str *init_command_var,
 
1311
                          pthread_rwlock_t *var_mutex);
732
1312
extern Field *not_found_field;
733
1313
extern Field *view_ref_found;
734
1314
 
736
1316
find_field_in_tables(Session *session, Item_ident *item,
737
1317
                     TableList *first_table, TableList *last_table,
738
1318
                     Item **ref, find_item_error_report_type report_error,
739
 
                     bool register_tree_change);
 
1319
                     bool check_privileges, bool register_tree_change);
740
1320
Field *
741
1321
find_field_in_table_ref(Session *session, TableList *table_list,
742
1322
                        const char *name, uint32_t length,
743
1323
                        const char *item_name, const char *db_name,
744
1324
                        const char *table_name, Item **ref,
745
 
                        bool allow_rowid,
 
1325
                        bool check_privileges, bool allow_rowid,
746
1326
                        uint32_t *cached_field_index_ptr,
747
1327
                        bool register_tree_change, TableList **actual_table);
748
1328
Field *
749
1329
find_field_in_table(Session *session, Table *table, const char *name, uint32_t length,
750
1330
                    bool allow_rowid, uint32_t *cached_field_index_ptr);
751
 
 
752
 
} /* namespace drizzled */
753
 
 
754
 
#endif /* DRIZZLED_CURSOR_H */
 
1331
Field *
 
1332
find_field_in_table_sef(Table *table, const char *name);
 
1333
int update_virtual_fields_marked_for_write(Table *table,
 
1334
                                           bool ignore_stored=true);
 
1335
 
 
1336
 
 
1337
#endif /* DRIZZLED_HANDLER_H */