sql_cursor.h File Reference

#include "sql_class.h"

Go to the source code of this file.

Classes
class	Server_side_cursor
Functions
bool	mysql_open_cursor (THD *thd, select_result *result, Server_side_cursor **res)

---

Detailed Description

Declarations for implementation of server side cursors. Only read-only non-scrollable cursors are currently implemented.

---

Function Documentation

bool mysql_open_cursor	(	THD *	thd,
		select_result *	result,
		Server_side_cursor **	pcursor
	)

Attempt to open a materialized cursor.

Parameters:

	thd	thread handle
[in]	result	result class of the caller used as a destination for the rows fetched from the cursor
[out]	pcursor	a pointer to store a pointer to cursor in

Returns:

Error status

Return values:

false	-- the query has been successfully executed; in this case pcursor may or may not contain a pointer to an open cursor.
true	-- an error, 'pcursor' has been left intact.