Cursor functions

Functions
HAILDB_API ib_err_t	ib_cursor_open_table_using_id (ib_id_t table_id, ib_trx_t ib_trx, ib_crsr_t *ib_crsr) UNIV_NO_IGNORE
HAILDB_API ib_err_t	ib_cursor_open_index_using_id (ib_id_t index_id, ib_trx_t ib_trx, ib_crsr_t *ib_crsr) UNIV_NO_IGNORE
HAILDB_API ib_err_t	ib_cursor_open_index_using_name (ib_crsr_t ib_open_crsr, const char *index_name, ib_crsr_t *ib_crsr) UNIV_NO_IGNORE
HAILDB_API ib_err_t	ib_cursor_open_table (const char *name, ib_trx_t ib_trx, ib_crsr_t *ib_crsr) UNIV_NO_IGNORE
HAILDB_API ib_err_t	ib_cursor_reset (ib_crsr_t ib_crsr) UNIV_NO_IGNORE
HAILDB_API ib_err_t	ib_cursor_close (ib_crsr_t ib_crsr) UNIV_NO_IGNORE
HAILDB_API ib_err_t	ib_cursor_prev (ib_crsr_t ib_crsr) UNIV_NO_IGNORE
HAILDB_API ib_err_t	ib_cursor_next (ib_crsr_t ib_crsr) UNIV_NO_IGNORE
HAILDB_API ib_err_t	ib_cursor_first (ib_crsr_t ib_crsr) UNIV_NO_IGNORE
HAILDB_API ib_err_t	ib_cursor_last (ib_crsr_t ib_crsr) UNIV_NO_IGNORE
HAILDB_API ib_err_t	ib_cursor_moveto (ib_crsr_t ib_crsr, ib_tpl_t ib_tpl, ib_srch_mode_t ib_srch_mode, int *result) UNIV_NO_IGNORE
HAILDB_API void	ib_cursor_attach_trx (ib_crsr_t ib_crsr, ib_trx_t ib_trx)
HAILDB_API void	ib_cursor_set_match_mode (ib_crsr_t ib_crsr, ib_match_mode_t match_mode)
HAILDB_API ib_bool_t	ib_cursor_is_positioned (const ib_crsr_t ib_crsr) UNIV_NO_IGNORE
HAILDB_API void	ib_cursor_stmt_begin (ib_crsr_t ib_crsr)

---

Function Documentation

HAILDB_API void ib_cursor_attach_trx	(	ib_crsr_t	ib_crsr,
		ib_trx_t	ib_trx
	)

Attach the cursor to the transaction. The cursor must not already be attached to another transaction.

Parameters:

	ib_crsr	is the cursor instance
	ib_trx	is the transaction to attach to the cursor

HAILDB_API ib_err_t ib_cursor_close

(

ib_crsr_t

ib_crsr

)

Close an InnoDB table and free the cursor.

Parameters:

ib_crsr

is an open cursor

Returns:

DB_SUCCESS or err code

HAILDB_API ib_err_t ib_cursor_first

(

ib_crsr_t

ib_crsr

)

Move cursor to the first record in the table.

Parameters:

ib_crsr

is the cursor instance

Returns:

DB_SUCCESS or err code

HAILDB_API ib_bool_t ib_cursor_is_positioned

(

const ib_crsr_t

ib_crsr

)

Check if cursor is positioned.

Parameters:

ib_crsr

is the cursor instance to check

Returns:

IB_TRUE if positioned

HAILDB_API ib_err_t ib_cursor_last

(

ib_crsr_t

ib_crsr

)

Move cursor to the last record in the table.

Parameters:

ib_crsr

is the cursor instance

Returns:

DB_SUCCESS or err code

HAILDB_API ib_err_t ib_cursor_moveto	(	ib_crsr_t	ib_crsr,
		ib_tpl_t	ib_tpl,
		ib_srch_mode_t	ib_srch_mode,
		int *	result
	)

Search for key.

Parameters:

	ib_crsr	is an open cursor instance
	ib_tpl	is a key to search for
	ib_srch_mode	is the search mode
[out]	result	is -1, 0 or 1 depending on tuple eq or gt than the current row

Returns:

DB_SUCCESS or err code

HAILDB_API ib_err_t ib_cursor_next

(

ib_crsr_t

ib_crsr

)

Move cursor to the next user record in the table.

Parameters:

ib_crsr

is the cursor instance

Returns:

DB_SUCCESS or err code

HAILDB_API ib_err_t ib_cursor_open_index_using_id	(	ib_id_t	index_id,
		ib_trx_t	ib_trx,
		ib_crsr_t *	ib_crsr
	)

Open an InnoDB index and return a cursor handle to it.

Parameters:

	index_id	is the id of the index to open
	ib_trx	is the current transaction handlem can be NULL
[out]	ib_crsr	is the new cursor

Returns:

DB_SUCCESS or err code

HAILDB_API ib_err_t ib_cursor_open_index_using_name	(	ib_crsr_t	ib_open_crsr,
		const char *	index_name,
		ib_crsr_t *	ib_crsr
	)

Open an InnoDB secondary index cursor and return a cursor handle to it.

Parameters:

	ib_open_crsr	is an open cursor
	index_name	is the name of the index
[out]	ib_crsr	is the new cursor

Returns:

DB_SUCCESS or err code

HAILDB_API ib_err_t ib_cursor_open_table	(	const char *	name,
		ib_trx_t	ib_trx,
		ib_crsr_t *	ib_crsr
	)

Open an InnoDB table by name and return a cursor handle to it.

Parameters:

	name	is the table name to open
	ib_trx	is the current transactionm, can be NULL
	ib_crsr	is the new cursor

Returns:

DB_SUCCESS or err code

HAILDB_API ib_err_t ib_cursor_open_table_using_id	(	ib_id_t	table_id,
		ib_trx_t	ib_trx,
		ib_crsr_t *	ib_crsr
	)

Open an InnoDB table and return a cursor handle to it.

Parameters:

	table_id	is the id of the table to open
	ib_trx	is the current transaction handle, can be NULL
[out]	ib_crsr	is the new cursor

Returns:

DB_SUCCESS or err code

HAILDB_API ib_err_t ib_cursor_prev

(

ib_crsr_t

ib_crsr

)

Move cursor to the prev user record in the table.

Parameters:

ib_crsr

is the cursor instance

Returns:

DB_SUCCESS or err code

HAILDB_API ib_err_t ib_cursor_reset

(

ib_crsr_t

ib_crsr

)

Reset the cursor.

Parameters:

ib_crsr

is an open cursor

Returns:

DB_SUCCESS or err code

HAILDB_API void ib_cursor_set_match_mode	(	ib_crsr_t	ib_crsr,
		ib_match_mode_t	match_mode
	)

Set the match mode for ib_cursor_move().

Parameters:

	ib_crsr	is the cursor instance
	match_mode	is the match mode to set

HAILDB_API void ib_cursor_stmt_begin

(

ib_crsr_t

ib_crsr

)

Inform the cursor that it's the start of an SQL statement.

Parameters:

ib_crsr

is the cursor instance