duckdb::KeyRowIdOutput Struct Reference

Output policy for scanning keys and row IDs. More...

Collaboration diagram for duckdb::KeyRowIdOutput:

Public Member Functions
	KeyRowIdOutput (ArenaAllocator &arena, unsafe_vector< ARTKey > &keys, unsafe_vector< ARTKey > &row_id_keys, const idx_t capacity)
idx_t	Count () const
void	Reset ()
bool	IsFull () const
void	SetKey (const IteratorKey &current_key, const idx_t column_key_len)
void	Add (const row_t rid)

Public Attributes
ArenaAllocator &	arena
unsafe_vector< ARTKey > &	keys
unsafe_vector< ARTKey > &	row_id_keys
const idx_t	capacity
idx_t	count = 0
const_data_ptr_t	key_data = nullptr
idx_t	key_len = 0

Detailed Description

Output policy for scanning keys and row IDs.

Constructor & Destructor Documentation

KeyRowIdOutput()

duckdb::KeyRowIdOutput::KeyRowIdOutput ( ArenaAllocator &  arena, unsafe_vector< ARTKey > &  keys, unsafe_vector< ARTKey > &  row_id_keys, const idx_t  capacity  )

inline

        : arena(arena), keys(keys), row_id_keys(row_id_keys), capacity(capacity) {
    }

Member Function Documentation

Count()

idx_t duckdb::KeyRowIdOutput::Count ( ) const

inline

                        {
        return count;
    }

Reset()

void duckdb::KeyRowIdOutput::Reset ( )

inline

                 {
        count = 0;
        arena.Reset();
    }

IsFull()

bool duckdb::KeyRowIdOutput::IsFull ( ) const

inline

                        {
        D_ASSERT(count >= 0 && count <= capacity);
        return count >= capacity;
    }

SetKey()

void duckdb::KeyRowIdOutput::SetKey ( const IteratorKey &  current_key, const idx_t  column_key_len  )

inline

                                                                            {
        key_data = current_key.Data();
        key_len = column_key_len;
    }

Add()

void duckdb::KeyRowIdOutput::Add ( const row_t  rid )

inline

                              {
        keys[count] = ARTKey::CreateARTKeyFromBytes(arena, key_data, key_len);
        row_id_keys[count] = ARTKey::CreateARTKey<row_t>(arena, rid);
        count++;
    }

---

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

• external/duckdb/duckdb.cpp