1 /* Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved. 2 3 This program is free software; you can redistribute it and/or modify 4 it under the terms of the GNU General Public License, version 2.0, 5 as published by the Free Software Foundation. 6 7 This program is also distributed with certain software (including 8 but not limited to OpenSSL) that is licensed under separate terms, 9 as designated in a particular file or component or in included license 10 documentation. The authors of MySQL hereby grant you an additional 11 permission to link the program and your derivative works with the 12 separately licensed software that they have included with MySQL. 13 14 This program is distributed in the hope that it will be useful, 15 but WITHOUT ANY WARRANTY; without even the implied warranty of 16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 GNU General Public License, version 2.0, for more details. 18 19 You should have received a copy of the GNU General Public License 20 along with this program; if not, write to the Free Software Foundation, 21 Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA */ 22 23 24 /* This file includes constants used with all databases */ 25 26 #ifndef _my_base_h 27 #define _my_base_h 28 29 #ifndef stdin /* Included first in handler */ 30 #define CHSIZE_USED 31 #include <my_global.h> 32 #include <my_dir.h> /* This includes types */ 33 #include <my_sys.h> 34 #include <m_string.h> 35 #include <errno.h> 36 37 #ifndef EOVERFLOW 38 #define EOVERFLOW 84 39 #endif 40 41 #endif /* stdin */ 42 #include <my_list.h> 43 44 /* The following is bits in the flag parameter to ha_open() */ 45 46 #define HA_OPEN_ABORT_IF_LOCKED 0 /* default */ 47 #define HA_OPEN_WAIT_IF_LOCKED 1 48 #define HA_OPEN_IGNORE_IF_LOCKED 2 49 #define HA_OPEN_TMP_TABLE 4 /* Table is a temp table */ 50 #define HA_OPEN_DELAY_KEY_WRITE 8 /* Don't update index */ 51 #define HA_OPEN_ABORT_IF_CRASHED 16 52 #define HA_OPEN_FOR_REPAIR 32 /* open even if crashed */ 53 #define HA_OPEN_FROM_SQL_LAYER 64 54 #define HA_OPEN_MMAP 128 /* open memory mapped */ 55 #define HA_OPEN_COPY 256 /* Open copy (for repair) */ 56 /* Internal temp table, used for temporary results */ 57 #define HA_OPEN_INTERNAL_TABLE 512 58 /** 59 Don't connect any share_psi to the handler, since it is a partition. 60 It would not be used, since partitions don't call unbind_psi()/rebind_psi(). 61 */ 62 #define HA_OPEN_NO_PSI_CALL 1024 /* Don't call/connect PSI */ 63 64 /* The following is parameter to ha_rkey() how to use key */ 65 66 /* 67 We define a complete-field prefix of a key value as a prefix where 68 the last included field in the prefix contains the full field, not 69 just some bytes from the start of the field. A partial-field prefix 70 is allowed to contain only a few first bytes from the last included 71 field. 72 73 Below HA_READ_KEY_EXACT, ..., HA_READ_BEFORE_KEY can take a 74 complete-field prefix of a key value as the search 75 key. HA_READ_PREFIX and HA_READ_PREFIX_LAST could also take a 76 partial-field prefix, but currently (4.0.10) they are only used with 77 complete-field prefixes. MySQL uses a padding trick to implement 78 LIKE 'abc%' queries. 79 80 NOTE that in InnoDB HA_READ_PREFIX_LAST will NOT work with a 81 partial-field prefix because InnoDB currently strips spaces from the 82 end of varchar fields! 83 */ 84 85 enum ha_rkey_function { 86 HA_READ_KEY_EXACT, /* Find first record else error */ 87 HA_READ_KEY_OR_NEXT, /* Record or next record */ 88 HA_READ_KEY_OR_PREV, /* Record or previous */ 89 HA_READ_AFTER_KEY, /* Find next rec. after key-record */ 90 HA_READ_BEFORE_KEY, /* Find next rec. before key-record */ 91 HA_READ_PREFIX, /* Key which as same prefix */ 92 HA_READ_PREFIX_LAST, /* Last key with the same prefix */ 93 HA_READ_PREFIX_LAST_OR_PREV, /* Last or prev key with the same prefix */ 94 HA_READ_MBR_CONTAIN, /* Minimum Bounding Rectangle contains */ 95 HA_READ_MBR_INTERSECT, /* Minimum Bounding Rectangle intersect */ 96 HA_READ_MBR_WITHIN, /* Minimum Bounding Rectangle within */ 97 HA_READ_MBR_DISJOINT, /* Minimum Bounding Rectangle disjoint */ 98 HA_READ_MBR_EQUAL /* Minimum Bounding Rectangle equal */ 99 }; 100 101 /* Key algorithm types */ 102 103 enum ha_key_alg { 104 HA_KEY_ALG_UNDEF= 0, /* Not specified (old file) */ 105 HA_KEY_ALG_BTREE= 1, /* B-tree, default one */ 106 HA_KEY_ALG_RTREE= 2, /* R-tree, for spatial searches */ 107 HA_KEY_ALG_HASH= 3, /* HASH keys (HEAP tables) */ 108 HA_KEY_ALG_FULLTEXT= 4 /* FULLTEXT (MyISAM tables) */ 109 }; 110 111 /* Storage media types */ 112 113 enum ha_storage_media { 114 HA_SM_DEFAULT= 0, /* Not specified (engine default) */ 115 HA_SM_DISK= 1, /* DISK storage */ 116 HA_SM_MEMORY= 2 /* MAIN MEMORY storage */ 117 }; 118 119 /* The following is parameter to ha_extra() */ 120 121 enum ha_extra_function { 122 HA_EXTRA_NORMAL=0, /* Optimize for space (def) */ 123 HA_EXTRA_QUICK=1, /* Optimize for speed */ 124 HA_EXTRA_NOT_USED=2, 125 HA_EXTRA_CACHE=3, /* Cache record in HA_rrnd() */ 126 HA_EXTRA_NO_CACHE=4, /* End caching of records (def) */ 127 HA_EXTRA_NO_READCHECK=5, /* No readcheck on update */ 128 HA_EXTRA_READCHECK=6, /* Use readcheck (def) */ 129 HA_EXTRA_KEYREAD=7, /* Read only key to database */ 130 HA_EXTRA_NO_KEYREAD=8, /* Normal read of records (def) */ 131 HA_EXTRA_NO_USER_CHANGE=9, /* No user is allowed to write */ 132 HA_EXTRA_KEY_CACHE=10, 133 HA_EXTRA_NO_KEY_CACHE=11, 134 HA_EXTRA_WAIT_LOCK=12, /* Wait until file is avalably (def) */ 135 HA_EXTRA_NO_WAIT_LOCK=13, /* If file is locked, return quickly */ 136 HA_EXTRA_WRITE_CACHE=14, /* Use write cache in ha_write() */ 137 HA_EXTRA_FLUSH_CACHE=15, /* flush write_record_cache */ 138 HA_EXTRA_NO_KEYS=16, /* Remove all update of keys */ 139 HA_EXTRA_KEYREAD_CHANGE_POS=17, /* Keyread, but change pos */ 140 /* xxxxchk -r must be used */ 141 HA_EXTRA_REMEMBER_POS=18, /* Remember pos for next/prev */ 142 HA_EXTRA_RESTORE_POS=19, 143 HA_EXTRA_REINIT_CACHE=20, /* init cache from current record */ 144 HA_EXTRA_FORCE_REOPEN=21, /* Datafile have changed on disk */ 145 HA_EXTRA_FLUSH, /* Flush tables to disk */ 146 HA_EXTRA_NO_ROWS, /* Don't write rows */ 147 HA_EXTRA_RESET_STATE, /* Reset positions */ 148 HA_EXTRA_IGNORE_DUP_KEY, /* Dup keys don't rollback everything*/ 149 HA_EXTRA_NO_IGNORE_DUP_KEY, 150 HA_EXTRA_PREPARE_FOR_DROP, 151 HA_EXTRA_PREPARE_FOR_UPDATE, /* Remove read cache if problems */ 152 HA_EXTRA_PRELOAD_BUFFER_SIZE, /* Set buffer size for preloading */ 153 /* 154 On-the-fly switching between unique and non-unique key inserting. 155 */ 156 HA_EXTRA_CHANGE_KEY_TO_UNIQUE, 157 HA_EXTRA_CHANGE_KEY_TO_DUP, 158 /* 159 When using HA_EXTRA_KEYREAD, overwrite only key member fields and keep 160 other fields intact. When this is off (by default) InnoDB will use memcpy 161 to overwrite entire row. 162 */ 163 HA_EXTRA_KEYREAD_PRESERVE_FIELDS, 164 HA_EXTRA_MMAP, 165 /* 166 Ignore if the a tuple is not found, continue processing the 167 transaction and ignore that 'row'. Needed for idempotency 168 handling on the slave 169 170 Currently only used by NDB storage engine. Partition handler ignores flag. 171 */ 172 HA_EXTRA_IGNORE_NO_KEY, 173 HA_EXTRA_NO_IGNORE_NO_KEY, 174 /* 175 Mark the table as a log table. For some handlers (e.g. CSV) this results 176 in a special locking for the table. 177 */ 178 HA_EXTRA_MARK_AS_LOG_TABLE, 179 /* 180 Informs handler that write_row() which tries to insert new row into the 181 table and encounters some already existing row with same primary/unique 182 key can replace old row with new row instead of reporting error (basically 183 it informs handler that we do REPLACE instead of simple INSERT). 184 Off by default. 185 */ 186 HA_EXTRA_WRITE_CAN_REPLACE, 187 HA_EXTRA_WRITE_CANNOT_REPLACE, 188 /* 189 Inform handler that delete_row()/update_row() cannot batch deletes/updates 190 and should perform them immediately. This may be needed when table has 191 AFTER DELETE/UPDATE triggers which access to subject table. 192 These flags are reset by the handler::extra(HA_EXTRA_RESET) call. 193 */ 194 HA_EXTRA_DELETE_CANNOT_BATCH, 195 HA_EXTRA_UPDATE_CANNOT_BATCH, 196 /* 197 Inform handler that an "INSERT...ON DUPLICATE KEY UPDATE" will be 198 executed. This condition is unset by HA_EXTRA_NO_IGNORE_DUP_KEY. 199 */ 200 HA_EXTRA_INSERT_WITH_UPDATE, 201 /* Inform handler that we will do a rename */ 202 HA_EXTRA_PREPARE_FOR_RENAME, 203 /* 204 Special actions for MERGE tables. 205 */ 206 HA_EXTRA_ADD_CHILDREN_LIST, 207 HA_EXTRA_ATTACH_CHILDREN, 208 HA_EXTRA_IS_ATTACHED_CHILDREN, 209 HA_EXTRA_DETACH_CHILDREN, 210 /* 211 Prepare table for export 212 (e.g. quiesce the table and write table metadata). 213 */ 214 HA_EXTRA_EXPORT, 215 /** Do secondary sort by handler::ref (rowid) after key sort. */ 216 HA_EXTRA_SECONDARY_SORT_ROWID 217 }; 218 219 /* Compatible option, to be deleted in 6.0 */ 220 #define HA_EXTRA_PREPARE_FOR_DELETE HA_EXTRA_PREPARE_FOR_DROP 221 222 /* The following is parameter to ha_panic() */ 223 224 enum ha_panic_function { 225 HA_PANIC_CLOSE, /* Close all databases */ 226 HA_PANIC_WRITE, /* Unlock and write status */ 227 HA_PANIC_READ /* Lock and read keyinfo */ 228 }; 229 230 /* The following is parameter to ha_create(); keytypes */ 231 232 enum ha_base_keytype { 233 HA_KEYTYPE_END=0, 234 HA_KEYTYPE_TEXT=1, /* Key is sorted as letters */ 235 HA_KEYTYPE_BINARY=2, /* Key is sorted as unsigned chars */ 236 HA_KEYTYPE_SHORT_INT=3, 237 HA_KEYTYPE_LONG_INT=4, 238 HA_KEYTYPE_FLOAT=5, 239 HA_KEYTYPE_DOUBLE=6, 240 HA_KEYTYPE_NUM=7, /* Not packed num with pre-space */ 241 HA_KEYTYPE_USHORT_INT=8, 242 HA_KEYTYPE_ULONG_INT=9, 243 HA_KEYTYPE_LONGLONG=10, 244 HA_KEYTYPE_ULONGLONG=11, 245 HA_KEYTYPE_INT24=12, 246 HA_KEYTYPE_UINT24=13, 247 HA_KEYTYPE_INT8=14, 248 /* Varchar (0-255 bytes) with length packed with 1 byte */ 249 HA_KEYTYPE_VARTEXT1=15, /* Key is sorted as letters */ 250 HA_KEYTYPE_VARBINARY1=16, /* Key is sorted as unsigned chars */ 251 /* Varchar (0-65535 bytes) with length packed with 2 bytes */ 252 HA_KEYTYPE_VARTEXT2=17, /* Key is sorted as letters */ 253 HA_KEYTYPE_VARBINARY2=18, /* Key is sorted as unsigned chars */ 254 HA_KEYTYPE_BIT=19 255 }; 256 257 #define HA_MAX_KEYTYPE 31 /* Must be log2-1 */ 258 259 /* These flags kan be OR:ed to key-flag */ 260 261 #define HA_NOSAME 1 /* Set if not dupplicated records */ 262 #define HA_PACK_KEY 2 /* Pack string key to previous key */ 263 #define HA_AUTO_KEY 16 264 #define HA_BINARY_PACK_KEY 32 /* Packing of all keys to prev key */ 265 #define HA_FULLTEXT 128 /* For full-text search */ 266 #define HA_UNIQUE_CHECK 256 /* Check the key for uniqueness */ 267 #define HA_SPATIAL 1024 /* For spatial search */ 268 #define HA_NULL_ARE_EQUAL 2048 /* NULL in key are cmp as equal */ 269 #define HA_GENERATED_KEY 8192 /* Automaticly generated key */ 270 #define HA_CLUSTERING (1<<31) /* TokuDB CLUSTERING key */ 271 272 /* The combination of the above can be used for key type comparison. */ 273 #define HA_KEYFLAG_MASK (HA_NOSAME | HA_PACK_KEY | HA_AUTO_KEY | \ 274 HA_BINARY_PACK_KEY | HA_FULLTEXT | HA_UNIQUE_CHECK | \ 275 HA_SPATIAL | HA_NULL_ARE_EQUAL | HA_GENERATED_KEY | \ 276 HA_CLUSTERING) 277 278 /* 279 Key contains partial segments. 280 281 This flag is internal to the MySQL server by design. It is not supposed 282 neither to be saved in FRM-files, nor to be passed to storage engines. 283 It is intended to pass information into internal static sort_keys(KEY *, 284 KEY *) function. 285 286 This flag can be calculated -- it's based on key lengths comparison. 287 */ 288 #define HA_KEY_HAS_PART_KEY_SEG 65536 289 290 /* Automatic bits in key-flag */ 291 292 #define HA_SPACE_PACK_USED 4 /* Test for if SPACE_PACK used */ 293 #define HA_VAR_LENGTH_KEY 8 294 #define HA_NULL_PART_KEY 64 295 #define HA_USES_COMMENT 4096 296 #define HA_USES_PARSER 16384 /* Fulltext index uses [pre]parser */ 297 #define HA_USES_BLOCK_SIZE ((uint) 32768) 298 #define HA_SORT_ALLOWS_SAME 512 /* Intern bit when sorting records */ 299 300 /* These flags can be added to key-seg-flag */ 301 302 #define HA_SPACE_PACK 1 /* Pack space in key-seg */ 303 #define HA_PART_KEY_SEG 4 /* Used by MySQL for part-key-cols */ 304 #define HA_VAR_LENGTH_PART 8 305 #define HA_NULL_PART 16 306 #define HA_BLOB_PART 32 307 #define HA_SWAP_KEY 64 308 #define HA_REVERSE_SORT 128 /* Sort key in reverse order */ 309 #define HA_NO_SORT 256 /* do not bother sorting on this keyseg */ 310 /* 311 End space in unique/varchar are considered equal. (Like 'a' and 'a ') 312 Only needed for internal temporary tables. 313 */ 314 #define HA_END_SPACE_ARE_EQUAL 512 315 #define HA_BIT_PART 1024 316 317 /* optionbits for database */ 318 #define HA_OPTION_PACK_RECORD 1 319 #define HA_OPTION_PACK_KEYS 2 320 #define HA_OPTION_COMPRESS_RECORD 4 321 #define HA_OPTION_LONG_BLOB_PTR 8 /* new ISAM format */ 322 #define HA_OPTION_TMP_TABLE 16 323 #define HA_OPTION_CHECKSUM 32 324 #define HA_OPTION_DELAY_KEY_WRITE 64 325 #define HA_OPTION_NO_PACK_KEYS 128 /* Reserved for MySQL */ 326 #define HA_OPTION_CREATE_FROM_ENGINE 256 327 #define HA_OPTION_RELIES_ON_SQL_LAYER 512 328 #define HA_OPTION_NULL_FIELDS 1024 329 #define HA_OPTION_PAGE_CHECKSUM 2048 330 /** STATS_PERSISTENT=1 has been specified in the SQL command (either CREATE 331 or ALTER TABLE). Table and index statistics that are collected by the 332 storage engine and used by the optimizer for query optimization will be 333 stored on disk and will not change after a server restart. */ 334 #define HA_OPTION_STATS_PERSISTENT 4096 335 /** STATS_PERSISTENT=0 has been specified in CREATE/ALTER TABLE. Statistics 336 for the table will be wiped away on server shutdown and new ones recalculated 337 after the server is started again. If none of HA_OPTION_STATS_PERSISTENT or 338 HA_OPTION_NO_STATS_PERSISTENT is set, this means that the setting is not 339 explicitly set at table level and the corresponding table will use whatever 340 is the global server default. */ 341 #define HA_OPTION_NO_STATS_PERSISTENT 8192 342 #define HA_OPTION_TEMP_COMPRESS_RECORD ((uint) 16384) /* set by isamchk */ 343 #define HA_OPTION_READ_ONLY_DATA ((uint) 32768) /* Set by isamchk */ 344 345 /* Bits in flag to create() */ 346 347 #define HA_DONT_TOUCH_DATA 1 /* Don't empty datafile (isamchk) */ 348 #define HA_PACK_RECORD 2 /* Request packed record format */ 349 #define HA_CREATE_TMP_TABLE 4 350 #define HA_CREATE_CHECKSUM 8 351 #define HA_CREATE_KEEP_FILES 16 /* don't overwrite .MYD and MYI */ 352 #define HA_CREATE_PAGE_CHECKSUM 32 353 #define HA_CREATE_DELAY_KEY_WRITE 64 354 #define HA_CREATE_RELIES_ON_SQL_LAYER 128 355 #define HA_CREATE_INTERNAL_TABLE 256 356 357 /* 358 The following flags (OR-ed) are passed to handler::info() method. 359 The method copies misc handler information out of the storage engine 360 to data structures accessible from MySQL 361 362 Same flags are also passed down to mi_status, myrg_status, etc. 363 */ 364 365 /* this one is not used */ 366 #define HA_STATUS_POS 1 367 /* 368 assuming the table keeps shared actual copy of the 'info' and 369 local, possibly outdated copy, the following flag means that 370 it should not try to get the actual data (locking the shared structure) 371 slightly outdated version will suffice 372 */ 373 #define HA_STATUS_NO_LOCK 2 374 /* update the time of the last modification (in handler::update_time) */ 375 #define HA_STATUS_TIME 4 376 /* 377 update the 'constant' part of the info: 378 handler::max_data_file_length, max_index_file_length, create_time 379 sortkey, ref_length, block_size, data_file_name, index_file_name. 380 handler::table->s->keys_in_use, keys_for_keyread, rec_per_key 381 */ 382 #define HA_STATUS_CONST 8 383 /* 384 update the 'variable' part of the info: 385 handler::records, deleted, data_file_length, index_file_length, 386 check_time, mean_rec_length 387 */ 388 #define HA_STATUS_VARIABLE 16 389 /* 390 get the information about the key that caused last duplicate value error 391 update handler::errkey and handler::dupp_ref 392 see handler::get_dup_key() 393 */ 394 #define HA_STATUS_ERRKEY 32 395 /* 396 update handler::auto_increment_value 397 */ 398 #define HA_STATUS_AUTO 64 399 /* 400 Get also delete_length when HA_STATUS_VARIABLE is called. It's ok to set it also 401 when only HA_STATUS_VARIABLE but it won't be used. 402 */ 403 #define HA_STATUS_VARIABLE_EXTRA 128 404 405 /* 406 Errorcodes given by handler functions 407 408 opt_sum_query() assumes these codes are > 1 409 Do not add error numbers before HA_ERR_FIRST. 410 If necessary to add lower numbers, change HA_ERR_FIRST accordingly. 411 */ 412 #define HA_ERR_FIRST 120 /* Copy of first error nr.*/ 413 414 #define HA_ERR_KEY_NOT_FOUND 120 /* Didn't find key on read or update */ 415 #define HA_ERR_FOUND_DUPP_KEY 121 /* Dupplicate key on write */ 416 #define HA_ERR_INTERNAL_ERROR 122 /* Internal error */ 417 #define HA_ERR_RECORD_CHANGED 123 /* Uppdate with is recoverable */ 418 #define HA_ERR_WRONG_INDEX 124 /* Wrong index given to function */ 419 #define HA_ERR_CRASHED 126 /* Indexfile is crashed */ 420 #define HA_ERR_WRONG_IN_RECORD 127 /* Record-file is crashed */ 421 #define HA_ERR_OUT_OF_MEM 128 /* Record-file is crashed */ 422 #define HA_ERR_NOT_A_TABLE 130 /* not a MYI file - no signature */ 423 #define HA_ERR_WRONG_COMMAND 131 /* Command not supported */ 424 #define HA_ERR_OLD_FILE 132 /* old databasfile */ 425 #define HA_ERR_NO_ACTIVE_RECORD 133 /* No record read in update() */ 426 #define HA_ERR_RECORD_DELETED 134 /* A record is not there */ 427 #define HA_ERR_RECORD_FILE_FULL 135 /* No more room in file */ 428 #define HA_ERR_INDEX_FILE_FULL 136 /* No more room in file */ 429 #define HA_ERR_END_OF_FILE 137 /* end in next/prev/first/last */ 430 #define HA_ERR_UNSUPPORTED 138 /* unsupported extension used */ 431 #define HA_ERR_TO_BIG_ROW 139 /* Too big row */ 432 #define HA_WRONG_CREATE_OPTION 140 /* Wrong create option */ 433 #define HA_ERR_FOUND_DUPP_UNIQUE 141 /* Dupplicate unique on write */ 434 #define HA_ERR_UNKNOWN_CHARSET 142 /* Can't open charset */ 435 #define HA_ERR_WRONG_MRG_TABLE_DEF 143 /* conflicting tables in MERGE */ 436 #define HA_ERR_CRASHED_ON_REPAIR 144 /* Last (automatic?) repair failed */ 437 #define HA_ERR_CRASHED_ON_USAGE 145 /* Table must be repaired */ 438 #define HA_ERR_LOCK_WAIT_TIMEOUT 146 439 #define HA_ERR_LOCK_TABLE_FULL 147 440 #define HA_ERR_READ_ONLY_TRANSACTION 148 /* Updates not allowed */ 441 #define HA_ERR_LOCK_DEADLOCK 149 442 #define HA_ERR_CANNOT_ADD_FOREIGN 150 /* Cannot add a foreign key constr. */ 443 #define HA_ERR_NO_REFERENCED_ROW 151 /* Cannot add a child row */ 444 #define HA_ERR_ROW_IS_REFERENCED 152 /* Cannot delete a parent row */ 445 #define HA_ERR_NO_SAVEPOINT 153 /* No savepoint with that name */ 446 #define HA_ERR_NON_UNIQUE_BLOCK_SIZE 154 /* Non unique key block size */ 447 #define HA_ERR_NO_SUCH_TABLE 155 /* The table does not exist in engine */ 448 #define HA_ERR_TABLE_EXIST 156 /* The table existed in storage engine */ 449 #define HA_ERR_NO_CONNECTION 157 /* Could not connect to storage engine */ 450 /* NULLs are not supported in spatial index */ 451 #define HA_ERR_NULL_IN_SPATIAL 158 452 #define HA_ERR_TABLE_DEF_CHANGED 159 /* The table changed in storage engine */ 453 /* There's no partition in table for given value */ 454 #define HA_ERR_NO_PARTITION_FOUND 160 455 #define HA_ERR_RBR_LOGGING_FAILED 161 /* Row-based binlogging of row failed */ 456 #define HA_ERR_DROP_INDEX_FK 162 /* Index needed in foreign key constr */ 457 /* 458 Upholding foreign key constraints would lead to a duplicate key error 459 in some other table. 460 */ 461 #define HA_ERR_FOREIGN_DUPLICATE_KEY 163 462 /* The table changed in storage engine */ 463 #define HA_ERR_TABLE_NEEDS_UPGRADE 164 464 #define HA_ERR_TABLE_READONLY 165 /* The table is not writable */ 465 466 #define HA_ERR_AUTOINC_READ_FAILED 166 /* Failed to get next autoinc value */ 467 #define HA_ERR_AUTOINC_ERANGE 167 /* Failed to set row autoinc value */ 468 #define HA_ERR_GENERIC 168 /* Generic error */ 469 /* row not actually updated: new values same as the old values */ 470 #define HA_ERR_RECORD_IS_THE_SAME 169 471 /* It is not possible to log this statement */ 472 #define HA_ERR_LOGGING_IMPOSSIBLE 170 /* It is not possible to log this 473 statement */ 474 #define HA_ERR_CORRUPT_EVENT 171 /* The event was corrupt, leading to 475 illegal data being read */ 476 #define HA_ERR_NEW_FILE 172 /* New file format */ 477 #define HA_ERR_ROWS_EVENT_APPLY 173 /* The event could not be processed 478 no other hanlder error happened */ 479 #define HA_ERR_INITIALIZATION 174 /* Error during initialization */ 480 #define HA_ERR_FILE_TOO_SHORT 175 /* File too short */ 481 #define HA_ERR_WRONG_CRC 176 /* Wrong CRC on page */ 482 #define HA_ERR_TOO_MANY_CONCURRENT_TRXS 177 /*Too many active concurrent transactions */ 483 /* There's no explicitly listed partition in table for the given value */ 484 #define HA_ERR_NOT_IN_LOCK_PARTITIONS 178 485 #define HA_ERR_INDEX_COL_TOO_LONG 179 /* Index column length exceeds limit */ 486 #define HA_ERR_INDEX_CORRUPT 180 /* InnoDB index corrupted */ 487 #define HA_ERR_UNDO_REC_TOO_BIG 181 /* Undo log record too big */ 488 #define HA_FTS_INVALID_DOCID 182 /* Invalid InnoDB Doc ID */ 489 #define HA_ERR_TABLE_IN_FK_CHECK 183 /* Table being used in foreign key check */ 490 #define HA_ERR_TABLESPACE_EXISTS 184 /* The tablespace existed in storage engine */ 491 #define HA_ERR_TOO_MANY_FIELDS 185 /* Table has too many columns */ 492 #define HA_ERR_ROW_IN_WRONG_PARTITION 186 /* Row in wrong partition */ 493 #define HA_ERR_INNODB_READ_ONLY 187 /* InnoDB is in read only mode. */ 494 #define HA_ERR_FTS_EXCEED_RESULT_CACHE_LIMIT 188 /* FTS query exceeds result cache limit */ 495 #define HA_ERR_TEMP_FILE_WRITE_FAILURE 189 /* Temporary file write failure */ 496 #define HA_ERR_INNODB_FORCED_RECOVERY 190 /* Innodb is in force recovery mode */ 497 #define HA_ERR_FTS_TOO_MANY_WORDS_IN_PHRASE 191 /* Too many words in a phrase */ 498 #define HA_ERR_DEST_SCHEMA_NOT_EXIST 192 /* Destination schema does not exist */ 499 #define HA_ERR_FTS_TOO_MANY_NESTED_EXP 193 /* Too many sub-expression in search string */ 500 #define HA_ERR_LAST 193 /* Copy of last error nr */ 501 502 /* Number of different errors */ 503 #define HA_ERR_ERRORS (HA_ERR_LAST - HA_ERR_FIRST + 1) 504 505 /* Other constants */ 506 507 #define HA_NAMELEN 64 /* Max length of saved filename */ 508 #define NO_SUCH_KEY (~(uint)0) /* used as a key no. */ 509 510 typedef ulong key_part_map; 511 #define HA_WHOLE_KEY (~(key_part_map)0) 512 513 /* Intern constants in databases */ 514 515 /* bits in _search */ 516 #define SEARCH_FIND 1 517 #define SEARCH_NO_FIND 2 518 #define SEARCH_SAME 4 519 #define SEARCH_BIGGER 8 520 #define SEARCH_SMALLER 16 521 #define SEARCH_SAVE_BUFF 32 522 #define SEARCH_UPDATE 64 523 #define SEARCH_PREFIX 128 524 #define SEARCH_LAST 256 525 #define MBR_CONTAIN 512 526 #define MBR_INTERSECT 1024 527 #define MBR_WITHIN 2048 528 #define MBR_DISJOINT 4096 529 #define MBR_EQUAL 8192 530 #define MBR_DATA 16384 531 #define SEARCH_NULL_ARE_EQUAL 32768 /* NULL in keys are equal */ 532 #define SEARCH_NULL_ARE_NOT_EQUAL 65536 /* NULL in keys are not equal */ 533 534 /* bits in opt_flag */ 535 #define QUICK_USED 1 536 #define READ_CACHE_USED 2 537 #define READ_CHECK_USED 4 538 #define KEY_READ_USED 8 539 #define WRITE_CACHE_USED 16 540 #define OPT_NO_ROWS 32 541 542 /* bits in update */ 543 #define HA_STATE_CHANGED 1 /* Database has changed */ 544 #define HA_STATE_AKTIV 2 /* Has a current record */ 545 #define HA_STATE_WRITTEN 4 /* Record is written */ 546 #define HA_STATE_DELETED 8 547 #define HA_STATE_NEXT_FOUND 16 /* Next found record (record before) */ 548 #define HA_STATE_PREV_FOUND 32 /* Prev found record (record after) */ 549 #define HA_STATE_NO_KEY 64 /* Last read didn't find record */ 550 #define HA_STATE_KEY_CHANGED 128 551 #define HA_STATE_WRITE_AT_END 256 /* set in _ps_find_writepos */ 552 #define HA_STATE_BUFF_SAVED 512 /* If current keybuff is info->buff */ 553 #define HA_STATE_ROW_CHANGED 1024 /* To invalide ROW cache */ 554 #define HA_STATE_EXTEND_BLOCK 2048 555 556 /* myisampack expects no more than 32 field types. */ 557 enum en_fieldtype { 558 FIELD_LAST=-1,FIELD_NORMAL,FIELD_SKIP_ENDSPACE,FIELD_SKIP_PRESPACE, 559 FIELD_SKIP_ZERO,FIELD_BLOB,FIELD_CONSTANT,FIELD_INTERVALL,FIELD_ZERO, 560 FIELD_VARCHAR,FIELD_CHECK, 561 FIELD_enum_val_count 562 }; 563 564 enum data_file_type { 565 STATIC_RECORD, DYNAMIC_RECORD, COMPRESSED_RECORD, BLOCK_RECORD 566 }; 567 568 /* For key ranges */ 569 570 enum key_range_flag { 571 NO_MIN_RANGE= 1 << 0, ///< from -inf 572 NO_MAX_RANGE= 1 << 1, ///< to +inf 573 /* X < key, i.e. not including the left endpoint */ 574 NEAR_MIN= 1 << 2, 575 /* X > key, i.e. not including the right endpoint */ 576 NEAR_MAX= 1 << 3, 577 /* 578 This flag means that index is a unique index, and the interval is 579 equivalent to "AND(keypart_i = const_i)", where all of const_i are 580 not NULLs. 581 */ 582 UNIQUE_RANGE= 1 << 4, 583 /* 584 This flag means that the interval is equivalent to 585 "AND(keypart_i = const_i)", where not all key parts may be used 586 but all of const_i are not NULLs. 587 */ 588 EQ_RANGE= 1 << 5, 589 /* 590 This flag has the same meaning as UNIQUE_RANGE, except that for at 591 least one keypart the condition is "keypart IS NULL". 592 */ 593 NULL_RANGE= 1 << 6, 594 GEOM_FLAG= 1 << 7, ///< GIS 595 /* Deprecated, currently used only by NDB at row retrieval */ 596 SKIP_RANGE= 1 << 8, 597 /* 598 Used together with EQ_RANGE to indicate that index statistics 599 should be used instead of sampling the index. 600 */ 601 USE_INDEX_STATISTICS= 1 << 9 602 }; 603 604 605 typedef struct st_key_range 606 { 607 const uchar *key; 608 uint length; 609 key_part_map keypart_map; 610 enum ha_rkey_function flag; 611 } key_range; 612 613 typedef struct st_key_multi_range 614 { 615 key_range start_key; 616 key_range end_key; 617 char *ptr; /* Free to use by caller (ptr to row etc) */ 618 uint range_flag; /* key range flags see above */ 619 } KEY_MULTI_RANGE; 620 621 622 /* For number of records */ 623 #ifdef BIG_TABLES 624 #define rows2double(A) ulonglong2double(A) 625 typedef my_off_t ha_rows; 626 #else 627 #define rows2double(A) (double) (A) 628 typedef ulong ha_rows; 629 #endif 630 631 #define HA_POS_ERROR (~ (ha_rows) 0) 632 #define HA_OFFSET_ERROR (~ (my_off_t) 0) 633 634 #if SYSTEM_SIZEOF_OFF_T == 4 635 #define MAX_FILE_SIZE INT_MAX32 636 #else 637 #define MAX_FILE_SIZE LONGLONG_MAX 638 #endif 639 640 #define HA_VARCHAR_PACKLENGTH(field_length) ((field_length) < 256 ? 1 :2) 641 642 /* invalidator function reference for Query Cache */ 643 C_MODE_START 644 typedef void (* invalidator_by_filename)(const char * filename); 645 C_MODE_END 646 647 #endif /* _my_base_h */ 648