MySQL 8.0.32
Source Code Documentation
ddl::Fetch_sequence Struct Reference

Fetch the document ID from the table. More...

#include <ddl0impl.h>

Inheritance diagram for ddl::Fetch_sequence:
[legend]

Public Member Functions

 Fetch_sequence (dict_index_t *index) noexcept
 Constructor. More...
 
 ~Fetch_sequence () noexcept override
 Destructor. More...
 
doc_id_t current () noexcept override
 Not supported. More...
 
void increment () noexcept override
 Not supported. More...
 
doc_id_t fetch (const dtuple_t *dtuple) noexcept override
 Get the next document ID. More...
 
doc_id_t generated_count () const noexcept override
 
doc_id_t max_doc_id () const noexcept override
 
bool is_generated () const noexcept override
 
- Public Member Functions inherited from ddl::Context::FTS::Sequence
virtual ~Sequence () noexcept
 Destructor. More...
 

Public Attributes

dict_index_tm_index {}
 The document ID index. More...
 
doc_id_t m_max_doc_id {}
 Maximum document ID seen so far. More...
 
- Public Attributes inherited from ddl::Context::FTS::Sequence
doc_id_t m_doc_id {}
 Current document ID. More...
 

Detailed Description

Fetch the document ID from the table.

Constructor & Destructor Documentation

◆ Fetch_sequence()

ddl::Fetch_sequence::Fetch_sequence ( dict_index_t index)
inlineexplicitnoexcept

Constructor.

Parameters
[in]indexDocument ID index.

◆ ~Fetch_sequence()

ddl::Fetch_sequence::~Fetch_sequence ( )
inlineoverridenoexcept

Destructor.

Member Function Documentation

◆ current()

doc_id_t ddl::Fetch_sequence::current ( )
inlineoverridevirtualnoexcept

Not supported.

Returns
the current document ID.

Implements ddl::Context::FTS::Sequence.

◆ fetch()

doc_id_t ddl::Fetch_sequence::fetch ( const dtuple_t dtuple)
overridevirtualnoexcept

Get the next document ID.

Parameters
[in]dtupleRow from which to fetch ID.
Returns
the document ID from the row.

Implements ddl::Context::FTS::Sequence.

◆ generated_count()

doc_id_t ddl::Fetch_sequence::generated_count ( ) const
inlineoverridevirtualnoexcept
Returns
the number of document IDs generated.

Implements ddl::Context::FTS::Sequence.

◆ increment()

void ddl::Fetch_sequence::increment ( )
inlineoverridevirtualnoexcept

Not supported.

Implements ddl::Context::FTS::Sequence.

◆ is_generated()

bool ddl::Fetch_sequence::is_generated ( ) const
inlineoverridevirtualnoexcept
Returns
false, because we never generate the document ID.

Implements ddl::Context::FTS::Sequence.

◆ max_doc_id()

doc_id_t ddl::Fetch_sequence::max_doc_id ( ) const
inlineoverridevirtualnoexcept
Returns
the maximum document ID seen so far.

Implements ddl::Context::FTS::Sequence.

Member Data Documentation

◆ m_index

dict_index_t* ddl::Fetch_sequence::m_index {}

The document ID index.

◆ m_max_doc_id

doc_id_t ddl::Fetch_sequence::m_max_doc_id {}

Maximum document ID seen so far.


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