MySQL  8.0.19
Source Code Documentation
Server_side_cursor Class Referenceabstract

Server_side_cursor – an interface for materialized implementation of cursors. More...

#include <sql_cursor.h>

Inheritance diagram for Server_side_cursor:
Materialized_cursor

Public Member Functions

 Server_side_cursor (MEM_ROOT *mem_root_arg, Query_result *result_arg)
 
virtual bool is_open () const =0
 
virtual int open (THD *thd, JOIN *top_level_join)=0
 
virtual bool fetch (ulong num_rows)=0
 
virtual void close ()=0
 
virtual ~Server_side_cursor ()
 

Static Public Member Functions

static void operator delete (void *ptr, size_t size)
 
static void operator delete (void *, MEM_ROOT *, const std::nothrow_t &) noexcept
 

Protected Attributes

Query_arena m_arena
 
Query_resultresult
 Row destination used for fetch. More...
 

Detailed Description

Server_side_cursor – an interface for materialized implementation of cursors.

All cursors are self-contained (created in their own memory root). For that reason they must be deleted only using a pointer to Server_side_cursor, not to its base class.

Constructor & Destructor Documentation

◆ Server_side_cursor()

Server_side_cursor::Server_side_cursor ( MEM_ROOT mem_root_arg,
Query_result result_arg 
)
inline

◆ ~Server_side_cursor()

Server_side_cursor::~Server_side_cursor ( )
virtual

Member Function Documentation

◆ close()

virtual void Server_side_cursor::close ( )
pure virtual

Implemented in Materialized_cursor.

◆ fetch()

virtual bool Server_side_cursor::fetch ( ulong  num_rows)
pure virtual

Implemented in Materialized_cursor.

◆ is_open()

virtual bool Server_side_cursor::is_open ( ) const
pure virtual

Implemented in Materialized_cursor.

◆ open()

virtual int Server_side_cursor::open ( THD thd,
JOIN top_level_join 
)
pure virtual

Implemented in Materialized_cursor.

◆ operator delete() [1/2]

static void Server_side_cursor::operator delete ( void *  ,
MEM_ROOT ,
const std::nothrow_t &   
)
inlinestaticnoexcept

◆ operator delete() [2/2]

void Server_side_cursor::operator delete ( void *  ptr,
size_t  size 
)
static

Member Data Documentation

◆ m_arena

Query_arena Server_side_cursor::m_arena
protected

◆ result

Query_result* Server_side_cursor::result
protected

Row destination used for fetch.


The documentation for this class was generated from the following files: