Record manager. More...

#include "rem0rec.h"
#include "rem0lrec.h"
#include <sys/types.h>
#include "data0data.h"
#include "fts0fts.h"
#include "gis0geo.h"
#include "mach0data.h"
#include "mtr0log.h"
#include "mtr0mtr.h"
#include "page0page.h"
#include "trx0sys.h"
#include "my_dbug.h"

Functions
static bool	rec_validate_old (const rec_t *rec)
	Validates the consistency of an old-style physical record. More...

ulint	rec_get_n_extern_new (const rec_t rec, const dict_index_t index, ulint n)
	Determine how many of the first n columns in a compact physical record are stored externally. More...

bool	is_store_version (const dict_index_t *index, size_t n_tuple_fields)
	For a given clustered index, version is to be stored on physical record. More...

static size_t	get_nullable_fields_for_rec (const dict_index_t *index, const size_t n_fields, uint8_t &rec_version)

static ulint	rec_get_converted_size_comp_prefix_low (const dict_index_t index, const dfield_t fields, ulint n_fields, const dtuple_t v_entry, ulint extra, ulint *status, bool temp, uint8_t rec_version)
	Determines the size of a data tuple prefix in ROW_FORMAT=COMPACT. More...

ulint	rec_get_converted_size_comp_prefix (const dict_index_t index, const dfield_t fields, ulint n_fields, ulint *extra)
	Determines the size of a data tuple prefix in ROW_FORMAT=COMPACT. More...

ulint	rec_get_converted_size_comp (const dict_index_t index, ulint status, const dfield_t fields, ulint n_fields, ulint *extra)
	Determines the size of a data tuple in ROW_FORMAT=COMPACT. More...

static rec_t *	rec_convert_dtuple_to_rec_old (byte buf, const dict_index_t index, const dtuple_t *dtuple)
	Builds an old-style physical record out of a data tuple and stores it beginning from the start of the given buffer. More...

size_t	get_extra_bytes_for_temp_redundant (const dict_index_t *index, bool valid_version)

static Rec_instant_state	rec_convert_dtuple_to_rec_comp (rec_t rec, const dict_index_t index, const dfield_t fields, ulint n_fields, const dtuple_t v_entry, ulint status, bool temp, uint8_t rec_version)
	Builds a ROW_FORMAT=COMPACT record out of a data tuple. More...

static rec_t *	rec_convert_dtuple_to_rec_new (byte buf, const dict_index_t index, const dtuple_t *dtuple)
	Builds a new-style physical record out of a data tuple and stores it beginning from the start of the given buffer. More...

rec_t *	rec_convert_dtuple_to_rec (byte buf, const dict_index_t index, const dtuple_t *dtuple)
	Builds a physical record out of a data tuple and stores it beginning from the start of the given buffer. More...

ulint	rec_get_serialize_size (const dict_index_t index, const dfield_t fields, ulint n_fields, const dtuple_t v_entry, ulint extra, uint8_t rec_version)
	Determines the size of a data tuple prefix in ROW_FORMAT=COMPACT. More...

void	rec_deserialize_init_offsets (const rec_t rec, const dict_index_t index, ulint *offsets)
	Determine the offset to each field in temporary file. More...

void	rec_serialize_dtuple (rec_t rec, const dict_index_t index, const dfield_t fields, ulint n_fields, const dtuple_t v_entry, uint8_t rec_version)
	Builds a temporary file record out of a data tuple. More...

void	rec_copy_prefix_to_dtuple (dtuple_t tuple, const rec_t rec, const dict_index_t index, ulint n_fields, mem_heap_t heap)
	Copies the first n fields of a physical record to a data tuple. More...

static rec_t *	rec_copy_prefix_to_buf_old (const rec_t rec, ulint n_fields, ulint area_end, byte buf, size_t buf_size)
	Copies the first n fields of an old-style physical record to a new physical record in a buffer. More...

rec_t *	rec_copy_prefix_to_buf (const rec_t rec, const dict_index_t index, ulint n_fields, byte *buf, size_t buf_size)
	Copies the first n fields of a physical record to a new physical record in a buffer. More...

bool	rec_validate (const rec_t rec, const ulint offsets)
	Validates the consistency of a physical record. More...

void	rec_print_old (FILE file, const rec_t rec)
	Prints an old-style physical record. More...

static void	rec_print_comp (FILE file, const rec_t rec, const ulint *offsets)
	Prints a physical record in ROW_FORMAT=COMPACT. More...

static void	rec_print_mbr_old (FILE file, const rec_t rec)
	Prints an old-style spatial index record. More...

void	rec_print_mbr_rec (FILE file, const rec_t rec, const ulint *offsets)
	Prints a spatial index record. More...

void	rec_print_new (FILE file, const rec_t rec, const ulint *offsets)
	Prints a physical record. More...

void	rec_print (FILE file, const rec_t rec, const dict_index_t *index)
	Prints a physical record. More...

void	rec_print (std::ostream &o, const rec_t rec, ulint info, const ulint offsets)
	Pretty-print a record. More...

std::ostream &	operator<< (std::ostream &o, const rec_index_print &r)
	Display a record. More...

std::ostream &	operator<< (std::ostream &o, const rec_offsets_print &r)
	Display a record. More...

trx_id_t	rec_get_trx_id (const rec_t rec, const dict_index_t index)
	Reads the DB_TRX_ID of a clustered index record. More...

Detailed Description

Record manager.

Created 5/30/1994 Heikki Tuuri

Function Documentation

◆ get_extra_bytes_for_temp_redundant()

size_t get_extra_bytes_for_temp_redundant	(	const dict_index_t *	index,
		bool	valid_version
	)

◆ get_nullable_fields_for_rec()

static size_t get_nullable_fields_for_rec	(	const dict_index_t *	index,
		const size_t	n_fields,
		uint8_t &	rec_version
	)

static

◆ is_store_version()

bool is_store_version	(	const dict_index_t *	index,
		size_t	n_tuple_fields
	)

For a given clustered index, version is to be stored on physical record.

Parameters

[in]	index	clustered index
[in]	n_tuple_fields	number of fields in tuple

Returns: true, if version is to be stored

◆ operator<<() [1/2]

std::ostream & operator<<	(	std::ostream &	o,
		const rec_index_print &	r
	)

Display a record.

Parameters

[in,out]	o	output stream
[in]	r	record to display

Returns: the output stream

◆ operator<<() [2/2]

std::ostream & operator<<	(	std::ostream &	o,
		const rec_offsets_print &	r
	)

Display a record.

Parameters

[in,out]	o	output stream
[in]	r	record to display

Returns: the output stream

◆ rec_convert_dtuple_to_rec()

rec_t * rec_convert_dtuple_to_rec	(	byte *	buf,
		const dict_index_t *	index,
		const dtuple_t *	dtuple
	)

Builds a physical record out of a data tuple and stores it beginning from the start of the given buffer.

Builds a physical record out of a data tuple and stores it into the given buffer.

Returns: pointer to the origin of physical record

Parameters

buf	in: start address of the physical record
index	in: record descriptor
dtuple	in: data tuple

◆ rec_convert_dtuple_to_rec_comp()

static Rec_instant_state rec_convert_dtuple_to_rec_comp	(	rec_t *	rec,
		const dict_index_t *	index,
		const dfield_t *	fields,
		ulint	n_fields,
		const dtuple_t *	v_entry,
		ulint	status,
		bool	temp,
		uint8_t	rec_version
	)

inlinestatic

Builds a ROW_FORMAT=COMPACT record out of a data tuple.

Parameters

[in,out]	rec	origin of record
[in]	index	record descriptor
[in]	fields	array of data fields
[in]	n_fields	number of data fields
[in]	v_entry	dtuple contains virtual column data
[in]	status	status bits of the record
[in]	temp	whether to use the format for temporary files in index creation
[in]	rec_version	rec version (could be 0 also)

Returns: record instant information for record on leaf page

◆ rec_convert_dtuple_to_rec_new()

static rec_t * rec_convert_dtuple_to_rec_new	(	byte *	buf,
		const dict_index_t *	index,
		const dtuple_t *	dtuple
	)

static

Builds a new-style physical record out of a data tuple and stores it beginning from the start of the given buffer.

Parameters

[in]	buf	start address of the physical record
[in]	index	record descriptor
[in]	dtuple	data tuple

Returns: pointer to the origin of physical record

◆ rec_convert_dtuple_to_rec_old()

static rec_t * rec_convert_dtuple_to_rec_old	(	byte *	buf,
		const dict_index_t *	index,
		const dtuple_t *	dtuple
	)

static

Builds an old-style physical record out of a data tuple and stores it beginning from the start of the given buffer.

Parameters

[in]	buf	start address of the physical record
[in]	index	record descriptor
[in]	dtuple	data tuple

Returns: pointer to the origin of physical record

◆ rec_copy_prefix_to_buf()

rec_t * rec_copy_prefix_to_buf	(	const rec_t *	rec,
		const dict_index_t *	index,
		ulint	n_fields,
		byte **	buf,
		size_t *	buf_size
	)

Copies the first n fields of a physical record to a new physical record in a buffer.

Parameters

[in]	rec	physical record
[in]	index	record descriptor
[in]	n_fields	number of fields to copy
[in,out]	buf	memory buffer for the copied prefix, or NULL
[in,out]	buf_size	buffer size

Returns: own: copied record

◆ rec_copy_prefix_to_buf_old()

static rec_t * rec_copy_prefix_to_buf_old	(	const rec_t *	rec,
		ulint	n_fields,
		ulint	area_end,
		byte **	buf,
		size_t *	buf_size
	)

static

Copies the first n fields of an old-style physical record to a new physical record in a buffer.

Parameters

[in]	rec	physical record
[in]	n_fields	number of fields to copy
[in]	area_end	end of the prefix data
[in,out]	buf	memory buffer for the copied prefix, or NULL
[in,out]	buf_size	buffer size

Returns: own: copied record

◆ rec_copy_prefix_to_dtuple()

void rec_copy_prefix_to_dtuple	(	dtuple_t *	tuple,
		const rec_t *	rec,
		const dict_index_t *	index,
		ulint	n_fields,
		mem_heap_t *	heap
	)

Copies the first n fields of a physical record to a data tuple.

The fields are copied to the memory heap.

Parameters

tuple	out: data tuple
rec	in: physical record
index	in: record descriptor
n_fields	in: number of fields to copy
heap	in: memory heap

◆ rec_deserialize_init_offsets()

void rec_deserialize_init_offsets	(	const rec_t *	rec,
		const dict_index_t *	index,
		ulint *	offsets
	)

Determine the offset to each field in temporary file.

See also: rec_serialize_dtuple()

Parameters

rec	in: temporary file record
index	in: record descriptor
offsets	in/out: array of offsets; in: n=rec_offs_n_fields(offsets)

◆ rec_get_converted_size_comp()

ulint rec_get_converted_size_comp	(	const dict_index_t *	index,
		ulint	status,
		const dfield_t *	fields,
		ulint	n_fields,
		ulint *	extra
	)

Determines the size of a data tuple in ROW_FORMAT=COMPACT.

Returns: total size

Parameters

index	in: record descriptor; dict_table_is_comp() is assumed to hold, even if it does not
status	in: status bits of the record
fields	in: array of data fields
n_fields	in: number of data fields
extra	out: extra size

◆ rec_get_converted_size_comp_prefix()

ulint rec_get_converted_size_comp_prefix	(	const dict_index_t *	index,
		const dfield_t *	fields,
		ulint	n_fields,
		ulint *	extra
	)

Determines the size of a data tuple prefix in ROW_FORMAT=COMPACT.

Returns: total size

Parameters

index	in: record descriptor
fields	in: array of data fields
n_fields	in: number of data fields
extra	out: extra size

◆ rec_get_converted_size_comp_prefix_low()

static ulint rec_get_converted_size_comp_prefix_low	(	const dict_index_t *	index,
		const dfield_t *	fields,
		ulint	n_fields,
		const dtuple_t *	v_entry,
		ulint *	extra,
		ulint *	status,
		bool	temp,
		uint8_t	rec_version
	)

inlinestatic

Determines the size of a data tuple prefix in ROW_FORMAT=COMPACT.

Parameters

[in]	index	record descriptor, dict_table_is_comp() is assumed to hold, even if it does not
[in]	fields	array of data fields
[in]	n_fields	number of data fields
[in]	v_entry	dtuple contains virtual column data
[out]	extra	extra size
[in]	status	status bits of the record, can be nullptr if unnecessary
[in]	temp	whether this is a temporary file record
[in]	rec_version	rec version if INSTANT

Returns: total size

◆ rec_get_n_extern_new()

ulint rec_get_n_extern_new	(	const rec_t *	rec,
		const dict_index_t *	index,
		ulint	n
	)

Determine how many of the first n columns in a compact physical record are stored externally.

Returns: number of externally stored columns

Parameters

rec	in: compact physical record
index	in: record descriptor
n	in: number of columns to scan

◆ rec_get_serialize_size()

ulint rec_get_serialize_size	(	const dict_index_t *	index,
		const dfield_t *	fields,
		ulint	n_fields,
		const dtuple_t *	v_entry,
		ulint *	extra,
		uint8_t	rec_version
	)

Determines the size of a data tuple prefix in ROW_FORMAT=COMPACT.

Determines the size of a data tuple prefix in a temporary file.

Returns: total size

◆ rec_get_trx_id()

trx_id_t rec_get_trx_id	(	const rec_t *	rec,
		const dict_index_t *	index
	)

Reads the DB_TRX_ID of a clustered index record.

Returns: the value of DB_TRX_ID

Parameters

rec	in: record
index	in: clustered index

◆ rec_print() [1/2]

void rec_print	(	FILE *	file,
		const rec_t *	rec,
		const dict_index_t *	index
	)

Prints a physical record.

Parameters

[in]	file	File where to print
[in]	rec	Physical record
[in]	index	Record descriptor

◆ rec_print() [2/2]

void rec_print	(	std::ostream &	o,
		const rec_t *	rec,
		ulint	info,
		const ulint *	offsets
	)

Pretty-print a record.

Parameters

[in,out]	o	output stream
[in]	rec	physical record
[in]	info	rec_get_info_bits(rec)
[in]	offsets	rec_get_offsets(rec)

◆ rec_print_comp()

static void rec_print_comp	(	FILE *	file,
		const rec_t *	rec,
		const ulint *	offsets
	)

static

Prints a physical record in ROW_FORMAT=COMPACT.

Ignores the record header.

Parameters

file	in: file where to print
rec	in: physical record
offsets	in: array returned by rec_get_offsets()

◆ rec_print_mbr_old()

static void rec_print_mbr_old	(	FILE *	file,
		const rec_t *	rec
	)

static

Prints an old-style spatial index record.

Parameters

file	in: file where to print
rec	in: physical record

◆ rec_print_mbr_rec()

void rec_print_mbr_rec	(	FILE *	file,
		const rec_t *	rec,
		const ulint *	offsets
	)

Prints a spatial index record.

Parameters

[in]	file	File where to print
[in]	rec	Physical record
[in]	offsets	Array returned by rec_get_offsets()

◆ rec_print_new()

void rec_print_new	(	FILE *	file,
		const rec_t *	rec,
		const ulint *	offsets
	)

Prints a physical record.

Parameters

[in]	file	file where to print
[in]	rec	physical record
[in]	offsets	array returned by rec_get_offsets()

Parameters

file	in: file where to print
rec	in: physical record
offsets	in: array returned by rec_get_offsets()

◆ rec_print_old()

void rec_print_old	(	FILE *	file,
		const rec_t *	rec
	)

Prints an old-style physical record.

Parameters

[in]	file	File where to print
[in]	rec	Physical record

◆ rec_serialize_dtuple()

void rec_serialize_dtuple	(	rec_t *	rec,
		const dict_index_t *	index,
		const dfield_t *	fields,
		ulint	n_fields,
		const dtuple_t *	v_entry,
		uint8_t	rec_version
	)

Builds a temporary file record out of a data tuple.

Parameters

[out]	rec	record
[in]	index	record descriptor
[in]	fields	array of data fields
[in]	n_fields	number of fields
[in]	v_entry	dtuple contains virtual column data
[in]	rec_version	rec version

See also: rec_deserialize_init_offsets()

◆ rec_validate()

bool rec_validate	(	const rec_t *	rec,
		const ulint *	offsets
	)

Validates the consistency of a physical record.

Parameters

[in]	rec	physical record
[in]	offsets	array returned by rec_get_offsets()

Returns: true if ok

◆ rec_validate_old()

static bool rec_validate_old ( const rec_t * rec )

static

Validates the consistency of an old-style physical record.

Parameters

[in] rec physical record

Returns: true if ok

Functions

Detailed Description

Function Documentation

◆ get_extra_bytes_for_temp_redundant()

◆ get_nullable_fields_for_rec()

◆ is_store_version()

◆ operator<<() [1/2]

◆ operator<<() [2/2]

◆ rec_convert_dtuple_to_rec()

◆ rec_convert_dtuple_to_rec_comp()

◆ rec_convert_dtuple_to_rec_new()

◆ rec_convert_dtuple_to_rec_old()

◆ rec_copy_prefix_to_buf()

◆ rec_copy_prefix_to_buf_old()

◆ rec_copy_prefix_to_dtuple()

◆ rec_deserialize_init_offsets()

◆ rec_get_converted_size_comp()

◆ rec_get_converted_size_comp_prefix()

◆ rec_get_converted_size_comp_prefix_low()

◆ rec_get_n_extern_new()

◆ rec_get_serialize_size()

◆ rec_get_trx_id()

◆ rec_print() [1/2]

◆ rec_print() [2/2]

◆ rec_print_comp()

◆ rec_print_mbr_old()

◆ rec_print_mbr_rec()

◆ rec_print_new()

◆ rec_print_old()

◆ rec_serialize_dtuple()

◆ rec_validate()

◆ rec_validate_old()