kuzu::storage Namespace Reference

Classes
struct	BitpackInfo
class	BoolChunkData
class	BooleanBitpacking
struct	ChunkCheckpointState
class	ChunkedNodeGroup
struct	ChunkState
class	Column
struct	ColumnCheckpointState
class	ColumnChunk
class	ColumnChunkData
struct	ColumnChunkFactory
struct	ColumnChunkMetadata
struct	ColumnFactory
class	ColumnPredicate
class	ColumnPredicateSet
struct	ColumnPredicateUtil
class	CompressedFunctor
class	CompressionAlg
struct	CompressionMetadata
class	ConstantCompression
struct	DBFileID
class	GroupCollection
class	IntegerBitpacking
class	InternalIDChunkData
class	InternalIDColumn
class	LocalStorage
class	LocalTable
class	NodeGroup
struct	NodeGroupCheckpointState
struct	NodeGroupScanResult
struct	NodeGroupScanState
class	NullChunkData
class	ReadCompressedValuesFromPage
class	ReadCompressedValuesFromPageToVector
struct	ResidencyStateUtils
union	StorageValue
struct	StorageVersionInfo
class	Table
struct	TableAddColumnState
struct	TableDeleteState
struct	TableInsertState
struct	TableScanState
struct	TableUpdateState
class	Uncompressed
class	UndoBuffer
class	UndoBufferIterator
class	UndoMemoryBuffer
class	UpdateInfo
struct	VectorUpdateInfo
struct	VectorVersionInfo
class	VersionInfo
class	WriteCompressedValuesToPage

Concepts
concept	StorageValueType
concept	IntegerBitpackingType

Typedefs
using	read_values_to_vector_func_t
using	write_values_from_vector_func_t
using	write_values_func_t
using	read_values_to_page_func_t
using	batch_lookup_func_t = read_values_to_page_func_t
using	offset_to_row_idx_t = std::map<common::offset_t, common::row_idx_t>
using	offset_to_row_idx_vec_t = std::map<common::offset_t, std::vector<common::row_idx_t>>
using	offset_set_t = std::unordered_set<common::offset_t>
using	storage_version_t = uint64_t

Enumerations
enum class	NodeGroupDataFormat : uint8_t { REGULAR = 0 , CSR = 1 }
enum class	CompressionType : uint8_t { UNCOMPRESSED = 0 , INTEGER_BITPACKING = 1 , BOOLEAN_BITPACKING = 2 , CONSTANT = 3 }
enum class	DBFileType : uint8_t { NODE_INDEX = 0 , DATA = 1 }
enum class	ResidencyState : uint8_t { IN_MEMORY = 0 , ON_DISK = 1 }
enum class	TableScanSource : uint8_t { COMMITTED = 0 , UNCOMMITTED = 1 , NONE = 3 }

Functions
std::pair< std::optional< StorageValue >, std::optional< StorageValue > >	getMinMaxStorageValue (const uint8_t *data, uint64_t offset, uint64_t numValues, common::PhysicalTypeID physicalType, const common::NullMask *nullMask, bool valueRequiredIfUnsupported=false)
uint32_t	getDataTypeSizeInChunk (const common::LogicalType &dataType)
uint32_t	getDataTypeSizeInChunk (const common::PhysicalTypeID &dataType)

Typedef Documentation

batch_lookup_func_t

using kuzu::storage::batch_lookup_func_t = read_values_to_page_func_t

offset_set_t

using kuzu::storage::offset_set_t = std::unordered_set<common::offset_t>

offset_to_row_idx_t

using kuzu::storage::offset_to_row_idx_t = std::map<common::offset_t, common::row_idx_t>

offset_to_row_idx_vec_t

using kuzu::storage::offset_to_row_idx_vec_t = std::map<common::offset_t, std::vector<common::row_idx_t>>

read_values_to_page_func_t

using kuzu::storage::read_values_to_page_func_t

Initial value:

 
    std::function<void(uint8_t* frame, PageCursor& pageCursor, uint8_t* result,
        uint32_t posInResult, uint64_t numValues, const CompressionMetadata& metadata)>

read_values_to_vector_func_t

using kuzu::storage::read_values_to_vector_func_t

Initial value:

 
    std::function<void(uint8_t* frame, PageCursor& pageCursor, common::ValueVector* resultVector,
        uint32_t posInVector, uint32_t numValuesToRead, const CompressionMetadata& metadata)>

storage_version_t

using kuzu::storage::storage_version_t = uint64_t

write_values_from_vector_func_t

using kuzu::storage::write_values_from_vector_func_t

Initial value:

 std::function<void(uint8_t* frame, uint16_t posInFrame,
    common::ValueVector* vector, uint32_t posInVector, const CompressionMetadata& metadata)>

write_values_func_t

using kuzu::storage::write_values_func_t

Initial value:

 std::function<void(uint8_t* frame, uint16_t posInFrame,
    const uint8_t* data, common::offset_t dataOffset, common::offset_t numValues,
    const CompressionMetadata& metadata, const common::NullMask*)>

Enumeration Type Documentation

CompressionType

enum class kuzu::storage::CompressionType : uint8_t

strong

Enumerator
UNCOMPRESSED
INTEGER_BITPACKING
BOOLEAN_BITPACKING
CONSTANT

DBFileType

enum class kuzu::storage::DBFileType : uint8_t

strong

Enumerator
NODE_INDEX
DATA

NodeGroupDataFormat

enum class kuzu::storage::NodeGroupDataFormat : uint8_t

strong

Enumerator
REGULAR
CSR

ResidencyState

enum class kuzu::storage::ResidencyState : uint8_t

strong

Enumerator
IN_MEMORY
ON_DISK

TableScanSource

enum class kuzu::storage::TableScanSource : uint8_t

strong

Enumerator
COMMITTED
UNCOMMITTED
NONE

Function Documentation

getDataTypeSizeInChunk() [1/2]

uint32_t kuzu::storage::getDataTypeSizeInChunk

(

const common::LogicalType &

dataType

)

getDataTypeSizeInChunk() [2/2]

uint32_t kuzu::storage::getDataTypeSizeInChunk

(

const common::PhysicalTypeID &

dataType

)

getMinMaxStorageValue()

std::pair< std::optional< StorageValue >, std::optional< StorageValue > > kuzu::storage::getMinMaxStorageValue	(	const uint8_t *	data,
		uint64_t	offset,
		uint64_t	numValues,
		common::PhysicalTypeID	physicalType,
		const common::NullMask *	nullMask,
		bool	valueRequiredIfUnsupported = false )