duckdb::UnboundIndex Class Reference

Inheritance diagram for duckdb::UnboundIndex:

Collaboration diagram for duckdb::UnboundIndex:

Public Member Functions
	UnboundIndex (unique_ptr< CreateInfo > create_info, IndexStorageInfo storage_info, TableIOManager &table_io_manager, AttachedDatabase &db)
bool	IsBound () const override
	Returns true if the index is a bound index, and false otherwise.
const string &	GetIndexType () const override
	The index type (ART, B+-tree, Skip-List, ...)
const string &	GetIndexName () const override
	The name of the index.
IndexConstraintType	GetConstraintType () const override
	The index constraint type.
const CreateIndexInfo &	GetCreateInfo () const
const IndexStorageInfo &	GetStorageInfo () const
const vector< unique_ptr< ParsedExpression > > &	GetParsedExpressions () const
const string &	GetTableName () const
void	CommitDrop () override
void	BufferChunk (DataChunk &index_column_chunk, Vector &row_ids, const vector< StorageIndex > &mapped_column_ids_p, BufferedIndexReplay replay_type)
bool	HasBufferedReplays () const
BufferedIndexReplays &	GetBufferedReplays ()
const vector< StorageIndex > &	GetMappedColumnIds () const
Public Member Functions inherited from duckdb::Index
bool	IsUnique () const
	Returns unique flag.
bool	IsPrimary () const
	Returns primary key flag.
bool	IsForeign () const
	Returns foreign key flag.
const vector< column_t > &	GetColumnIds () const
const unordered_set< column_t > &	GetColumnIdSet () const
template<class TARGET >
TARGET &	Cast ()
template<class TARGET >
const TARGET &	Cast () const

Private Attributes
unique_ptr< CreateInfo >	create_info
	The CreateInfo of the index.
IndexStorageInfo	storage_info
	The serialized storage information of the index.
BufferedIndexReplays	buffered_replays
	Buffered for index operations during WAL replay. They are replayed upon index binding.
vector< StorageIndex >	mapped_column_ids

Additional Inherited Members
Public Attributes inherited from duckdb::Index
TableIOManager &	table_io_manager
	Associated table io manager.
AttachedDatabase &	db
	Attached database instance.
Protected Member Functions inherited from duckdb::Index
	Index (const vector< column_t > &column_ids, TableIOManager &table_io_manager, AttachedDatabase &db)
Protected Attributes inherited from duckdb::Index
vector< column_t >	column_ids
unordered_set< column_t >	column_id_set
	Unordered set of column_ids used by the Index.

Member Function Documentation

IsBound()

bool duckdb::UnboundIndex::IsBound ( ) const

inlineoverridevirtual

Returns true if the index is a bound index, and false otherwise.

Implements duckdb::Index.

                                  {
        return false;
    }

GetIndexType()

const string & duckdb::UnboundIndex::GetIndexType ( ) const

inlineoverridevirtual

The index type (ART, B+-tree, Skip-List, ...)

Implements duckdb::Index.

                                                {
        return GetCreateInfo().index_type;
    }

GetIndexName()

const string & duckdb::UnboundIndex::GetIndexName ( ) const

inlineoverridevirtual

The name of the index.

Implements duckdb::Index.

                                                {
        return GetCreateInfo().index_name;
    }

GetConstraintType()

IndexConstraintType duckdb::UnboundIndex::GetConstraintType ( ) const

inlineoverridevirtual

The index constraint type.

Implements duckdb::Index.

                                                           {
        return GetCreateInfo().constraint_type;
    }

GetCreateInfo()

const CreateIndexInfo & duckdb::UnboundIndex::GetCreateInfo ( ) const

inline

                                                 {
        return create_info->Cast<CreateIndexInfo>();
    }

GetStorageInfo()

const IndexStorageInfo & duckdb::UnboundIndex::GetStorageInfo ( ) const

inline

                                                   {
        return storage_info;
    }

GetParsedExpressions()

const vector< unique_ptr< ParsedExpression > > & duckdb::UnboundIndex::GetParsedExpressions ( ) const

inline

                                                                             {
        return GetCreateInfo().parsed_expressions;
    }

GetTableName()

const string & duckdb::UnboundIndex::GetTableName ( ) const

inline

                                       {
        return GetCreateInfo().table;
    }

CommitDrop()

void duckdb::UnboundIndex::CommitDrop ( )

overridevirtual

Implements duckdb::Index.

BufferChunk()

void duckdb::UnboundIndex::BufferChunk	(	DataChunk &	index_column_chunk,
		Vector &	row_ids,
		const vector< StorageIndex > &	mapped_column_ids_p,
		BufferedIndexReplay	replay_type
	)

Buffer Index delete or insert (replay_type) data chunk. See note above on mapped_column_ids, this function assumes that index_column_chunk maps into mapped_column_ids_p to get the physical column index for each Indexed column in the chunk.

HasBufferedReplays()

bool duckdb::UnboundIndex::HasBufferedReplays ( ) const

inline

                                    {
        return buffered_replays.HasBufferedReplays();
    }

GetBufferedReplays()

BufferedIndexReplays & duckdb::UnboundIndex::GetBufferedReplays ( )

inline

                                               {
        return buffered_replays;
    }

GetMappedColumnIds()

const vector< StorageIndex > & duckdb::UnboundIndex::GetMappedColumnIds ( ) const

inline

                                                           {
        return mapped_column_ids;
    }

Member Data Documentation

mapped_column_ids

vector<StorageIndex> duckdb::UnboundIndex::mapped_column_ids

private

Maps the column IDs in the buffered replays to a physical table offset. For example, column [i] in a buffered ColumnDataCollection is the data for an Indexed column with physical table index mapped_column_ids[i]. This is in sorted order of physical column IDs.

---

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

• external/duckdb/duckdb.hpp