ddl::Context::FTS::Sequence Struct Reference

Document ID sequence. More...

#include <ddl0ddl.h>

Inheritance diagram for ddl::Context::FTS::Sequence:

Public Member Functions
virtual	~Sequence () noexcept
	Destructor. More...
virtual doc_id_t	fetch (const dtuple_t *dtuple=nullptr) noexcept=0
	Get the next document ID. More...
virtual doc_id_t	current () noexcept=0
	Get the current document ID. More...
virtual doc_id_t	generated_count () const noexcept=0
virtual doc_id_t	max_doc_id () const noexcept=0
virtual bool	is_generated () const noexcept=0
virtual void	increment () noexcept=0
	Advance the document ID. More...

Public Attributes
doc_id_t	m_doc_id {}
	Current document ID. More...

Detailed Description

Document ID sequence.

Constructor & Destructor Documentation

~Sequence()

ddl::Context::FTS::Sequence::~Sequence ( )

virtualnoexcept

Destructor.

Member Function Documentation

current()

virtual doc_id_t ddl::Context::FTS::Sequence::current ( )

pure virtualnoexcept

Get the current document ID.

Returns

the current document ID.

Implemented in ddl::Gen_sequence, and ddl::Fetch_sequence.

fetch()

virtual doc_id_t ddl::Context::FTS::Sequence::fetch ( const dtuple_t *  dtuple = nullptr )

pure virtualnoexcept

Get the next document ID.

Parameters

[in]

dtuple

Row from which to fetch ID.

Returns

the next document ID.

Implemented in ddl::Fetch_sequence, and ddl::Gen_sequence.

generated_count()

virtual doc_id_t ddl::Context::FTS::Sequence::generated_count ( ) const

pure virtualnoexcept

Returns

the number of document IDs generated.

Implemented in ddl::Gen_sequence, and ddl::Fetch_sequence.

increment()

virtual void ddl::Context::FTS::Sequence::increment ( )

pure virtualnoexcept

Advance the document ID.

Implemented in ddl::Gen_sequence, and ddl::Fetch_sequence.

is_generated()

virtual bool ddl::Context::FTS::Sequence::is_generated ( ) const

pure virtualnoexcept

Returns

true if the document ID is generated, instead of fetched from a column from the row.

Implemented in ddl::Gen_sequence, and ddl::Fetch_sequence.

max_doc_id()

virtual doc_id_t ddl::Context::FTS::Sequence::max_doc_id ( ) const

pure virtualnoexcept

Returns

the maximum document ID seen so far.

Implemented in ddl::Gen_sequence, and ddl::Fetch_sequence.

Member Data Documentation

m_doc_id

doc_id_t ddl::Context::FTS::Sequence::m_doc_id {}

Current document ID.

---

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

• storage/innobase/include/ddl0ddl.h
• storage/innobase/ddl/ddl0ctx.cc