pg_proc.h File Reference

#include "catalog/genbki.h"
#include "catalog/objectaddress.h"
#include "catalog/pg_proc_d.h"
#include "nodes/pg_list.h"

Include dependency graph for pg_proc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef FormData_pg_proc *	Form_pg_proc

Functions
	CATALOG (pg_proc, 1255, ProcedureRelationId) BKI_BOOTSTRAP BKI_ROWTYPE_OID(81
Oid pronamespace	BKI_DEFAULT (pg_catalog) BKI_LOOKUP(pg_namespace)
Oid proowner	BKI_DEFAULT (POSTGRES) BKI_LOOKUP(pg_authid)
Oid prolang	BKI_DEFAULT (internal) BKI_LOOKUP(pg_language)
float4 procost	BKI_DEFAULT (1)
float4 prorows	BKI_DEFAULT (0)
char prokind	BKI_DEFAULT (f)
bool proisstrict	BKI_DEFAULT (t)
char provolatile	BKI_DEFAULT (i)
char proparallel	BKI_DEFAULT (s)
Oid prorettype	BKI_LOOKUP (pg_type)
	DECLARE_TOAST (pg_proc, 2836, 2837)
	DECLARE_UNIQUE_INDEX_PKEY (pg_proc_oid_index, 2690, ProcedureOidIndexId, pg_proc, btree(oid oid_ops))
	DECLARE_UNIQUE_INDEX (pg_proc_proname_args_nsp_index, 2691, ProcedureNameArgsNspIndexId, pg_proc, btree(proname name_ops, proargtypes oidvector_ops, pronamespace oid_ops))
	MAKE_SYSCACHE (PROCOID, pg_proc_oid_index, 128)
	MAKE_SYSCACHE (PROCNAMEARGSNSP, pg_proc_proname_args_nsp_index, 128)
ObjectAddress	ProcedureCreate (const char *procedureName, Oid procNamespace, bool replace, bool returnsSet, Oid returnType, Oid proowner, Oid languageObjectId, Oid languageValidator, const char *prosrc, const char *probin, Node *prosqlbody, char prokind, bool security_definer, bool isLeakProof, bool isStrict, char volatility, char parallel, oidvector *parameterTypes, Datum allParameterTypes, Datum parameterModes, Datum parameterNames, List *parameterDefaults, Datum trftypes, Datum proconfig, Oid prosupport, float4 procost, float4 prorows)
bool	function_parse_error_transpose (const char *prosrc)
List *	oid_array_to_list (Datum datum)

Variables
ProcedureRelation_Rowtype_Id	BKI_SCHEMA_MACRO
NameData	proname
int16	pronargs
	FormData_pg_proc

Typedef Documentation

Form_pg_proc

typedef FormData_pg_proc* Form_pg_proc

Definition at line 136 of file pg_proc.h.

Function Documentation

BKI_DEFAULT() [1/9]

float4 prorows BKI_DEFAULT

(

0

)

BKI_DEFAULT() [2/9]

float4 procost BKI_DEFAULT

(

1

)

BKI_DEFAULT() [3/9]

char prokind BKI_DEFAULT

(

f

)

BKI_DEFAULT() [4/9]

char provolatile BKI_DEFAULT

(

i

)

BKI_DEFAULT() [5/9]

Oid prolang BKI_DEFAULT

(

internal

)

BKI_DEFAULT() [6/9]

Oid pronamespace BKI_DEFAULT

(

pg_catalog

)

BKI_DEFAULT() [7/9]

Oid proowner BKI_DEFAULT

(

POSTGRES

)

BKI_DEFAULT() [8/9]

char proparallel BKI_DEFAULT

(

s

)

BKI_DEFAULT() [9/9]

bool proisstrict BKI_DEFAULT

(

t

)

BKI_LOOKUP()

oidvector proargtypes BKI_LOOKUP

(

pg_type

)

CATALOG()

CATALOG	(	pg_proc	,
		1255	,
		ProcedureRelationId
	)

DECLARE_TOAST()

DECLARE_TOAST	(	pg_proc	,
		2836	,
		2837
	)

DECLARE_UNIQUE_INDEX()

DECLARE_UNIQUE_INDEX	(	pg_proc_proname_args_nsp_index	,
		2691	,
		ProcedureNameArgsNspIndexId	,
		pg_proc	,
		btree(proname name_ops, proargtypes oidvector_ops, pronamespace oid_ops)
	)

DECLARE_UNIQUE_INDEX_PKEY()

DECLARE_UNIQUE_INDEX_PKEY	(	pg_proc_oid_index	,
		2690	,
		ProcedureOidIndexId	,
		pg_proc	,
		btree(oid oid_ops)
	)

function_parse_error_transpose()

bool function_parse_error_transpose

(

const char *

prosrc

)

Definition at line 1002 of file pg_proc.c.

{
    int         origerrposition;
    int         newerrposition;
 
    /*
     * Nothing to do unless we are dealing with a syntax error that has a
     * cursor position.
     *
     * Some PLs may prefer to report the error position as an internal error
     * to begin with, so check that too.
     */
    origerrposition = geterrposition();
    if (origerrposition <= 0)
    {
        origerrposition = getinternalerrposition();
        if (origerrposition <= 0)
            return false;
    }
 
    /* We can get the original query text from the active portal (hack...) */
    if (ActivePortal && ActivePortal->status == PORTAL_ACTIVE)
    {
        const char *queryText = ActivePortal->sourceText;
 
        /* Try to locate the prosrc in the original text */
        newerrposition = match_prosrc_to_query(prosrc, queryText,
                                               origerrposition);
    }
    else
    {
        /*
         * Quietly give up if no ActivePortal.  This is an unusual situation
         * but it can happen in, e.g., logical replication workers.
         */
        newerrposition = -1;
    }
 
    if (newerrposition > 0)
    {
        /* Successful, so fix error position to reference original query */
        errposition(newerrposition);
        /* Get rid of any report of the error as an "internal query" */
        internalerrposition(0);
        internalerrquery(NULL);
    }
    else
    {
        /*
         * If unsuccessful, convert the position to an internal position
         * marker and give the function text as the internal query.
         */
        errposition(0);
        internalerrposition(origerrposition);
        internalerrquery(prosrc);
    }
 
    return true;
}

References ActivePortal, errposition(), geterrposition(), getinternalerrposition(), internalerrposition(), internalerrquery(), match_prosrc_to_query(), PORTAL_ACTIVE, PortalData::sourceText, and PortalData::status.

Referenced by plpgsql_compile_error_callback(), and sql_function_parse_error_callback().

MAKE_SYSCACHE() [1/2]

MAKE_SYSCACHE	(	PROCNAMEARGSNSP	,
		pg_proc_proname_args_nsp_index	,
		128
	)

MAKE_SYSCACHE() [2/2]

MAKE_SYSCACHE	(	PROCOID	,
		pg_proc_oid_index	,
		128
	)

oid_array_to_list()

List * oid_array_to_list

(

Datum

datum

)

Definition at line 1184 of file pg_proc.c.

{
    ArrayType  *array = DatumGetArrayTypeP(datum);
    Datum      *values;
    int         nelems;
    int         i;
    List       *result = NIL;
 
    deconstruct_array_builtin(array, OIDOID, &values, NULL, &nelems);
    for (i = 0; i < nelems; i++)
        result = lappend_oid(result, values[i]);
    return result;
}

References DatumGetArrayTypeP, deconstruct_array_builtin(), i, lappend_oid(), NIL, and values.

Referenced by compile_plperl_function(), and PLy_procedure_create().

ProcedureCreate()

ObjectAddress ProcedureCreate	(	const char *	procedureName,
		Oid	procNamespace,
		bool	replace,
		bool	returnsSet,
		Oid	returnType,
		Oid	proowner,
		Oid	languageObjectId,
		Oid	languageValidator,
		const char *	prosrc,
		const char *	probin,
		Node *	prosqlbody,
		char	prokind,
		bool	security_definer,
		bool	isLeakProof,
		bool	isStrict,
		char	volatility,
		char	parallel,
		oidvector *	parameterTypes,
		Datum	allParameterTypes,
		Datum	parameterModes,
		Datum	parameterNames,
		List *	parameterDefaults,
		Datum	trftypes,
		Datum	proconfig,
		Oid	prosupport,
		float4	procost,
		float4	prorows
	)

Definition at line 70 of file pg_proc.c.

{
    Oid         retval;
    int         parameterCount;
    int         allParamCount;
    Oid        *allParams;
    char       *paramModes = NULL;
    Oid         variadicType = InvalidOid;
    Acl        *proacl = NULL;
    Relation    rel;
    HeapTuple   tup;
    HeapTuple   oldtup;
    bool        nulls[Natts_pg_proc];
    Datum       values[Natts_pg_proc];
    bool        replaces[Natts_pg_proc];
    NameData    procname;
    TupleDesc   tupDesc;
    bool        is_update;
    ObjectAddress myself,
                referenced;
    char       *detailmsg;
    int         i;
    Oid         trfid;
    ObjectAddresses *addrs;
 
    /*
     * sanity checks
     */
    Assert(PointerIsValid(prosrc));
 
    parameterCount = parameterTypes->dim1;
    if (parameterCount < 0 || parameterCount > FUNC_MAX_ARGS)
        ereport(ERROR,
                (errcode(ERRCODE_TOO_MANY_ARGUMENTS),
                 errmsg_plural("functions cannot have more than %d argument",
                               "functions cannot have more than %d arguments",
                               FUNC_MAX_ARGS,
                               FUNC_MAX_ARGS)));
    /* note: the above is correct, we do NOT count output arguments */
 
    /* Deconstruct array inputs */
    if (allParameterTypes != PointerGetDatum(NULL))
    {
        /*
         * We expect the array to be a 1-D OID array; verify that. We don't
         * need to use deconstruct_array() since the array data is just going
         * to look like a C array of OID values.
         */
        ArrayType  *allParamArray = (ArrayType *) DatumGetPointer(allParameterTypes);
 
        allParamCount = ARR_DIMS(allParamArray)[0];
        if (ARR_NDIM(allParamArray) != 1 ||
            allParamCount <= 0 ||
            ARR_HASNULL(allParamArray) ||
            ARR_ELEMTYPE(allParamArray) != OIDOID)
            elog(ERROR, "allParameterTypes is not a 1-D Oid array");
        allParams = (Oid *) ARR_DATA_PTR(allParamArray);
        Assert(allParamCount >= parameterCount);
        /* we assume caller got the contents right */
    }
    else
    {
        allParamCount = parameterCount;
        allParams = parameterTypes->values;
    }
 
    if (parameterModes != PointerGetDatum(NULL))
    {
        /*
         * We expect the array to be a 1-D CHAR array; verify that. We don't
         * need to use deconstruct_array() since the array data is just going
         * to look like a C array of char values.
         */
        ArrayType  *modesArray = (ArrayType *) DatumGetPointer(parameterModes);
 
        if (ARR_NDIM(modesArray) != 1 ||
            ARR_DIMS(modesArray)[0] != allParamCount ||
            ARR_HASNULL(modesArray) ||
            ARR_ELEMTYPE(modesArray) != CHAROID)
            elog(ERROR, "parameterModes is not a 1-D char array");
        paramModes = (char *) ARR_DATA_PTR(modesArray);
    }
 
    /*
     * Do not allow polymorphic return type unless there is a polymorphic
     * input argument that we can use to deduce the actual return type.
     */
    detailmsg = check_valid_polymorphic_signature(returnType,
                                                  parameterTypes->values,
                                                  parameterCount);
    if (detailmsg)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
                 errmsg("cannot determine result data type"),
                 errdetail_internal("%s", detailmsg)));
 
    /*
     * Also, do not allow return type INTERNAL unless at least one input
     * argument is INTERNAL.
     */
    detailmsg = check_valid_internal_signature(returnType,
                                               parameterTypes->values,
                                               parameterCount);
    if (detailmsg)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
                 errmsg("unsafe use of pseudo-type \"internal\""),
                 errdetail_internal("%s", detailmsg)));
 
    /*
     * Apply the same tests to any OUT arguments.
     */
    if (allParameterTypes != PointerGetDatum(NULL))
    {
        for (i = 0; i < allParamCount; i++)
        {
            if (paramModes == NULL ||
                paramModes[i] == PROARGMODE_IN ||
                paramModes[i] == PROARGMODE_VARIADIC)
                continue;       /* ignore input-only params */
 
            detailmsg = check_valid_polymorphic_signature(allParams[i],
                                                          parameterTypes->values,
                                                          parameterCount);
            if (detailmsg)
                ereport(ERROR,
                        (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
                         errmsg("cannot determine result data type"),
                         errdetail_internal("%s", detailmsg)));
            detailmsg = check_valid_internal_signature(allParams[i],
                                                       parameterTypes->values,
                                                       parameterCount);
            if (detailmsg)
                ereport(ERROR,
                        (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
                         errmsg("unsafe use of pseudo-type \"internal\""),
                         errdetail_internal("%s", detailmsg)));
        }
    }
 
    /* Identify variadic argument type, if any */
    if (paramModes != NULL)
    {
        /*
         * Only the last input parameter can be variadic; if it is, save its
         * element type.  Errors here are just elog since caller should have
         * checked this already.
         */
        for (i = 0; i < allParamCount; i++)
        {
            switch (paramModes[i])
            {
                case PROARGMODE_IN:
                case PROARGMODE_INOUT:
                    if (OidIsValid(variadicType))
                        elog(ERROR, "variadic parameter must be last");
                    break;
                case PROARGMODE_OUT:
                    if (OidIsValid(variadicType) && prokind == PROKIND_PROCEDURE)
                        elog(ERROR, "variadic parameter must be last");
                    break;
                case PROARGMODE_TABLE:
                    /* okay */
                    break;
                case PROARGMODE_VARIADIC:
                    if (OidIsValid(variadicType))
                        elog(ERROR, "variadic parameter must be last");
                    switch (allParams[i])
                    {
                        case ANYOID:
                            variadicType = ANYOID;
                            break;
                        case ANYARRAYOID:
                            variadicType = ANYELEMENTOID;
                            break;
                        case ANYCOMPATIBLEARRAYOID:
                            variadicType = ANYCOMPATIBLEOID;
                            break;
                        default:
                            variadicType = get_element_type(allParams[i]);
                            if (!OidIsValid(variadicType))
                                elog(ERROR, "variadic parameter is not an array");
                            break;
                    }
                    break;
                default:
                    elog(ERROR, "invalid parameter mode '%c'", paramModes[i]);
                    break;
            }
        }
    }
 
    /*
     * All seems OK; prepare the data to be inserted into pg_proc.
     */
 
    for (i = 0; i < Natts_pg_proc; ++i)
    {
        nulls[i] = false;
        values[i] = (Datum) 0;
        replaces[i] = true;
    }
 
    namestrcpy(&procname, procedureName);
    values[Anum_pg_proc_proname - 1] = NameGetDatum(&procname);
    values[Anum_pg_proc_pronamespace - 1] = ObjectIdGetDatum(procNamespace);
    values[Anum_pg_proc_proowner - 1] = ObjectIdGetDatum(proowner);
    values[Anum_pg_proc_prolang - 1] = ObjectIdGetDatum(languageObjectId);
    values[Anum_pg_proc_procost - 1] = Float4GetDatum(procost);
    values[Anum_pg_proc_prorows - 1] = Float4GetDatum(prorows);
    values[Anum_pg_proc_provariadic - 1] = ObjectIdGetDatum(variadicType);
    values[Anum_pg_proc_prosupport - 1] = ObjectIdGetDatum(prosupport);
    values[Anum_pg_proc_prokind - 1] = CharGetDatum(prokind);
    values[Anum_pg_proc_prosecdef - 1] = BoolGetDatum(security_definer);
    values[Anum_pg_proc_proleakproof - 1] = BoolGetDatum(isLeakProof);
    values[Anum_pg_proc_proisstrict - 1] = BoolGetDatum(isStrict);
    values[Anum_pg_proc_proretset - 1] = BoolGetDatum(returnsSet);
    values[Anum_pg_proc_provolatile - 1] = CharGetDatum(volatility);
    values[Anum_pg_proc_proparallel - 1] = CharGetDatum(parallel);
    values[Anum_pg_proc_pronargs - 1] = UInt16GetDatum(parameterCount);
    values[Anum_pg_proc_pronargdefaults - 1] = UInt16GetDatum(list_length(parameterDefaults));
    values[Anum_pg_proc_prorettype - 1] = ObjectIdGetDatum(returnType);
    values[Anum_pg_proc_proargtypes - 1] = PointerGetDatum(parameterTypes);
    if (allParameterTypes != PointerGetDatum(NULL))
        values[Anum_pg_proc_proallargtypes - 1] = allParameterTypes;
    else
        nulls[Anum_pg_proc_proallargtypes - 1] = true;
    if (parameterModes != PointerGetDatum(NULL))
        values[Anum_pg_proc_proargmodes - 1] = parameterModes;
    else
        nulls[Anum_pg_proc_proargmodes - 1] = true;
    if (parameterNames != PointerGetDatum(NULL))
        values[Anum_pg_proc_proargnames - 1] = parameterNames;
    else
        nulls[Anum_pg_proc_proargnames - 1] = true;
    if (parameterDefaults != NIL)
        values[Anum_pg_proc_proargdefaults - 1] = CStringGetTextDatum(nodeToString(parameterDefaults));
    else
        nulls[Anum_pg_proc_proargdefaults - 1] = true;
    if (trftypes != PointerGetDatum(NULL))
        values[Anum_pg_proc_protrftypes - 1] = trftypes;
    else
        nulls[Anum_pg_proc_protrftypes - 1] = true;
    values[Anum_pg_proc_prosrc - 1] = CStringGetTextDatum(prosrc);
    if (probin)
        values[Anum_pg_proc_probin - 1] = CStringGetTextDatum(probin);
    else
        nulls[Anum_pg_proc_probin - 1] = true;
    if (prosqlbody)
        values[Anum_pg_proc_prosqlbody - 1] = CStringGetTextDatum(nodeToString(prosqlbody));
    else
        nulls[Anum_pg_proc_prosqlbody - 1] = true;
    if (proconfig != PointerGetDatum(NULL))
        values[Anum_pg_proc_proconfig - 1] = proconfig;
    else
        nulls[Anum_pg_proc_proconfig - 1] = true;
    /* proacl will be determined later */
 
    rel = table_open(ProcedureRelationId, RowExclusiveLock);
    tupDesc = RelationGetDescr(rel);
 
    /* Check for pre-existing definition */
    oldtup = SearchSysCache3(PROCNAMEARGSNSP,
                             PointerGetDatum(procedureName),
                             PointerGetDatum(parameterTypes),
                             ObjectIdGetDatum(procNamespace));
 
    if (HeapTupleIsValid(oldtup))
    {
        /* There is one; okay to replace it? */
        Form_pg_proc oldproc = (Form_pg_proc) GETSTRUCT(oldtup);
        Datum       proargnames;
        bool        isnull;
        const char *dropcmd;
 
        if (!replace)
            ereport(ERROR,
                    (errcode(ERRCODE_DUPLICATE_FUNCTION),
                     errmsg("function \"%s\" already exists with same argument types",
                            procedureName)));
        if (!object_ownercheck(ProcedureRelationId, oldproc->oid, proowner))
            aclcheck_error(ACLCHECK_NOT_OWNER, OBJECT_FUNCTION,
                           procedureName);
 
        /* Not okay to change routine kind */
        if (oldproc->prokind != prokind)
            ereport(ERROR,
                    (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                     errmsg("cannot change routine kind"),
                     (oldproc->prokind == PROKIND_AGGREGATE ?
                      errdetail("\"%s\" is an aggregate function.", procedureName) :
                      oldproc->prokind == PROKIND_FUNCTION ?
                      errdetail("\"%s\" is a function.", procedureName) :
                      oldproc->prokind == PROKIND_PROCEDURE ?
                      errdetail("\"%s\" is a procedure.", procedureName) :
                      oldproc->prokind == PROKIND_WINDOW ?
                      errdetail("\"%s\" is a window function.", procedureName) :
                      0)));
 
        dropcmd = (prokind == PROKIND_PROCEDURE ? "DROP PROCEDURE" :
                   prokind == PROKIND_AGGREGATE ? "DROP AGGREGATE" :
                   "DROP FUNCTION");
 
        /*
         * Not okay to change the return type of the existing proc, since
         * existing rules, views, etc may depend on the return type.
         *
         * In case of a procedure, a changing return type means that whether
         * the procedure has output parameters was changed.  Since there is no
         * user visible return type, we produce a more specific error message.
         */
        if (returnType != oldproc->prorettype ||
            returnsSet != oldproc->proretset)
            ereport(ERROR,
                    (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
                     prokind == PROKIND_PROCEDURE
                     ? errmsg("cannot change whether a procedure has output parameters")
                     : errmsg("cannot change return type of existing function"),
 
            /*
             * translator: first %s is DROP FUNCTION, DROP PROCEDURE, or DROP
             * AGGREGATE
             */
                     errhint("Use %s %s first.",
                             dropcmd,
                             format_procedure(oldproc->oid))));
 
        /*
         * If it returns RECORD, check for possible change of record type
         * implied by OUT parameters
         */
        if (returnType == RECORDOID)
        {
            TupleDesc   olddesc;
            TupleDesc   newdesc;
 
            olddesc = build_function_result_tupdesc_t(oldtup);
            newdesc = build_function_result_tupdesc_d(prokind,
                                                      allParameterTypes,
                                                      parameterModes,
                                                      parameterNames);
            if (olddesc == NULL && newdesc == NULL)
                 /* ok, both are runtime-defined RECORDs */ ;
            else if (olddesc == NULL || newdesc == NULL ||
                     !equalRowTypes(olddesc, newdesc))
                ereport(ERROR,
                        (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
                         errmsg("cannot change return type of existing function"),
                         errdetail("Row type defined by OUT parameters is different."),
                /* translator: first %s is DROP FUNCTION or DROP PROCEDURE */
                         errhint("Use %s %s first.",
                                 dropcmd,
                                 format_procedure(oldproc->oid))));
        }
 
        /*
         * If there were any named input parameters, check to make sure the
         * names have not been changed, as this could break existing calls. We
         * allow adding names to formerly unnamed parameters, though.
         */
        proargnames = SysCacheGetAttr(PROCNAMEARGSNSP, oldtup,
                                      Anum_pg_proc_proargnames,
                                      &isnull);
        if (!isnull)
        {
            Datum       proargmodes;
            char      **old_arg_names;
            char      **new_arg_names;
            int         n_old_arg_names;
            int         n_new_arg_names;
            int         j;
 
            proargmodes = SysCacheGetAttr(PROCNAMEARGSNSP, oldtup,
                                          Anum_pg_proc_proargmodes,
                                          &isnull);
            if (isnull)
                proargmodes = PointerGetDatum(NULL);    /* just to be sure */
 
            n_old_arg_names = get_func_input_arg_names(proargnames,
                                                       proargmodes,
                                                       &old_arg_names);
            n_new_arg_names = get_func_input_arg_names(parameterNames,
                                                       parameterModes,
                                                       &new_arg_names);
            for (j = 0; j < n_old_arg_names; j++)
            {
                if (old_arg_names[j] == NULL)
                    continue;
                if (j >= n_new_arg_names || new_arg_names[j] == NULL ||
                    strcmp(old_arg_names[j], new_arg_names[j]) != 0)
                    ereport(ERROR,
                            (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
                             errmsg("cannot change name of input parameter \"%s\"",
                                    old_arg_names[j]),
                    /* translator: first %s is DROP FUNCTION or DROP PROCEDURE */
                             errhint("Use %s %s first.",
                                     dropcmd,
                                     format_procedure(oldproc->oid))));
            }
        }
 
        /*
         * If there are existing defaults, check compatibility: redefinition
         * must not remove any defaults nor change their types.  (Removing a
         * default might cause a function to fail to satisfy an existing call.
         * Changing type would only be possible if the associated parameter is
         * polymorphic, and in such cases a change of default type might alter
         * the resolved output type of existing calls.)
         */
        if (oldproc->pronargdefaults != 0)
        {
            Datum       proargdefaults;
            List       *oldDefaults;
            ListCell   *oldlc;
            ListCell   *newlc;
 
            if (list_length(parameterDefaults) < oldproc->pronargdefaults)
                ereport(ERROR,
                        (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
                         errmsg("cannot remove parameter defaults from existing function"),
                /* translator: first %s is DROP FUNCTION or DROP PROCEDURE */
                         errhint("Use %s %s first.",
                                 dropcmd,
                                 format_procedure(oldproc->oid))));
 
            proargdefaults = SysCacheGetAttrNotNull(PROCNAMEARGSNSP, oldtup,
                                                    Anum_pg_proc_proargdefaults);
            oldDefaults = castNode(List, stringToNode(TextDatumGetCString(proargdefaults)));
            Assert(list_length(oldDefaults) == oldproc->pronargdefaults);
 
            /* new list can have more defaults than old, advance over 'em */
            newlc = list_nth_cell(parameterDefaults,
                                  list_length(parameterDefaults) -
                                  oldproc->pronargdefaults);
 
            foreach(oldlc, oldDefaults)
            {
                Node       *oldDef = (Node *) lfirst(oldlc);
                Node       *newDef = (Node *) lfirst(newlc);
 
                if (exprType(oldDef) != exprType(newDef))
                    ereport(ERROR,
                            (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
                             errmsg("cannot change data type of existing parameter default value"),
                    /* translator: first %s is DROP FUNCTION or DROP PROCEDURE */
                             errhint("Use %s %s first.",
                                     dropcmd,
                                     format_procedure(oldproc->oid))));
                newlc = lnext(parameterDefaults, newlc);
            }
        }
 
        /*
         * Do not change existing oid, ownership or permissions, either.  Note
         * dependency-update code below has to agree with this decision.
         */
        replaces[Anum_pg_proc_oid - 1] = false;
        replaces[Anum_pg_proc_proowner - 1] = false;
        replaces[Anum_pg_proc_proacl - 1] = false;
 
        /* Okay, do it... */
        tup = heap_modify_tuple(oldtup, tupDesc, values, nulls, replaces);
        CatalogTupleUpdate(rel, &tup->t_self, tup);
 
        ReleaseSysCache(oldtup);
        is_update = true;
    }
    else
    {
        /* Creating a new procedure */
        Oid         newOid;
 
        /* First, get default permissions and set up proacl */
        proacl = get_user_default_acl(OBJECT_FUNCTION, proowner,
                                      procNamespace);
        if (proacl != NULL)
            values[Anum_pg_proc_proacl - 1] = PointerGetDatum(proacl);
        else
            nulls[Anum_pg_proc_proacl - 1] = true;
 
        newOid = GetNewOidWithIndex(rel, ProcedureOidIndexId,
                                    Anum_pg_proc_oid);
        values[Anum_pg_proc_oid - 1] = ObjectIdGetDatum(newOid);
        tup = heap_form_tuple(tupDesc, values, nulls);
        CatalogTupleInsert(rel, tup);
        is_update = false;
    }
 
 
    retval = ((Form_pg_proc) GETSTRUCT(tup))->oid;
 
    /*
     * Create dependencies for the new function.  If we are updating an
     * existing function, first delete any existing pg_depend entries.
     * (However, since we are not changing ownership or permissions, the
     * shared dependencies do *not* need to change, and we leave them alone.)
     */
    if (is_update)
        deleteDependencyRecordsFor(ProcedureRelationId, retval, true);
 
    addrs = new_object_addresses();
 
    ObjectAddressSet(myself, ProcedureRelationId, retval);
 
    /* dependency on namespace */
    ObjectAddressSet(referenced, NamespaceRelationId, procNamespace);
    add_exact_object_address(&referenced, addrs);
 
    /* dependency on implementation language */
    ObjectAddressSet(referenced, LanguageRelationId, languageObjectId);
    add_exact_object_address(&referenced, addrs);
 
    /* dependency on return type */
    ObjectAddressSet(referenced, TypeRelationId, returnType);
    add_exact_object_address(&referenced, addrs);
 
    /* dependency on transform used by return type, if any */
    if ((trfid = get_transform_oid(returnType, languageObjectId, true)))
    {
        ObjectAddressSet(referenced, TransformRelationId, trfid);
        add_exact_object_address(&referenced, addrs);
    }
 
    /* dependency on parameter types */
    for (i = 0; i < allParamCount; i++)
    {
        ObjectAddressSet(referenced, TypeRelationId, allParams[i]);
        add_exact_object_address(&referenced, addrs);
 
        /* dependency on transform used by parameter type, if any */
        if ((trfid = get_transform_oid(allParams[i], languageObjectId, true)))
        {
            ObjectAddressSet(referenced, TransformRelationId, trfid);
            add_exact_object_address(&referenced, addrs);
        }
    }
 
    /* dependency on support function, if any */
    if (OidIsValid(prosupport))
    {
        ObjectAddressSet(referenced, ProcedureRelationId, prosupport);
        add_exact_object_address(&referenced, addrs);
    }
 
    record_object_address_dependencies(&myself, addrs, DEPENDENCY_NORMAL);
    free_object_addresses(addrs);
 
    /* dependency on SQL routine body */
    if (languageObjectId == SQLlanguageId && prosqlbody)
        recordDependencyOnExpr(&myself, prosqlbody, NIL, DEPENDENCY_NORMAL);
 
    /* dependency on parameter default expressions */
    if (parameterDefaults)
        recordDependencyOnExpr(&myself, (Node *) parameterDefaults,
                               NIL, DEPENDENCY_NORMAL);
 
    /* dependency on owner */
    if (!is_update)
        recordDependencyOnOwner(ProcedureRelationId, retval, proowner);
 
    /* dependency on any roles mentioned in ACL */
    if (!is_update)
        recordDependencyOnNewAcl(ProcedureRelationId, retval, 0,
                                 proowner, proacl);
 
    /* dependency on extension */
    recordDependencyOnCurrentExtension(&myself, is_update);
 
    heap_freetuple(tup);
 
    /* Post creation hook for new function */
    InvokeObjectPostCreateHook(ProcedureRelationId, retval, 0);
 
    table_close(rel, RowExclusiveLock);
 
    /* Verify function body */
    if (OidIsValid(languageValidator))
    {
        ArrayType  *set_items = NULL;
        int         save_nestlevel = 0;
 
        /* Advance command counter so new tuple can be seen by validator */
        CommandCounterIncrement();
 
        /*
         * Set per-function configuration parameters so that the validation is
         * done with the environment the function expects.  However, if
         * check_function_bodies is off, we don't do this, because that would
         * create dump ordering hazards that pg_dump doesn't know how to deal
         * with.  (For example, a SET clause might refer to a not-yet-created
         * text search configuration.)  This means that the validator
         * shouldn't complain about anything that might depend on a GUC
         * parameter when check_function_bodies is off.
         */
        if (check_function_bodies)
        {
            set_items = (ArrayType *) DatumGetPointer(proconfig);
            if (set_items)      /* Need a new GUC nesting level */
            {
                save_nestlevel = NewGUCNestLevel();
                ProcessGUCArray(set_items,
                                (superuser() ? PGC_SUSET : PGC_USERSET),
                                PGC_S_SESSION,
                                GUC_ACTION_SAVE);
            }
        }
 
        OidFunctionCall1(languageValidator, ObjectIdGetDatum(retval));
 
        if (set_items)
            AtEOXact_GUC(true, save_nestlevel);
    }
 
    /* ensure that stats are dropped if transaction aborts */
    if (!is_update)
        pgstat_create_function(retval);
 
    return myself;
}

References aclcheck_error(), ACLCHECK_NOT_OWNER, add_exact_object_address(), ARR_DATA_PTR, ARR_DIMS, ARR_ELEMTYPE, ARR_HASNULL, ARR_NDIM, Assert, AtEOXact_GUC(), BoolGetDatum(), build_function_result_tupdesc_d(), build_function_result_tupdesc_t(), castNode, CatalogTupleInsert(), CatalogTupleUpdate(), CharGetDatum(), check_function_bodies, check_valid_internal_signature(), check_valid_polymorphic_signature(), CommandCounterIncrement(), CStringGetTextDatum, DatumGetPointer(), deleteDependencyRecordsFor(), DEPENDENCY_NORMAL, oidvector::dim1, elog, equalRowTypes(), ereport, errcode(), errdetail(), errdetail_internal(), errhint(), errmsg(), errmsg_plural(), ERROR, exprType(), Float4GetDatum(), format_procedure(), free_object_addresses(), FUNC_MAX_ARGS, get_element_type(), get_func_input_arg_names(), get_transform_oid(), get_user_default_acl(), GetNewOidWithIndex(), GETSTRUCT, GUC_ACTION_SAVE, heap_form_tuple(), heap_freetuple(), heap_modify_tuple(), HeapTupleIsValid, i, InvalidOid, InvokeObjectPostCreateHook, j, lfirst, list_length(), list_nth_cell(), lnext(), NameGetDatum(), namestrcpy(), new_object_addresses(), NewGUCNestLevel(), NIL, nodeToString(), OBJECT_FUNCTION, object_ownercheck(), ObjectAddressSet, ObjectIdGetDatum(), OidFunctionCall1, OidIsValid, PGC_S_SESSION, PGC_SUSET, PGC_USERSET, pgstat_create_function(), PointerGetDatum(), PointerIsValid, ProcessGUCArray(), record_object_address_dependencies(), recordDependencyOnCurrentExtension(), recordDependencyOnExpr(), recordDependencyOnNewAcl(), recordDependencyOnOwner(), RelationGetDescr, ReleaseSysCache(), RowExclusiveLock, SearchSysCache3(), stringToNode(), superuser(), SysCacheGetAttr(), SysCacheGetAttrNotNull(), HeapTupleData::t_self, table_close(), table_open(), TextDatumGetCString, UInt16GetDatum(), oidvector::values, and values.

Referenced by AggregateCreate(), CreateFunction(), makeMultirangeConstructors(), and makeRangeConstructors().

Variable Documentation

BKI_SCHEMA_MACRO

ProcedureRelation_Rowtype_Id BKI_SCHEMA_MACRO

Initial value:

{
    Oid         oid

Definition at line 30 of file pg_proc.h.

FormData_pg_proc

FormData_pg_proc

Definition at line 129 of file pg_proc.h.

proname

NameData proname

Definition at line 35 of file pg_proc.h.

Referenced by appendFunctionName(), fmgr_internal_function(), format_procedure_extended(), FunctionIsVisibleExt(), generate_function_name(), getObjectDescription(), getObjectIdentityParts(), IsThereFunctionInNamespace(), plpgsql_resolve_polymorphic_argtypes(), plsample_func_handler(), plsample_trigger_handler(), PLy_traceback(), print_function_sqlbody(), regprocout(), and throw_tcl_error().

pronargs

int16 pronargs

Definition at line 81 of file pg_proc.h.

Referenced by add_function_defaults(), expand_function_arguments(), FuncnameGetCandidates(), get_func_nargs(), IsThereFunctionInNamespace(), makeRangeConstructors(), MatchNamedCall(), ParseFuncOrColumn(), recheck_cast_function_args(), and reorder_function_arguments().