duckdb::BaseScalarFunction Class Reference

Inheritance diagram for duckdb::BaseScalarFunction:

Collaboration diagram for duckdb::BaseScalarFunction:

Public Member Functions
DUCKDB_API	BaseScalarFunction (string name, vector< LogicalType > arguments, LogicalType return_type, FunctionStability stability, LogicalType varargs=LogicalType(LogicalTypeId::INVALID), FunctionNullHandling null_handling=FunctionNullHandling::DEFAULT_NULL_HANDLING, FunctionErrors errors=FunctionErrors::CANNOT_ERROR)
void	SetReturnType (LogicalType return_type_p)
const LogicalType &	GetReturnType () const
LogicalType &	GetReturnType ()
FunctionStability	GetStability () const
void	SetStability (FunctionStability stability_p)
FunctionNullHandling	GetNullHandling () const
void	SetNullHandling (FunctionNullHandling null_handling_p)
FunctionErrors	GetErrorMode () const
void	SetErrorMode (FunctionErrors errors_p)
void	SetFallible ()
	Set this functions error-mode as fallible (can throw runtime errors)
void	SetVolatile ()
	Set this functions stability as volatile (can not be cached per row)
void	SetCollationHandling (FunctionCollationHandling collation_handling_p)
FunctionCollationHandling	GetCollationHandling () const
DUCKDB_API hash_t	Hash () const
DUCKDB_API string	ToString () const override
Public Member Functions inherited from duckdb::SimpleFunction
DUCKDB_API	SimpleFunction (string name, vector< LogicalType > arguments, LogicalType varargs=LogicalType(LogicalTypeId::INVALID))
DUCKDB_API bool	HasVarArgs () const
Public Member Functions inherited from duckdb::Function
DUCKDB_API	Function (string name)

Static Public Member Functions
static BaseScalarFunction	SetReturnsError (BaseScalarFunction &function)
Static Public Member Functions inherited from duckdb::Function
static DUCKDB_API string	CallToString (const string &catalog_name, const string &schema_name, const string &name, const vector< LogicalType > &arguments, const LogicalType &varargs=LogicalType::INVALID)
	Returns the formatted string name(arg1, arg2, ...)
static DUCKDB_API string	CallToString (const string &catalog_name, const string &schema_name, const string &name, const vector< LogicalType > &arguments, const LogicalType &varargs, const LogicalType &return_type)
	Returns the formatted string name(arg1, arg2..) -> return_type.
static DUCKDB_API string	CallToString (const string &catalog_name, const string &schema_name, const string &name, const vector< LogicalType > &arguments, const named_parameter_type_map_t &named_parameters)
	Returns the formatted string name(arg1, arg2.., np1=a, np2=b, ...)
static DUCKDB_API void	EraseArgument (SimpleFunction &bound_function, vector< unique_ptr< Expression > > &arguments, idx_t argument_index)
	Used in the bind to erase an argument from a function.

Public Attributes
LogicalType	return_type
	Return type of the function.
FunctionStability	stability
	The stability of the function (see FunctionStability enum for more info)
FunctionNullHandling	null_handling
	How this function handles NULL values.
FunctionErrors	errors
	Whether or not this function can throw an error.
FunctionCollationHandling	collation_handling
	Collation handling of the function.
Public Attributes inherited from duckdb::SimpleFunction
vector< LogicalType >	arguments
	The set of arguments of the function.
vector< LogicalType >	original_arguments
LogicalType	varargs
Public Attributes inherited from duckdb::Function
string	name
	The name of the function.
string	extra_info
	Additional Information to specify function from it's name.
string	catalog_name
string	schema_name

Member Function Documentation

SetReturnType()

void duckdb::BaseScalarFunction::SetReturnType ( LogicalType  return_type_p )

inline

                                                  {
        return_type = std::move(return_type_p);
    }

GetReturnType() [1/2]

const LogicalType & duckdb::BaseScalarFunction::GetReturnType ( ) const

inline

                                             {
        return return_type;
    }

GetReturnType() [2/2]

LogicalType & duckdb::BaseScalarFunction::GetReturnType ( )

inline

                                 {
        return return_type;
    }

GetStability()

FunctionStability duckdb::BaseScalarFunction::GetStability ( ) const

inline

                                           {
        return stability;
    }

SetStability()

void duckdb::BaseScalarFunction::SetStability ( FunctionStability  stability_p )

inline

                                                     {
        stability = stability_p;
    }

GetNullHandling()

FunctionNullHandling duckdb::BaseScalarFunction::GetNullHandling ( ) const

inline

                                                 {
        return null_handling;
    }

SetNullHandling()

void duckdb::BaseScalarFunction::SetNullHandling ( FunctionNullHandling  null_handling_p )

inline

                                                               {
        null_handling = null_handling_p;
    }

GetErrorMode()

FunctionErrors duckdb::BaseScalarFunction::GetErrorMode ( ) const

inline

                                        {
        return errors;
    }

SetErrorMode()

void duckdb::BaseScalarFunction::SetErrorMode ( FunctionErrors  errors_p )

inline

                                               {
        errors = errors_p;
    }

SetFallible()

void duckdb::BaseScalarFunction::SetFallible ( )

inline

Set this functions error-mode as fallible (can throw runtime errors)

                       {
        errors = FunctionErrors::CAN_THROW_RUNTIME_ERROR;
    }

SetVolatile()

void duckdb::BaseScalarFunction::SetVolatile ( )

inline

Set this functions stability as volatile (can not be cached per row)

                       {
        stability = FunctionStability::VOLATILE;
    }

SetCollationHandling()

void duckdb::BaseScalarFunction::SetCollationHandling ( FunctionCollationHandling  collation_handling_p )

inline

                                                                              {
        collation_handling = collation_handling_p;
    }

GetCollationHandling()

FunctionCollationHandling duckdb::BaseScalarFunction::GetCollationHandling ( ) const

inline

                                                           {
        return collation_handling;
    }

SetReturnsError()

static BaseScalarFunction duckdb::BaseScalarFunction::SetReturnsError ( BaseScalarFunction &  function )

inlinestatic

                                                                            {
        function.errors = FunctionErrors::CAN_THROW_RUNTIME_ERROR;
        return function;
    }

ToString()

DUCKDB_API string duckdb::BaseScalarFunction::ToString ( ) const

overridevirtual

Reimplemented from duckdb::SimpleFunction.

---

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

• external/duckdb/duckdb.hpp