MySQL 8.4.2
Source Code Documentation
Btree_load::Cursor Struct Referenceabstract

Interface to consume from. More...

#include <btr0load.h>

Inheritance diagram for Btree_load::Cursor:
[legend]

Public Member Functions

 Cursor ()=default
 Constructor. More...
 
virtual ~Cursor ()=default
 Destructor. More...
 
virtual dberr_t fetch (dtuple_t *&dtuple) noexcept=0
 Fetch the current row as a tuple. More...
 
virtual bool duplicates_detected () const noexcept=0
 
virtual dberr_t next () noexcept=0
 Move to the next record. More...
 

Detailed Description

Interface to consume from.

Constructor & Destructor Documentation

◆ Cursor()

Btree_load::Cursor::Cursor ( )
default

Constructor.

◆ ~Cursor()

virtual Btree_load::Cursor::~Cursor ( )
virtualdefault

Destructor.

Member Function Documentation

◆ duplicates_detected()

virtual bool Btree_load::Cursor::duplicates_detected ( ) const
pure virtualnoexcept
Returns
true if duplicates detected.

Implemented in ddl::Load_cursor.

◆ fetch()

virtual dberr_t Btree_load::Cursor::fetch ( dtuple_t *&  dtuple)
pure virtualnoexcept

Fetch the current row as a tuple.

Parameters
[out]dtupleRow represented as a tuple.
Returns
DB_SUCCESS, DB_END_OF_INDEX or error code.

Implemented in ddl::Key_sort_buffer_cursor, ddl::File_cursor, and ddl::Merge_cursor.

◆ next()

virtual dberr_t Btree_load::Cursor::next ( )
pure virtualnoexcept

Move to the next record.

Returns
DB_SUCCESS, DB_END_OF_INDEX or error code.

Implemented in ddl::Key_sort_buffer_cursor, ddl::File_cursor, and ddl::Merge_cursor.


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