MySQL 8.0.32
Source Code Documentation
InnoDB Tablespace Flag Constants

Functions

constexpr uint32_t FSP_FLAGS_GET_POST_ANTELOPE (uint32_t flags)
 Return the value of the POST_ANTELOPE field. More...
 
constexpr uint32_t FSP_FLAGS_GET_ZIP_SSIZE (uint32_t flags)
 Return the value of the ZIP_SSIZE field. More...
 
constexpr uint32_t FSP_FLAGS_HAS_ATOMIC_BLOBS (uint32_t flags)
 Return the value of the ATOMIC_BLOBS field. More...
 
constexpr uint32_t FSP_FLAGS_GET_PAGE_SSIZE (uint32_t flags)
 Return the value of the PAGE_SSIZE field. More...
 
constexpr uint32_t FSP_FLAGS_HAS_DATA_DIR (uint32_t flags)
 Return the value of the DATA_DIR field. More...
 
constexpr uint32_t FSP_FLAGS_GET_SHARED (uint32_t flags)
 Return the contents of the SHARED field. More...
 
constexpr uint32_t FSP_FLAGS_GET_TEMPORARY (uint32_t flags)
 Return the contents of the TEMPORARY field. More...
 
constexpr uint32_t FSP_FLAGS_GET_ENCRYPTION (uint32_t flags)
 Return the contents of the ENCRYPTION field. More...
 
constexpr uint32_t FSP_FLAGS_HAS_SDI (uint32_t flags)
 Return the value of the SDI field. More...
 
constexpr uint32_t FSP_FLAGS_GET_UNUSED (uint32_t flags)
 Return the contents of the UNUSED bits. More...
 
constexpr bool FSP_FLAGS_ARE_NOT_SET (uint32_t flags)
 Return true if flags are not set. More...
 
constexpr void fsp_flags_set_encryption (uint32_t &flags)
 Set ENCRYPTION bit in tablespace flags. More...
 
constexpr void fsp_flags_unset_encryption (uint32_t &flags)
 Set ENCRYPTION bit in tablespace flags. More...
 
constexpr void fsp_flags_set_sdi (uint32_t &flags)
 Set SDI Index bit in tablespace flags. More...
 
constexpr void fsp_flags_unset_sdi (uint32_t &flags)
 Set SDI Index bit in tablespace flags. More...
 
constexpr uint32_t fsp_is_shared_tablespace (uint32_t flags)
 Use an alias in the code for FSP_FLAGS_GET_SHARED() More...
 

Variables

constexpr uint32_t FSP_FLAGS_WIDTH_POST_ANTELOPE = 1
 Width of the POST_ANTELOPE flag. More...
 
constexpr uint32_t FSP_FLAGS_WIDTH_ZIP_SSIZE = 4
 Number of flag bits used to indicate the tablespace zip page size. More...
 
constexpr uint32_t FSP_FLAGS_WIDTH_ATOMIC_BLOBS = 1
 Width of the ATOMIC_BLOBS flag. More...
 
constexpr uint32_t FSP_FLAGS_WIDTH_PAGE_SSIZE = 4
 Number of flag bits used to indicate the tablespace page size. More...
 
constexpr uint32_t FSP_FLAGS_WIDTH_DATA_DIR = 1
 Width of the DATA_DIR flag. More...
 
constexpr uint32_t FSP_FLAGS_WIDTH_SHARED = 1
 Width of the SHARED flag. More...
 
constexpr uint32_t FSP_FLAGS_WIDTH_TEMPORARY = 1
 Width of the TEMPORARY flag. More...
 
constexpr uint32_t FSP_FLAGS_WIDTH_ENCRYPTION = 1
 Width of the encryption flag. More...
 
constexpr uint32_t FSP_FLAGS_WIDTH_SDI = 1
 Width of the SDI flag. More...
 
constexpr uint32_t FSP_FLAGS_WIDTH
 Width of all the currently known tablespace flags. More...
 
constexpr uint32_t FSP_FLAGS_MASK = ~(~0U << FSP_FLAGS_WIDTH)
 A mask of all the known/used bits in tablespace flags. More...
 
constexpr uint32_t FSP_FLAGS_POS_POST_ANTELOPE = 0
 Zero relative shift position of the POST_ANTELOPE field. More...
 
constexpr uint32_t FSP_FLAGS_POS_ZIP_SSIZE
 Zero relative shift position of the ZIP_SSIZE field. More...
 
constexpr uint32_t FSP_FLAGS_POS_ATOMIC_BLOBS
 Zero relative shift position of the ATOMIC_BLOBS field. More...
 
constexpr uint32_t FSP_FLAGS_POS_PAGE_SSIZE
 Zero relative shift position of the PAGE_SSIZE field. More...
 
constexpr uint32_t FSP_FLAGS_POS_DATA_DIR
 Zero relative shift position of the start of the DATA_DIR bit. More...
 
constexpr uint32_t FSP_FLAGS_POS_SHARED
 Zero relative shift position of the start of the SHARED bit. More...
 
constexpr uint32_t FSP_FLAGS_POS_TEMPORARY
 Zero relative shift position of the start of the TEMPORARY bit. More...
 
constexpr uint32_t FSP_FLAGS_POS_ENCRYPTION
 Zero relative shift position of the start of the ENCRYPTION bit. More...
 
constexpr uint32_t FSP_FLAGS_POS_SDI
 Zero relative shift position of the start of the SDI bits. More...
 
constexpr uint32_t FSP_FLAGS_POS_UNUSED
 Zero relative shift position of the start of the UNUSED bits. More...
 
constexpr uint32_t FSP_FLAGS_MASK_POST_ANTELOPE
 Bit mask of the POST_ANTELOPE field. More...
 
constexpr uint32_t FSP_FLAGS_MASK_ZIP_SSIZE
 Bit mask of the ZIP_SSIZE field. More...
 
constexpr uint32_t FSP_FLAGS_MASK_ATOMIC_BLOBS
 Bit mask of the ATOMIC_BLOBS field. More...
 
constexpr uint32_t FSP_FLAGS_MASK_PAGE_SSIZE
 Bit mask of the PAGE_SSIZE field. More...
 
constexpr uint32_t FSP_FLAGS_MASK_DATA_DIR
 Bit mask of the DATA_DIR field. More...
 
constexpr uint32_t FSP_FLAGS_MASK_SHARED
 Bit mask of the SHARED field. More...
 
constexpr uint32_t FSP_FLAGS_MASK_TEMPORARY
 Bit mask of the TEMPORARY field. More...
 
constexpr uint32_t FSP_FLAGS_MASK_ENCRYPTION
 Bit mask of the ENCRYPTION field. More...
 
constexpr uint32_t FSP_FLAGS_MASK_SDI
 Bit mask of the SDI field. More...
 

Detailed Description

Function Documentation

◆ FSP_FLAGS_ARE_NOT_SET()

constexpr bool FSP_FLAGS_ARE_NOT_SET ( uint32_t  flags)
constexpr

Return true if flags are not set.

◆ FSP_FLAGS_GET_ENCRYPTION()

constexpr uint32_t FSP_FLAGS_GET_ENCRYPTION ( uint32_t  flags)
constexpr

Return the contents of the ENCRYPTION field.

◆ FSP_FLAGS_GET_PAGE_SSIZE()

constexpr uint32_t FSP_FLAGS_GET_PAGE_SSIZE ( uint32_t  flags)
constexpr

Return the value of the PAGE_SSIZE field.

◆ FSP_FLAGS_GET_POST_ANTELOPE()

constexpr uint32_t FSP_FLAGS_GET_POST_ANTELOPE ( uint32_t  flags)
constexpr

Return the value of the POST_ANTELOPE field.

◆ FSP_FLAGS_GET_SHARED()

constexpr uint32_t FSP_FLAGS_GET_SHARED ( uint32_t  flags)
constexpr

Return the contents of the SHARED field.

◆ FSP_FLAGS_GET_TEMPORARY()

constexpr uint32_t FSP_FLAGS_GET_TEMPORARY ( uint32_t  flags)
constexpr

Return the contents of the TEMPORARY field.

◆ FSP_FLAGS_GET_UNUSED()

constexpr uint32_t FSP_FLAGS_GET_UNUSED ( uint32_t  flags)
constexpr

Return the contents of the UNUSED bits.

◆ FSP_FLAGS_GET_ZIP_SSIZE()

constexpr uint32_t FSP_FLAGS_GET_ZIP_SSIZE ( uint32_t  flags)
constexpr

Return the value of the ZIP_SSIZE field.

◆ FSP_FLAGS_HAS_ATOMIC_BLOBS()

constexpr uint32_t FSP_FLAGS_HAS_ATOMIC_BLOBS ( uint32_t  flags)
constexpr

Return the value of the ATOMIC_BLOBS field.

◆ FSP_FLAGS_HAS_DATA_DIR()

constexpr uint32_t FSP_FLAGS_HAS_DATA_DIR ( uint32_t  flags)
constexpr

Return the value of the DATA_DIR field.

◆ FSP_FLAGS_HAS_SDI()

constexpr uint32_t FSP_FLAGS_HAS_SDI ( uint32_t  flags)
constexpr

Return the value of the SDI field.

◆ fsp_flags_set_encryption()

constexpr void fsp_flags_set_encryption ( uint32_t &  flags)
constexpr

Set ENCRYPTION bit in tablespace flags.

◆ fsp_flags_set_sdi()

constexpr void fsp_flags_set_sdi ( uint32_t &  flags)
constexpr

Set SDI Index bit in tablespace flags.

◆ fsp_flags_unset_encryption()

constexpr void fsp_flags_unset_encryption ( uint32_t &  flags)
constexpr

Set ENCRYPTION bit in tablespace flags.

◆ fsp_flags_unset_sdi()

constexpr void fsp_flags_unset_sdi ( uint32_t &  flags)
constexpr

Set SDI Index bit in tablespace flags.

◆ fsp_is_shared_tablespace()

constexpr uint32_t fsp_is_shared_tablespace ( uint32_t  flags)
constexpr

Use an alias in the code for FSP_FLAGS_GET_SHARED()

Variable Documentation

◆ FSP_FLAGS_MASK

constexpr uint32_t FSP_FLAGS_MASK = ~(~0U << FSP_FLAGS_WIDTH)
constexpr

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

◆ FSP_FLAGS_MASK_ATOMIC_BLOBS

constexpr uint32_t FSP_FLAGS_MASK_ATOMIC_BLOBS
constexpr
Initial value:
=
constexpr uint32_t FSP_FLAGS_WIDTH_ATOMIC_BLOBS
Width of the ATOMIC_BLOBS flag.
Definition: fsp0types.h:231
constexpr uint32_t FSP_FLAGS_POS_ATOMIC_BLOBS
Zero relative shift position of the ATOMIC_BLOBS field.
Definition: fsp0types.h:268
Definition: dtoa.cc:594

Bit mask of the ATOMIC_BLOBS field.

◆ FSP_FLAGS_MASK_DATA_DIR

constexpr uint32_t FSP_FLAGS_MASK_DATA_DIR
constexpr
Initial value:
=
constexpr uint32_t FSP_FLAGS_WIDTH_DATA_DIR
Width of the DATA_DIR flag.
Definition: fsp0types.h:236
constexpr uint32_t FSP_FLAGS_POS_DATA_DIR
Zero relative shift position of the start of the DATA_DIR bit.
Definition: fsp0types.h:274

Bit mask of the DATA_DIR field.

◆ FSP_FLAGS_MASK_ENCRYPTION

constexpr uint32_t FSP_FLAGS_MASK_ENCRYPTION
constexpr
Initial value:
=
constexpr uint32_t FSP_FLAGS_WIDTH_ENCRYPTION
Width of the encryption flag.
Definition: fsp0types.h:246
constexpr uint32_t FSP_FLAGS_POS_ENCRYPTION
Zero relative shift position of the start of the ENCRYPTION bit.
Definition: fsp0types.h:283

Bit mask of the ENCRYPTION field.

◆ FSP_FLAGS_MASK_PAGE_SSIZE

constexpr uint32_t FSP_FLAGS_MASK_PAGE_SSIZE
constexpr
Initial value:
=
constexpr uint32_t FSP_FLAGS_WIDTH_PAGE_SSIZE
Number of flag bits used to indicate the tablespace page size.
Definition: fsp0types.h:233
constexpr uint32_t FSP_FLAGS_POS_PAGE_SSIZE
Zero relative shift position of the PAGE_SSIZE field.
Definition: fsp0types.h:271

Bit mask of the PAGE_SSIZE field.

◆ FSP_FLAGS_MASK_POST_ANTELOPE

constexpr uint32_t FSP_FLAGS_MASK_POST_ANTELOPE
constexpr
Initial value:
=
constexpr uint32_t FSP_FLAGS_POS_POST_ANTELOPE
Zero relative shift position of the POST_ANTELOPE field.
Definition: fsp0types.h:263
constexpr uint32_t FSP_FLAGS_WIDTH_POST_ANTELOPE
Width of the POST_ANTELOPE flag.
Definition: fsp0types.h:225

Bit mask of the POST_ANTELOPE field.

◆ FSP_FLAGS_MASK_SDI

constexpr uint32_t FSP_FLAGS_MASK_SDI
constexpr
Initial value:
constexpr uint32_t FSP_FLAGS_WIDTH_SDI
Width of the SDI flag.
Definition: fsp0types.h:249
constexpr uint32_t FSP_FLAGS_POS_SDI
Zero relative shift position of the start of the SDI bits.
Definition: fsp0types.h:286

Bit mask of the SDI field.

◆ FSP_FLAGS_MASK_SHARED

constexpr uint32_t FSP_FLAGS_MASK_SHARED
constexpr
Initial value:
constexpr uint32_t FSP_FLAGS_POS_SHARED
Zero relative shift position of the start of the SHARED bit.
Definition: fsp0types.h:277
constexpr uint32_t FSP_FLAGS_WIDTH_SHARED
Width of the SHARED flag.
Definition: fsp0types.h:239

Bit mask of the SHARED field.

◆ FSP_FLAGS_MASK_TEMPORARY

constexpr uint32_t FSP_FLAGS_MASK_TEMPORARY
constexpr
Initial value:
=
constexpr uint32_t FSP_FLAGS_POS_TEMPORARY
Zero relative shift position of the start of the TEMPORARY bit.
Definition: fsp0types.h:280
constexpr uint32_t FSP_FLAGS_WIDTH_TEMPORARY
Width of the TEMPORARY flag.
Definition: fsp0types.h:243

Bit mask of the TEMPORARY field.

◆ FSP_FLAGS_MASK_ZIP_SSIZE

constexpr uint32_t FSP_FLAGS_MASK_ZIP_SSIZE
constexpr
Initial value:
=
constexpr uint32_t FSP_FLAGS_WIDTH_ZIP_SSIZE
Number of flag bits used to indicate the tablespace zip page size.
Definition: fsp0types.h:227
constexpr uint32_t FSP_FLAGS_POS_ZIP_SSIZE
Zero relative shift position of the ZIP_SSIZE field.
Definition: fsp0types.h:265

Bit mask of the ZIP_SSIZE field.

◆ FSP_FLAGS_POS_ATOMIC_BLOBS

constexpr uint32_t FSP_FLAGS_POS_ATOMIC_BLOBS
constexpr
Initial value:

Zero relative shift position of the ATOMIC_BLOBS field.

◆ FSP_FLAGS_POS_DATA_DIR

constexpr uint32_t FSP_FLAGS_POS_DATA_DIR
constexpr
Initial value:

Zero relative shift position of the start of the DATA_DIR bit.

◆ FSP_FLAGS_POS_ENCRYPTION

constexpr uint32_t FSP_FLAGS_POS_ENCRYPTION
constexpr
Initial value:

Zero relative shift position of the start of the ENCRYPTION bit.

◆ FSP_FLAGS_POS_PAGE_SSIZE

constexpr uint32_t FSP_FLAGS_POS_PAGE_SSIZE
constexpr
Initial value:

Zero relative shift position of the PAGE_SSIZE field.

◆ FSP_FLAGS_POS_POST_ANTELOPE

constexpr uint32_t FSP_FLAGS_POS_POST_ANTELOPE = 0
constexpr

Zero relative shift position of the POST_ANTELOPE field.

◆ FSP_FLAGS_POS_SDI

constexpr uint32_t FSP_FLAGS_POS_SDI
constexpr
Initial value:

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

◆ FSP_FLAGS_POS_SHARED

constexpr uint32_t FSP_FLAGS_POS_SHARED
constexpr
Initial value:

Zero relative shift position of the start of the SHARED bit.

◆ FSP_FLAGS_POS_TEMPORARY

constexpr uint32_t FSP_FLAGS_POS_TEMPORARY
constexpr
Initial value:

Zero relative shift position of the start of the TEMPORARY bit.

◆ FSP_FLAGS_POS_UNUSED

constexpr uint32_t FSP_FLAGS_POS_UNUSED
constexpr
Initial value:

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

◆ FSP_FLAGS_POS_ZIP_SSIZE

constexpr uint32_t FSP_FLAGS_POS_ZIP_SSIZE
constexpr
Initial value:

Zero relative shift position of the ZIP_SSIZE field.

◆ FSP_FLAGS_WIDTH

◆ FSP_FLAGS_WIDTH_ATOMIC_BLOBS

constexpr uint32_t FSP_FLAGS_WIDTH_ATOMIC_BLOBS = 1
constexpr

Width of the ATOMIC_BLOBS flag.

The ability to break up a long column into an in-record prefix and an externally stored part is available to ROW_FORMAT=REDUNDANT and ROW_FORMAT=COMPACT.

◆ FSP_FLAGS_WIDTH_DATA_DIR

constexpr uint32_t FSP_FLAGS_WIDTH_DATA_DIR = 1
constexpr

Width of the DATA_DIR flag.

This flag indicates that the tablespace is found in a remote location, not the default data directory.

◆ FSP_FLAGS_WIDTH_ENCRYPTION

constexpr uint32_t FSP_FLAGS_WIDTH_ENCRYPTION = 1
constexpr

Width of the encryption flag.

This flag indicates that the tablespace is a tablespace with encryption.

◆ FSP_FLAGS_WIDTH_PAGE_SSIZE

constexpr uint32_t FSP_FLAGS_WIDTH_PAGE_SSIZE = 4
constexpr

Number of flag bits used to indicate the tablespace page size.

◆ FSP_FLAGS_WIDTH_POST_ANTELOPE

constexpr uint32_t FSP_FLAGS_WIDTH_POST_ANTELOPE = 1
constexpr

Width of the POST_ANTELOPE flag.

◆ FSP_FLAGS_WIDTH_SDI

constexpr uint32_t FSP_FLAGS_WIDTH_SDI = 1
constexpr

Width of the SDI flag.

This flag indicates the presence of tablespace dictionary.

◆ FSP_FLAGS_WIDTH_SHARED

constexpr uint32_t FSP_FLAGS_WIDTH_SHARED = 1
constexpr

Width of the SHARED flag.

This flag indicates that the tablespace was created with CREATE TABLESPACE and can be shared by multiple tables.

◆ FSP_FLAGS_WIDTH_TEMPORARY

constexpr uint32_t FSP_FLAGS_WIDTH_TEMPORARY = 1
constexpr

Width of the TEMPORARY flag.

This flag indicates that the tablespace is a temporary tablespace and everything in it is temporary, meaning that it is for a single client and should be deleted upon startup if it exists.

◆ FSP_FLAGS_WIDTH_ZIP_SSIZE

constexpr uint32_t FSP_FLAGS_WIDTH_ZIP_SSIZE = 4
constexpr

Number of flag bits used to indicate the tablespace zip page size.