CacheInvalidatorIterator Class Reference

An iterator that helps invalidating caches. More...

#include <composite_iterators.h>

Inheritance diagram for CacheInvalidatorIterator:

Public Member Functions
	CacheInvalidatorIterator (THD *thd, unique_ptr_destroy_only< RowIterator > source_iterator, const std::string &name)
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
int64_t	generation () const
std::string	name () const
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
unique_ptr_destroy_only< RowIterator >	m_source_iterator
int64_t	m_generation = 0
std::string	m_name

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

Detailed Description

An iterator that helps invalidating caches.

Every time a row passes through it or it changes state in any other way, it increments its “generation” counter. This allows MaterializeIterator to see whether any of its dependencies has changed, and then force a rematerialization – this is typically used for LATERAL tables, where we're joining in a derived table that depends on something earlier in the join.

Constructor & Destructor Documentation

CacheInvalidatorIterator()

CacheInvalidatorIterator::CacheInvalidatorIterator ( THD *  thd, unique_ptr_destroy_only< RowIterator >  source_iterator, const std::string &  name  )

inline

Member Function Documentation

generation()

int64_t CacheInvalidatorIterator::generation ( ) const

inline

Init()

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

Implements RowIterator.

name()

std::string CacheInvalidatorIterator::name ( ) const

inline

Read()

int CacheInvalidatorIterator::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 CacheInvalidatorIterator::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 CacheInvalidatorIterator::UnlockRow ( )

inlineoverridevirtual

Implements RowIterator.

Member Data Documentation

m_generation

int64_t CacheInvalidatorIterator::m_generation = 0

private

m_name

std::string CacheInvalidatorIterator::m_name

private

m_source_iterator

unique_ptr_destroy_only<RowIterator> CacheInvalidatorIterator::m_source_iterator

private

---

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

• sql/iterators/composite_iterators.h