rem0rec.ic File Reference

#include "mach0data.h"
#include "ut0byte.h"
#include "dict0dict.h"
#include "btr0types.h"

Include dependency graph for rem0rec.ic:

This graph shows which files directly or indirectly include this file:

Macros
#define	REC_OFFS_COMPACT   ((ulint) 1 << 31)
#define	REC_OFFS_SQL_NULL   ((ulint) 1 << 31)
#define	REC_OFFS_EXTERNAL   ((ulint) 1 << 30)
#define	REC_OFFS_MASK   (REC_OFFS_EXTERNAL - 1)
#define	REC_NEXT   2
#define	REC_NEXT_MASK   0xFFFFUL
#define	REC_NEXT_SHIFT   0
#define	REC_OLD_SHORT   3 /* This is single byte bit-field */
#define	REC_OLD_SHORT_MASK   0x1UL
#define	REC_OLD_SHORT_SHIFT   0
#define	REC_OLD_N_FIELDS   4
#define	REC_OLD_N_FIELDS_MASK   0x7FEUL
#define	REC_OLD_N_FIELDS_SHIFT   1
#define	REC_NEW_STATUS   3 /* This is single byte bit-field */
#define	REC_NEW_STATUS_MASK   0x7UL
#define	REC_NEW_STATUS_SHIFT   0
#define	REC_OLD_HEAP_NO   5
#define	REC_HEAP_NO_MASK   0xFFF8UL
#define	REC_OLD_N_OWNED   6 /* This is single byte bit-field */
#define	REC_NEW_N_OWNED   5 /* This is single byte bit-field */
#define	REC_N_OWNED_MASK   0xFUL
#define	REC_N_OWNED_SHIFT   0
#define	REC_OLD_INFO_BITS   6 /* This is single byte bit-field */
#define	REC_NEW_INFO_BITS   5 /* This is single byte bit-field */
#define	REC_INFO_BITS_MASK   0xF0UL
#define	REC_INFO_BITS_SHIFT   0
#define	rec_offs_base(offsets)   (offsets + REC_OFFS_HEADER_SIZE)

Functions
UNIV_INTERN void	rec_set_nth_field_null_bit (rec_t *rec, ulint i, ibool val)
UNIV_INTERN void	rec_set_nth_field_sql_null (rec_t *rec, ulint n)
UNIV_INLINE ulint	rec_get_bit_field_1 (const rec_t *rec, ulint offs, ulint mask, ulint shift)
UNIV_INLINE void	rec_set_bit_field_1 (rec_t *rec, ulint val, ulint offs, ulint mask, ulint shift)
UNIV_INLINE ulint	rec_get_bit_field_2 (const rec_t *rec, ulint offs, ulint mask, ulint shift)
UNIV_INLINE void	rec_set_bit_field_2 (rec_t *rec, ulint val, ulint offs, ulint mask, ulint shift)
UNIV_INLINE const rec_t *	rec_get_next_ptr_const (const rec_t *rec, ulint comp)
UNIV_INLINE rec_t *	rec_get_next_ptr (rec_t *rec, ulint comp)
UNIV_INLINE ulint	rec_get_next_offs (const rec_t *rec, ulint comp)
UNIV_INLINE void	rec_set_next_offs_old (rec_t *rec, ulint next)
UNIV_INLINE void	rec_set_next_offs_new (rec_t *rec, ulint next)
UNIV_INLINE ulint	rec_get_n_fields_old (const rec_t *rec)
UNIV_INLINE void	rec_set_n_fields_old (rec_t *rec, ulint n_fields)
UNIV_INLINE ulint	rec_get_status (const rec_t *rec)
UNIV_INLINE ulint	rec_get_n_fields (const rec_t *rec, const dict_index_t *index)
UNIV_INLINE ulint	rec_get_n_owned_old (const rec_t *rec)
UNIV_INLINE void	rec_set_n_owned_old (rec_t *rec, ulint n_owned)
UNIV_INLINE ulint	rec_get_n_owned_new (const rec_t *rec)
UNIV_INLINE void	rec_set_n_owned_new (rec_t *rec, page_zip_des_t *page_zip, ulint n_owned)
UNIV_INLINE ulint	rec_get_info_bits (const rec_t *rec, ulint comp)
UNIV_INLINE void	rec_set_info_bits_old (rec_t *rec, ulint bits)
UNIV_INLINE void	rec_set_info_bits_new (rec_t *rec, ulint bits)
UNIV_INLINE void	rec_set_status (rec_t *rec, ulint bits)
UNIV_INLINE ulint	rec_get_info_and_status_bits (const rec_t *rec, ulint comp)
UNIV_INLINE void	rec_set_info_and_status_bits (rec_t *rec, ulint bits)
UNIV_INLINE ulint	rec_get_deleted_flag (const rec_t *rec, ulint comp)
UNIV_INLINE void	rec_set_deleted_flag_old (rec_t *rec, ulint flag)
UNIV_INLINE void	rec_set_deleted_flag_new (rec_t *rec, page_zip_des_t *page_zip, ulint flag)
UNIV_INLINE ibool	rec_get_node_ptr_flag (const rec_t *rec)
UNIV_INLINE ulint	rec_get_heap_no_old (const rec_t *rec)
UNIV_INLINE void	rec_set_heap_no_old (rec_t *rec, ulint heap_no)
UNIV_INLINE ulint	rec_get_heap_no_new (const rec_t *rec)
UNIV_INLINE void	rec_set_heap_no_new (rec_t *rec, ulint heap_no)
UNIV_INLINE ibool	rec_get_1byte_offs_flag (const rec_t *rec)
UNIV_INLINE void	rec_set_1byte_offs_flag (rec_t *rec, ibool flag)
UNIV_INLINE ulint	rec_1_get_field_end_info (const rec_t *rec, ulint n)
UNIV_INLINE ulint	rec_2_get_field_end_info (const rec_t *rec, ulint n)
UNIV_INLINE ulint	rec_2_is_field_extern (const rec_t *rec, ulint n)
UNIV_INLINE ulint	rec_offs_get_n_alloc (const ulint *offsets)
UNIV_INLINE void	rec_offs_set_n_alloc (ulint *offsets, ulint n_alloc)
UNIV_INLINE ulint	rec_offs_n_fields (const ulint *offsets)
UNIV_INLINE ibool	rec_offs_validate (const rec_t *rec, const dict_index_t *index, const ulint *offsets)
UNIV_INLINE void	rec_offs_make_valid (const rec_t *rec, const dict_index_t *index, ulint *offsets)
UNIV_INLINE ulint	rec_get_nth_field_offs (const ulint *offsets, ulint n, ulint *len)
UNIV_INLINE ulint	rec_offs_comp (const ulint *offsets)
UNIV_INLINE ulint	rec_offs_any_extern (const ulint *offsets)
UNIV_INLINE const byte *	rec_offs_any_null_extern (const rec_t *rec, const ulint *offsets)
UNIV_INLINE ulint	rec_offs_nth_extern (const ulint *offsets, ulint n)
UNIV_INLINE ulint	rec_offs_nth_sql_null (const ulint *offsets, ulint n)
UNIV_INLINE ulint	rec_offs_nth_size (const ulint *offsets, ulint n)
UNIV_INLINE ulint	rec_offs_n_extern (const ulint *offsets)
UNIV_INLINE ulint	rec_1_get_prev_field_end_info (const rec_t *rec, ulint n)
UNIV_INLINE ulint	rec_2_get_prev_field_end_info (const rec_t *rec, ulint n)
UNIV_INLINE void	rec_1_set_field_end_info (rec_t *rec, ulint n, ulint info)
UNIV_INLINE void	rec_2_set_field_end_info (rec_t *rec, ulint n, ulint info)
UNIV_INLINE ulint	rec_1_get_field_start_offs (const rec_t *rec, ulint n)
UNIV_INLINE ulint	rec_2_get_field_start_offs (const rec_t *rec, ulint n)
UNIV_INLINE ulint	rec_get_field_start_offs (const rec_t *rec, ulint n)
UNIV_INLINE ulint	rec_get_nth_field_size (const rec_t *rec, ulint n)
UNIV_INLINE void	rec_set_nth_field (rec_t *rec, const ulint *offsets, ulint n, const void *data, ulint len)
UNIV_INLINE ulint	rec_get_data_size_old (const rec_t *rec)
UNIV_INLINE void	rec_offs_set_n_fields (ulint *offsets, ulint n_fields)
UNIV_INLINE ulint	rec_offs_data_size (const ulint *offsets)
UNIV_INLINE ulint	rec_offs_extra_size (const ulint *offsets)
UNIV_INLINE ulint	rec_offs_size (const ulint *offsets)
UNIV_INLINE byte *	rec_get_end (const rec_t *rec, const ulint *offsets)
UNIV_INLINE byte *	rec_get_start (const rec_t *rec, const ulint *offsets)
UNIV_INLINE rec_t *	rec_copy (void *buf, const rec_t *rec, const ulint *offsets)
UNIV_INLINE ulint	rec_get_converted_extra_size (ulint data_size, ulint n_fields, ulint n_ext)
UNIV_INLINE ulint	rec_get_converted_size (dict_index_t *index, const dtuple_t *dtuple, ulint n_ext)
UNIV_INLINE ulint	rec_fold (const rec_t *rec, const ulint *offsets, ulint n_fields, ulint n_bytes, index_id_t tree_id)

Detailed Description

Record manager

Created 5/30/1994 Heikki Tuuri

Function Documentation

UNIV_INLINE ulint rec_1_get_field_end_info	(	const rec_t *	rec,
		ulint	n
	)

Returns the offset of nth field end if the record is stored in the 1-byte offsets form. If the field is SQL null, the flag is ORed in the returned value.

Returns

offset of the start of the field, SQL null flag ORed

Parameters

rec	in: record
n	in: field index

UNIV_INLINE ulint rec_1_get_field_start_offs	(	const rec_t *	rec,
		ulint	n
	)

Returns the offset of nth field start if the record is stored in the 1-byte offsets form.

Returns

offset of the start of the field

Parameters

rec	in: record
n	in: field index

UNIV_INLINE ulint rec_1_get_prev_field_end_info	(	const rec_t *	rec,
		ulint	n
	)

Returns the offset of n - 1th field end if the record is stored in the 1-byte offsets form. If the field is SQL null, the flag is ORed in the returned value. This function and the 2-byte counterpart are defined here because the C-compiler was not able to sum negative and positive constant offsets, and warned of constant arithmetic overflow within the compiler.

Returns

offset of the start of the PREVIOUS field, SQL null flag ORed

Parameters

rec	in: record
n	in: field index

UNIV_INLINE void rec_1_set_field_end_info	(	rec_t *	rec,
		ulint	n,
		ulint	info
	)

Sets the field end info for the nth field if the record is stored in the 1-byte format.

Parameters

rec	in: record
n	in: field index
info	in: value to set

UNIV_INLINE ulint rec_2_get_field_end_info	(	const rec_t *	rec,
		ulint	n
	)

Returns the offset of nth field end if the record is stored in the 2-byte offsets form. If the field is SQL null, the flag is ORed in the returned value.

Returns

offset of the start of the field, SQL null flag and extern storage flag ORed

Parameters

rec	in: record
n	in: field index

UNIV_INLINE ulint rec_2_get_field_start_offs	(	const rec_t *	rec,
		ulint	n
	)

Returns the offset of nth field start if the record is stored in the 2-byte offsets form.

Returns

offset of the start of the field

Parameters

rec	in: record
n	in: field index

UNIV_INLINE ulint rec_2_get_prev_field_end_info	(	const rec_t *	rec,
		ulint	n
	)

Returns the offset of n - 1th field end if the record is stored in the 2-byte offsets form. If the field is SQL null, the flag is ORed in the returned value.

Returns

offset of the start of the PREVIOUS field, SQL null flag ORed

Parameters

rec	in: record
n	in: field index

UNIV_INLINE ulint rec_2_is_field_extern	(	const rec_t *	rec,
		ulint	n
	)

Returns nonzero if the field is stored off-page.

Return values

0	if the field is stored in-page
REC_2BYTE_EXTERN_MASK	if the field is stored externally

Parameters

rec	in: record
n	in: field index

UNIV_INLINE void rec_2_set_field_end_info	(	rec_t *	rec,
		ulint	n,
		ulint	info
	)

Sets the field end info for the nth field if the record is stored in the 2-byte format.

Parameters

rec	in: record
n	in: field index
info	in: value to set

UNIV_INLINE rec_t* rec_copy	(	void *	buf,
		const rec_t *	rec,
		const ulint *	offsets
	)

Copies a physical record to a buffer.

Returns

pointer to the origin of the copy

Parameters

buf	in: buffer
rec	in: physical record
offsets	in: array returned by rec_get_offsets()

UNIV_INLINE ulint rec_fold	(	const rec_t *	rec,
		const ulint *	offsets,
		ulint	n_fields,
		ulint	n_bytes,
		index_id_t	tree_id
	)

Folds a prefix of a physical record to a ulint. Folds only existing fields, that is, checks that we do not run out of the record.

Returns

the folded value

Parameters

rec	in: the physical record
offsets	in: array returned by rec_get_offsets()
n_fields	in: number of complete fields to fold
n_bytes	in: number of bytes to fold in an incomplete last field
tree_id	in: index tree id

UNIV_INLINE ibool rec_get_1byte_offs_flag

(

const rec_t *

rec

)

The following function is used to test whether the data offsets in the record are stored in one-byte or two-byte format.

Returns

TRUE if 1-byte form

Parameters

rec	in: physical record

UNIV_INLINE ulint rec_get_bit_field_1	(	const rec_t *	rec,
		ulint	offs,
		ulint	mask,
		ulint	shift
	)

Gets a bit field from within 1 byte.

Parameters

rec	in: pointer to record origin
offs	in: offset from the origin down
mask	in: mask used to filter bits
shift	in: shift right applied after masking

UNIV_INLINE ulint rec_get_bit_field_2	(	const rec_t *	rec,
		ulint	offs,
		ulint	mask,
		ulint	shift
	)

Gets a bit field from within 2 bytes.

Parameters

rec	in: pointer to record origin
offs	in: offset from the origin down
mask	in: mask used to filter bits
shift	in: shift right applied after masking

UNIV_INLINE ulint rec_get_converted_extra_size	(	ulint	data_size,
		ulint	n_fields,
		ulint	n_ext
	)

Returns the extra size of an old-style physical record if we know its data size and number of fields.

Returns

extra size

Parameters

data_size	in: data size
n_fields	in: number of fields
n_ext	in: number of externally stored columns

UNIV_INLINE ulint rec_get_converted_size	(	dict_index_t *	index,
		const dtuple_t *	dtuple,
		ulint	n_ext
	)

The following function returns the size of a data tuple when converted to a physical record.

Returns

size

Parameters

index	in: record descriptor
dtuple	in: data tuple
n_ext	in: number of externally stored columns

UNIV_INLINE ulint rec_get_data_size_old

(

const rec_t *

rec

)

The following function returns the data size of an old-style physical record, that is the sum of field lengths. SQL null fields are counted as length 0 fields. The value returned by the function is the distance from record origin to record end in bytes.

Returns

size

Parameters

rec	in: physical record

UNIV_INLINE ulint rec_get_deleted_flag	(	const rec_t *	rec,
		ulint	comp
	)

The following function tells if record is delete marked.

Returns

nonzero if delete marked

Parameters

rec	in: physical record
comp	in: nonzero=compact page format

UNIV_INLINE byte* rec_get_end	(	const rec_t *	rec,
		const ulint *	offsets
	)

Returns a pointer to the end of the record.

Returns

pointer to end

Parameters

rec	in: pointer to record
offsets	in: array returned by rec_get_offsets()

UNIV_INLINE ulint rec_get_field_start_offs	(	const rec_t *	rec,
		ulint	n
	)

The following function is used to read the offset of the start of a data field in the record. The start of an SQL null field is the end offset of the previous non-null field, or 0, if none exists. If n is the number of the last field + 1, then the end offset of the last field is returned.

Returns

offset of the start of the field

Parameters

rec	in: record
n	in: field index

UNIV_INLINE ulint rec_get_heap_no_new

(

const rec_t *

rec

)

The following function is used to get the order number of a new-style record in the heap of the index page.

Returns

heap order number

Parameters

rec	in: physical record

UNIV_INLINE ulint rec_get_heap_no_old

(

const rec_t *

rec

)

The following function is used to get the order number of an old-style record in the heap of the index page.

Returns

heap order number

Parameters

rec	in: physical record

UNIV_INLINE ulint rec_get_info_and_status_bits	(	const rec_t *	rec,
		ulint	comp
	)

The following function is used to retrieve the info and status bits of a record. (Only compact records have status bits.)

Returns

info bits

Parameters

rec	in: physical record
comp	in: nonzero=compact page format

UNIV_INLINE ulint rec_get_info_bits	(	const rec_t *	rec,
		ulint	comp
	)

The following function is used to retrieve the info bits of a record.

Returns

info bits

Parameters

rec	in: physical record
comp	in: nonzero=compact page format

UNIV_INLINE ulint rec_get_n_fields	(	const rec_t *	rec,
		const dict_index_t *	index
	)

The following function is used to get the number of fields in a record.

Returns

number of data fields

Parameters

rec	in: physical record
index	in: record descriptor

UNIV_INLINE ulint rec_get_n_fields_old

(

const rec_t *

rec

)

The following function is used to get the number of fields in an old-style record.

Returns

number of data fields

Parameters

rec	in: physical record

UNIV_INLINE ulint rec_get_n_owned_new

(

const rec_t *

rec

)

The following function is used to get the number of records owned by the previous directory record.

Returns

number of owned records

Parameters

rec	in: new-style physical record

UNIV_INLINE ulint rec_get_n_owned_old

(

const rec_t *

rec

)

The following function is used to get the number of records owned by the previous directory record.

Returns

number of owned records

Parameters

rec	in: old-style physical record

UNIV_INLINE ulint rec_get_next_offs	(	const rec_t *	rec,
		ulint	comp
	)

The following function is used to get the offset of the next chained record on the same page.

Returns

the page offset of the next chained record, or 0 if none

Parameters

rec	in: physical record
comp	in: nonzero=compact page format

UNIV_INLINE rec_t* rec_get_next_ptr	(	rec_t *	rec,
		ulint	comp
	)

The following function is used to get the pointer of the next chained record on the same page.

Returns

pointer to the next chained record, or NULL if none

Parameters

rec	in: physical record
comp	in: nonzero=compact page format

UNIV_INLINE const rec_t* rec_get_next_ptr_const	(	const rec_t *	rec,
		ulint	comp
	)

The following function is used to get the pointer of the next chained record on the same page.

Returns

pointer to the next chained record, or NULL if none

Parameters

rec	in: physical record
comp	in: nonzero=compact page format

UNIV_INLINE ibool rec_get_node_ptr_flag

(

const rec_t *

rec

)

The following function tells if a new-style record is a node pointer.

Returns

TRUE if node pointer

Parameters

rec	in: physical record

UNIV_INLINE ulint rec_get_nth_field_offs	(	const ulint *	offsets,
		ulint	n,
		ulint *	len
	)

The following function is used to get an offset to the nth data field in a record.

Returns

offset from the origin of rec

Parameters

offsets	in: array returned by rec_get_offsets()
n	in: index of the field
len	out: length of the field; UNIV_SQL_NULL if SQL null

UNIV_INLINE ulint rec_get_nth_field_size	(	const rec_t *	rec,
		ulint	n
	)

Gets the physical size of an old-style field. Also an SQL null may have a field of size > 0, if the data type is of a fixed size.

Returns

field size in bytes

Parameters

rec	in: record
n	in: index of the field

UNIV_INLINE byte* rec_get_start	(	const rec_t *	rec,
		const ulint *	offsets
	)

Returns a pointer to the start of the record.

Returns

pointer to start

Parameters

rec	in: pointer to record
offsets	in: array returned by rec_get_offsets()

UNIV_INLINE ulint rec_get_status

(

const rec_t *

rec

)

The following function retrieves the status bits of a new-style record.

Returns

status bits

Parameters

rec	in: physical record

UNIV_INLINE ulint rec_offs_any_extern

(

const ulint *

offsets

)

Determine if the offsets are for a record containing externally stored columns.

Returns

nonzero if externally stored

Parameters

offsets

in: array returned by rec_get_offsets()

UNIV_INLINE const byte* rec_offs_any_null_extern	(	const rec_t *	rec,
		const ulint *	offsets
	)

Determine if the offsets are for a record containing null BLOB pointers.

Returns

first field containing a null BLOB pointer, or NULL if none found

Parameters

rec	in: record
offsets	in: rec_get_offsets(rec)

UNIV_INLINE ulint rec_offs_comp

(

const ulint *

offsets

)

Determine if the offsets are for a record in the new compact format.

Returns

nonzero if compact format

Parameters

offsets

in: array returned by rec_get_offsets()

UNIV_INLINE ulint rec_offs_data_size

(

const ulint *

offsets

)

The following function returns the data size of a physical record, that is the sum of field lengths. SQL null fields are counted as length 0 fields. The value returned by the function is the distance from record origin to record end in bytes.

Returns

size

Parameters

offsets

in: array returned by rec_get_offsets()

UNIV_INLINE ulint rec_offs_extra_size

(

const ulint *

offsets

)

Returns the total size of record minus data size of record. The value returned by the function is the distance from record start to record origin in bytes.

Returns

size

Parameters

offsets

in: array returned by rec_get_offsets()

UNIV_INLINE ulint rec_offs_get_n_alloc

(

const ulint *

offsets

)

The following function returns the number of allocated elements for an array of offsets.

Returns

number of elements

Parameters

offsets

in: array for rec_get_offsets()

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

Updates debug data in offsets, in order to avoid bogus rec_offs_validate() failures.

Parameters

rec	in: record
index	in: record descriptor
offsets	in: array returned by rec_get_offsets()

UNIV_INLINE ulint rec_offs_n_extern

(

const ulint *

offsets

)

Returns the number of extern bits set in a record.

Returns

number of externally stored fields

Parameters

offsets

in: array returned by rec_get_offsets()

UNIV_INLINE ulint rec_offs_n_fields

(

const ulint *

offsets

)

The following function returns the number of fields in a record.

Returns

number of fields

Parameters

offsets

in: array returned by rec_get_offsets()

UNIV_INLINE ulint rec_offs_nth_extern	(	const ulint *	offsets,
		ulint	n
	)

Returns nonzero if the extern bit is set in nth field of rec.

Returns

nonzero if externally stored

Parameters

offsets	in: array returned by rec_get_offsets()
n	in: nth field

UNIV_INLINE ulint rec_offs_nth_size	(	const ulint *	offsets,
		ulint	n
	)

Gets the physical size of a field.

Returns

length of field

Parameters

offsets	in: array returned by rec_get_offsets()
n	in: nth field

UNIV_INLINE ulint rec_offs_nth_sql_null	(	const ulint *	offsets,
		ulint	n
	)

Returns nonzero if the SQL NULL bit is set in nth field of rec.

Returns

nonzero if SQL NULL

Parameters

offsets	in: array returned by rec_get_offsets()
n	in: nth field

UNIV_INLINE void rec_offs_set_n_alloc	(	ulint *	offsets,
		ulint	n_alloc
	)

The following function sets the number of allocated elements for an array of offsets.

Parameters

offsets	out: array for rec_get_offsets(), must be allocated
n_alloc	in: number of elements

UNIV_INLINE void rec_offs_set_n_fields	(	ulint *	offsets,
		ulint	n_fields
	)

The following function sets the number of fields in offsets.

Parameters

offsets	in/out: array returned by rec_get_offsets()
n_fields	in: number of fields

UNIV_INLINE ulint rec_offs_size

(

const ulint *

offsets

)

Returns the total size of a physical record.

Returns

size

Parameters

offsets

in: array returned by rec_get_offsets()

UNIV_INLINE ibool rec_offs_validate	(	const rec_t *	rec,
		const dict_index_t *	index,
		const ulint *	offsets
	)

Validates offsets returned by rec_get_offsets().

Returns

TRUE if valid

Parameters

rec	in: record or NULL
index	in: record descriptor or NULL
offsets	in: array returned by rec_get_offsets()

UNIV_INLINE void rec_set_1byte_offs_flag	(	rec_t *	rec,
		ibool	flag
	)

The following function is used to set the 1-byte offsets flag.

Parameters

rec	in: physical record
flag	in: TRUE if 1byte form

UNIV_INLINE void rec_set_bit_field_1	(	rec_t *	rec,
		ulint	val,
		ulint	offs,
		ulint	mask,
		ulint	shift
	)

Sets a bit field within 1 byte.

Parameters

rec	in: pointer to record origin
val	in: value to set
offs	in: offset from the origin down
mask	in: mask used to filter bits
shift	in: shift right applied after masking

UNIV_INLINE void rec_set_bit_field_2	(	rec_t *	rec,
		ulint	val,
		ulint	offs,
		ulint	mask,
		ulint	shift
	)

Sets a bit field within 2 bytes.

Parameters

rec	in: pointer to record origin
val	in: value to set
offs	in: offset from the origin down
mask	in: mask used to filter bits
shift	in: shift right applied after masking

UNIV_INLINE void rec_set_deleted_flag_new	(	rec_t *	rec,
		page_zip_des_t *	page_zip,
		ulint	flag
	)

The following function is used to set the deleted bit.

Parameters

rec	in/out: new-style physical record
page_zip	in/out: compressed page, or NULL
flag	in: nonzero if delete marked

UNIV_INLINE void rec_set_deleted_flag_old	(	rec_t *	rec,
		ulint	flag
	)

The following function is used to set the deleted bit.

Parameters

rec	in: old-style physical record
flag	in: nonzero if delete marked

UNIV_INLINE void rec_set_heap_no_new	(	rec_t *	rec,
		ulint	heap_no
	)

The following function is used to set the heap number field in a new-style record.

Parameters

rec	in/out: physical record
heap_no	in: the heap number

UNIV_INLINE void rec_set_heap_no_old	(	rec_t *	rec,
		ulint	heap_no
	)

The following function is used to set the heap number field in an old-style record.

Parameters

rec	in: physical record
heap_no	in: the heap number

UNIV_INLINE void rec_set_info_and_status_bits	(	rec_t *	rec,
		ulint	bits
	)

The following function is used to set the info and status bits of a record. (Only compact records have status bits.)

Parameters

rec	in/out: physical record
bits	in: info bits

UNIV_INLINE void rec_set_info_bits_new	(	rec_t *	rec,
		ulint	bits
	)

The following function is used to set the info bits of a record.

Parameters

rec	in/out: new-style physical record
bits	in: info bits

UNIV_INLINE void rec_set_info_bits_old	(	rec_t *	rec,
		ulint	bits
	)

The following function is used to set the info bits of a record.

Parameters

rec	in: old-style physical record
bits	in: info bits

UNIV_INLINE void rec_set_n_fields_old	(	rec_t *	rec,
		ulint	n_fields
	)

The following function is used to set the number of fields in an old-style record.

Parameters

rec	in: physical record
n_fields	in: the number of fields

UNIV_INLINE void rec_set_n_owned_new	(	rec_t *	rec,
		page_zip_des_t *	page_zip,
		ulint	n_owned
	)

The following function is used to set the number of owned records.

Parameters

rec	in/out: new-style physical record
page_zip	in/out: compressed page, or NULL
n_owned	in: the number of owned

UNIV_INLINE void rec_set_n_owned_old	(	rec_t *	rec,
		ulint	n_owned
	)

The following function is used to set the number of owned records.

Parameters

rec	in: old-style physical record
n_owned	in: the number of owned

UNIV_INLINE void rec_set_next_offs_new	(	rec_t *	rec,
		ulint	next
	)

The following function is used to set the next record offset field of a new-style record.

Parameters

rec	in/out: new-style physical record
next	in: offset of the next record

UNIV_INLINE void rec_set_next_offs_old	(	rec_t *	rec,
		ulint	next
	)

The following function is used to set the next record offset field of an old-style record.

Parameters

rec	in: old-style physical record
next	in: offset of the next record

UNIV_INLINE void rec_set_nth_field	(	rec_t *	rec,
		const ulint *	offsets,
		ulint	n,
		const void *	data,
		ulint	len
	)

This is used to modify the value of an already existing field in a record. The previous value must have exactly the same size as the new value. If len is UNIV_SQL_NULL then the field is treated as an SQL null. For records in ROW_FORMAT=COMPACT (new-style records), len must not be UNIV_SQL_NULL unless the field already is SQL null.

Parameters

rec	in: record
offsets	in: array returned by rec_get_offsets()
n	in: index number of the field
data	in: pointer to the data if not SQL null
len	in: length of the data or UNIV_SQL_NULL

UNIV_INTERN void rec_set_nth_field_null_bit	(	rec_t *	rec,
		ulint	i,
		ibool	val
	)

Sets the value of the ith field SQL null bit of an old-style record. in: value to set

Parameters

rec	in: record
i	in: ith field

UNIV_INTERN void rec_set_nth_field_sql_null	(	rec_t *	rec,
		ulint	n
	)

Sets an old-style record field to SQL null. The physical size of the field is not changed. in: index of the field

Parameters

rec	in: record

UNIV_INLINE void rec_set_status	(	rec_t *	rec,
		ulint	bits
	)

The following function is used to set the status bits of a new-style record.

Parameters

rec	in/out: physical record
bits	in: info bits