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]

float4 prorows BKI_DEFAULT ( )

◆ BKI_DEFAULT() [2/9]

float4 procost BKI_DEFAULT ( )

◆ BKI_DEFAULT() [3/9]

char prokind BKI_DEFAULT ( )

◆ 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 ( )

◆ BKI_DEFAULT() [9/9]

bool proisstrict 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 1016 of file pg_proc.c.

1017 {
1018  int origerrposition;
1019  int newerrposition;
1020  const char *queryText;
1021 
1022  /*
1023  * Nothing to do unless we are dealing with a syntax error that has a
1024  * cursor position.
1025  *
1026  * Some PLs may prefer to report the error position as an internal error
1027  * to begin with, so check that too.
1028  */
1029  origerrposition = geterrposition();
1030  if (origerrposition <= 0)
1031  {
1032  origerrposition = getinternalerrposition();
1033  if (origerrposition <= 0)
1034  return false;
1035  }
1036 
1037  /* We can get the original query text from the active portal (hack...) */
1039  queryText = ActivePortal->sourceText;
1040 
1041  /* Try to locate the prosrc in the original text */
1042  newerrposition = match_prosrc_to_query(prosrc, queryText, origerrposition);
1043 
1044  if (newerrposition > 0)
1045  {
1046  /* Successful, so fix error position to reference original query */
1047  errposition(newerrposition);
1048  /* Get rid of any report of the error as an "internal query" */
1050  internalerrquery(NULL);
1051  }
1052  else
1053  {
1054  /*
1055  * If unsuccessful, convert the position to an internal position
1056  * marker and give the function text as the internal query.
1057  */
1058  errposition(0);
1059  internalerrposition(origerrposition);
1060  internalerrquery(prosrc);
1061  }
1062 
1063  return true;
1064 }
int getinternalerrposition(void)
Definition: elog.c:1429
int internalerrquery(const char *query)
Definition: elog.c:1316
int internalerrposition(int cursorpos)
Definition: elog.c:1296
int geterrposition(void)
Definition: elog.c:1412
int errposition(int cursorpos)
Definition: elog.c:1280
Assert(fmt[strlen(fmt) - 1] !='\n')
static int match_prosrc_to_query(const char *prosrc, const char *queryText, int cursorpos)
Definition: pg_proc.c:1073
@ PORTAL_ACTIVE
Definition: portal.h:108
Portal ActivePortal
Definition: pquery.c:35
const char * sourceText
Definition: portal.h:136
PortalStatus status
Definition: portal.h:151

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().

◆ oid_array_to_list()

List* oid_array_to_list ( Datum  datum)

Definition at line 1188 of file pg_proc.c.

1189 {
1190  ArrayType *array = DatumGetArrayTypeP(datum);
1191  Datum *values;
1192  int nelems;
1193  int i;
1194  List *result = NIL;
1195 
1196  deconstruct_array(array,
1197  OIDOID,
1198  sizeof(Oid), true, TYPALIGN_INT,
1199  &values, NULL, &nelems);
1200  for (i = 0; i < nelems; i++)
1201  result = lappend_oid(result, values[i]);
1202  return result;
1203 }
#define DatumGetArrayTypeP(X)
Definition: array.h:254
void deconstruct_array(ArrayType *array, Oid elmtype, int elmlen, bool elmbyval, char elmalign, Datum **elemsp, bool **nullsp, int *nelemsp)
Definition: arrayfuncs.c:3491
static Datum values[MAXATTR]
Definition: bootstrap.c:156
int i
Definition: isn.c:73
List * lappend_oid(List *list, Oid datum)
Definition: list.c:372
#define NIL
Definition: pg_list.h:65
uintptr_t Datum
Definition: postgres.h:411
unsigned int Oid
Definition: postgres_ext.h:31
Definition: pg_list.h:51

References DatumGetArrayTypeP, deconstruct_array(), 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 72 of file pg_proc.c.

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

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, j, 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, pgstat_create_function(), 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, 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

◆ pronargs