duckdb::PragmaFunction Class Reference

#include <duckdb.hpp>

Inheritance diagram for duckdb::PragmaFunction:

Collaboration diagram for duckdb::PragmaFunction:

Public Member Functions
DUCKDB_API string	ToString () const override
Public Member Functions inherited from duckdb::SimpleNamedParameterFunction
DUCKDB_API	SimpleNamedParameterFunction (string name, vector< LogicalType > arguments, LogicalType varargs=LogicalType(LogicalTypeId::INVALID))
DUCKDB_API string	ToString () const override
DUCKDB_API bool	HasNamedParameters () const
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 DUCKDB_API PragmaFunction	PragmaCall (const string &name, pragma_query_t query, vector< LogicalType > arguments, LogicalType varargs=LogicalType::INVALID)
static DUCKDB_API PragmaFunction	PragmaCall (const string &name, pragma_function_t function, vector< LogicalType > arguments, LogicalType varargs=LogicalType::INVALID)
static DUCKDB_API PragmaFunction	PragmaStatement (const string &name, pragma_query_t query)
static DUCKDB_API PragmaFunction	PragmaStatement (const string &name, pragma_function_t 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
PragmaType	type
pragma_query_t	query
pragma_function_t	function
named_parameter_type_map_t	named_parameters
Public Attributes inherited from duckdb::SimpleNamedParameterFunction
named_parameter_type_map_t	named_parameters
	The named parameters 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

Private Member Functions
	PragmaFunction (string name, PragmaType pragma_type, pragma_query_t query, pragma_function_t function, vector< LogicalType > arguments, LogicalType varargs)

Detailed Description

Pragma functions are invoked by calling PRAGMA x Pragma functions come in three types:

• Call: function call, e.g. PRAGMA table_info('tbl') -> call statements can take multiple parameters
• Statement: statement without parameters, e.g. PRAGMA show_tables -> this is similar to a call pragma but without parameters Pragma functions can either return a new query to execute (pragma_query_t) or they can

Member Function Documentation

ToString()

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

overridevirtual

Reimplemented from duckdb::SimpleFunction.

---

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

• external/duckdb/duckdb.hpp