handler.h 73.8 KB
Newer Older
1
/* Copyright 2000-2008 MySQL AB, 2008 Sun Microsystems, Inc.
2

unknown's avatar
unknown committed
3 4
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
unknown's avatar
unknown committed
5
   the Free Software Foundation; version 2 of the License.
6

unknown's avatar
unknown committed
7 8 9 10
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
11

unknown's avatar
unknown committed
12 13 14 15 16 17 18
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */


/* Definitions for parameters to do with handler-routines */

19
#ifdef USE_PRAGMA_INTERFACE
unknown's avatar
unknown committed
20 21 22
#pragma interface			/* gcc class implementation */
#endif

23
#include <my_handler.h>
unknown's avatar
unknown committed
24
#include <ft_global.h>
unknown's avatar
unknown committed
25
#include <keycache.h>
unknown's avatar
unknown committed
26

unknown's avatar
unknown committed
27 28 29 30
#ifndef NO_HASH
#define NO_HASH				/* Not yet implemented */
#endif

31 32
#define USING_TRANSACTIONS

unknown's avatar
unknown committed
33 34
// the following is for checking tables

35 36 37 38 39 40
#define HA_ADMIN_ALREADY_DONE	  1
#define HA_ADMIN_OK               0
#define HA_ADMIN_NOT_IMPLEMENTED -1
#define HA_ADMIN_FAILED		 -2
#define HA_ADMIN_CORRUPT         -3
#define HA_ADMIN_INTERNAL_ERROR  -4
unknown's avatar
unknown committed
41
#define HA_ADMIN_INVALID         -5
unknown's avatar
unknown committed
42
#define HA_ADMIN_REJECT          -6
43
#define HA_ADMIN_TRY_ALTER       -7
44
#define HA_ADMIN_WRONG_CHECKSUM  -8
unknown's avatar
unknown committed
45
#define HA_ADMIN_NOT_BASE_TABLE  -9
unknown's avatar
unknown committed
46 47 48
#define HA_ADMIN_NEEDS_UPGRADE  -10
#define HA_ADMIN_NEEDS_ALTER    -11
#define HA_ADMIN_NEEDS_CHECK    -12
unknown's avatar
unknown committed
49

50
/* Bits in table_flags() to show what database can do */
51

52 53 54
#define HA_NO_TRANSACTIONS     (1 << 0) /* Doesn't support transactions */
#define HA_PARTIAL_COLUMN_READ (1 << 1) /* read may not return all columns */
#define HA_TABLE_SCAN_ON_INDEX (1 << 2) /* No separate data/index file */
55
/*
56 57 58 59 60 61
  The following should be set if the following is not true when scanning
  a table with rnd_next()
  - We will see all rows (including deleted ones)
  - Row positions are 'table->s->db_record_offset' apart
  If this flag is not set, filesort will do a postion() call for each matched
  row to be able to find the row later.
62
*/
63
#define HA_REC_NOT_IN_SEQ      (1 << 3)
unknown's avatar
unknown committed
64
#define HA_CAN_GEOMETRY        (1 << 4)
65 66 67 68 69 70
/*
  Reading keys in random order is as fast as reading keys in sort order
  (Used in records.cc to decide if we should use a record cache and by
  filesort to decide if we should sort key + data or key + pointer-to-row
*/
#define HA_FAST_KEY_READ       (1 << 5)
71 72 73 74 75
/*
  Set the following flag if we on delete should force all key to be read
  and on update read all keys that changes
*/
#define HA_REQUIRES_KEY_COLUMNS_FOR_DELETE (1 << 6)
unknown's avatar
unknown committed
76
#define HA_NULL_IN_KEY         (1 << 7) /* One can have keys with NULL */
77
#define HA_DUPLICATE_POS       (1 << 8)    /* ha_position() gives dup row */
unknown's avatar
unknown committed
78
#define HA_NO_BLOBS            (1 << 9) /* Doesn't support blobs */
unknown's avatar
unknown committed
79 80 81
#define HA_CAN_INDEX_BLOBS     (1 << 10)
#define HA_AUTO_PART_KEY       (1 << 11) /* auto-increment in multi-part key */
#define HA_REQUIRE_PRIMARY_KEY (1 << 12) /* .. and can't create a hidden one */
82
#define HA_STATS_RECORDS_IS_EXACT (1 << 13) /* stats.records is exact */
83 84 85 86 87
/*
  INSERT_DELAYED only works with handlers that uses MySQL internal table
  level locks
*/
#define HA_CAN_INSERT_DELAYED  (1 << 14)
88 89 90 91 92
/*
  If we get the primary key columns for free when we do an index read
  It also implies that we have to retrive the primary key when using
  position() and rnd_pos().
*/
unknown's avatar
unknown committed
93
#define HA_PRIMARY_KEY_IN_READ_INDEX (1 << 15)
94
/*
95 96
  If HA_PRIMARY_KEY_REQUIRED_FOR_POSITION is set, it means that to position()
  uses a primary key. Without primary key, we can't call position().
97
*/ 
98
#define HA_PRIMARY_KEY_REQUIRED_FOR_POSITION (1 << 16) 
99
#define HA_CAN_RTREEKEYS       (1 << 17)
unknown's avatar
unknown committed
100
#define HA_NOT_DELETE_WITH_CACHE (1 << 18)
101 102 103 104 105
/*
  The following is we need to a primary key to delete (and update) a row.
  If there is no primary key, all columns needs to be read on update and delete
*/
#define HA_PRIMARY_KEY_REQUIRED_FOR_DELETE (1 << 19)
unknown's avatar
unknown committed
106 107 108 109 110
#define HA_NO_PREFIX_CHAR_KEYS (1 << 20)
#define HA_CAN_FULLTEXT        (1 << 21)
#define HA_CAN_SQL_HANDLER     (1 << 22)
#define HA_NO_AUTO_INCREMENT   (1 << 23)
#define HA_HAS_CHECKSUM        (1 << 24)
unknown's avatar
unknown committed
111
/* Table data are stored in separate files (for lower_case_table_names) */
unknown's avatar
unknown committed
112
#define HA_FILE_BASED	       (1 << 26)
113
#define HA_NO_VARCHAR	       (1 << 27)
unknown's avatar
unknown committed
114
#define HA_CAN_BIT_FIELD       (1 << 28) /* supports bit fields */
unknown's avatar
unknown committed
115
#define HA_NEED_READ_RANGE_BUFFER (1 << 29) /* for read_multi_range */
116
#define HA_ANY_INDEX_MAY_BE_UNIQUE (1 << 30)
117 118
#define HA_NO_COPY_ON_ALTER    (LL(1) << 31)
#define HA_HAS_RECORDS	       (LL(1) << 32) /* records() gives exact count*/
119 120
/* Has it's own method of binlog logging */
#define HA_HAS_OWN_BINLOGGING  (LL(1) << 33)
121 122 123 124 125 126 127 128 129 130 131 132
/*
  Engine is capable of row-format and statement-format logging,
  respectively
*/
#define HA_BINLOG_ROW_CAPABLE  (LL(1) << 34)
#define HA_BINLOG_STMT_CAPABLE (LL(1) << 35)

/*
  Set of all binlog flags. Currently only contain the capabilities
  flags.
 */
#define HA_BINLOG_FLAGS (HA_BINLOG_ROW_CAPABLE | HA_BINLOG_STMT_CAPABLE)
unknown's avatar
unknown committed
133

134
/* bits in index_flags(index_number) for what you can do with index */
unknown's avatar
unknown committed
135 136 137 138
#define HA_READ_NEXT            1       /* TODO really use this flag */
#define HA_READ_PREV            2       /* supports ::index_prev */
#define HA_READ_ORDER           4       /* index_next/prev follow sort order */
#define HA_READ_RANGE           8       /* can find all records in a range */
139
#define HA_ONLY_WHOLE_INDEX	16	/* Can't use part key searches */
unknown's avatar
unknown committed
140
#define HA_KEYREAD_ONLY         64	/* Support HA_EXTRA_KEYREAD */
141

unknown's avatar
unknown committed
142 143 144
/*
  bits in alter_table_flags:
*/
145 146 147 148
/*
  These bits are set if different kinds of indexes can be created
  off-line without re-create of the table (but with a table lock).
*/
unknown's avatar
unknown committed
149 150 151 152 153 154
#define HA_ONLINE_ADD_INDEX_NO_WRITES           (1L << 0) /*add index w/lock*/
#define HA_ONLINE_DROP_INDEX_NO_WRITES          (1L << 1) /*drop index w/lock*/
#define HA_ONLINE_ADD_UNIQUE_INDEX_NO_WRITES    (1L << 2) /*add unique w/lock*/
#define HA_ONLINE_DROP_UNIQUE_INDEX_NO_WRITES   (1L << 3) /*drop uniq. w/lock*/
#define HA_ONLINE_ADD_PK_INDEX_NO_WRITES        (1L << 4) /*add prim. w/lock*/
#define HA_ONLINE_DROP_PK_INDEX_NO_WRITES       (1L << 5) /*drop prim. w/lock*/
155 156 157 158 159
/*
  These are set if different kinds of indexes can be created on-line
  (without a table lock). If a handler is capable of one or more of
  these, it should also set the corresponding *_NO_WRITES bit(s).
*/
unknown's avatar
unknown committed
160 161 162 163 164 165
#define HA_ONLINE_ADD_INDEX                     (1L << 6) /*add index online*/
#define HA_ONLINE_DROP_INDEX                    (1L << 7) /*drop index online*/
#define HA_ONLINE_ADD_UNIQUE_INDEX              (1L << 8) /*add unique online*/
#define HA_ONLINE_DROP_UNIQUE_INDEX             (1L << 9) /*drop uniq. online*/
#define HA_ONLINE_ADD_PK_INDEX                  (1L << 10)/*add prim. online*/
#define HA_ONLINE_DROP_PK_INDEX                 (1L << 11)/*drop prim. online*/
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
/*
  HA_PARTITION_FUNCTION_SUPPORTED indicates that the function is
  supported at all.
  HA_FAST_CHANGE_PARTITION means that optimised variants of the changes
  exists but they are not necessarily done online.

  HA_ONLINE_DOUBLE_WRITE means that the handler supports writing to both
  the new partition and to the old partitions when updating through the
  old partitioning schema while performing a change of the partitioning.
  This means that we can support updating of the table while performing
  the copy phase of the change. For no lock at all also a double write
  from new to old must exist and this is not required when this flag is
  set.
  This is actually removed even before it was introduced the first time.
  The new idea is that handlers will handle the lock level already in
  store_lock for ALTER TABLE partitions.

  HA_PARTITION_ONE_PHASE is a flag that can be set by handlers that take
  care of changing the partitions online and in one phase. Thus all phases
  needed to handle the change are implemented inside the storage engine.
  The storage engine must also support auto-discovery since the frm file
  is changed as part of the change and this change must be controlled by
  the storage engine. A typical engine to support this is NDB (through
  WL #2498).
*/
#define HA_PARTITION_FUNCTION_SUPPORTED         (1L << 12)
#define HA_FAST_CHANGE_PARTITION                (1L << 13)
#define HA_PARTITION_ONE_PHASE                  (1L << 14)
unknown's avatar
unknown committed
194

195 196 197 198 199 200
/*
  Index scan will not return records in rowid order. Not guaranteed to be
  set for unordered (e.g. HASH) indexes.
*/
#define HA_KEY_SCAN_NOT_ROR     128 

201 202 203 204 205 206
/* operations for disable/enable indexes */
#define HA_KEY_SWITCH_NONUNIQ      0
#define HA_KEY_SWITCH_ALL          1
#define HA_KEY_SWITCH_NONUNIQ_SAVE 2
#define HA_KEY_SWITCH_ALL_SAVE     3

207 208
/*
  Note: the following includes binlog and closing 0.
209 210 211
  so: innodb + bdb + ndb + binlog + myisam + myisammrg + archive +
      example + csv + heap + blackhole + federated + 0
  (yes, the sum is deliberately inaccurate)
unknown's avatar
unknown committed
212
  TODO remove the limit, use dynarrays
213
*/
214
#define MAX_HA 15
215

216 217 218 219
/*
  Parameters for open() (in register form->filestat)
  HA_GET_INFO does an implicit HA_ABORT_IF_LOCKED
*/
unknown's avatar
unknown committed
220 221 222 223 224 225

#define HA_OPEN_KEYFILE		1
#define HA_OPEN_RNDFILE		2
#define HA_GET_INDEX		4
#define HA_GET_INFO		8	/* do a ha_info() after open */
#define HA_READ_ONLY		16	/* File opened as readonly */
226 227
/* Try readonly if can't open with read and write */
#define HA_TRY_READ_ONLY	32
unknown's avatar
unknown committed
228 229 230 231 232 233 234 235 236 237 238
#define HA_WAIT_IF_LOCKED	64	/* Wait if locked on open */
#define HA_ABORT_IF_LOCKED	128	/* skip if locked on open.*/
#define HA_BLOCK_LOCK		256	/* unlock when reading some records */
#define HA_OPEN_TEMPORARY	512

	/* Some key definitions */
#define HA_KEY_NULL_LENGTH	1
#define HA_KEY_BLOB_LENGTH	2

#define HA_LEX_CREATE_TMP_TABLE	1
#define HA_LEX_CREATE_IF_NOT_EXISTS 2
unknown's avatar
unknown committed
239
#define HA_LEX_CREATE_TABLE_LIKE 4
unknown's avatar
unknown committed
240 241 242 243
#define HA_OPTION_NO_CHECKSUM	(1L << 17)
#define HA_OPTION_NO_DELAY_KEY_WRITE (1L << 18)
#define HA_MAX_REC_LENGTH	65535

244 245
/* Table caching type */
#define HA_CACHE_TBL_NONTRANSACT 0
246 247 248 249
#define HA_CACHE_TBL_NOCACHE     1
#define HA_CACHE_TBL_ASKTRANSACT 2
#define HA_CACHE_TBL_TRANSACT    4

250 251
/* Options of START TRANSACTION statement (and later of SET TRANSACTION stmt) */
#define MYSQL_START_TRANS_OPT_WITH_CONS_SNAPSHOT 1
252

253 254 255 256 257
/* Flags for method is_fatal_error */
#define HA_CHECK_DUP_KEY 1
#define HA_CHECK_DUP_UNIQUE 2
#define HA_CHECK_DUP (HA_CHECK_DUP_KEY + HA_CHECK_DUP_UNIQUE)

unknown's avatar
unknown committed
258
enum legacy_db_type
259
{
unknown's avatar
unknown committed
260 261 262 263
  DB_TYPE_UNKNOWN=0,DB_TYPE_DIAB_ISAM=1,
  DB_TYPE_HASH,DB_TYPE_MISAM,DB_TYPE_PISAM,
  DB_TYPE_RMS_ISAM, DB_TYPE_HEAP, DB_TYPE_ISAM,
  DB_TYPE_MRG_ISAM, DB_TYPE_MYISAM, DB_TYPE_MRG_MYISAM,
264
  DB_TYPE_BERKELEY_DB, DB_TYPE_INNODB,
unknown's avatar
unknown committed
265
  DB_TYPE_GEMINI, DB_TYPE_NDBCLUSTER,
266
  DB_TYPE_EXAMPLE_DB, DB_TYPE_ARCHIVE_DB, DB_TYPE_CSV_DB,
267
  DB_TYPE_FEDERATED_DB,
268
  DB_TYPE_BLACKHOLE_DB,
269
  DB_TYPE_PARTITION_DB,
270
  DB_TYPE_BINLOG,
271 272 273 274
  DB_TYPE_SOLID,
  DB_TYPE_PBXT,
  DB_TYPE_TABLE_FUNCTION,
  DB_TYPE_MEMCACHE,
275
  DB_TYPE_FALCON,
276
  DB_TYPE_MARIA,
277
  DB_TYPE_FIRST_DYNAMIC=42,
unknown's avatar
unknown committed
278
  DB_TYPE_DEFAULT=127 // Must be last
unknown's avatar
unknown committed
279
};
unknown's avatar
unknown committed
280

281
enum row_type { ROW_TYPE_NOT_USED=-1, ROW_TYPE_DEFAULT, ROW_TYPE_FIXED,
282
		ROW_TYPE_DYNAMIC, ROW_TYPE_COMPRESSED,
283 284 285
		ROW_TYPE_REDUNDANT, ROW_TYPE_COMPACT,
                /** Unused. Reserved for future versions. */
                ROW_TYPE_PAGE };
unknown's avatar
unknown committed
286

unknown's avatar
unknown committed
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
enum enum_binlog_func {
  BFN_RESET_LOGS=        1,
  BFN_RESET_SLAVE=       2,
  BFN_BINLOG_WAIT=       3,
  BFN_BINLOG_END=        4,
  BFN_BINLOG_PURGE_FILE= 5
};

enum enum_binlog_command {
  LOGCOM_CREATE_TABLE,
  LOGCOM_ALTER_TABLE,
  LOGCOM_RENAME_TABLE,
  LOGCOM_DROP_TABLE,
  LOGCOM_CREATE_DB,
  LOGCOM_ALTER_DB,
  LOGCOM_DROP_DB
};

unknown's avatar
unknown committed
305 306 307
/* struct to hold information about the table that should be created */

/* Bits in used_fields */
308
#define HA_CREATE_USED_AUTO             (1L << 0)
309
#define HA_CREATE_USED_RAID             (1L << 1) //RAID is no longer availble
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
#define HA_CREATE_USED_UNION            (1L << 2)
#define HA_CREATE_USED_INSERT_METHOD    (1L << 3)
#define HA_CREATE_USED_MIN_ROWS         (1L << 4)
#define HA_CREATE_USED_MAX_ROWS         (1L << 5)
#define HA_CREATE_USED_AVG_ROW_LENGTH   (1L << 6)
#define HA_CREATE_USED_PACK_KEYS        (1L << 7)
#define HA_CREATE_USED_CHARSET          (1L << 8)
#define HA_CREATE_USED_DEFAULT_CHARSET  (1L << 9)
#define HA_CREATE_USED_DATADIR          (1L << 10)
#define HA_CREATE_USED_INDEXDIR         (1L << 11)
#define HA_CREATE_USED_ENGINE           (1L << 12)
#define HA_CREATE_USED_CHECKSUM         (1L << 13)
#define HA_CREATE_USED_DELAY_KEY_WRITE  (1L << 14)
#define HA_CREATE_USED_ROW_FORMAT       (1L << 15)
#define HA_CREATE_USED_COMMENT          (1L << 16)
#define HA_CREATE_USED_PASSWORD         (1L << 17)
326
#define HA_CREATE_USED_CONNECTION       (1L << 18)
327
#define HA_CREATE_USED_KEY_BLOCK_SIZE   (1L << 19)
328
/** Unused. Reserved for future versions. */
329
#define HA_CREATE_USED_TRANSACTIONAL    (1L << 20)
330
/** Unused. Reserved for future versions. */
331
#define HA_CREATE_USED_PAGE_CHECKSUM    (1L << 21)
unknown's avatar
unknown committed
332

333
typedef ulonglong my_xid; // this line is the same as in log_event.h
334 335 336 337
#define MYSQL_XID_PREFIX "MySQLXid"
#define MYSQL_XID_PREFIX_LEN 8 // must be a multiple of 8
#define MYSQL_XID_OFFSET (MYSQL_XID_PREFIX_LEN+sizeof(server_id))
#define MYSQL_XID_GTRID_LEN (MYSQL_XID_OFFSET+sizeof(my_xid))
338

339
#define XIDDATASIZE MYSQL_XIDDATASIZE
340 341 342
#define MAXGTRIDSIZE 64
#define MAXBQUALSIZE 64

unknown's avatar
unknown committed
343 344 345
#define COMPATIBLE_DATA_YES 0
#define COMPATIBLE_DATA_NO  1

346 347 348 349 350 351 352 353
/**
  struct xid_t is binary compatible with the XID structure as
  in the X/Open CAE Specification, Distributed Transaction Processing:
  The XA Specification, X/Open Company Ltd., 1991.
  http://www.opengroup.org/bookstore/catalog/c193.htm

  @see MYSQL_XID in mysql/plugin.h
*/
354 355 356 357
struct xid_t {
  long formatID;
  long gtrid_length;
  long bqual_length;
358
  char data[XIDDATASIZE];  // not \0-terminated !
359

360
  xid_t() {}                                /* Remove gcc warning */  
unknown's avatar
unknown committed
361
  bool eq(struct xid_t *xid)
362
  { return eq(xid->gtrid_length, xid->bqual_length, xid->data); }
363 364
  bool eq(long g, long b, const char *d)
  { return g == gtrid_length && b == bqual_length && !memcmp(d, data, g+b); }
unknown's avatar
unknown committed
365
  void set(struct xid_t *xid)
366
  { memcpy(this, xid, xid->length()); }
unknown's avatar
unknown committed
367 368 369 370 371 372
  void set(long f, const char *g, long gl, const char *b, long bl)
  {
    formatID= f;
    memcpy(data, g, gtrid_length= gl);
    memcpy(data+gl, b, bqual_length= bl);
  }
373
  void set(ulonglong xid)
374
  {
375
    my_xid tmp;
unknown's avatar
unknown committed
376
    formatID= 1;
377
    set(MYSQL_XID_PREFIX_LEN, 0, MYSQL_XID_PREFIX);
378 379 380
    memcpy(data+MYSQL_XID_PREFIX_LEN, &server_id, sizeof(server_id));
    tmp= xid;
    memcpy(data+MYSQL_XID_OFFSET, &tmp, sizeof(tmp));
381 382 383 384
    gtrid_length=MYSQL_XID_GTRID_LEN;
  }
  void set(long g, long b, const char *d)
  {
unknown's avatar
unknown committed
385
    formatID= 1;
386 387 388 389 390 391 392 393
    gtrid_length= g;
    bqual_length= b;
    memcpy(data, d, g+b);
  }
  bool is_null() { return formatID == -1; }
  void null() { formatID= -1; }
  my_xid quick_get_my_xid()
  {
394 395 396
    my_xid tmp;
    memcpy(&tmp, data+MYSQL_XID_OFFSET, sizeof(tmp));
    return tmp;
397 398 399 400
  }
  my_xid get_my_xid()
  {
    return gtrid_length == MYSQL_XID_GTRID_LEN && bqual_length == 0 &&
unknown's avatar
unknown committed
401
           !memcmp(data+MYSQL_XID_PREFIX_LEN, &server_id, sizeof(server_id)) &&
402 403 404
           !memcmp(data, MYSQL_XID_PREFIX, MYSQL_XID_PREFIX_LEN) ?
           quick_get_my_xid() : 0;
  }
405 406 407 408 409
  uint length()
  {
    return sizeof(formatID)+sizeof(gtrid_length)+sizeof(bqual_length)+
           gtrid_length+bqual_length;
  }
410
  uchar *key()
411
  {
412
    return (uchar *)&gtrid_length;
413 414 415 416 417
  }
  uint key_length()
  {
    return sizeof(gtrid_length)+sizeof(bqual_length)+gtrid_length+bqual_length;
  }
418
};
419 420
typedef struct xid_t XID;

421 422
/* for recover() handlerton call */
#define MIN_XID_LIST_SIZE  128
423 424 425
#ifdef SAFEMALLOC
#define MAX_XID_LIST_SIZE  256
#else
426
#define MAX_XID_LIST_SIZE  (1024*128)
427
#endif
428

unknown's avatar
unknown committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
/*
  These structures are used to pass information from a set of SQL commands
  on add/drop/change tablespace definitions to the proper hton.
*/
#define UNDEF_NODEGROUP 65535
enum ts_command_type
{
  TS_CMD_NOT_DEFINED = -1,
  CREATE_TABLESPACE = 0,
  ALTER_TABLESPACE = 1,
  CREATE_LOGFILE_GROUP = 2,
  ALTER_LOGFILE_GROUP = 3,
  DROP_TABLESPACE = 4,
  DROP_LOGFILE_GROUP = 5,
  CHANGE_FILE_TABLESPACE = 6,
  ALTER_ACCESS_MODE_TABLESPACE = 7
};

enum ts_alter_tablespace_type
{
  TS_ALTER_TABLESPACE_TYPE_NOT_DEFINED = -1,
  ALTER_TABLESPACE_ADD_FILE = 1,
  ALTER_TABLESPACE_DROP_FILE = 2
};

enum tablespace_access_mode
{
  TS_NOT_DEFINED= -1,
  TS_READ_ONLY = 0,
  TS_READ_WRITE = 1,
  TS_NOT_ACCESSIBLE = 2
};

462
struct handlerton;
unknown's avatar
unknown committed
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
class st_alter_tablespace : public Sql_alloc
{
  public:
  const char *tablespace_name;
  const char *logfile_group_name;
  enum ts_command_type ts_cmd_type;
  enum ts_alter_tablespace_type ts_alter_tablespace_type;
  const char *data_file_name;
  const char *undo_file_name;
  const char *redo_file_name;
  ulonglong extent_size;
  ulonglong undo_buffer_size;
  ulonglong redo_buffer_size;
  ulonglong initial_size;
  ulonglong autoextend_size;
  ulonglong max_size;
  uint nodegroup_id;
480
  handlerton *storage_engine;
unknown's avatar
unknown committed
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
  bool wait_until_completed;
  const char *ts_comment;
  enum tablespace_access_mode ts_access_mode;
  st_alter_tablespace()
  {
    tablespace_name= NULL;
    logfile_group_name= "DEFAULT_LG"; //Default log file group
    ts_cmd_type= TS_CMD_NOT_DEFINED;
    data_file_name= NULL;
    undo_file_name= NULL;
    redo_file_name= NULL;
    extent_size= 1024*1024;        //Default 1 MByte
    undo_buffer_size= 8*1024*1024; //Default 8 MByte
    redo_buffer_size= 8*1024*1024; //Default 8 MByte
    initial_size= 128*1024*1024;   //Default 128 MByte
    autoextend_size= 0;            //No autoextension as default
    max_size= 0;                   //Max size == initial size => no extension
498
    storage_engine= NULL;
unknown's avatar
unknown committed
499 500 501 502 503 504 505
    nodegroup_id= UNDEF_NODEGROUP;
    wait_until_completed= TRUE;
    ts_comment= NULL;
    ts_access_mode= TS_NOT_DEFINED;
  }
};

506 507 508 509
/* The handler for a table type.  Will be included in the TABLE structure */

struct st_table;
typedef struct st_table TABLE;
unknown's avatar
unknown committed
510
typedef struct st_table_share TABLE_SHARE;
511 512
struct st_foreign_key_info;
typedef struct st_foreign_key_info FOREIGN_KEY_INFO;
unknown's avatar
unknown committed
513 514 515
typedef bool (stat_print_fn)(THD *thd, const char *type, uint type_len,
                             const char *file, uint file_len,
                             const char *status, uint status_len);
516
enum ha_stat_type { HA_ENGINE_STATUS, HA_ENGINE_LOGS, HA_ENGINE_MUTEX };
unknown's avatar
unknown committed
517
extern st_plugin_int *hton2plugin[MAX_HA];
518

519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
/* Transaction log maintains type definitions */
enum log_status
{
  HA_LOG_STATUS_FREE= 0,      /* log is free and can be deleted */
  HA_LOG_STATUS_INUSE= 1,     /* log can't be deleted because it is in use */
  HA_LOG_STATUS_NOSUCHLOG= 2  /* no such log (can't be returned by
                                the log iterator status) */
};
/*
  Function for signaling that the log file changed its state from
  LOG_STATUS_INUSE to LOG_STATUS_FREE

  Now it do nothing, will be implemented as part of new transaction
  log management for engines.
  TODO: implement the function.
*/
void signal_log_not_needed(struct handlerton, char *log_file);
/*
  Data of transaction log iterator.
*/
struct handler_log_file_data {
  LEX_STRING filename;
  enum log_status status;
};


enum handler_iterator_type
{
  /* request of transaction log iterator */
  HA_TRANSACTLOG_ITERATOR= 1
};
enum handler_create_iterator_result
{
  HA_ITERATOR_OK,          /* iterator created */
  HA_ITERATOR_UNSUPPORTED, /* such type of iterator is not supported */
  HA_ITERATOR_ERROR        /* error during iterator creation */
};

/*
  Iterator structure. Can be used by handler/handlerton for different purposes.

  Iterator should be created in the way to point "before" the first object
  it iterate, so next() call move it to the first object or return !=0 if
  there is nothing to iterate through.
*/
struct handler_iterator {
  /*
    Moves iterator to next record and return 0 or return !=0
    if there is no records.
    iterator_object will be filled by this function if next() returns 0.
    Content of the iterator_object depend on iterator type.
  */
  int (*next)(struct handler_iterator *, void *iterator_object);
  /*
    Free resources allocated by iterator, after this call iterator
    is not usable.
  */
  void (*destroy)(struct handler_iterator *);
  /*
    Pointer to buffer for the iterator to use.
    Should be allocated by function which created the iterator and
    destroied by freed by above "destroy" call
  */
  void *buffer;
};

unknown's avatar
unknown committed
585 586
/*
  handlerton is a singleton structure - one instance per storage engine -
unknown's avatar
unknown committed
587 588
  to provide access to storage engine functionality that works on the
  "global" level (unlike handler class that works on a per-table basis)
unknown's avatar
unknown committed
589 590

  usually handlerton instance is defined statically in ha_xxx.cc as
591

unknown's avatar
unknown committed
592 593 594 595
  static handlerton { ... } xxx_hton;

  savepoint_*, prepare, recover, and *_by_xid pointers can be 0.
*/
596
struct handlerton
597
{
unknown's avatar
unknown committed
598
  /*
unknown's avatar
unknown committed
599
    Historical marker for if the engine is available of not
600 601 602 603 604 605 606
  */
  SHOW_COMP_OPTION state;

  /*
    Historical number used for frm file to determine the correct storage engine.
    This is going away and new engines will just use "name" for this.
  */
unknown's avatar
unknown committed
607
  enum legacy_db_type db_type;
unknown's avatar
unknown committed
608 609 610 611 612 613 614 615 616
  /*
    each storage engine has it's own memory area (actually a pointer)
    in the thd, for storing per-connection information.
    It is accessed as

      thd->ha_data[xxx_hton.slot]

   slot number is initialized by MySQL after xxx_init() is called.
   */
617
   uint slot;
unknown's avatar
unknown committed
618 619 620 621 622 623 624 625 626
   /*
     to store per-savepoint data storage engine is provided with an area
     of a requested size (0 is ok here).
     savepoint_offset must be initialized statically to the size of
     the needed memory to store per-savepoint information.
     After xxx_init it is changed to be an offset to savepoint storage
     area and need not be used by storage engine.
     see binlog_hton and binlog_savepoint_set/rollback for an example.
   */
627
   uint savepoint_offset;
unknown's avatar
unknown committed
628 629 630 631 632 633 634 635
   /*
     handlerton methods:

     close_connection is only called if
     thd->ha_data[xxx_hton.slot] is non-zero, so even if you don't need
     this storage area - set it to something, so that MySQL would know
     this storage engine was accessed in this connection
   */
636
   int  (*close_connection)(handlerton *hton, THD *thd);
unknown's avatar
unknown committed
637 638 639 640
   /*
     sv points to an uninitialized storage area of requested size
     (see savepoint_offset description)
   */
641
   int  (*savepoint_set)(handlerton *hton, THD *thd, void *sv);
unknown's avatar
unknown committed
642 643 644 645
   /*
     sv points to a storage area, that was earlier passed
     to the savepoint_set call
   */
646 647
   int  (*savepoint_rollback)(handlerton *hton, THD *thd, void *sv);
   int  (*savepoint_release)(handlerton *hton, THD *thd, void *sv);
unknown's avatar
unknown committed
648 649 650 651 652 653 654
   /*
     'all' is true if it's a real commit, that makes persistent changes
     'all' is false if it's not in fact a commit but an end of the
     statement that is part of the transaction.
     NOTE 'all' is also false in auto-commit mode where 'end of statement'
     and 'real commit' mean the same event.
   */
655 656 657 658 659 660
   int  (*commit)(handlerton *hton, THD *thd, bool all);
   int  (*rollback)(handlerton *hton, THD *thd, bool all);
   int  (*prepare)(handlerton *hton, THD *thd, bool all);
   int  (*recover)(handlerton *hton, XID *xid_list, uint len);
   int  (*commit_by_xid)(handlerton *hton, XID *xid);
   int  (*rollback_by_xid)(handlerton *hton, XID *xid);
661 662 663
   void *(*create_cursor_read_view)(handlerton *hton, THD *thd);
   void (*set_cursor_read_view)(handlerton *hton, THD *thd, void *read_view);
   void (*close_cursor_read_view)(handlerton *hton, THD *thd, void *read_view);
664
   handler *(*create)(handlerton *hton, TABLE_SHARE *table, MEM_ROOT *mem_root);
665 666 667 668 669
   void (*drop_database)(handlerton *hton, char* path);
   int (*panic)(handlerton *hton, enum ha_panic_function flag);
   int (*start_consistent_snapshot)(handlerton *hton, THD *thd);
   bool (*flush_logs)(handlerton *hton);
   bool (*show_status)(handlerton *hton, THD *thd, stat_print_fn *print, enum ha_stat_type stat);
unknown's avatar
unknown committed
670 671
   uint (*partition_flags)();
   uint (*alter_table_flags)(uint flags);
672 673
   int (*alter_tablespace)(handlerton *hton, THD *thd, st_alter_tablespace *ts_info);
   int (*fill_files_table)(handlerton *hton, THD *thd,
674
                           TABLE_LIST *tables,
675
                           class Item *cond);
676
   uint32 flags;                                /* global handler flags */
677 678 679
   /*
      Those handlerton functions below are properly initialized at handler
      init.
unknown's avatar
unknown committed
680
   */
681 682 683
   int (*binlog_func)(handlerton *hton, THD *thd, enum_binlog_func fn, void *arg);
   void (*binlog_log_query)(handlerton *hton, THD *thd, 
                            enum_binlog_command binlog_command,
unknown's avatar
unknown committed
684 685
                            const char *query, uint query_length,
                            const char *db, const char *table_name);
686
   int (*release_temporary_latches)(handlerton *hton, THD *thd);
687 688 689 690 691 692 693 694

   /*
     Get log status.
     If log_status is null then the handler do not support transaction
     log information (i.e. log iterator can't be created).
     (see example of implementation in handler.cc, TRANS_LOG_MGM_EXAMPLE_CODE)

   */
695
   enum log_status (*get_log_status)(handlerton *hton, char *log);
696 697 698 699 700 701

   /*
     Iterators creator.
     Presence of the pointer should be checked before using
   */
   enum handler_create_iterator_result
702
     (*create_iterator)(handlerton *hton, enum handler_iterator_type type,
703
                        struct handler_iterator *fill_this_in);
704 705
   int (*discover)(handlerton *hton, THD* thd, const char *db, 
                   const char *name,
706 707
                   uchar **frmblob, 
                   size_t *frmlen);
708 709 710
   int (*find_files)(handlerton *hton, THD *thd,
                     const char *db,
                     const char *path,
711
                     const char *wild, bool dir, List<LEX_STRING> *files);
712
   int (*table_exists_in_engine)(handlerton *hton, THD* thd, const char *db,
713
                                 const char *name);
714
   uint32 license; /* Flag for Engine License */
715
   void *data; /* Location for engines to keep personal structures */
716
};
717

718

719
/* Possible flags of a handlerton (there can be 32 of them) */
720 721
#define HTON_NO_FLAGS                 0
#define HTON_CLOSE_CURSORS_AT_COMMIT (1 << 0)
722 723 724
#define HTON_ALTER_NOT_SUPPORTED     (1 << 1) //Engine does not support alter
#define HTON_CAN_RECREATE            (1 << 2) //Delete all is used fro truncate
#define HTON_HIDDEN                  (1 << 3) //Engine does not appear in lists
725 726
#define HTON_FLUSH_AFTER_RENAME      (1 << 4)
#define HTON_NOT_USER_SELECTABLE     (1 << 5)
727
#define HTON_TEMPORARY_NOT_SUPPORTED (1 << 6) //Having temporary tables not supported
unknown's avatar
unknown committed
728
#define HTON_SUPPORT_LOG_TABLES      (1 << 7) //Engine supports log tables
729
#define HTON_NO_PARTITION            (1 << 8) //You can not partition these tables
730

731 732 733
class Ha_trx_info;

struct THD_TRANS
734
{
unknown's avatar
unknown committed
735
  /* true is not all entries in the ht[] support 2pc */
736
  bool        no_2pc;
737 738
  /* storage engines that registered in this transaction */
  Ha_trx_info *ha_list;
unknown's avatar
unknown committed
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
  /* 
    The purpose of this flag is to keep track of non-transactional
    tables that were modified in scope of:
    - transaction, when the variable is a member of
    THD::transaction.all
    - top-level statement or sub-statement, when the variable is a
    member of THD::transaction.stmt
    This member has the following life cycle:
    * stmt.modified_non_trans_table is used to keep track of
    modified non-transactional tables of top-level statements. At
    the end of the previous statement and at the beginning of the session,
    it is reset to FALSE.  If such functions
    as mysql_insert, mysql_update, mysql_delete etc modify a
    non-transactional table, they set this flag to TRUE.  At the
    end of the statement, the value of stmt.modified_non_trans_table 
    is merged with all.modified_non_trans_table and gets reset.
    * all.modified_non_trans_table is reset at the end of transaction
    
    * Since we do not have a dedicated context for execution of a
    sub-statement, to keep track of non-transactional changes in a
    sub-statement, we re-use stmt.modified_non_trans_table. 
    At entrance into a sub-statement, a copy of the value of
    stmt.modified_non_trans_table (containing the changes of the
    outer statement) is saved on stack. Then 
    stmt.modified_non_trans_table is reset to FALSE and the
    substatement is executed. Then the new value is merged with the
    saved value.
  */
  bool modified_non_trans_table;
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867

  void reset() { no_2pc= FALSE; modified_non_trans_table= FALSE; }
};


/**
  Either statement transaction or normal transaction - related
  thread-specific storage engine data.

  If a storage engine participates in a statement/transaction,
  an instance of this class is present in
  thd->transaction.{stmt|all}.ha_list. The addition to
  {stmt|all}.ha_list is made by trans_register_ha().

  When it's time to commit or rollback, each element of ha_list
  is used to access storage engine's prepare()/commit()/rollback()
  methods, and also to evaluate if a full two phase commit is
  necessary.

  @sa General description of transaction handling in handler.cc.
*/

class Ha_trx_info
{
public:
  /** Register this storage engine in the given transaction context. */
  void register_ha(THD_TRANS *trans, handlerton *ht_arg)
  {
    DBUG_ASSERT(m_flags == 0);
    DBUG_ASSERT(m_ht == NULL);
    DBUG_ASSERT(m_next == NULL);

    m_ht= ht_arg;
    m_flags= (int) TRX_READ_ONLY; /* Assume read-only at start. */

    m_next= trans->ha_list;
    trans->ha_list= this;
  }

  /** Clear, prepare for reuse. */
  void reset()
  {
    m_next= NULL;
    m_ht= NULL;
    m_flags= 0;
  }

  Ha_trx_info() { reset(); }

  void set_trx_read_write()
  {
    DBUG_ASSERT(is_started());
    m_flags|= (int) TRX_READ_WRITE;
  }
  bool is_trx_read_write() const
  {
    DBUG_ASSERT(is_started());
    return m_flags & (int) TRX_READ_WRITE;
  }
  bool is_started() const { return m_ht != NULL; }
  /** Mark this transaction read-write if the argument is read-write. */
  void coalesce_trx_with(const Ha_trx_info *stmt_trx)
  {
    /*
      Must be called only after the transaction has been started.
      Can be called many times, e.g. when we have many
      read-write statements in a transaction.
    */
    DBUG_ASSERT(is_started());
    if (stmt_trx->is_trx_read_write())
      set_trx_read_write();
  }
  Ha_trx_info *next() const
  {
    DBUG_ASSERT(is_started());
    return m_next;
  }
  handlerton *ht() const
  {
    DBUG_ASSERT(is_started());
    return m_ht;
  }
private:
  enum { TRX_READ_ONLY= 0, TRX_READ_WRITE= 1 };
  /** Auxiliary, used for ha_list management */
  Ha_trx_info *m_next;
  /**
    Although a given Ha_trx_info instance is currently always used
    for the same storage engine, 'ht' is not-NULL only when the
    corresponding storage is a part of a transaction.
  */
  handlerton *m_ht;
  /**
    Transaction flags related to this engine.
    Not-null only if this instance is a part of transaction.
    May assume a combination of enum values above.
  */
  uchar       m_flags;
};

868

unknown's avatar
unknown committed
869 870 871
enum enum_tx_isolation { ISO_READ_UNCOMMITTED, ISO_READ_COMMITTED,
			 ISO_REPEATABLE_READ, ISO_SERIALIZABLE};

872

873 874
enum ndb_distribution { ND_KEYHASH= 0, ND_LINHASH= 1 };

unknown's avatar
unknown committed
875

876 877 878 879 880 881 882
typedef struct {
  ulonglong data_file_length;
  ulonglong max_data_file_length;
  ulonglong index_file_length;
  ulonglong delete_length;
  ha_rows records;
  ulong mean_rec_length;
883 884 885
  ulong create_time;
  ulong check_time;
  ulong update_time;
886 887 888
  ulonglong check_sum;
} PARTITION_INFO;

889 890
#define UNDEF_NODEGROUP 65535
class Item;
unknown's avatar
unknown committed
891
struct st_table_log_memory_entry;
892 893 894

class partition_info;

unknown's avatar
unknown committed
895 896 897
struct st_partition_iter;
#define NOT_A_PARTITION_ID ((uint32)-1)

898 899
enum enum_ha_unused { HA_CHOICE_UNDEF, HA_CHOICE_NO, HA_CHOICE_YES };

unknown's avatar
unknown committed
900 901
typedef struct st_ha_create_information
{
902
  CHARSET_INFO *table_charset, *default_table_charset;
903
  LEX_STRING connect_string;
904
  const char *password, *tablespace;
905
  LEX_STRING comment;
unknown's avatar
unknown committed
906 907
  const char *data_file_name, *index_file_name;
  const char *alias;
908 909 910 911
  ulonglong max_rows,min_rows;
  ulonglong auto_increment_value;
  ulong table_options;
  ulong avg_row_length;
unknown's avatar
unknown committed
912
  ulong used_fields;
913
  ulong key_block_size;
914
  SQL_LIST merge_list;
unknown's avatar
unknown committed
915
  handlerton *db_type;
916
  enum row_type row_type;
917
  uint null_bits;                       /* NULL bits at start of record */
918
  uint options;				/* OR of HA_CREATE_ options */
919
  uint merge_insert_method;
920
  uint extra_size;                      /* length of extra data segment */
921
  enum enum_ha_unused unused1;
922
  bool table_existed;			/* 1 in create if table existed */
923
  bool frm_only;                        /* 1 if no ha_create_table() */
924
  bool varchar;                         /* 1 if table has a VARCHAR */
925
  enum ha_storage_media storage_media;  /* DEFAULT, DISK or MEMORY */
926
  enum enum_ha_unused unused2;
unknown's avatar
unknown committed
927 928
} HA_CREATE_INFO;

929 930 931 932 933 934 935 936 937

typedef struct st_key_create_information
{
  enum ha_key_alg algorithm;
  ulong block_size;
  LEX_STRING parser_name;
} KEY_CREATE_INFO;


938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
/*
  Class for maintaining hooks used inside operations on tables such
  as: create table functions, delete table functions, and alter table
  functions.

  Class is using the Template Method pattern to separate the public
  usage interface from the private inheritance interface.  This
  imposes no overhead, since the public non-virtual function is small
  enough to be inlined.

  The hooks are usually used for functions that does several things,
  e.g., create_table_from_items(), which both create a table and lock
  it.
 */
class TABLEOP_HOOKS
{
public:
955 956 957
  TABLEOP_HOOKS() {}
  virtual ~TABLEOP_HOOKS() {}

958 959 960 961
  inline void prelock(TABLE **tables, uint count)
  {
    do_prelock(tables, count);
  }
unknown's avatar
unknown committed
962

963 964 965 966
  inline int postlock(TABLE **tables, uint count)
  {
    return do_postlock(tables, count);
  }
967 968 969 970 971 972
private:
  /* Function primitive that is called prior to locking tables */
  virtual void do_prelock(TABLE **tables, uint count)
  {
    /* Default is to do nothing */
  }
973 974 975 976 977 978 979 980 981 982 983 984 985

  /**
     Primitive called after tables are locked.

     If an error is returned, the tables will be unlocked and error
     handling start.

     @return Error code or zero.
   */
  virtual int do_postlock(TABLE **tables, uint count)
  {
    return 0;                           /* Default is to do nothing */
  }
986
};
unknown's avatar
unknown committed
987

988 989
typedef struct st_savepoint SAVEPOINT;
extern ulong savepoint_alloc_size;
990
extern KEY_CREATE_INFO default_key_create_info;
991

992
/* Forward declaration for condition pushdown to storage engine */
993
typedef class Item COND;
unknown's avatar
Merge  
unknown committed
994

unknown's avatar
unknown committed
995 996
typedef struct st_ha_check_opt
{
997
  st_ha_check_opt() {}                        /* Remove gcc warning */
unknown's avatar
unknown committed
998
  ulong sort_buffer_size;
unknown's avatar
unknown committed
999 1000
  uint flags;       /* isam layer flags (e.g. for myisamchk) */
  uint sql_flags;   /* sql layer flags - for something myisamchk cannot do */
unknown's avatar
unknown committed
1001
  KEY_CACHE *key_cache;	/* new key cache when changing key cache */
unknown's avatar
unknown committed
1002
  void init();
unknown's avatar
unknown committed
1003 1004
} HA_CHECK_OPT;

1005

1006

unknown's avatar
unknown committed
1007 1008 1009 1010 1011 1012 1013 1014 1015
/*
  This is a buffer area that the handler can use to store rows.
  'end_of_used_area' should be kept updated after calls to
  read-functions so that other parts of the code can use the
  remaining area (until next read calls is issued).
*/

typedef struct st_handler_buffer
{
1016 1017 1018
  const uchar *buffer;         /* Buffer one can start using */
  const uchar *buffer_end;     /* End of buffer */
  uchar *end_of_used_area;     /* End of area that was used by handler */
unknown's avatar
unknown committed
1019 1020
} HANDLER_BUFFER;

1021 1022
typedef struct system_status_var SSV;

1023 1024 1025 1026 1027 1028 1029 1030 1031
class ha_statistics
{
public:
  ulonglong data_file_length;		/* Length off data file */
  ulonglong max_data_file_length;	/* Length off data file */
  ulonglong index_file_length;
  ulonglong max_index_file_length;
  ulonglong delete_length;		/* Free bytes */
  ulonglong auto_increment_value;
1032 1033 1034 1035 1036 1037 1038 1039 1040
  /*
    The number of records in the table. 
      0    - means the table has exactly 0 rows
    other  - if (table_flags() & HA_STATS_RECORDS_IS_EXACT)
               the value is the exact number of records in the table
             else
               it is an estimate
  */
  ha_rows records;
1041 1042
  ha_rows deleted;			/* Deleted records */
  ulong mean_rec_length;		/* physical reclength */
1043 1044 1045
  ulong create_time;			/* When table was created */
  ulong check_time;
  ulong update_time;
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
  uint block_size;			/* index block size */

  ha_statistics():
    data_file_length(0), max_data_file_length(0),
    index_file_length(0), delete_length(0), auto_increment_value(0),
    records(0), deleted(0), mean_rec_length(0), create_time(0),
    check_time(0), update_time(0), block_size(0)
  {}
};

1056
uint calculate_key_len(TABLE *, uint, const uchar *, key_part_map);
1057 1058 1059 1060
/*
  bitmap with first N+1 bits set
  (keypart_map for a key prefix of [0..N] keyparts)
*/
unknown's avatar
unknown committed
1061
#define make_keypart_map(N) (((key_part_map)2 << (N)) - 1)
1062 1063 1064 1065
/*
  bitmap with first N bits set
  (keypart_map for a key prefix of [0..N-1] keyparts)
*/
unknown's avatar
unknown committed
1066
#define make_prev_keypart_map(N) (((key_part_map)1 << (N)) - 1)
1067

1068
/**
1069 1070 1071
  The handler class is the interface for dynamically loadable
  storage engines. Do not add ifdefs and take care when adding or
  changing virtual functions to avoid vtable confusion
1072
*/
1073

unknown's avatar
unknown committed
1074 1075
class handler :public Sql_alloc
{
1076 1077
public:
  typedef ulonglong Table_flags;
1078
protected:
unknown's avatar
unknown committed
1079 1080
  struct st_table_share *table_share;   /* The table definition */
  struct st_table *table;               /* The current open table */
1081
  Table_flags cached_table_flags;       /* Set on init() and open() */
unknown's avatar
unknown committed
1082

1083
  ha_rows estimation_rows_to_insert;
unknown's avatar
unknown committed
1084
public:
1085
  handlerton *ht;                 /* storage engine of this handler */
1086 1087
  uchar *ref;				/* Pointer to current row */
  uchar *dup_ref;			/* Pointer to duplicate row */
1088 1089

  ha_statistics stats;
1090

1091
  /** The following are for read_multi_range */
unknown's avatar
unknown committed
1092 1093 1094 1095 1096
  bool multi_range_sorted;
  KEY_MULTI_RANGE *multi_range_curr;
  KEY_MULTI_RANGE *multi_range_end;
  HANDLER_BUFFER *multi_range_buffer;

1097
  /** The following are for read_range() */
1098 1099 1100
  key_range save_end_range, *end_range;
  KEY_PART_INFO *range_key_part;
  int key_compare_result_on_equal;
unknown's avatar
unknown committed
1101
  bool eq_range;
1102

1103
  uint errkey;				/* Last dup key */
1104
  uint key_used_on_scan;
1105
  uint active_index;
1106
  /** Length of ref (1-8 or the clustered key length) */
1107
  uint ref_length;
unknown's avatar
unknown committed
1108
  FT_INFO *ft_handler;
1109
  enum {NONE=0, INDEX, RND} inited;
1110
  bool locked;
1111
  bool implicit_emptied;                /* Can be !=0 only if HEAP */
1112
  const COND *pushed_cond;
1113
  /**
1114 1115 1116 1117 1118 1119 1120 1121 1122
    next_insert_id is the next value which should be inserted into the
    auto_increment column: in a inserting-multi-row statement (like INSERT
    SELECT), for the first row where the autoinc value is not specified by the
    statement, get_auto_increment() called and asked to generate a value,
    next_insert_id is set to the next value, then for all other rows
    next_insert_id is used (and increased each time) without calling
    get_auto_increment().
  */
  ulonglong next_insert_id;
1123
  /**
1124 1125 1126 1127 1128 1129
    insert id for the current row (*autogenerated*; if not
    autogenerated, it's 0).
    At first successful insertion, this variable is stored into
    THD::first_successful_insert_id_in_cur_stmt.
  */
  ulonglong insert_id_for_cur_row;
1130
  /**
1131 1132 1133 1134
    Interval returned by get_auto_increment() and being consumed by the
    inserter.
  */
  Discrete_interval auto_inc_interval_for_cur_row;
Guilhem Bichot's avatar
Guilhem Bichot committed
1135 1136 1137 1138 1139 1140 1141
  /**
     Number of reserved auto-increment intervals. Serves as a heuristic
     when we have no estimation of how many records the statement will insert:
     the more intervals we have reserved, the bigger the next one. Reset in
     handler::ha_release_auto_increment().
  */
  uint auto_inc_intervals_count;
1142

1143
  handler(handlerton *ht_arg, TABLE_SHARE *share_arg)
unknown's avatar
unknown committed
1144 1145
    :table_share(share_arg), table(0),
    estimation_rows_to_insert(0), ht(ht_arg),
1146 1147
    ref(0), key_used_on_scan(MAX_KEY), active_index(MAX_KEY),
    ref_length(sizeof(my_off_t)),
1148
    ft_handler(0), inited(NONE),
1149
    locked(FALSE), implicit_emptied(0),
Guilhem Bichot's avatar
Guilhem Bichot committed
1150 1151
    pushed_cond(0), next_insert_id(0), insert_id_for_cur_row(0),
    auto_inc_intervals_count(0)
unknown's avatar
unknown committed
1152
    {}
1153 1154
  virtual ~handler(void)
  {
1155
    DBUG_ASSERT(locked == FALSE);
1156 1157
    /* TODO: DBUG_ASSERT(inited == NONE); */
  }
unknown's avatar
unknown committed
1158
  virtual handler *clone(MEM_ROOT *mem_root);
1159
  /** This is called after create to allow us to set up cached variables */
1160 1161 1162 1163
  void init()
  {
    cached_table_flags= table_flags();
  }
1164 1165
  /* ha_ methods: pubilc wrappers for private virtual API */

unknown's avatar
unknown committed
1166
  int ha_open(TABLE *table, const char *name, int mode, int test_if_locked);
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
  int ha_index_init(uint idx, bool sorted)
  {
    int result;
    DBUG_ENTER("ha_index_init");
    DBUG_ASSERT(inited==NONE);
    if (!(result= index_init(idx, sorted)))
      inited=INDEX;
    DBUG_RETURN(result);
  }
  int ha_index_end()
  {
    DBUG_ENTER("ha_index_end");
    DBUG_ASSERT(inited==INDEX);
    inited=NONE;
    DBUG_RETURN(index_end());
  }
  int ha_rnd_init(bool scan)
  {
    int result;
    DBUG_ENTER("ha_rnd_init");
    DBUG_ASSERT(inited==NONE || (inited==RND && scan));
    inited= (result= rnd_init(scan)) ? NONE: RND;
    DBUG_RETURN(result);
  }
  int ha_rnd_end()
  {
    DBUG_ENTER("ha_rnd_end");
    DBUG_ASSERT(inited==RND);
    inited=NONE;
    DBUG_RETURN(rnd_end());
  }
  int ha_reset();
  /* this is necessary in many places, e.g. in HANDLER command */
  int ha_index_or_rnd_end()
  {
    return inited == INDEX ? ha_index_end() : inited == RND ? ha_rnd_end() : 0;
  }
1204 1205 1206
  /**
    The cached_table_flags is set at ha_open and ha_external_lock
  */
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
  Table_flags ha_table_flags() const { return cached_table_flags; }
  /**
    These functions represent the public interface to *users* of the
    handler class, hence they are *not* virtual. For the inheritance
    interface, see the (private) functions write_row(), update_row(),
    and delete_row() below.
  */
  int ha_external_lock(THD *thd, int lock_type);
  int ha_write_row(uchar * buf);
  int ha_update_row(const uchar * old_data, uchar * new_data);
  int ha_delete_row(const uchar * buf);
  void ha_release_auto_increment();

1220
  int check_collation_compatibility();
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
  int ha_check_for_upgrade(HA_CHECK_OPT *check_opt);
  /** to be actually called to get 'check()' functionality*/
  int ha_check(THD *thd, HA_CHECK_OPT *check_opt);
  int ha_repair(THD* thd, HA_CHECK_OPT* check_opt);
  void ha_start_bulk_insert(ha_rows rows)
  {
    estimation_rows_to_insert= rows;
    start_bulk_insert(rows);
  }
  int ha_end_bulk_insert()
  {
    estimation_rows_to_insert= 0;
    return end_bulk_insert();
  }
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
  int ha_bulk_update_row(const uchar *old_data, uchar *new_data,
                         uint *dup_key_found);
  int ha_delete_all_rows();
  int ha_reset_auto_increment(ulonglong value);
  int ha_backup(THD* thd, HA_CHECK_OPT* check_opt);
  int ha_restore(THD* thd, HA_CHECK_OPT* check_opt);
  int ha_optimize(THD* thd, HA_CHECK_OPT* check_opt);
  int ha_analyze(THD* thd, HA_CHECK_OPT* check_opt);
  bool ha_check_and_repair(THD *thd);
  int ha_disable_indexes(uint mode);
  int ha_enable_indexes(uint mode);
  int ha_discard_or_import_tablespace(my_bool discard);
  void ha_prepare_for_alter();
  int ha_rename_table(const char *from, const char *to);
  int ha_delete_table(const char *name);
  void ha_drop_table(const char *name);

  int ha_create(const char *name, TABLE *form, HA_CREATE_INFO *info);

  int ha_create_handler_files(const char *name, const char *old_name,
                              int action_flag, HA_CREATE_INFO *info);

  int ha_change_partitions(HA_CREATE_INFO *create_info,
                           const char *path,
1259 1260
                           ulonglong * const copied,
                           ulonglong * const deleted,
1261 1262 1263 1264
                           const uchar *pack_frm_data,
                           size_t pack_frm_len);
  int ha_drop_partitions(const char *path);
  int ha_rename_partitions(const char *path);
1265

1266
  void adjust_next_insert_id_after_explicit_value(ulonglong nr);
unknown's avatar
unknown committed
1267
  int update_auto_increment();
1268
  void print_keydup_error(uint key_nr, const char *msg);
unknown's avatar
unknown committed
1269
  virtual void print_error(int error, myf errflag);
1270
  virtual bool get_error_message(int error, String *buf);
unknown's avatar
unknown committed
1271
  uint get_dup_key(int error);
1272
  virtual void change_table_ptr(TABLE *table_arg, TABLE_SHARE *share)
unknown's avatar
unknown committed
1273 1274 1275 1276
  {
    table= table_arg;
    table_share= share;
  }
unknown's avatar
unknown committed
1277
  virtual double scan_time()
1278
  { return ulonglong2double(stats.data_file_length) / IO_SIZE + 2; }
unknown's avatar
unknown committed
1279
  virtual double read_time(uint index, uint ranges, ha_rows rows)
1280
  { return rows2double(ranges+rows); }
unknown's avatar
unknown committed
1281
  virtual const key_map *keys_to_use_for_scanning() { return &key_map_empty; }
1282 1283
  bool has_transactions()
  { return (ha_table_flags() & HA_NO_TRANSACTIONS) == 0; }
1284
  virtual uint extra_rec_buf_length() const { return 0; }
1285

1286
  /**
1287 1288 1289 1290 1291
    This method is used to analyse the error to see whether the error
    is ignorable or not, certain handlers can have more error that are
    ignorable than others. E.g. the partition handler can get inserts
    into a range where there is no partition and this is an ignorable
    error.
1292 1293
    HA_ERR_FOUND_DUP_UNIQUE is a special case in MyISAM that means the
    same thing as HA_ERR_FOUND_DUP_KEY but can in some cases lead to
1294
    a slightly different error message.
1295
  */
1296
  virtual bool is_fatal_error(int error, uint flags)
1297 1298
  {
    if (!error ||
1299
        ((flags & HA_CHECK_DUP_KEY) &&
1300 1301
         (error == HA_ERR_FOUND_DUPP_KEY ||
          error == HA_ERR_FOUND_DUPP_UNIQUE)))
1302 1303 1304 1305
      return FALSE;
    return TRUE;
  }

1306
  /**
1307 1308 1309 1310
    Number of rows in table. It will only be called if
    (table_flags() & (HA_HAS_RECORDS | HA_STATS_RECORDS_IS_EXACT)) != 0
  */
  virtual ha_rows records() { return stats.records; }
1311
  /**
unknown's avatar
unknown committed
1312 1313 1314 1315 1316 1317
    Return upper bound of current number of records in the table
    (max. of how many records one will retrieve when doing a full table scan)
    If upper bound is not known, HA_POS_ERROR should be returned as a max
    possible upper bound.
  */
  virtual ha_rows estimate_rows_upper_bound()
1318
  { return stats.records+EXTRA_RECORDS; }
unknown's avatar
unknown committed
1319

1320
  /**
1321 1322 1323 1324 1325
    Get the row type from the storage engine.  If this method returns
    ROW_TYPE_NOT_USED, the information in HA_CREATE_INFO should be used.
  */
  virtual enum row_type get_row_type() const { return ROW_TYPE_NOT_USED; }

unknown's avatar
unknown committed
1326 1327
  virtual const char *index_type(uint key_number) { DBUG_ASSERT(0); return "";}

1328

1329
  /**
1330 1331 1332 1333 1334
    Signal that the table->read_set and table->write_set table maps changed
    The handler is allowed to set additional bits in the above map in this
    call. Normally the handler should ignore all calls until we have done
    a ha_rnd_init() or ha_index_init(), write_row(), update_row or delete_row()
    as there may be several calls to this routine.
1335
  */
1336
  virtual void column_bitmaps_signal();
unknown's avatar
unknown committed
1337 1338
  uint get_index(void) const { return active_index; }
  virtual int close(void)=0;
1339

1340 1341 1342
  /**
    @retval  0   Bulk update used by handler
    @retval  1   Bulk update not used, normal operation used
unknown's avatar
unknown committed
1343 1344
  */
  virtual bool start_bulk_update() { return 1; }
1345 1346 1347
  /**
    @retval  0   Bulk delete used by handler
    @retval  1   Bulk delete not used, normal operation used
unknown's avatar
unknown committed
1348 1349
  */
  virtual bool start_bulk_delete() { return 1; }
1350
  /**
unknown's avatar
unknown committed
1351 1352 1353 1354 1355
    After this call all outstanding updates must be performed. The number
    of duplicate key errors are reported in the duplicate key parameter.
    It is allowed to continue to the batched update after this call, the
    handler has to wait until end_bulk_update with changing state.

1356 1357 1358 1359
    @param    dup_key_found       Number of duplicate keys found

    @retval  0           Success
    @retval  >0          Error code
unknown's avatar
unknown committed
1360
  */
unknown's avatar
unknown committed
1361 1362 1363 1364 1365
  virtual int exec_bulk_update(uint *dup_key_found)
  {
    DBUG_ASSERT(FALSE);
    return HA_ERR_WRONG_COMMAND;
  }
1366
  /**
unknown's avatar
unknown committed
1367 1368 1369
    Perform any needed clean-up, no outstanding updates are there at the
    moment.
  */
unknown's avatar
unknown committed
1370
  virtual void end_bulk_update() { return; }
1371
  /**
unknown's avatar
unknown committed
1372 1373
    Execute all outstanding deletes and close down the bulk delete.

1374 1375
    @retval 0             Success
    @retval >0            Error code
unknown's avatar
unknown committed
1376
  */
unknown's avatar
unknown committed
1377 1378 1379 1380 1381
  virtual int end_bulk_delete()
  {
    DBUG_ASSERT(FALSE);
    return HA_ERR_WRONG_COMMAND;
  }
1382 1383 1384 1385 1386 1387 1388
  /**
     @brief
     Positions an index cursor to the index specified in the handle. Fetches the
     row if available. If the key value is null, begin at the first key of the
     index.
  */
  virtual int index_read_map(uchar * buf, const uchar * key,
unknown's avatar
unknown committed
1389
                             key_part_map keypart_map,
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
                             enum ha_rkey_function find_flag)
  {
    uint key_len= calculate_key_len(table, active_index, key, keypart_map);
    return  index_read(buf, key, key_len, find_flag);
  }
  /**
     @brief
     Positions an index cursor to the index specified in the handle. Fetches the
     row if available. If the key value is null, begin at the first key of the
     index.
  */
  virtual int index_read_idx_map(uchar * buf, uint index, const uchar * key,
                                 key_part_map keypart_map,
                                 enum ha_rkey_function find_flag);
1404
  virtual int index_next(uchar * buf)
unknown's avatar
unknown committed
1405
   { return  HA_ERR_WRONG_COMMAND; }
1406
  virtual int index_prev(uchar * buf)
unknown's avatar
unknown committed
1407
   { return  HA_ERR_WRONG_COMMAND; }
1408
  virtual int index_first(uchar * buf)
unknown's avatar
unknown committed
1409
   { return  HA_ERR_WRONG_COMMAND; }
1410
  virtual int index_last(uchar * buf)
unknown's avatar
unknown committed
1411
   { return  HA_ERR_WRONG_COMMAND; }
1412
  virtual int index_next_same(uchar *buf, const uchar *key, uint keylen);
1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
  /**
     @brief
     The following functions works like index_read, but it find the last
     row with the current key value or prefix.
  */
  virtual int index_read_last_map(uchar * buf, const uchar * key,
                                  key_part_map keypart_map)
  {
    uint key_len= calculate_key_len(table, active_index, key, keypart_map);
    return index_read_last(buf, key, key_len);
  }
unknown's avatar
unknown committed
1424 1425 1426 1427
  virtual int read_multi_range_first(KEY_MULTI_RANGE **found_range_p,
                                     KEY_MULTI_RANGE *ranges, uint range_count,
                                     bool sorted, HANDLER_BUFFER *buffer);
  virtual int read_multi_range_next(KEY_MULTI_RANGE **found_range_p);
1428
  virtual int read_range_first(const key_range *start_key,
unknown's avatar
unknown committed
1429 1430 1431
                               const key_range *end_key,
                               bool eq_range, bool sorted);
  virtual int read_range_next();
1432
  int compare_key(key_range *range);
unknown's avatar
unknown committed
1433
  virtual int ft_init() { return HA_ERR_WRONG_COMMAND; }
1434
  void ft_end() { ft_handler=NULL; }
1435
  virtual FT_INFO *ft_init_ext(uint flags, uint inx,String *key)
unknown's avatar
unknown committed
1436
    { return NULL; }
1437 1438 1439
  virtual int ft_read(uchar *buf) { return HA_ERR_WRONG_COMMAND; }
  virtual int rnd_next(uchar *buf)=0;
  virtual int rnd_pos(uchar * buf, uchar *pos)=0;
1440 1441
  /**
    One has to use this method when to find
1442 1443
    random position by record as the plain
    position() call doesn't work for some
1444
    handlers for random position.
1445 1446 1447 1448 1449 1450
  */
  virtual int rnd_pos_by_record(uchar *record)
    {
      position(record);
      return rnd_pos(record, ref);
    }
1451
  virtual int read_first_row(uchar *buf, uint primary_key);
1452
  /**
unknown's avatar
unknown committed
1453
    The following function is only needed for tables that may be temporary
1454
    tables during joins.
unknown's avatar
unknown committed
1455
  */
1456
  virtual int restart_rnd_next(uchar *buf, uchar *pos)
unknown's avatar
unknown committed
1457
    { return HA_ERR_WRONG_COMMAND; }
1458
  virtual int rnd_same(uchar *buf, uint inx)
unknown's avatar
unknown committed
1459
    { return HA_ERR_WRONG_COMMAND; }
1460
  virtual ha_rows records_in_range(uint inx, key_range *min_key, key_range *max_key)
unknown's avatar
unknown committed
1461
    { return (ha_rows) 10; }
1462
  virtual void position(const uchar *record)=0;
1463
  virtual int info(uint)=0; // see my_base.h for full description
1464 1465
  virtual void get_dynamic_partition_info(PARTITION_INFO *stat_info,
                                          uint part_id);
unknown's avatar
unknown committed
1466 1467
  virtual int extra(enum ha_extra_function operation)
  { return 0; }
unknown's avatar
unknown committed
1468
  virtual int extra_opt(enum ha_extra_function operation, ulong cache_size)
unknown's avatar
unknown committed
1469
  { return extra(operation); }
1470

1471
  /**
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483
    In an UPDATE or DELETE, if the row under the cursor was locked by another
    transaction, and the engine used an optimistic read of the last
    committed row value under the cursor, then the engine returns 1 from this
    function. MySQL must NOT try to update this optimistic value. If the
    optimistic value does not match the WHERE condition, MySQL can decide to
    skip over this row. Currently only works for InnoDB. This can be used to
    avoid unnecessary lock waits.

    If this method returns nonzero, it will also signal the storage
    engine that the next read will be a locking re-read of the row.
  */
  virtual bool was_semi_consistent_read() { return 0; }
1484
  /**
1485 1486 1487 1488 1489 1490
    Tell the engine whether it should avoid unnecessary lock waits.
    If yes, in an UPDATE or DELETE, if the row under the cursor was locked
    by another transaction, the engine may try an optimistic read of
    the last committed row value under the cursor.
  */
  virtual void try_semi_consistent_read(bool) {}
unknown's avatar
unknown committed
1491
  virtual void unlock_row() {}
unknown's avatar
unknown committed
1492
  virtual int start_stmt(THD *thd, thr_lock_type lock_type) {return 0;}
1493 1494 1495 1496
  virtual void get_auto_increment(ulonglong offset, ulonglong increment,
                                  ulonglong nb_desired_values,
                                  ulonglong *first_value,
                                  ulonglong *nb_reserved_values);
1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516
  void set_next_insert_id(ulonglong id)
  {
    DBUG_PRINT("info",("auto_increment: next value %lu", (ulong)id));
    next_insert_id= id;
  }
  void restore_auto_increment(ulonglong prev_insert_id)
  {
    /*
      Insertion of a row failed, re-use the lastly generated auto_increment
      id, for the next row. This is achieved by resetting next_insert_id to
      what it was before the failed insertion (that old value is provided by
      the caller). If that value was 0, it was the first row of the INSERT;
      then if insert_id_for_cur_row contains 0 it means no id was generated
      for this first row, so no id was generated since the INSERT started, so
      we should set next_insert_id to 0; if insert_id_for_cur_row is not 0, it
      is the generated id of the first and failed row, so we use it.
    */
    next_insert_id= (prev_insert_id > 0) ? prev_insert_id :
      insert_id_for_cur_row;
  }
1517

unknown's avatar
unknown committed
1518
  virtual void update_create_info(HA_CREATE_INFO *create_info) {}
unknown's avatar
unknown committed
1519
  int check_old_types();
unknown's avatar
unknown committed
1520 1521 1522 1523 1524 1525 1526
  virtual int assign_to_keycache(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
  virtual int preload_keys(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
  /* end of the list of admin commands */

  virtual int dump(THD* thd, int fd = -1) { return HA_ERR_WRONG_COMMAND; }
1527
  virtual int indexes_are_disabled(void) {return 0;}
unknown's avatar
unknown committed
1528
  virtual int net_read_dump(NET* net) { return HA_ERR_WRONG_COMMAND; }
1529 1530 1531
  virtual char *update_table_comment(const char * comment)
  { return (char*) comment;}
  virtual void append_create_info(String *packet) {}
1532 1533 1534 1535 1536 1537 1538 1539 1540
  /**
    If index == MAX_KEY then a check for table is made and if index <
    MAX_KEY then a check is made if the table has foreign keys and if
    a foreign key uses this index (and thus the index cannot be dropped).

    @param  index            Index to check if foreign key uses it

    @retval   TRUE            Foreign key defined on table or index
    @retval   FALSE           No foreign key defined
unknown's avatar
unknown committed
1541 1542 1543
  */
  virtual bool is_fk_defined_on_table_or_index(uint index)
  { return FALSE; }
1544 1545
  virtual char* get_foreign_key_create_info()
  { return(NULL);}  /* gets foreign key create string from InnoDB */
1546
  virtual char* get_tablespace_name(THD *thd, char *name, uint name_len)
1547
  { return(NULL);}  /* gets tablespace name from handler */
1548
  /** used in ALTER TABLE; 1 if changing storage engine is allowed */
1549
  virtual bool can_switch_engines() { return 1; }
1550
  /** used in REPLACE; is > 0 if table is referred by a FOREIGN KEY */
1551 1552
  virtual int get_foreign_key_list(THD *thd, List<FOREIGN_KEY_INFO> *f_key_list)
  { return 0; }
unknown's avatar
unknown committed
1553
  virtual uint referenced_by_foreign_key() { return 0;}
unknown's avatar
unknown committed
1554
  virtual void init_table_handle_for_HANDLER()
unknown's avatar
unknown committed
1555 1556
  { return; }       /* prepare InnoDB for HANDLER */
  virtual void free_foreign_key_create_info(char* str) {}
1557
  /** The following can be called without an open handler */
unknown's avatar
unknown committed
1558
  virtual const char *table_type() const =0;
1559
  /**
1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
    If frm_error() is called then we will use this to find out what file
    extentions exist for the storage engine. This is also used by the default
    rename_table and delete_table method in handler.cc.

    For engines that have two file name extentions (separate meta/index file
    and data file), the order of elements is relevant. First element of engine
    file name extentions array should be meta/index file extention. Second
    element - data file extention. This order is assumed by
    prepare_for_repair() when REPAIR TABLE ... USE_FRM is issued.
  */
unknown's avatar
unknown committed
1570
  virtual const char **bas_ext() const =0;
1571

1572
  virtual int get_default_no_partitions(HA_CREATE_INFO *info) { return 1;}
unknown's avatar
unknown committed
1573 1574 1575 1576 1577 1578 1579 1580
  virtual void set_auto_partitions(partition_info *part_info) { return; }
  virtual bool get_no_parts(const char *name,
                            uint *no_parts)
  {
    *no_parts= 0;
    return 0;
  }
  virtual void set_part_info(partition_info *part_info) {return;}
1581

1582
  virtual ulong index_flags(uint idx, uint part, bool all_parts) const =0;
1583

1584
  virtual int add_index(TABLE *table_arg, KEY *key_info, uint num_of_keys)
unknown's avatar
unknown committed
1585
  { return (HA_ERR_WRONG_COMMAND); }
1586 1587 1588 1589
  virtual int prepare_drop_index(TABLE *table_arg, uint *key_num,
                                 uint num_of_keys)
  { return (HA_ERR_WRONG_COMMAND); }
  virtual int final_drop_index(TABLE *table_arg)
unknown's avatar
unknown committed
1590 1591 1592 1593 1594 1595 1596 1597 1598 1599
  { return (HA_ERR_WRONG_COMMAND); }

  uint max_record_length() const
  { return min(HA_MAX_REC_LENGTH, max_supported_record_length()); }
  uint max_keys() const
  { return min(MAX_KEY, max_supported_keys()); }
  uint max_key_parts() const
  { return min(MAX_REF_PARTS, max_supported_key_parts()); }
  uint max_key_length() const
  { return min(MAX_KEY_LENGTH, max_supported_key_length()); }
unknown's avatar
unknown committed
1600
  uint max_key_part_length() const
unknown's avatar
unknown committed
1601 1602 1603 1604 1605 1606
  { return min(MAX_KEY_LENGTH, max_supported_key_part_length()); }

  virtual uint max_supported_record_length() const { return HA_MAX_REC_LENGTH; }
  virtual uint max_supported_keys() const { return 0; }
  virtual uint max_supported_key_parts() const { return MAX_REF_PARTS; }
  virtual uint max_supported_key_length() const { return MAX_KEY_LENGTH; }
1607
  virtual uint max_supported_key_part_length() const { return 255; }
unknown's avatar
unknown committed
1608
  virtual uint min_record_length(uint options) const { return 1; }
unknown's avatar
unknown committed
1609

unknown's avatar
unknown committed
1610
  virtual bool low_byte_first() const { return 1; }
unknown's avatar
unknown committed
1611
  virtual uint checksum() const { return 0; }
1612 1613
  virtual bool is_crashed() const  { return 0; }
  virtual bool auto_repair() const { return 0; }
unknown's avatar
unknown committed
1614

1615

1616
#define CHF_CREATE_FLAG 0
1617 1618
#define CHF_DELETE_FLAG 1
#define CHF_RENAME_FLAG 2
1619
#define CHF_INDEX_FLAG  3
1620

unknown's avatar
unknown committed
1621

1622 1623 1624
  /**
    @note lock_count() can return > 1 if the table is MERGE or partitioned.
  */
unknown's avatar
unknown committed
1625
  virtual uint lock_count(void) const { return 1; }
1626 1627
  /**
    Is not invoked for non-transactional temporary tables.
1628

1629 1630 1631
    @note store_lock() can return more than one lock if the table is MERGE
    or partitioned.

1632
    @note that one can NOT rely on table->in_use in store_lock().  It may
unknown's avatar
unknown committed
1633
    refer to a different thread if called from mysql_lock_abort_for_thread().
1634 1635 1636 1637

    @note If the table is MERGE, store_lock() can return less locks
    than lock_count() claimed. This can happen when the MERGE children
    are not attached when this is called from another thread.
unknown's avatar
unknown committed
1638
  */
unknown's avatar
unknown committed
1639 1640 1641
  virtual THR_LOCK_DATA **store_lock(THD *thd,
				     THR_LOCK_DATA **to,
				     enum thr_lock_type lock_type)=0;
1642

1643
  /** Type of table for caching query */
1644
  virtual uint8 table_cache_type() { return HA_CACHE_TBL_NONTRANSACT; }
1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676


  /**
    @brief Register a named table with a call back function to the query cache.

    @param thd The thread handle
    @param table_key A pointer to the table name in the table cache
    @param key_length The length of the table name
    @param[out] engine_callback The pointer to the storage engine call back
      function
    @param[out] engine_data Storage engine specific data which could be
      anything

    This method offers the storage engine, the possibility to store a reference
    to a table name which is going to be used with query cache. 
    The method is called each time a statement is written to the cache and can
    be used to verify if a specific statement is cachable. It also offers
    the possibility to register a generic (but static) call back function which
    is called each time a statement is matched against the query cache.

    @note If engine_data supplied with this function is different from
      engine_data supplied with the callback function, and the callback returns
      FALSE, a table invalidation on the current table will occur.

    @return Upon success the engine_callback will point to the storage engine
      call back function, if any, and engine_data will point to any storage
      engine data used in the specific implementation.
      @retval TRUE Success
      @retval FALSE The specified table or current statement should not be
        cached
  */

1677
  virtual my_bool register_query_cache_table(THD *thd, char *table_key,
1678 1679 1680 1681
                                             uint key_length,
                                             qc_engine_callback
                                             *engine_callback,
                                             ulonglong *engine_data)
unknown's avatar
unknown committed
1682 1683
  {
    *engine_callback= 0;
1684
    return TRUE;
unknown's avatar
unknown committed
1685
  }
1686 1687


unknown's avatar
unknown committed
1688
 /*
1689 1690 1691
   @retval TRUE   Primary key (if there is one) is clustered
                  key covering all fields
   @retval FALSE  otherwise
unknown's avatar
unknown committed
1692 1693
 */
 virtual bool primary_key_is_clustered() { return FALSE; }
1694
 virtual int cmp_ref(const uchar *ref1, const uchar *ref2)
unknown's avatar
unknown committed
1695 1696 1697
 {
   return memcmp(ref1, ref2, ref_length);
 }
1698

unknown's avatar
Merge  
unknown committed
1699 1700 1701
 /*
   Condition pushdown to storage engines
 */
1702

1703
 /**
1704
   Push condition down to the table handler.
1705

1706 1707 1708 1709
   @param  cond   Condition to be pushed. The condition tree must not be
                  modified by the by the caller.

   @return
1710 1711 1712
     The 'remainder' condition that caller must use to filter out records.
     NULL means the handler will not return rows that do not match the
     passed condition.
1713

1714
   @note
1715 1716 1717 1718 1719
   The pushed conditions form a stack (from which one can remove the
   last pushed condition using cond_pop).
   The table handler filters out rows using (pushed_cond1 AND pushed_cond2 
   AND ... AND pushed_condN)
   or less restrictive condition, depending on handler's capabilities.
1720

1721
   handler->ha_reset() call empties the condition stack.
1722 1723 1724
   Calls to rnd_init/rnd_end, index_init/index_end etc do not affect the
   condition stack.
 */ 
unknown's avatar
Merge  
unknown committed
1725
 virtual const COND *cond_push(const COND *cond) { return cond; };
1726
 /**
1727
   Pop the top condition from the condition stack of the handler instance.
1728 1729

   Pops the top if condition stack, if stack is not empty.
1730
 */
unknown's avatar
Merge  
unknown committed
1731
 virtual void cond_pop() { return; };
unknown's avatar
unknown committed
1732 1733 1734
 virtual bool check_if_incompatible_data(HA_CREATE_INFO *create_info,
					 uint table_changes)
 { return COMPATIBLE_DATA_NO; }
1735

1736
  /**
1737 1738 1739 1740 1741
    use_hidden_primary_key() is called in case of an update/delete when
    (table_flags() and HA_PRIMARY_KEY_REQUIRED_FOR_DELETE) is defined
    but we don't have a primary key
  */
  virtual void use_hidden_primary_key();
1742 1743 1744 1745 1746
  virtual uint alter_table_flags(uint flags)
  {
    if (ht->alter_table_flags)
      return ht->alter_table_flags(flags);
    return 0;
1747
  }
1748

1749 1750 1751 1752 1753
protected:
  /* Service methods for use by storage engines. */
  void ha_statistic_increment(ulong SSV::*offset) const;
  void **ha_data(THD *) const;
  THD *ha_thd(void) const;
1754 1755 1756 1757 1758 1759 1760 1761 1762

  /**
    Default rename_table() and delete_table() rename/delete files with a
    given name and extensions from bas_ext().

    These methods can be overridden, but their default implementation
    provide useful functionality.
  */
  virtual int rename_table(const char *from, const char *to);
1763 1764 1765 1766
  /**
    Delete a table in the engine. Called for base as well as temporary
    tables.
  */
1767
  virtual int delete_table(const char *name);
1768 1769 1770
private:
  /* Private helpers */
  inline void mark_trx_read_write();
1771 1772
private:
  /*
1773
    Low-level primitives for storage engines.  These should be
1774 1775 1776
    overridden by the storage engine class. To call these methods, use
    the corresponding 'ha_*' method above.
  */
1777

1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789
  virtual int open(const char *name, int mode, uint test_if_locked)=0;
  virtual int index_init(uint idx, bool sorted) { active_index= idx; return 0; }
  virtual int index_end() { active_index= MAX_KEY; return 0; }
  /**
    rnd_init() can be called two times without rnd_end() in between
    (it only makes sense if scan=1).
    then the second call should prepare for the new table scan (e.g
    if rnd_init allocates the cursor, second call should position it
    to the start of the table, no need to deallocate and allocate it again
  */
  virtual int rnd_init(bool scan)= 0;
  virtual int rnd_end() { return 0; }
1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804
  virtual int write_row(uchar *buf __attribute__((unused)))
  {
    return HA_ERR_WRONG_COMMAND;
  }

  virtual int update_row(const uchar *old_data __attribute__((unused)),
                         uchar *new_data __attribute__((unused)))
  {
    return HA_ERR_WRONG_COMMAND;
  }

  virtual int delete_row(const uchar *buf __attribute__((unused)))
  {
    return HA_ERR_WRONG_COMMAND;
  }
1805 1806 1807 1808 1809 1810 1811
  /**
    Reset state of file to after 'open'.
    This function is called after every statement for all tables used
    by that statement.
  */
  virtual int reset() { return 0; }
  virtual Table_flags table_flags(void) const= 0;
1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833
  /**
    Is not invoked for non-transactional temporary tables.

    Tells the storage engine that we intend to read or write data
    from the table. This call is prefixed with a call to handler::store_lock()
    and is invoked only for those handler instances that stored the lock.

    Calls to rnd_init/index_init are prefixed with this call. When table
    IO is complete, we call external_lock(F_UNLCK).
    A storage engine writer should expect that each call to
    ::external_lock(F_[RD|WR]LOCK is followed by a call to
    ::external_lock(F_UNLCK). If it is not, it is a bug in MySQL.

    The name and signature originate from the first implementation
    in MyISAM, which would call fcntl to set/clear an advisory
    lock on the data file in this method.

    @param   lock_type    F_RDLCK, F_WRLCK, F_UNLCK

    @return  non-0 in case of failure, 0 in case of success.
    When lock_type is F_UNLCK, the return value is ignored.
  */
1834 1835 1836 1837 1838
  virtual int external_lock(THD *thd __attribute__((unused)),
                            int lock_type __attribute__((unused)))
  {
    return 0;
  }
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859
  virtual void release_auto_increment() { return; };
  /** admin commands - called from mysql_admin_table */
  virtual int check_for_upgrade(HA_CHECK_OPT *check_opt)
  { return 0; }
  virtual int check(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }

  /**
     In this method check_opt can be modified
     to specify CHECK option to use to call check()
     upon the table.
  */
  virtual int repair(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
  virtual void start_bulk_insert(ha_rows rows) {}
  virtual int end_bulk_insert() { return 0; }
  virtual int index_read(uchar * buf, const uchar * key, uint key_len,
                         enum ha_rkey_function find_flag)
   { return  HA_ERR_WRONG_COMMAND; }
  virtual int index_read_last(uchar * buf, const uchar * key, uint key_len)
   { return (my_errno= HA_ERR_WRONG_COMMAND); }
1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882
  /**
    This method is similar to update_row, however the handler doesn't need
    to execute the updates at this point in time. The handler can be certain
    that another call to bulk_update_row will occur OR a call to
    exec_bulk_update before the set of updates in this query is concluded.

    @param    old_data       Old record
    @param    new_data       New record
    @param    dup_key_found  Number of duplicate keys found

    @retval  0   Bulk delete used by handler
    @retval  1   Bulk delete not used, normal operation used
  */
  virtual int bulk_update_row(const uchar *old_data, uchar *new_data,
                              uint *dup_key_found)
  {
    DBUG_ASSERT(FALSE);
    return HA_ERR_WRONG_COMMAND;
  }
  /**
    This is called to delete all rows in a table
    If the handler don't support this, then this function will
    return HA_ERR_WRONG_COMMAND and MySQL will delete the rows one
1883 1884
    by one. It should reset auto_increment if
    thd->lex->sql_command == SQLCOM_TRUNCATE.
1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907
  */
  virtual int delete_all_rows()
  { return (my_errno=HA_ERR_WRONG_COMMAND); }
  /**
    Reset the auto-increment counter to the given value, i.e. the next row
    inserted will get the given value. This is called e.g. after TRUNCATE
    is emulated by doing a 'DELETE FROM t'. HA_ERR_WRONG_COMMAND is
    returned by storage engines that don't support this operation.
  */
  virtual int reset_auto_increment(ulonglong value)
  { return HA_ERR_WRONG_COMMAND; }
  virtual int backup(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
  /**
    Restore assumes .frm file must exist, and that generate_table() has been
    called; It will just copy the data file and run repair.
  */
  virtual int restore(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
  virtual int optimize(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
  virtual int analyze(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
unknown's avatar
unknown committed
1908
  virtual bool check_and_repair(THD *thd) { return TRUE; }
1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922
  virtual int disable_indexes(uint mode) { return HA_ERR_WRONG_COMMAND; }
  virtual int enable_indexes(uint mode) { return HA_ERR_WRONG_COMMAND; }
  virtual int discard_or_import_tablespace(my_bool discard)
  { return (my_errno=HA_ERR_WRONG_COMMAND); }
  virtual void prepare_for_alter() { return; }
  virtual void drop_table(const char *name);
  virtual int create(const char *name, TABLE *form, HA_CREATE_INFO *info)=0;

  virtual int create_handler_files(const char *name, const char *old_name,
                                   int action_flag, HA_CREATE_INFO *info)
  { return FALSE; }

  virtual int change_partitions(HA_CREATE_INFO *create_info,
                                const char *path,
1923 1924
                                ulonglong * const copied,
                                ulonglong * const deleted,
1925 1926 1927 1928 1929 1930 1931
                                const uchar *pack_frm_data,
                                size_t pack_frm_len)
  { return HA_ERR_WRONG_COMMAND; }
  virtual int drop_partitions(const char *path)
  { return HA_ERR_WRONG_COMMAND; }
  virtual int rename_partitions(const char *path)
  { return HA_ERR_WRONG_COMMAND; }
unknown's avatar
unknown committed
1932 1933
};

1934

unknown's avatar
unknown committed
1935 1936 1937
	/* Some extern variables used with handlers */

extern const char *ha_row_type[];
1938 1939
extern const char *tx_isolation_names[];
extern const char *binlog_format_names[];
1940
extern TYPELIB tx_isolation_typelib;
1941
extern TYPELIB myisam_stats_method_typelib;
1942
extern ulong total_ha, total_ha_2pc;
unknown's avatar
unknown committed
1943

1944
       /* Wrapper functions */
1945 1946
#define ha_commit(thd) (ha_commit_trans((thd), TRUE))
#define ha_rollback(thd) (ha_rollback_trans((thd), TRUE))
1947

1948
/* lookups */
unknown's avatar
unknown committed
1949
handlerton *ha_default_handlerton(THD *thd);
unknown's avatar
unknown committed
1950 1951
plugin_ref ha_resolve_by_name(THD *thd, const LEX_STRING *name);
plugin_ref ha_lock_engine(THD *thd, handlerton *hton);
unknown's avatar
unknown committed
1952
handlerton *ha_resolve_by_legacy_type(THD *thd, enum legacy_db_type db_type);
unknown's avatar
unknown committed
1953
handler *get_new_handler(TABLE_SHARE *share, MEM_ROOT *alloc,
unknown's avatar
unknown committed
1954 1955
                         handlerton *db_type);
handlerton *ha_checktype(THD *thd, enum legacy_db_type database_type,
1956
                          bool no_substitute, bool report_error);
unknown's avatar
unknown committed
1957 1958


unknown's avatar
unknown committed
1959
static inline enum legacy_db_type ha_legacy_type(const handlerton *db_type)
unknown's avatar
unknown committed
1960 1961 1962 1963
{
  return (db_type == NULL) ? DB_TYPE_UNKNOWN : db_type->db_type;
}

unknown's avatar
unknown committed
1964
static inline const char *ha_resolve_storage_engine_name(const handlerton *db_type)
unknown's avatar
unknown committed
1965
{
unknown's avatar
unknown committed
1966
  return db_type == NULL ? "UNKNOWN" : hton2plugin[db_type->slot]->name.str;
unknown's avatar
unknown committed
1967 1968
}

unknown's avatar
unknown committed
1969
static inline bool ha_check_storage_engine_flag(const handlerton *db_type, uint32 flag)
unknown's avatar
unknown committed
1970 1971 1972 1973
{
  return db_type == NULL ? FALSE : test(db_type->flags & flag);
}

unknown's avatar
unknown committed
1974
static inline bool ha_storage_engine_is_enabled(const handlerton *db_type)
unknown's avatar
unknown committed
1975
{
1976
  return (db_type && db_type->create) ?
unknown's avatar
unknown committed
1977 1978
         (db_type->state == SHOW_OPTION_YES) : FALSE;
}
1979 1980

/* basic stuff */
1981
int ha_init_errors(void);
unknown's avatar
unknown committed
1982
int ha_init(void);
1983
int ha_end(void);
unknown's avatar
unknown committed
1984 1985
int ha_initialize_handlerton(st_plugin_int *plugin);
int ha_finalize_handlerton(st_plugin_int *plugin);
unknown's avatar
unknown committed
1986

1987
TYPELIB *ha_known_exts(void);
unknown's avatar
unknown committed
1988
int ha_panic(enum ha_panic_function flag);
1989
void ha_close_connection(THD* thd);
unknown's avatar
unknown committed
1990
bool ha_flush_logs(handlerton *db_type);
1991
void ha_drop_database(char* path);
unknown's avatar
unknown committed
1992 1993 1994
int ha_create_table(THD *thd, const char *path,
                    const char *db, const char *table_name,
                    HA_CREATE_INFO *create_info,
unknown's avatar
unknown committed
1995
		    bool update_create_info);
unknown's avatar
unknown committed
1996
int ha_delete_table(THD *thd, handlerton *db_type, const char *path,
unknown's avatar
unknown committed
1997
                    const char *db, const char *alias, bool generate_warning);
1998

1999
/* statistics and info */
unknown's avatar
unknown committed
2000
bool ha_show_status(THD *thd, handlerton *db_type, enum ha_stat_type stat);
2001

2002
/* discovery */
2003
int ha_create_table_from_engine(THD* thd, const char *db, const char *name);
2004
int ha_discover(THD* thd, const char* dbname, const char* name,
2005
                uchar** frmblob, size_t* frmlen);
2006
int ha_find_files(THD *thd,const char *db,const char *path,
2007
                  const char *wild, bool dir, List<LEX_STRING>* files);
unknown's avatar
unknown committed
2008
int ha_table_exists_in_engine(THD* thd, const char* db, const char* name);
2009 2010

/* key cache */
2011
extern "C" int ha_init_key_cache(const char *name, KEY_CACHE *key_cache);
unknown's avatar
unknown committed
2012 2013
int ha_resize_key_cache(KEY_CACHE *key_cache);
int ha_change_key_cache_param(KEY_CACHE *key_cache);
2014
int ha_change_key_cache(KEY_CACHE *old_key_cache, KEY_CACHE *new_key_cache);
unknown's avatar
unknown committed
2015
int ha_end_key_cache(KEY_CACHE *key_cache);
2016

unknown's avatar
unknown committed
2017
/* report to InnoDB that control passes to the client */
2018
int ha_release_temporary_latches(THD *thd);
2019 2020 2021

/* transactions: interface to handlerton functions */
int ha_start_consistent_snapshot(THD *thd);
unknown's avatar
unknown committed
2022
int ha_commit_or_rollback_by_xid(XID *xid, bool commit);
2023 2024 2025 2026 2027 2028 2029
int ha_commit_one_phase(THD *thd, bool all);
int ha_rollback_trans(THD *thd, bool all);
int ha_prepare(THD *thd);
int ha_recover(HASH *commit_list);

/* transactions: these functions never call handlerton functions directly */
int ha_commit_trans(THD *thd, bool all);
unknown's avatar
unknown committed
2030
int ha_autocommit_or_rollback(THD *thd, int error);
2031
int ha_enable_transaction(THD *thd, bool on);
2032 2033 2034 2035 2036 2037

/* savepoints */
int ha_rollback_to_savepoint(THD *thd, SAVEPOINT *sv);
int ha_savepoint(THD *thd, SAVEPOINT *sv);
int ha_release_savepoint(THD *thd, SAVEPOINT *sv);

unknown's avatar
unknown committed
2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048
/* these are called by storage engines */
void trans_register_ha(THD *thd, bool all, handlerton *ht);

/*
  Storage engine has to assume the transaction will end up with 2pc if
   - there is more than one 2pc-capable storage engine available
   - in the current transaction 2pc was not disabled yet
*/
#define trans_need_2pc(thd, all)                   ((total_ha_2pc > 1) && \
        !((all ? &thd->transaction.all : &thd->transaction.stmt)->no_2pc))

unknown's avatar
unknown committed
2049 2050 2051 2052
#ifdef HAVE_NDB_BINLOG
int ha_reset_logs(THD *thd);
int ha_binlog_index_purge_file(THD *thd, const char *file);
void ha_reset_slave(THD *thd);
2053
void ha_binlog_log_query(THD *thd, handlerton *db_type,
2054
                         enum_binlog_command binlog_command,
unknown's avatar
unknown committed
2055 2056 2057 2058 2059
                         const char *query, uint query_length,
                         const char *db, const char *table_name);
void ha_binlog_wait(THD *thd);
int ha_binlog_end(THD *thd);
#else
2060 2061 2062 2063 2064 2065
#define ha_reset_logs(a) do {} while (0)
#define ha_binlog_index_purge_file(a,b) do {} while (0)
#define ha_reset_slave(a) do {} while (0)
#define ha_binlog_log_query(a,b,c,d,e,f,g) do {} while (0)
#define ha_binlog_wait(a) do {} while (0)
#define ha_binlog_end(a)  do {} while (0)
unknown's avatar
unknown committed
2066
#endif