duckdb::ScalarFunctionCatalogEntry Class Reference

A scalar function in the catalog. More...

Inheritance diagram for duckdb::ScalarFunctionCatalogEntry:

Collaboration diagram for duckdb::ScalarFunctionCatalogEntry:

Public Member Functions
	ScalarFunctionCatalogEntry (Catalog &catalog, SchemaCatalogEntry &schema, CreateScalarFunctionInfo &info)
unique_ptr< CatalogEntry >	AlterEntry (CatalogTransaction transaction, AlterInfo &info) override
Public Member Functions inherited from duckdb::FunctionEntry
	FunctionEntry (CatalogType type, Catalog &catalog, SchemaCatalogEntry &schema, CreateFunctionInfo &info)
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 void	UndoAlter (ClientContext &context, AlterInfo &info)
virtual void	Rollback (CatalogEntry &prev_entry)
virtual void	OnDrop ()
virtual unique_ptr< CatalogEntry >	Copy (ClientContext &context) const
virtual unique_ptr< CreateInfo >	GetInfo () const
virtual void	SetAsRoot ()
	Sets the CatalogEntry as the new root entry (i.e. the newest entry)
virtual string	ToSQL () const
	Convert the catalog entry to a SQL string that can be used to re-construct the catalog 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
ScalarFunctionSet	functions
	The scalar functions.
Public Attributes inherited from duckdb::FunctionEntry
string	alias_of
vector< FunctionDescription >	descriptions
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::SCALAR_FUNCTION_ENTRY
static constexpr const char *	Name = "scalar function"

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

Detailed Description

A scalar function in the catalog.

Constructor & Destructor Documentation

ScalarFunctionCatalogEntry()

duckdb::ScalarFunctionCatalogEntry::ScalarFunctionCatalogEntry	(	Catalog &	catalog,
		SchemaCatalogEntry &	schema,
		CreateScalarFunctionInfo &	info
	)

    : FunctionEntry(CatalogType::SCALAR_FUNCTION_ENTRY, catalog, schema, info), functions(info.functions) {
    for (auto &function : functions.functions) {
        function.catalog_name = catalog.GetAttached().GetName();
        function.schema_name = schema.name;
    }
}

Member Function Documentation

AlterEntry()

unique_ptr< CatalogEntry > duckdb::ScalarFunctionCatalogEntry::AlterEntry ( CatalogTransaction  transaction, AlterInfo &  info  )

overridevirtual

Reimplemented from duckdb::CatalogEntry.

                                                                                                               {
    if (info.type != AlterType::ALTER_SCALAR_FUNCTION) {
        throw InternalException("Attempting to alter ScalarFunctionCatalogEntry with unsupported alter type");
    }
    auto &function_info = info.Cast<AlterScalarFunctionInfo>();
    if (function_info.alter_scalar_function_type != AlterScalarFunctionType::ADD_FUNCTION_OVERLOADS) {
        throw InternalException(
            "Attempting to alter ScalarFunctionCatalogEntry with unsupported alter scalar function type");
    }
    auto &add_overloads = function_info.Cast<AddScalarFunctionOverloadInfo>();
 
    ScalarFunctionSet new_set = functions;
    if (!new_set.MergeFunctionSet(add_overloads.new_overloads->functions, true)) {
        throw BinderException(
            "Failed to add new function overloads to function \"%s\": function overload already exists", name);
    }
    CreateScalarFunctionInfo new_info(std::move(new_set));
    new_info.internal = internal;
    new_info.descriptions = descriptions;
    new_info.descriptions.insert(new_info.descriptions.end(), add_overloads.new_overloads->descriptions.begin(),
                                 add_overloads.new_overloads->descriptions.end());
    return make_uniq<ScalarFunctionCatalogEntry>(catalog, schema, new_info);
}

---

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

• external/duckdb/duckdb.cpp