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
|
/*****************************************************************************
Copyright (c) 2000, 2017, Oracle and/or its affiliates. All Rights Reserved.
Copyright (c) 2013, 2020, MariaDB Corporation.
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.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA
*****************************************************************************/
#ifdef WITH_WSREP
#include "wsrep_api.h"
#include <mysql/service_wsrep.h>
#endif /* WITH_WSREP */
#include "table.h"
/* The InnoDB handler: the interface between MySQL and InnoDB. */
/** "GEN_CLUST_INDEX" is the name reserved for InnoDB default
system clustered index when there is no primary key. */
extern const char innobase_index_reserve_name[];
/** Prebuilt structures in an InnoDB table handle used within MySQL */
struct row_prebuilt_t;
/** InnoDB transaction */
struct trx_t;
/** Engine specific table options are defined using this struct */
struct ha_table_option_struct
{
bool page_compressed; /*!< Table is using page compression
if this option is true. */
ulonglong page_compression_level; /*!< Table page compression level
0-9. */
uint atomic_writes; /*!< Use atomic writes for this
table if this options is ON or
in DEFAULT if
srv_use_atomic_writes=1.
Atomic writes are not used if
value OFF.*/
uint encryption; /*!< DEFAULT, ON, OFF */
ulonglong encryption_key_id; /*!< encryption key id */
};
/* JAN: TODO: MySQL 5.7 handler.h */
struct st_handler_tablename
{
const char *db;
const char *tablename;
};
/** The class defining a handle to an Innodb table */
class ha_innobase final : public handler
{
public:
ha_innobase(handlerton* hton, TABLE_SHARE* table_arg);
~ha_innobase() override;
/** 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. */
enum row_type get_row_type() const override;
const char* table_type() const;
const char* index_type(uint key_number) override;
Table_flags table_flags() const override;
ulong index_flags(uint idx, uint part, bool all_parts) const override;
uint max_supported_keys() const override;
uint max_supported_key_length() const override;
uint max_supported_key_part_length() const override;
const key_map* keys_to_use_for_scanning() override;
void column_bitmaps_signal() override;
/** Opens dictionary table object using table name. For partition, we need to
try alternative lower/upper case names to support moving data files across
platforms.
@param[in] table_name name of the table/partition
@param[in] norm_name normalized name of the table/partition
@param[in] is_partition if this is a partition of a table
@param[in] ignore_err error to ignore for loading dictionary object
@return dictionary table object or NULL if not found */
static dict_table_t* open_dict_table(
const char* table_name,
const char* norm_name,
bool is_partition,
dict_err_ignore_t ignore_err);
int open(const char *name, int mode, uint test_if_locked) override;
handler* clone(const char *name, MEM_ROOT *mem_root) override;
int close(void) override;
double scan_time() override;
double read_time(uint index, uint ranges, ha_rows rows) override;
int delete_all_rows() override;
int write_row(const uchar * buf) override;
int update_row(const uchar * old_data, const uchar * new_data) override;
int delete_row(const uchar * buf) override;
bool was_semi_consistent_read() override;
void try_semi_consistent_read(bool yes) override;
void unlock_row() override;
int index_init(uint index, bool sorted) override;
int index_end() override;
int index_read(
uchar* buf,
const uchar* key,
uint key_len,
ha_rkey_function find_flag) override;
int index_read_last(uchar * buf, const uchar * key,
uint key_len) override;
int index_next(uchar * buf) override;
int index_next_same(uchar * buf, const uchar * key,
uint keylen) override;
int index_prev(uchar * buf) override;
int index_first(uchar * buf) override;
int index_last(uchar * buf) override;
/* Copy a cached MySQL row. If requested, also avoids
overwriting non-read columns. */
void copy_cached_row(uchar *to_rec, const uchar *from_rec,
uint rec_length);
int rnd_init(bool scan) override;
int rnd_end() override;
int rnd_next(uchar *buf) override;
int rnd_pos(uchar * buf, uchar *pos) override;
int ft_init() override;
void ft_end() override { rnd_end(); }
FT_INFO *ft_init_ext(uint flags, uint inx, String* key) override;
int ft_read(uchar* buf) override;
void position(const uchar *record) override;
int info(uint) override;
int analyze(THD* thd,HA_CHECK_OPT* check_opt) override;
int optimize(THD* thd,HA_CHECK_OPT* check_opt) override;
int discard_or_import_tablespace(my_bool discard) override;
int extra(ha_extra_function operation) override;
int reset() override;
int external_lock(THD *thd, int lock_type) override;
int start_stmt(THD *thd, thr_lock_type lock_type) override;
ha_rows records_in_range(
uint inx,
const key_range* min_key,
const key_range* max_key,
page_range* pages) override;
ha_rows estimate_rows_upper_bound() override;
void update_create_info(HA_CREATE_INFO* create_info) override;
inline int create(
const char* name,
TABLE* form,
HA_CREATE_INFO* create_info,
bool file_per_table,
trx_t* trx = NULL);
int create(
const char* name,
TABLE* form,
HA_CREATE_INFO* create_info) override;
inline int delete_table(const char* name, enum_sql_command sqlcom);
int truncate() override;
int delete_table(const char *name) override;
int rename_table(const char* from, const char* to) override;
inline int defragment_table(const char* name);
int check(THD* thd, HA_CHECK_OPT* check_opt) override;
char* update_table_comment(const char* comment) override;
char* get_foreign_key_create_info() override;
int get_foreign_key_list(THD *thd,
List<FOREIGN_KEY_INFO> *f_key_list) override;
int get_parent_foreign_key_list(
THD* thd,
List<FOREIGN_KEY_INFO>* f_key_list) override;
bool can_switch_engines() override;
uint referenced_by_foreign_key() override;
void free_foreign_key_create_info(char* str) override;
uint lock_count(void) const override;
THR_LOCK_DATA** store_lock(
THD* thd,
THR_LOCK_DATA** to,
thr_lock_type lock_type) override;
void init_table_handle_for_HANDLER() override;
void get_auto_increment(
ulonglong offset,
ulonglong increment,
ulonglong nb_desired_values,
ulonglong* first_value,
ulonglong* nb_reserved_values) override;
int reset_auto_increment(ulonglong value) override;
bool get_error_message(int error, String *buf) override;
bool get_foreign_dup_key(char*, uint, char*, uint) override;
uint8 table_cache_type() override;
/**
Ask handler about permission to cache table during query registration
*/
my_bool register_query_cache_table(
THD* thd,
const char* table_key,
uint key_length,
qc_engine_callback* call_back,
ulonglong* engine_data) override;
int cmp_ref(const uchar* ref1, const uchar* ref2) override;
/** On-line ALTER TABLE interface @see handler0alter.cc @{ */
/** Check if InnoDB supports a particular alter table in-place
@param altered_table TABLE object for new version of table.
@param ha_alter_info Structure describing changes to be done
by ALTER TABLE and holding data used during in-place alter.
@retval HA_ALTER_INPLACE_NOT_SUPPORTED Not supported
@retval HA_ALTER_INPLACE_INSTANT
MDL_EXCLUSIVE is needed for executing prepare_inplace_alter_table()
and commit_inplace_alter_table(). inplace_alter_table()
will not be called.
@retval HA_ALTER_INPLACE_COPY_NO_LOCK
MDL_EXCLUSIVE in prepare_inplace_alter_table(), which can be downgraded
to LOCK=NONE for rebuilding the table in inplace_alter_table()
@retval HA_ALTER_INPLACE_COPY_LOCK
MDL_EXCLUSIVE in prepare_inplace_alter_table(), which can be downgraded
to LOCK=SHARED for rebuilding the table in inplace_alter_table()
@retval HA_ALTER_INPLACE_NOCOPY_NO_LOCK
MDL_EXCLUSIVE in prepare_inplace_alter_table(), which can be downgraded
to LOCK=NONE for inplace_alter_table() which will not rebuild the table
@retval HA_ALTER_INPLACE_NOCOPY_LOCK
MDL_EXCLUSIVE in prepare_inplace_alter_table(), which can be downgraded
to LOCK=SHARED for inplace_alter_table() which will not rebuild
the table. */
enum_alter_inplace_result check_if_supported_inplace_alter(
TABLE* altered_table,
Alter_inplace_info* ha_alter_info) override;
/** Allows InnoDB to update internal structures with concurrent
writes blocked (provided that check_if_supported_inplace_alter()
did not return HA_ALTER_INPLACE_NO_LOCK).
This will be invoked before inplace_alter_table().
@param altered_table TABLE object for new version of table.
@param ha_alter_info Structure describing changes to be done
by ALTER TABLE and holding data used during in-place alter.
@retval true Failure
@retval false Success
*/
bool prepare_inplace_alter_table(
TABLE* altered_table,
Alter_inplace_info* ha_alter_info) override;
/** Alter the table structure in-place with operations
specified using HA_ALTER_FLAGS and Alter_inplace_information.
The level of concurrency allowed during this operation depends
on the return value from check_if_supported_inplace_alter().
@param altered_table TABLE object for new version of table.
@param ha_alter_info Structure describing changes to be done
by ALTER TABLE and holding data used during in-place alter.
@retval true Failure
@retval false Success
*/
bool inplace_alter_table(
TABLE* altered_table,
Alter_inplace_info* ha_alter_info) override;
/** Commit or rollback the changes made during
prepare_inplace_alter_table() and inplace_alter_table() inside
the storage engine. Note that the allowed level of concurrency
during this operation will be the same as for
inplace_alter_table() and thus might be higher than during
prepare_inplace_alter_table(). (E.g concurrent writes were
blocked during prepare, but might not be during commit).
@param altered_table TABLE object for new version of table.
@param ha_alter_info Structure describing changes to be done
by ALTER TABLE and holding data used during in-place alter.
@param commit true => Commit, false => Rollback.
@retval true Failure
@retval false Success
*/
bool commit_inplace_alter_table(
TABLE* altered_table,
Alter_inplace_info* ha_alter_info,
bool commit) override;
/** @} */
bool check_if_incompatible_data(
HA_CREATE_INFO* info,
uint table_changes) override;
/** @name Multi Range Read interface @{ */
/** Initialize multi range read @see DsMrr_impl::dsmrr_init
@param seq
@param seq_init_param
@param n_ranges
@param mode
@param buf */
int multi_range_read_init(
RANGE_SEQ_IF* seq,
void* seq_init_param,
uint n_ranges,
uint mode,
HANDLER_BUFFER* buf) override;
/** Process next multi range read @see DsMrr_impl::dsmrr_next
@param range_info */
int multi_range_read_next(range_id_t *range_info) override;
/** Initialize multi range read and get information.
@see ha_myisam::multi_range_read_info_const
@see DsMrr_impl::dsmrr_info_const
@param keyno
@param seq
@param seq_init_param
@param n_ranges
@param bufsz
@param flags
@param cost */
ha_rows multi_range_read_info_const(
uint keyno,
RANGE_SEQ_IF* seq,
void* seq_init_param,
uint n_ranges,
uint* bufsz,
uint* flags,
Cost_estimate* cost) override;
/** Initialize multi range read and get information.
@see DsMrr_impl::dsmrr_info
@param keyno
@param seq
@param seq_init_param
@param n_ranges
@param bufsz
@param flags
@param cost */
ha_rows multi_range_read_info(uint keyno, uint n_ranges, uint keys,
uint key_parts, uint* bufsz, uint* flags,
Cost_estimate* cost) override;
int multi_range_read_explain_info(uint mrr_mode,
char *str, size_t size) override;
/** Attempt to push down an index condition.
@param[in] keyno MySQL key number
@param[in] idx_cond Index condition to be checked
@return idx_cond if pushed; NULL if not pushed */
Item* idx_cond_push(uint keyno, Item* idx_cond) override;
/* @} */
/** Check if InnoDB is not storing virtual column metadata for a table.
@param s table definition (based on .frm file)
@return whether InnoDB will omit virtual column metadata */
static bool omits_virtual_cols(const TABLE_SHARE& s)
{
return s.frm_version<FRM_VER_EXPRESSSIONS && s.virtual_fields;
}
/** Push a primary key filter.
@param[in] pk_filter filter against which primary keys
are to be checked
@retval false if pushed (always) */
bool rowid_filter_push(Rowid_filter *rowid_filter) override;
bool
can_convert_string(const Field_string* field,
const Column_definition& new_field) const override;
bool can_convert_varstring(
const Field_varstring* field,
const Column_definition& new_field) const override;
bool
can_convert_blob(const Field_blob* field,
const Column_definition& new_field) const override;
/** @return whether innodb_strict_mode is active */
static bool is_innodb_strict_mode(THD* thd);
/** @return whether innodb_strict_mode is active */
bool is_innodb_strict_mode()
{ return is_innodb_strict_mode(m_user_thd); }
Compare_keys
compare_key_parts(const Field& old_field,
const Column_definition& new_field,
const KEY_PART_INFO& old_part,
const KEY_PART_INFO& new_part) const override;
protected:
dberr_t innobase_get_autoinc(ulonglong* value);
dberr_t innobase_lock_autoinc();
ulonglong innobase_peek_autoinc();
dberr_t innobase_set_max_autoinc(ulonglong auto_inc);
dberr_t innobase_reset_autoinc(ulonglong auto_inc);
/** Resets a query execution 'template'.
@see build_template() */
void reset_template();
inline void update_thd(THD* thd);
void update_thd();
int general_fetch(uchar* buf, uint direction, uint match_mode);
int change_active_index(uint keynr);
dict_index_t* innobase_get_index(uint keynr);
#ifdef WITH_WSREP
int wsrep_append_keys(
THD *thd,
Wsrep_service_key_type key_type,
const uchar* record0,
const uchar* record1);
#endif
/** Builds a 'template' to the prebuilt struct.
The template is used in fast retrieval of just those column
values MySQL needs in its processing.
@param whole_row true if access is needed to a whole row,
false if accessing individual fields is enough */
void build_template(bool whole_row);
int info_low(uint, bool);
/** The multi range read session object */
DsMrr_impl m_ds_mrr;
/** Save CPU time with prebuilt/cached data structures */
row_prebuilt_t* m_prebuilt;
/** Thread handle of the user currently using the handler;
this is set in external_lock function */
THD* m_user_thd;
/** buffer used in updates */
uchar* m_upd_buf;
/** the size of upd_buf in bytes */
ulint m_upd_buf_size;
/** Flags that specificy the handler instance (table) capability. */
Table_flags m_int_table_flags;
/** Index into the server's primkary keye meta-data table->key_info{} */
uint m_primary_key;
/** this is set to 1 when we are starting a table scan but have
not yet fetched any row, else false */
bool m_start_of_scan;
/*!< match mode of the latest search: ROW_SEL_EXACT,
ROW_SEL_EXACT_PREFIX, or undefined */
uint m_last_match_mode;
/** If mysql has locked with external_lock() */
bool m_mysql_has_locked;
};
/* Some accessor functions which the InnoDB plugin needs, but which
can not be added to mysql/plugin.h as part of the public interface;
the definitions are bracketed with #ifdef INNODB_COMPATIBILITY_HOOKS */
#ifndef INNODB_COMPATIBILITY_HOOKS
#error InnoDB needs MySQL to be built with #define INNODB_COMPATIBILITY_HOOKS
#endif
extern "C" {
/** Check if a user thread is a replication slave thread
@param thd user thread
@retval 0 the user thread is not a replication slave thread
@retval 1 the user thread is a replication slave thread */
int thd_slave_thread(const MYSQL_THD thd);
/** Check if a user thread is running a non-transactional update
@param thd user thread
@retval 0 the user thread is not running a non-transactional update
@retval 1 the user thread is running a non-transactional update */
int thd_non_transactional_update(const MYSQL_THD thd);
/** Get high resolution timestamp for the current query start time.
The timestamp is not anchored to any specific point in time,
but can be used for comparison.
@param thd user thread
@retval timestamp in microseconds precision
*/
unsigned long long thd_start_utime(const MYSQL_THD thd);
/** Get the user thread's binary logging format
@param thd user thread
@return Value to be used as index into the binlog_format_names array */
int thd_binlog_format(const MYSQL_THD thd);
/** Check if binary logging is filtered for thread's current db.
@param thd Thread handle
@retval 1 the query is not filtered, 0 otherwise. */
bool thd_binlog_filter_ok(const MYSQL_THD thd);
/** Check if the query may generate row changes which may end up in the binary.
@param thd Thread handle
@retval 1 the query may generate row changes, 0 otherwise.
*/
bool thd_sqlcom_can_generate_row_events(const MYSQL_THD thd);
/** Is strict sql_mode set.
@param thd Thread object
@return True if sql_mode has strict mode (all or trans), false otherwise. */
bool thd_is_strict_mode(const MYSQL_THD thd);
} /* extern "C" */
/** Get the file name and position of the MySQL binlog corresponding to the
* current commit.
*/
extern void mysql_bin_log_commit_pos(THD *thd, ulonglong *out_pos, const char **out_file);
struct trx_t;
#ifdef WITH_WSREP
#include <mysql/service_wsrep.h>
#endif /* WITH_WSREP */
extern const struct _ft_vft ft_vft_result;
/** Structure Returned by ha_innobase::ft_init_ext() */
typedef struct new_ft_info
{
struct _ft_vft *please;
struct _ft_vft_ext *could_you;
row_prebuilt_t* ft_prebuilt;
fts_result_t* ft_result;
} NEW_FT_INFO;
/**
Allocates an InnoDB transaction for a MySQL handler object.
@return InnoDB transaction handle */
trx_t*
innobase_trx_allocate(
MYSQL_THD thd); /*!< in: user thread handle */
/*********************************************************************//**
This function checks each index name for a table against reserved
system default primary index name 'GEN_CLUST_INDEX'. If a name
matches, this function pushes an warning message to the client,
and returns true.
@return true if the index name matches the reserved name */
bool
innobase_index_name_is_reserved(
THD* thd, /*!< in/out: MySQL connection */
const KEY* key_info, /*!< in: Indexes to be created */
ulint num_of_keys) /*!< in: Number of indexes to
be created. */
MY_ATTRIBUTE((nonnull(1), warn_unused_result));
/** Parse hint for table and its indexes, and update the information
in dictionary.
@param[in] thd Connection thread
@param[in,out] table Target table
@param[in] table_share Table definition */
void
innobase_parse_hint_from_comment(
THD* thd,
dict_table_t* table,
const TABLE_SHARE* table_share);
/** Class for handling create table information. */
class create_table_info_t
{
public:
/** Constructor.
Used in two ways:
- all but file_per_table is used, when creating the table.
- all but name/path is used, when validating options and using flags. */
create_table_info_t(
THD* thd,
const TABLE* form,
HA_CREATE_INFO* create_info,
char* table_name,
char* remote_path,
bool file_per_table,
trx_t* trx = NULL);
/** Initialize the object. */
int initialize();
/** Set m_tablespace_type. */
void set_tablespace_type(bool table_being_altered_is_file_per_table);
/** Create InnoDB foreign keys from MySQL alter_info. */
dberr_t create_foreign_keys();
/** Create the internal innodb table.
@param create_fk whether to add FOREIGN KEY constraints */
int create_table(bool create_fk = true);
/** Update the internal data dictionary. */
int create_table_update_dict();
/** Validates the create options. Checks that the options
KEY_BLOCK_SIZE, ROW_FORMAT, DATA DIRECTORY, TEMPORARY & TABLESPACE
are compatible with each other and other settings.
These CREATE OPTIONS are not validated here unless innodb_strict_mode
is on. With strict mode, this function will report each problem it
finds using a custom message with error code
ER_ILLEGAL_HA_CREATE_OPTION, not its built-in message.
@return NULL if valid, string name of bad option if not. */
const char* create_options_are_invalid();
bool gcols_in_fulltext_or_spatial();
/** Validates engine specific table options not handled by
SQL-parser.
@return NULL if valid, string name of bad option if not. */
const char* check_table_options();
/** Validate DATA DIRECTORY option. */
bool create_option_data_directory_is_valid();
/** Validate TABLESPACE option. */
bool create_option_tablespace_is_valid();
/** Prepare to create a table. */
int prepare_create_table(const char* name, bool strict = true);
void allocate_trx();
/** Checks that every index have sane size. Depends on strict mode */
bool row_size_is_acceptable(const dict_table_t& table,
bool strict) const;
/** Checks that given index have sane size. Depends on strict mode */
bool row_size_is_acceptable(const dict_index_t& index,
bool strict) const;
/** Determines InnoDB table flags.
If strict_mode=OFF, this will adjust the flags to what should be assumed.
@retval true if successful, false if error */
bool innobase_table_flags();
/** Set flags and append '/' to remote path if necessary. */
void set_remote_path_flags();
/** Get table flags. */
ulint flags() const
{ return(m_flags); }
/** Update table flags. */
void flags_set(ulint flags) { m_flags |= flags; }
/** Get table flags2. */
ulint flags2() const
{ return(m_flags2); }
/** Get trx. */
trx_t* trx() const
{ return(m_trx); }
/** Return table name. */
const char* table_name() const
{ return(m_table_name); }
/** @return whether the table needs to be dropped on rollback */
bool drop_before_rollback() const { return m_drop_before_rollback; }
THD* thd() const
{ return(m_thd); }
/** Normalizes a table name string.
A normalized name consists of the database name catenated to '/' and
table name. An example: test/mytable. On Windows normalization puts
both the database name and the table name always to lower case if
"set_lower_case" is set to true.
@param[in,out] norm_name Buffer to return the normalized name in.
@param[in] name Table name string.
@param[in] set_lower_case True if we want to set name to lower
case. */
static void normalize_table_name_low(
char* norm_name,
const char* name,
ibool set_lower_case);
private:
/** Parses the table name into normal name and either temp path or
remote path if needed.*/
int
parse_table_name(
const char* name);
/** Create the internal innodb table definition. */
int create_table_def();
/** Connection thread handle. */
THD* m_thd;
/** InnoDB transaction handle. */
trx_t* m_trx;
/** Information on table columns and indexes. */
const TABLE* m_form;
/** Value of innodb_default_row_format */
const ulong m_default_row_format;
/** Create options. */
HA_CREATE_INFO* m_create_info;
/** Table name */
char* m_table_name;
/** Table */
dict_table_t* m_table;
/** Whether the table needs to be dropped before rollback */
bool m_drop_before_rollback;
/** Remote path (DATA DIRECTORY) or zero length-string */
char* m_remote_path;
/** Local copy of srv_file_per_table. */
bool m_innodb_file_per_table;
/** Allow file_per_table for this table either because:
1) the setting innodb_file_per_table=on,
2) it was explicitly requested by tablespace=innodb_file_per_table.
3) the table being altered is currently file_per_table */
bool m_allow_file_per_table;
/** After all considerations, this shows whether we will actually
create a table and tablespace using file-per-table. */
bool m_use_file_per_table;
/** Using DATA DIRECTORY */
bool m_use_data_dir;
/** Table flags */
ulint m_flags;
/** Table flags2 */
ulint m_flags2;
};
/**
Initialize the table FTS stopword list
@return TRUE if success */
ibool
innobase_fts_load_stopword(
/*=======================*/
dict_table_t* table, /*!< in: Table has the FTS */
trx_t* trx, /*!< in: transaction */
THD* thd) /*!< in: current thread */
MY_ATTRIBUTE((warn_unused_result));
/** Some defines for innobase_fts_check_doc_id_index() return value */
enum fts_doc_id_index_enum {
FTS_INCORRECT_DOC_ID_INDEX,
FTS_EXIST_DOC_ID_INDEX,
FTS_NOT_EXIST_DOC_ID_INDEX
};
/**
Check whether the table has a unique index with FTS_DOC_ID_INDEX_NAME
on the Doc ID column.
@return the status of the FTS_DOC_ID index */
fts_doc_id_index_enum
innobase_fts_check_doc_id_index(
const dict_table_t* table, /*!< in: table definition */
const TABLE* altered_table, /*!< in: MySQL table
that is being altered */
ulint* fts_doc_col_no) /*!< out: The column number for
Doc ID */
MY_ATTRIBUTE((warn_unused_result));
/**
Check whether the table has a unique index with FTS_DOC_ID_INDEX_NAME
on the Doc ID column in MySQL create index definition.
@return FTS_EXIST_DOC_ID_INDEX if there exists the FTS_DOC_ID index,
FTS_INCORRECT_DOC_ID_INDEX if the FTS_DOC_ID index is of wrong format */
fts_doc_id_index_enum
innobase_fts_check_doc_id_index_in_def(
ulint n_key, /*!< in: Number of keys */
const KEY* key_info) /*!< in: Key definitions */
MY_ATTRIBUTE((warn_unused_result));
/**
Copy table flags from MySQL's TABLE_SHARE into an InnoDB table object.
Those flags are stored in .frm file and end up in the MySQL table object,
but are frequently used inside InnoDB so we keep their copies into the
InnoDB table object. */
void
innobase_copy_frm_flags_from_table_share(
dict_table_t* innodb_table, /*!< in/out: InnoDB table */
const TABLE_SHARE* table_share); /*!< in: table share */
/** Set up base columns for virtual column
@param[in] table the InnoDB table
@param[in] field MySQL field
@param[in,out] v_col virtual column to be set up */
void
innodb_base_col_setup(
dict_table_t* table,
const Field* field,
dict_v_col_t* v_col);
/** Set up base columns for stored column
@param[in] table InnoDB table
@param[in] field MySQL field
@param[in,out] s_col stored column */
void
innodb_base_col_setup_for_stored(
const dict_table_t* table,
const Field* field,
dict_s_col_t* s_col);
/** whether this is a stored generated column */
#define innobase_is_s_fld(field) ((field)->vcol_info && (field)->stored_in_db())
/** Always normalize table name to lower case on Windows */
#ifdef _WIN32
#define normalize_table_name(norm_name, name) \
create_table_info_t::normalize_table_name_low(norm_name, name, TRUE)
#else
#define normalize_table_name(norm_name, name) \
create_table_info_t::normalize_table_name_low(norm_name, name, FALSE)
#endif /* _WIN32 */
/** Converts a search mode flag understood by MySQL to a flag understood
by InnoDB.
@param[in] find_flag MySQL search mode flag.
@return InnoDB search mode flag. */
page_cur_mode_t
convert_search_mode_to_innobase(
enum ha_rkey_function find_flag);
/** Commits a transaction in an InnoDB database.
@param[in] trx Transaction handle. */
void
innobase_commit_low(
trx_t* trx);
extern my_bool innobase_stats_on_metadata;
/** Calculate Record Per Key value.
Need to exclude the NULL value if innodb_stats_method is set to "nulls_ignored"
@param[in] index InnoDB index.
@param[in] i The column we are calculating rec per key.
@param[in] records Estimated total records.
@return estimated record per key value */
/* JAN: TODO: MySQL 5.7 */
typedef float rec_per_key_t;
rec_per_key_t
innodb_rec_per_key(
dict_index_t* index,
ulint i,
ha_rows records);
/** Build template for the virtual columns and their base columns
@param[in] table MySQL TABLE
@param[in] ib_table InnoDB dict_table_t
@param[in,out] s_templ InnoDB template structure
@param[in] add_v new virtual columns added along with
add index call
@param[in] locked true if innobase_share_mutex is held */
void
innobase_build_v_templ(
const TABLE* table,
const dict_table_t* ib_table,
dict_vcol_templ_t* s_templ,
const dict_add_v_col_t* add_v,
bool locked);
/** callback used by MySQL server layer to initialized
the table virtual columns' template
@param[in] table MySQL TABLE
@param[in,out] ib_table InnoDB dict_table_t */
void
innobase_build_v_templ_callback(
const TABLE* table,
void* ib_table);
/** Callback function definition, used by MySQL server layer to initialized
the table virtual columns' template */
typedef void (*my_gcolumn_templatecallback_t)(const TABLE*, void*);
/** Convert MySQL column number to dict_table_t::cols[] offset.
@param[in] field non-virtual column
@return column number relative to dict_table_t::cols[] */
unsigned
innodb_col_no(const Field* field)
MY_ATTRIBUTE((nonnull, warn_unused_result));
/********************************************************************//**
Helper function to push frm mismatch error to error log and
if needed to sql-layer. */
UNIV_INTERN
void
ib_push_frm_error(
/*==============*/
THD* thd, /*!< in: MySQL thd */
dict_table_t* ib_table, /*!< in: InnoDB table */
TABLE* table, /*!< in: MySQL table */
ulint n_keys, /*!< in: InnoDB #keys */
bool push_warning); /*!< in: print warning ? */
/** Check each index part length whether they not exceed the max limit
@param[in] max_field_len maximum allowed key part length
@param[in] key MariaDB key definition
@return true if index column length exceeds limit */
MY_ATTRIBUTE((warn_unused_result))
bool too_big_key_part_length(size_t max_field_len, const KEY& key);
/** This function is used to rollback one X/Open XA distributed transaction
which is in the prepared state
@param[in] hton InnoDB handlerton
@param[in] xid X/Open XA transaction identification
@return 0 or error number */
int innobase_rollback_by_xid(handlerton* hton, XID* xid);
/** Free tablespace resources allocated. */
void innobase_space_shutdown();
|