MySQL 9.1.0
Source Code Documentation
Column_text Struct Reference

#include <bulk_data_service.h>

Public Member Functions

void set_null ()
 Mark the column to be null, by setting length to a special value. More...
 
bool is_null () const
 Check if the column is null, by checking special value for length. More...
 
bool is_ext () const
 Check if the column data is stored externally. More...
 
bool is_ext_relaxed () const
 Check if the column data is stored externally. More...
 
void set_ext ()
 Mark that the column data has been stored externally. More...
 
void init ()
 Initialize the members. More...
 
std::ostream & print (std::ostream &out) const
 Print this object into the given output stream. More...
 
std::string to_string () const
 

Public Attributes

const char * m_data_ptr {}
 Column data. More...
 
size_t m_data_len {}
 Column data length. More...
 

Private Attributes

bool m_is_ext {false}
 If true, the column data is stored externally. More...
 

Member Function Documentation

◆ init()

void Column_text::init ( )
inline

Initialize the members.

◆ is_ext()

bool Column_text::is_ext ( ) const
inline

Check if the column data is stored externally.

If the data is stored externally, then the data length (m_data_len) would be equal to the BLOB_REF_SIZE and the column data (m_data_ptr) will contain the lob reference.

Returns
true if data is stored externally, false otherwise.

◆ is_ext_relaxed()

bool Column_text::is_ext_relaxed ( ) const
inline

Check if the column data is stored externally.

It is called relaxed, because the column length might not be equal to BLOB_REF_SIZE. Only to be used while the blob is being processed by the CSV parser.

Returns
true if data is stored externally, false otherwise.

◆ is_null()

bool Column_text::is_null ( ) const
inline

Check if the column is null, by checking special value for length.

Returns
true if the column is null, false otherwise.

◆ print()

std::ostream & Column_text::print ( std::ostream &  out) const
inline

Print this object into the given output stream.

Parameters
[in]outoutput stream into which this object will be printed.
Returns
given output stream

◆ set_ext()

void Column_text::set_ext ( )
inline

Mark that the column data has been stored externally.

◆ set_null()

void Column_text::set_null ( )
inline

Mark the column to be null, by setting length to a special value.

This is only used for columns whose state is maintained across chunks (aka fragmented columns).

◆ to_string()

std::string Column_text::to_string ( ) const
inline

Member Data Documentation

◆ m_data_len

size_t Column_text::m_data_len {}

Column data length.

◆ m_data_ptr

const char* Column_text::m_data_ptr {}

Column data.

◆ m_is_ext

bool Column_text::m_is_ext {false}
private

If true, the column data is stored externally.


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