The page cursor. More...

#include "buf0types.h"
#include "page0page.h"
#include "rem0cmp.h"

Functions
static page_t *	page_cur_get_page (page_cur_t *cur)
	Gets pointer to the page frame where the cursor is positioned. More...

static buf_block_t *	page_cur_get_block (page_cur_t *cur)
	Gets pointer to the buffer block where the cursor is positioned. More...

static page_zip_des_t *	page_cur_get_page_zip (page_cur_t *cur)
	Gets pointer to the page frame where the cursor is positioned. More...

static rec_t *	page_cur_get_rec (page_cur_t *cur)
	Gets the record where the cursor is positioned. More...

static void	page_cur_set_before_first (const buf_block_t block, page_cur_t cur)
	Sets the cursor object to point before the first user record on the page. More...

static void	page_cur_set_after_last (const buf_block_t block, page_cur_t cur)
	Sets the cursor object to point after the last user record on the page. More...

static bool	page_cur_is_before_first (const page_cur_t *cur)
	Returns true if the cursor is before first user record on page. More...

static bool	page_cur_is_after_last (const page_cur_t *cur)
	Returns true if the cursor is after last user record. More...

static void	page_cur_position (const rec_t rec, const buf_block_t block, page_cur_t *cur)
	Positions the cursor on the given record. More...

static void	page_cur_move_to_next (page_cur_t *cur)
	Moves the cursor to the next record on page. More...

static void	page_cur_move_to_prev (page_cur_t *cur)
	Moves the cursor to the previous record on page. More...

static ulint	page_cur_search (const buf_block_t block, const dict_index_t index, const dtuple_t tuple, page_cur_mode_t mode, page_cur_t cursor)
	Search the right position for a page cursor. More...

static ulint	page_cur_search (const buf_block_t block, const dict_index_t index, const dtuple_t tuple, page_cur_t cursor)
	Search the right position for a page cursor. More...

static rec_t *	page_cur_tuple_insert (page_cur_t cursor, const dtuple_t tuple, dict_index_t index, ulint offsets, mem_heap_t heap, mtr_t mtr)

static rec_t *	page_cur_tuple_direct_insert (page_cur_t cursor, const dtuple_t tuple, dict_index_t index, mtr_t mtr, ulint rec_size)
	Insert a record next to page cursor. More...

static rec_t *	page_cur_rec_insert (page_cur_t cursor, const rec_t rec, dict_index_t index, ulint offsets, mtr_t *mtr)
	Inserts a record next to page cursor. More...

Detailed Description

The page cursor.

Created 10/4/1994 Heikki Tuuri

Function Documentation

◆ page_cur_get_block()

static buf_block_t * page_cur_get_block ( page_cur_t * cur )

inlinestatic

Gets pointer to the buffer block where the cursor is positioned.

Returns: page

Parameters

cur	in: page cursor

◆ page_cur_get_page()

static page_t * page_cur_get_page ( page_cur_t * cur )

inlinestatic

Gets pointer to the page frame where the cursor is positioned.

Returns: page

Parameters

cur	in: page cursor

◆ page_cur_get_page_zip()

static page_zip_des_t * page_cur_get_page_zip ( page_cur_t * cur )

inlinestatic

Gets pointer to the page frame where the cursor is positioned.

Returns: page

Parameters

cur	in: page cursor

◆ page_cur_get_rec()

static rec_t * page_cur_get_rec ( page_cur_t * cur )

inlinestatic

Gets the record where the cursor is positioned.

Returns: record

Parameters

cur	in: page cursor

◆ page_cur_is_after_last()

static bool page_cur_is_after_last ( const page_cur_t * cur )

inlinestatic

Returns true if the cursor is after last user record.

Returns: true if at end

Parameters

cur	in: cursor

◆ page_cur_is_before_first()

static bool page_cur_is_before_first ( const page_cur_t * cur )

inlinestatic

Returns true if the cursor is before first user record on page.

Returns: true if at start

Parameters

cur	in: cursor

◆ page_cur_move_to_next()

static void page_cur_move_to_next ( page_cur_t * cur )

inlinestatic

Moves the cursor to the next record on page.

Parameters

cur	in/out: cursor; must not be after last

◆ page_cur_move_to_prev()

static void page_cur_move_to_prev ( page_cur_t * cur )

inlinestatic

Moves the cursor to the previous record on page.

Parameters

cur	in/out: page cursor, not before first

◆ page_cur_position()

static void page_cur_position	(	const rec_t *	rec,
		const buf_block_t *	block,
		page_cur_t *	cur
	)

inlinestatic

Positions the cursor on the given record.

Parameters

rec	in: record on a page
block	in: buffer block containing the record
cur	out: page cursor

◆ page_cur_rec_insert()

static rec_t * page_cur_rec_insert	(	page_cur_t *	cursor,
		const rec_t *	rec,
		dict_index_t *	index,
		ulint *	offsets,
		mtr_t *	mtr
	)

inlinestatic

Inserts a record next to page cursor.

Returns pointer to inserted record if succeed, i.e., enough space available, NULL otherwise. The cursor stays at the same logical position, but the physical position may change if it is pointing to a compressed page that was reorganized.

IMPORTANT: The caller will have to update IBUF_BITMAP_FREE if this is a compressed leaf page in a secondary index. This has to be done either within the same mini-transaction, or by invoking ibuf_reset_free_bits() before mtr_commit().

Returns: pointer to record if succeed, NULL otherwise

Parameters

cursor	in/out: a page cursor
rec	in: record to insert
index	in: record descriptor
offsets	in/out: rec_get_offsets(rec, index)
mtr	in: mini-transaction handle, or NULL

◆ page_cur_search() [1/2]

static ulint page_cur_search	(	const buf_block_t *	block,
		const dict_index_t *	index,
		const dtuple_t *	tuple,
		page_cur_mode_t	mode,
		page_cur_t *	cursor
	)

inlinestatic

Search the right position for a page cursor.

Parameters

[in]	block	buffer block
[in]	index	index tree
[in]	tuple	data tuple
[in]	mode	PAGE_CUR_L, PAGE_CUR_LE, PAGE_CUR_G, or PAGE_CUR_GE
[out]	cursor	page cursor

Returns: number of matched fields on the left

◆ page_cur_search() [2/2]

static ulint page_cur_search	(	const buf_block_t *	block,
		const dict_index_t *	index,
		const dtuple_t *	tuple,
		page_cur_t *	cursor
	)

inlinestatic

Search the right position for a page cursor.

Parameters

[in]	block	buffer block
[in]	index	index tree
[in]	tuple	data tuple
[out]	cursor	page cursor

Returns: number of matched fields on the left

◆ page_cur_set_after_last()

static void page_cur_set_after_last	(	const buf_block_t *	block,
		page_cur_t *	cur
	)

inlinestatic

Sets the cursor object to point after the last user record on the page.

Parameters

block	in: index page
cur	in: cursor

◆ page_cur_set_before_first()

static void page_cur_set_before_first	(	const buf_block_t *	block,
		page_cur_t *	cur
	)

inlinestatic

Sets the cursor object to point before the first user record on the page.

Parameters

block	in: index page
cur	in: cursor

◆ page_cur_tuple_direct_insert()

static rec_t * page_cur_tuple_direct_insert	(	page_cur_t *	cursor,
		const dtuple_t *	tuple,
		dict_index_t *	index,
		mtr_t *	mtr,
		ulint	rec_size
	)

inlinestatic

Insert a record next to page cursor.

Record is directly copied to the page from tuple without creating intermediate copy of the record.

Parameters

[in,out]	cursor	A page cursor
[in]	tuple	Pointer to a data tuple
[in]	index	Record descriptor
[in]	mtr	Mini-transaction handle, or NULL
[in]	rec_size	The size of new record

Returns: pointer to record if succeed, NULL otherwise

◆ page_cur_tuple_insert()

static rec_t * page_cur_tuple_insert	(	page_cur_t *	cursor,
		const dtuple_t *	tuple,
		dict_index_t *	index,
		ulint **	offsets,
		mem_heap_t **	heap,
		mtr_t *	mtr
	)

inlinestatic

Functions

Detailed Description

Function Documentation

◆ page_cur_get_block()

◆ page_cur_get_page()

◆ page_cur_get_page_zip()

◆ page_cur_get_rec()

◆ page_cur_is_after_last()

◆ page_cur_is_before_first()

◆ page_cur_move_to_next()

◆ page_cur_move_to_prev()

◆ page_cur_position()

◆ page_cur_rec_insert()

◆ page_cur_search() [1/2]

◆ page_cur_search() [2/2]

◆ page_cur_set_after_last()

◆ page_cur_set_before_first()

◆ page_cur_tuple_direct_insert()

◆ page_cur_tuple_insert()