RowIDIntersectionIterator Class Reference

#include <rowid_ordered_retrieval.h>

Inheritance diagram for RowIDIntersectionIterator:

Public Member Functions
	RowIDIntersectionIterator (THD *thd, MEM_ROOT *return_mem_root, TABLE *table_arg, bool retrieve_full_rows, bool need_rows_in_rowid_order, Mem_root_array< unique_ptr_destroy_only< RowIterator > > children, unique_ptr_destroy_only< RowIterator > cpk_child)
	~RowIDIntersectionIterator () override
bool	Init () override
	Initialize or reinitialize the iterator. More...
int	Read () override
	Read a single row. More...
uchar *	last_rowid () const override
Public Member Functions inherited from RowIDCapableRowIterator
	RowIDCapableRowIterator (THD *thd, TABLE *table)
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 const IteratorProfiler *	GetProfiler () const
	Get profiling data for this iterator (for 'EXPLAIN ANALYZE'). More...
virtual void	SetOverrideProfiler ([[maybe_unused]] const IteratorProfiler *profiler)
virtual RowIterator *	real_iterator ()
	If this iterator is wrapping a different iterator (e.g. More...
virtual const RowIterator *	real_iterator () const

Private Member Functions
bool	init_ror_merged_scan ()

Private Attributes
Mem_root_array< unique_ptr_destroy_only< RowIterator > >	m_children
unique_ptr_destroy_only< RowIterator >	m_cpk_child
bool	retrieve_full_rows
bool	scans_inited
const bool	need_rows_in_rowid_order
uchar *	m_last_rowid
bool	inited = false

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

Constructor & Destructor Documentation

RowIDIntersectionIterator()

RowIDIntersectionIterator::RowIDIntersectionIterator	(	THD *	thd,
		MEM_ROOT *	return_mem_root,
		TABLE *	table_arg,
		bool	retrieve_full_rows,
		bool	need_rows_in_rowid_order,
		Mem_root_array< unique_ptr_destroy_only< RowIterator > >	children,
		unique_ptr_destroy_only< RowIterator >	cpk_child
	)

~RowIDIntersectionIterator()

RowIDIntersectionIterator::~RowIDIntersectionIterator ( )

override

Member Function Documentation

Init()

bool RowIDIntersectionIterator::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.

init_ror_merged_scan()

bool RowIDIntersectionIterator::init_ror_merged_scan ( )

private

last_rowid()

uchar * RowIDIntersectionIterator::last_rowid ( ) const

inlineoverridevirtual

Implements RowIDCapableRowIterator.

Read()

int RowIDIntersectionIterator::Read ( )

overridevirtual

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.

Member Data Documentation

inited

bool RowIDIntersectionIterator::inited = false

private

m_children

Mem_root_array<unique_ptr_destroy_only<RowIterator> > RowIDIntersectionIterator::m_children

private

m_cpk_child

unique_ptr_destroy_only<RowIterator> RowIDIntersectionIterator::m_cpk_child

private

m_last_rowid

uchar* RowIDIntersectionIterator::m_last_rowid

private

need_rows_in_rowid_order

const bool RowIDIntersectionIterator::need_rows_in_rowid_order

private

retrieve_full_rows

bool RowIDIntersectionIterator::retrieve_full_rows

private

scans_inited

bool RowIDIntersectionIterator::scans_inited

private

---

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

• sql/range_optimizer/rowid_ordered_retrieval.h
• sql/range_optimizer/rowid_ordered_retrieval.cc