PostgreSQL Source Code  git master
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_procForm_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, on pg_proc using btree(oid oid_ops))
 
 DECLARE_UNIQUE_INDEX (pg_proc_proname_args_nsp_index, 2691, ProcedureNameArgsNspIndexId, on pg_proc using btree(proname name_ops, proargtypes oidvector_ops, pronamespace oid_ops))
 
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)
 
Listoid_array_to_list (Datum datum)
 

Variables

ProcedureRelation_Rowtype_Id BKI_SCHEMA_MACRO
 
NameData proname
 
int16 pronargs
 
 FormData_pg_proc
 

Typedef Documentation

◆ Form_pg_proc

Definition at line 136 of file pg_proc.h.

Function Documentation

◆ BKI_DEFAULT() [1/9]

Oid pronamespace BKI_DEFAULT ( pg_catalog  )

◆ BKI_DEFAULT() [2/9]

Oid proowner BKI_DEFAULT ( POSTGRES  )

◆ BKI_DEFAULT() [3/9]

Oid prolang BKI_DEFAULT ( internal  )

◆ BKI_DEFAULT() [4/9]

float4 procost BKI_DEFAULT ( )

◆ BKI_DEFAULT() [5/9]

float4 prorows BKI_DEFAULT ( )

◆ BKI_DEFAULT() [6/9]

char prokind BKI_DEFAULT ( )

◆ BKI_DEFAULT() [7/9]

bool proisstrict BKI_DEFAULT ( )

◆ BKI_DEFAULT() [8/9]

char provolatile BKI_DEFAULT ( i  )

◆ BKI_DEFAULT() [9/9]

char proparallel BKI_DEFAULT ( )

◆ 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  ,
on pg_proc using   btreeproname name_ops, proargtypes oidvector_ops, pronamespace oid_ops 
)

◆ DECLARE_UNIQUE_INDEX_PKEY()

DECLARE_UNIQUE_INDEX_PKEY ( pg_proc_oid_index  ,
2690  ,
ProcedureOidIndexId  ,
on pg_proc using   btreeoid oid_ops 
)

◆ function_parse_error_transpose()

bool function_parse_error_transpose ( const char *  prosrc)

Definition at line 992 of file pg_proc.c.

References ActivePortal, Assert, 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().

993 {
994  int origerrposition;
995  int newerrposition;
996  const char *queryText;
997 
998  /*
999  * Nothing to do unless we are dealing with a syntax error that has a
1000  * cursor position.
1001  *
1002  * Some PLs may prefer to report the error position as an internal error
1003  * to begin with, so check that too.
1004  */
1005  origerrposition = geterrposition();
1006  if (origerrposition <= 0)
1007  {
1008  origerrposition = getinternalerrposition();
1009  if (origerrposition <= 0)
1010  return false;
1011  }
1012 
1013  /* We can get the original query text from the active portal (hack...) */
1015  queryText = ActivePortal->sourceText;
1016 
1017  /* Try to locate the prosrc in the original text */
1018  newerrposition = match_prosrc_to_query(prosrc, queryText, origerrposition);
1019 
1020  if (newerrposition > 0)
1021  {
1022  /* Successful, so fix error position to reference original query */
1023  errposition(newerrposition);
1024  /* Get rid of any report of the error as an "internal query" */
1026  internalerrquery(NULL);
1027  }
1028  else
1029  {
1030  /*
1031  * If unsuccessful, convert the position to an internal position
1032  * marker and give the function text as the internal query.
1033  */
1034  errposition(0);
1035  internalerrposition(origerrposition);
1036  internalerrquery(prosrc);
1037  }
1038 
1039  return true;
1040 }
Portal ActivePortal
Definition: pquery.c:35
int geterrposition(void)
Definition: elog.c:1417
int getinternalerrposition(void)
Definition: elog.c:1434
const char * sourceText
Definition: portal.h:135
int internalerrquery(const char *query)
Definition: elog.c:1321
#define Assert(condition)
Definition: c.h:804
PortalStatus status
Definition: portal.h:150
static int match_prosrc_to_query(const char *prosrc, const char *queryText, int cursorpos)
Definition: pg_proc.c:1049
int errposition(int cursorpos)
Definition: elog.c:1285
int internalerrposition(int cursorpos)
Definition: elog.c:1301

◆ oid_array_to_list()

List* oid_array_to_list ( Datum  datum)

Definition at line 1164 of file pg_proc.c.

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

Referenced by compile_plperl_function(), and PLy_procedure_create().

1165 {
1166  ArrayType *array = DatumGetArrayTypeP(datum);
1167  Datum *values;
1168  int nelems;
1169  int i;
1170  List *result = NIL;
1171 
1172  deconstruct_array(array,
1173  OIDOID,
1174  sizeof(Oid), true, TYPALIGN_INT,
1175  &values, NULL, &nelems);
1176  for (i = 0; i < nelems; i++)
1177  result = lappend_oid(result, values[i]);
1178  return result;
1179 }
#define NIL
Definition: pg_list.h:65
unsigned int Oid
Definition: postgres_ext.h:31
List * lappend_oid(List *list, Oid datum)
Definition: list.c:372
uintptr_t Datum
Definition: postgres.h:411
void deconstruct_array(ArrayType *array, Oid elmtype, int elmlen, bool elmbyval, char elmalign, Datum **elemsp, bool **nullsp, int *nelemsp)
Definition: arrayfuncs.c:3490
static Datum values[MAXATTR]
Definition: bootstrap.c:166
int i
Definition: pg_list.h:50
#define DatumGetArrayTypeP(X)
Definition: array.h:254

◆ 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.

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, equalTupleDescs(), 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, lfirst, list_length(), list_nth_cell(), lnext(), NameGetDatum, namestrcpy(), new_object_addresses(), NewGUCNestLevel(), NIL, nodeToString(), OBJECT_FUNCTION, ObjectAddressSet, ObjectIdGetDatum, OidFunctionCall1, OidIsValid, pg_proc_ownercheck(), PGC_S_SESSION, PGC_SUSET, PGC_USERSET, PointerGetDatum, PointerIsValid, ProcessGUCArray(), PROCNAMEARGSNSP, record_object_address_dependencies(), recordDependencyOnCurrentExtension(), recordDependencyOnExpr(), recordDependencyOnNewAcl(), recordDependencyOnOwner(), RelationGetDescr, ReleaseSysCache(), RowExclusiveLock, SearchSysCache3(), stringToNode(), superuser(), SysCacheGetAttr(), HeapTupleData::t_self, table_close(), table_open(), TextDatumGetCString, UInt16GetDatum, values, and oidvector::values.

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

97 {
98  Oid retval;
99  int parameterCount;
100  int allParamCount;
101  Oid *allParams;
102  char *paramModes = NULL;
103  Oid variadicType = InvalidOid;
104  Acl *proacl = NULL;
105  Relation rel;
106  HeapTuple tup;
107  HeapTuple oldtup;
108  bool nulls[Natts_pg_proc];
109  Datum values[Natts_pg_proc];
110  bool replaces[Natts_pg_proc];
111  NameData procname;
112  TupleDesc tupDesc;
113  bool is_update;
114  ObjectAddress myself,
115  referenced;
116  char *detailmsg;
117  int i;
118  Oid trfid;
119  ObjectAddresses *addrs;
120 
121  /*
122  * sanity checks
123  */
124  Assert(PointerIsValid(prosrc));
125 
126  parameterCount = parameterTypes->dim1;
127  if (parameterCount < 0 || parameterCount > FUNC_MAX_ARGS)
128  ereport(ERROR,
129  (errcode(ERRCODE_TOO_MANY_ARGUMENTS),
130  errmsg_plural("functions cannot have more than %d argument",
131  "functions cannot have more than %d arguments",
132  FUNC_MAX_ARGS,
133  FUNC_MAX_ARGS)));
134  /* note: the above is correct, we do NOT count output arguments */
135 
136  /* Deconstruct array inputs */
137  if (allParameterTypes != PointerGetDatum(NULL))
138  {
139  /*
140  * We expect the array to be a 1-D OID array; verify that. We don't
141  * need to use deconstruct_array() since the array data is just going
142  * to look like a C array of OID values.
143  */
144  ArrayType *allParamArray = (ArrayType *) DatumGetPointer(allParameterTypes);
145 
146  allParamCount = ARR_DIMS(allParamArray)[0];
147  if (ARR_NDIM(allParamArray) != 1 ||
148  allParamCount <= 0 ||
149  ARR_HASNULL(allParamArray) ||
150  ARR_ELEMTYPE(allParamArray) != OIDOID)
151  elog(ERROR, "allParameterTypes is not a 1-D Oid array");
152  allParams = (Oid *) ARR_DATA_PTR(allParamArray);
153  Assert(allParamCount >= parameterCount);
154  /* we assume caller got the contents right */
155  }
156  else
157  {
158  allParamCount = parameterCount;
159  allParams = parameterTypes->values;
160  }
161 
162  if (parameterModes != PointerGetDatum(NULL))
163  {
164  /*
165  * We expect the array to be a 1-D CHAR array; verify that. We don't
166  * need to use deconstruct_array() since the array data is just going
167  * to look like a C array of char values.
168  */
169  ArrayType *modesArray = (ArrayType *) DatumGetPointer(parameterModes);
170 
171  if (ARR_NDIM(modesArray) != 1 ||
172  ARR_DIMS(modesArray)[0] != allParamCount ||
173  ARR_HASNULL(modesArray) ||
174  ARR_ELEMTYPE(modesArray) != CHAROID)
175  elog(ERROR, "parameterModes is not a 1-D char array");
176  paramModes = (char *) ARR_DATA_PTR(modesArray);
177  }
178 
179  /*
180  * Do not allow polymorphic return type unless there is a polymorphic
181  * input argument that we can use to deduce the actual return type.
182  */
183  detailmsg = check_valid_polymorphic_signature(returnType,
184  parameterTypes->values,
185  parameterCount);
186  if (detailmsg)
187  ereport(ERROR,
188  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
189  errmsg("cannot determine result data type"),
190  errdetail_internal("%s", detailmsg)));
191 
192  /*
193  * Also, do not allow return type INTERNAL unless at least one input
194  * argument is INTERNAL.
195  */
196  detailmsg = check_valid_internal_signature(returnType,
197  parameterTypes->values,
198  parameterCount);
199  if (detailmsg)
200  ereport(ERROR,
201  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
202  errmsg("unsafe use of pseudo-type \"internal\""),
203  errdetail_internal("%s", detailmsg)));
204 
205  /*
206  * Apply the same tests to any OUT arguments.
207  */
208  if (allParameterTypes != PointerGetDatum(NULL))
209  {
210  for (i = 0; i < allParamCount; i++)
211  {
212  if (paramModes == NULL ||
213  paramModes[i] == PROARGMODE_IN ||
214  paramModes[i] == PROARGMODE_VARIADIC)
215  continue; /* ignore input-only params */
216 
217  detailmsg = check_valid_polymorphic_signature(allParams[i],
218  parameterTypes->values,
219  parameterCount);
220  if (detailmsg)
221  ereport(ERROR,
222  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
223  errmsg("cannot determine result data type"),
224  errdetail_internal("%s", detailmsg)));
225  detailmsg = check_valid_internal_signature(allParams[i],
226  parameterTypes->values,
227  parameterCount);
228  if (detailmsg)
229  ereport(ERROR,
230  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
231  errmsg("unsafe use of pseudo-type \"internal\""),
232  errdetail_internal("%s", detailmsg)));
233  }
234  }
235 
236  /* Identify variadic argument type, if any */
237  if (paramModes != NULL)
238  {
239  /*
240  * Only the last input parameter can be variadic; if it is, save its
241  * element type. Errors here are just elog since caller should have
242  * checked this already.
243  */
244  for (i = 0; i < allParamCount; i++)
245  {
246  switch (paramModes[i])
247  {
248  case PROARGMODE_IN:
249  case PROARGMODE_INOUT:
250  if (OidIsValid(variadicType))
251  elog(ERROR, "variadic parameter must be last");
252  break;
253  case PROARGMODE_OUT:
254  if (OidIsValid(variadicType) && prokind == PROKIND_PROCEDURE)
255  elog(ERROR, "variadic parameter must be last");
256  break;
257  case PROARGMODE_TABLE:
258  /* okay */
259  break;
260  case PROARGMODE_VARIADIC:
261  if (OidIsValid(variadicType))
262  elog(ERROR, "variadic parameter must be last");
263  switch (allParams[i])
264  {
265  case ANYOID:
266  variadicType = ANYOID;
267  break;
268  case ANYARRAYOID:
269  variadicType = ANYELEMENTOID;
270  break;
271  case ANYCOMPATIBLEARRAYOID:
272  variadicType = ANYCOMPATIBLEOID;
273  break;
274  default:
275  variadicType = get_element_type(allParams[i]);
276  if (!OidIsValid(variadicType))
277  elog(ERROR, "variadic parameter is not an array");
278  break;
279  }
280  break;
281  default:
282  elog(ERROR, "invalid parameter mode '%c'", paramModes[i]);
283  break;
284  }
285  }
286  }
287 
288  /*
289  * All seems OK; prepare the data to be inserted into pg_proc.
290  */
291 
292  for (i = 0; i < Natts_pg_proc; ++i)
293  {
294  nulls[i] = false;
295  values[i] = (Datum) 0;
296  replaces[i] = true;
297  }
298 
299  namestrcpy(&procname, procedureName);
300  values[Anum_pg_proc_proname - 1] = NameGetDatum(&procname);
301  values[Anum_pg_proc_pronamespace - 1] = ObjectIdGetDatum(procNamespace);
302  values[Anum_pg_proc_proowner - 1] = ObjectIdGetDatum(proowner);
303  values[Anum_pg_proc_prolang - 1] = ObjectIdGetDatum(languageObjectId);
304  values[Anum_pg_proc_procost - 1] = Float4GetDatum(procost);
305  values[Anum_pg_proc_prorows - 1] = Float4GetDatum(prorows);
306  values[Anum_pg_proc_provariadic - 1] = ObjectIdGetDatum(variadicType);
307  values[Anum_pg_proc_prosupport - 1] = ObjectIdGetDatum(prosupport);
308  values[Anum_pg_proc_prokind - 1] = CharGetDatum(prokind);
309  values[Anum_pg_proc_prosecdef - 1] = BoolGetDatum(security_definer);
310  values[Anum_pg_proc_proleakproof - 1] = BoolGetDatum(isLeakProof);
311  values[Anum_pg_proc_proisstrict - 1] = BoolGetDatum(isStrict);
312  values[Anum_pg_proc_proretset - 1] = BoolGetDatum(returnsSet);
313  values[Anum_pg_proc_provolatile - 1] = CharGetDatum(volatility);
314  values[Anum_pg_proc_proparallel - 1] = CharGetDatum(parallel);
315  values[Anum_pg_proc_pronargs - 1] = UInt16GetDatum(parameterCount);
316  values[Anum_pg_proc_pronargdefaults - 1] = UInt16GetDatum(list_length(parameterDefaults));
317  values[Anum_pg_proc_prorettype - 1] = ObjectIdGetDatum(returnType);
318  values[Anum_pg_proc_proargtypes - 1] = PointerGetDatum(parameterTypes);
319  if (allParameterTypes != PointerGetDatum(NULL))
320  values[Anum_pg_proc_proallargtypes - 1] = allParameterTypes;
321  else
322  nulls[Anum_pg_proc_proallargtypes - 1] = true;
323  if (parameterModes != PointerGetDatum(NULL))
324  values[Anum_pg_proc_proargmodes - 1] = parameterModes;
325  else
326  nulls[Anum_pg_proc_proargmodes - 1] = true;
327  if (parameterNames != PointerGetDatum(NULL))
328  values[Anum_pg_proc_proargnames - 1] = parameterNames;
329  else
330  nulls[Anum_pg_proc_proargnames - 1] = true;
331  if (parameterDefaults != NIL)
332  values[Anum_pg_proc_proargdefaults - 1] = CStringGetTextDatum(nodeToString(parameterDefaults));
333  else
334  nulls[Anum_pg_proc_proargdefaults - 1] = true;
335  if (trftypes != PointerGetDatum(NULL))
336  values[Anum_pg_proc_protrftypes - 1] = trftypes;
337  else
338  nulls[Anum_pg_proc_protrftypes - 1] = true;
339  values[Anum_pg_proc_prosrc - 1] = CStringGetTextDatum(prosrc);
340  if (probin)
341  values[Anum_pg_proc_probin - 1] = CStringGetTextDatum(probin);
342  else
343  nulls[Anum_pg_proc_probin - 1] = true;
344  if (prosqlbody)
345  values[Anum_pg_proc_prosqlbody - 1] = CStringGetTextDatum(nodeToString(prosqlbody));
346  else
347  nulls[Anum_pg_proc_prosqlbody - 1] = true;
348  if (proconfig != PointerGetDatum(NULL))
349  values[Anum_pg_proc_proconfig - 1] = proconfig;
350  else
351  nulls[Anum_pg_proc_proconfig - 1] = true;
352  /* proacl will be determined later */
353 
354  rel = table_open(ProcedureRelationId, RowExclusiveLock);
355  tupDesc = RelationGetDescr(rel);
356 
357  /* Check for pre-existing definition */
359  PointerGetDatum(procedureName),
360  PointerGetDatum(parameterTypes),
361  ObjectIdGetDatum(procNamespace));
362 
363  if (HeapTupleIsValid(oldtup))
364  {
365  /* There is one; okay to replace it? */
366  Form_pg_proc oldproc = (Form_pg_proc) GETSTRUCT(oldtup);
367  Datum proargnames;
368  bool isnull;
369  const char *dropcmd;
370 
371  if (!replace)
372  ereport(ERROR,
373  (errcode(ERRCODE_DUPLICATE_FUNCTION),
374  errmsg("function \"%s\" already exists with same argument types",
375  procedureName)));
376  if (!pg_proc_ownercheck(oldproc->oid, proowner))
378  procedureName);
379 
380  /* Not okay to change routine kind */
381  if (oldproc->prokind != prokind)
382  ereport(ERROR,
383  (errcode(ERRCODE_WRONG_OBJECT_TYPE),
384  errmsg("cannot change routine kind"),
385  (oldproc->prokind == PROKIND_AGGREGATE ?
386  errdetail("\"%s\" is an aggregate function.", procedureName) :
387  oldproc->prokind == PROKIND_FUNCTION ?
388  errdetail("\"%s\" is a function.", procedureName) :
389  oldproc->prokind == PROKIND_PROCEDURE ?
390  errdetail("\"%s\" is a procedure.", procedureName) :
391  oldproc->prokind == PROKIND_WINDOW ?
392  errdetail("\"%s\" is a window function.", procedureName) :
393  0)));
394 
395  dropcmd = (prokind == PROKIND_PROCEDURE ? "DROP PROCEDURE" :
396  prokind == PROKIND_AGGREGATE ? "DROP AGGREGATE" :
397  "DROP FUNCTION");
398 
399  /*
400  * Not okay to change the return type of the existing proc, since
401  * existing rules, views, etc may depend on the return type.
402  *
403  * In case of a procedure, a changing return type means that whether
404  * the procedure has output parameters was changed. Since there is no
405  * user visible return type, we produce a more specific error message.
406  */
407  if (returnType != oldproc->prorettype ||
408  returnsSet != oldproc->proretset)
409  ereport(ERROR,
410  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
411  prokind == PROKIND_PROCEDURE
412  ? errmsg("cannot change whether a procedure has output parameters")
413  : errmsg("cannot change return type of existing function"),
414 
415  /*
416  * translator: first %s is DROP FUNCTION, DROP PROCEDURE, or DROP
417  * AGGREGATE
418  */
419  errhint("Use %s %s first.",
420  dropcmd,
421  format_procedure(oldproc->oid))));
422 
423  /*
424  * If it returns RECORD, check for possible change of record type
425  * implied by OUT parameters
426  */
427  if (returnType == RECORDOID)
428  {
429  TupleDesc olddesc;
430  TupleDesc newdesc;
431 
432  olddesc = build_function_result_tupdesc_t(oldtup);
433  newdesc = build_function_result_tupdesc_d(prokind,
434  allParameterTypes,
435  parameterModes,
436  parameterNames);
437  if (olddesc == NULL && newdesc == NULL)
438  /* ok, both are runtime-defined RECORDs */ ;
439  else if (olddesc == NULL || newdesc == NULL ||
440  !equalTupleDescs(olddesc, newdesc))
441  ereport(ERROR,
442  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
443  errmsg("cannot change return type of existing function"),
444  errdetail("Row type defined by OUT parameters is different."),
445  /* translator: first %s is DROP FUNCTION or DROP PROCEDURE */
446  errhint("Use %s %s first.",
447  dropcmd,
448  format_procedure(oldproc->oid))));
449  }
450 
451  /*
452  * If there were any named input parameters, check to make sure the
453  * names have not been changed, as this could break existing calls. We
454  * allow adding names to formerly unnamed parameters, though.
455  */
456  proargnames = SysCacheGetAttr(PROCNAMEARGSNSP, oldtup,
457  Anum_pg_proc_proargnames,
458  &isnull);
459  if (!isnull)
460  {
461  Datum proargmodes;
462  char **old_arg_names;
463  char **new_arg_names;
464  int n_old_arg_names;
465  int n_new_arg_names;
466  int j;
467 
468  proargmodes = SysCacheGetAttr(PROCNAMEARGSNSP, oldtup,
469  Anum_pg_proc_proargmodes,
470  &isnull);
471  if (isnull)
472  proargmodes = PointerGetDatum(NULL); /* just to be sure */
473 
474  n_old_arg_names = get_func_input_arg_names(proargnames,
475  proargmodes,
476  &old_arg_names);
477  n_new_arg_names = get_func_input_arg_names(parameterNames,
478  parameterModes,
479  &new_arg_names);
480  for (j = 0; j < n_old_arg_names; j++)
481  {
482  if (old_arg_names[j] == NULL)
483  continue;
484  if (j >= n_new_arg_names || new_arg_names[j] == NULL ||
485  strcmp(old_arg_names[j], new_arg_names[j]) != 0)
486  ereport(ERROR,
487  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
488  errmsg("cannot change name of input parameter \"%s\"",
489  old_arg_names[j]),
490  /* translator: first %s is DROP FUNCTION or DROP PROCEDURE */
491  errhint("Use %s %s first.",
492  dropcmd,
493  format_procedure(oldproc->oid))));
494  }
495  }
496 
497  /*
498  * If there are existing defaults, check compatibility: redefinition
499  * must not remove any defaults nor change their types. (Removing a
500  * default might cause a function to fail to satisfy an existing call.
501  * Changing type would only be possible if the associated parameter is
502  * polymorphic, and in such cases a change of default type might alter
503  * the resolved output type of existing calls.)
504  */
505  if (oldproc->pronargdefaults != 0)
506  {
507  Datum proargdefaults;
508  List *oldDefaults;
509  ListCell *oldlc;
510  ListCell *newlc;
511 
512  if (list_length(parameterDefaults) < oldproc->pronargdefaults)
513  ereport(ERROR,
514  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
515  errmsg("cannot remove parameter defaults from existing function"),
516  /* translator: first %s is DROP FUNCTION or DROP PROCEDURE */
517  errhint("Use %s %s first.",
518  dropcmd,
519  format_procedure(oldproc->oid))));
520 
521  proargdefaults = SysCacheGetAttr(PROCNAMEARGSNSP, oldtup,
522  Anum_pg_proc_proargdefaults,
523  &isnull);
524  Assert(!isnull);
525  oldDefaults = castNode(List, stringToNode(TextDatumGetCString(proargdefaults)));
526  Assert(list_length(oldDefaults) == oldproc->pronargdefaults);
527 
528  /* new list can have more defaults than old, advance over 'em */
529  newlc = list_nth_cell(parameterDefaults,
530  list_length(parameterDefaults) -
531  oldproc->pronargdefaults);
532 
533  foreach(oldlc, oldDefaults)
534  {
535  Node *oldDef = (Node *) lfirst(oldlc);
536  Node *newDef = (Node *) lfirst(newlc);
537 
538  if (exprType(oldDef) != exprType(newDef))
539  ereport(ERROR,
540  (errcode(ERRCODE_INVALID_FUNCTION_DEFINITION),
541  errmsg("cannot change data type of existing parameter default value"),
542  /* translator: first %s is DROP FUNCTION or DROP PROCEDURE */
543  errhint("Use %s %s first.",
544  dropcmd,
545  format_procedure(oldproc->oid))));
546  newlc = lnext(parameterDefaults, newlc);
547  }
548  }
549 
550  /*
551  * Do not change existing oid, ownership or permissions, either. Note
552  * dependency-update code below has to agree with this decision.
553  */
554  replaces[Anum_pg_proc_oid - 1] = false;
555  replaces[Anum_pg_proc_proowner - 1] = false;
556  replaces[Anum_pg_proc_proacl - 1] = false;
557 
558  /* Okay, do it... */
559  tup = heap_modify_tuple(oldtup, tupDesc, values, nulls, replaces);
560  CatalogTupleUpdate(rel, &tup->t_self, tup);
561 
562  ReleaseSysCache(oldtup);
563  is_update = true;
564  }
565  else
566  {
567  /* Creating a new procedure */
568  Oid newOid;
569 
570  /* First, get default permissions and set up proacl */
571  proacl = get_user_default_acl(OBJECT_FUNCTION, proowner,
572  procNamespace);
573  if (proacl != NULL)
574  values[Anum_pg_proc_proacl - 1] = PointerGetDatum(proacl);
575  else
576  nulls[Anum_pg_proc_proacl - 1] = true;
577 
578  newOid = GetNewOidWithIndex(rel, ProcedureOidIndexId,
579  Anum_pg_proc_oid);
580  values[Anum_pg_proc_oid - 1] = ObjectIdGetDatum(newOid);
581  tup = heap_form_tuple(tupDesc, values, nulls);
582  CatalogTupleInsert(rel, tup);
583  is_update = false;
584  }
585 
586 
587  retval = ((Form_pg_proc) GETSTRUCT(tup))->oid;
588 
589  /*
590  * Create dependencies for the new function. If we are updating an
591  * existing function, first delete any existing pg_depend entries.
592  * (However, since we are not changing ownership or permissions, the
593  * shared dependencies do *not* need to change, and we leave them alone.)
594  */
595  if (is_update)
596  deleteDependencyRecordsFor(ProcedureRelationId, retval, true);
597 
598  addrs = new_object_addresses();
599 
600  ObjectAddressSet(myself, ProcedureRelationId, retval);
601 
602  /* dependency on namespace */
603  ObjectAddressSet(referenced, NamespaceRelationId, procNamespace);
604  add_exact_object_address(&referenced, addrs);
605 
606  /* dependency on implementation language */
607  ObjectAddressSet(referenced, LanguageRelationId, languageObjectId);
608  add_exact_object_address(&referenced, addrs);
609 
610  /* dependency on return type */
611  ObjectAddressSet(referenced, TypeRelationId, returnType);
612  add_exact_object_address(&referenced, addrs);
613 
614  /* dependency on transform used by return type, if any */
615  if ((trfid = get_transform_oid(returnType, languageObjectId, true)))
616  {
617  ObjectAddressSet(referenced, TransformRelationId, trfid);
618  add_exact_object_address(&referenced, addrs);
619  }
620 
621  /* dependency on parameter types */
622  for (i = 0; i < allParamCount; i++)
623  {
624  ObjectAddressSet(referenced, TypeRelationId, allParams[i]);
625  add_exact_object_address(&referenced, addrs);
626 
627  /* dependency on transform used by parameter type, if any */
628  if ((trfid = get_transform_oid(allParams[i], languageObjectId, true)))
629  {
630  ObjectAddressSet(referenced, TransformRelationId, trfid);
631  add_exact_object_address(&referenced, addrs);
632  }
633  }
634 
635  /* dependency on support function, if any */
636  if (OidIsValid(prosupport))
637  {
638  ObjectAddressSet(referenced, ProcedureRelationId, prosupport);
639  add_exact_object_address(&referenced, addrs);
640  }
641 
643  free_object_addresses(addrs);
644 
645  /* dependency on SQL routine body */
646  if (languageObjectId == SQLlanguageId && prosqlbody)
647  recordDependencyOnExpr(&myself, prosqlbody, NIL, DEPENDENCY_NORMAL);
648 
649  /* dependency on parameter default expressions */
650  if (parameterDefaults)
651  recordDependencyOnExpr(&myself, (Node *) parameterDefaults,
653 
654  /* dependency on owner */
655  if (!is_update)
656  recordDependencyOnOwner(ProcedureRelationId, retval, proowner);
657 
658  /* dependency on any roles mentioned in ACL */
659  if (!is_update)
660  recordDependencyOnNewAcl(ProcedureRelationId, retval, 0,
661  proowner, proacl);
662 
663  /* dependency on extension */
664  recordDependencyOnCurrentExtension(&myself, is_update);
665 
666  heap_freetuple(tup);
667 
668  /* Post creation hook for new function */
669  InvokeObjectPostCreateHook(ProcedureRelationId, retval, 0);
670 
672 
673  /* Verify function body */
674  if (OidIsValid(languageValidator))
675  {
676  ArrayType *set_items = NULL;
677  int save_nestlevel = 0;
678 
679  /* Advance command counter so new tuple can be seen by validator */
681 
682  /*
683  * Set per-function configuration parameters so that the validation is
684  * done with the environment the function expects. However, if
685  * check_function_bodies is off, we don't do this, because that would
686  * create dump ordering hazards that pg_dump doesn't know how to deal
687  * with. (For example, a SET clause might refer to a not-yet-created
688  * text search configuration.) This means that the validator
689  * shouldn't complain about anything that might depend on a GUC
690  * parameter when check_function_bodies is off.
691  */
693  {
694  set_items = (ArrayType *) DatumGetPointer(proconfig);
695  if (set_items) /* Need a new GUC nesting level */
696  {
697  save_nestlevel = NewGUCNestLevel();
698  ProcessGUCArray(set_items,
702  }
703  }
704 
705  OidFunctionCall1(languageValidator, ObjectIdGetDatum(retval));
706 
707  if (set_items)
708  AtEOXact_GUC(true, save_nestlevel);
709  }
710 
711  return myself;
712 }
static Datum Float4GetDatum(float4 X)
Definition: postgres.h:725
#define NIL
Definition: pg_list.h:65
Oid GetNewOidWithIndex(Relation relation, Oid indexId, AttrNumber oidcolumn)
Definition: catalog.c:381
#define NameGetDatum(X)
Definition: postgres.h:639
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:167
int errhint(const char *fmt,...)
Definition: elog.c:1156
#define GETSTRUCT(TUP)
Definition: htup_details.h:654
#define InvokeObjectPostCreateHook(classId, objectId, subId)
Definition: objectaccess.h:151
char * check_valid_polymorphic_signature(Oid ret_type, const Oid *declared_arg_types, int nargs)
static ListCell * lnext(const List *l, const ListCell *c)
Definition: pg_list.h:322
static ListCell * list_nth_cell(const List *list, int n)
Definition: pg_list.h:256
#define RelationGetDescr(relation)
Definition: rel.h:503
int errmsg_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...)
Definition: elog.c:1019
#define castNode(_type_, nodeptr)
Definition: nodes.h:608
void namestrcpy(Name name, const char *str)
Definition: name.c:233
Oid get_element_type(Oid typid)
Definition: lsyscache.c:2706
#define PointerGetDatum(X)
Definition: postgres.h:600
void record_object_address_dependencies(const ObjectAddress *depender, ObjectAddresses *referenced, DependencyType behavior)
Definition: dependency.c:2691
TupleDesc build_function_result_tupdesc_d(char prokind, Datum proallargtypes, Datum proargmodes, Datum proargnames)
Definition: funcapi.c:1652
long deleteDependencyRecordsFor(Oid classId, Oid objectId, bool skipExtensionDeps)
Definition: pg_depend.c:236
Definition: nodes.h:539
int errcode(int sqlerrcode)
Definition: elog.c:698
void * stringToNode(const char *str)
Definition: read.c:89
bool superuser(void)
Definition: superuser.c:46
void add_exact_object_address(const ObjectAddress *object, ObjectAddresses *addrs)
Definition: dependency.c:2482
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, Datum *values, bool *isnull)
Definition: heaptuple.c:1020
void recordDependencyOnOwner(Oid classId, Oid objectId, Oid owner)
Definition: pg_shdepend.c:163
ObjectAddresses * new_object_addresses(void)
Definition: dependency.c:2427
bool check_function_bodies
Definition: guc.c:586
void free_object_addresses(ObjectAddresses *addrs)
Definition: dependency.c:2722
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:710
int errdetail_internal(const char *fmt,...)
Definition: elog.c:1069
#define FUNC_MAX_ARGS
Oid get_transform_oid(Oid type_id, Oid lang_id, bool missing_ok)
void aclcheck_error(AclResult aclerr, ObjectType objtype, const char *objectname)
Definition: aclchk.c:3308
TupleDesc build_function_result_tupdesc_t(HeapTuple procTuple)
Definition: funcapi.c:1602
#define ObjectIdGetDatum(X)
Definition: postgres.h:551
#define ERROR
Definition: elog.h:46
#define ARR_DIMS(a)
Definition: array.h:287
Definition: guc.h:75
HeapTuple SearchSysCache3(int cacheId, Datum key1, Datum key2, Datum key3)
Definition: syscache.c:1149
ItemPointerData t_self
Definition: htup.h:65
#define OidFunctionCall1(functionId, arg1)
Definition: fmgr.h:664
Definition: c.h:675
#define ARR_DATA_PTR(a)
Definition: array.h:315
Oid values[FLEXIBLE_ARRAY_MEMBER]
Definition: c.h:668
int dim1
Definition: c.h:666
#define RowExclusiveLock
Definition: lockdefs.h:38
void AtEOXact_GUC(bool isCommit, int nestLevel)
Definition: guc.c:6218
int errdetail(const char *fmt,...)
Definition: elog.c:1042
void recordDependencyOnExpr(const ObjectAddress *depender, Node *expr, List *rtable, DependencyType behavior)
Definition: dependency.c:1568
#define ARR_HASNULL(a)
Definition: array.h:284
int get_func_input_arg_names(Datum proargnames, Datum proargmodes, char ***arg_names)
Definition: funcapi.c:1412
#define TextDatumGetCString(d)
Definition: builtins.h:83
uintptr_t Datum
Definition: postgres.h:411
void CommandCounterIncrement(void)
Definition: xact.c:1021
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1175
Datum SysCacheGetAttr(int cacheId, HeapTuple tup, AttrNumber attributeNumber, bool *isNull)
Definition: syscache.c:1388
FormData_pg_proc * Form_pg_proc
Definition: pg_proc.h:136
#define BoolGetDatum(X)
Definition: postgres.h:446
#define InvalidOid
Definition: postgres_ext.h:36
void ProcessGUCArray(ArrayType *array, GucContext context, GucSource source, GucAction action)
Definition: guc.c:11017
#define ereport(elevel,...)
Definition: elog.h:157
char * format_procedure(Oid procedure_oid)
Definition: regproc.c:323
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define Assert(condition)
Definition: c.h:804
#define lfirst(lc)
Definition: pg_list.h:169
char * check_valid_internal_signature(Oid ret_type, const Oid *declared_arg_types, int nargs)
void recordDependencyOnCurrentExtension(const ObjectAddress *object, bool isReplace)
Definition: pg_depend.c:184
void CatalogTupleUpdate(Relation heapRel, ItemPointer otid, HeapTuple tup)
Definition: indexing.c:301
Oid exprType(const Node *expr)
Definition: nodeFuncs.c:41
static int list_length(const List *l)
Definition: pg_list.h:149
#define ARR_NDIM(a)
Definition: array.h:283
#define ObjectAddressSet(addr, class_id, object_id)
Definition: objectaddress.h:40
#define CharGetDatum(X)
Definition: postgres.h:460
#define DatumGetPointer(X)
Definition: postgres.h:593
void recordDependencyOnNewAcl(Oid classId, Oid objectId, int32 objsubId, Oid ownerId, Acl *acl)
Definition: aclchk.c:5597
static Datum values[MAXATTR]
Definition: bootstrap.c:166
int NewGUCNestLevel(void)
Definition: guc.c:6204
int errmsg(const char *fmt,...)
Definition: elog.c:909
#define elog(elevel,...)
Definition: elog.h:232
int i
#define CStringGetTextDatum(s)
Definition: builtins.h:82
char * nodeToString(const void *obj)
Definition: outfuncs.c:4542
bool equalTupleDescs(TupleDesc tupdesc1, TupleDesc tupdesc2)
Definition: tupdesc.c:402
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
HeapTuple heap_modify_tuple(HeapTuple tuple, TupleDesc tupleDesc, Datum *replValues, bool *replIsnull, bool *doReplace)
Definition: heaptuple.c:1113
Definition: pg_list.h:50
#define PointerIsValid(pointer)
Definition: c.h:698
#define ARR_ELEMTYPE(a)
Definition: array.h:285
#define UInt16GetDatum(X)
Definition: postgres.h:509
void CatalogTupleInsert(Relation heapRel, HeapTuple tup)
Definition: indexing.c:221
bool pg_proc_ownercheck(Oid proc_oid, Oid roleid)
Definition: aclchk.c:4896
Acl * get_user_default_acl(ObjectType objtype, Oid ownerId, Oid nsp_oid)
Definition: aclchk.c:5521

Variable Documentation

◆ BKI_SCHEMA_MACRO

ProcedureRelation_Rowtype_Id BKI_SCHEMA_MACRO
Initial value:
{
Oid oid
unsigned int Oid
Definition: postgres_ext.h:31

Definition at line 31 of file pg_proc.h.

◆ FormData_pg_proc

FormData_pg_proc

Definition at line 129 of file pg_proc.h.

◆ proname

◆ pronargs