AlternativeIterator Class Reference

An iterator that switches between another iterator (typically a RefIterator or similar) and a TableScanIterator. More...

#include <ref_row_iterators.h>

Inheritance diagram for AlternativeIterator:

Public Member Functions
	AlternativeIterator (THD *thd, TABLE *table, unique_ptr_destroy_only< RowIterator > source, unique_ptr_destroy_only< RowIterator > table_scan_iterator, Index_lookup *ref)
bool	Init () override
	Initialize or reinitialize the iterator. More...
int	Read () override
	Read a single row. 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	UnlockRow () override
Public Member Functions inherited from RowIterator
	RowIterator (THD *thd)
virtual	~RowIterator ()=default
	RowIterator (const RowIterator &)=delete
	RowIterator (RowIterator &&)=default
virtual const IteratorProfiler *	GetProfiler () const
	Get profiling data for this iterator (for 'EXPLAIN ANALYZE'). More...
virtual void	SetOverrideProfiler ([[maybe_unused]] const IteratorProfiler *profiler)
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 RowIterator *	real_iterator ()
	If this iterator is wrapping a different iterator (e.g. More...
virtual const RowIterator *	real_iterator () const

Private Attributes
std::vector< bool * >	m_applicable_cond_guards
RowIterator *	m_iterator = nullptr
RowIterator *	m_last_iterator_inited = nullptr
unique_ptr_destroy_only< RowIterator >	m_source_iterator
unique_ptr_destroy_only< RowIterator >	m_table_scan_iterator
TABLE *const	m_table

Additional Inherited Members
Protected Member Functions inherited from RowIterator
THD *	thd () const

Detailed Description

An iterator that switches between another iterator (typically a RefIterator or similar) and a TableScanIterator.

This is used when predicates have been pushed down into an IN subquery and then created ref accesses, but said predicates should not be checked for a NULL value (so we need to revert to table scans). See QEP_TAB::access_path() for a more thorough explanation.

Constructor & Destructor Documentation

AlternativeIterator()

AlternativeIterator::AlternativeIterator	(	THD *	thd,
		TABLE *	table,
		unique_ptr_destroy_only< RowIterator >	source,
		unique_ptr_destroy_only< RowIterator >	table_scan_iterator,
		Index_lookup *	ref
	)

Member Function Documentation

Init()

bool AlternativeIterator::Init ( )

overridevirtual

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 Index_lookup) and allow you to read the records anew.

Implements RowIterator.

Read()

int AlternativeIterator::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

0	OK
-1	End of records
1	Error

Implements RowIterator.

SetNullRowFlag()

void AlternativeIterator::SetNullRowFlag ( bool  is_null_row )

inlineoverridevirtual

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).

This is used for outer joins, when an iterator hasn't produced any rows and we need to produce a NULL-complemented row. Init() or Read() won't necessarily reset this flag, so if you ever set is to true, make sure to also set it to false when needed.

Note that this can be called without Init() having been called first. For example, NestedLoopIterator can hit EOF immediately on the outer iterator, which means the inner iterator doesn't get an Init() call, but will still forward SetNullRowFlag to both inner and outer iterators.

TODO: We shouldn't need this. See the comments on AggregateIterator for a bit more discussion on abstracting out a row interface.

Implements RowIterator.

UnlockRow()

void AlternativeIterator::UnlockRow ( )

inlineoverridevirtual

Implements RowIterator.

Member Data Documentation

m_applicable_cond_guards

std::vector<bool *> AlternativeIterator::m_applicable_cond_guards

private

m_iterator

RowIterator* AlternativeIterator::m_iterator = nullptr

private

m_last_iterator_inited

RowIterator* AlternativeIterator::m_last_iterator_inited = nullptr

private

m_source_iterator

unique_ptr_destroy_only<RowIterator> AlternativeIterator::m_source_iterator

private

m_table

TABLE* const AlternativeIterator::m_table

private

m_table_scan_iterator

unique_ptr_destroy_only<RowIterator> AlternativeIterator::m_table_scan_iterator

private

---

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

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