A schema in the catalog. More...

#include <duckdb.hpp>

Inheritance diagram for duckdb::SchemaCatalogEntry:

[legend]

Collaboration diagram for duckdb::SchemaCatalogEntry:

[legend]

Public Member Functions
	SchemaCatalogEntry (Catalog &catalog, CreateSchemaInfo &info)

unique_ptr< CreateInfo >	GetInfo () const override

virtual void	Scan (ClientContext &context, CatalogType type, const std::function< void(CatalogEntry &)> &callback)=0
	Scan the specified catalog set, invoking the callback method for every entry.

virtual void	Scan (CatalogType type, const std::function< void(CatalogEntry &)> &callback)=0
	Scan the specified catalog set, invoking the callback method for every committed entry.

string	ToSQL () const override
	Convert the catalog entry to a SQL string that can be used to re-construct the catalog entry.

virtual optional_ptr< CatalogEntry >	CreateIndex (CatalogTransaction transaction, CreateIndexInfo &info, TableCatalogEntry &table)=0
	Creates an index with the given name in the schema.

optional_ptr< CatalogEntry >	CreateIndex (ClientContext &context, CreateIndexInfo &info, TableCatalogEntry &table)

virtual optional_ptr< CatalogEntry >	CreateFunction (CatalogTransaction transaction, CreateFunctionInfo &info)=0
	Create a scalar or aggregate function within the given schema.

virtual optional_ptr< CatalogEntry >	CreateTable (CatalogTransaction transaction, BoundCreateTableInfo &info)=0
	Creates a table with the given name in the schema.

virtual optional_ptr< CatalogEntry >	CreateView (CatalogTransaction transaction, CreateViewInfo &info)=0
	Creates a view with the given name in the schema.

virtual optional_ptr< CatalogEntry >	CreateSequence (CatalogTransaction transaction, CreateSequenceInfo &info)=0
	Creates a sequence with the given name in the schema.

virtual optional_ptr< CatalogEntry >	CreateTableFunction (CatalogTransaction transaction, CreateTableFunctionInfo &info)=0
	Create a table function within the given schema.

virtual optional_ptr< CatalogEntry >	CreateCopyFunction (CatalogTransaction transaction, CreateCopyFunctionInfo &info)=0
	Create a copy function within the given schema.

virtual optional_ptr< CatalogEntry >	CreatePragmaFunction (CatalogTransaction transaction, CreatePragmaFunctionInfo &info)=0
	Create a pragma function within the given schema.

virtual optional_ptr< CatalogEntry >	CreateCollation (CatalogTransaction transaction, CreateCollationInfo &info)=0
	Create a collation within the given schema.

virtual optional_ptr< CatalogEntry >	CreateCoordinateSystem (CatalogTransaction transaction, CreateCoordinateSystemInfo &info)
	Create a coordiante system within the given schema.

virtual optional_ptr< CatalogEntry >	CreateType (CatalogTransaction transaction, CreateTypeInfo &info)=0
	Create a enum within the given schema.

virtual DUCKDB_API optional_ptr< CatalogEntry >	LookupEntry (CatalogTransaction transaction, const EntryLookupInfo &lookup_info)=0
	Lookup an entry in the schema.

virtual DUCKDB_API CatalogSet::EntryLookup	LookupEntryDetailed (CatalogTransaction transaction, const EntryLookupInfo &lookup_info)

virtual DUCKDB_API SimilarCatalogEntry	GetSimilarEntry (CatalogTransaction transaction, const EntryLookupInfo &lookup_info)

DUCKDB_API optional_ptr< CatalogEntry >	GetEntry (CatalogTransaction transaction, CatalogType type, const string &name)

virtual void	DropEntry (ClientContext &context, DropInfo &info)=0
	Drops an entry from the schema.

virtual void	Alter (CatalogTransaction transaction, AlterInfo &info)=0
	Alters a catalog entry.

CatalogTransaction	GetCatalogTransaction (ClientContext &context)

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)

virtual SchemaCatalogEntry &	ParentSchema ()

virtual const SchemaCatalogEntry &	ParentSchema () const

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

Static Public Attributes
static constexpr const CatalogType	Type = CatalogType::SCHEMA_ENTRY

static constexpr const char *	Name = "schema"

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

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

Detailed Description

A schema in the catalog.

Constructor & Destructor Documentation

◆ SchemaCatalogEntry()

duckdb::SchemaCatalogEntry::SchemaCatalogEntry	(	Catalog &	catalog,
		CreateSchemaInfo &	info
	)

    : InCatalogEntry(CatalogType::SCHEMA_ENTRY, catalog, info.schema) {
    this->internal = info.internal;
    this->comment = info.comment;
    this->tags = info.tags;
}

Member Function Documentation

◆ GetInfo()

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

overridevirtual

Reimplemented from duckdb::CatalogEntry.

                                                         {
    auto result = make_uniq<CreateSchemaInfo>();
    result->schema = name;
    result->comment = comment;
    result->tags = tags;
    return std::move(result);
}

◆ Scan() [1/2]

virtual void duckdb::SchemaCatalogEntry::Scan	(	ClientContext &	context,
		CatalogType	type,
		const std::function< void(CatalogEntry &)> &	callback
	)

pure virtual

Scan the specified catalog set, invoking the callback method for every entry.

Implemented in duckdb::DuckSchemaEntry.

◆ Scan() [2/2]

virtual void duckdb::SchemaCatalogEntry::Scan	(	CatalogType	type,
		const std::function< void(CatalogEntry &)> &	callback
	)

pure virtual

Scan the specified catalog set, invoking the callback method for every committed entry.

Implemented in duckdb::DuckSchemaEntry.

◆ ToSQL()

string duckdb::SchemaCatalogEntry::ToSQL ( ) const

overridevirtual

Convert the catalog entry to a SQL string that can be used to re-construct the catalog entry.

Reimplemented from duckdb::CatalogEntry.

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

◆ CreateIndex() [1/2]

virtual optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::CreateIndex	(	CatalogTransaction	transaction,
		CreateIndexInfo &	info,
		TableCatalogEntry &	table
	)

pure virtual

Creates an index with the given name in the schema.

Implemented in duckdb::DuckSchemaEntry.

◆ CreateIndex() [2/2]

optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::CreateIndex	(	ClientContext &	context,
		CreateIndexInfo &	info,
		TableCatalogEntry &	table
	)

                                                                                     {
    return CreateIndex(GetCatalogTransaction(context), info, table);
}

◆ CreateFunction()

virtual optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::CreateFunction	(	CatalogTransaction	transaction,
		CreateFunctionInfo &	info
	)

pure virtual

Create a scalar or aggregate function within the given schema.

Implemented in duckdb::DuckSchemaEntry.

Here is the caller graph for this function:

◆ CreateTable()

virtual optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::CreateTable	(	CatalogTransaction	transaction,
		BoundCreateTableInfo &	info
	)

pure virtual

Creates a table with the given name in the schema.

Implemented in duckdb::DuckSchemaEntry.

Here is the caller graph for this function:

◆ CreateView()

virtual optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::CreateView	(	CatalogTransaction	transaction,
		CreateViewInfo &	info
	)

pure virtual

Creates a view with the given name in the schema.

Implemented in duckdb::DuckSchemaEntry.

Here is the caller graph for this function:

◆ CreateSequence()

virtual optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::CreateSequence	(	CatalogTransaction	transaction,
		CreateSequenceInfo &	info
	)

pure virtual

Creates a sequence with the given name in the schema.

Implemented in duckdb::DuckSchemaEntry.

Here is the caller graph for this function:

◆ CreateTableFunction()

virtual optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::CreateTableFunction	(	CatalogTransaction	transaction,
		CreateTableFunctionInfo &	info
	)

pure virtual

Create a table function within the given schema.

Implemented in duckdb::DuckSchemaEntry.

Here is the caller graph for this function:

◆ CreateCopyFunction()

virtual optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::CreateCopyFunction	(	CatalogTransaction	transaction,
		CreateCopyFunctionInfo &	info
	)

pure virtual

Create a copy function within the given schema.

Implemented in duckdb::DuckSchemaEntry.

Here is the caller graph for this function:

◆ CreatePragmaFunction()

virtual optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::CreatePragmaFunction	(	CatalogTransaction	transaction,
		CreatePragmaFunctionInfo &	info
	)

pure virtual

Create a pragma function within the given schema.

Implemented in duckdb::DuckSchemaEntry.

Here is the caller graph for this function:

◆ CreateCollation()

virtual optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::CreateCollation	(	CatalogTransaction	transaction,
		CreateCollationInfo &	info
	)

pure virtual

Create a collation within the given schema.

Implemented in duckdb::DuckSchemaEntry.

Here is the caller graph for this function:

◆ CreateCoordinateSystem()

virtual optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::CreateCoordinateSystem	(	CatalogTransaction	transaction,
		CreateCoordinateSystemInfo &	info
	)

inlinevirtual

Create a coordiante system within the given schema.

Reimplemented in duckdb::DuckSchemaEntry.

                                                                                                {
        throw NotImplementedException("Coordinate systems are not supported in schema '%s'", name);
    }

Here is the caller graph for this function:

◆ CreateType()

virtual optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::CreateType	(	CatalogTransaction	transaction,
		CreateTypeInfo &	info
	)

pure virtual

Create a enum within the given schema.

Implemented in duckdb::DuckSchemaEntry.

Here is the caller graph for this function:

◆ LookupEntry()

virtual DUCKDB_API optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::LookupEntry	(	CatalogTransaction	transaction,
		const EntryLookupInfo &	lookup_info
	)

pure virtual

Lookup an entry in the schema.

Implemented in duckdb::DuckSchemaEntry.

◆ LookupEntryDetailed()

CatalogSet::EntryLookup duckdb::SchemaCatalogEntry::LookupEntryDetailed	(	CatalogTransaction	transaction,
		const EntryLookupInfo &	lookup_info
	)

virtual

This should not be used, it's only implemented to not put the burden of implementing it on every derived class of SchemaCatalogEntry

Reimplemented in duckdb::DuckSchemaEntry.

                                                                                                    {
    CatalogSet::EntryLookup result;
    result.result = LookupEntry(transaction, lookup_info);
    if (!result.result) {
        result.reason = CatalogSet::EntryLookup::FailureReason::DELETED;
    } else {
        result.reason = CatalogSet::EntryLookup::FailureReason::SUCCESS;
    }
    return result;
}

◆ GetSimilarEntry()

SimilarCatalogEntry duckdb::SchemaCatalogEntry::GetSimilarEntry	(	CatalogTransaction	transaction,
		const EntryLookupInfo &	lookup_info
	)

virtual

                                                                                            {
    SimilarCatalogEntry result;
    Scan(transaction.GetContext(), lookup_info.GetCatalogType(), [&](CatalogEntry &entry) {
        auto entry_score = StringUtil::SimilarityRating(entry.name, lookup_info.GetEntryName());
        if (entry_score > result.score) {
            result.score = entry_score;
            result.name = entry.name;
        }
    });
    return result;
}

◆ GetEntry()

optional_ptr< CatalogEntry > duckdb::SchemaCatalogEntry::GetEntry	(	CatalogTransaction	transaction,
		CatalogType	type,
		const string &	name
	)

                                                                            {
    EntryLookupInfo lookup_info(type, name);
    return LookupEntry(transaction, lookup_info);
}

◆ DropEntry()

virtual void duckdb::SchemaCatalogEntry::DropEntry	(	ClientContext &	context,
		DropInfo &	info
	)

pure virtual

Drops an entry from the schema.

Implemented in duckdb::DuckSchemaEntry.

◆ Alter()

virtual void duckdb::SchemaCatalogEntry::Alter	(	CatalogTransaction	transaction,
		AlterInfo &	info
	)

pure virtual

Alters a catalog entry.

Implemented in duckdb::DuckSchemaEntry.

◆ GetCatalogTransaction()

CatalogTransaction duckdb::SchemaCatalogEntry::GetCatalogTransaction ( ClientContext & context )

                                                                                   {
    return CatalogTransaction(catalog, context);
}

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

external/duckdb/duckdb.hpp
external/duckdb/duckdb.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SchemaCatalogEntry()

Member Function Documentation

◆ GetInfo()

◆ Scan() [1/2]

◆ Scan() [2/2]

◆ ToSQL()

◆ CreateIndex() [1/2]

◆ CreateIndex() [2/2]

◆ CreateFunction()

◆ CreateTable()

◆ CreateView()

◆ CreateSequence()

◆ CreateTableFunction()

◆ CreateCopyFunction()

◆ CreatePragmaFunction()

◆ CreateCollation()

◆ CreateCoordinateSystem()

◆ CreateType()

◆ LookupEntry()

◆ LookupEntryDetailed()

◆ GetSimilarEntry()

◆ GetEntry()

◆ DropEntry()

◆ Alter()

◆ GetCatalogTransaction()