RefIterator< Reverse > Class Template Reference

For each record on the left side of a join (given in Init()), returns one or more matching rows from the given table, i.e., WHERE column=<ref>. More...

#include <ref_row_iterators.h>

Inheritance diagram for RefIterator< Reverse >:

Public Member Functions
	RefIterator (THD *thd, TABLE *table, Index_lookup *ref, bool use_order, double expected_rows, ha_rows *examined_rows)
	~RefIterator () override
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
bool	Init ()
	Initialize or reinitialize the iterator. More...
int	Read ()
	Read a single row. More...
virtual const IteratorProfiler *	GetProfiler () const
	Get profiling data for this iterator (for 'EXPLAIN ANALYZE'). More...
virtual void	SetOverrideProfiler (const IteratorProfiler *profiler)
virtual RowIterator *	real_iterator ()
	If this iterator is wrapping a different iterator (e.g. More...
virtual const RowIterator *	real_iterator () const
uint64_t	num_init_calls () const
	Returns the number of times Init() has been called on this iterator. More...
uint64_t	num_rows () const
	Returns the number of times Read() has returned a row successfully from this iterator. More...
uint64_t	num_full_reads () const
	Returns the number of times the iterator has been fully read. More...

Private Member Functions
bool	DoInit () override
int	DoRead () override

Private Attributes
Index_lookup *const	m_ref
const bool	m_use_order
const double	m_expected_rows
ha_rows *const	m_examined_rows
bool	m_first_record_since_init
bool	m_is_mvi_unique_filter_enabled

Additional Inherited Members
Protected Member Functions inherited from TableRowIterator
int	HandleError (int error)
void	PrintError (int error)
TABLE *	table () const
Protected Member Functions inherited from RowIterator
THD *	thd () const

Detailed Description

template<bool Reverse>
class RefIterator< Reverse >

For each record on the left side of a join (given in Init()), returns one or more matching rows from the given table, i.e., WHERE column=<ref>.

Constructor & Destructor Documentation

RefIterator()

template<bool Reverse>

RefIterator< Reverse >::RefIterator ( THD *  thd, TABLE *  table, Index_lookup *  ref, bool  use_order, double  expected_rows, ha_rows *  examined_rows  )

inline

~RefIterator()

template<bool Reverse>

RefIterator< Reverse >::~RefIterator ( )

override

Member Function Documentation

DoInit()

template<bool Reverse>

bool RefIterator< Reverse >::DoInit

overrideprivatevirtual

Implements RowIterator.

DoRead()

template<bool Reverse>

int RefIterator< Reverse >::DoRead ( )

overrideprivatevirtual

Implements RowIterator.

Member Data Documentation

m_examined_rows

template<bool Reverse>

ha_rows* const RefIterator< Reverse >::m_examined_rows

private

m_expected_rows

template<bool Reverse>

const double RefIterator< Reverse >::m_expected_rows

private

m_first_record_since_init

template<bool Reverse>

bool RefIterator< Reverse >::m_first_record_since_init

private

m_is_mvi_unique_filter_enabled

template<bool Reverse>

bool RefIterator< Reverse >::m_is_mvi_unique_filter_enabled

private

m_ref

template<bool Reverse>

Index_lookup* const RefIterator< Reverse >::m_ref

private

m_use_order

template<bool Reverse>

const bool RefIterator< Reverse >::m_use_order

private

---

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

• sql/iterators/ref_row_iterators.h
• sql/iterators/ref_row_iterators.cc