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
std::string	get_compare_string () const
bool	is_integer () const
bool	can_be_stored_externally () const
	Based on the column data type check if it can be stored externally. More...
std::string	to_string () const
	Get a string representation of Column_meta object. More...
std::ostream &	print (std::ostream &out) const
	Print this object into the given output stream. More...
std::string	get_type_string () const
	Get the data type of the column as a string. More...

Public Attributes
bool	m_is_part_of_sk {false}
	true if this column is part of secondary index. More...
enum_field_types	m_type
	Field type. More...
bool	m_is_nullable {false}
	If column could be NULL. More...
bool	m_is_pk {false}
	true if column belongs to primary index (key or non-key) More...
bool	m_is_key {false}
	true if column is a key for primary or secondary index. More...
bool	m_is_desc_key {false}
	If the key is descending. More...
bool	m_is_prefix_key {false}
	If the key is prefix of the column. More...
bool	m_is_fixed_len {false}
	If it is fixed length type. More...
Compare	m_compare
	If it is integer type. More...
bool	m_is_unsigned {false}
	If it is unsigned integer type. More...
bool	m_fixed_len_if_set_in_row {false}
	Check the row header to find out if it is fixed length. More...
bool	m_is_single_byte_len {false}
	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_field_index
	Position of column in table. 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...
std::string	m_field_name
	Field name. 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

can_be_stored_externally()

bool Column_meta::can_be_stored_externally ( ) const

inline

Based on the column data type check if it can be stored externally.

Returns

true if the column data can be stored externally

false if the column data cannot be stored externally

get_compare_string()

std::string Column_meta::get_compare_string ( ) const

inline

get_type_string()

std::string Column_meta::get_type_string ( ) const

inline

Get the data type of the column as a string.

Returns

data type of the column as a string.

is_integer()

bool Column_meta::is_integer ( ) const

inline

Returns

true if integer type.

print()

std::ostream & Column_meta::print ( std::ostream &  out ) const

inline

Print this object into the given output stream.

Parameters

[in]

out

output stream into which object will be printed

Returns

given output stream.

to_string()

std::string Column_meta::to_string ( ) const

inline

Get a string representation of Column_meta object.

Useful only for debugging purposes.

See also

Column_meta

Returns

string representation of this object.

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_field_index

uint16_t Column_meta::m_field_index

Position of column in table.

Refer to Field::field_index()

m_field_name

std::string Column_meta::m_field_name

Field name.

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 {false}

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 {false}

If the key is descending.

m_is_fixed_len

bool Column_meta::m_is_fixed_len {false}

If it is fixed length type.

m_is_key

bool Column_meta::m_is_key {false}

true if column is a key for primary or secondary index.

m_is_nullable

bool Column_meta::m_is_nullable {false}

If column could be NULL.

m_is_part_of_sk

bool Column_meta::m_is_part_of_sk {false}

true if this column is part of secondary index.

m_is_pk

bool Column_meta::m_is_pk {false}

true if column belongs to primary index (key or non-key)

m_is_prefix_key

bool Column_meta::m_is_prefix_key {false}

If the key is prefix of the column.

m_is_single_byte_len

bool Column_meta::m_is_single_byte_len {false}

If character column length can be kept in one byte.

m_is_unsigned

bool Column_meta::m_is_unsigned {false}

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

enum_field_types Column_meta::m_type

Field type.

(enum_field_types)

---

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

• include/mysql/components/services/bulk_data_service.h