duckdb::Iterator Class Reference

Collaboration diagram for duckdb::Iterator:

Classes
struct	ResumeScanState

Public Member Functions
	Iterator (ART &art)
template<typename Output >
ARTScanResult	Scan (const ARTKey &upper_bound, Output &output, bool equal)
void	FindMinimum (const Node &node)
	Finds the minimum (leaf) of the current subtree.
bool	LowerBound (const Node &node, const ARTKey &key, const bool equal)
uint8_t	GetNestedDepth () const
	Returns the nested depth.

Public Attributes
IteratorKey	current_key
	Holds the current key leading down to the top node on the stack.

Static Public Attributes
static constexpr uint8_t	ROW_ID_SIZE = sizeof(row_t)

Private Member Functions
bool	Next ()
void	PopNode ()
	Pop the top node from the stack of iterator entries and adjust the current key.

Private Attributes
ART &	art
	The ART.
stack< IteratorEntry >	nodes
	Stack of nodes from the root to the currently active node.
Node	last_leaf = Node()
	Last visited leaf node.
uint8_t	row_id [ROW_ID_SIZE]
	Holds the row ID of nested leaves.
GateStatus	status
	True, if we passed a gate.
uint8_t	nested_depth = 0
	Depth in a nested leaf.
bool	entered_nested_leaf = false
	True, if we entered a nested leaf to retrieve the next node.
ResumeScanState	resume_state

Constructor & Destructor Documentation

Iterator()

duckdb::Iterator::Iterator ( ART &  art )

inlineexplicit

: art(art), status(GateStatus::GATE_NOT_SET) {};

Member Function Documentation

Scan()

template<typename Output >

ARTScanResult duckdb::Iterator::Scan	(	const ARTKey &	upper_bound,
		Output &	output,
		bool	equal
	)

Templated scan implementation. Output policy defines how results are emitted. Returns COMPLETED if scan finished, PAUSED if stopped due to output capacity.

LowerBound()

bool duckdb::Iterator::LowerBound	(	const Node &	node,
		const ARTKey &	key,
		const bool	equal
	)

Finds the lower bound of the ART and adds the nodes to the stack. Returns false, if the lower bound exceeds the maximum value of the ART.

GetNestedDepth()

uint8_t duckdb::Iterator::GetNestedDepth ( ) const

inline

Returns the nested depth.

                                   {
        return nested_depth;
    }

Next()

bool duckdb::Iterator::Next ( )

private

Goes to the next leaf in the ART and sets it as last_leaf, returns false if there is no next leaf.

---

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

• external/duckdb/duckdb.cpp