MySQL 8.0.31
Source Code Documentation
GeometryIndexRangeScanIterator Class Reference

#include <geometry_index_range_scan.h>

Inheritance diagram for GeometryIndexRangeScanIterator:

Public Member Functions

 GeometryIndexRangeScanIterator (THD *thd, TABLE *table, ha_rows *examined_rows, double expected_rows, uint index_arg, bool need_rows_in_rowid_order_arg, bool reuse_handler_arg, MEM_ROOT *return_mem_root, uint mrr_flags_arg, uint mrr_buf_size_arg, Bounds_checked_array< QUICK_RANGE * > ranges_arg)
int Read () override
 Read a single row. More...
- Public Member Functions inherited from IndexRangeScanIterator
 IndexRangeScanIterator (THD *thd, TABLE *table, ha_rows *examined_rows, double expected_rows, uint index_arg, bool need_rows_in_rowid_order, bool reuse_handler, MEM_ROOT *return_mem_root, uint mrr_flags, uint mrr_buf_size, Bounds_checked_array< QUICK_RANGE * > ranges)
 ~IndexRangeScanIterator () override
 IndexRangeScanIterator (const IndexRangeScanIterator &)=delete
 IndexRangeScanIterator (IndexRangeScanIterator &&)=default
bool Init () override
 Initialize or reinitialize the iterator. More...
int Read () override
 Read a single row. More...
void UnlockRow () override
 The default implementation of unlock-row method of RowIterator, used in all access methods except EQRefIterator. More...
uint get_mrr_flags () const
ucharlast_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 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 IteratorProfilerGetProfiler () const
 Get profiling data for this iterator (for 'EXPLAIN ANALYZE'). More...
virtual void SetOverrideProfiler ([[maybe_unused]] const IteratorProfiler *profiler)
virtual RowIteratorreal_iterator ()
 If this iterator is wrapping a different iterator (e.g. More...
virtual const RowIteratorreal_iterator () const

Private Attributes


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
- Protected Attributes inherited from IndexRangeScanIterator
uint index
bool in_ror_merged_scan
MY_BITMAP column_bitmap
Bounds_checked_array< QUICK_RANGE * > ranges
bool free_file
QUICK_RANGE ** cur_range
QUICK_RANGE_SEQ_CTX qr_traversal_ctx
uint mrr_flags
uint mrr_buf_size
const bool need_rows_in_rowid_order
const bool reuse_handler

Constructor & Destructor Documentation

◆ GeometryIndexRangeScanIterator()

GeometryIndexRangeScanIterator::GeometryIndexRangeScanIterator ( THD thd,
TABLE table,
ha_rows examined_rows,
double  expected_rows,
uint  index_arg,
bool  need_rows_in_rowid_order_arg,
bool  reuse_handler_arg,
MEM_ROOT return_mem_root,
uint  mrr_flags_arg,
uint  mrr_buf_size_arg,
Bounds_checked_array< QUICK_RANGE * >  ranges_arg 

Member Function Documentation

◆ Read()

int GeometryIndexRangeScanIterator::Read ( )

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
-1End of records

Implements RowIterator.

Member Data Documentation

◆ m_examined_rows

ha_rows* GeometryIndexRangeScanIterator::m_examined_rows

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