duckdb::VectorBuffer Class Reference

The VectorBuffer is a class used by the vector to hold its data. More...

Inheritance diagram for duckdb::VectorBuffer:

Collaboration diagram for duckdb::VectorBuffer:

Public Member Functions
	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

Static Public Member Functions
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
VectorBufferType	buffer_type
unique_ptr< VectorAuxiliaryData >	aux_data
AllocatedData	data

Detailed Description

The VectorBuffer is a class used by the vector to hold its data.

Constructor & Destructor Documentation

VectorBuffer() [1/4]

duckdb::VectorBuffer::VectorBuffer ( VectorBufferType  type )

inlineexplicit

                                                 : buffer_type(type) {
    }

VectorBuffer() [2/4]

duckdb::VectorBuffer::VectorBuffer ( idx_t  data_size )

inlineexplicit

                                           : buffer_type(VectorBufferType::STANDARD_BUFFER) {
        if (data_size > 0) {
            data = Allocator::DefaultAllocator().Allocate(data_size);
        }
    }

VectorBuffer() [3/4]

duckdb::VectorBuffer::VectorBuffer ( AllocatedData &&  data_p )

inlineexplicit

        : buffer_type(VectorBufferType::STANDARD_BUFFER), data(std::move(data_p)) {
    }

~VectorBuffer()

virtual duckdb::VectorBuffer::~VectorBuffer ( )

inlinevirtual

                            {
    }

VectorBuffer() [4/4]

duckdb::VectorBuffer::VectorBuffer ( )

inline

                   {
    }

Member Function Documentation

GetData()

data_ptr_t duckdb::VectorBuffer::GetData ( )

inline

                         {
        return data.get();
    }

SetData()

void duckdb::VectorBuffer::SetData ( AllocatedData &&  new_data )

inline

                                           {
        data = std::move(new_data);
    }

GetAuxiliaryData()

VectorAuxiliaryData * duckdb::VectorBuffer::GetAuxiliaryData ( )

inline

                                            {
        return aux_data.get();
    }

SetAuxiliaryData()

void duckdb::VectorBuffer::SetAuxiliaryData ( unique_ptr< VectorAuxiliaryData >  aux_data_p )

inline

                                                                      {
        aux_data = std::move(aux_data_p);
    }

MoveAuxiliaryData()

void duckdb::VectorBuffer::MoveAuxiliaryData ( VectorBuffer &  source_buffer )

inline

                                                        {
        SetAuxiliaryData(std::move(source_buffer.aux_data));
    }

GetAllocator()

virtual optional_ptr< Allocator > duckdb::VectorBuffer::GetAllocator ( ) const

inlinevirtual

                                                         {
        return data.GetAllocator();
    }

GetBufferType()

VectorBufferType duckdb::VectorBuffer::GetBufferType ( ) const

inline

                                                  {
        return buffer_type;
    }

GetAuxiliaryDataType()

VectorAuxiliaryDataType duckdb::VectorBuffer::GetAuxiliaryDataType ( ) const

inline

                                                                {
        return aux_data->type;
    }

Cast() [1/2]

template<class TARGET >

TARGET & duckdb::VectorBuffer::Cast ( )

inline

                   {
        DynamicCastCheck<TARGET>(this);
        return reinterpret_cast<TARGET &>(*this);
    }

Cast() [2/2]

template<class TARGET >

const TARGET & duckdb::VectorBuffer::Cast ( ) const

inline

                               {
        DynamicCastCheck<TARGET>(this);
        return reinterpret_cast<const TARGET &>(*this);
    }

---

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

• external/duckdb/duckdb.hpp