MySQL  8.0.22
Source Code Documentation
big_rec_t Struct Reference

Storage format for overflow data in a big record, that is, a clustered index record which needs external storage of data fields. More...

#include <data0data.h>

Public Member Functions

 big_rec_t (const ulint max)
 Constructor. More...
 
void append (const big_rec_field_t &field)
 Append one big_rec_field_t object to the end of array of fields. More...
 
std::ostream & print (std::ostream &out) const
 Print the current object into the given output stream. More...
 

Static Public Member Functions

static big_rec_talloc (mem_heap_t *heap, ulint n_fld)
 Allocate a big_rec_t object in the given memory heap, and for storing n_fld number of fields. More...
 

Public Attributes

mem_heap_theap
 memory heap from which allocated More...
 
const ulint capacity
 fields array size More...
 
ulint n_fields
 number of stored fields More...
 
big_rec_field_tfields
 stored fields More...
 

Detailed Description

Storage format for overflow data in a big record, that is, a clustered index record which needs external storage of data fields.

Constructor & Destructor Documentation

◆ big_rec_t()

big_rec_t::big_rec_t ( const ulint  max)
inlineexplicit

Constructor.

Parameters
[in]maxthe capacity of the array of fields.

Member Function Documentation

◆ alloc()

big_rec_t * big_rec_t::alloc ( mem_heap_t heap,
ulint  n_fld 
)
static

Allocate a big_rec_t object in the given memory heap, and for storing n_fld number of fields.

Parameters
[in]heapmemory heap in which this object is allocated
[in]n_fldmaximum number of fields that can be stored in this object
Returns
the allocated object

◆ append()

void big_rec_t::append ( const big_rec_field_t field)
inline

Append one big_rec_field_t object to the end of array of fields.

◆ print()

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

Print the current object into the given output stream.

Parameters
[in]outthe output stream.
Returns
the ouput stream.

Member Data Documentation

◆ capacity

const ulint big_rec_t::capacity

fields array size

◆ fields

big_rec_field_t* big_rec_t::fields

stored fields

◆ heap

mem_heap_t* big_rec_t::heap

memory heap from which allocated

◆ n_fields

ulint big_rec_t::n_fields

number of stored fields


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