duckdb::IndexStorageInfo Struct Reference

Index (de)serialization information. More...

#include <duckdb.hpp>

Collaboration diagram for duckdb::IndexStorageInfo:

Public Member Functions
	IndexStorageInfo (const string &name)
	IndexStorageInfo (const IndexStorageInfo &)=delete
	Disable copy constructor and copy assignment, this type's lifetime is explicitly managed.
IndexStorageInfo &	operator= (const IndexStorageInfo &)=delete
	IndexStorageInfo (IndexStorageInfo &&)=default
IndexStorageInfo &	operator= (IndexStorageInfo &&)=default
bool	IsValid () const
void	Serialize (Serializer &serializer) const

Static Public Member Functions
static IndexStorageInfo	Deserialize (Deserializer &deserializer)

Public Attributes
string	name
	The name.
idx_t	root
	The storage root.
case_insensitive_map_t< Value >	options
	Any index specialization can provide additional key-Value settings via this map.
vector< FixedSizeAllocatorInfo >	allocator_infos
	Serialization information for fixed-size allocator memory.
vector< vector< IndexBufferInfo > >	buffers
BlockPointer	root_block_ptr
	The root block pointer of the index. Necessary to support older storage files.

Detailed Description

Index (de)serialization information.

Constructor & Destructor Documentation

IndexStorageInfo() [1/2]

duckdb::IndexStorageInfo::IndexStorageInfo ( )

inline

{};

IndexStorageInfo() [2/2]

duckdb::IndexStorageInfo::IndexStorageInfo ( const string &  name )

inlineexplicit

: name(name) {};

Member Function Documentation

IsValid()

bool duckdb::IndexStorageInfo::IsValid ( ) const

inline

Returns true, if IndexStorageInfo holds information to deserialize an index. Note that the name can be misleading - any index that is empty (no nodes, etc.) might also have neither a root_block_ptr nor allocator_infos. Ensure that your index constructor initializes an empty index correctly without the need for these fields.

                         {
        return root_block_ptr.IsValid() || !allocator_infos.empty();
    }

Member Data Documentation

buffers

vector<vector<IndexBufferInfo> > duckdb::IndexStorageInfo::buffers

Contains all buffer pointers and their allocation size for serializing to the WAL. First dimension: All fixed-size allocators. Second dimension: The buffers of each fixed-size allocator.

---

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

• external/duckdb/duckdb.hpp