handler.h 60.7 KB
Newer Older
1
/* Copyright (C) 2000,2004 MySQL AB & MySQL Finland AB & TCX DataKonsult AB
2

bk@work.mysql.com's avatar
bk@work.mysql.com committed
3 4 5 6
   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
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
7

bk@work.mysql.com's avatar
bk@work.mysql.com committed
8 9 10 11
   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.
12

bk@work.mysql.com's avatar
bk@work.mysql.com committed
13 14 15 16 17 18 19
   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 */

20
#ifdef USE_PRAGMA_INTERFACE
bk@work.mysql.com's avatar
bk@work.mysql.com committed
21 22 23
#pragma interface			/* gcc class implementation */
#endif

24
#include <ft_global.h>
25
#include <keycache.h>
26

bk@work.mysql.com's avatar
bk@work.mysql.com committed
27 28 29 30
#ifndef NO_HASH
#define NO_HASH				/* Not yet implemented */
#endif

31 32
#define USING_TRANSACTIONS

bk@work.mysql.com's avatar
bk@work.mysql.com 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
41
#define HA_ADMIN_INVALID         -5
vva@eagle.mysql.r18.ru's avatar
vva@eagle.mysql.r18.ru committed
42
#define HA_ADMIN_REJECT          -6
43
#define HA_ADMIN_TRY_ALTER       -7
44
#define HA_ADMIN_WRONG_CHECKSUM  -8
igor@rurik.mysql.com's avatar
igor@rurik.mysql.com committed
45
#define HA_ADMIN_NOT_BASE_TABLE  -9
46 47 48
#define HA_ADMIN_NEEDS_UPGRADE  -10
#define HA_ADMIN_NEEDS_ALTER    -11
#define HA_ADMIN_NEEDS_CHECK    -12
bk@work.mysql.com's avatar
bk@work.mysql.com 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)
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)
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 */
serg@serg.mylan's avatar
serg@serg.mylan committed
78
#define HA_NO_BLOBS            (1 << 9) /* Doesn't support blobs */
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().
*/
serg@serg.mylan's avatar
serg@serg.mylan 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)
serg@serg.mylan's avatar
serg@serg.mylan 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)
serg@serg.mylan's avatar
serg@serg.mylan 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)
111
/* Table data are stored in separate files (for lower_case_table_names) */
monty@mysql.com's avatar
monty@mysql.com committed
112
#define HA_FILE_BASED	       (1 << 26)
113
#define HA_NO_VARCHAR	       (1 << 27)
ram@gw.mysql.r18.ru's avatar
ram@gw.mysql.r18.ru committed
114
#define HA_CAN_BIT_FIELD       (1 << 28) /* supports bit fields */
ingo@mysql.com's avatar
ingo@mysql.com 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)
monty@mysql.com's avatar
monty@mysql.com committed
121

122
/* bits in index_flags(index_number) for what you can do with index */
123 124 125 126
#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 */
127
#define HA_ONLY_WHOLE_INDEX	16	/* Can't use part key searches */
128
#define HA_KEYREAD_ONLY         64	/* Support HA_EXTRA_KEYREAD */
129

130 131 132
/*
  bits in alter_table_flags:
*/
133 134 135 136
/*
  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).
*/
137 138 139 140 141 142
#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*/
143 144 145 146 147
/*
  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).
*/
148 149 150 151 152 153
#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*/
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
/*
  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)
182

183 184 185 186 187 188
/*
  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 

189 190 191 192 193 194
/* 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

195 196
/*
  Note: the following includes binlog and closing 0.
197 198 199
  so: innodb + bdb + ndb + binlog + myisam + myisammrg + archive +
      example + csv + heap + blackhole + federated + 0
  (yes, the sum is deliberately inaccurate)
200
  TODO remove the limit, use dynarrays
201
*/
202
#define MAX_HA 15
203

204 205 206 207
/*
  Parameters for open() (in register form->filestat)
  HA_GET_INFO does an implicit HA_ABORT_IF_LOCKED
*/
bk@work.mysql.com's avatar
bk@work.mysql.com committed
208 209 210 211 212 213

#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 */
214 215
/* Try readonly if can't open with read and write */
#define HA_TRY_READ_ONLY	32
bk@work.mysql.com's avatar
bk@work.mysql.com committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
#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
#define HA_OPTION_NO_CHECKSUM	(1L << 17)
#define HA_OPTION_NO_DELAY_KEY_WRITE (1L << 18)
#define HA_MAX_REC_LENGTH	65535

231 232
/* Table caching type */
#define HA_CACHE_TBL_NONTRANSACT 0
233 234 235 236
#define HA_CACHE_TBL_NOCACHE     1
#define HA_CACHE_TBL_ASKTRANSACT 2
#define HA_CACHE_TBL_TRANSACT    4

237 238
/* Options of START TRANSACTION statement (and later of SET TRANSACTION stmt) */
#define MYSQL_START_TRANS_OPT_WITH_CONS_SNAPSHOT 1
239

240 241 242 243 244
/* 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)

245
enum legacy_db_type
246
{
247 248 249 250
  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,
251
  DB_TYPE_BERKELEY_DB, DB_TYPE_INNODB,
252
  DB_TYPE_GEMINI, DB_TYPE_NDBCLUSTER,
253
  DB_TYPE_EXAMPLE_DB, DB_TYPE_ARCHIVE_DB, DB_TYPE_CSV_DB,
254
  DB_TYPE_FEDERATED_DB,
255
  DB_TYPE_BLACKHOLE_DB,
256
  DB_TYPE_PARTITION_DB,
257
  DB_TYPE_BINLOG,
acurtis@xiphis.org's avatar
acurtis@xiphis.org committed
258
  DB_TYPE_FIRST_DYNAMIC=32,
259
  DB_TYPE_DEFAULT=127 // Must be last
260
};
bk@work.mysql.com's avatar
bk@work.mysql.com committed
261

262
enum row_type { ROW_TYPE_NOT_USED=-1, ROW_TYPE_DEFAULT, ROW_TYPE_FIXED,
263
		ROW_TYPE_DYNAMIC, ROW_TYPE_COMPRESSED,
264
		ROW_TYPE_REDUNDANT, ROW_TYPE_COMPACT, ROW_TYPE_PAGES };
bk@work.mysql.com's avatar
bk@work.mysql.com committed
265

tomas@poseidon.ndb.mysql.com's avatar
tomas@poseidon.ndb.mysql.com committed
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
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
};

bk@work.mysql.com's avatar
bk@work.mysql.com committed
284 285 286
/* struct to hold information about the table that should be created */

/* Bits in used_fields */
287
#define HA_CREATE_USED_AUTO             (1L << 0)
288
#define HA_CREATE_USED_RAID             (1L << 1) //RAID is no longer availble
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
#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)
305
#define HA_CREATE_USED_CONNECTION       (1L << 18)
306
#define HA_CREATE_USED_KEY_BLOCK_SIZE   (1L << 19)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
307

308
typedef ulonglong my_xid; // this line is the same as in log_event.h
309 310 311 312
#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))
313 314 315 316 317

#define XIDDATASIZE 128
#define MAXGTRIDSIZE 64
#define MAXBQUALSIZE 64

318 319 320
#define COMPATIBLE_DATA_YES 0
#define COMPATIBLE_DATA_NO  1

321 322 323 324
struct xid_t {
  long formatID;
  long gtrid_length;
  long bqual_length;
325
  char data[XIDDATASIZE];  // not \0-terminated !
326

327
  xid_t() {}                                /* Remove gcc warning */  
serg@serg.mylan's avatar
serg@serg.mylan committed
328
  bool eq(struct xid_t *xid)
329
  { return eq(xid->gtrid_length, xid->bqual_length, xid->data); }
330 331
  bool eq(long g, long b, const char *d)
  { return g == gtrid_length && b == bqual_length && !memcmp(d, data, g+b); }
serg@serg.mylan's avatar
serg@serg.mylan committed
332
  void set(struct xid_t *xid)
333
  { memcpy(this, xid, xid->length()); }
serg@serg.mylan's avatar
serg@serg.mylan committed
334 335 336 337 338 339
  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);
  }
340
  void set(ulonglong xid)
341
  {
342
    my_xid tmp;
serg@serg.mylan's avatar
serg@serg.mylan committed
343
    formatID= 1;
344
    set(MYSQL_XID_PREFIX_LEN, 0, MYSQL_XID_PREFIX);
345 346 347
    memcpy(data+MYSQL_XID_PREFIX_LEN, &server_id, sizeof(server_id));
    tmp= xid;
    memcpy(data+MYSQL_XID_OFFSET, &tmp, sizeof(tmp));
348 349 350 351
    gtrid_length=MYSQL_XID_GTRID_LEN;
  }
  void set(long g, long b, const char *d)
  {
serg@serg.mylan's avatar
serg@serg.mylan committed
352
    formatID= 1;
353 354 355 356 357 358 359 360
    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()
  {
361 362 363
    my_xid tmp;
    memcpy(&tmp, data+MYSQL_XID_OFFSET, sizeof(tmp));
    return tmp;
364 365 366 367
  }
  my_xid get_my_xid()
  {
    return gtrid_length == MYSQL_XID_GTRID_LEN && bqual_length == 0 &&
serg@serg.mylan's avatar
serg@serg.mylan committed
368
           !memcmp(data+MYSQL_XID_PREFIX_LEN, &server_id, sizeof(server_id)) &&
369 370 371
           !memcmp(data, MYSQL_XID_PREFIX, MYSQL_XID_PREFIX_LEN) ?
           quick_get_my_xid() : 0;
  }
372 373 374 375 376
  uint length()
  {
    return sizeof(formatID)+sizeof(gtrid_length)+sizeof(bqual_length)+
           gtrid_length+bqual_length;
  }
377 378 379 380 381 382 383 384
  byte *key()
  {
    return (byte *)&gtrid_length;
  }
  uint key_length()
  {
    return sizeof(gtrid_length)+sizeof(bqual_length)+gtrid_length+bqual_length;
  }
385
};
386 387
typedef struct xid_t XID;

388 389
/* for recover() handlerton call */
#define MIN_XID_LIST_SIZE  128
390 391 392
#ifdef SAFEMALLOC
#define MAX_XID_LIST_SIZE  256
#else
393
#define MAX_XID_LIST_SIZE  (1024*128)
394
#endif
395

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
/*
  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
};

429
struct handlerton;
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
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;
447
  const handlerton *storage_engine;
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
  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
465
    storage_engine= NULL;
466 467 468 469 470 471 472
    nodegroup_id= UNDEF_NODEGROUP;
    wait_until_completed= TRUE;
    ts_comment= NULL;
    ts_access_mode= TS_NOT_DEFINED;
  }
};

473 474 475 476
/* The handler for a table type.  Will be included in the TABLE structure */

struct st_table;
typedef struct st_table TABLE;
477
typedef struct st_table_share TABLE_SHARE;
478 479
struct st_foreign_key_info;
typedef struct st_foreign_key_info FOREIGN_KEY_INFO;
480 481 482
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);
483
enum ha_stat_type { HA_ENGINE_STATUS, HA_ENGINE_LOGS, HA_ENGINE_MUTEX };
serg@sergbook.mysql.com's avatar
serg@sergbook.mysql.com committed
484
extern st_plugin_int *hton2plugin[MAX_HA];
485

486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 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
/* 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;
};

552 553
/*
  handlerton is a singleton structure - one instance per storage engine -
serg@serg.mylan's avatar
serg@serg.mylan committed
554 555
  to provide access to storage engine functionality that works on the
  "global" level (unlike handler class that works on a per-table basis)
556 557

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

559 560 561 562
  static handlerton { ... } xxx_hton;

  savepoint_*, prepare, recover, and *_by_xid pointers can be 0.
*/
563
struct handlerton
564
{
565
  /*
566
    Historical marker for if the engine is available of not
567 568 569 570 571 572 573
  */
  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.
  */
574
  enum legacy_db_type db_type;
575 576 577 578 579 580 581 582 583
  /*
    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.
   */
584
   uint slot;
585 586 587 588 589 590 591 592 593
   /*
     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.
   */
594
   uint savepoint_offset;
595 596 597 598 599 600 601 602
   /*
     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
   */
603
   int  (*close_connection)(THD *thd);
604 605 606 607
   /*
     sv points to an uninitialized storage area of requested size
     (see savepoint_offset description)
   */
608
   int  (*savepoint_set)(THD *thd, void *sv);
609 610 611 612
   /*
     sv points to a storage area, that was earlier passed
     to the savepoint_set call
   */
613 614
   int  (*savepoint_rollback)(THD *thd, void *sv);
   int  (*savepoint_release)(THD *thd, void *sv);
615 616 617 618 619 620 621
   /*
     '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.
   */
622 623 624 625 626 627
   int  (*commit)(THD *thd, bool all);
   int  (*rollback)(THD *thd, bool all);
   int  (*prepare)(THD *thd, bool all);
   int  (*recover)(XID *xid_list, uint len);
   int  (*commit_by_xid)(XID *xid);
   int  (*rollback_by_xid)(XID *xid);
628 629 630
   void *(*create_cursor_read_view)();
   void (*set_cursor_read_view)(void *);
   void (*close_cursor_read_view)(void *);
631
   handler *(*create)(TABLE_SHARE *table, MEM_ROOT *mem_root);
632 633 634 635 636
   void (*drop_database)(char* path);
   int (*panic)(enum ha_panic_function flag);
   int (*start_consistent_snapshot)(THD *thd);
   bool (*flush_logs)();
   bool (*show_status)(THD *thd, stat_print_fn *print, enum ha_stat_type stat);
637 638
   uint (*partition_flags)();
   uint (*alter_table_flags)(uint flags);
639
   int (*alter_tablespace)(THD *thd, st_alter_tablespace *ts_info);
640 641 642
   int (*fill_files_table)(THD *thd,
                           struct st_table_list *tables,
                           class Item *cond);
643
   uint32 flags;                                /* global handler flags */
644 645 646
   /*
      Those handlerton functions below are properly initialized at handler
      init.
tomas@poseidon.ndb.mysql.com's avatar
tomas@poseidon.ndb.mysql.com committed
647 648 649 650 651
   */
   int (*binlog_func)(THD *thd, enum_binlog_func fn, void *arg);
   void (*binlog_log_query)(THD *thd, enum_binlog_command binlog_command,
                            const char *query, uint query_length,
                            const char *db, const char *table_name);
652
   int (*release_temporary_latches)(THD *thd);
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669

   /*
     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)

   */
   enum log_status (*get_log_status)(char *log);

   /*
     Iterators creator.
     Presence of the pointer should be checked before using
   */
   enum handler_create_iterator_result
     (*create_iterator)(enum handler_iterator_type type,
                        struct handler_iterator *fill_this_in);
670
};
671

672

673
/* Possible flags of a handlerton */
674 675
#define HTON_NO_FLAGS                 0
#define HTON_CLOSE_CURSORS_AT_COMMIT (1 << 0)
676 677 678
#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
679 680
#define HTON_FLUSH_AFTER_RENAME      (1 << 4)
#define HTON_NOT_USER_SELECTABLE     (1 << 5)
681
#define HTON_TEMPORARY_NOT_SUPPORTED (1 << 6) //Having temporary tables not supported
acurtis@xiphis.org's avatar
acurtis@xiphis.org committed
682
#define HTON_ALTER_CANNOT_CREATE     (1 << 7) //Cannot use alter to create
683

684 685
typedef struct st_thd_trans
{
686
  /* number of entries in the ht[] */
687
  uint        nht;
688
  /* true is not all entries in the ht[] support 2pc */
689
  bool        no_2pc;
690
  /* storage engines that registered themselves for this transaction */
691 692 693
  handlerton *ht[MAX_HA];
} THD_TRANS;

monty@tik.mysql.fi's avatar
monty@tik.mysql.fi committed
694 695 696
enum enum_tx_isolation { ISO_READ_UNCOMMITTED, ISO_READ_COMMITTED,
			 ISO_REPEATABLE_READ, ISO_SERIALIZABLE};

697

698 699
enum ndb_distribution { ND_KEYHASH= 0, ND_LINHASH= 1 };

700

701 702 703 704 705 706 707 708 709 710 711 712 713
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;
  time_t create_time;
  time_t check_time;
  time_t update_time;
  ulonglong check_sum;
} PARTITION_INFO;

714 715
#define UNDEF_NODEGROUP 65535
class Item;
716
struct st_table_log_memory_entry;
717 718 719

class partition_info;

720 721 722 723
struct st_partition_iter;
#define NOT_A_PARTITION_ID ((uint32)-1)


bk@work.mysql.com's avatar
bk@work.mysql.com committed
724 725
typedef struct st_ha_create_information
{
726
  CHARSET_INFO *table_charset, *default_table_charset;
727
  LEX_STRING connect_string;
728
  const char *comment,*password, *tablespace;
729 730
  const char *data_file_name, *index_file_name;
  const char *alias;
731 732 733 734
  ulonglong max_rows,min_rows;
  ulonglong auto_increment_value;
  ulong table_options;
  ulong avg_row_length;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
735
  ulong used_fields;
736
  ulong key_block_size;
737
  SQL_LIST merge_list;
738
  handlerton *db_type;
739
  enum row_type row_type;
740
  uint null_bits;                       /* NULL bits at start of record */
741
  uint options;				/* OR of HA_CREATE_ options */
742
  uint merge_insert_method;
743
  uint extra_size;                      /* length of extra data segment */
744
  bool table_existed;			/* 1 in create if table existed */
745
  bool frm_only;                        /* 1 if no ha_create_table() */
746
  bool varchar;                         /* 1 if table has a VARCHAR */
747
  bool store_on_disk;                   /* 1 if table stored on disk */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
748 749
} HA_CREATE_INFO;

750 751 752 753 754 755 756 757 758

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


759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
/*
  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:
  inline void prelock(TABLE **tables, uint count)
  {
    do_prelock(tables, count);
  }
780 781
  virtual ~TABLEOP_HOOKS() {}
  TABLEOP_HOOKS() {}
bk@work.mysql.com's avatar
bk@work.mysql.com committed
782

783 784 785 786 787 788 789
private:
  /* Function primitive that is called prior to locking tables */
  virtual void do_prelock(TABLE **tables, uint count)
  {
    /* Default is to do nothing */
  }
};
bk@work.mysql.com's avatar
bk@work.mysql.com committed
790

791 792
typedef struct st_savepoint SAVEPOINT;
extern ulong savepoint_alloc_size;
793
extern KEY_CREATE_INFO default_key_create_info;
794

795
/* Forward declaration for condition pushdown to storage engine */
796
typedef class Item COND;
mskold@mysql.com's avatar
Merge  
mskold@mysql.com committed
797

bk@work.mysql.com's avatar
bk@work.mysql.com committed
798 799
typedef struct st_ha_check_opt
{
800
  st_ha_check_opt() {}                        /* Remove gcc warning */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
801
  ulong sort_buffer_size;
serg@serg.mysql.com's avatar
serg@serg.mysql.com committed
802 803
  uint flags;       /* isam layer flags (e.g. for myisamchk) */
  uint sql_flags;   /* sql layer flags - for something myisamchk cannot do */
804
  KEY_CACHE *key_cache;	/* new key cache when changing key cache */
805
  void init();
bk@work.mysql.com's avatar
bk@work.mysql.com committed
806 807
} HA_CHECK_OPT;

808

809

ingo@mysql.com's avatar
ingo@mysql.com committed
810 811 812 813 814 815 816 817 818 819 820 821 822 823
/*
  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
{
  const byte *buffer;         /* Buffer one can start using */
  const byte *buffer_end;     /* End of buffer */
  byte *end_of_used_area;     /* End of area that was used by handler */
} HANDLER_BUFFER;

824 825
typedef struct system_status_var SSV;

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
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;
  ha_rows records;			/* Estimated records in table */
  ha_rows deleted;			/* Deleted records */
  ulong mean_rec_length;		/* physical reclength */
  time_t create_time;			/* When table was created */
  time_t check_time;
  time_t update_time;
  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)
  {}
};

851 852 853 854 855
/*
  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
 */
856

bk@work.mysql.com's avatar
bk@work.mysql.com committed
857 858
class handler :public Sql_alloc
{
859 860
  friend class ha_partition;

bk@work.mysql.com's avatar
bk@work.mysql.com committed
861
 protected:
862 863
  struct st_table_share *table_share;   /* The table definition */
  struct st_table *table;               /* The current open table */
864
  ulonglong cached_table_flags;         /* Set on init() and open() */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
865

866
  virtual int index_init(uint idx, bool sorted) { active_index=idx; return 0; }
867 868 869 870 871 872 873 874 875 876
  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; }
877
  virtual ulonglong table_flags(void) const =0;
878 879
  void ha_statistic_increment(ulong SSV::*offset) const;

880 881 882
  ha_rows estimation_rows_to_insert;
  virtual void start_bulk_insert(ha_rows rows) {}
  virtual int end_bulk_insert() {return 0; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
883
public:
884
  const handlerton *ht;                 /* storage engine of this handler */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
885
  byte *ref;				/* Pointer to current row */
886 887 888
  byte *dup_ref;			/* Pointer to duplicate row */

  ha_statistics stats;
889

ingo@mysql.com's avatar
ingo@mysql.com committed
890 891 892 893 894 895
  /* The following are for read_multi_range */
  bool multi_range_sorted;
  KEY_MULTI_RANGE *multi_range_curr;
  KEY_MULTI_RANGE *multi_range_end;
  HANDLER_BUFFER *multi_range_buffer;

896 897 898 899
  /* The following are for read_range() */
  key_range save_end_range, *end_range;
  KEY_PART_INFO *range_key_part;
  int key_compare_result_on_equal;
900
  bool eq_range;
901

902
  uint errkey;				/* Last dup key */
903
  uint key_used_on_scan;
904 905 906
  uint active_index;
  /* Length of ref (1-8 or the clustered key length) */
  uint ref_length;
907
  FT_INFO *ft_handler;
908
  enum {NONE=0, INDEX, RND} inited;
909
  bool implicit_emptied;                /* Can be !=0 only if HEAP */
910
  const COND *pushed_cond;
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
  /*
    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;
  /*
    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;
  /*
    Interval returned by get_auto_increment() and being consumed by the
    inserter.
  */
  Discrete_interval auto_inc_interval_for_cur_row;
933

934
  handler(const handlerton *ht_arg, TABLE_SHARE *share_arg)
935
    :table_share(share_arg), estimation_rows_to_insert(0), ht(ht_arg),
936 937
    ref(0), key_used_on_scan(MAX_KEY), active_index(MAX_KEY),
    ref_length(sizeof(my_off_t)),
938
    ft_handler(0), inited(NONE), implicit_emptied(0),
939
    pushed_cond(NULL), next_insert_id(0), insert_id_for_cur_row(0)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
940
    {}
941 942 943 944
  virtual ~handler(void)
  {
    /* TODO: DBUG_ASSERT(inited == NONE); */
  }
945 946 947 948 949
  /* This is called after create to allow us to set up cached variables */
  void init()
  {
    cached_table_flags= table_flags();
  }
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
  /*
    Check whether a handler allows to lock the table.

    SYNOPSIS
      check_if_locking_is_allowed()
        thd     Handler of the thread, trying to lock the table
        table   Table handler to check
        count   Number of locks already granted to the table

    DESCRIPTION
      Check whether a handler allows to lock the table. For instance,
      MyISAM does not allow to lock mysql.proc along with other tables.
      This limitation stems from the fact that MyISAM does not support
      row-level locking and we have to add this limitation to avoid
      deadlocks.

    RETURN
      TRUE      Locking is allowed
      FALSE     Locking is not allowed. The error was thrown.
  */
970 971 972 973
  virtual bool check_if_locking_is_allowed(uint sql_command,
                                           ulong type, TABLE *table,
                                           uint count,
                                           bool called_by_logger_thread)
974 975 976
  {
    return TRUE;
  }
977 978
  bool check_if_log_table_locking_is_allowed(uint sql_command,
                                             ulong type, TABLE *table);
979
  int ha_open(TABLE *table, const char *name, int mode, int test_if_locked);
980
  void adjust_next_insert_id_after_explicit_value(ulonglong nr);
981
  bool update_auto_increment();
982
  void print_keydup_error(uint key_nr, const char *msg);
983
  virtual void print_error(int error, myf errflag);
984
  virtual bool get_error_message(int error, String *buf);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
985
  uint get_dup_key(int error);
986 987 988 989 990
  void change_table_ptr(TABLE *table_arg, TABLE_SHARE *share)
  {
    table= table_arg;
    table_share= share;
  }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
991
  virtual double scan_time()
992
  { return ulonglong2double(stats.data_file_length) / IO_SIZE + 2; }
monty@narttu.mysql.fi's avatar
monty@narttu.mysql.fi committed
993
  virtual double read_time(uint index, uint ranges, ha_rows rows)
994
  { return rows2double(ranges+rows); }
serg@serg.mylan's avatar
serg@serg.mylan committed
995
  virtual const key_map *keys_to_use_for_scanning() { return &key_map_empty; }
996 997
  bool has_transactions()
  { return (ha_table_flags() & HA_NO_TRANSACTIONS) == 0; }
998
  virtual uint extra_rec_buf_length() const { return 0; }
999 1000 1001 1002 1003 1004 1005

  /*
    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.
1006 1007
    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
1008
    a slightly different error message.
1009
  */
1010
  virtual bool is_fatal_error(int error, uint flags)
1011 1012
  {
    if (!error ||
1013
        ((flags & HA_CHECK_DUP_KEY) &&
1014 1015
         (error == HA_ERR_FOUND_DUPP_KEY ||
          error == HA_ERR_FOUND_DUPP_UNIQUE)))
1016 1017 1018 1019
      return FALSE;
    return TRUE;
  }

1020 1021 1022 1023 1024
  /*
    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; }
sergefp@mysql.com's avatar
sergefp@mysql.com committed
1025 1026 1027 1028 1029 1030 1031
  /*
    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()
1032
  { return stats.records+EXTRA_RECORDS; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1033

1034 1035 1036 1037 1038 1039
  /*
    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; }

1040 1041
  virtual const char *index_type(uint key_number) { DBUG_ASSERT(0); return "";}

1042
  int ha_index_init(uint idx, bool sorted)
1043
  {
monty@mysql.com's avatar
monty@mysql.com committed
1044
    DBUG_ENTER("ha_index_init");
1045 1046
    DBUG_ASSERT(inited==NONE);
    inited=INDEX;
1047
    DBUG_RETURN(index_init(idx, sorted));
1048 1049 1050
  }
  int ha_index_end()
  {
monty@mysql.com's avatar
monty@mysql.com committed
1051
    DBUG_ENTER("ha_index_end");
1052 1053
    DBUG_ASSERT(inited==INDEX);
    inited=NONE;
monty@mysql.com's avatar
monty@mysql.com committed
1054
    DBUG_RETURN(index_end());
1055
  }
1056
  int ha_rnd_init(bool scan)
1057
  {
monty@mysql.com's avatar
monty@mysql.com committed
1058
    DBUG_ENTER("ha_rnd_init");
1059 1060
    DBUG_ASSERT(inited==NONE || (inited==RND && scan));
    inited=RND;
monty@mysql.com's avatar
monty@mysql.com committed
1061
    DBUG_RETURN(rnd_init(scan));
1062 1063 1064
  }
  int ha_rnd_end()
  {
monty@mysql.com's avatar
monty@mysql.com committed
1065
    DBUG_ENTER("ha_rnd_end");
1066 1067
    DBUG_ASSERT(inited==RND);
    inited=NONE;
monty@mysql.com's avatar
monty@mysql.com committed
1068
    DBUG_RETURN(rnd_end());
1069
  }
1070
  int ha_reset();
1071

monty@mysql.com's avatar
monty@mysql.com committed
1072
  /* this is necessary in many places, e.g. in HANDLER command */
1073 1074 1075 1076
  int ha_index_or_rnd_end()
  {
    return inited == INDEX ? ha_index_end() : inited == RND ? ha_rnd_end() : 0;
  }
1077 1078
  longlong ha_table_flags() { return cached_table_flags; }

1079
  /*
1080 1081 1082 1083 1084
    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.
1085
  */
1086
  virtual void column_bitmaps_signal();
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1087
  uint get_index(void) const { return active_index; }
1088
  virtual int open(const char *name, int mode, uint test_if_locked)=0;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1089
  virtual int close(void)=0;
1090 1091 1092 1093 1094 1095 1096

  /*
    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.
   */
1097
  int ha_external_lock(THD *thd, int lock_type);
1098 1099 1100 1101
  int ha_write_row(byte * buf);
  int ha_update_row(const byte * old_data, byte * new_data);
  int ha_delete_row(const byte * buf);

mronstrom@mysql.com's avatar
mronstrom@mysql.com committed
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
  /*
    SYNOPSIS
      start_bulk_update()
    RETURN
      0   Bulk update used by handler
      1   Bulk update not used, normal operation used
  */
  virtual bool start_bulk_update() { return 1; }
  /*
    SYNOPSIS
      start_bulk_delete()
    RETURN
      0   Bulk delete used by handler
      1   Bulk delete not used, normal operation used
  */
  virtual bool start_bulk_delete() { return 1; }
  /*
    SYNOPSIS
    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.

      bulk_update_row()
        old_data       Old record
        new_data       New record
        dup_key_found  Number of duplicate keys found
    RETURN
      0   Bulk delete used by handler
      1   Bulk delete not used, normal operation used
  */
mronstrom@mysql.com[mikron]'s avatar
mronstrom@mysql.com[mikron] committed
1133 1134 1135 1136 1137 1138
  virtual int bulk_update_row(const byte *old_data, byte *new_data,
                              uint *dup_key_found)
  {
    DBUG_ASSERT(FALSE);
    return HA_ERR_WRONG_COMMAND;
  }
mronstrom@mysql.com's avatar
mronstrom@mysql.com committed
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
  /*
    SYNOPSIS
    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.

      exec_bulk_update()
        dup_key_found       Number of duplicate keys found
    RETURN
      0           Success
      >0          Error code
  */
mronstrom@mysql.com[mikron]'s avatar
mronstrom@mysql.com[mikron] committed
1152 1153 1154 1155 1156
  virtual int exec_bulk_update(uint *dup_key_found)
  {
    DBUG_ASSERT(FALSE);
    return HA_ERR_WRONG_COMMAND;
  }
mronstrom@mysql.com's avatar
mronstrom@mysql.com committed
1157 1158 1159 1160 1161 1162 1163 1164 1165
  /*
    SYNOPSIS
    Perform any needed clean-up, no outstanding updates are there at the
    moment.

      end_bulk_update()
    RETURN
      Nothing
  */
mronstrom@mysql.com[mikron]'s avatar
mronstrom@mysql.com[mikron] committed
1166
  virtual void end_bulk_update() { return; }
mronstrom@mysql.com's avatar
mronstrom@mysql.com committed
1167 1168 1169 1170 1171 1172 1173 1174 1175
  /*
    SYNOPSIS
    Execute all outstanding deletes and close down the bulk delete.

      end_bulk_delete()
    RETURN
    0             Success
    >0            Error code
  */
mronstrom@mysql.com[mikron]'s avatar
mronstrom@mysql.com[mikron] committed
1176 1177 1178 1179 1180
  virtual int end_bulk_delete()
  {
    DBUG_ASSERT(FALSE);
    return HA_ERR_WRONG_COMMAND;
  }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1181
  virtual int index_read(byte * buf, const byte * key,
1182 1183
			 uint key_len, enum ha_rkey_function find_flag)
   { return  HA_ERR_WRONG_COMMAND; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1184
  virtual int index_read_idx(byte * buf, uint index, const byte * key,
1185 1186 1187 1188 1189 1190 1191 1192 1193
			     uint key_len, enum ha_rkey_function find_flag);
  virtual int index_next(byte * buf)
   { return  HA_ERR_WRONG_COMMAND; }
  virtual int index_prev(byte * buf)
   { return  HA_ERR_WRONG_COMMAND; }
  virtual int index_first(byte * buf)
   { return  HA_ERR_WRONG_COMMAND; }
  virtual int index_last(byte * buf)
   { return  HA_ERR_WRONG_COMMAND; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1194
  virtual int index_next_same(byte *buf, const byte *key, uint keylen);
1195
  virtual int index_read_last(byte * buf, const byte * key, uint key_len)
1196
   { return (my_errno=HA_ERR_WRONG_COMMAND); }
ingo@mysql.com's avatar
ingo@mysql.com committed
1197 1198 1199 1200
  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);
1201
  virtual int read_range_first(const key_range *start_key,
1202 1203 1204
                               const key_range *end_key,
                               bool eq_range, bool sorted);
  virtual int read_range_next();
1205
  int compare_key(key_range *range);
1206
  virtual int ft_init() { return HA_ERR_WRONG_COMMAND; }
1207
  void ft_end() { ft_handler=NULL; }
1208
  virtual FT_INFO *ft_init_ext(uint flags, uint inx,String *key)
1209
    { return NULL; }
1210
  virtual int ft_read(byte *buf) { return HA_ERR_WRONG_COMMAND; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1211 1212
  virtual int rnd_next(byte *buf)=0;
  virtual int rnd_pos(byte * buf, byte *pos)=0;
1213
  virtual int read_first_row(byte *buf, uint primary_key);
1214 1215 1216 1217 1218 1219 1220 1221
  /*
    The following function is only needed for tables that may be temporary
    tables during joins
  */
  virtual int restart_rnd_next(byte *buf, byte *pos)
    { return HA_ERR_WRONG_COMMAND; }
  virtual int rnd_same(byte *buf, uint inx)
    { return HA_ERR_WRONG_COMMAND; }
1222 1223
  virtual ha_rows records_in_range(uint inx, key_range *min_key,
                                   key_range *max_key)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1224 1225
    { return (ha_rows) 10; }
  virtual void position(const byte *record)=0;
1226
  virtual void info(uint)=0; // see my_base.h for full description
1227 1228
  virtual void get_dynamic_partition_info(PARTITION_INFO *stat_info,
                                          uint part_id);
1229 1230
  virtual int extra(enum ha_extra_function operation)
  { return 0; }
1231
  virtual int extra_opt(enum ha_extra_function operation, ulong cache_size)
1232
  { return extra(operation); }
1233 1234 1235 1236 1237 1238 1239

  /*
    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; }
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
  /*
    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; }
  /*
    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) {}
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
1260
  virtual void unlock_row() {}
serg@serg.mylan's avatar
serg@serg.mylan committed
1261
  virtual int start_stmt(THD *thd, thr_lock_type lock_type) {return 0;}
1262 1263 1264 1265 1266 1267 1268 1269
  /*
    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
    by one.
  */
  virtual int delete_all_rows()
  { return (my_errno=HA_ERR_WRONG_COMMAND); }
1270 1271 1272 1273
  virtual void get_auto_increment(ulonglong offset, ulonglong increment,
                                  ulonglong nb_desired_values,
                                  ulonglong *first_value,
                                  ulonglong *nb_reserved_values);
1274
private:
1275
  virtual void release_auto_increment() { return; };
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
public:
  void ha_release_auto_increment();
  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;
  }
osku@127.(none)'s avatar
osku@127.(none) committed
1298 1299 1300 1301 1302 1303 1304
  /*
    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)
1305 1306
  { return HA_ERR_WRONG_COMMAND; }

bk@work.mysql.com's avatar
bk@work.mysql.com committed
1307
  virtual void update_create_info(HA_CREATE_INFO *create_info) {}
1308 1309
protected:
  /* to be implemented in handlers */
1310 1311 1312 1313

  /* admin commands - called from mysql_admin_table */
  virtual int check(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327

  /*
     in these two methods check_opt can be modified
     to specify CHECK option to use to call check()
     upon the table
  */
  virtual int check_for_upgrade(HA_CHECK_OPT *check_opt)
  { return 0; }
public:
  int ha_check_for_upgrade(HA_CHECK_OPT *check_opt);
  int check_old_types();
  /* to be actually called to get 'check()' functionality*/
  int ha_check(THD *thd, HA_CHECK_OPT *check_opt);
   
1328 1329
  virtual int backup(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
1330 1331 1332 1333
  /*
    restore assumes .frm file must exist, and that generate_table() has been
    called; It will just copy the data file and run repair.
  */
1334 1335
  virtual int restore(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
1336
protected:
1337 1338
  virtual int repair(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
1339 1340
public:
  int ha_repair(THD* thd, HA_CHECK_OPT* check_opt);
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352
  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; }
  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 bool check_and_repair(THD *thd) { return HA_ERR_WRONG_COMMAND; }
  virtual int dump(THD* thd, int fd = -1) { return HA_ERR_WRONG_COMMAND; }
1353 1354 1355
  virtual int disable_indexes(uint mode) { return HA_ERR_WRONG_COMMAND; }
  virtual int enable_indexes(uint mode) { return HA_ERR_WRONG_COMMAND; }
  virtual int indexes_are_disabled(void) {return 0;}
1356 1357 1358 1359 1360 1361 1362 1363 1364 1365
  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();
  }
1366 1367 1368
  virtual int discard_or_import_tablespace(my_bool discard)
  {return HA_ERR_WRONG_COMMAND;}
  virtual int net_read_dump(NET* net) { return HA_ERR_WRONG_COMMAND; }
1369 1370 1371
  virtual char *update_table_comment(const char * comment)
  { return (char*) comment;}
  virtual void append_create_info(String *packet) {}
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
  /*
    SYNOPSIS
      is_fk_defined_on_table_or_index()
      index            Index to check if foreign key uses it
    RETURN VALUE
       TRUE            Foreign key defined on table or index
       FALSE           No foreign key defined
    DESCRIPTION
      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).
  */
  virtual bool is_fk_defined_on_table_or_index(uint index)
  { return FALSE; }
1386 1387
  virtual char* get_foreign_key_create_info()
  { return(NULL);}  /* gets foreign key create string from InnoDB */
1388
  virtual char* get_tablespace_name(THD *thd)
1389
  { return(NULL);}  /* gets tablespace name from handler */
1390 1391
  /* used in ALTER TABLE; 1 if changing storage engine is allowed */
  virtual bool can_switch_engines() { return 1; }
monty@mysql.com's avatar
monty@mysql.com committed
1392
  /* used in REPLACE; is > 0 if table is referred by a FOREIGN KEY */
1393 1394
  virtual int get_foreign_key_list(THD *thd, List<FOREIGN_KEY_INFO> *f_key_list)
  { return 0; }
monty@mysql.com's avatar
monty@mysql.com committed
1395
  virtual uint referenced_by_foreign_key() { return 0;}
1396
  virtual void init_table_handle_for_HANDLER()
serg@serg.mylan's avatar
serg@serg.mylan committed
1397 1398
  { return; }       /* prepare InnoDB for HANDLER */
  virtual void free_foreign_key_create_info(char* str) {}
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1399 1400 1401
  /* The following can be called without an open handler */
  virtual const char *table_type() const =0;
  virtual const char **bas_ext() const =0;
1402

1403
  virtual int get_default_no_partitions(HA_CREATE_INFO *info) { return 1;}
1404 1405 1406 1407 1408 1409 1410 1411
  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;}
1412

1413
  virtual ulong index_flags(uint idx, uint part, bool all_parts) const =0;
1414

1415
  virtual void prepare_for_alter() { return; }
1416
  virtual int add_index(TABLE *table_arg, KEY *key_info, uint num_of_keys)
1417
  { return (HA_ERR_WRONG_COMMAND); }
1418 1419 1420 1421
  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)
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431
  { 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()); }
1432
  uint max_key_part_length() const
1433 1434 1435 1436 1437 1438
  { 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; }
1439
  virtual uint max_supported_key_part_length() const { return 255; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1440
  virtual uint min_record_length(uint options) const { return 1; }
1441

bk@work.mysql.com's avatar
bk@work.mysql.com committed
1442
  virtual bool low_byte_first() const { return 1; }
serg@serg.mylan's avatar
serg@serg.mylan committed
1443
  virtual uint checksum() const { return 0; }
1444 1445
  virtual bool is_crashed() const  { return 0; }
  virtual bool auto_repair() const { return 0; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1446

1447 1448 1449 1450
  /*
    default rename_table() and delete_table() rename/delete files with a
    given name and extensions from bas_ext()
  */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1451 1452
  virtual int rename_table(const char *from, const char *to);
  virtual int delete_table(const char *name);
1453
  virtual void drop_table(const char *name);
1454
  
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1455
  virtual int create(const char *name, TABLE *form, HA_CREATE_INFO *info)=0;
1456

1457
#define CHF_CREATE_FLAG 0
1458 1459
#define CHF_DELETE_FLAG 1
#define CHF_RENAME_FLAG 2
1460
#define CHF_INDEX_FLAG  3
1461

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

1466 1467 1468 1469 1470 1471 1472
  virtual int change_partitions(HA_CREATE_INFO *create_info,
                                const char *path,
                                ulonglong *copied,
                                ulonglong *deleted,
                                const void *pack_frm_data,
                                uint pack_frm_len)
  { return HA_ERR_WRONG_COMMAND; }
1473 1474
  virtual int drop_partitions(const char *path)
  { return HA_ERR_WRONG_COMMAND; }
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
  virtual int rename_partitions(const char *path)
  { return HA_ERR_WRONG_COMMAND; }
  virtual int optimize_partitions(THD *thd)
  { return HA_ERR_WRONG_COMMAND; }
  virtual int analyze_partitions(THD *thd)
  { return HA_ERR_WRONG_COMMAND; }
  virtual int check_partitions(THD *thd)
  { return HA_ERR_WRONG_COMMAND; }
  virtual int repair_partitions(THD *thd)
  { return HA_ERR_WRONG_COMMAND; }

1486
  /* lock_count() can be more than one if the table is a MERGE */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1487 1488 1489 1490
  virtual uint lock_count(void) const { return 1; }
  virtual THR_LOCK_DATA **store_lock(THD *thd,
				     THR_LOCK_DATA **to,
				     enum thr_lock_type lock_type)=0;
1491 1492 1493

  /* Type of table for caching query */
  virtual uint8 table_cache_type() { return HA_CACHE_TBL_NONTRANSACT; }
1494 1495 1496 1497 1498 1499
  /* ask handler about permission to cache table when query is to be cached */
  virtual my_bool register_query_cache_table(THD *thd, char *table_key,
					     uint key_length,
					     qc_engine_callback 
					     *engine_callback,
					     ulonglong *engine_data)
1500 1501 1502 1503
  {
    *engine_callback= 0;
    return 1;
  }
monty@mysql.com's avatar
monty@mysql.com committed
1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
 /*
  RETURN
    true  Primary key (if there is one) is clustered key covering all fields
    false otherwise
 */
 virtual bool primary_key_is_clustered() { return FALSE; }
 virtual int cmp_ref(const byte *ref1, const byte *ref2)
 {
   return memcmp(ref1, ref2, ref_length);
 }
mskold@mysql.com's avatar
Merge  
mskold@mysql.com committed
1514 1515 1516 1517
 
 /*
   Condition pushdown to storage engines
 */
1518

1519 1520 1521 1522 1523 1524
 /*
   Push condition down to the table handler.
   SYNOPSIS
     cond_push()
     cond   Condition to be pushed. The condition tree must not be            
     modified by the by the caller.
1525

1526 1527 1528 1529
   RETURN
     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.
1530

1531 1532 1533 1534 1535 1536 1537
   NOTES
   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.
   
1538
   handler->ha_reset() call empties the condition stack.
1539 1540 1541
   Calls to rnd_init/rnd_end, index_init/index_end etc do not affect the
   condition stack.
 */ 
mskold@mysql.com's avatar
Merge  
mskold@mysql.com committed
1542
 virtual const COND *cond_push(const COND *cond) { return cond; };
1543 1544 1545 1546 1547 1548
 /*
   Pop the top condition from the condition stack of the handler instance.
   SYNOPSIS
     cond_pop()
     Pops the top if condition stack, if stack is not empty
 */
mskold@mysql.com's avatar
Merge  
mskold@mysql.com committed
1549
 virtual void cond_pop() { return; };
1550 1551 1552
 virtual bool check_if_incompatible_data(HA_CREATE_INFO *create_info,
					 uint table_changes)
 { return COMPATIBLE_DATA_NO; }
1553

1554
 /* These are only called from sql_select for internal temporary tables */
1555 1556 1557
  virtual int write_row(byte *buf __attribute__((unused)))
  {
    return HA_ERR_WRONG_COMMAND;
1558 1559 1560 1561
  }

  virtual int update_row(const byte *old_data __attribute__((unused)),
                         byte *new_data __attribute__((unused)))
1562 1563
  {
    return HA_ERR_WRONG_COMMAND;
1564 1565 1566
  }

  virtual int delete_row(const byte *buf __attribute__((unused)))
1567 1568
  {
    return HA_ERR_WRONG_COMMAND;
1569
  }
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
  /*
    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();

private:
  /*
    Row-level primitives for storage engines.  These should be
    overridden by the storage engine class. To call these methods, use
    the corresponding 'ha_*' method above.
  */
  virtual int external_lock(THD *thd __attribute__((unused)),
                            int lock_type __attribute__((unused)))
  {
    return 0;
  }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1588 1589 1590 1591
};

	/* Some extern variables used with handlers */

1592
extern handlerton *sys_table_types[];
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1593
extern const char *ha_row_type[];
1594
extern TYPELIB tx_isolation_typelib;
1595
extern TYPELIB myisam_stats_method_typelib;
1596
extern ulong total_ha, total_ha_2pc;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1597

1598
	/* Wrapper functions */
1599 1600 1601 1602
#define ha_commit_stmt(thd) (ha_commit_trans((thd), FALSE))
#define ha_rollback_stmt(thd) (ha_rollback_trans((thd), FALSE))
#define ha_commit(thd) (ha_commit_trans((thd), TRUE))
#define ha_rollback(thd) (ha_rollback_trans((thd), TRUE))
1603

1604
/* lookups */
acurtis@xiphis.org's avatar
acurtis@xiphis.org committed
1605 1606
handlerton *ha_default_handlerton(THD *thd);
handlerton *ha_resolve_by_name(THD *thd, const LEX_STRING *name);
1607 1608
handlerton *ha_resolve_by_legacy_type(THD *thd, enum legacy_db_type db_type);
const char *ha_get_storage_engine(enum legacy_db_type db_type);
1609
handler *get_new_handler(TABLE_SHARE *share, MEM_ROOT *alloc,
1610 1611
                         handlerton *db_type);
handlerton *ha_checktype(THD *thd, enum legacy_db_type database_type,
1612
                          bool no_substitute, bool report_error);
1613 1614


serg@serg.mylan's avatar
serg@serg.mylan committed
1615
static inline enum legacy_db_type ha_legacy_type(const handlerton *db_type)
1616 1617 1618 1619
{
  return (db_type == NULL) ? DB_TYPE_UNKNOWN : db_type->db_type;
}

serg@serg.mylan's avatar
serg@serg.mylan committed
1620
static inline const char *ha_resolve_storage_engine_name(const handlerton *db_type)
1621
{
serg@sergbook.mysql.com's avatar
serg@sergbook.mysql.com committed
1622
  return db_type == NULL ? "UNKNOWN" : hton2plugin[db_type->slot]->name.str;
1623 1624
}

serg@serg.mylan's avatar
serg@serg.mylan committed
1625
static inline bool ha_check_storage_engine_flag(const handlerton *db_type, uint32 flag)
1626 1627 1628 1629
{
  return db_type == NULL ? FALSE : test(db_type->flags & flag);
}

serg@serg.mylan's avatar
serg@serg.mylan committed
1630
static inline bool ha_storage_engine_is_enabled(const handlerton *db_type)
1631
{
1632
  return (db_type && db_type->create) ?
1633 1634
         (db_type->state == SHOW_OPTION_YES) : FALSE;
}
1635 1636

/* basic stuff */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1637
int ha_init(void);
acurtis@xiphis.org's avatar
acurtis@xiphis.org committed
1638 1639
int ha_initialize_handlerton(st_plugin_int *plugin);
int ha_finalize_handlerton(st_plugin_int *plugin);
1640

1641
TYPELIB *ha_known_exts(void);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1642
int ha_panic(enum ha_panic_function flag);
1643
void ha_close_connection(THD* thd);
1644
bool ha_flush_logs(handlerton *db_type);
1645
void ha_drop_database(char* path);
1646 1647 1648
int ha_create_table(THD *thd, const char *path,
                    const char *db, const char *table_name,
                    HA_CREATE_INFO *create_info,
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1649
		    bool update_create_info);
1650
int ha_delete_table(THD *thd, handlerton *db_type, const char *path,
1651
                    const char *db, const char *alias, bool generate_warning);
1652

1653
/* statistics and info */
1654
bool ha_show_status(THD *thd, handlerton *db_type, enum ha_stat_type stat);
1655

1656
/* discovery */
1657
int ha_create_table_from_engine(THD* thd, const char *db, const char *name);
1658 1659 1660 1661
int ha_discover(THD* thd, const char* dbname, const char* name,
                const void** frmblob, uint* frmlen);
int ha_find_files(THD *thd,const char *db,const char *path,
                  const char *wild, bool dir,List<char>* files);
1662
int ha_table_exists_in_engine(THD* thd, const char* db, const char* name);
1663 1664

/* key cache */
1665 1666 1667
int ha_init_key_cache(const char *name, KEY_CACHE *key_cache);
int ha_resize_key_cache(KEY_CACHE *key_cache);
int ha_change_key_cache_param(KEY_CACHE *key_cache);
1668
int ha_change_key_cache(KEY_CACHE *old_key_cache, KEY_CACHE *new_key_cache);
1669
int ha_end_key_cache(KEY_CACHE *key_cache);
1670

heikki@hundin.mysql.fi's avatar
heikki@hundin.mysql.fi committed
1671
/* report to InnoDB that control passes to the client */
1672
int ha_release_temporary_latches(THD *thd);
1673 1674 1675

/* transactions: interface to handlerton functions */
int ha_start_consistent_snapshot(THD *thd);
serg@serg.mylan's avatar
serg@serg.mylan committed
1676
int ha_commit_or_rollback_by_xid(XID *xid, bool commit);
1677 1678 1679 1680 1681 1682 1683
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);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1684
int ha_autocommit_or_rollback(THD *thd, int error);
1685
int ha_enable_transaction(THD *thd, bool on);
1686 1687 1688 1689 1690 1691

/* 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);

serg@serg.mylan's avatar
serg@serg.mylan committed
1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702
/* 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))

tomas@poseidon.ndb.mysql.com's avatar
tomas@poseidon.ndb.mysql.com committed
1703 1704 1705 1706
#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);
1707 1708
void ha_binlog_log_query(THD *thd, const handlerton *db_type,
                         enum_binlog_command binlog_command,
tomas@poseidon.ndb.mysql.com's avatar
tomas@poseidon.ndb.mysql.com committed
1709 1710 1711 1712 1713
                         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
1714 1715 1716 1717 1718 1719
#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)
tomas@poseidon.ndb.mysql.com's avatar
tomas@poseidon.ndb.mysql.com committed
1720
#endif