duckdb::DictionaryBuffer Class Reference

The DictionaryBuffer holds a selection vector. More...

Inheritance diagram for duckdb::DictionaryBuffer:

Collaboration diagram for duckdb::DictionaryBuffer:

Public Member Functions
	DictionaryBuffer (const SelectionVector &sel)
	DictionaryBuffer (buffer_ptr< SelectionData > data)
	DictionaryBuffer (idx_t count=STANDARD_VECTOR_SIZE)
const SelectionVector &	GetSelVector () const
SelectionVector &	GetSelVector ()
void	SetSelVector (const SelectionVector &vector)
void	SetDictionarySize (idx_t dict_size)
optional_idx	GetDictionarySize () const
void	SetDictionaryId (string id)
const string &	GetDictionaryId () const
Public Member Functions inherited from duckdb::VectorBuffer
	VectorBuffer (VectorBufferType type)
	VectorBuffer (idx_t data_size)
	VectorBuffer (AllocatedData &&data_p)
data_ptr_t	GetData ()
void	SetData (AllocatedData &&new_data)
VectorAuxiliaryData *	GetAuxiliaryData ()
void	SetAuxiliaryData (unique_ptr< VectorAuxiliaryData > aux_data_p)
void	MoveAuxiliaryData (VectorBuffer &source_buffer)
virtual optional_ptr< Allocator >	GetAllocator () const
VectorBufferType	GetBufferType () const
VectorAuxiliaryDataType	GetAuxiliaryDataType () const
template<class TARGET >
TARGET &	Cast ()
template<class TARGET >
const TARGET &	Cast () const

Private Attributes
SelectionVector	sel_vector
optional_idx	dictionary_size
string	dictionary_id
	A unique identifier for the dictionary that can be used to check if two dictionaries are equivalent.

Additional Inherited Members
Static Public Member Functions inherited from duckdb::VectorBuffer
static buffer_ptr< VectorBuffer >	CreateStandardVector (PhysicalType type, idx_t capacity=STANDARD_VECTOR_SIZE)
static buffer_ptr< VectorBuffer >	CreateConstantVector (PhysicalType type)
static buffer_ptr< VectorBuffer >	CreateConstantVector (const LogicalType &logical_type)
static buffer_ptr< VectorBuffer >	CreateStandardVector (const LogicalType &logical_type, idx_t capacity=STANDARD_VECTOR_SIZE)
Protected Attributes inherited from duckdb::VectorBuffer
VectorBufferType	buffer_type
unique_ptr< VectorAuxiliaryData >	aux_data
AllocatedData	data

Detailed Description

The DictionaryBuffer holds a selection vector.

Constructor & Destructor Documentation

DictionaryBuffer() [1/3]

duckdb::DictionaryBuffer::DictionaryBuffer ( const SelectionVector &  sel )

inlineexplicit

        : VectorBuffer(VectorBufferType::DICTIONARY_BUFFER), sel_vector(sel) {
    }

DictionaryBuffer() [2/3]

duckdb::DictionaryBuffer::DictionaryBuffer ( buffer_ptr< SelectionData >  data )

inlineexplicit

        : VectorBuffer(VectorBufferType::DICTIONARY_BUFFER), sel_vector(std::move(data)) {
    }

DictionaryBuffer() [3/3]

duckdb::DictionaryBuffer::DictionaryBuffer ( idx_t  count = STANDARD_VECTOR_SIZE )

inlineexplicit

        : VectorBuffer(VectorBufferType::DICTIONARY_BUFFER), sel_vector(count) {
    }

Member Function Documentation

GetSelVector() [1/2]

const SelectionVector & duckdb::DictionaryBuffer::GetSelVector ( ) const

inline

                                                {
        return sel_vector;
    }

GetSelVector() [2/2]

SelectionVector & duckdb::DictionaryBuffer::GetSelVector ( )

inline

                                    {
        return sel_vector;
    }

SetSelVector()

void duckdb::DictionaryBuffer::SetSelVector ( const SelectionVector &  vector )

inline

                                                     {
        this->sel_vector.Initialize(vector);
    }

SetDictionarySize()

void duckdb::DictionaryBuffer::SetDictionarySize ( idx_t  dict_size )

inline

                                            {
        dictionary_size = dict_size;
    }

GetDictionarySize()

optional_idx duckdb::DictionaryBuffer::GetDictionarySize ( ) const

inline

                                           {
        return dictionary_size;
    }

SetDictionaryId()

void duckdb::DictionaryBuffer::SetDictionaryId ( string  id )

inline

                                    {
        dictionary_id = std::move(id);
    }

GetDictionaryId()

const string & duckdb::DictionaryBuffer::GetDictionaryId ( ) const

inline

                                          {
        return dictionary_id;
    }

---

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

• external/duckdb/duckdb.hpp