drizzle
C++ MySQL-protocol-compatible database server
Loading...
Searching...
No Matches
base.h
1/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3 *
4 * Copyright (C) 2008 Sun Microsystems, Inc.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; version 2 of the License.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19
20/* This file includes constants used with all databases */
21
27
29
30#pragma once
31
32namespace drizzled
33{
34
35/* The following is bits in the flag parameter to ha_open() */
36
37#define HA_OPEN_ABORT_IF_LOCKED 0 /* default */
38#define HA_OPEN_WAIT_IF_LOCKED 1
39#define HA_OPEN_IGNORE_IF_LOCKED 2
40#define HA_OPEN_TMP_TABLE 4 /* Table is a temp table */
41/* Internal temp table, used for temporary results */
42#define HA_OPEN_INTERNAL_TABLE 512
43
44/* The following is parameter to ha_rkey() how to use key */
45
46/*
47 We define a complete-field prefix of a key value as a prefix where
48 the last included field in the prefix contains the full field, not
49 just some bytes from the start of the field. A partial-field prefix
50 is allowed to contain only a few first bytes from the last included
51 field.
52
53 Below HA_READ_KEY_EXACT, ..., HA_READ_BEFORE_KEY can take a
54 complete-field prefix of a key value as the search
55 key. HA_READ_PREFIX and HA_READ_PREFIX_LAST could also take a
56 partial-field prefix, but currently (4.0.10) they are only used with
57 complete-field prefixes. MySQL uses a padding trick to implement
58 LIKE 'abc%' queries.
59
60 NOTE that in InnoDB HA_READ_PREFIX_LAST will NOT work with a
61 partial-field prefix because InnoDB currently strips spaces from the
62 end of varchar fields!
63*/
64
65enum ha_rkey_function {
66 HA_READ_KEY_EXACT, /* Find first record else error */
67 HA_READ_KEY_OR_NEXT, /* Record or next record */
68 HA_READ_KEY_OR_PREV, /* Record or previous */
69 HA_READ_AFTER_KEY, /* Find next rec. after key-record */
70 HA_READ_BEFORE_KEY, /* Find next rec. before key-record */
71 HA_READ_PREFIX, /* Key which as same prefix */
72 HA_READ_PREFIX_LAST, /* Last key with the same prefix */
73 HA_READ_PREFIX_LAST_OR_PREV, /* Last or prev key with the same prefix */
74 HA_READ_MBR_CONTAIN,
75 HA_READ_MBR_INTERSECT,
76 HA_READ_MBR_WITHIN,
77 HA_READ_MBR_DISJOINT,
78 HA_READ_MBR_EQUAL
79};
80
81 /* The following is parameter to ha_extra() */
82
83enum ha_extra_function {
84 HA_EXTRA_NORMAL=0, /* Optimize for space (def) */
85 HA_EXTRA_QUICK=1, /* Optimize for speed */
86 HA_EXTRA_NOT_USED=2,
87 HA_EXTRA_CACHE=3, /* Cache record in HA_rrnd() */
88 HA_EXTRA_NO_CACHE=4, /* End caching of records (def) */
89 HA_EXTRA_NO_READCHECK=5, /* No readcheck on update */
90 HA_EXTRA_READCHECK=6, /* Use readcheck (def) */
91 HA_EXTRA_KEYREAD=7, /* Read only key to database */
92 HA_EXTRA_NO_KEYREAD=8, /* Normal read of records (def) */
93 HA_EXTRA_NO_USER_CHANGE=9, /* No user is allowed to write */
94 HA_EXTRA_KEY_CACHE=10,
95 HA_EXTRA_NO_KEY_CACHE=11,
96 HA_EXTRA_WAIT_LOCK=12, /* Wait until file is avalably (def) */
97 HA_EXTRA_NO_WAIT_LOCK=13, /* If file is locked, return quickly */
98 HA_EXTRA_WRITE_CACHE=14, /* Use write cache in ha_write() */
99 HA_EXTRA_FLUSH_CACHE=15, /* flush write_record_cache */
100 HA_EXTRA_NO_KEYS=16, /* Remove all update of keys */
101 HA_EXTRA_KEYREAD_CHANGE_POS=17, /* Keyread, but change pos */
102 /* xxxxchk -r must be used */
103 HA_EXTRA_REMEMBER_POS=18, /* Remember pos for next/prev */
104 HA_EXTRA_RESTORE_POS=19,
105 HA_EXTRA_REINIT_CACHE=20, /* init cache from current record */
106 HA_EXTRA_FORCE_REOPEN=21, /* Datafile have changed on disk */
107 HA_EXTRA_FLUSH, /* Flush tables to disk */
108 HA_EXTRA_NO_ROWS, /* Don't write rows */
109 HA_EXTRA_RESET_STATE, /* Reset positions */
110 HA_EXTRA_IGNORE_DUP_KEY, /* Dup keys don't rollback everything*/
111 HA_EXTRA_NO_IGNORE_DUP_KEY,
112 HA_EXTRA_PREPARE_FOR_DROP,
113 HA_EXTRA_PREPARE_FOR_UPDATE, /* Remove read cache if problems */
114 HA_EXTRA_PRELOAD_BUFFER_SIZE, /* Set buffer size for preloading */
115 /*
116 On-the-fly switching between unique and non-unique key inserting.
117 */
118 HA_EXTRA_CHANGE_KEY_TO_UNIQUE,
119 HA_EXTRA_CHANGE_KEY_TO_DUP,
120 /*
121 When using HA_EXTRA_KEYREAD, overwrite only key member fields and keep
122 other fields intact. When this is off (by default) InnoDB will use memcpy
123 to overwrite entire row.
124 */
125 HA_EXTRA_KEYREAD_PRESERVE_FIELDS,
126 /*
127 Ignore if the a tuple is not found, continue processing the
128 transaction and ignore that 'row'. Needed for idempotency
129 handling on the slave
130
131 Currently only used by NDB storage engine. Partition handler ignores flag.
132 */
133 HA_EXTRA_IGNORE_NO_KEY,
134 HA_EXTRA_NO_IGNORE_NO_KEY,
135 /*
136 Informs handler that write_row() which tries to insert new row into the
137 table and encounters some already existing row with same primary/unique
138 key can replace old row with new row instead of reporting error (basically
139 it informs handler that we do REPLACE instead of simple INSERT).
140 Off by default.
141 */
142 HA_EXTRA_WRITE_CAN_REPLACE,
143 HA_EXTRA_WRITE_CANNOT_REPLACE,
144 /*
145 Inform handler that delete_row()/update_row() cannot batch deletes/updates
146 and should perform them immediately. This may be needed when table has
147 AFTER DELETE/UPDATE triggers which access to subject table.
148 These flags are reset by the handler::extra(HA_EXTRA_RESET) call.
149 */
150 HA_EXTRA_DELETE_CANNOT_BATCH,
151 HA_EXTRA_UPDATE_CANNOT_BATCH,
152 /*
153 Inform handler that an "INSERT...ON DUPLICATE KEY UPDATE" will be
154 executed. This condition is unset by HA_EXTRA_NO_IGNORE_DUP_KEY.
155 */
156 HA_EXTRA_INSERT_WITH_UPDATE,
157 /* Inform handler that we will do a rename */
158 HA_EXTRA_PREPARE_FOR_RENAME
159};
160
161 /* The following is parameter to ha_panic() */
162
163enum ha_panic_function {
164 HA_PANIC_CLOSE, /* Close all databases */
165 HA_PANIC_WRITE, /* Unlock and write status */
166 HA_PANIC_READ /* Lock and read keyinfo */
167};
168
169 /* The following is parameter to ha_create(); keytypes */
170
171enum ha_base_keytype {
172 HA_KEYTYPE_END=0,
173 HA_KEYTYPE_TEXT=1, /* Key is sorted as letters */
174 HA_KEYTYPE_BINARY=2, /* Key is sorted as unsigned chars */
175 HA_KEYTYPE_LONG_INT=4,
176 HA_KEYTYPE_DOUBLE=6,
177 HA_KEYTYPE_ULONG_INT=9,
178 HA_KEYTYPE_LONGLONG=10,
179 HA_KEYTYPE_ULONGLONG=11,
180 /* Varchar (0-255 bytes) with length packed with 1 byte */
181 HA_KEYTYPE_VARTEXT1=15, /* Key is sorted as letters */
182 HA_KEYTYPE_VARBINARY1=16, /* Key is sorted as unsigned chars */
183 /* Varchar (0-65535 bytes) with length packed with 2 bytes */
184 HA_KEYTYPE_VARTEXT2=17, /* Key is sorted as letters */
185 HA_KEYTYPE_VARBINARY2=18 /* Key is sorted as unsigned chars */
186};
187
188 /* These flags kan be OR:ed to key-flag */
189
190#define HA_NOSAME 1 /* Set if not dupplicated records */
191#define HA_PACK_KEY 2 /* Pack string key to previous key */
192#define HA_AUTO_KEY 16
193#define HA_BINARY_PACK_KEY 32 /* Packing of all keys to prev key */
194#define HA_UNIQUE_CHECK 256 /* Check the key for uniqueness */
195#define HA_NULL_ARE_EQUAL 2048 /* NULL in key are cmp as equal */
196#define HA_GENERATED_KEY 8192 /* Automaticly generated key */
197
198#define HA_KEY_HAS_PART_KEY_SEG 65536 /* Key contains partial segments */
199
200 /* Automatic bits in key-flag */
201
202#define HA_SPACE_PACK_USED 4 /* Test for if SPACE_PACK used */
203#define HA_VAR_LENGTH_KEY 8
204#define HA_NULL_PART_KEY 64
205#define HA_USES_COMMENT 4096
206#define HA_USES_BLOCK_SIZE ((uint32_t) 32768)
207#define HA_SORT_ALLOWS_SAME 512 /* Intern bit when sorting records */
208
209 /* These flags can be added to key-seg-flag */
210
211#define HA_SPACE_PACK 1 /* Pack space in key-seg */
212#define HA_PART_KEY_SEG 4 /* Used by MySQL for part-key-cols */
213#define HA_VAR_LENGTH_PART 8
214#define HA_NULL_PART 16
215#define HA_BLOB_PART 32
216#define HA_SWAP_KEY 64
217#define HA_REVERSE_SORT 128 /* Sort key in reverse order */
218#define HA_NO_SORT 256 /* do not bother sorting on this keyseg */
219/*
220 End space in unique/varchar are considered equal. (Like 'a' and 'a ')
221 Only needed for internal temporary tables.
222*/
223#define HA_END_SPACE_ARE_EQUAL 512
224#define HA_BIT_PART 1024
225
226 /* optionbits for database */
227#define HA_OPTION_PACK_RECORD 1
228#define HA_OPTION_PACK_KEYS 2
229#define HA_OPTION_COMPRESS_RECORD 4
230#define HA_OPTION_TMP_TABLE 16
231#define HA_OPTION_NO_PACK_KEYS 128 /* Reserved for MySQL */
232#define HA_OPTION_TEMP_COMPRESS_RECORD ((uint32_t) 16384) /* set by isamchk */
233#define HA_OPTION_READ_ONLY_DATA ((uint32_t) 32768) /* Set by isamchk */
234
235 /* Bits in flag to create() */
236
237#define HA_DONT_TOUCH_DATA 1 /* Don't empty datafile (isamchk) */
238#define HA_PACK_RECORD 2 /* Request packed record format */
239#define HA_CREATE_TMP_TABLE 4
240#define HA_CREATE_KEEP_FILES 16 /* don't overwrite .MYD and MYI */
241
242/*
243 The following flags (OR-ed) are passed to handler::info() method.
244 The method copies misc handler information out of the storage engine
245 to data structures accessible from MySQL
246
247 Same flags are also passed down to mi_status, myrg_status, etc.
248*/
249
250/* this one is not used */
251#define HA_STATUS_POS 1
252/*
253 assuming the table keeps shared actual copy of the 'info' and
254 local, possibly outdated copy, the following flag means that
255 it should not try to get the actual data (locking the shared structure)
256 slightly outdated version will suffice
257*/
258#define HA_STATUS_NO_LOCK 2
259/* update the time of the last modification (in handler::update_time) */
260#define HA_STATUS_TIME 4
261/*
262 update the 'constant' part of the info:
263 handler::max_data_file_length, max_index_file_length, create_time
264 sortkey, ref_length, block_size, data_file_name, index_file_name.
265 handler::table->s->keys_in_use, keys_for_keyread, rec_per_key
266*/
267#define HA_STATUS_CONST 8
268/*
269 update the 'variable' part of the info:
270 handler::records, deleted, data_file_length, index_file_length,
271 delete_length, check_time, mean_rec_length
272*/
273#define HA_STATUS_VARIABLE 16
274/*
275 get the information about the key that caused last duplicate value error
276 update handler::errkey and handler::dupp_ref
277 see handler::get_dup_key()
278*/
279#define HA_STATUS_ERRKEY 32
280/*
281 update handler::auto_increment_value
282*/
283#define HA_STATUS_AUTO 64
284
285/*
286 Errorcodes given by handler functions
287
288 optimizer::sum_query() assumes these codes are > 1
289 Do not add error numbers before HA_ERR_FIRST.
290 If necessary to add lower numbers, change HA_ERR_FIRST accordingly.
291*/
292#define HA_ERR_FIRST 120 /* Copy of first error nr.*/
293
294/* Other constants */
295
296typedef unsigned long key_part_map;
297#define HA_WHOLE_KEY (~(key_part_map)0)
298
299 /* Intern constants in databases */
300
301 /* bits in _search */
302#define SEARCH_FIND 1
303#define SEARCH_NO_FIND 2
304#define SEARCH_SAME 4
305#define SEARCH_BIGGER 8
306#define SEARCH_SMALLER 16
307#define SEARCH_SAVE_BUFF 32
308#define SEARCH_UPDATE 64
309#define SEARCH_PREFIX 128
310#define SEARCH_LAST 256
311#define MBR_CONTAIN 512
312#define MBR_INTERSECT 1024
313#define MBR_WITHIN 2048
314#define MBR_DISJOINT 4096
315#define MBR_EQUAL 8192
316#define SEARCH_NULL_ARE_EQUAL 32768 /* NULL in keys are equal */
317#define SEARCH_NULL_ARE_NOT_EQUAL 65536 /* NULL in keys are not equal */
318
319 /* bits in opt_flag */
320#define READ_CACHE_USED 2
321#define READ_CHECK_USED 4
322#define KEY_READ_USED 8
323#define WRITE_CACHE_USED 16
324#define OPT_NO_ROWS 32
325
326 /* bits in update */
327#define HA_STATE_CHANGED 1 /* Database has changed */
328#define HA_STATE_AKTIV 2 /* Has a current record */
329#define HA_STATE_WRITTEN 4 /* Record is written */
330#define HA_STATE_DELETED 8
331#define HA_STATE_NEXT_FOUND 16 /* Next found record (record before) */
332#define HA_STATE_PREV_FOUND 32 /* Prev found record (record after) */
333#define HA_STATE_KEY_CHANGED 128
334#define HA_STATE_WRITE_AT_END 256 /* set in _ps_find_writepos */
335#define HA_STATE_ROW_CHANGED 1024 /* To invalide ROW cache */
336#define HA_STATE_EXTEND_BLOCK 2048
337#define HA_STATE_RNEXT_SAME 4096 /* rnext_same occupied lastkey2 */
338
339/* myisampack expects no more than 32 field types. */
340enum en_fieldtype {
341 FIELD_LAST=-1,FIELD_NORMAL,FIELD_SKIP_ENDSPACE,FIELD_SKIP_PRESPACE,
342 FIELD_SKIP_ZERO,FIELD_BLOB,FIELD_CONSTANT,FIELD_INTERVALL,FIELD_ZERO,
343 FIELD_VARCHAR,FIELD_CHECK,
344 FIELD_enum_val_count
345};
346
347enum data_file_type {
348 STATIC_RECORD, DYNAMIC_RECORD, COMPRESSED_RECORD, BLOCK_RECORD
349};
350
351/* For key ranges */
352
353/* from -inf */
354#define NO_MIN_RANGE 1
355
356/* to +inf */
357#define NO_MAX_RANGE 2
358
359/* X < key, i.e. not including the left endpoint */
360#define NEAR_MIN 4
361
362/* X > key, i.e. not including the right endpoint */
363#define NEAR_MAX 8
364
365/*
366 This flag means that index is a unique index, and the interval is
367 equivalent to "AND(keypart_i = const_i)", where all of const_i are not NULLs.
368*/
369#define UNIQUE_RANGE 16
370
371/*
372 This flag means that the interval is equivalent to
373 "AND(keypart_i = const_i)", where not all key parts may be used but all of
374 const_i are not NULLs.
375*/
376#define EQ_RANGE 32
377
378/*
379 This flag has the same meaning as UNIQUE_RANGE, except that for at least
380 one keypart the condition is "keypart IS NULL".
381*/
382#define NULL_RANGE 64
383
385{
386public:
387 const unsigned char *key;
388 uint32_t length;
389 enum ha_rkey_function flag;
390 key_part_map keypart_map;
391};
392
394{
395public:
396 key_range start_key;
397 key_range end_key;
398 char *ptr; /* Free to use by caller (ptr to row etc) */
399 uint32_t range_flag; /* key range flags see above */
400};
401
402
403/* For number of records */
404typedef uint64_t ha_rows;
405
406#define HA_POS_ERROR (~ (::drizzled::ha_rows) 0)
407#define HA_OFFSET_ERROR (~ (::drizzled::internal::my_off_t) 0)
408
409#if SIZEOF_OFF_T == 4
410#define MAX_FILE_SIZE INT32_MAX
411#else
412#define MAX_FILE_SIZE INT64_MAX
413#endif
414
415inline static uint32_t ha_varchar_packlength(uint32_t field_length)
416{
417 return (field_length < 256 ? 1 :2);
418}
419
420
421} /* namespace drizzled */
422
TODO: Rename this file - func.h is stupid.