MySQL  8.0.27
Source Code Documentation
FakeSingleRowIterator Class Referencefinal

#include <basic_row_iterators.h>

Inheritance diagram for FakeSingleRowIterator:
RowIterator

Public Member Functions

 FakeSingleRowIterator (THD *thd, ha_rows *examined_rows)
 
bool Init () override
 Initialize or reinitialize the iterator. More...
 
int Read () override
 Read a single row. More...
 
void SetNullRowFlag (bool is_null_row[[maybe_unused]]) override
 
void UnlockRow () override
 
- Public Member Functions inherited from RowIterator
 RowIterator (THD *thd)
 
virtual ~RowIterator ()=default
 
virtual void SetNullRowFlag (bool is_null_row)=0
 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...
 
virtual std::string TimingString () const
 
virtual void StartPSIBatchMode ()
 Start performance schema batch mode, if supported (otherwise ignored). More...
 
virtual void EndPSIBatchModeIfStarted ()
 Ends performance schema batch mode, if started. More...
 
virtual RowIteratorreal_iterator ()
 If this iterator is wrapping a different iterator (e.g. More...
 
virtual const RowIteratorreal_iterator () const
 

Private Attributes

bool m_has_row
 
ha_rows *const m_examined_rows
 

Additional Inherited Members

- Protected Member Functions inherited from RowIterator
THDthd () const
 

Constructor & Destructor Documentation

◆ FakeSingleRowIterator()

FakeSingleRowIterator::FakeSingleRowIterator ( THD thd,
ha_rows examined_rows 
)
inline

Member Function Documentation

◆ Init()

bool FakeSingleRowIterator::Init ( )
inlineoverridevirtual

Initialize or reinitialize the iterator.

You must always call Init() before trying a Read() (but Init() does not imply Read()).

You can call Init() multiple times; subsequent calls will rewind the iterator (or reposition it, depending on whether the iterator takes in e.g. a TABLE_REF) and allow you to read the records anew.

Implements RowIterator.

◆ Read()

int FakeSingleRowIterator::Read ( )
inlineoverridevirtual

Read a single row.

The row data is not actually returned from the function; it is put in the table's (or tables', in case of a join) record buffer, ie., table->records[0].

Return values
0OK
-1End of records
1Error

Implements RowIterator.

◆ SetNullRowFlag()

void FakeSingleRowIterator::SetNullRowFlag ( bool is_null_row]  [[maybe_unused])
inlineoverride

◆ UnlockRow()

void FakeSingleRowIterator::UnlockRow ( )
inlineoverridevirtual

Implements RowIterator.

Member Data Documentation

◆ m_examined_rows

ha_rows* const FakeSingleRowIterator::m_examined_rows
private

◆ m_has_row

bool FakeSingleRowIterator::m_has_row
private

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