MySQL 9.5.0
Source Code Documentation
IndexDistanceScanIterator Class Referencefinal

Perform a distance index scan along an index. More...

#include <basic_row_iterators.h>

Inheritance diagram for IndexDistanceScanIterator:
[legend]

Public Member Functions

 IndexDistanceScanIterator (THD *thd, TABLE *table, int idx, QUICK_RANGE *query_mbr, double expected_rows, ha_rows *examined_rows)
 
- 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 IteratorProfilerGetProfiler () const
 Get profiling data for this iterator (for 'EXPLAIN ANALYZE'). More...
 
virtual void SetOverrideProfiler (const IteratorProfiler *profiler)
 
virtual RowIteratorreal_iterator ()
 If this iterator is wrapping a different iterator (e.g. More...
 
virtual const RowIteratorreal_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

uchar *const m_record
 
const int m_idx
 
QUICK_RANGEm_query_mbr
 
const double m_expected_rows
 
ha_rows *const m_examined_rows
 
bool m_first = true
 

Additional Inherited Members

- Protected Member Functions inherited from TableRowIterator
int HandleError (int error)
 
void PrintError (int error)
 
TABLEtable () const
 
- Protected Member Functions inherited from RowIterator
THDthd () const
 

Detailed Description

Perform a distance index scan along an index.

For now it is just like the IndexScanIterator, waiting for innodb implementation of distance index scan functions

Constructor & Destructor Documentation

◆ IndexDistanceScanIterator()

IndexDistanceScanIterator::IndexDistanceScanIterator ( THD thd,
TABLE table,
int  idx,
QUICK_RANGE query_mbr,
double  expected_rows,
ha_rows examined_rows 
)

Member Function Documentation

◆ DoInit()

bool IndexDistanceScanIterator::DoInit ( )
overrideprivatevirtual

Implements RowIterator.

◆ DoRead()

int IndexDistanceScanIterator::DoRead ( )
overrideprivatevirtual

Implements RowIterator.

Member Data Documentation

◆ m_examined_rows

ha_rows* const IndexDistanceScanIterator::m_examined_rows
private

◆ m_expected_rows

const double IndexDistanceScanIterator::m_expected_rows
private

◆ m_first

bool IndexDistanceScanIterator::m_first = true
private

◆ m_idx

const int IndexDistanceScanIterator::m_idx
private

◆ m_query_mbr

QUICK_RANGE* IndexDistanceScanIterator::m_query_mbr
private

◆ m_record

uchar* const IndexDistanceScanIterator::m_record
private

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