duckdb::ColumnDataAllocator Class Reference

Collaboration diagram for duckdb::ColumnDataAllocator:

Public Member Functions
	ColumnDataAllocator (Allocator &allocator)
	ColumnDataAllocator (BufferManager &buffer_manager, ColumnDataCollectionLifetime lifetime=ColumnDataCollectionLifetime::REGULAR)
	ColumnDataAllocator (ClientContext &context, ColumnDataAllocatorType allocator_type, ColumnDataCollectionLifetime lifetime=ColumnDataCollectionLifetime::REGULAR)
	ColumnDataAllocator (ColumnDataAllocator &allocator)
Allocator &	GetAllocator ()
BufferManager &	GetBufferManager ()
	Returns the buffer manager, if this is not an in-memory allocation.
ColumnDataAllocatorType	GetType ()
	Returns the allocator type.
void	MakeShared ()
bool	IsShared () const
idx_t	BlockCount () const
idx_t	SizeInBytes () const
idx_t	AllocationSize () const
void	SetPartitionIndex (idx_t index)
	Sets the partition index of this tuple data collection.
void	AllocateData (idx_t size, uint32_t &block_id, uint32_t &offset, ChunkManagementState *chunk_state)
void	Initialize (ColumnDataAllocator &other)
void	InitializeChunkState (ChunkManagementState &state, ChunkMetaData &meta_data)
data_ptr_t	GetDataPointer (ChunkManagementState &state, uint32_t block_id, uint32_t offset)
void	UnswizzlePointers (ChunkManagementState &state, Vector &result, SwizzleMetaData &swizzle_segment, const VectorMetaData &string_heap_segment, const idx_t &v_offset, const bool &copied)
void	SetDestroyBufferUponUnpin (uint32_t block_id)
	Prevents the block with the given id from being added to the eviction queue.
shared_ptr< DatabaseInstance >	GetDatabase () const
	Gets a shared pointer to the database instance if ColumnDataCollectionLifetime::DATABASE_INSTANCE.

Private Member Functions
void	AllocateEmptyBlock (idx_t size)
BufferHandle	AllocateBlock (idx_t size)
BufferHandle	Pin (uint32_t block_id)
bool	HasBlocks () const
void	AllocateBuffer (idx_t size, uint32_t &block_id, uint32_t &offset, ChunkManagementState *chunk_state)
void	AllocateMemory (idx_t size, uint32_t &block_id, uint32_t &offset, ChunkManagementState *chunk_state)
void	AssignPointer (uint32_t &block_id, uint32_t &offset, data_ptr_t pointer)

Private Attributes
ColumnDataAllocatorType	type
union {
Allocator *   allocator
	The allocator object (if this is a IN_MEMORY_ALLOCATOR)
BufferManager *   buffer_manager
	The buffer manager (if this is a BUFFER_MANAGER_ALLOCATOR)
}	alloc
vector< BlockMetaData >	blocks
	The set of blocks used by the column data collection.
vector< AllocatedData >	allocated_data
	The set of allocated data.
bool	shared = false
	Whether this ColumnDataAllocator is shared across ColumnDataCollections that allocate in parallel.
mutex	lock
	Lock used in case this ColumnDataAllocator is shared across threads.
idx_t	allocated_size = 0
	Total allocated size.
optional_idx	partition_index
	Partition index (optional, if partitioned)
ManagedResultSet	managed_result_set
	Lifetime management for this allocator.

Member Function Documentation

GetAllocator()

Allocator & duckdb::ColumnDataAllocator::GetAllocator

(

)

Returns an allocator object to allocate with. This returns the allocator in IN_MEMORY_ALLOCATOR, and a buffer allocator in case of BUFFER_MANAGER_ALLOCATOR.

GetType()

ColumnDataAllocatorType duckdb::ColumnDataAllocator::GetType ( )

inline

Returns the allocator type.

                                      {
        return type;
    }

MakeShared()

void duckdb::ColumnDataAllocator::MakeShared ( )

inline

                      {
        shared = true;
    }

IsShared()

bool duckdb::ColumnDataAllocator::IsShared ( ) const

inline

                          {
        return shared;
    }

BlockCount()

idx_t duckdb::ColumnDataAllocator::BlockCount ( ) const

inline

                             {
        return blocks.size();
    }

SizeInBytes()

idx_t duckdb::ColumnDataAllocator::SizeInBytes ( ) const

inline

                              {
        idx_t total_size = 0;
        for (const auto &block : blocks) {
            total_size += block.size;
        }
        return total_size;
    }

AllocationSize()

idx_t duckdb::ColumnDataAllocator::AllocationSize ( ) const

inline

                                 {
        return allocated_size;
    }

SetPartitionIndex()

void duckdb::ColumnDataAllocator::SetPartitionIndex ( idx_t  index )

inline

Sets the partition index of this tuple data collection.

                                        {
        D_ASSERT(!partition_index.IsValid());
        D_ASSERT(blocks.empty() && allocated_data.empty());
        partition_index = index;
    }

HasBlocks()

bool duckdb::ColumnDataAllocator::HasBlocks ( ) const

inlineprivate

                           {
        return !blocks.empty();
    }

---

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

• external/duckdb/duckdb.hpp