duckdb::TableIndexList Class Reference

Collaboration diagram for duckdb::TableIndexList:

Public Member Functions
TableIndexIterationHelper< IndexEntry >	IndexEntries () const
TableIndexIterationHelper< Index >	Indexes () const
void	AddIndex (unique_ptr< Index > index)
	Adds an index entry to the list of index entries.
void	RemoveIndex (const string &name)
	Removes an index entry from the list of index entries.
void	CommitDrop (const string &name)
	Removes all remaining memory of an index after dropping the catalog entry.
bool	NameIsUnique (const string &name)
	Returns true, if the index name does not exist.
optional_ptr< BoundIndex >	Find (const string &name)
	Returns an optional pointer to the index matching the name.
void	Bind (ClientContext &context, DataTableInfo &table_info, const char *index_type=nullptr)
	Binds unbound indexes possibly present after loading an extension.
bool	Empty () const
	Returns true, if there are no index entries.
idx_t	Count () const
	Returns the number of index entries.
bool	HasUnbound () const
	Returns true, if there are unbound indexes.
unordered_set< string >	DistinctIndexTypes () const
	Returns the set of distinct index types across all bound indexes.
void	Move (TableIndexList &other)
	Overwrite this list with the other list.
void	MergeCheckpointDeltas (transaction_t checkpoint_id)
	Merge any changes added to deltas during a checkpoint back into the main indexes.
optional_ptr< IndexEntry >	FindForeignKeyIndex (const vector< PhysicalIndex > &fk_keys, const ForeignKeyType fk_type)
void	VerifyForeignKey (optional_ptr< LocalTableStorage > storage, const vector< PhysicalIndex > &fk_keys, DataChunk &chunk, ConflictManager &conflict_manager)
	Verify a foreign key constraint.
unordered_set< column_t >	GetRequiredColumns ()
	Get the combined column ids of the indexes.
IndexSerializationResult	SerializeToDisk (QueryContext context, const IndexSerializationInfo &info)
	Serialize all indexes of the table.

Static Public Member Functions
static void	InitializeIndexChunk (DataChunk &index_chunk, const vector< LogicalType > &table_types, vector< StorageIndex > &mapped_column_ids, DataTableInfo &data_table_info)
	Initialize an index_chunk from a table.
static void	ReferenceIndexChunk (DataChunk &table_chunk, DataChunk &index_chunk, vector< StorageIndex > &mapped_column_ids)
	Reference the indexed columns of a table chunk.

Private Attributes
mutex	index_entries_lock
	A lock to prevent any concurrent changes to the index entries.
vector< unique_ptr< IndexEntry > >	index_entries
	The index entries of the table.
idx_t	unbound_count = 0
	Contains the number of unbound indexes.

Member Function Documentation

Empty()

bool duckdb::TableIndexList::Empty ( ) const

inline

Returns true, if there are no index entries.

                       {
        return Count() == 0;
    }

Here is the call graph for this function:

Count()

idx_t duckdb::TableIndexList::Count ( ) const

inline

Returns the number of index entries.

                        {
        lock_guard<mutex> lock(index_entries_lock);
        return index_entries.size();
    }

Here is the caller graph for this function:

HasUnbound()

bool duckdb::TableIndexList::HasUnbound ( ) const

inline

Returns true, if there are unbound indexes.

                            {
        lock_guard<mutex> lock(index_entries_lock);
        return unbound_count != 0;
    }

Move()

void duckdb::TableIndexList::Move ( TableIndexList &  other )

inline

Overwrite this list with the other list.

                                     {
        D_ASSERT(index_entries.empty());
        index_entries = std::move(other.index_entries);
    }

FindForeignKeyIndex()

optional_ptr< IndexEntry > duckdb::TableIndexList::FindForeignKeyIndex	(	const vector< PhysicalIndex > &	fk_keys,
		const ForeignKeyType	fk_type
	)

Returns true, if all indexes Find the foreign key matching the keys.

---

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

• external/duckdb/duckdb.hpp