duckdb::IndexCatalogEntry Class Reference

An index catalog entry. More...

Inheritance diagram for duckdb::IndexCatalogEntry:

Collaboration diagram for duckdb::IndexCatalogEntry:

Public Member Functions
	IndexCatalogEntry (Catalog &catalog, SchemaCatalogEntry &schema, CreateIndexInfo &info)
	Create an IndexCatalogEntry.
unique_ptr< CreateInfo >	GetInfo () const override
	Returns the CreateIndexInfo.
string	ToSQL () const override
	Returns the original CREATE INDEX SQL.
virtual string	GetSchemaName () const =0
virtual string	GetTableName () const =0
bool	IsUnique () const
	Returns true, if this index is UNIQUE.
bool	IsPrimary () const
	Returns true, if this index is a PRIMARY KEY.
Public Member Functions inherited from duckdb::StandardEntry
	StandardEntry (CatalogType type, SchemaCatalogEntry &schema, Catalog &catalog, string name)
SchemaCatalogEntry &	ParentSchema () override
const SchemaCatalogEntry &	ParentSchema () const override
Public Member Functions inherited from duckdb::InCatalogEntry
	InCatalogEntry (CatalogType type, Catalog &catalog, string name)
Catalog &	ParentCatalog () override
const Catalog &	ParentCatalog () const override
void	Verify (Catalog &catalog) override
Public Member Functions inherited from duckdb::CatalogEntry
	CatalogEntry (CatalogType type, Catalog &catalog, string name)
	CatalogEntry (CatalogType type, string name, idx_t oid)
virtual unique_ptr< CatalogEntry >	AlterEntry (ClientContext &context, AlterInfo &info)
virtual unique_ptr< CatalogEntry >	AlterEntry (CatalogTransaction transaction, AlterInfo &info)
virtual void	UndoAlter (ClientContext &context, AlterInfo &info)
virtual void	Rollback (CatalogEntry &prev_entry)
virtual void	OnDrop ()
virtual unique_ptr< CatalogEntry >	Copy (ClientContext &context) const
virtual void	SetAsRoot ()
	Sets the CatalogEntry as the new root entry (i.e. the newest entry)
void	Serialize (Serializer &serializer) const
void	SetChild (unique_ptr< CatalogEntry > child)
unique_ptr< CatalogEntry >	TakeChild ()
bool	HasChild () const
bool	HasParent () const
CatalogEntry &	Child ()
CatalogEntry &	Parent ()
const CatalogEntry &	Parent () const
template<class TARGET >
TARGET &	Cast ()
template<class TARGET >
const TARGET &	Cast () const

Public Attributes
string	sql
	The SQL of the CREATE INDEX statement.
case_insensitive_map_t< Value >	options
	Additional index options.
string	index_type
	The index type (ART, B+-tree, Skip-List, ...)
IndexConstraintType	index_constraint_type
	The index constraint type.
vector< column_t >	column_ids
	The column ids of the indexed table.
vector< unique_ptr< ParsedExpression > >	expressions
	The set of expressions to index by.
vector< unique_ptr< ParsedExpression > >	parsed_expressions
Public Attributes inherited from duckdb::StandardEntry
SchemaCatalogEntry &	schema
	The schema the entry belongs to.
LogicalDependencyList	dependencies
	The dependencies of the entry, can be empty.
Public Attributes inherited from duckdb::InCatalogEntry
Catalog &	catalog
	The catalog the entry belongs to.
Public Attributes inherited from duckdb::CatalogEntry
idx_t	oid
	The oid of the entry.
CatalogType	type
	The type of this catalog entry.
optional_ptr< CatalogSet >	set
	Reference to the catalog set this entry is stored in.
string	name
	The name of the entry.
bool	deleted
	Whether or not the object is deleted.
bool	temporary
	Whether or not the object is temporary and should not be added to the WAL.
bool	internal
	Whether or not the entry is an internal entry (cannot be deleted, not dumped, etc)
atomic< transaction_t >	timestamp
	Timestamp at which the catalog entry was created.
Value	comment
	(optional) comment on this entry
InsertionOrderPreservingMap< string >	tags
	(optional) extra data associated with this entry

Static Public Attributes
static constexpr const CatalogType	Type = CatalogType::INDEX_ENTRY
static constexpr const char *	Name = "index"

Additional Inherited Members
Static Public Member Functions inherited from duckdb::CatalogEntry
static unique_ptr< CreateInfo >	Deserialize (Deserializer &deserializer)

Detailed Description

An index catalog entry.

Constructor & Destructor Documentation

IndexCatalogEntry()

duckdb::IndexCatalogEntry::IndexCatalogEntry	(	Catalog &	catalog,
		SchemaCatalogEntry &	schema,
		CreateIndexInfo &	info
	)

Create an IndexCatalogEntry.

    : StandardEntry(CatalogType::INDEX_ENTRY, schema, catalog, info.index_name), sql(info.sql), options(info.options),
      index_type(info.index_type), index_constraint_type(info.constraint_type), column_ids(info.column_ids) {
    this->temporary = info.temporary;
    this->dependencies = info.dependencies;
    this->comment = info.comment;
    for (auto &expr : expressions) {
        D_ASSERT(expr);
        expressions.push_back(expr->Copy());
    }
    for (auto &parsed_expr : info.parsed_expressions) {
        D_ASSERT(parsed_expr);
        parsed_expressions.push_back(parsed_expr->Copy());
    }
}

Member Function Documentation

GetInfo()

unique_ptr< CreateInfo > duckdb::IndexCatalogEntry::GetInfo ( ) const

overridevirtual

Returns the CreateIndexInfo.

Reimplemented from duckdb::CatalogEntry.

                                                        {
    auto result = make_uniq<CreateIndexInfo>();
    result->schema = GetSchemaName();
    result->table = GetTableName();
 
    result->temporary = temporary;
    result->sql = sql;
    result->index_name = name;
    result->index_type = index_type;
    result->constraint_type = index_constraint_type;
    result->column_ids = column_ids;
    result->dependencies = dependencies;
 
    for (auto &expr : expressions) {
        result->expressions.push_back(expr->Copy());
    }
    for (auto &expr : parsed_expressions) {
        result->parsed_expressions.push_back(expr->Copy());
    }
 
    result->comment = comment;
    result->tags = tags;
 
    return std::move(result);
}

Here is the caller graph for this function:

ToSQL()

string duckdb::IndexCatalogEntry::ToSQL ( ) const

overridevirtual

Returns the original CREATE INDEX SQL.

Reimplemented from duckdb::CatalogEntry.

                                      {
    auto info = GetInfo();
    return info->ToString();
}

Here is the call graph for this function:

IsUnique()

bool duckdb::IndexCatalogEntry::IsUnique

(

)

const

Returns true, if this index is UNIQUE.

                                       {
    return (index_constraint_type == IndexConstraintType::UNIQUE ||
            index_constraint_type == IndexConstraintType::PRIMARY);
}

IsPrimary()

bool duckdb::IndexCatalogEntry::IsPrimary

(

)

const

Returns true, if this index is a PRIMARY KEY.

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

---

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

• external/duckdb/duckdb.cpp