MySQL 8.0.30
Source Code Documentation
RowIDCapableRowIterator Class Referenceabstract

An interface for RowIterators that have a given row ID, ie., they can be children in ROR (rowid-ordered) scans. More...

#include <rowid_capable_row_iterator.h>

Inheritance diagram for RowIDCapableRowIterator:
[legend]

Public Member Functions

 RowIDCapableRowIterator (THD *thd, TABLE *table)
 
virtual ucharlast_rowid () const =0
 
- Public Member Functions inherited from TableRowIterator
 TableRowIterator (THD *thd, TABLE *table)
 
void UnlockRow () override
 The default implementation of unlock-row method of RowIterator, used in all access methods except EQRefIterator. More...
 
void SetNullRowFlag (bool is_null_row) override
 Mark the current row buffer as containing a NULL row or not, so that if you read from it and the flag is true, you'll get only NULLs no matter what is actually in the buffer (typically some old leftover row). More...
 
void StartPSIBatchMode () override
 Start performance schema batch mode, if supported (otherwise ignored). More...
 
void EndPSIBatchModeIfStarted () override
 Ends performance schema batch mode, if started. More...
 
- Public Member Functions inherited from RowIterator
 RowIterator (THD *thd)
 
virtual ~RowIterator ()=default
 
 RowIterator (const RowIterator &)=delete
 
 RowIterator (RowIterator &&)=default
 
virtual bool Init ()=0
 Initialize or reinitialize the iterator. More...
 
virtual int Read ()=0
 Read a single row. More...
 
virtual const IteratorProfilerGetProfiler () const
 Get profiling data for this iterator (for 'EXPLAIN ANALYZE'). More...
 
virtual void SetOverrideProfiler ([[maybe_unused]] const IteratorProfiler *profiler)
 
virtual RowIteratorreal_iterator ()
 If this iterator is wrapping a different iterator (e.g. More...
 
virtual const RowIteratorreal_iterator () const
 

Additional Inherited Members

- Protected Member Functions inherited from TableRowIterator
int HandleError (int error)
 
void PrintError (int error)
 
TABLEtable () const
 
- Protected Member Functions inherited from RowIterator
THDthd () const
 

Detailed Description

An interface for RowIterators that have a given row ID, ie., they can be children in ROR (rowid-ordered) scans.

The only examples of this are QUICK_RANGE_SCAN_SELECT and RowIDIntersectionIterator (which itself can also be a parent).

Constructor & Destructor Documentation

◆ RowIDCapableRowIterator()

RowIDCapableRowIterator::RowIDCapableRowIterator ( THD thd,
TABLE table 
)
inline

Member Function Documentation

◆ last_rowid()

virtual uchar * RowIDCapableRowIterator::last_rowid ( ) const
pure virtual

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