duckdb::BlockHandle Class Reference

Inheritance diagram for duckdb::BlockHandle:

Collaboration diagram for duckdb::BlockHandle:

Public Member Functions
	BlockHandle (BlockManager &block_manager, block_id_t block_id, MemoryTag tag)
	BlockHandle (BlockManager &block_manager, block_id_t block_id, MemoryTag tag, unique_ptr< FileBuffer > buffer, DestroyBufferUpon destroy_buffer_upon, idx_t size, BufferPoolReservation &&reservation)
BlockManager &	GetBlockManager () const
	Returns a reference to the block manager.
block_id_t	BlockId () const
	Returns the block id.
idx_t	GetBlockAllocSize () const
	Returns the block allocation size of this block.
idx_t	GetBlockHeaderSize () const
	Returns the block header size including the 8-byte checksum.
idx_t	GetBlockSize () const
const BlockMemory &	GetMemory () const
	Returns a const reference to the memory of a block.
BlockMemory &	GetMemory ()
	Returns a reference to the memory of a block.
weak_ptr< BlockMemory >	GetMemoryWeak () const
	Returns a weak pointer to the memory of a block.
BufferHandle	LoadFromBuffer (BlockLock &l, data_ptr_t data, unique_ptr< FileBuffer > reusable_buffer, BufferPoolReservation reservation)
BufferHandle	Load (QueryContext context, unique_ptr< FileBuffer > buffer=nullptr)
Public Member Functions inherited from duckdb::enable_shared_from_this< BlockHandle >
shared_ptr< BlockHandle >	shared_from_this ()
shared_ptr< BlockHandle const >	shared_from_this () const

Private Attributes
BlockManager &	block_manager
	The block manager, which loads the block.
idx_t	block_alloc_size
idx_t	block_header_size
	The size of the block header, including the checksum.
const block_id_t	block_id
	The block id of the block.
const shared_ptr< BlockMemory >	memory_p
	Pointer to the underlying memory of the block.
BlockMemory &	memory
	Memory for fast access to the block memory.

Additional Inherited Members
Protected Member Functions inherited from duckdb::enable_shared_from_this< BlockHandle >
	enable_shared_from_this (enable_shared_from_this const &) noexcept
enable_shared_from_this &	operator= (enable_shared_from_this const &) noexcept

Member Function Documentation

GetBlockManager()

BlockManager & duckdb::BlockHandle::GetBlockManager ( ) const

inline

Returns a reference to the block manager.

                                          {
        return block_manager;
    }

BlockId()

block_id_t duckdb::BlockHandle::BlockId ( ) const

inline

Returns the block id.

                               {
        return block_id;
    }

GetBlockAllocSize()

idx_t duckdb::BlockHandle::GetBlockAllocSize ( ) const

inline

Returns the block allocation size of this block.

                                    {
        return block_alloc_size;
    }

GetBlockHeaderSize()

idx_t duckdb::BlockHandle::GetBlockHeaderSize ( ) const

inline

Returns the block header size including the 8-byte checksum.

                                     {
        return block_header_size;
    }

GetBlockSize()

idx_t duckdb::BlockHandle::GetBlockSize ( ) const

inline

Returns the size of the block that is available for usage, as determined by the block manager that created the block. The block_alloc_size can differ from the memory_usage for blocks managed by the temporary block manager, thus, this should only be called for persistent blocks.

                               {
        return block_alloc_size - block_header_size;
    }

GetMemory() [1/2]

const BlockMemory & duckdb::BlockHandle::GetMemory ( ) const

inline

Returns a const reference to the memory of a block.

                                         {
        return memory;
    }

GetMemory() [2/2]

BlockMemory & duckdb::BlockHandle::GetMemory ( )

inline

Returns a reference to the memory of a block.

                             {
        return memory;
    }

GetMemoryWeak()

weak_ptr< BlockMemory > duckdb::BlockHandle::GetMemoryWeak ( ) const

inline

Returns a weak pointer to the memory of a block.

                                                {
        return weak_ptr<BlockMemory>(memory_p);
    }

Member Data Documentation

block_alloc_size

idx_t duckdb::BlockHandle::block_alloc_size

private

The block allocation size, which is determined by the block manager creating the block. For non-temporary block managers the block_alloc_size corresponds to the memory_usage. If we are pinning/loading an unloaded block, then we know how much memory to reserve. This is NOT the actual memory available on a block.

---

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

• external/duckdb/duckdb.hpp