duckdb::VectorStringBuffer Class Reference

Inheritance diagram for duckdb::VectorStringBuffer:

Collaboration diagram for duckdb::VectorStringBuffer:

Public Member Functions
	VectorStringBuffer (Allocator &allocator)
	VectorStringBuffer (VectorBufferType type)
string_t	AddString (const char *data, idx_t len)
string_t	AddString (string_t data)
string_t	AddBlob (string_t data)
string_t	EmptyString (idx_t len)
ArenaAllocator &	GetStringAllocator ()
data_ptr_t	AllocateShrinkableBuffer (idx_t alloc_len)
string_t	FinalizeShrinkableBuffer (data_ptr_t buffer, idx_t alloc_len, idx_t str_len)
void	AddHeapReference (buffer_ptr< VectorBuffer > heap)
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
StringHeap	heap
	The string heap of this buffer.
vector< buffer_ptr< VectorBuffer > >	references
	References to additional vector buffers referenced by this string buffer.

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

Member Function Documentation

AddString() [1/2]

string_t duckdb::VectorStringBuffer::AddString ( const char *  data, idx_t  len  )

inline

                                                    {
        return heap.AddString(data, len);
    }

AddString() [2/2]

string_t duckdb::VectorStringBuffer::AddString ( string_t  data )

inline

                                      {
        return heap.AddString(data);
    }

AddBlob()

string_t duckdb::VectorStringBuffer::AddBlob ( string_t  data )

inline

                                    {
        return heap.AddBlob(data.GetData(), data.GetSize());
    }

EmptyString()

string_t duckdb::VectorStringBuffer::EmptyString ( idx_t  len )

inline

                                    {
        return heap.EmptyString(len);
    }

GetStringAllocator()

ArenaAllocator & duckdb::VectorStringBuffer::GetStringAllocator ( )

inline

                                         {
        return heap.GetAllocator();
    }

AllocateShrinkableBuffer()

data_ptr_t duckdb::VectorStringBuffer::AllocateShrinkableBuffer ( idx_t  alloc_len )

inline

Allocate a buffer to store up to "len" bytes for a string This can be turned into a proper string by using FinalizeBuffer afterwards Note that alloc_len only has to be an upper bound, the final string may be smaller

                                                         {
        auto &allocator = heap.GetAllocator();
        return allocator.Allocate(alloc_len);
    }

FinalizeShrinkableBuffer()

string_t duckdb::VectorStringBuffer::FinalizeShrinkableBuffer ( data_ptr_t  buffer, idx_t  alloc_len, idx_t  str_len  )

inline

Finalize a buffer allocated with AllocateShrinkableBuffer into a string of size str_len str_len must be <= alloc_len

                                                                                         {
        auto &allocator = heap.GetAllocator();
        D_ASSERT(str_len <= alloc_len);
        D_ASSERT(buffer == allocator.GetHead()->data.get() + allocator.GetHead()->current_position - alloc_len);
        bool is_not_inlined = str_len > string_t::INLINE_LENGTH;
        idx_t shrink_count = alloc_len - (str_len * is_not_inlined);
        allocator.ShrinkHead(shrink_count);
        return string_t(const_char_ptr_cast(buffer), UnsafeNumericCast<uint32_t>(str_len));
    }

AddHeapReference()

void duckdb::VectorStringBuffer::AddHeapReference ( buffer_ptr< VectorBuffer >  heap )

inline

                                                         {
        references.push_back(std::move(heap));
    }

---

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

• external/duckdb/duckdb.hpp