Vertica documentation is moving! Use our new documentation site at https://docs.rocketsoftware.com/bundle/vertica_24.2/page/index.html

Vertica::ServerInterface::FunctionDescription Struct Reference

Collaboration diagram for Vertica::ServerInterface::FunctionDescription:

Public Types
enum FunctionType { FT_SCALAR, FT_AGGREGATE, FT_ANALYTIC, FT_EXTPROC, FT_UDSF, FT_UDAGG, FT_UDAN, FT_UDT, FT_UDT_MULTI, FT_UDT_CURSOR, FT_UDPARSE, FT_UDFILTER, FT_UDSOURCE }
Public Attributes
std::vector< std::string > argNames
std::vector< VerticaType > argTypes
std::string binary
std::string databaseName
std::string functionName
Oid functionOid
enum Vertica::ServerInterface::FunctionDescription::FunctionType functionType
bool isFenced
bool isInternal
bool isStrict
std::string language
std::string libraryFileName
std::string libraryName
Oid libraryOid
std::vector< std::string > returnNames
std::vector< VerticaType > returnTypes
std::string schemaName
std::string source
char volatility

Detailed Description

Structure to describe the name and properties of a function, It is to be used in the methods below.

Member Data Documentation

◆databaseName

std::string Vertica::ServerInterface::FunctionDescription::databaseName

Database name

◆functionName

std::string Vertica::ServerInterface::FunctionDescription::functionName

Table name, projection basename, or projection name

◆functionOid

Oid Vertica::ServerInterface::FunctionDescription::functionOid

Function OID, for lookups if this is nonzero it takes precedence

◆isFenced

bool Vertica::ServerInterface::FunctionDescription::isFenced

Is fenced

◆isInternal

bool Vertica::ServerInterface::FunctionDescription::isInternal

Is internal / built in function

◆isStrict

bool Vertica::ServerInterface::FunctionDescription::isStrict

Is strict

◆schemaName

std::string Vertica::ServerInterface::FunctionDescription::schemaName

Schema name; on lookup if empty the search path will be consulted

◆volatility

char Vertica::ServerInterface::FunctionDescription::volatility

Volatility