MySQL 8.3.0
Source Code Documentation
Column_meta Struct Reference

Column metadata information. More...

#include <bulk_data_service.h>

Public Types

enum class  Compare { INTEGER_SIGNED , INTEGER_UNSIGNED , BINARY , MYSQL }
 Data comparison method. More...
 

Public Member Functions

bool is_integer () const
 

Public Attributes

int m_type
 Field type. More...
 
bool m_is_nullable
 If column could be NULL. More...
 
bool m_is_key
 If column is part of primary key. More...
 
bool m_is_desc_key
 If the key is descending. More...
 
bool m_is_prefix_key
 If the key is prefix of the column. More...
 
bool m_is_fixed_len
 If it is fixed length type. More...
 
Compare m_compare
 If it is integer type. More...
 
bool m_is_unsigned
 If it is unsigned integer type. More...
 
bool m_fixed_len_if_set_in_row
 Check the row header to find out if it is fixed length. More...
 
bool m_is_single_byte_len
 If character column length can be kept in one byte. More...
 
uint16_t m_fixed_len
 The length of column data if fixed. More...
 
uint16_t m_max_len
 Maximum length of data in bytes. More...
 
uint16_t m_index
 Index of column in row. More...
 
uint16_t m_null_byte
 Byte index in NULL bitmap. More...
 
uint16_t m_null_bit
 BIT number in NULL bitmap. More...
 
const void * m_charset
 Character set for char & varchar columns. More...
 

Detailed Description

Column metadata information.

Member Enumeration Documentation

◆ Compare

enum class Column_meta::Compare
strong

Data comparison method.

Enumerator
INTEGER_SIGNED 
INTEGER_UNSIGNED 
BINARY 
MYSQL 

Member Function Documentation

◆ is_integer()

bool Column_meta::is_integer ( ) const
inline
Returns
true if integer type.

Member Data Documentation

◆ m_charset

const void* Column_meta::m_charset

Character set for char & varchar columns.

◆ m_compare

Compare Column_meta::m_compare

If it is integer type.

◆ m_fixed_len

uint16_t Column_meta::m_fixed_len

The length of column data if fixed.

◆ m_fixed_len_if_set_in_row

bool Column_meta::m_fixed_len_if_set_in_row

Check the row header to find out if it is fixed length.

For character data type the row header indicates fixed length.

◆ m_index

uint16_t Column_meta::m_index

Index of column in row.

◆ m_is_desc_key

bool Column_meta::m_is_desc_key

If the key is descending.

◆ m_is_fixed_len

bool Column_meta::m_is_fixed_len

If it is fixed length type.

◆ m_is_key

bool Column_meta::m_is_key

If column is part of primary key.

◆ m_is_nullable

bool Column_meta::m_is_nullable

If column could be NULL.

◆ m_is_prefix_key

bool Column_meta::m_is_prefix_key

If the key is prefix of the column.

◆ m_is_single_byte_len

bool Column_meta::m_is_single_byte_len

If character column length can be kept in one byte.

◆ m_is_unsigned

bool Column_meta::m_is_unsigned

If it is unsigned integer type.

◆ m_max_len

uint16_t Column_meta::m_max_len

Maximum length of data in bytes.

◆ m_null_bit

uint16_t Column_meta::m_null_bit

BIT number in NULL bitmap.

◆ m_null_byte

uint16_t Column_meta::m_null_byte

Byte index in NULL bitmap.

◆ m_type

int Column_meta::m_type

Field type.


The documentation for this struct was generated from the following file: