duckdb::TupleDataLayout Class Reference

Collaboration diagram for duckdb::TupleDataLayout:

Public Types
using	Aggregates = vector< AggregateObject >
using	ValidityBytes = TemplatedValidityMask< uint8_t >

Public Member Functions
	TupleDataLayout ()
	Creates an empty TupleDataLayout.
TupleDataLayout	Copy () const
	Create a copy of this TupleDataLayout.
void	Initialize (vector< LogicalType > types_p, Aggregates aggregates_p, TupleDataValidityType validity_type, TupleDataNestednessType nestedness_type=TupleDataNestednessType::TOP_LEVEL_LAYOUT)
	Initializes the TupleDataLayout with the specified types and aggregates to an empty TupleDataLayout.
void	Initialize (vector< LogicalType > types, TupleDataValidityType validity_type, TupleDataNestednessType nestedness_type=TupleDataNestednessType::TOP_LEVEL_LAYOUT)
	Initializes the TupleDataLayout with the specified types to an empty TupleDataLayout.
void	Initialize (Aggregates aggregates_p)
	Initializes the TupleDataLayout with the specified aggregates to an empty TupleDataLayout.
void	Initialize (const vector< BoundOrderByNode > &orders, const LogicalType &type, bool has_payload)
	Initializes a TupleDataLayout with the specified ORDER BY to an empty TupleDataLayout.
idx_t	ColumnCount () const
	Returns the number of data columns.
const vector< LogicalType > &	GetTypes () const
	Returns a list of the column types for this data chunk.
idx_t	AggregateCount () const
	Returns the number of aggregates.
Aggregates &	GetAggregates ()
	Returns a list of the aggregates for this data chunk.
const Aggregates &	GetAggregates () const
SortKeyType	GetSortKeyType () const
	Gets the sort key type of this layout (if applicable)
bool	IsSortKeyLayout () const
	Returns whether this is a sort key layout (in implementation file to avoid including here)
const TupleDataLayout &	GetStructLayout (idx_t col_idx) const
	Returns a map from column id to the struct TupleDataLayout.
idx_t	GetRowWidth () const
	Returns the total width required for each row, including padding.
idx_t	GetDataOffset () const
	Returns the offset to the start of the data.
idx_t	GetDataWidth () const
	Returns the total width required for the data, including padding.
idx_t	GetAggrOffset () const
	Returns the offset to the start of the aggregates.
idx_t	GetAggrWidth () const
	Returns the total width required for the aggregates, including padding.
idx_t	GetSortWidth () const
	Returns the total width required for sorting.
const vector< idx_t > &	GetSortSkippableBytes () const
const vector< idx_t > &	GetOffsets () const
	Returns the column offsets into each row.
bool	AllConstant () const
	Returns whether all columns in this layout are constant size.
const vector< idx_t > &	GetVariableColumns () const
idx_t	GetHeapSizeOffset () const
	Gets offset to where heap size is stored.
bool	HasDestructor () const
	Returns whether any of the aggregates have a destructor.
const vector< idx_t > &	GetAggregateDestructorIndices () const
	Returns the indices of the aggregates that have destructors.
bool	AllValid () const
	Returns whether none of the columns have NULLs.

Private Attributes
vector< LogicalType >	types
	The types of the data columns.
Aggregates	aggregates
	The aggregate functions.
SortKeyType	sort_key_type
	The sort key type associated with orders.
unique_ptr< unordered_map< idx_t, TupleDataLayout > >	struct_layouts
	Structs are a recursive TupleDataLayout.
idx_t	flag_width
	The width of the validity header.
idx_t	data_width
	The width of the data portion.
idx_t	aggr_width
	The width of the aggregate state portion.
idx_t	sort_width
	The width of the sort key.
vector< idx_t >	sort_skippable_bytes
	Bytes that are skippable during sorting.
idx_t	row_width
	The width of the entire row.
vector< idx_t >	offsets
	The offsets to the columns and aggregate data in each row.
bool	all_constant
	Whether all columns in this layout are constant size.
vector< idx_t >	variable_columns
	Indices of the variable columns.
idx_t	heap_size_offset
	Offset to the heap size of every row.
vector< idx_t >	aggr_destructor_idxs
	Indices of aggregate functions that have a destructor.
TupleDataValidityType	validity_type
	Whether none of the columns have NULLs.

Member Function Documentation

ColumnCount()

idx_t duckdb::TupleDataLayout::ColumnCount ( ) const

inline

Returns the number of data columns.

                                     {
        return types.size();
    }

GetTypes()

const vector< LogicalType > & duckdb::TupleDataLayout::GetTypes ( ) const

inline

Returns a list of the column types for this data chunk.

                                                       {
        return types;
    }

AggregateCount()

idx_t duckdb::TupleDataLayout::AggregateCount ( ) const

inline

Returns the number of aggregates.

                                        {
        return aggregates.size();
    }

GetAggregates() [1/2]

Aggregates & duckdb::TupleDataLayout::GetAggregates ( )

inline

Returns a list of the aggregates for this data chunk.

                                       {
        return aggregates;
    }

GetAggregates() [2/2]

const Aggregates & duckdb::TupleDataLayout::GetAggregates ( ) const

inline

                                                   {
        return aggregates;
    }

GetSortKeyType()

SortKeyType duckdb::TupleDataLayout::GetSortKeyType ( ) const

inline

Gets the sort key type of this layout (if applicable)

                                              {
        return sort_key_type;
    }

GetStructLayout()

const TupleDataLayout & duckdb::TupleDataLayout::GetStructLayout ( idx_t  col_idx ) const

inline

Returns a map from column id to the struct TupleDataLayout.

                                                                       {
        D_ASSERT(struct_layouts->find(col_idx) != struct_layouts->end());
        return struct_layouts->find(col_idx)->second;
    }

GetRowWidth()

idx_t duckdb::TupleDataLayout::GetRowWidth ( ) const

inline

Returns the total width required for each row, including padding.

                                     {
        return row_width;
    }

GetDataOffset()

idx_t duckdb::TupleDataLayout::GetDataOffset ( ) const

inline

Returns the offset to the start of the data.

                                       {
        return flag_width;
    }

GetDataWidth()

idx_t duckdb::TupleDataLayout::GetDataWidth ( ) const

inline

Returns the total width required for the data, including padding.

                                      {
        return data_width;
    }

GetAggrOffset()

idx_t duckdb::TupleDataLayout::GetAggrOffset ( ) const

inline

Returns the offset to the start of the aggregates.

                                       {
        return flag_width + data_width;
    }

GetAggrWidth()

idx_t duckdb::TupleDataLayout::GetAggrWidth ( ) const

inline

Returns the total width required for the aggregates, including padding.

                                      {
        return aggr_width;
    }

GetSortWidth()

idx_t duckdb::TupleDataLayout::GetSortWidth ( ) const

inline

Returns the total width required for sorting.

                                      {
        D_ASSERT(IsSortKeyLayout());
        return sort_width;
    }

Here is the call graph for this function:

GetSortSkippableBytes()

const vector< idx_t > & duckdb::TupleDataLayout::GetSortSkippableBytes ( ) const

inline

                                                              {
        D_ASSERT(IsSortKeyLayout());
        return sort_skippable_bytes;
    }

GetOffsets()

const vector< idx_t > & duckdb::TupleDataLayout::GetOffsets ( ) const

inline

Returns the column offsets into each row.

                                                   {
        return offsets;
    }

AllConstant()

bool duckdb::TupleDataLayout::AllConstant ( ) const

inline

Returns whether all columns in this layout are constant size.

                                    {
        return all_constant;
    }

GetVariableColumns()

const vector< idx_t > & duckdb::TupleDataLayout::GetVariableColumns ( ) const

inline

                                                           {
        return variable_columns;
    }

GetHeapSizeOffset()

idx_t duckdb::TupleDataLayout::GetHeapSizeOffset ( ) const

inline

Gets offset to where heap size is stored.

                                           {
        return heap_size_offset;
    }

HasDestructor()

bool duckdb::TupleDataLayout::HasDestructor ( ) const

inline

Returns whether any of the aggregates have a destructor.

                                      {
        return !aggr_destructor_idxs.empty();
    }

GetAggregateDestructorIndices()

const vector< idx_t > & duckdb::TupleDataLayout::GetAggregateDestructorIndices ( ) const

inline

Returns the indices of the aggregates that have destructors.

                                                                      {
        return aggr_destructor_idxs;
    }

AllValid()

bool duckdb::TupleDataLayout::AllValid ( ) const

inline

Returns whether none of the columns have NULLs.

                                 {
        return validity_type == TupleDataValidityType::CANNOT_HAVE_NULL_VALUES;
    }

---

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

• external/duckdb/duckdb.cpp