#include "sql/dd/object_id.h"
#include "sql/dd/types/column.h"
#include "univ.i"
#include "btr0types.h"
#include "data0type.h"
#include "dict0types.h"
#include "mem0mem.h"
#include "rem0types.h"
#include "row0types.h"
#include "lock0types.h"
#include "que0types.h"
#include "hash0hash.h"
#include "sync0rw.h"
#include "trx0types.h"
#include "ut0byte.h"
#include "ut0mem.h"
#include "ut0rnd.h"
#include "fts0fts.h"
#include "buf0buf.h"
#include "gis0type.h"
#include "os0once.h"
#include "dict/mem.h"
#include "ut0new.h"
#include "sql/sql_const.h"
#include <algorithm>
#include <iterator>
#include <memory>
#include <set>
#include <string>
#include <vector>
#include "dict0mem.ic"

Classes
class	id_name_t
	SQL identifier name wrapper for pretty-printing. More...

struct	table_name_t
	Table name wrapper for pretty-printing. More...

struct	dict_col_default_t
	Data structure for default value of a column in a table. More...

struct	dict_col_t
	Data structure for a column in a table. More...

struct	dict_v_idx_t
	Index information put in a list of virtual column structure. More...

struct	dict_v_col_t
	Data structure for a virtual column in a table. More...

struct	dict_add_v_col_t
	Data structure for newly added virtual column in a table. More...

struct	dict_s_col_t
	Data structure for a stored column in a table. More...

struct	dict_field_t
	Data structure for a field in an index. More...

struct	zip_pad_info_t
	Data structure to hold information about about how much space in an uncompressed page should be left as padding to avoid compression failures. More...

class	rec_cache_t
	If key is fixed length key then cache the record offsets on first computation. More...

class	last_ops_cur_t
	Cache position of last inserted or selected record by caching record and holding reference to the block where record resides. More...

struct	dict_index_t
	Data structure for an index. More...

struct	dict_foreign_t
	Data structure for a foreign key constraint; an example: FOREIGN KEY (A, B) REFERENCES TABLE2 (C, D). More...

struct	dict_foreign_print

struct	dict_foreign_compare
	Compare two dict_foreign_t objects using their ids. More...

struct	dict_foreign_with_index
	A function object to find a foreign key with the given index as the referenced index. More...

struct	dict_foreign_different_tables

struct	dict_foreign_not_exists
	Function object to check if a foreign key object is there in the given foreign key set or not. More...

struct	dict_foreign_set_free
	The destructor will free all the foreign key constraints in the set by calling dict_foreign_free() on each of the foreign key constraints. More...

struct	dict_vcol_templ_t
	Structure defines template related to virtual columns and their base columns. More...

struct	dict_table_t
	Data structure for a database table. More...

class	PersistentTableMetadata
	Persistent dynamic metadata for a table. More...

class	Persister
	Interface for persistent dynamic table metadata. More...

class	CorruptedIndexPersister
	Persister used for corrupted indexes. More...

class	AutoIncPersister
	Persister used for autoinc counters. More...

class	Persisters
	Container of persisters used in the system. More...

struct	dict_foreign_add_to_referenced_table
	A function object to add the foreign key constraint to the referenced set of the referenced table, if it exists in the dictionary cache. More...

Namespaces
	dd
	The version of the current data dictionary table definitions.

Macros
#define	DICT_CLUSTERED 1
	Type flags of an index: OR'ing of the flags is allowed to define a combination of types. More...

#define	DICT_UNIQUE 2
	unique index More...

#define	DICT_IBUF 8
	insert buffer tree More...

#define	DICT_CORRUPT 16
	bit to store the corrupted flag \ in SYS_INDEXES.TYPE More...

#define	DICT_FTS

#define	DICT_SPATIAL

#define	DICT_VIRTUAL 128 /* Index on Virtual column */

#define	DICT_SDI

#define	DICT_MULTI_VALUE 512 /* Multi-value index */

#define	DICT_IT_BITS 10
	number of bits used for \ SYS_INDEXES.TYPE More...

#define	DICT_TF_REDUNDANT 0
	dict_table_t::flags bit 0 is equal to 0 if the row format = Redundant More...

#define	DICT_TF_COMPACT 1
	dict_table_t::flags bit 0 is equal to 1 if the row format = Compact More...

#define	DICT_N_COLS_COMPACT 0x80000000UL
	This bitmask is used in SYS_TABLES.N_COLS to set and test whether the Compact page format is used, i.e ROW_FORMAT != REDUNDANT. More...

#define	DICT_TF_WIDTH_COMPACT 1
	Width of the COMPACT flag. More...

#define	DICT_TF_WIDTH_ZIP_SSIZE 4
	Width of the ZIP_SSIZE flag. More...

#define	DICT_TF_WIDTH_ATOMIC_BLOBS 1
	Width of the ATOMIC_BLOBS flag. More...

#define	DICT_TF_WIDTH_DATA_DIR 1
	If a table is created with the MYSQL option DATA DIRECTORY and innodb-file-per-table, an older engine will not be able to find that table. More...

#define	DICT_TF_WIDTH_SHARED_SPACE 1
	Width of the SHARED tablespace flag. More...

#define	DICT_TF_BITS
	Width of all the currently known table flags. More...

#define	DICT_TF_BIT_MASK (~(~0 << DICT_TF_BITS))
	A mask of all the known/used bits in table flags. More...

#define	DICT_TF_POS_COMPACT 0
	Zero relative shift position of the COMPACT field. More...

#define	DICT_TF_POS_ZIP_SSIZE (DICT_TF_POS_COMPACT + DICT_TF_WIDTH_COMPACT)
	Zero relative shift position of the ZIP_SSIZE field. More...

#define	DICT_TF_POS_ATOMIC_BLOBS (DICT_TF_POS_ZIP_SSIZE + DICT_TF_WIDTH_ZIP_SSIZE)
	Zero relative shift position of the ATOMIC_BLOBS field. More...

#define	DICT_TF_POS_DATA_DIR (DICT_TF_POS_ATOMIC_BLOBS + DICT_TF_WIDTH_ATOMIC_BLOBS)
	Zero relative shift position of the DATA_DIR field. More...

#define	DICT_TF_POS_SHARED_SPACE (DICT_TF_POS_DATA_DIR + DICT_TF_WIDTH_DATA_DIR)
	Zero relative shift position of the SHARED TABLESPACE field. More...

#define	DICT_TF_POS_UNUSED (DICT_TF_POS_SHARED_SPACE + DICT_TF_WIDTH_SHARED_SPACE)
	Zero relative shift position of the start of the UNUSED bits. More...

#define	DICT_TF_MASK_COMPACT ((~(~0U << DICT_TF_WIDTH_COMPACT)) << DICT_TF_POS_COMPACT)
	Bit mask of the COMPACT field. More...

#define	DICT_TF_MASK_ZIP_SSIZE ((~(~0U << DICT_TF_WIDTH_ZIP_SSIZE)) << DICT_TF_POS_ZIP_SSIZE)
	Bit mask of the ZIP_SSIZE field. More...

#define	DICT_TF_MASK_ATOMIC_BLOBS ((~(~0U << DICT_TF_WIDTH_ATOMIC_BLOBS)) << DICT_TF_POS_ATOMIC_BLOBS)
	Bit mask of the ATOMIC_BLOBS field. More...

#define	DICT_TF_MASK_DATA_DIR ((~(~0U << DICT_TF_WIDTH_DATA_DIR)) << DICT_TF_POS_DATA_DIR)
	Bit mask of the DATA_DIR field. More...

#define	DICT_TF_MASK_SHARED_SPACE ((~(~0U << DICT_TF_WIDTH_SHARED_SPACE)) << DICT_TF_POS_SHARED_SPACE)
	Bit mask of the SHARED_SPACE field. More...

#define	DICT_TF_GET_COMPACT(flags) ((flags & DICT_TF_MASK_COMPACT) >> DICT_TF_POS_COMPACT)
	Return the value of the COMPACT field. More...

#define	DICT_TF_GET_ZIP_SSIZE(flags) ((flags & DICT_TF_MASK_ZIP_SSIZE) >> DICT_TF_POS_ZIP_SSIZE)
	Return the value of the ZIP_SSIZE field. More...

#define	DICT_TF_HAS_ATOMIC_BLOBS(flags) ((flags & DICT_TF_MASK_ATOMIC_BLOBS) >> DICT_TF_POS_ATOMIC_BLOBS)
	Return the value of the ATOMIC_BLOBS field. More...

#define	DICT_TF_HAS_DATA_DIR(flags) ((flags & DICT_TF_MASK_DATA_DIR) >> DICT_TF_POS_DATA_DIR)
	Return the value of the DATA_DIR field. More...

#define	DICT_TF_HAS_SHARED_SPACE(flags) ((flags & DICT_TF_MASK_SHARED_SPACE) >> DICT_TF_POS_SHARED_SPACE)
	Return the value of the SHARED_SPACE field. More...

#define	DICT_TF_GET_UNUSED(flags) (flags >> DICT_TF_POS_UNUSED)
	Return the contents of the UNUSED bits. More...

#define	DICT_TF2_BITS 11
	Table Flags set number 2. More...

#define	DICT_TF2_UNUSED_BIT_MASK (~0U << DICT_TF2_BITS)

#define	DICT_TF2_BIT_MASK ~DICT_TF2_UNUSED_BIT_MASK

#define	DICT_TF2_TEMPORARY 1
	TEMPORARY; TRUE for tables from CREATE TEMPORARY TABLE. More...

#define	DICT_TF2_FTS_HAS_DOC_ID 2
	The table has an internal defined DOC ID column. More...

#define	DICT_TF2_FTS 4
	The table has an FTS index. More...

#define	DICT_TF2_FTS_ADD_DOC_ID 8
	Need to add Doc ID column for FTS index build. More...

#define	DICT_TF2_USE_FILE_PER_TABLE 16
	This bit is used during table creation to indicate that it will use its own tablespace instead of the system tablespace. More...

#define	DICT_TF2_DISCARDED 32
	Set when we discard/detach the tablespace. More...

#define	DICT_TF2_INTRINSIC 128
	Intrinsic table bit Intrinsic table is table created internally by MySQL modules viz. More...

#define	DICT_TF2_ENCRYPTION_FILE_PER_TABLE 256
	Encryption table bit for innodb_file-per-table only. More...

#define	DICT_TF2_AUX 512
	FTS AUX hidden table bit. More...

#define	DICT_TF2_RESURRECT_PREPARED 1024
	Table is opened by resurrected trx during crash recovery. More...

#define	DICT_TF2_FLAG_SET(table, flag) (table->flags2 \|= (flag))

#define	DICT_TF2_FLAG_IS_SET(table, flag) (table->flags2 & (flag))

#define	DICT_TF2_FLAG_UNSET(table, flag) (table->flags2 &= ~(flag))

#define	DICT_FK_MAX_RECURSIVE_LOAD 20
	Tables could be chained together with Foreign key constraint. More...

#define	FK_MAX_CASCADE_DEL 15
	Similarly, when tables are chained together with foreign key constraints with on cascading delete/update clause, delete from parent table could result in recursive cascading calls. More...

#define	DICT_ANTELOPE_MAX_INDEX_COL_LEN REC_ANTELOPE_MAX_INDEX_COL_LEN
	DICT_ANTELOPE_MAX_INDEX_COL_LEN is measured in bytes and is the maximum indexed column length (or indexed prefix length) in ROW_FORMAT=REDUNDANT and ROW_FORMAT=COMPACT. More...

#define	DICT_MAX_FIELD_LEN_BY_FORMAT(table)
	Find out maximum indexed column length by its table format. More...

#define	DICT_MAX_FIELD_LEN_BY_FORMAT_FLAG(flags)

#define	DICT_MAX_FIXED_COL_LEN DICT_ANTELOPE_MAX_INDEX_COL_LEN
	Defines the maximum fixed length column size. More...

#define	ZIP_PAD_ROUND_LEN (128)
	PADDING HEURISTIC BASED ON LINEAR INCREASE OF PADDING TO AVOID COMPRESSION FAILURES (Note: this is relevant only for compressed indexes) GOAL: Avoid compression failures by maintaining information about the compressibility of data. More...

#define	ZIP_PAD_SUCCESSFUL_ROUND_LIMIT (5)
	Number of successful rounds after which the padding is decreased. More...

#define	ZIP_PAD_INCR (128)
	Amount by which padding is increased. More...

#define	DICT_INDEX_MERGE_THRESHOLD_DEFAULT 50

#define	MAX_KEY_LENGTH_BITS 12

#define	DICT_INDEX_MAGIC_N 76789786
	Value of dict_index_t::magic_n. More...

#define	DICT_FOREIGN_ON_DELETE_CASCADE 1
	The flags for ON_UPDATE and ON_DELETE can be ORed; the default is that a foreign key constraint is enforced, therefore RESTRICT just means no flag. More...

#define	DICT_FOREIGN_ON_DELETE_SET_NULL 2
	ON DELETE SET NULL. More...

#define	DICT_FOREIGN_ON_UPDATE_CASCADE 4
	ON UPDATE CASCADE. More...

#define	DICT_FOREIGN_ON_UPDATE_SET_NULL 8
	ON UPDATE SET NULL. More...

#define	DICT_FOREIGN_ON_DELETE_NO_ACTION 16
	ON DELETE NO ACTION. More...

#define	DICT_FOREIGN_ON_UPDATE_NO_ACTION 32
	ON UPDATE NO ACTION. More...


#define	DICT_STATS_PERSISTENT_ON (1 << 1)
	The two bits below are set in the 'stat_persistent' member. More...

#define	DICT_STATS_PERSISTENT_OFF (1 << 2)

#define	DICT_STATS_AUTO_RECALC_ON (1 << 1)
	The two bits below are set in the 'stats_auto_recalc' member. More...

#define	DICT_STATS_AUTO_RECALC_OFF (1 << 2)

#define	BG_STAT_NONE 0
	Background stats thread is not working on this table. More...

#define	BG_STAT_IN_PROGRESS (1 << 0)
	Set in 'stats_bg_flag' when the background stats code is working on this table. More...

#define	BG_STAT_SHOULD_QUIT (1 << 1)
	Set in 'stats_bg_flag' when DROP TABLE starts waiting on BG_STAT_IN_PROGRESS to be cleared. More...

#define	DICT_TABLE_MAGIC_N 76333786
	Value of 'magic_n'. More...

Typedefs
typedef std::list< dict_v_idx_t, ut_allocator< dict_v_idx_t > >	dict_v_idx_list
	Index list to put in dict_v_col_t. More...

typedef std::list< dict_s_col_t, ut_allocator< dict_s_col_t > >	dict_s_col_list
	list to put stored column for dict_table_t More...

typedef std::set< dict_v_col_t , std::less< dict_v_col_t >, ut_allocator< dict_v_col_t * > >	dict_vcol_set
	Set to store the virtual columns which are affected by Foreign key constraint. More...

typedef std::set< dict_foreign_t , dict_foreign_compare, ut_allocator< dict_foreign_t > >	dict_foreign_set

typedef ut_list_base< lock_t, ut_list_node< lock_t > lock_table_t::* >	table_lock_list_t
	List of locks that different transactions have acquired on a table. More...

typedef std::vector< row_prebuilt_t * >	temp_prebuilt_vec
	A vector to collect prebuilt from different readers working on the same temp table. More...

typedef std::vector< index_id_t, ut_allocator< index_id_t > >	corrupted_ids_t

Enumerations
enum	online_index_status { ONLINE_INDEX_COMPLETE = 0, ONLINE_INDEX_CREATION, ONLINE_INDEX_ABORTED, ONLINE_INDEX_ABORTED_DROPPED }
	The status of online index creation. More...

enum	table_dirty_status { METADATA_DIRTY = 0, METADATA_BUFFERED, METADATA_CLEAN }
	The dirty status of tables, used to indicate if a table has some dynamic metadata changed to be written back. More...

enum	persistent_type_t { PM_SMALLEST_TYPE = 0, PM_INDEX_CORRUPTED = 1, PM_TABLE_AUTO_INC = 2, PM_BIGGEST_TYPE = 3 }
	Persistent dynamic metadata type, there should be 1 to 1 relationship between the metadata and the type. More...

Functions
dict_v_col_t *	dict_mem_table_add_v_col (dict_table_t table, mem_heap_t heap, const char *name, ulint mtype, ulint prtype, ulint len, ulint pos, ulint num_base)
	Adds a virtual column definition to a table. More...

void	dict_mem_table_add_s_col (dict_table_t *table, ulint num_base)
	Adds a stored column definition to a table. More...

void	dict_mem_table_col_rename (dict_table_t table, ulint nth_col, const char from, const char *to, bool is_virtual)
	Renames a column of a table in the data dictionary cache. More...

UNIV_INLINE void	dict_mem_fill_index_struct (dict_index_t index, mem_heap_t heap, const char table_name, const char index_name, ulint space, ulint type, ulint n_fields)
	This function poplulates a dict_index_t index memory structure with supplied information. More...

void	dict_mem_index_free (dict_index_t *index)
	Frees an index memory object. More...

dict_foreign_t *	dict_mem_foreign_create (void)
	Creates and initializes a foreign constraint memory object. More...

void	dict_mem_foreign_table_name_lookup_set (dict_foreign_t *foreign, ibool do_alloc)
	Sets the foreign_table_name_lookup pointer based on the value of lower_case_table_names. More...

void	dict_mem_referenced_table_name_lookup_set (dict_foreign_t *foreign, ibool do_alloc)
	Sets the referenced_table_name_lookup pointer based on the value of lower_case_table_names. More...

void	dict_mem_foreign_fill_vcol_set (dict_foreign_t *foreign)
	Fills the dependent virtual columns in a set. More...

void	dict_mem_table_fill_foreign_vcol_set (dict_table_t *table)
	Fill virtual columns set in each fk constraint present in the table. More...

void	dict_mem_table_free_foreign_vcol_set (dict_table_t *table)
	Free the vcol_set from all foreign key constraint on the table. More...

char *	dict_mem_create_temporary_tablename (mem_heap_t heap, const char dbtab, table_id_t id)
	Create a temporary tablename like "#sql-ibtid-inc" where tid = the Table ID inc = a randomly initialized number that is incremented for each file The table ID is a 64 bit integer, can use up to 20 digits, and is initialized at bootstrap. More...

void	dict_mem_init (void)
	Initialize dict memory variables. More...

std::ostream &	operator<< (std::ostream &out, const dict_foreign_t &foreign)

std::ostream &	operator<< (std::ostream &out, const dict_foreign_set &fk_set)

bool	dict_foreign_set_validate (const dict_foreign_set &fk_set)
	Validate the search order in the foreign key set. More...

bool	dict_foreign_set_validate (const dict_table_t &table)
	Validate the search order in the foreign key sets of the table (foreign_set and referenced_set). More...

void	dict_foreign_free (dict_foreign_t *foreign)
	Frees a foreign key struct. More...

std::ostream &	operator<< (std::ostream &s, const id_name_t &id_name)
	Display an identifier. More...

std::ostream &	operator<< (std::ostream &s, const table_name_t &table_name)
	Display a table name. More...

void	lock_table_lock_list_init (table_lock_list_t *locks)
	Initialise the table lock list. More...

void	dict_table_mutex_create_lazy (dict_table_t *table)
	Request for lazy creation of the mutex of a given table. More...

void	dict_table_mutex_destroy (dict_table_t *table)
	Destroy the mutex of a given table. More...

void	dict_table_autoinc_destroy (dict_table_t *table)
	Destroy the autoinc latch of the given table. More...

void	dict_table_autoinc_create_lazy (dict_table_t *table)
	Request for lazy creation of the autoinc latch of a given table. More...

void	dict_index_zip_pad_mutex_create_lazy (dict_index_t *index)
	Request a lazy creation of dict_index_t::zip_pad::mutex. More...

void	dict_index_zip_pad_mutex_destroy (dict_index_t *index)
	Destroy the zip_pad_mutex of the given index. More...

void	dict_index_zip_pad_unlock (dict_index_t *index)
	Release the zip_pad_mutex of a given index. More...

bool	dict_table_autoinc_own (const dict_table_t *table)
	Check if the current thread owns the autoinc_mutex of a given table. More...

Variables
ulong	zip_failure_threshold_pct
	Percentage of compression failures that are allowed in a single round. More...

ulong	zip_pad_max
	Maximum percentage of a page that can be allowed as a pad to avoid compression failures. More...

const char	innobase_index_reserve_name [] = "GEN_CLUST_INDEX"
	"GEN_CLUST_INDEX" is the name reserved for InnoDB default system clustered index when there is no primary key. More...

Detailed Description

Data dictionary memory object creation

Created 1/8/1996 Heikki Tuuri

Macro Definition Documentation

◆ BG_STAT_IN_PROGRESS

#define BG_STAT_IN_PROGRESS (1 << 0)

Set in 'stats_bg_flag' when the background stats code is working on this table.

The DROP TABLE code waits for this to be cleared before proceeding.

◆ BG_STAT_NONE

#define BG_STAT_NONE 0

Background stats thread is not working on this table.

◆ BG_STAT_SHOULD_QUIT

#define BG_STAT_SHOULD_QUIT (1 << 1)

Set in 'stats_bg_flag' when DROP TABLE starts waiting on BG_STAT_IN_PROGRESS to be cleared.

The background stats thread will detect this and will eventually quit sooner.

◆ DICT_ANTELOPE_MAX_INDEX_COL_LEN

#define DICT_ANTELOPE_MAX_INDEX_COL_LEN REC_ANTELOPE_MAX_INDEX_COL_LEN

DICT_ANTELOPE_MAX_INDEX_COL_LEN is measured in bytes and is the maximum indexed column length (or indexed prefix length) in ROW_FORMAT=REDUNDANT and ROW_FORMAT=COMPACT.

Also, in any format, any fixed-length field that is longer than this will be encoded as a variable-length field.

It is set to 3*256, so that one can create a column prefix index on 256 characters of a TEXT or VARCHAR column also in the UTF-8 charset. In that charset, a character may take at most 3 bytes. This constant MUST NOT BE CHANGED, or the compatibility of InnoDB data files would be at risk!

◆ DICT_CLUSTERED

#define DICT_CLUSTERED 1

Type flags of an index: OR'ing of the flags is allowed to define a combination of types.

clustered index; for other than \ auto-generated clustered indexes, \ also DICT_UNIQUE will be set

◆ DICT_CORRUPT

#define DICT_CORRUPT 16

bit to store the corrupted flag \ in SYS_INDEXES.TYPE

◆ DICT_FK_MAX_RECURSIVE_LOAD

#define DICT_FK_MAX_RECURSIVE_LOAD 20

Tables could be chained together with Foreign key constraint.

When first load the parent table, we would load all of its descedents. This could result in rescursive calls and out of stack error eventually. DICT_FK_MAX_RECURSIVE_LOAD defines the maximum number of recursive loads, when exceeded, the child table will not be loaded. It will be loaded when the foreign constraint check needs to be run.

◆ DICT_FOREIGN_ON_DELETE_CASCADE

#define DICT_FOREIGN_ON_DELETE_CASCADE 1

The flags for ON_UPDATE and ON_DELETE can be ORed; the default is that a foreign key constraint is enforced, therefore RESTRICT just means no flag.

ON DELETE CASCADE

◆ DICT_FOREIGN_ON_DELETE_NO_ACTION

#define DICT_FOREIGN_ON_DELETE_NO_ACTION 16

ON DELETE NO ACTION.

◆ DICT_FOREIGN_ON_DELETE_SET_NULL

#define DICT_FOREIGN_ON_DELETE_SET_NULL 2

ON DELETE SET NULL.

◆ DICT_FOREIGN_ON_UPDATE_CASCADE

#define DICT_FOREIGN_ON_UPDATE_CASCADE 4

ON UPDATE CASCADE.

◆ DICT_FOREIGN_ON_UPDATE_NO_ACTION

#define DICT_FOREIGN_ON_UPDATE_NO_ACTION 32

ON UPDATE NO ACTION.

◆ DICT_FOREIGN_ON_UPDATE_SET_NULL

#define DICT_FOREIGN_ON_UPDATE_SET_NULL 8

ON UPDATE SET NULL.

◆ DICT_FTS

#define DICT_FTS

Value:

32 /* FTS index; can't be combined with the \

other flags */

◆ DICT_IBUF

#define DICT_IBUF 8

insert buffer tree

◆ DICT_INDEX_MAGIC_N

#define DICT_INDEX_MAGIC_N 76789786

Value of dict_index_t::magic_n.

◆ DICT_INDEX_MERGE_THRESHOLD_DEFAULT

#define DICT_INDEX_MERGE_THRESHOLD_DEFAULT 50

◆ DICT_IT_BITS

#define DICT_IT_BITS 10

number of bits used for \ SYS_INDEXES.TYPE

◆ DICT_MAX_FIELD_LEN_BY_FORMAT

#define DICT_MAX_FIELD_LEN_BY_FORMAT ( table )

Value:

(dict_table_has_atomic_blobs(table) ? REC_VERSION_56_MAX_INDEX_COL_LEN \

: REC_ANTELOPE_MAX_INDEX_COL_LEN - 1)

Find out maximum indexed column length by its table format.

For ROW_FORMAT=REDUNDANT and ROW_FORMAT=COMPACT, the maximum field length is REC_ANTELOPE_MAX_INDEX_COL_LEN - 1 (767). For ROW_FORMAT=COMPRESSED and ROW_FORMAT=DYNAMIC, the length could be REC_VERSION_56_MAX_INDEX_COL_LEN (3072) bytes

◆ DICT_MAX_FIELD_LEN_BY_FORMAT_FLAG

#define DICT_MAX_FIELD_LEN_BY_FORMAT_FLAG ( flags )

Value:

(DICT_TF_HAS_ATOMIC_BLOBS(flags) ? REC_VERSION_56_MAX_INDEX_COL_LEN \

: REC_ANTELOPE_MAX_INDEX_COL_LEN - 1)

◆ DICT_MAX_FIXED_COL_LEN

#define DICT_MAX_FIXED_COL_LEN DICT_ANTELOPE_MAX_INDEX_COL_LEN

Defines the maximum fixed length column size.

◆ DICT_MULTI_VALUE

#define DICT_MULTI_VALUE 512 /* Multi-value index */

◆ DICT_N_COLS_COMPACT

#define DICT_N_COLS_COMPACT 0x80000000UL

This bitmask is used in SYS_TABLES.N_COLS to set and test whether the Compact page format is used, i.e ROW_FORMAT != REDUNDANT.

◆ DICT_SDI

#define DICT_SDI

Value:

256 /* Tablespace dictionary Index. Set only in \

in-memory index structure. */

◆ DICT_SPATIAL

#define DICT_SPATIAL

Value:

64 /* SPATIAL index; can't be combined with the \

other flags */

◆ DICT_STATS_AUTO_RECALC_OFF

#define DICT_STATS_AUTO_RECALC_OFF (1 << 2)

◆ DICT_STATS_AUTO_RECALC_ON

#define DICT_STATS_AUTO_RECALC_ON (1 << 1)

The two bits below are set in the 'stats_auto_recalc' member.

They have the following meaning:

_ON=0, _OFF=0, no explicit auto recalc setting for this table, the value of the global srv_stats_persistent_auto_recalc is used to determine whether the table has auto recalc enabled or not
_ON=0, _OFF=1, auto recalc is explicitly disabled for this table, regardless of the value of the global srv_stats_persistent_auto_recalc
_ON=1, _OFF=0, auto recalc is explicitly enabled for this table, regardless of the value of the global srv_stats_persistent_auto_recalc
_ON=1, _OFF=1, not allowed, we assert if this ever happens.

◆ DICT_STATS_PERSISTENT_OFF

#define DICT_STATS_PERSISTENT_OFF (1 << 2)

◆ DICT_STATS_PERSISTENT_ON

#define DICT_STATS_PERSISTENT_ON (1 << 1)

The two bits below are set in the 'stat_persistent' member.

They have the following meaning:

_ON=0, _OFF=0, no explicit persistent stats setting for this table, the value of the global srv_stats_persistent is used to determine whether the table has persistent stats enabled or not
_ON=0, _OFF=1, persistent stats are explicitly disabled for this table, regardless of the value of the global srv_stats_persistent
_ON=1, _OFF=0, persistent stats are explicitly enabled for this table, regardless of the value of the global srv_stats_persistent
_ON=1, _OFF=1, not allowed, we assert if this ever happens.

◆ DICT_TABLE_MAGIC_N

#define DICT_TABLE_MAGIC_N 76333786

Value of 'magic_n'.

◆ DICT_TF2_AUX

#define DICT_TF2_AUX 512

FTS AUX hidden table bit.

◆ DICT_TF2_BIT_MASK

#define DICT_TF2_BIT_MASK ~DICT_TF2_UNUSED_BIT_MASK

◆ DICT_TF2_BITS

#define DICT_TF2_BITS 11

Table Flags set number 2.

These flags will be stored in SYS_TABLES.MIX_LEN. All unused flags will be written as 0. The column may contain garbage for tables created with old versions of InnoDB that only implemented ROW_FORMAT=REDUNDANT. InnoDB engines do not check these flags for unknown bits in order to protect backward incompatibility. Total number of bits in table->flags2.

◆ DICT_TF2_DISCARDED

#define DICT_TF2_DISCARDED 32

Set when we discard/detach the tablespace.

◆ DICT_TF2_ENCRYPTION_FILE_PER_TABLE

#define DICT_TF2_ENCRYPTION_FILE_PER_TABLE 256

Encryption table bit for innodb_file-per-table only.

◆ DICT_TF2_FLAG_IS_SET

#define DICT_TF2_FLAG_IS_SET	(	table,
		flag
	)	(table->flags2 & (flag))

◆ DICT_TF2_FLAG_SET

#define DICT_TF2_FLAG_SET	(	table,
		flag
	)	(table->flags2 \|= (flag))

◆ DICT_TF2_FLAG_UNSET

#define DICT_TF2_FLAG_UNSET	(	table,
		flag
	)	(table->flags2 &= ~(flag))

◆ DICT_TF2_FTS

#define DICT_TF2_FTS 4

The table has an FTS index.

◆ DICT_TF2_FTS_ADD_DOC_ID

#define DICT_TF2_FTS_ADD_DOC_ID 8

Need to add Doc ID column for FTS index build.

This is a transient bit for index build

◆ DICT_TF2_FTS_HAS_DOC_ID

#define DICT_TF2_FTS_HAS_DOC_ID 2

The table has an internal defined DOC ID column.

◆ DICT_TF2_INTRINSIC

#define DICT_TF2_INTRINSIC 128

Intrinsic table bit Intrinsic table is table created internally by MySQL modules viz.

Optimizer, FTS, etc.... Intrinsic table has all the properties of the normal table except it is not created by user and so not visible to end-user.

◆ DICT_TF2_RESURRECT_PREPARED

#define DICT_TF2_RESURRECT_PREPARED 1024

Table is opened by resurrected trx during crash recovery.

◆ DICT_TF2_TEMPORARY

#define DICT_TF2_TEMPORARY 1

TEMPORARY; TRUE for tables from CREATE TEMPORARY TABLE.

◆ DICT_TF2_UNUSED_BIT_MASK

#define DICT_TF2_UNUSED_BIT_MASK (~0U << DICT_TF2_BITS)

◆ DICT_TF2_USE_FILE_PER_TABLE

#define DICT_TF2_USE_FILE_PER_TABLE 16

This bit is used during table creation to indicate that it will use its own tablespace instead of the system tablespace.

◆ DICT_TF_BIT_MASK

#define DICT_TF_BIT_MASK (~(~0 << DICT_TF_BITS))

A mask of all the known/used bits in table flags.

◆ DICT_TF_BITS

#define DICT_TF_BITS

Value:

  (DICT_TF_WIDTH_COMPACT + DICT_TF_WIDTH_ZIP_SSIZE +     \
   DICT_TF_WIDTH_ATOMIC_BLOBS + DICT_TF_WIDTH_DATA_DIR + \
   DICT_TF_WIDTH_SHARED_SPACE)

Width of all the currently known table flags.

◆ DICT_TF_COMPACT

#define DICT_TF_COMPACT 1

dict_table_t::flags bit 0 is equal to 1 if the row format = Compact

Compact row format.

◆ DICT_TF_GET_COMPACT

#define DICT_TF_GET_COMPACT ( flags ) ((flags & DICT_TF_MASK_COMPACT) >> DICT_TF_POS_COMPACT)

Return the value of the COMPACT field.

◆ DICT_TF_GET_UNUSED

#define DICT_TF_GET_UNUSED ( flags ) (flags >> DICT_TF_POS_UNUSED)

Return the contents of the UNUSED bits.

◆ DICT_TF_GET_ZIP_SSIZE

#define DICT_TF_GET_ZIP_SSIZE ( flags ) ((flags & DICT_TF_MASK_ZIP_SSIZE) >> DICT_TF_POS_ZIP_SSIZE)

Return the value of the ZIP_SSIZE field.

◆ DICT_TF_HAS_ATOMIC_BLOBS

#define DICT_TF_HAS_ATOMIC_BLOBS ( flags ) ((flags & DICT_TF_MASK_ATOMIC_BLOBS) >> DICT_TF_POS_ATOMIC_BLOBS)

Return the value of the ATOMIC_BLOBS field.

◆ DICT_TF_HAS_DATA_DIR

#define DICT_TF_HAS_DATA_DIR ( flags ) ((flags & DICT_TF_MASK_DATA_DIR) >> DICT_TF_POS_DATA_DIR)

Return the value of the DATA_DIR field.

◆ DICT_TF_HAS_SHARED_SPACE

#define DICT_TF_HAS_SHARED_SPACE ( flags ) ((flags & DICT_TF_MASK_SHARED_SPACE) >> DICT_TF_POS_SHARED_SPACE)

Return the value of the SHARED_SPACE field.

◆ DICT_TF_MASK_ATOMIC_BLOBS

#define DICT_TF_MASK_ATOMIC_BLOBS ((~(~0U << DICT_TF_WIDTH_ATOMIC_BLOBS)) << DICT_TF_POS_ATOMIC_BLOBS)

Bit mask of the ATOMIC_BLOBS field.

◆ DICT_TF_MASK_COMPACT

#define DICT_TF_MASK_COMPACT ((~(~0U << DICT_TF_WIDTH_COMPACT)) << DICT_TF_POS_COMPACT)

Bit mask of the COMPACT field.

◆ DICT_TF_MASK_DATA_DIR

#define DICT_TF_MASK_DATA_DIR ((~(~0U << DICT_TF_WIDTH_DATA_DIR)) << DICT_TF_POS_DATA_DIR)

Bit mask of the DATA_DIR field.

◆ DICT_TF_MASK_SHARED_SPACE

#define DICT_TF_MASK_SHARED_SPACE ((~(~0U << DICT_TF_WIDTH_SHARED_SPACE)) << DICT_TF_POS_SHARED_SPACE)

Bit mask of the SHARED_SPACE field.

◆ DICT_TF_MASK_ZIP_SSIZE

#define DICT_TF_MASK_ZIP_SSIZE ((~(~0U << DICT_TF_WIDTH_ZIP_SSIZE)) << DICT_TF_POS_ZIP_SSIZE)

Bit mask of the ZIP_SSIZE field.

◆ DICT_TF_POS_ATOMIC_BLOBS

#define DICT_TF_POS_ATOMIC_BLOBS (DICT_TF_POS_ZIP_SSIZE + DICT_TF_WIDTH_ZIP_SSIZE)

Zero relative shift position of the ATOMIC_BLOBS field.

◆ DICT_TF_POS_COMPACT

#define DICT_TF_POS_COMPACT 0

Zero relative shift position of the COMPACT field.

◆ DICT_TF_POS_DATA_DIR

#define DICT_TF_POS_DATA_DIR (DICT_TF_POS_ATOMIC_BLOBS + DICT_TF_WIDTH_ATOMIC_BLOBS)

Zero relative shift position of the DATA_DIR field.

◆ DICT_TF_POS_SHARED_SPACE

#define DICT_TF_POS_SHARED_SPACE (DICT_TF_POS_DATA_DIR + DICT_TF_WIDTH_DATA_DIR)

Zero relative shift position of the SHARED TABLESPACE field.

◆ DICT_TF_POS_UNUSED

#define DICT_TF_POS_UNUSED (DICT_TF_POS_SHARED_SPACE + DICT_TF_WIDTH_SHARED_SPACE)

Zero relative shift position of the start of the UNUSED bits.

◆ DICT_TF_POS_ZIP_SSIZE

#define DICT_TF_POS_ZIP_SSIZE (DICT_TF_POS_COMPACT + DICT_TF_WIDTH_COMPACT)

Zero relative shift position of the ZIP_SSIZE field.

◆ DICT_TF_REDUNDANT

#define DICT_TF_REDUNDANT 0

dict_table_t::flags bit 0 is equal to 0 if the row format = Redundant

Redundant row format.

◆ DICT_TF_WIDTH_ATOMIC_BLOBS

#define DICT_TF_WIDTH_ATOMIC_BLOBS 1

Width of the ATOMIC_BLOBS flag.

The ROW_FORMAT=REDUNDANT and ROW_FORMAT=COMPACT broke up BLOB and TEXT fields, storing the first 768 bytes in the clustered index. ROW_FORMAT=DYNAMIC and ROW_FORMAT=COMPRESSED store the whole blob or text field off-page atomically. Secondary indexes are created from this external data using row_ext_t to cache the BLOB prefixes.

◆ DICT_TF_WIDTH_COMPACT

#define DICT_TF_WIDTH_COMPACT 1

Width of the COMPACT flag.

◆ DICT_TF_WIDTH_DATA_DIR

#define DICT_TF_WIDTH_DATA_DIR 1

If a table is created with the MYSQL option DATA DIRECTORY and innodb-file-per-table, an older engine will not be able to find that table.

This flag prevents older engines from attempting to open the table and allows InnoDB to update_create_info() accordingly.

◆ DICT_TF_WIDTH_SHARED_SPACE

#define DICT_TF_WIDTH_SHARED_SPACE 1

Width of the SHARED tablespace flag.

It is used to identify tables that exist inside a shared general tablespace. If a table is created with the TABLESPACE=tsname option, an older engine will not be able to find that table. This flag prevents older engines from attempting to open the table and allows InnoDB to quickly find the tablespace.

◆ DICT_TF_WIDTH_ZIP_SSIZE

#define DICT_TF_WIDTH_ZIP_SSIZE 4

Width of the ZIP_SSIZE flag.

◆ DICT_UNIQUE

#define DICT_UNIQUE 2

unique index

◆ DICT_VIRTUAL

#define DICT_VIRTUAL 128 /* Index on Virtual column */

◆ FK_MAX_CASCADE_DEL

#define FK_MAX_CASCADE_DEL 15

Similarly, when tables are chained together with foreign key constraints with on cascading delete/update clause, delete from parent table could result in recursive cascading calls.

This defines the maximum number of such cascading deletes/updates allowed. When exceeded, the delete from parent table will fail, and user has to drop excessive foreign constraint before proceeds.

◆ MAX_KEY_LENGTH_BITS

#define MAX_KEY_LENGTH_BITS 12

◆ ZIP_PAD_INCR

#define ZIP_PAD_INCR (128)

Amount by which padding is increased.

◆ ZIP_PAD_ROUND_LEN

#define ZIP_PAD_ROUND_LEN (128)

PADDING HEURISTIC BASED ON LINEAR INCREASE OF PADDING TO AVOID COMPRESSION FAILURES (Note: this is relevant only for compressed indexes) GOAL: Avoid compression failures by maintaining information about the compressibility of data.

If data is not very compressible then leave some extra space 'padding' in the uncompressed page making it more likely that compression of less than fully packed uncompressed page will succeed.

This padding heuristic works by increasing the pad linearly until the desired failure rate is reached. A "round" is a fixed number of compression operations. After each round, the compression failure rate for that round is computed. If the failure rate is too high, then padding is incremented by a fixed value, otherwise it's left intact. If the compression failure is lower than the desired rate for a fixed number of consecutive rounds, then the padding is decreased by a fixed value. This is done to prevent overshooting the padding value, and to accommodate the possible change in data compressibility. Number of zip ops in one round.

◆ ZIP_PAD_SUCCESSFUL_ROUND_LIMIT

#define ZIP_PAD_SUCCESSFUL_ROUND_LIMIT (5)

Number of successful rounds after which the padding is decreased.

Typedef Documentation

◆ corrupted_ids_t

typedef std::vector<index_id_t, ut_allocator<index_id_t> > corrupted_ids_t

◆ dict_foreign_set

typedef std::set<dict_foreign_t *, dict_foreign_compare, ut_allocator<dict_foreign_t *> > dict_foreign_set

◆ dict_s_col_list

typedef std::list<dict_s_col_t, ut_allocator<dict_s_col_t> > dict_s_col_list

list to put stored column for dict_table_t

◆ dict_v_idx_list

typedef std::list<dict_v_idx_t, ut_allocator<dict_v_idx_t> > dict_v_idx_list

Index list to put in dict_v_col_t.

◆ dict_vcol_set

typedef std::set<dict_v_col_t *, std::less<dict_v_col_t *>, ut_allocator<dict_v_col_t *> > dict_vcol_set

Set to store the virtual columns which are affected by Foreign key constraint.

◆ table_lock_list_t

typedef ut_list_base<lock_t, ut_list_node<lock_t> lock_table_t::*> table_lock_list_t

List of locks that different transactions have acquired on a table.

This list has a list node that is embedded in a nested union/structure. We have to generate a specific template for it.

◆ temp_prebuilt_vec

typedef std::vector<row_prebuilt_t *> temp_prebuilt_vec

A vector to collect prebuilt from different readers working on the same temp table.

Enumeration Type Documentation

◆ online_index_status

enum online_index_status

The status of online index creation.

Enumerator
ONLINE_INDEX_COMPLETE	the index is complete and ready for access
ONLINE_INDEX_CREATION	the index is being created, online (allowing concurrent modifications)
ONLINE_INDEX_ABORTED	secondary index creation was aborted and the index should be dropped as soon as index->table->n_ref_count reaches 0, or online table rebuild was aborted and the clustered index of the original table should soon be restored to ONLINE_INDEX_COMPLETE
ONLINE_INDEX_ABORTED_DROPPED	the online index creation was aborted, the index was dropped from the data dictionary and the tablespace, and it should be dropped from the data dictionary cache as soon as index->table->n_ref_count reaches 0.

◆ persistent_type_t

enum persistent_type_t

Persistent dynamic metadata type, there should be 1 to 1 relationship between the metadata and the type.

Please keep them in order so that we can iterate over it

Enumerator
PM_SMALLEST_TYPE	The smallest type, which should be 1 less than the first true type.
PM_INDEX_CORRUPTED	Persistent Metadata type for corrupted indexes.
PM_TABLE_AUTO_INC	Persistent Metadata type for autoinc counter.
PM_BIGGEST_TYPE	The biggest type, which should be 1 bigger than the last true type.

◆ table_dirty_status

enum table_dirty_status

The dirty status of tables, used to indicate if a table has some dynamic metadata changed to be written back.

Enumerator

METADATA_DIRTY

Some persistent metadata is now dirty in memory, need to be written back to DDTableBuffer table and(or directly to) DD table.

There could be some exceptions, when it's marked as dirty, but the metadata has already been written back to DDTableBuffer. For example, if a corrupted index is found and marked as corrupted, then it gets dropped. At this time, the dirty_status is still of this dirty value. Also a concurrent checkpoint make this bit out-of-date for other working threads, which still think the status is dirty and write-back is necessary. There could be either one row or no row for this table in DDTableBuffer table

METADATA_BUFFERED

Some persistent metadata is buffered in DDTableBuffer table, need to be written back to DD table.

There is must be one row in DDTableBuffer table for this table

METADATA_CLEAN

All persistent metadata are up to date.

There is no row for this table in DDTableBuffer table

Function Documentation

◆ dict_foreign_free()

void dict_foreign_free ( dict_foreign_t * foreign )

inline

Frees a foreign key struct.

in, own: foreign key struct

Parameters

foreign in, own: foreign key struct

◆ dict_foreign_set_validate() [1/2]

bool dict_foreign_set_validate ( const dict_foreign_set & fk_set )

Validate the search order in the foreign key set.

Parameters

[in] fk_set the foreign key set to be validated

Returns: true if search order is fine in the set, false otherwise.

◆ dict_foreign_set_validate() [2/2]

bool dict_foreign_set_validate ( const dict_table_t & table )

Validate the search order in the foreign key sets of the table (foreign_set and referenced_set).

Parameters

[in] table table whose foreign key sets are to be validated

Returns: true if foreign key sets are fine, false otherwise.

◆ dict_index_zip_pad_mutex_create_lazy()

void dict_index_zip_pad_mutex_create_lazy ( dict_index_t * index )

inline

Request a lazy creation of dict_index_t::zip_pad::mutex.

This function is only called from either single threaded environment or from a thread that has not shared the table object with other threads.

Parameters

[in,out] index index whose zip_pad mutex is to be created

◆ dict_index_zip_pad_mutex_destroy()

void dict_index_zip_pad_mutex_destroy ( dict_index_t * index )

inline

Destroy the zip_pad_mutex of the given index.

This function is only called from either single threaded environment or from a thread that has not shared the table object with other threads.

Parameters

[in,out] index index whose stats latch to destroy

◆ dict_index_zip_pad_unlock()

void dict_index_zip_pad_unlock ( dict_index_t * index )

inline

Release the zip_pad_mutex of a given index.

Parameters

[in,out] index index whose zip_pad_mutex is to be released

◆ dict_mem_create_temporary_tablename()

char* dict_mem_create_temporary_tablename	(	mem_heap_t *	heap,
		const char *	dbtab,
		table_id_t	id
	)

Create a temporary tablename like "#sql-ibtid-inc" where tid = the Table ID inc = a randomly initialized number that is incremented for each file The table ID is a 64 bit integer, can use up to 20 digits, and is initialized at bootstrap.

The second number is 32 bits, can use up to 10 digits, and is initialized at startup to a randomly distributed number. It is hoped that the combination of these two numbers will provide a reasonably unique temporary file name.

Parameters

[in]	heap	A memory heap
[in]	dbtab	Table name in the form database/table name
[in]	id	Table id

Returns: A unique temporary tablename suitable for InnoDB use

◆ dict_mem_fill_index_struct()

UNIV_INLINE void dict_mem_fill_index_struct	(	dict_index_t *	index,
		mem_heap_t *	heap,
		const char *	table_name,
		const char *	index_name,
		ulint	space,
		ulint	type,
		ulint	n_fields
	)

This function poplulates a dict_index_t index memory structure with supplied information.

Parameters

[out]	index	index to be filled
[in]	heap	memory heap
[in]	table_name	table name
[in]	index_name	index name
[in]	space	space where the index tree is placed, the clustered type ignored if the index is of the clustered type
[in]	type	DICT_UNIQUE, DICT_CLUSTERED, ... ORed
[in]	n_fields	number of fields

◆ dict_mem_foreign_create()

dict_foreign_t* dict_mem_foreign_create ( void )

Creates and initializes a foreign constraint memory object.

Returns: own: foreign constraint struct

◆ dict_mem_foreign_fill_vcol_set()

void dict_mem_foreign_fill_vcol_set ( dict_foreign_t * foreign )

Fills the dependent virtual columns in a set.

Reason for being dependent are 1) FK can be present on base column of virtual columns 2) FK can be present on column which is a part of virtual index

Parameters

[in,out] foreign foreign key information.

FK can be present on base columns of virtual columns.

FK can be present on the columns which can be a part of virtual index.

◆ dict_mem_foreign_table_name_lookup_set()

void dict_mem_foreign_table_name_lookup_set	(	dict_foreign_t *	foreign,
		ibool	do_alloc
	)

Sets the foreign_table_name_lookup pointer based on the value of lower_case_table_names.

If that is 0 or 1, foreign_table_name_lookup will point to foreign_table_name. If 2, then another string is allocated from the heap and set to lower case. in: is an alloc needed

If that is 0 or 1, foreign_table_name_lookup will point to foreign_table_name. If 2, then another string is allocated from foreign->heap and set to lower case.

◆ dict_mem_index_free()

void dict_mem_index_free ( dict_index_t * index )

Frees an index memory object.

in: index

◆ dict_mem_init()

void dict_mem_init ( void )

Initialize dict memory variables.

◆ dict_mem_referenced_table_name_lookup_set()

void dict_mem_referenced_table_name_lookup_set	(	dict_foreign_t *	foreign,
		ibool	do_alloc
	)

Sets the referenced_table_name_lookup pointer based on the value of lower_case_table_names.

If that is 0 or 1, referenced_table_name_lookup will point to referenced_table_name. If 2, then another string is allocated from the heap and set to lower case. in: is an alloc needed

If that is 0 or 1, referenced_table_name_lookup will point to referenced_table_name. If 2, then another string is allocated from foreign->heap and set to lower case.

◆ dict_mem_table_add_s_col()

void dict_mem_table_add_s_col	(	dict_table_t *	table,
		ulint	num_base
	)

Adds a stored column definition to a table.

Parameters

[in,out]	table	table
[in]	num_base	number of base columns.
[in]	table	table
[in]	num_base	number of base columns.

◆ dict_mem_table_add_v_col()

dict_v_col_t* dict_mem_table_add_v_col	(	dict_table_t *	table,
		mem_heap_t *	heap,
		const char *	name,
		ulint	mtype,
		ulint	prtype,
		ulint	len,
		ulint	pos,
		ulint	num_base
	)

Adds a virtual column definition to a table.

Parameters

[in,out]	table	table
[in]	heap	temporary memory heap, or NULL. It is used to store name when we have not finished adding all columns. When all columns are added, the whole name will copy to memory from table->heap
[in]	name	column name
[in]	mtype	main datatype
[in]	prtype	precise type
[in]	len	length
[in]	pos	position in a table
[in]	num_base	number of base columns

Returns: the virtual column definition

Parameters

[in,out]	table	table
[in,out]	heap	temporary memory heap, or NULL. It is used to store name when we have not finished adding all columns. When all columns are added, the whole name will copy to memory from table->heap
[in]	name	column name
[in]	mtype	main datatype
[in]	prtype	precise type
[in]	len	length
[in]	pos	position in a table
[in]	num_base	number of base columns

Returns: the virtual column definition

◆ dict_mem_table_col_rename()

void dict_mem_table_col_rename	(	dict_table_t *	table,
		ulint	nth_col,
		const char *	from,
		const char *	to,
		bool	is_virtual
	)

Renames a column of a table in the data dictionary cache.

in: if this is a virtual column

Parameters

table	in/out: table
nth_col	in: column index
from	in: old column name
to	in: new column name

◆ dict_mem_table_fill_foreign_vcol_set()

void dict_mem_table_fill_foreign_vcol_set ( dict_table_t * table )

Fill virtual columns set in each fk constraint present in the table.

Parameters

[in,out] table innodb table object.

◆ dict_mem_table_free_foreign_vcol_set()

void dict_mem_table_free_foreign_vcol_set ( dict_table_t * table )

Free the vcol_set from all foreign key constraint on the table.

Parameters

[in,out] table innodb table object.

◆ dict_table_autoinc_create_lazy()

void dict_table_autoinc_create_lazy ( dict_table_t * table )

inline

Request for lazy creation of the autoinc latch of a given table.

This function is only called from either single threaded environment or from a thread that has not shared the table object with other threads.

Parameters

[in,out] table table whose autoinc latch is to be created.

◆ dict_table_autoinc_destroy()

void dict_table_autoinc_destroy ( dict_table_t * table )

inline

Destroy the autoinc latch of the given table.

This function is only called from either single threaded environment or from a thread that has not shared the table object with other threads.

Parameters

[in,out] table table whose stats latch to destroy

◆ dict_table_autoinc_own()

bool dict_table_autoinc_own ( const dict_table_t * table )

inline

Check if the current thread owns the autoinc_mutex of a given table.

Parameters

[in] table the autoinc_mutex belongs to this table

Returns: true, if the current thread owns the autoinc_mutex, false otherwise.

◆ dict_table_mutex_create_lazy()

void dict_table_mutex_create_lazy ( dict_table_t * table )

inline

Request for lazy creation of the mutex of a given table.

This function is only called from either single threaded environment or from a thread that has not shared the table object with other threads.

Parameters

[in,out] table table whose mutex is to be created

◆ dict_table_mutex_destroy()

void dict_table_mutex_destroy ( dict_table_t * table )

inline

Destroy the mutex of a given table.

This function is only called from either single threaded environment or from a thread that has not shared the table object with other threads.

Parameters

[in,out] table table whose mutex is to be created

◆ lock_table_lock_list_init()

void lock_table_lock_list_init ( table_lock_list_t * locks )

Initialise the table lock list.

List to initialise

◆ operator<<() [1/4]

std::ostream& operator<<	(	std::ostream &	out,
		const dict_foreign_set &	fk_set
	)

◆ operator<<() [2/4]

std::ostream& operator<<	(	std::ostream &	out,
		const dict_foreign_t &	foreign
	)

◆ operator<<() [3/4]

std::ostream& operator<<	(	std::ostream &	s,
		const id_name_t &	id_name
	)

Display an identifier.

Parameters

[in,out]	s	output stream
[in]	id_name	SQL identifier (other than table name)

Returns: the output stream

◆ operator<<() [4/4]

std::ostream& operator<<	(	std::ostream &	s,
		const table_name_t &	table_name
	)

Display a table name.

Parameters

[in,out]	s	output stream
[in]	table_name	table name

Returns: the output stream

Variable Documentation

◆ innobase_index_reserve_name

const char innobase_index_reserve_name[] = "GEN_CLUST_INDEX"

"GEN_CLUST_INDEX" is the name reserved for InnoDB default system clustered index when there is no primary key.

◆ zip_failure_threshold_pct

ulong zip_failure_threshold_pct

Percentage of compression failures that are allowed in a single round.

◆ zip_pad_max

ulong zip_pad_max

Maximum percentage of a page that can be allowed as a pad to avoid compression failures.

Classes

Namespaces

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ BG_STAT_IN_PROGRESS

◆ BG_STAT_NONE

◆ BG_STAT_SHOULD_QUIT

◆ DICT_ANTELOPE_MAX_INDEX_COL_LEN

◆ DICT_CLUSTERED

◆ DICT_CORRUPT

◆ DICT_FK_MAX_RECURSIVE_LOAD

◆ DICT_FOREIGN_ON_DELETE_CASCADE

◆ DICT_FOREIGN_ON_DELETE_NO_ACTION

◆ DICT_FOREIGN_ON_DELETE_SET_NULL

◆ DICT_FOREIGN_ON_UPDATE_CASCADE

◆ DICT_FOREIGN_ON_UPDATE_NO_ACTION

◆ DICT_FOREIGN_ON_UPDATE_SET_NULL

◆ DICT_FTS

◆ DICT_IBUF

◆ DICT_INDEX_MAGIC_N

◆ DICT_INDEX_MERGE_THRESHOLD_DEFAULT

◆ DICT_IT_BITS

◆ DICT_MAX_FIELD_LEN_BY_FORMAT

◆ DICT_MAX_FIELD_LEN_BY_FORMAT_FLAG

◆ DICT_MAX_FIXED_COL_LEN

◆ DICT_MULTI_VALUE

◆ DICT_N_COLS_COMPACT

◆ DICT_SDI

◆ DICT_SPATIAL

◆ DICT_STATS_AUTO_RECALC_OFF

◆ DICT_STATS_AUTO_RECALC_ON

◆ DICT_STATS_PERSISTENT_OFF

◆ DICT_STATS_PERSISTENT_ON

◆ DICT_TABLE_MAGIC_N

◆ DICT_TF2_AUX

◆ DICT_TF2_BIT_MASK

◆ DICT_TF2_BITS

◆ DICT_TF2_DISCARDED

◆ DICT_TF2_ENCRYPTION_FILE_PER_TABLE

◆ DICT_TF2_FLAG_IS_SET

◆ DICT_TF2_FLAG_SET

◆ DICT_TF2_FLAG_UNSET

◆ DICT_TF2_FTS

◆ DICT_TF2_FTS_ADD_DOC_ID

◆ DICT_TF2_FTS_HAS_DOC_ID

◆ DICT_TF2_INTRINSIC

◆ DICT_TF2_RESURRECT_PREPARED

◆ DICT_TF2_TEMPORARY

◆ DICT_TF2_UNUSED_BIT_MASK

◆ DICT_TF2_USE_FILE_PER_TABLE

◆ DICT_TF_BIT_MASK

◆ DICT_TF_BITS

◆ DICT_TF_COMPACT

◆ DICT_TF_GET_COMPACT

◆ DICT_TF_GET_UNUSED

◆ DICT_TF_GET_ZIP_SSIZE

◆ DICT_TF_HAS_ATOMIC_BLOBS

◆ DICT_TF_HAS_DATA_DIR

◆ DICT_TF_HAS_SHARED_SPACE

◆ DICT_TF_MASK_ATOMIC_BLOBS

◆ DICT_TF_MASK_COMPACT

◆ DICT_TF_MASK_DATA_DIR

◆ DICT_TF_MASK_SHARED_SPACE

◆ DICT_TF_MASK_ZIP_SSIZE

◆ DICT_TF_POS_ATOMIC_BLOBS

◆ DICT_TF_POS_COMPACT

◆ DICT_TF_POS_DATA_DIR

◆ DICT_TF_POS_SHARED_SPACE

◆ DICT_TF_POS_UNUSED

◆ DICT_TF_POS_ZIP_SSIZE

◆ DICT_TF_REDUNDANT

◆ DICT_TF_WIDTH_ATOMIC_BLOBS

◆ DICT_TF_WIDTH_COMPACT

◆ DICT_TF_WIDTH_DATA_DIR

◆ DICT_TF_WIDTH_SHARED_SPACE