MySQL  8.0.19
Source Code Documentation
SortFileIterator< Packed_addon_fields > Class Template Referencefinal

Fetch the records from a tempoary file. More...

#include <basic_row_iterators.h>

Inheritance diagram for SortFileIterator< Packed_addon_fields >:
TableRowIterator RowIterator

Public Member Functions

 SortFileIterator (THD *thd, TABLE *table, IO_CACHE *tempfile, Filesort_info *sort, ha_rows *examined_rows)
 
 ~SortFileIterator () override
 
bool Init () override
 Initialize or reinitialize the iterator. More...
 
int Read () override
 Read a result set record from a temporary file after sorting. More...
 
std::vector< std::string > DebugString () const override
 Returns a short string (used for EXPLAIN FORMAT=tree) with user-readable information for this iterator. More...
 
void UnlockRow () override
 
- 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 ()
 
virtual std::vector< Childchildren () const
 List of zero or more iterators which are direct children of this one. More...
 
virtual std::string TimingString () const
 
JOINjoin_for_explain () const
 
void set_join_for_explain (JOIN *join)
 
void set_estimated_cost (double estimated_cost)
 
double estimated_cost () const
 
void set_expected_rows (double expected_rows)
 
double expected_rows () const
 
virtual RowIteratorreal_iterator ()
 If this iterator is wrapping a different iterator (e.g. More...
 
virtual const RowIteratorreal_iterator () const
 

Private Attributes

uchar *const m_rec_buf
 
const uint m_ref_length
 
IO_CACHE *const m_io_cache
 
Filesort_info *const m_sort
 
ha_rows *const m_examined_rows
 

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

template<bool Packed_addon_fields>
class SortFileIterator< Packed_addon_fields >

Fetch the records from a tempoary file.

There used to be a comment here saying “should obviously not really happen other than in strange configurations”, but especially with packed addons and InnoDB (where fetching rows needs a primary key lookup), it's not necessarily suboptimal compared to e.g. SortBufferIndirectIterator.

Constructor & Destructor Documentation

◆ SortFileIterator()

template<bool Packed_addon_fields>
SortFileIterator< Packed_addon_fields >::SortFileIterator ( THD thd,
TABLE table,
IO_CACHE tempfile,
Filesort_info sort,
ha_rows examined_rows 
)

◆ ~SortFileIterator()

template<bool Packed_addon_fields>
SortFileIterator< Packed_addon_fields >::~SortFileIterator
override

Member Function Documentation

◆ DebugString()

template<bool Packed_addon_fields>
vector< string > SortFileIterator< Packed_addon_fields >::DebugString ( ) const
overridevirtual

Returns a short string (used for EXPLAIN FORMAT=tree) with user-readable information for this iterator.

When implementing these, try to avoid internal jargon (e.g. “eq_ref”); prefer things that read like normal, technical English (e.g. “single-row index lookup”).

For certain complex operations, such as MaterializeIterator, there can be multiple strings. If so, they are interpreted as nested operations, with the outermost, last-done operation first and the other ones indented as if they were child iterators.

Callers should use FullDebugString() below, which adds costs (see set_estimated_cost() etc.) if present.

Implements RowIterator.

◆ Init()

template<bool Packed_addon_fields>
bool SortFileIterator< Packed_addon_fields >::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 TABLE_REF) and allow you to read the records anew.

Implements RowIterator.

◆ Read()

template<bool Packed_addon_fields>
int SortFileIterator< Packed_addon_fields >::Read
overridevirtual

Read a result set record from a temporary file after sorting.

The function first reads the next sorted record from the temporary file. into a buffer. If a success it calls a callback function that unpacks the fields values use in the result set from this buffer into their positions in the regular record buffer.

Template Parameters
Packed_addon_fieldsAre the addon fields packed? This is a compile-time constant, to avoid if (....) tests during execution.
Return values
0Record successfully read.
-1There is no record to be read anymore.

Implements RowIterator.

◆ UnlockRow()

template<bool Packed_addon_fields>
void SortFileIterator< Packed_addon_fields >::UnlockRow ( )
inlineoverridevirtual

Implements RowIterator.

Member Data Documentation

◆ m_examined_rows

template<bool Packed_addon_fields>
ha_rows* const SortFileIterator< Packed_addon_fields >::m_examined_rows
private

◆ m_io_cache

template<bool Packed_addon_fields>
IO_CACHE* const SortFileIterator< Packed_addon_fields >::m_io_cache
private

◆ m_rec_buf

template<bool Packed_addon_fields>
uchar* const SortFileIterator< Packed_addon_fields >::m_rec_buf
private

◆ m_ref_length

template<bool Packed_addon_fields>
const uint SortFileIterator< Packed_addon_fields >::m_ref_length
private

◆ m_sort

template<bool Packed_addon_fields>
Filesort_info* const SortFileIterator< Packed_addon_fields >::m_sort
private

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