-
Notifications
You must be signed in to change notification settings - Fork 7
/
innodb.h
2406 lines (1919 loc) · 70.4 KB
/
innodb.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
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
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***********************************************************************
Copyright (c) 2008, 2009 Innobase Oy. All rights reserved.
Copyright (c) 2008, 2009 Oracle. All rights reserved.
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; version 2 of the License.
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.
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
************************************************************************/
/* !!!!!!!!!!!!!!!* This is a generated file. *!!!!!!!!!!!!!!! */
/*!< @file innodb.h */
#ifndef INNODB_H
#define INNODB_H
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/** InnoDB error codes. Most of the error codes are internal to the engine
and will not be seen by user applications. The partial error codes reflect
the sub-state of an operation within InnoDB. Some of the error codes are
deprecated and are no longer used. */
enum db_err {
DB_SUCCESS = 10, /*!< A successult result */
/* The following are error codes */
DB_ERROR, /*!< This is a generic error code. It
is used to classify error conditions
that can't be represented by other
codes */
DB_INTERRUPTED, /*!< An operation was interrupted by
a user. */
DB_OUT_OF_MEMORY, /*!< Operation caused an out of memory
error. Within InnoDB core code this is
normally a fatal error */
DB_OUT_OF_FILE_SPACE, /*!< The operating system returned
an out of file space error when trying
to do an IO operation. */
DB_LOCK_WAIT, /*!< A lock request by transaction
resulted in a lock wait. The thread
is suspended internally by InnoDB and
is put on a lock wait queue. */
DB_DEADLOCK, /*!< A lock request by a transaction
resulted in a deadlock. The transaction
was rolled back */
DB_ROLLBACK, /*!< Not used */
DB_DUPLICATE_KEY, /*!< A record insert or update violates
a unique contraint. */
DB_QUE_THR_SUSPENDED, /*!< A query thread should be in state
suspended but is trying to acquire a
lock. Currently this is treated as a
hard error and a violation of an
invariant. */
DB_MISSING_HISTORY, /*!< Required history data has been
deleted due to lack of space in
rollback segment */
DB_CLUSTER_NOT_FOUND = 30, /*!< This error is not used */
DB_TABLE_NOT_FOUND, /*!< The table could not be found */
DB_MUST_GET_MORE_FILE_SPACE, /*!< The database has to be stopped
and restarted with more file space */
DB_TABLE_IS_BEING_USED, /*!< The user is trying to create a
table in the InnoDB data dictionary but
a table with that name already exists */
DB_TOO_BIG_RECORD, /*!< A record in an index would not fit
on a compressed page, or it would
become bigger than 1/2 free space in
an uncompressed page frame */
DB_LOCK_WAIT_TIMEOUT, /*!< Lock wait lasted too long */
DB_NO_REFERENCED_ROW, /*!< Referenced key value not found
for a foreign key in an insert or
update of a row */
DB_ROW_IS_REFERENCED, /*!< Cannot delete or update a row
because it contains a key value
which is referenced */
DB_CANNOT_ADD_CONSTRAINT, /*!< Adding a foreign key constraint
to a table failed */
DB_CORRUPTION, /*!< Data structure corruption
noticed */
DB_COL_APPEARS_TWICE_IN_INDEX, /*!< InnoDB cannot handle an index
where same column appears twice */
DB_CANNOT_DROP_CONSTRAINT, /*!< Dropping a foreign key constraint
from a table failed */
DB_NO_SAVEPOINT, /*!< No savepoint exists with the given
name */
DB_TABLESPACE_ALREADY_EXISTS, /*!< We cannot create a new single-table
tablespace because a file of the same
name already exists */
DB_TABLESPACE_DELETED, /*!< Tablespace does not exist or is
being dropped right now */
DB_LOCK_TABLE_FULL, /*!< Lock structs have exhausted the
buffer pool (for big transactions,
InnoDB stores the lock structs in the
buffer pool) */
DB_FOREIGN_DUPLICATE_KEY, /*!< Foreign key constraints
activated but the operation would
lead to a duplicate key in some
table */
DB_TOO_MANY_CONCURRENT_TRXS, /*!< When InnoDB runs out of the
preconfigured undo slots, this can
only happen when there are too many
concurrent transactions */
DB_UNSUPPORTED, /*!< When InnoDB sees any artefact or
a feature that it can't recoginize or
work with e.g., FT indexes created by
a later version of the engine. */
DB_PRIMARY_KEY_IS_NULL, /*!< A column in the PRIMARY KEY
was found to be NULL */
DB_FATAL, /*!< The application should clean up
and quite ASAP. Fatal error, InnoDB
cannot continue operation without
risking database corruption. */
/* The following are partial failure codes */
DB_FAIL = 1000, /*!< Partial failure code. */
DB_OVERFLOW, /*!< If an update or insert of a record
doesn't fit in a Btree page */
DB_UNDERFLOW, /*!< If an update or delete of a
record causes a Btree page to be below
a minimum threshold */
DB_STRONG_FAIL, /*!< Failure to insert a secondary
index entry to the insert buffer */
DB_ZIP_OVERFLOW, /*!< Failure trying to compress
a page */
DB_RECORD_NOT_FOUND = 1500, /*!< Record not found */
DB_END_OF_INDEX, /*!< A cursor operation or search
operation scanned to the end of the
index. */
/* The following are API only error codes. */
DB_SCHEMA_ERROR = 2000, /*!< Generic schema error */
DB_DATA_MISMATCH, /*!< Column update or read failed
because the types mismatch */
DB_SCHEMA_NOT_LOCKED, /*!< If an API function expects the
schema to be locked in exclusive mode
and if it's not then that API function
will return this error code */
DB_NOT_FOUND, /*!< Generic error code for "Not found"
type of errors */
DB_READONLY, /*!< Generic error code for "Readonly"
type of errors */
DB_INVALID_INPUT, /*!< Generic error code for "Invalid
input" type of errors */
};
#include <stdio.h>
#ifdef _MSC_VER
#define strncasecmp _strnicmp
#define strcasecmp _stricmp
#endif
#if defined(__GNUC__) && (__GNUC__ > 2) && ! defined(__INTEL_COMPILER)
#define UNIV_NO_IGNORE __attribute__ ((warn_unused_result))
#else
#define UNIV_NO_IGNORE
#endif /* __GNUC__ && __GNUC__ > 2 && !__INTEL_COMPILER */
/* See comment about ib_bool_t as to why the two macros are unsigned long. */
/** The boolean value of "true" used internally within InnoDB */
#define IB_TRUE 0x1UL
/** The boolean value of "false" used internally within InnoDB */
#define IB_FALSE 0x0UL
/* Basic types used by the InnoDB API. */
/** All InnoDB error codes are represented by ib_err_t */
typedef enum db_err ib_err_t;
/** Representation of a byte within InnoDB */
typedef unsigned char ib_byte_t;
/** Representation of an unsigned long int within InnoDB */
typedef unsigned long int ib_ulint_t;
/** Representation of a void* within InnoDB */
typedef void* ib_opaque_t;
/* Ideally we would like to have this as ib_byte_t, but we need to make it
the same as the InnoDB internal ibool. */
/** Representation of a "boolean" type within InnoDB */
typedef ib_ulint_t ib_bool_t;
/** A character set pointer */
typedef ib_opaque_t ib_charset_t;
/* We assume C99 support except when using VisualStudio. */
#if !defined(_MSC_VER)
#include <stdint.h>
#endif /* _MSC_VER */
/* Integer types used by the API. Microsft VS defines its own types
and we use the Microsoft types when building with Visual Studio. */
#if defined(_MSC_VER)
/** A signed 8 bit integral type. */
typedef __int8 ib_i8_t;
#else
/** A signed 8 bit integral type. */
typedef int8_t ib_i8_t;
#endif
#if defined(_MSC_VER)
/** An unsigned 8 bit integral type. */
typedef unsigned __int8 ib_u8_t;
#else
/** An unsigned 8 bit integral type. */
typedef uint8_t ib_u8_t;
#endif
#if defined(_MSC_VER)
/** A signed 16 bit integral type. */
typedef __int16 ib_i16_t;
#else
/** A signed 16 bit integral type. */
typedef int16_t ib_i16_t;
#endif
#if defined(_MSC_VER)
/** An unsigned 16 bit integral type. */
typedef unsigned __int16 ib_u16_t;
#else
/** An unsigned 16 bit integral type. */
typedef uint16_t ib_u16_t;
#endif
#if defined(_MSC_VER)
/** A signed 32 bit integral type. */
typedef __int32 ib_i32_t;
#else
/** A signed 32 bit integral type. */
typedef int32_t ib_i32_t;
#endif
#if defined(_MSC_VER)
/** An unsigned 32 bit integral type. */
typedef unsigned __int32 ib_u32_t;
#else
/** An unsigned 32 bit integral type. */
typedef uint32_t ib_u32_t;
#endif
#if defined(_MSC_VER)
/** A signed 64 bit integral type. */
typedef __int64 ib_i64_t;
#else
/** A signed 64 bit integral type. */
typedef int64_t ib_i64_t;
#endif
#if defined(_MSC_VER)
/** An unsigned 64 bit integral type. */
typedef unsigned __int64 ib_u64_t;
#else
/** An unsigned 64 bit integral type. */
typedef uint64_t ib_u64_t;
#endif
/** The integral type that represents internal table and index ids. */
typedef ib_u64_t ib_id_t;
/** @enum ib_cfg_type_t Possible types for a configuration variable. */
typedef enum {
IB_CFG_IBOOL, /*!< The configuration parameter is
of type ibool */
/* XXX Can we avoid having different types for ulint and ulong?
- On Win64 "unsigned long" is 32 bits
- ulong is always defined as "unsigned long"
- On Win64 ulint is defined as 64 bit integer
=> On Win64 ulint != ulong.
If we typecast all ulong and ulint variables to the smaller type
ulong, then we will cut the range of the ulint variables.
This is not a problem for most ulint variables because their max
allowed values do not exceed 2^32-1 (e.g. log_groups is ulint
but its max allowed value is 10). BUT buffer_pool_size and
log_file_size allow up to 2^64-1. */
IB_CFG_ULINT, /*!< The configuration parameter is
of type ulint */
IB_CFG_ULONG, /*!< The configuration parameter is
of type ulong */
IB_CFG_TEXT, /*!< The configuration parameter is
of type char* */
IB_CFG_CB /*!< The configuration parameter is
a callback parameter */
} ib_cfg_type_t;
/** @enum ib_col_type_t column types that are supported. */
typedef enum {
IB_VARCHAR = 1, /*!< Character varying length. The
column is not padded. */
IB_CHAR = 2, /*!< Fixed length character string. The
column is padded to the right. */
IB_BINARY = 3, /*!< Fixed length binary, similar to
IB_CHAR but the column is not padded
to the right. */
IB_VARBINARY = 4, /*!< Variable length binary */
IB_BLOB = 5, /*!< Binary large object, or
a TEXT type */
IB_INT = 6, /*!< Integer: can be any size
from 1 - 8 bytes. If the size is
1, 2, 4 and 8 bytes then you can use
the typed read and write functions. For
other sizes you will need to use the
ib_col_get_value() function and do the
conversion yourself. */
IB_SYS = 8, /*!< System column, this column can
be one of DATA_TRX_ID, DATA_ROLL_PTR
or DATA_ROW_ID. */
IB_FLOAT = 9, /*!< C (float) floating point value. */
IB_DOUBLE = 10, /*!> C (double) floating point value. */
IB_DECIMAL = 11, /*!< Decimal stored as an ASCII
string */
IB_VARCHAR_ANYCHARSET = 12, /*!< Any charset, varying length */
IB_CHAR_ANYCHARSET = 13 /*!< Any charset, fixed length */
} ib_col_type_t;
/** @enum ib_tbl_fmt_t InnoDB table format types */
typedef enum {
IB_TBL_REDUNDANT, /*!< Redundant row format, the column
type and length is stored in the row.*/
IB_TBL_COMPACT, /*!< Compact row format, the column
type is not stored in the row. The
length is stored in the row but the
storage format uses a compact format
to store the length of the column data
and record data storage format also
uses less storage. */
IB_TBL_DYNAMIC, /*!< Compact row format. BLOB prefixes
are not stored in the clustered index */
IB_TBL_COMPRESSED /*!< Similar to dynamic format but
with pages compressed */
} ib_tbl_fmt_t;
/** @enum ib_col_attr_t InnoDB column attributes */
typedef enum {
IB_COL_NONE = 0, /*!< No special attributes. */
IB_COL_NOT_NULL = 1, /*!< Column data can't be NULL. */
IB_COL_UNSIGNED = 2, /*!< Column is IB_INT and unsigned. */
IB_COL_NOT_USED = 4, /*!< Future use, reserved. */
IB_COL_CUSTOM1 = 8, /*!< Custom precision type, this is
a bit that is ignored by InnoDB and so
can be set and queried by users. */
IB_COL_CUSTOM2 = 16, /*!< Custom precision type, this is
a bit that is ignored by InnoDB and so
can be set and queried by users. */
IB_COL_CUSTOM3 = 32 /*!< Custom precision type, this is
a bit that is ignored by InnoDB and so
can be set and queried by users. */
} ib_col_attr_t;
/* Note: must match lock0types.h */
/** @enum ib_lck_mode_t InnoDB lock modes. */
typedef enum {
IB_LOCK_IS = 0, /*!< Intention shared, an intention
lock should be used to lock tables */
IB_LOCK_IX, /*!< Intention exclusive, an intention
lock should be used to lock tables */
IB_LOCK_S, /*!< Shared locks should be used to
lock rows */
IB_LOCK_X, /*!< Exclusive locks should be used to
lock rows*/
IB_LOCK_NOT_USED, /*!< Future use, reserved */
IB_LOCK_NONE, /*!< This is used internally to note
consistent read */
IB_LOCK_NUM = IB_LOCK_NONE /*!< number of lock modes */
} ib_lck_mode_t;
/** @enum ib_srch_mode_t InnoDB cursor search modes for ib_cursor_moveto().
Note: Values must match those found in page0cur.h */
typedef enum {
IB_CUR_G = 1, /*!< If search key is not found then
position the cursor on the row that
is greater than the search key */
IB_CUR_GE = 2, /*!< If the search key not found then
position the cursor on the row that
is greater than or equal to the search
key */
IB_CUR_L = 3, /*!< If search key is not found then
position the cursor on the row that
is less than the search key */
IB_CUR_LE = 4 /*!< If search key is not found then
position the cursor on the row that
is less than or equal to the search
key */
} ib_srch_mode_t;
/** @enum ib_match_mode_t Various match modes used by ib_cursor_moveto() */
typedef enum {
IB_CLOSEST_MATCH, /*!< Closest match possible */
IB_EXACT_MATCH, /*!< Search using a complete key
value */
IB_EXACT_PREFIX /*!< Search using a key prefix which
must match to rows: the prefix may
contain an incomplete field (the
last field in prefix may be just
a prefix of a fixed length column) */
} ib_match_mode_t;
/** @struct ib_col_meta_t InnoDB column meta data. */
typedef struct {
ib_col_type_t type; /*!< Type of the column */
ib_col_attr_t attr; /*!< Column attributes */
ib_u32_t type_len; /*!< Length of type */
ib_u16_t client_type; /*!< 16 bits of data relevant only to
the client. InnoDB doesn't care */
ib_charset_t* charset; /*!< Column charset */
} ib_col_meta_t;
/* Note: Must be in sync with trx0trx.h */
/** @enum ib_trx_state_t The transaction state can be queried using the
ib_trx_state() function. The InnoDB deadlock monitor can roll back a
transaction and users should be prepared for this, especially where there
is high contention. The way to determine the state of the transaction is to
query it's state and check. */
typedef enum {
IB_TRX_NOT_STARTED, /*!< Has not started yet, the
transaction has not ben started yet.*/
IB_TRX_ACTIVE, /*!< The transaction is currently
active and needs to be either
committed or rolled back. */
IB_TRX_COMMITTED_IN_MEMORY, /*!< Not committed to disk yet */
IB_TRX_PREPARED /*!< Support for 2PC/XA */
} ib_trx_state_t;
/* Note: Must be in sync with trx0trx.h */
/** @enum ib_trx_level_t Transaction isolation levels */
typedef enum {
IB_TRX_READ_UNCOMMITTED = 0, /*!< Dirty read: non-locking SELECTs are
performed so that we do not look at a
possible earlier version of a record;
thus they are not 'consistent' reads
under this isolation level; otherwise
like level 2 */
IB_TRX_READ_COMMITTED = 1, /*!< Somewhat Oracle-like isolation,
except that in range UPDATE and DELETE
we must block phantom rows with
next-key locks; SELECT ... FOR UPDATE
and ... LOCK IN SHARE MODE only lock
the index records, NOT the gaps before
them, and thus allow free inserting;
each consistent read reads its own
snapshot */
IB_TRX_REPEATABLE_READ = 2, /*!< All consistent reads in the same
trx read the same snapshot; full
next-key locking used in locking reads
to block insertions into gaps */
IB_TRX_SERIALIZABLE = 3 /*!< All plain SELECTs are converted to
LOCK IN SHARE MODE reads */
} ib_trx_level_t;
/** @enum ib_shutdown_t When ib_shutdown() is called InnoDB may take a long
time to shutdown because of background tasks e.g., purging deleted records.
The following flags allow the user to control the shutdown behavior. */
typedef enum {
IB_SHUTDOWN_NORMAL, /*!< Normal shutdown, do insert buffer
merge and purge before complete
shutdown. */
IB_SHUTDOWN_NO_IBUFMERGE_PURGE, /*!< Do not do a purge and index buffer
merge at shutdown. */
IB_SHUTDOWN_NO_BUFPOOL_FLUSH /*!< Same as NO_IBUFMERGE_PURGE
and in addition do not even flush the
buffer pool to data files. No committed
transactions are lost */
} ib_shutdown_t;
/** Generical InnoDB callback prototype. */
typedef void (*ib_cb_t)(void);
/** The first argument to the InnoDB message logging function. By default
it's set to stderr. You should treat ib_msg_stream_t as a void*, since
it will probably change in the future. */
typedef FILE* ib_msg_stream_t;
/** All log messages are written to this function.It should have the same
behavior as fprintf(3). */
typedef int (*ib_msg_log_t)(ib_msg_stream_t, const char*, ...);
/* Note: This is to make it easy for API users to have type
checking for arguments to our functions. Making it ib_opaque_t
by itself will result in pointer decay resulting in subverting
of the compiler's type checking. */
/** InnoDB tuple handle. This handle can refer to either a cluster index
tuple or a secondary index tuple. There are two types of tuples for each
type of index, making a total of four types of tuple handles. There
is a tuple for reading the entire row contents and another for searching
on the index key. */
typedef struct ib_tpl_struct* ib_tpl_t;
/** InnoDB transaction handle, all database operations need to be covered
by transactions. This handle represents a transaction. The handle can be
created with ib_trx_begin(), you commit your changes with ib_trx_commit()
and undo your changes using ib_trx_rollback(). If the InnoDB deadlock
monitor rolls back the transaction then you need to free the transaction
using the function ib_trx_release(). You can query the state of an InnoDB
transaction by calling ib_trx_state(). */
typedef struct ib_trx_struct* ib_trx_t;
/** InnoDB cursor handle */
typedef struct ib_crsr_struct* ib_crsr_t;
/** InnoDB table schema handle */
typedef struct ib_tbl_sch_struct* ib_tbl_sch_t;
/** InnoDB index schema handle */
typedef struct ib_idx_sch_struct* ib_idx_sch_t;
/** Currently, this is also the number of callback functions in the struct. */
typedef enum {
IB_SCHEMA_VISITOR_TABLE = 1,
IB_SCHEMA_VISITOR_TABLE_COL = 2,
IB_SCHEMA_VISITOR_TABLE_AND_INDEX = 3,
IB_SCHEMA_VISITOR_TABLE_AND_INDEX_COL = 4
} ib_schema_visitor_version_t;
/** Visit all tables in the InnoDB schem. */
typedef int (*ib_schema_visitor_table_all_t) (
/*!< return 0 on success, nonzero
on failure (abort traversal) */
void* arg, /*!< User callback arg */
const char* name, /*!< Table name */
int name_len); /*!< Length of name in bytes */
/** Table visitor */
typedef int (*ib_schema_visitor_table_t) (
/*!< return 0 on success, nonzero
on failure (abort traversal) */
void* arg, /*!< User callback arg */
const char* name, /*!< Table name */
ib_tbl_fmt_t tbl_fmt, /*!< Table type */
ib_ulint_t page_size, /*!< Table page size */
int n_cols, /*!< No. of cols defined */
int n_indexes); /*!< No. of indexes defined */
/** Table column visitor */
typedef int (*ib_schema_visitor_table_col_t) (
/*!< return 0 on success, nonzero
on failure (abort traversal) */
void* arg, /*!< User callback arg */
const char* name, /*!< Column name */
ib_col_type_t col_type, /*!< Column type */
ib_ulint_t len, /*!< Column len */
ib_col_attr_t attr); /*!< Column attributes */
/** Index visitor */
typedef int (*ib_schema_visitor_index_t) (
/*!< return 0 on success, nonzero
on failure (abort traversal) */
void* arg, /*!< User callback arg */
const char* name, /*!< Index name */
ib_bool_t clustered, /*!< True if clustered */
ib_bool_t unique, /*!< True if unique */
int n_cols); /*!< No. of cols defined */
/** Index column visitor */
typedef int (*ib_schema_visitor_index_col_t) (
/*!< return 0 on success, nonzero
on failure (abort traversal) */
void* arg, /*!< User callback arg */
const char* name, /*!< Column name */
ib_ulint_t prefix_len); /*!< Prefix length */
/** Callback functions to traverse the schema of a table. */
typedef struct {
ib_schema_visitor_version_t version;
/*!< Visitor version */
ib_schema_visitor_table_t table;
/*!< For travesing table info */
ib_schema_visitor_table_col_t table_col;
/*!< For travesing table column info */
ib_schema_visitor_index_t index;
/*!< For travesing index info */
ib_schema_visitor_index_col_t index_col;
/*!< For travesing index column info */
} ib_schema_visitor_t;
/*************************************************************//**
This function is used to compare two data fields for which the data type
is such that we must use the client code to compare them. */
typedef int (*ib_client_cmp_t)(
/*!< out: 1, 0, -1, if a is greater,
equal, less than b, respectively */
const ib_col_meta_t*
col_meta, /*!< in: column meta data */
const ib_byte_t*p1, /*!< in: key */
ib_ulint_t p1_len, /*!< in: key length */
const ib_byte_t*p2, /*!< in: key */
ib_ulint_t p2_len); /*!< in: key length */
/* This should be the same as univ.i */
/** Represents SQL_NULL length */
#define IB_SQL_NULL 0xFFFFFFFF
/** The number of system columns in a row. */
#define IB_N_SYS_COLS 3
/** The maximum length of a text column. */
#define MAX_TEXT_LEN 4096
/* MySQL uses 3 byte UTF-8 encoding. */
/** The maximum length of a column name in a table schema. */
#define IB_MAX_COL_NAME_LEN (64 * 3)
/** The maximum length of a table name (plus database name). */
#define IB_MAX_TABLE_NAME_LEN (64 * 3)
/*! @def ib_tbl_sch_add_blob_col(s, n)
Add a BLOB column to a table schema.
@param s is the the schema handle
@param n is the column name */
#define ib_tbl_sch_add_blob_col(s, n) \
ib_table_schema_add_col(s, n, IB_BLOB, IB_COL_NONE, 0, 0)
/*! @def ib_tbl_sch_add_text_col(s, n)
Add a BLOB column to a table schema.
@param s is the the schema handle
@param n is the column name
Add a TEXT column to a table schema. */
#define ib_tbl_sch_add_text_col(s, n) \
ib_table_schema_add_col(s, n, IB_VARCHAR, IB_COL_NONE, 0, MAX_TEXT_LEN)
/*! @def ib_tbl_sch_add_varchar_col(s, n, l)
Add a VARCHAR column to a table schema.
@param s is the schema handle
@param n is the column name
@param l the max length of the VARCHAR column
@return DB_SUCCESS or error code */
#define ib_tbl_sch_add_varchar_col(s, n, l) \
ib_table_schema_add_col(s, n, IB_VARCHAR, IB_COL_NONE, 0, l)
/*! @def ib_tbl_sch_add_u32_col(s, n)
Add an UNSIGNED INT column to a table schema.
@param s is the schema handle
@param n is the column name
@return DB_SUCCESS or error code */
#define ib_tbl_sch_add_u32_col(s, n) \
ib_table_schema_add_col(s, n, IB_INT, IB_COL_UNSIGNED, 0, 4)
/*! @def ib_tbl_sch_add_u64_col(s, n)
Add an UNSIGNED BIGINT column to a table schema.
@param s is the schema handle
@param n is the column name
@return DB_SUCCESS or error code */
#define ib_tbl_sch_add_u64_col(s, n) \
ib_table_schema_add_col(s, n, IB_INT, IB_COL_UNSIGNED, 0, 8)
/*! @def ib_tbl_sch_add_u64_notnull_col(s, n)
Add an UNSIGNED BIGINT NOT NULL column to a table schema.
@param s is the schema handle
@param n is the column name
@return DB_SUCCESS or error code */
#define ib_tbl_sch_add_u64_notnull_col(s, n) \
ib_table_schema_add_col(s, n, IB_INT, \
IB_COL_NOT_NULL | IB_COL_UNSIGNED,0,\
8)
/*! @def ib_cfg_set_int(name, value)
Set an int configuration variable.
@param name is the config variable name
@param value is the integer value of the variable
@return DB_SUCCESS or error code */
#define ib_cfg_set_int(name, value) ib_cfg_set(name, value)
/*! @def ib_cfg_set_text(name, value)
Set a text configuration variable.
@param name is the config variable name
@param value is the char* value of the variable
@return DB_SUCCESS or error code */
#define ib_cfg_set_text(name, value) ib_cfg_set(name, value)
/*! @def ib_cfg_set_bool_on(name)
Set a boolean configuration variable to IB_TRUE.
@param name is the config variable name
@return DB_SUCCESS or error code */
#define ib_cfg_set_bool_on(name) ib_cfg_set(name, IB_TRUE)
/*! @def ib_cfg_set_bool_off(name)
Set a boolean configuration variable to IB_FALSE.
@param name is the config variable name
@return DB_SUCCESS or error code */
#define ib_cfg_set_bool_off(name) ib_cfg_set(name, IB_FALSE)
/*! @def ib_cfg_set_callback(name, value)
Set a generic ib_cb_t callback function.
@param name is the config variable name
@param value is a pointer to a callback function
@return DB_SUCCESS or error code */
#define ib_cfg_set_callback(name, value) ib_cfg_set(name, value)
/** Callback function to compare InnoDB key columns in an index. */
extern ib_client_cmp_t ib_client_compare;
/* Define the Doxygen groups:
@defgroup init Startup/Shutdown functions
@defgroup cursor Cursor functions
@defgroup trx Transaction functions
@defgroup conf Configuration functions
@defgroup ddl DDL functions
@defgroup misc Miscellaneous functions
@defgroup tuple Tuple functions
@defgroup sql SQL functions
@defgroup dml DML functions
*/
/*****************************************************************//**
Return the API version number, the version number format is:
| 16 bits future use | 16 bits current | 16 bits revision | 16 bits age |
- If the library source code has changed at all since the last release,
then revision will be incremented (`c:r:a' becomes `c:r+1:a').
- If any interfaces have been added, removed, or changed since the last
update, current will be incremented, and revision will be set to 0.
- If any interfaces have been added (but not changed or removed) since
the last release, then age will be incremented.
- If any interfaces have been changed or removed since the last release,
then age will be set to 0.
@ingroup misc
@return API version number */
ib_u64_t
ib_api_version(void) UNIV_NO_IGNORE;
/*=================*/
/*****************************************************************//**
Initialize the InnoDB engine. This must be called prior to calling
any other InnoDB API function. You can call only the ib_cfg_*() functions
between calls to ib_init() and ib_startup(). No other Embedded InnoDB
functions should be called.
@ingroup init
@return DB_SUCCESS or error code */
ib_err_t
ib_init(void) UNIV_NO_IGNORE;
/*=========*/
/*****************************************************************//**
Startup the InnoDB engine. If this function is called on a non-existent
database then based on the default or user specified configuration
settings it will create all the necessary files. If the database was
shutdown cleanly but the user deleted the REDO log files then it
will recreate the REDO log files.
@ingroup init
@param format is the max file format name that the engine supports
@return DB_SUCCESS or error code
@see DB_SUCCESS */
ib_err_t
ib_startup(
/*=======*/
const char* format) UNIV_NO_IGNORE;
/*****************************************************************//**
Shutdown the InnoDB engine. Call this function when they are no
active transactions. It will close all files and release all memory
on successful completion. All internal variables will be reset to their
default values.
@ingroup init
@param flag is the shutdown flag
@return DB_SUCCESS or error code */
ib_err_t
ib_shutdown(
/*========*/
ib_shutdown_t flag) UNIV_NO_IGNORE;
/*****************************************************************//**
Start a transaction that's been rolled back. This special function
exists for the case when InnoDB's deadlock detector has rolledack
a transaction. While the transaction has been rolled back the handle
is still valid and can be reused by calling this function. If you
don't want to reuse the transaction handle then you can free the handle
by calling ib_trx_release().
@ingroup trx
@param ib_trx is the transaction to restart
@param ib_trx_level is the transaction isolation level
@return innobase txn handle */
ib_err_t
ib_trx_start(
/*=========*/
ib_trx_t ib_trx,
ib_trx_level_t ib_trx_level) UNIV_NO_IGNORE;
/*****************************************************************//**
Begin a transaction. This will allocate a new transaction handle and
put the transaction in the active state.
@ingroup trx
@param ib_trx_level is the transaction isolation level
@return innobase txn handle */
ib_trx_t
ib_trx_begin(
/*=========*/
ib_trx_level_t ib_trx_level) UNIV_NO_IGNORE;
/*****************************************************************//**
Query the transaction's state. This function can be used to check for
the state of the transaction in case it has been rolled back by the
InnoDB deadlock detector. Note that when a transaction is selected as
a victim for rollback, InnoDB will always return an appropriate error
code indicating this. @see DB_DEADLOCK, @see DB_LOCK_TABLE_FULL and
@see DB_LOCK_WAIT_TIMEOUT
@ingroup trx
@param ib_trx is the transaction handle
@return transaction state */
ib_trx_state_t
ib_trx_state(
/*=========*/
ib_trx_t ib_trx) UNIV_NO_IGNORE;
/*****************************************************************//**
Release the resources of the transaction. If the transaction was
selected as a victim by InnoDB and rolled back then use this function
to free the transaction handle.
@ingroup trx
@param ib_trx is the transaction handle
@return DB_SUCCESS or err code */
ib_err_t
ib_trx_release(
/*===========*/
ib_trx_t ib_trx) UNIV_NO_IGNORE;
/*****************************************************************//**
Commit a transaction. This function will release the schema latches too.
It will also free the transaction handle.
@ingroup trx
@param ib_trx is thr transaction handle
@return DB_SUCCESS or err code */
ib_err_t
ib_trx_commit(
/*==========*/
ib_trx_t ib_trx) UNIV_NO_IGNORE;
/*****************************************************************//**
Rollback a transaction. This function will release the schema latches too.
It will also free the transaction handle.
@ingroup trx
@param ib_trx is the transaction handle
@return DB_SUCCESS or err code */
ib_err_t
ib_trx_rollback(
/*============*/
ib_trx_t ib_trx) UNIV_NO_IGNORE;
/*****************************************************************//**
Add columns to a table schema. Tables are created in InnoDB by first
creating a table schema which is identified by a handle. Then you
add the column definitions to the table schema.
@ingroup ddl
@param ib_tbl_sch is the table schema instance
@param name is the name of the column to add
@param ib_col_type is the type of the column
@param ib_col_attr are the attributes of the column, including constraints
@param client_type is any 16 bit number relevant only to the client
@param len is the maximum length of the column
@return DB_SUCCESS or err code */
ib_err_t
ib_table_schema_add_col(
/*====================*/
ib_tbl_sch_t ib_tbl_sch,
const char* name,
ib_col_type_t ib_col_type,
ib_col_attr_t ib_col_attr,
ib_u16_t client_type,
ib_ulint_t len) UNIV_NO_IGNORE;
/*****************************************************************//**
Create and add an index key definition to a table schema. The index
schema is owned by the table schema instance and will be freed when
the table schema instance is freed.
@ingroup ddl
@param[in,out] ib_tbl_sch is the schema instance
@param name name of the key definition to create
@param[out] ib_idx_sch is the key definition schema instance
@return DB_SUCCESS or err code */
ib_err_t
ib_table_schema_add_index(
/*======================*/
ib_tbl_sch_t ib_tbl_sch,
const char* name,
ib_idx_sch_t* ib_idx_sch) UNIV_NO_IGNORE;
/*****************************************************************//**
Destroy a schema. The handle is freed by this function.
@ingroup ddl
@param ib_tbl_sch is the table schema to delte*/
void
ib_table_schema_delete(
/*===================*/
ib_tbl_sch_t ib_tbl_sch);