duckdb::Index Class Reference

The index is an abstract base class that serves as the basis for indexes. More...

#include <duckdb.hpp>

Inheritance diagram for duckdb::Index:

Collaboration diagram for duckdb::Index:

Public Member Functions
virtual bool	IsBound () const =0
	Returns true if the index is a bound index, and false otherwise.
virtual const string &	GetIndexType () const =0
	The index type (ART, B+-tree, Skip-List, ...)
virtual const string &	GetIndexName () const =0
	The name of the index.
virtual IndexConstraintType	GetConstraintType () const =0
	The index constraint type.
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
virtual void	CommitDrop ()=0
template<class TARGET >
TARGET &	Cast ()
template<class TARGET >
const TARGET &	Cast () const

Public Attributes
TableIOManager &	table_io_manager
	Associated table io manager.
AttachedDatabase &	db
	Attached database instance.

Protected Member Functions
	Index (const vector< column_t > &column_ids, TableIOManager &table_io_manager, AttachedDatabase &db)

Protected Attributes
vector< column_t >	column_ids
unordered_set< column_t >	column_id_set
	Unordered set of column_ids used by the Index.

Detailed Description

The index is an abstract base class that serves as the basis for indexes.

Member Function Documentation

IsBound()

virtual bool duckdb::Index::IsBound ( ) const

pure virtual

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

Implemented in duckdb::UnboundIndex, and duckdb::BoundIndex.

GetIndexType()

virtual const string & duckdb::Index::GetIndexType ( ) const

pure virtual

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

Implemented in duckdb::UnboundIndex, and duckdb::BoundIndex.

GetIndexName()

virtual const string & duckdb::Index::GetIndexName ( ) const

pure virtual

The name of the index.

Implemented in duckdb::UnboundIndex, and duckdb::BoundIndex.

GetConstraintType()

virtual IndexConstraintType duckdb::Index::GetConstraintType ( ) const

pure virtual

The index constraint type.

Implemented in duckdb::UnboundIndex, and duckdb::BoundIndex.

Here is the caller graph for this function:

IsUnique()

bool duckdb::Index::IsUnique ( ) const

inline

Returns unique flag.

                          {
        auto type = GetConstraintType();
        return type == IndexConstraintType::UNIQUE || type == IndexConstraintType::PRIMARY;
    }

Here is the call graph for this function:

IsPrimary()

bool duckdb::Index::IsPrimary ( ) const

inline

Returns primary key flag.

                           {
        auto index_constraint_type = GetConstraintType();
        return (index_constraint_type == IndexConstraintType::PRIMARY);
    }

Here is the call graph for this function:

IsForeign()

bool duckdb::Index::IsForeign ( ) const

inline

Returns foreign key flag.

                           {
        auto index_constraint_type = GetConstraintType();
        return (index_constraint_type == IndexConstraintType::FOREIGN);
    }

Here is the call graph for this function:

GetColumnIds()

const vector< column_t > & duckdb::Index::GetColumnIds ( ) const

inline

                                                 {
        return column_ids;
    }

GetColumnIdSet()

const unordered_set< column_t > & duckdb::Index::GetColumnIdSet ( ) const

inline

                                                          {
        return column_id_set;
    }

CommitDrop()

virtual void duckdb::Index::CommitDrop ( )

pure virtual

Implemented in duckdb::BoundIndex.

Cast() [1/2]

template<class TARGET >

TARGET & duckdb::Index::Cast ( )

inline

                   {
        DynamicCastCheck<TARGET>(this);
        return reinterpret_cast<TARGET &>(*this);
    }

Cast() [2/2]

template<class TARGET >

const TARGET & duckdb::Index::Cast ( ) const

inline

                               {
        DynamicCastCheck<TARGET>(this);
        return reinterpret_cast<const TARGET &>(*this);
    }

Member Data Documentation

column_ids

vector<column_t> duckdb::Index::column_ids

protected

The physical column ids of the indexed columns. For example, given a table with the following columns: (a INT, gen AS (2 * a), b INT, c VARCHAR), an index on columns (a,c) would have physical column_ids [0,2] (since the virtual column is skipped in the physical representation). Also see comments in bound_index.hpp to see how these column IDs are used in the context of bound/unbound expressions. Note that these are the columns for this Index, not all Indexes on the table.

---

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

• external/duckdb/duckdb.hpp