PostgreSQL Source Code  git master
spi.h File Reference
#include "commands/trigger.h"
#include "lib/ilist.h"
#include "nodes/parsenodes.h"
#include "utils/portal.h"
Include dependency graph for spi.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SPITupleTable
 

Macros

#define SPI_ERROR_CONNECT   (-1)
 
#define SPI_ERROR_COPY   (-2)
 
#define SPI_ERROR_OPUNKNOWN   (-3)
 
#define SPI_ERROR_UNCONNECTED   (-4)
 
#define SPI_ERROR_CURSOR   (-5) /* not used anymore */
 
#define SPI_ERROR_ARGUMENT   (-6)
 
#define SPI_ERROR_PARAM   (-7)
 
#define SPI_ERROR_TRANSACTION   (-8)
 
#define SPI_ERROR_NOATTRIBUTE   (-9)
 
#define SPI_ERROR_NOOUTFUNC   (-10)
 
#define SPI_ERROR_TYPUNKNOWN   (-11)
 
#define SPI_ERROR_REL_DUPLICATE   (-12)
 
#define SPI_ERROR_REL_NOT_FOUND   (-13)
 
#define SPI_OK_CONNECT   1
 
#define SPI_OK_FINISH   2
 
#define SPI_OK_FETCH   3
 
#define SPI_OK_UTILITY   4
 
#define SPI_OK_SELECT   5
 
#define SPI_OK_SELINTO   6
 
#define SPI_OK_INSERT   7
 
#define SPI_OK_DELETE   8
 
#define SPI_OK_UPDATE   9
 
#define SPI_OK_CURSOR   10
 
#define SPI_OK_INSERT_RETURNING   11
 
#define SPI_OK_DELETE_RETURNING   12
 
#define SPI_OK_UPDATE_RETURNING   13
 
#define SPI_OK_REWRITTEN   14
 
#define SPI_OK_REL_REGISTER   15
 
#define SPI_OK_REL_UNREGISTER   16
 
#define SPI_OK_TD_REGISTER   17
 
#define SPI_OPT_NONATOMIC   (1 << 0)
 
#define SPI_push()   ((void) 0)
 
#define SPI_pop()   ((void) 0)
 
#define SPI_push_conditional()   false
 
#define SPI_pop_conditional(pushed)   ((void) 0)
 
#define SPI_restore_connection()   ((void) 0)
 

Typedefs

typedef struct SPITupleTable SPITupleTable
 
typedef struct _SPI_planSPIPlanPtr
 

Functions

int SPI_connect (void)
 
int SPI_connect_ext (int options)
 
int SPI_finish (void)
 
int SPI_execute (const char *src, bool read_only, long tcount)
 
int SPI_execute_plan (SPIPlanPtr plan, Datum *Values, const char *Nulls, bool read_only, long tcount)
 
int SPI_execute_plan_with_paramlist (SPIPlanPtr plan, ParamListInfo params, bool read_only, long tcount)
 
int SPI_exec (const char *src, long tcount)
 
int SPI_execp (SPIPlanPtr plan, Datum *Values, const char *Nulls, long tcount)
 
int SPI_execute_snapshot (SPIPlanPtr plan, Datum *Values, const char *Nulls, Snapshot snapshot, Snapshot crosscheck_snapshot, bool read_only, bool fire_triggers, long tcount)
 
int SPI_execute_with_args (const char *src, int nargs, Oid *argtypes, Datum *Values, const char *Nulls, bool read_only, long tcount)
 
SPIPlanPtr SPI_prepare (const char *src, int nargs, Oid *argtypes)
 
SPIPlanPtr SPI_prepare_cursor (const char *src, int nargs, Oid *argtypes, int cursorOptions)
 
SPIPlanPtr SPI_prepare_params (const char *src, ParserSetupHook parserSetup, void *parserSetupArg, int cursorOptions)
 
int SPI_keepplan (SPIPlanPtr plan)
 
SPIPlanPtr SPI_saveplan (SPIPlanPtr plan)
 
int SPI_freeplan (SPIPlanPtr plan)
 
Oid SPI_getargtypeid (SPIPlanPtr plan, int argIndex)
 
int SPI_getargcount (SPIPlanPtr plan)
 
bool SPI_is_cursor_plan (SPIPlanPtr plan)
 
bool SPI_plan_is_valid (SPIPlanPtr plan)
 
const char * SPI_result_code_string (int code)
 
ListSPI_plan_get_plan_sources (SPIPlanPtr plan)
 
CachedPlanSPI_plan_get_cached_plan (SPIPlanPtr plan)
 
HeapTuple SPI_copytuple (HeapTuple tuple)
 
HeapTupleHeader SPI_returntuple (HeapTuple tuple, TupleDesc tupdesc)
 
HeapTuple SPI_modifytuple (Relation rel, HeapTuple tuple, int natts, int *attnum, Datum *Values, const char *Nulls)
 
int SPI_fnumber (TupleDesc tupdesc, const char *fname)
 
char * SPI_fname (TupleDesc tupdesc, int fnumber)
 
char * SPI_getvalue (HeapTuple tuple, TupleDesc tupdesc, int fnumber)
 
Datum SPI_getbinval (HeapTuple tuple, TupleDesc tupdesc, int fnumber, bool *isnull)
 
char * SPI_gettype (TupleDesc tupdesc, int fnumber)
 
Oid SPI_gettypeid (TupleDesc tupdesc, int fnumber)
 
char * SPI_getrelname (Relation rel)
 
char * SPI_getnspname (Relation rel)
 
void * SPI_palloc (Size size)
 
void * SPI_repalloc (void *pointer, Size size)
 
void SPI_pfree (void *pointer)
 
Datum SPI_datumTransfer (Datum value, bool typByVal, int typLen)
 
void SPI_freetuple (HeapTuple pointer)
 
void SPI_freetuptable (SPITupleTable *tuptable)
 
Portal SPI_cursor_open (const char *name, SPIPlanPtr plan, Datum *Values, const char *Nulls, bool read_only)
 
Portal SPI_cursor_open_with_args (const char *name, const char *src, int nargs, Oid *argtypes, Datum *Values, const char *Nulls, bool read_only, int cursorOptions)
 
Portal SPI_cursor_open_with_paramlist (const char *name, SPIPlanPtr plan, ParamListInfo params, bool read_only)
 
Portal SPI_cursor_find (const char *name)
 
void SPI_cursor_fetch (Portal portal, bool forward, long count)
 
void SPI_cursor_move (Portal portal, bool forward, long count)
 
void SPI_scroll_cursor_fetch (Portal, FetchDirection direction, long count)
 
void SPI_scroll_cursor_move (Portal, FetchDirection direction, long count)
 
void SPI_cursor_close (Portal portal)
 
int SPI_register_relation (EphemeralNamedRelation enr)
 
int SPI_unregister_relation (const char *name)
 
int SPI_register_trigger_data (TriggerData *tdata)
 
void SPI_start_transaction (void)
 
void SPI_commit (void)
 
void SPI_commit_and_chain (void)
 
void SPI_rollback (void)
 
void SPI_rollback_and_chain (void)
 
void SPICleanup (void)
 
void AtEOXact_SPI (bool isCommit)
 
void AtEOSubXact_SPI (bool isCommit, SubTransactionId mySubid)
 
bool SPI_inside_nonatomic_context (void)
 

Variables

PGDLLIMPORT uint64 SPI_processed
 
PGDLLIMPORT SPITupleTableSPI_tuptable
 
PGDLLIMPORT int SPI_result
 

Macro Definition Documentation

◆ SPI_ERROR_ARGUMENT

◆ SPI_ERROR_CONNECT

#define SPI_ERROR_CONNECT   (-1)

Definition at line 39 of file spi.h.

Referenced by SPI_result_code_string().

◆ SPI_ERROR_COPY

#define SPI_ERROR_COPY   (-2)

◆ SPI_ERROR_CURSOR

#define SPI_ERROR_CURSOR   (-5) /* not used anymore */

Definition at line 43 of file spi.h.

◆ SPI_ERROR_NOATTRIBUTE

◆ SPI_ERROR_NOOUTFUNC

#define SPI_ERROR_NOOUTFUNC   (-10)

Definition at line 48 of file spi.h.

Referenced by SPI_result_code_string().

◆ SPI_ERROR_OPUNKNOWN

#define SPI_ERROR_OPUNKNOWN   (-3)

Definition at line 41 of file spi.h.

Referenced by _SPI_pquery(), and SPI_result_code_string().

◆ SPI_ERROR_PARAM

#define SPI_ERROR_PARAM   (-7)

◆ SPI_ERROR_REL_DUPLICATE

#define SPI_ERROR_REL_DUPLICATE   (-12)

Definition at line 50 of file spi.h.

Referenced by SPI_register_relation(), and SPI_result_code_string().

◆ SPI_ERROR_REL_NOT_FOUND

#define SPI_ERROR_REL_NOT_FOUND   (-13)

Definition at line 51 of file spi.h.

Referenced by SPI_result_code_string(), and SPI_unregister_relation().

◆ SPI_ERROR_TRANSACTION

#define SPI_ERROR_TRANSACTION   (-8)

◆ SPI_ERROR_TYPUNKNOWN

#define SPI_ERROR_TYPUNKNOWN   (-11)

Definition at line 49 of file spi.h.

Referenced by SPI_gettype(), and SPI_result_code_string().

◆ SPI_ERROR_UNCONNECTED

#define SPI_ERROR_UNCONNECTED   (-4)

◆ SPI_OK_CONNECT

◆ SPI_OK_CURSOR

#define SPI_OK_CURSOR   10

Definition at line 62 of file spi.h.

Referenced by exec_run_select(), and SPI_result_code_string().

◆ SPI_OK_DELETE

◆ SPI_OK_DELETE_RETURNING

#define SPI_OK_DELETE_RETURNING   12

◆ SPI_OK_FETCH

#define SPI_OK_FETCH   3

Definition at line 55 of file spi.h.

Referenced by PLy_cursor_fetch(), and SPI_result_code_string().

◆ SPI_OK_FINISH

◆ SPI_OK_INSERT

#define SPI_OK_INSERT   7

◆ SPI_OK_INSERT_RETURNING

#define SPI_OK_INSERT_RETURNING   11

◆ SPI_OK_REL_REGISTER

#define SPI_OK_REL_REGISTER   15

Definition at line 67 of file spi.h.

Referenced by SPI_register_relation(), SPI_register_trigger_data(), and SPI_result_code_string().

◆ SPI_OK_REL_UNREGISTER

#define SPI_OK_REL_UNREGISTER   16

Definition at line 68 of file spi.h.

Referenced by SPI_result_code_string(), and SPI_unregister_relation().

◆ SPI_OK_REWRITTEN

#define SPI_OK_REWRITTEN   14

◆ SPI_OK_SELECT

◆ SPI_OK_SELINTO

#define SPI_OK_SELINTO   6

◆ SPI_OK_TD_REGISTER

#define SPI_OK_TD_REGISTER   17

Definition at line 69 of file spi.h.

Referenced by SPI_register_trigger_data().

◆ SPI_OK_UPDATE

◆ SPI_OK_UPDATE_RETURNING

#define SPI_OK_UPDATE_RETURNING   13

◆ SPI_OK_UTILITY

◆ SPI_OPT_NONATOMIC

◆ SPI_pop

#define SPI_pop ( )    ((void) 0)

Definition at line 75 of file spi.h.

◆ SPI_pop_conditional

#define SPI_pop_conditional (   pushed)    ((void) 0)

Definition at line 77 of file spi.h.

◆ SPI_push

#define SPI_push ( )    ((void) 0)

Definition at line 74 of file spi.h.

◆ SPI_push_conditional

#define SPI_push_conditional ( )    false

Definition at line 76 of file spi.h.

◆ SPI_restore_connection

#define SPI_restore_connection ( )    ((void) 0)

Definition at line 78 of file spi.h.

Typedef Documentation

◆ SPIPlanPtr

typedef struct _SPI_plan* SPIPlanPtr

Definition at line 37 of file spi.h.

◆ SPITupleTable

typedef struct SPITupleTable SPITupleTable

Function Documentation

◆ AtEOSubXact_SPI()

void AtEOSubXact_SPI ( bool  isCommit,
SubTransactionId  mySubid 
)

Definition at line 385 of file spi.c.

References _SPI_connected, _SPI_connection::connectSubid, slist_mutable_iter::cur, ereport, errcode(), errhint(), errmsg(), _SPI_connection::execCxt, _SPI_connection::execSubid, _SPI_connection::internal_xact, InvalidSubTransactionId, MemoryContextDelete(), MemoryContextResetAndDeleteChildren, next, _SPI_connection::outer_processed, _SPI_connection::outer_result, _SPI_connection::outer_tuptable, _SPI_connection::procCxt, slist_container, slist_delete_current(), slist_foreach_modify, SPI_processed, SPI_result, SPITupleTable::subid, SPITupleTable::tuptabcxt, _SPI_connection::tuptable, _SPI_connection::tuptables, and WARNING.

Referenced by AbortSubTransaction(), and CommitSubTransaction().

386 {
387  bool found = false;
388 
389  while (_SPI_connected >= 0)
390  {
392 
393  if (connection->connectSubid != mySubid)
394  break; /* couldn't be any underneath it either */
395 
396  if (connection->internal_xact)
397  break;
398 
399  found = true;
400 
401  /*
402  * Release procedure memory explicitly (see note in SPI_connect)
403  */
404  if (connection->execCxt)
405  {
406  MemoryContextDelete(connection->execCxt);
407  connection->execCxt = NULL;
408  }
409  if (connection->procCxt)
410  {
411  MemoryContextDelete(connection->procCxt);
412  connection->procCxt = NULL;
413  }
414 
415  /*
416  * Restore outer global variables and pop the stack entry. Unlike
417  * SPI_finish(), we don't risk switching to memory contexts that might
418  * be already gone.
419  */
420  SPI_processed = connection->outer_processed;
421  SPI_tuptable = connection->outer_tuptable;
422  SPI_result = connection->outer_result;
423 
424  _SPI_connected--;
425  if (_SPI_connected < 0)
426  _SPI_current = NULL;
427  else
429  }
430 
431  if (found && isCommit)
433  (errcode(ERRCODE_WARNING),
434  errmsg("subtransaction left non-empty SPI stack"),
435  errhint("Check for missing \"SPI_finish\" calls.")));
436 
437  /*
438  * If we are aborting a subtransaction and there is an open SPI context
439  * surrounding the subxact, clean up to prevent memory leakage.
440  */
441  if (_SPI_current && !isCommit)
442  {
443  slist_mutable_iter siter;
444 
445  /*
446  * Throw away executor state if current executor operation was started
447  * within current subxact (essentially, force a _SPI_end_call(true)).
448  */
449  if (_SPI_current->execSubid >= mySubid)
450  {
453  }
454 
455  /* throw away any tuple tables created within current subxact */
457  {
458  SPITupleTable *tuptable;
459 
460  tuptable = slist_container(SPITupleTable, next, siter.cur);
461  if (tuptable->subid >= mySubid)
462  {
463  /*
464  * If we used SPI_freetuptable() here, its internal search of
465  * the tuptables list would make this operation O(N^2).
466  * Instead, just free the tuptable manually. This should
467  * match what SPI_freetuptable() does.
468  */
469  slist_delete_current(&siter);
470  if (tuptable == _SPI_current->tuptable)
471  _SPI_current->tuptable = NULL;
472  if (tuptable == SPI_tuptable)
473  SPI_tuptable = NULL;
474  MemoryContextDelete(tuptable->tuptabcxt);
475  }
476  }
477  }
478 }
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:211
int errhint(const char *fmt,...)
Definition: elog.c:1071
static int32 next
Definition: blutils.c:213
bool internal_xact
Definition: spi_priv.h:42
slist_node * cur
Definition: ilist.h:241
SPITupleTable * SPI_tuptable
Definition: spi.c:46
int errcode(int sqlerrcode)
Definition: elog.c:608
static int _SPI_connected
Definition: spi.c:52
SubTransactionId execSubid
Definition: spi_priv.h:29
static _SPI_connection * _SPI_current
Definition: spi.c:50
uint64 SPI_processed
Definition: spi.c:45
SPITupleTable * outer_tuptable
Definition: spi_priv.h:47
#define slist_foreach_modify(iter, lhead)
Definition: ilist.h:716
int SPI_result
Definition: spi.c:47
SubTransactionId connectSubid
Definition: spi_priv.h:36
SPITupleTable * tuptable
Definition: spi_priv.h:26
static _SPI_connection * _SPI_stack
Definition: spi.c:49
#define ereport(elevel, rest)
Definition: elog.h:141
#define WARNING
Definition: elog.h:40
uint64 outer_processed
Definition: spi_priv.h:46
#define MemoryContextResetAndDeleteChildren(ctx)
Definition: memutils.h:67
#define slist_container(type, membername, ptr)
Definition: ilist.h:674
MemoryContext procCxt
Definition: spi_priv.h:33
MemoryContext execCxt
Definition: spi_priv.h:34
int outer_result
Definition: spi_priv.h:48
#define InvalidSubTransactionId
Definition: c.h:514
int errmsg(const char *fmt,...)
Definition: elog.c:822
static void slist_delete_current(slist_mutable_iter *iter)
Definition: ilist.h:652
SubTransactionId subid
Definition: spi.h:33
slist_head tuptables
Definition: spi_priv.h:32
MemoryContext tuptabcxt
Definition: spi.h:31

◆ AtEOXact_SPI()

void AtEOXact_SPI ( bool  isCommit)

Definition at line 363 of file spi.c.

References _SPI_connected, ereport, errcode(), errhint(), errmsg(), _SPI_connection::internal_xact, SPICleanup(), and WARNING.

Referenced by AbortTransaction(), CommitTransaction(), and PrepareTransaction().

364 {
365  /* Do nothing if the transaction end was initiated by SPI. */
367  return;
368 
369  if (isCommit && _SPI_connected != -1)
371  (errcode(ERRCODE_WARNING),
372  errmsg("transaction left non-empty SPI stack"),
373  errhint("Check for missing \"SPI_finish\" calls.")));
374 
375  SPICleanup();
376 }
int errhint(const char *fmt,...)
Definition: elog.c:1071
bool internal_xact
Definition: spi_priv.h:42
void SPICleanup(void)
Definition: spi.c:349
int errcode(int sqlerrcode)
Definition: elog.c:608
static int _SPI_connected
Definition: spi.c:52
static _SPI_connection * _SPI_current
Definition: spi.c:50
#define ereport(elevel, rest)
Definition: elog.h:141
#define WARNING
Definition: elog.h:40
int errmsg(const char *fmt,...)
Definition: elog.c:822

◆ SPI_commit()

void SPI_commit ( void  )

Definition at line 278 of file spi.c.

References _SPI_commit().

Referenced by exec_stmt_commit(), plperl_spi_commit(), pltcl_commit(), and PLy_commit().

279 {
280  _SPI_commit(false);
281 }
static void _SPI_commit(bool chain)
Definition: spi.c:221

◆ SPI_commit_and_chain()

void SPI_commit_and_chain ( void  )

Definition at line 284 of file spi.c.

References _SPI_commit().

Referenced by exec_stmt_commit().

285 {
286  _SPI_commit(true);
287 }
static void _SPI_commit(bool chain)
Definition: spi.c:221

◆ SPI_connect()

◆ SPI_connect_ext()

int SPI_connect_ext ( int  options)

Definition at line 95 of file spi.c.

References _SPI_connected, _SPI_stack_depth, ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert, _SPI_connection::atomic, _SPI_connection::connectSubid, elog, ERROR, _SPI_connection::execCxt, _SPI_connection::execSubid, false, GetCurrentSubTransactionId(), _SPI_connection::internal_xact, InvalidSubTransactionId, MemoryContextAlloc(), MemoryContextSwitchTo(), _SPI_connection::outer_processed, _SPI_connection::outer_result, _SPI_connection::outer_tuptable, PortalContext, _SPI_connection::procCxt, _SPI_connection::processed, _SPI_connection::queryEnv, repalloc(), _SPI_connection::savedcxt, slist_init(), SPI_OK_CONNECT, SPI_OPT_NONATOMIC, SPI_processed, SPI_result, SPI_tuptable, TopMemoryContext, TopTransactionContext, _SPI_connection::tuptable, and _SPI_connection::tuptables.

Referenced by plperl_func_handler(), plperl_inline_handler(), plpgsql_call_handler(), plpgsql_inline_handler(), plpython_call_handler(), plpython_inline_handler(), pltcl_func_handler(), and SPI_connect().

96 {
97  int newdepth;
98 
99  /* Enlarge stack if necessary */
100  if (_SPI_stack == NULL)
101  {
102  if (_SPI_connected != -1 || _SPI_stack_depth != 0)
103  elog(ERROR, "SPI stack corrupted");
104  newdepth = 16;
107  newdepth * sizeof(_SPI_connection));
108  _SPI_stack_depth = newdepth;
109  }
110  else
111  {
113  elog(ERROR, "SPI stack corrupted");
114  if (_SPI_stack_depth == _SPI_connected + 1)
115  {
116  newdepth = _SPI_stack_depth * 2;
119  newdepth * sizeof(_SPI_connection));
120  _SPI_stack_depth = newdepth;
121  }
122  }
123 
124  /* Enter new stack level */
125  _SPI_connected++;
127 
129  _SPI_current->processed = 0;
130  _SPI_current->tuptable = NULL;
133  _SPI_current->procCxt = NULL; /* in case we fail to create 'em */
134  _SPI_current->execCxt = NULL;
136  _SPI_current->queryEnv = NULL;
138  _SPI_current->internal_xact = false;
142 
143  /*
144  * Create memory contexts for this procedure
145  *
146  * In atomic contexts (the normal case), we use TopTransactionContext,
147  * otherwise PortalContext, so that it lives across transaction
148  * boundaries.
149  *
150  * XXX It could be better to use PortalContext as the parent context in
151  * all cases, but we may not be inside a portal (consider deferred-trigger
152  * execution). Perhaps CurTransactionContext could be an option? For now
153  * it doesn't matter because we clean up explicitly in AtEOSubXact_SPI().
154  */
156  "SPI Proc",
159  "SPI Exec",
161  /* ... and switch to procedure's context */
163 
164  /*
165  * Reset API global variables so that current caller cannot accidentally
166  * depend on state of an outer caller.
167  */
168  SPI_processed = 0;
169  SPI_tuptable = NULL;
170  SPI_result = 0;
171 
172  return SPI_OK_CONNECT;
173 }
#define SPI_OK_CONNECT
Definition: spi.h:53
#define AllocSetContextCreate
Definition: memutils.h:170
MemoryContext TopTransactionContext
Definition: mcxt.c:49
static int _SPI_stack_depth
Definition: spi.c:51
bool internal_xact
Definition: spi_priv.h:42
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
SPITupleTable * SPI_tuptable
Definition: spi.c:46
static int _SPI_connected
Definition: spi.c:52
SubTransactionId execSubid
Definition: spi_priv.h:29
static _SPI_connection * _SPI_current
Definition: spi.c:50
#define false
Definition: c.h:317
uint64 SPI_processed
Definition: spi.c:45
SPITupleTable * outer_tuptable
Definition: spi_priv.h:47
MemoryContext PortalContext
Definition: mcxt.c:53
int SPI_result
Definition: spi.c:47
SubTransactionId connectSubid
Definition: spi_priv.h:36
static void slist_init(slist_head *head)
Definition: ilist.h:554
#define ERROR
Definition: elog.h:43
QueryEnvironment * queryEnv
Definition: spi_priv.h:37
#define SPI_OPT_NONATOMIC
Definition: spi.h:71
SPITupleTable * tuptable
Definition: spi_priv.h:26
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:192
static _SPI_connection * _SPI_stack
Definition: spi.c:49
MemoryContext TopMemoryContext
Definition: mcxt.c:44
MemoryContext savedcxt
Definition: spi_priv.h:35
uint64 outer_processed
Definition: spi_priv.h:46
MemoryContext procCxt
Definition: spi_priv.h:33
MemoryContext execCxt
Definition: spi_priv.h:34
uint64 processed
Definition: spi_priv.h:25
#define Assert(condition)
Definition: c.h:733
int outer_result
Definition: spi_priv.h:48
SubTransactionId GetCurrentSubTransactionId(void)
Definition: xact.c:707
#define InvalidSubTransactionId
Definition: c.h:514
void * repalloc(void *pointer, Size size)
Definition: mcxt.c:1069
void * MemoryContextAlloc(MemoryContext context, Size size)
Definition: mcxt.c:796
#define elog(elevel,...)
Definition: elog.h:228
slist_head tuptables
Definition: spi_priv.h:32

◆ SPI_copytuple()

HeapTuple SPI_copytuple ( HeapTuple  tuple)

Definition at line 823 of file spi.c.

References heap_copytuple(), MemoryContextSwitchTo(), _SPI_connection::savedcxt, SPI_ERROR_ARGUMENT, SPI_ERROR_UNCONNECTED, and SPI_result.

Referenced by get_tuple_of_interest(), and plpgsql_exec_trigger().

824 {
825  MemoryContext oldcxt;
826  HeapTuple ctuple;
827 
828  if (tuple == NULL)
829  {
831  return NULL;
832  }
833 
834  if (_SPI_current == NULL)
835  {
837  return NULL;
838  }
839 
841 
842  ctuple = heap_copytuple(tuple);
843 
844  MemoryContextSwitchTo(oldcxt);
845 
846  return ctuple;
847 }
HeapTuple heap_copytuple(HeapTuple tuple)
Definition: heaptuple.c:680
#define SPI_ERROR_UNCONNECTED
Definition: spi.h:42
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
static _SPI_connection * _SPI_current
Definition: spi.c:50
int SPI_result
Definition: spi.c:47
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
MemoryContext savedcxt
Definition: spi_priv.h:35

◆ SPI_cursor_close()

void SPI_cursor_close ( Portal  portal)

Definition at line 1595 of file spi.c.

References elog, ERROR, PortalDrop(), and PortalIsValid.

Referenced by exec_stmt_close(), exec_stmt_dynfors(), exec_stmt_forc(), exec_stmt_fors(), exec_stmt_return_query(), plperl_spi_cursor_close(), plperl_spi_fetchrow(), PLy_cursor_close(), PLy_cursor_dealloc(), query_to_xml_and_xmlschema(), query_to_xmlschema(), ts_stat_sql(), and tsquery_rewrite_query().

1596 {
1597  if (!PortalIsValid(portal))
1598  elog(ERROR, "invalid portal in SPI cursor operation");
1599 
1600  PortalDrop(portal, false);
1601 }
#define ERROR
Definition: elog.h:43
#define PortalIsValid(p)
Definition: portal.h:201
void PortalDrop(Portal portal, bool isTopCommit)
Definition: portalmem.c:465
#define elog(elevel,...)
Definition: elog.h:228

◆ SPI_cursor_fetch()

void SPI_cursor_fetch ( Portal  portal,
bool  forward,
long  count 
)

Definition at line 1539 of file spi.c.

References _SPI_cursor_operation(), CreateDestReceiver(), DestSPI, FETCH_BACKWARD, and FETCH_FORWARD.

Referenced by cursor_to_xml(), exec_for_query(), exec_stmt_return_query(), plperl_spi_fetchrow(), PLy_cursor_fetch(), PLy_cursor_iternext(), ts_stat_sql(), and tsquery_rewrite_query().

1540 {
1541  _SPI_cursor_operation(portal,
1542  forward ? FETCH_FORWARD : FETCH_BACKWARD, count,
1544  /* we know that the DestSPI receiver doesn't need a destroy call */
1545 }
Definition: dest.h:93
DestReceiver * CreateDestReceiver(CommandDest dest)
Definition: dest.c:113
static void _SPI_cursor_operation(Portal portal, FetchDirection direction, long count, DestReceiver *dest)
Definition: spi.c:2579

◆ SPI_cursor_find()

Portal SPI_cursor_find ( const char *  name)

Definition at line 1527 of file spi.c.

References GetPortalByName().

Referenced by cursor_to_xml(), cursor_to_xmlschema(), exec_stmt_close(), exec_stmt_fetch(), exec_stmt_forc(), exec_stmt_open(), plperl_spi_cursor_close(), and plperl_spi_fetchrow().

1528 {
1529  return GetPortalByName(name);
1530 }
Portal GetPortalByName(const char *name)
Definition: portalmem.c:130
const char * name
Definition: encode.c:521

◆ SPI_cursor_move()

void SPI_cursor_move ( Portal  portal,
bool  forward,
long  count 
)

Definition at line 1554 of file spi.c.

References _SPI_cursor_operation(), FETCH_BACKWARD, FETCH_FORWARD, and None_Receiver.

1555 {
1556  _SPI_cursor_operation(portal,
1557  forward ? FETCH_FORWARD : FETCH_BACKWARD, count,
1558  None_Receiver);
1559 }
DestReceiver * None_Receiver
Definition: dest.c:96
static void _SPI_cursor_operation(Portal portal, FetchDirection direction, long count, DestReceiver *dest)
Definition: spi.c:2579

◆ SPI_cursor_open()

Portal SPI_cursor_open ( const char *  name,
SPIPlanPtr  plan,
Datum Values,
const char *  Nulls,
bool  read_only 
)

Definition at line 1221 of file spi.c.

References _SPI_convert_params(), _SPI_plan::argtypes, _SPI_plan::nargs, pfree(), and SPI_cursor_open_internal().

Referenced by plperl_spi_query(), plperl_spi_query_prepared(), PLy_cursor_plan(), PLy_cursor_query(), query_to_xml_and_xmlschema(), query_to_xmlschema(), ts_stat_sql(), and tsquery_rewrite_query().

1224 {
1225  Portal portal;
1226  ParamListInfo paramLI;
1227 
1228  /* build transient ParamListInfo in caller's context */
1229  paramLI = _SPI_convert_params(plan->nargs, plan->argtypes,
1230  Values, Nulls);
1231 
1232  portal = SPI_cursor_open_internal(name, plan, paramLI, read_only);
1233 
1234  /* done with the transient ParamListInfo */
1235  if (paramLI)
1236  pfree(paramLI);
1237 
1238  return portal;
1239 }
Oid * argtypes
Definition: spi_priv.h:100
void pfree(void *pointer)
Definition: mcxt.c:1056
int nargs
Definition: spi_priv.h:99
const char * name
Definition: encode.c:521
static Portal SPI_cursor_open_internal(const char *name, SPIPlanPtr plan, ParamListInfo paramLI, bool read_only)
Definition: spi.c:1313
static ParamListInfo _SPI_convert_params(int nargs, Oid *argtypes, Datum *Values, const char *Nulls)
Definition: spi.c:2444
static bool Nulls[MAXATTR]
Definition: bootstrap.c:168

◆ SPI_cursor_open_with_args()

Portal SPI_cursor_open_with_args ( const char *  name,
const char *  src,
int  nargs,
Oid argtypes,
Datum Values,
const char *  Nulls,
bool  read_only,
int  cursorOptions 
)

Definition at line 1248 of file spi.c.

References _SPI_begin_call(), _SPI_convert_params(), _SPI_end_call(), _SPI_PLAN_MAGIC, _SPI_prepare_plan(), _SPI_plan::argtypes, _SPI_plan::cursor_options, elog, ERROR, _SPI_plan::magic, _SPI_plan::nargs, _SPI_plan::parserSetup, _SPI_plan::parserSetupArg, SPI_cursor_open_internal(), and SPI_result.

Referenced by exec_dynquery_with_params().

1253 {
1254  Portal result;
1255  _SPI_plan plan;
1256  ParamListInfo paramLI;
1257 
1258  if (src == NULL || nargs < 0)
1259  elog(ERROR, "SPI_cursor_open_with_args called with invalid arguments");
1260 
1261  if (nargs > 0 && (argtypes == NULL || Values == NULL))
1262  elog(ERROR, "SPI_cursor_open_with_args called with missing parameters");
1263 
1264  SPI_result = _SPI_begin_call(true);
1265  if (SPI_result < 0)
1266  elog(ERROR, "SPI_cursor_open_with_args called while not connected");
1267 
1268  memset(&plan, 0, sizeof(_SPI_plan));
1269  plan.magic = _SPI_PLAN_MAGIC;
1270  plan.cursor_options = cursorOptions;
1271  plan.nargs = nargs;
1272  plan.argtypes = argtypes;
1273  plan.parserSetup = NULL;
1274  plan.parserSetupArg = NULL;
1275 
1276  /* build transient ParamListInfo in executor context */
1277  paramLI = _SPI_convert_params(nargs, argtypes,
1278  Values, Nulls);
1279 
1280  _SPI_prepare_plan(src, &plan);
1281 
1282  /* We needn't copy the plan; SPI_cursor_open_internal will do so */
1283 
1284  result = SPI_cursor_open_internal(name, &plan, paramLI, read_only);
1285 
1286  /* And clean up */
1287  _SPI_end_call(true);
1288 
1289  return result;
1290 }
static void _SPI_prepare_plan(const char *src, SPIPlanPtr plan)
Definition: spi.c:1938
Oid * argtypes
Definition: spi_priv.h:100
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:2649
int SPI_result
Definition: spi.c:47
#define ERROR
Definition: elog.h:43
static int _SPI_end_call(bool use_exec)
Definition: spi.c:2673
int nargs
Definition: spi_priv.h:99
ParserSetupHook parserSetup
Definition: spi_priv.h:101
void * parserSetupArg
Definition: spi_priv.h:102
const char * name
Definition: encode.c:521
static Portal SPI_cursor_open_internal(const char *name, SPIPlanPtr plan, ParamListInfo paramLI, bool read_only)
Definition: spi.c:1313
#define elog(elevel,...)
Definition: elog.h:228
int cursor_options
Definition: spi_priv.h:98
static ParamListInfo _SPI_convert_params(int nargs, Oid *argtypes, Datum *Values, const char *Nulls)
Definition: spi.c:2444
static bool Nulls[MAXATTR]
Definition: bootstrap.c:168

◆ SPI_cursor_open_with_paramlist()

Portal SPI_cursor_open_with_paramlist ( const char *  name,
SPIPlanPtr  plan,
ParamListInfo  params,
bool  read_only 
)

Definition at line 1300 of file spi.c.

References SPI_cursor_open_internal().

Referenced by exec_run_select(), exec_stmt_forc(), and exec_stmt_open().

1302 {
1303  return SPI_cursor_open_internal(name, plan, params, read_only);
1304 }
const char * name
Definition: encode.c:521
static Portal SPI_cursor_open_internal(const char *name, SPIPlanPtr plan, ParamListInfo paramLI, bool read_only)
Definition: spi.c:1313

◆ SPI_datumTransfer()

Datum SPI_datumTransfer ( Datum  value,
bool  typByVal,
int  typLen 
)

Definition at line 1137 of file spi.c.

References datumTransfer(), elog, ERROR, MemoryContextSwitchTo(), and _SPI_connection::savedcxt.

Referenced by coerce_function_result_tuple(), and plpgsql_exec_function().

1138 {
1139  MemoryContext oldcxt;
1140  Datum result;
1141 
1142  if (_SPI_current == NULL)
1143  elog(ERROR, "SPI_datumTransfer called while not connected to SPI");
1144 
1146 
1147  result = datumTransfer(value, typByVal, typLen);
1148 
1149  MemoryContextSwitchTo(oldcxt);
1150 
1151  return result;
1152 }
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
static struct @145 value
static _SPI_connection * _SPI_current
Definition: spi.c:50
#define ERROR
Definition: elog.h:43
MemoryContext savedcxt
Definition: spi_priv.h:35
uintptr_t Datum
Definition: postgres.h:367
Datum datumTransfer(Datum value, bool typByVal, int typLen)
Definition: datum.c:192
#define elog(elevel,...)
Definition: elog.h:228

◆ SPI_exec()

int SPI_exec ( const char *  src,
long  tcount 
)

Definition at line 524 of file spi.c.

References SPI_execute().

Referenced by get_tuple_of_interest(), refresh_by_match_merge(), and xpath_table().

525 {
526  return SPI_execute(src, false, tcount);
527 }
int SPI_execute(const char *src, bool read_only, long tcount)
Definition: spi.c:496

◆ SPI_execp()

int SPI_execp ( SPIPlanPtr  plan,
Datum Values,
const char *  Nulls,
long  tcount 
)

Definition at line 558 of file spi.c.

References SPI_execute_plan().

Referenced by check_foreign_key(), check_primary_key(), and ttdummy().

559 {
560  return SPI_execute_plan(plan, Values, Nulls, false, tcount);
561 }
int SPI_execute_plan(SPIPlanPtr plan, Datum *Values, const char *Nulls, bool read_only, long tcount)
Definition: spi.c:531
static bool Nulls[MAXATTR]
Definition: bootstrap.c:168

◆ SPI_execute()

int SPI_execute ( const char *  src,
bool  read_only,
long  tcount 
)

Definition at line 496 of file spi.c.

References _SPI_begin_call(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, _SPI_prepare_oneshot_plan(), CURSOR_OPT_PARALLEL_OK, _SPI_plan::cursor_options, InvalidSnapshot, _SPI_plan::magic, and SPI_ERROR_ARGUMENT.

Referenced by build_tuplestore_recursively(), crosstab(), exec_stmt_dynexecute(), get_crosstab_tuplestore(), initialize_worker_spi(), load_categories_hash(), plperl_spi_exec(), pltcl_SPI_execute(), PLy_spi_execute_query(), query_to_oid_list(), query_to_xml_internal(), refresh_by_match_merge(), and SPI_exec().

497 {
498  _SPI_plan plan;
499  int res;
500 
501  if (src == NULL || tcount < 0)
502  return SPI_ERROR_ARGUMENT;
503 
504  res = _SPI_begin_call(true);
505  if (res < 0)
506  return res;
507 
508  memset(&plan, 0, sizeof(_SPI_plan));
509  plan.magic = _SPI_PLAN_MAGIC;
511 
512  _SPI_prepare_oneshot_plan(src, &plan);
513 
514  res = _SPI_execute_plan(&plan, NULL,
516  read_only, true, tcount);
517 
518  _SPI_end_call(true);
519  return res;
520 }
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
static void _SPI_prepare_oneshot_plan(const char *src, SPIPlanPtr plan)
Definition: spi.c:2043
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:2649
static int _SPI_execute_plan(SPIPlanPtr plan, ParamListInfo paramLI, Snapshot snapshot, Snapshot crosscheck_snapshot, bool read_only, bool fire_triggers, uint64 tcount)
Definition: spi.c:2101
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
static int _SPI_end_call(bool use_exec)
Definition: spi.c:2673
#define InvalidSnapshot
Definition: snapshot.h:123
#define CURSOR_OPT_PARALLEL_OK
Definition: parsenodes.h:2692
int cursor_options
Definition: spi_priv.h:98

◆ SPI_execute_plan()

int SPI_execute_plan ( SPIPlanPtr  plan,
Datum Values,
const char *  Nulls,
bool  read_only,
long  tcount 
)

Definition at line 531 of file spi.c.

References _SPI_begin_call(), _SPI_convert_params(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, _SPI_plan::argtypes, InvalidSnapshot, _SPI_plan::magic, _SPI_plan::nargs, SPI_ERROR_ARGUMENT, and SPI_ERROR_PARAM.

Referenced by exec_stmt_set(), pg_get_ruledef_worker(), pg_get_viewdef_worker(), plperl_spi_exec_prepared(), pltcl_SPI_execute_plan(), PLy_spi_execute_plan(), SPI_execp(), and test_predtest().

533 {
534  int res;
535 
536  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC || tcount < 0)
537  return SPI_ERROR_ARGUMENT;
538 
539  if (plan->nargs > 0 && Values == NULL)
540  return SPI_ERROR_PARAM;
541 
542  res = _SPI_begin_call(true);
543  if (res < 0)
544  return res;
545 
546  res = _SPI_execute_plan(plan,
547  _SPI_convert_params(plan->nargs, plan->argtypes,
548  Values, Nulls),
550  read_only, true, tcount);
551 
552  _SPI_end_call(true);
553  return res;
554 }
Oid * argtypes
Definition: spi_priv.h:100
#define SPI_ERROR_PARAM
Definition: spi.h:45
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:2649
static int _SPI_execute_plan(SPIPlanPtr plan, ParamListInfo paramLI, Snapshot snapshot, Snapshot crosscheck_snapshot, bool read_only, bool fire_triggers, uint64 tcount)
Definition: spi.c:2101
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
static int _SPI_end_call(bool use_exec)
Definition: spi.c:2673
#define InvalidSnapshot
Definition: snapshot.h:123
int nargs
Definition: spi_priv.h:99
static ParamListInfo _SPI_convert_params(int nargs, Oid *argtypes, Datum *Values, const char *Nulls)
Definition: spi.c:2444
static bool Nulls[MAXATTR]
Definition: bootstrap.c:168

◆ SPI_execute_plan_with_paramlist()

int SPI_execute_plan_with_paramlist ( SPIPlanPtr  plan,
ParamListInfo  params,
bool  read_only,
long  tcount 
)

Definition at line 565 of file spi.c.

References _SPI_begin_call(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, InvalidSnapshot, _SPI_plan::magic, and SPI_ERROR_ARGUMENT.

Referenced by exec_run_select(), exec_stmt_call(), and exec_stmt_execsql().

567 {
568  int res;
569 
570  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC || tcount < 0)
571  return SPI_ERROR_ARGUMENT;
572 
573  res = _SPI_begin_call(true);
574  if (res < 0)
575  return res;
576 
577  res = _SPI_execute_plan(plan, params,
579  read_only, true, tcount);
580 
581  _SPI_end_call(true);
582  return res;
583 }
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:2649
static int _SPI_execute_plan(SPIPlanPtr plan, ParamListInfo paramLI, Snapshot snapshot, Snapshot crosscheck_snapshot, bool read_only, bool fire_triggers, uint64 tcount)
Definition: spi.c:2101
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
static int _SPI_end_call(bool use_exec)
Definition: spi.c:2673
#define InvalidSnapshot
Definition: snapshot.h:123

◆ SPI_execute_snapshot()

int SPI_execute_snapshot ( SPIPlanPtr  plan,
Datum Values,
const char *  Nulls,
Snapshot  snapshot,
Snapshot  crosscheck_snapshot,
bool  read_only,
bool  fire_triggers,
long  tcount 
)

Definition at line 599 of file spi.c.

References _SPI_begin_call(), _SPI_convert_params(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, _SPI_plan::argtypes, _SPI_plan::magic, _SPI_plan::nargs, SPI_ERROR_ARGUMENT, and SPI_ERROR_PARAM.

Referenced by RI_Initial_Check(), RI_PartitionRemove_Check(), and ri_PerformCheck().

603 {
604  int res;
605 
606  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC || tcount < 0)
607  return SPI_ERROR_ARGUMENT;
608 
609  if (plan->nargs > 0 && Values == NULL)
610  return SPI_ERROR_PARAM;
611 
612  res = _SPI_begin_call(true);
613  if (res < 0)
614  return res;
615 
616  res = _SPI_execute_plan(plan,
617  _SPI_convert_params(plan->nargs, plan->argtypes,
618  Values, Nulls),
619  snapshot, crosscheck_snapshot,
620  read_only, fire_triggers, tcount);
621 
622  _SPI_end_call(true);
623  return res;
624 }
Oid * argtypes
Definition: spi_priv.h:100
#define SPI_ERROR_PARAM
Definition: spi.h:45
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:2649
static int _SPI_execute_plan(SPIPlanPtr plan, ParamListInfo paramLI, Snapshot snapshot, Snapshot crosscheck_snapshot, bool read_only, bool fire_triggers, uint64 tcount)
Definition: spi.c:2101
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
static int _SPI_end_call(bool use_exec)
Definition: spi.c:2673
int nargs
Definition: spi_priv.h:99
static ParamListInfo _SPI_convert_params(int nargs, Oid *argtypes, Datum *Values, const char *Nulls)
Definition: spi.c:2444
static bool Nulls[MAXATTR]
Definition: bootstrap.c:168

◆ SPI_execute_with_args()

int SPI_execute_with_args ( const char *  src,
int  nargs,
Oid argtypes,
Datum Values,
const char *  Nulls,
bool  read_only,
long  tcount 
)

Definition at line 633 of file spi.c.

References _SPI_begin_call(), _SPI_convert_params(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, _SPI_prepare_oneshot_plan(), _SPI_plan::argtypes, CURSOR_OPT_PARALLEL_OK, _SPI_plan::cursor_options, InvalidSnapshot, _SPI_plan::magic, _SPI_plan::nargs, _SPI_plan::parserSetup, _SPI_plan::parserSetupArg, SPI_ERROR_ARGUMENT, and SPI_ERROR_PARAM.

Referenced by exec_stmt_dynexecute().

637 {
638  int res;
639  _SPI_plan plan;
640  ParamListInfo paramLI;
641 
642  if (src == NULL || nargs < 0 || tcount < 0)
643  return SPI_ERROR_ARGUMENT;
644 
645  if (nargs > 0 && (argtypes == NULL || Values == NULL))
646  return SPI_ERROR_PARAM;
647 
648  res = _SPI_begin_call(true);
649  if (res < 0)
650  return res;
651 
652  memset(&plan, 0, sizeof(_SPI_plan));
653  plan.magic = _SPI_PLAN_MAGIC;
655  plan.nargs = nargs;
656  plan.argtypes = argtypes;
657  plan.parserSetup = NULL;
658  plan.parserSetupArg = NULL;
659 
660  paramLI = _SPI_convert_params(nargs, argtypes,
661  Values, Nulls);
662 
663  _SPI_prepare_oneshot_plan(src, &plan);
664 
665  res = _SPI_execute_plan(&plan, paramLI,
667  read_only, true, tcount);
668 
669  _SPI_end_call(true);
670  return res;
671 }
Oid * argtypes
Definition: spi_priv.h:100
#define SPI_ERROR_PARAM
Definition: spi.h:45
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
static void _SPI_prepare_oneshot_plan(const char *src, SPIPlanPtr plan)
Definition: spi.c:2043
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:2649
static int _SPI_execute_plan(SPIPlanPtr plan, ParamListInfo paramLI, Snapshot snapshot, Snapshot crosscheck_snapshot, bool read_only, bool fire_triggers, uint64 tcount)
Definition: spi.c:2101
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
static int _SPI_end_call(bool use_exec)
Definition: spi.c:2673
#define InvalidSnapshot
Definition: snapshot.h:123
int nargs
Definition: spi_priv.h:99
ParserSetupHook parserSetup
Definition: spi_priv.h:101
void * parserSetupArg
Definition: spi_priv.h:102
#define CURSOR_OPT_PARALLEL_OK
Definition: parsenodes.h:2692
int cursor_options
Definition: spi_priv.h:98
static ParamListInfo _SPI_convert_params(int nargs, Oid *argtypes, Datum *Values, const char *Nulls)
Definition: spi.c:2444
static bool Nulls[MAXATTR]
Definition: bootstrap.c:168

◆ SPI_finish()

int SPI_finish ( void  )

Definition at line 176 of file spi.c.

References _SPI_begin_call(), _SPI_connected, _SPI_connection::execCxt, MemoryContextDelete(), MemoryContextSwitchTo(), _SPI_connection::outer_processed, _SPI_connection::outer_result, _SPI_connection::outer_tuptable, _SPI_connection::procCxt, _SPI_connection::savedcxt, SPI_OK_FINISH, SPI_processed, and SPI_result.

Referenced by check_foreign_key(), check_primary_key(), connectby(), crosstab(), cursor_to_xml(), cursor_to_xmlschema(), database_to_xml_internal(), database_to_xmlschema_internal(), get_crosstab_tuplestore(), get_tuple_of_interest(), initialize_worker_spi(), load_categories_hash(), pg_get_ruledef_worker(), pg_get_viewdef_worker(), plperl_event_trigger_handler(), plperl_func_handler(), plperl_inline_handler(), plperl_trigger_handler(), plpgsql_call_handler(), plpgsql_inline_handler(), plpgsql_validator(), pltcl_event_trigger_handler(), pltcl_func_handler(), pltcl_trigger_handler(), PLy_exec_function(), PLy_exec_trigger(), query_to_xml_and_xmlschema(), query_to_xml_internal(), query_to_xmlschema(), refresh_by_match_merge(), ri_Check_Pk_Match(), RI_FKey_cascade_del(), RI_FKey_cascade_upd(), RI_FKey_check(), RI_Initial_Check(), RI_PartitionRemove_Check(), ri_restrict(), ri_set(), schema_to_xml_internal(), schema_to_xmlschema_internal(), test_predtest(), ts_stat1(), ts_stat2(), tsquery_rewrite_query(), ttdummy(), and xpath_table().

177 {
178  int res;
179 
180  res = _SPI_begin_call(false); /* just check we're connected */
181  if (res < 0)
182  return res;
183 
184  /* Restore memory context as it was before procedure call */
186 
187  /* Release memory used in procedure call (including tuptables) */
189  _SPI_current->execCxt = NULL;
191  _SPI_current->procCxt = NULL;
192 
193  /*
194  * Restore outer API variables, especially SPI_tuptable which is probably
195  * pointing at a just-deleted tuptable
196  */
200 
201  /* Exit stack level */
202  _SPI_connected--;
203  if (_SPI_connected < 0)
204  _SPI_current = NULL;
205  else
207 
208  return SPI_OK_FINISH;
209 }
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:211
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
SPITupleTable * SPI_tuptable
Definition: spi.c:46
static int _SPI_connected
Definition: spi.c:52
static _SPI_connection * _SPI_current
Definition: spi.c:50
uint64 SPI_processed
Definition: spi.c:45
SPITupleTable * outer_tuptable
Definition: spi_priv.h:47
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:2649
int SPI_result
Definition: spi.c:47
static _SPI_connection * _SPI_stack
Definition: spi.c:49
MemoryContext savedcxt
Definition: spi_priv.h:35
uint64 outer_processed
Definition: spi_priv.h:46
MemoryContext procCxt
Definition: spi_priv.h:33
MemoryContext execCxt
Definition: spi_priv.h:34
int outer_result
Definition: spi_priv.h:48
#define SPI_OK_FINISH
Definition: spi.h:54

◆ SPI_fname()

char* SPI_fname ( TupleDesc  tupdesc,
int  fnumber 
)

Definition at line 974 of file spi.c.

References FirstLowInvalidHeapAttributeNumber, FormData_pg_attribute, NameStr, TupleDescData::natts, pstrdup(), SPI_ERROR_NOATTRIBUTE, SPI_result, SystemAttributeDefinition(), and TupleDescAttr.

Referenced by get_pkey_attnames(), and SPI_sql_row_to_xmlelement().

975 {
976  const FormData_pg_attribute *att;
977 
978  SPI_result = 0;
979 
980  if (fnumber > tupdesc->natts || fnumber == 0 ||
982  {
984  return NULL;
985  }
986 
987  if (fnumber > 0)
988  att = TupleDescAttr(tupdesc, fnumber - 1);
989  else
990  att = SystemAttributeDefinition(fnumber);
991 
992  return pstrdup(NameStr(att->attname));
993 }
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
char * pstrdup(const char *in)
Definition: mcxt.c:1186
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:27
const FormData_pg_attribute * SystemAttributeDefinition(AttrNumber attno)
Definition: heap.c:250
int SPI_result
Definition: spi.c:47
#define SPI_ERROR_NOATTRIBUTE
Definition: spi.h:47
FormData_pg_attribute
Definition: pg_attribute.h:184
#define NameStr(name)
Definition: c.h:610

◆ SPI_fnumber()

int SPI_fnumber ( TupleDesc  tupdesc,
const char *  fname 
)

Definition at line 951 of file spi.c.

References FormData_pg_attribute, namestrcmp(), TupleDescData::natts, SPI_ERROR_NOATTRIBUTE, SystemAttributeByName(), and TupleDescAttr.

Referenced by autoinc(), check_foreign_key(), check_primary_key(), insert_username(), lo_manage(), make_ruledef(), make_viewdef(), moddatetime(), plperl_build_tuple_result(), plperl_modify_tuple(), pltcl_build_tuple_result(), PLy_modify_tuple(), tsvector_update_trigger(), and ttdummy().

952 {
953  int res;
954  const FormData_pg_attribute *sysatt;
955 
956  for (res = 0; res < tupdesc->natts; res++)
957  {
958  Form_pg_attribute attr = TupleDescAttr(tupdesc, res);
959 
960  if (namestrcmp(&attr->attname, fname) == 0 &&
961  !attr->attisdropped)
962  return res + 1;
963  }
964 
965  sysatt = SystemAttributeByName(fname);
966  if (sysatt != NULL)
967  return sysatt->attnum;
968 
969  /* SPI_ERROR_NOATTRIBUTE is different from all sys column numbers */
970  return SPI_ERROR_NOATTRIBUTE;
971 }
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
int namestrcmp(Name name, const char *str)
Definition: name.c:287
const FormData_pg_attribute * SystemAttributeByName(const char *attname)
Definition: heap.c:262
#define SPI_ERROR_NOATTRIBUTE
Definition: spi.h:47
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:200
FormData_pg_attribute
Definition: pg_attribute.h:184

◆ SPI_freeplan()

int SPI_freeplan ( SPIPlanPtr  plan)

Definition at line 801 of file spi.c.

References _SPI_PLAN_MAGIC, DropCachedPlan(), lfirst, _SPI_plan::magic, MemoryContextDelete(), _SPI_plan::plancache_list, _SPI_plan::plancxt, and SPI_ERROR_ARGUMENT.

Referenced by free_expr(), plperl_spi_freeplan(), plperl_spi_prepare(), plperl_spi_query(), PLy_cursor_query(), PLy_plan_dealloc(), ri_FetchPreparedPlan(), ts_stat_sql(), and tsquery_rewrite_query().

802 {
803  ListCell *lc;
804 
805  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC)
806  return SPI_ERROR_ARGUMENT;
807 
808  /* Release the plancache entries */
809  foreach(lc, plan->plancache_list)
810  {
811  CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc);
812 
813  DropCachedPlan(plansource);
814  }
815 
816  /* Now get rid of the _SPI_plan and subsidiary data in its plancxt */
818 
819  return 0;
820 }
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:211
List * plancache_list
Definition: spi_priv.h:96
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
MemoryContext plancxt
Definition: spi_priv.h:97
#define lfirst(lc)
Definition: pg_list.h:190
void DropCachedPlan(CachedPlanSource *plansource)
Definition: plancache.c:496

◆ SPI_freetuple()

void SPI_freetuple ( HeapTuple  pointer)

Definition at line 1155 of file spi.c.

References heap_freetuple().

1156 {
1157  /* No longer need to worry which context tuple was in... */
1158  heap_freetuple(tuple);
1159 }
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338

◆ SPI_freetuptable()

void SPI_freetuptable ( SPITupleTable tuptable)

Definition at line 1162 of file spi.c.

References slist_mutable_iter::cur, elog, MemoryContextDelete(), next, slist_container, slist_delete_current(), slist_foreach_modify, SPITupleTable::tuptabcxt, _SPI_connection::tuptable, _SPI_connection::tuptables, and WARNING.

Referenced by _SPI_execute_plan(), exec_assign_value(), exec_eval_cleanup(), exec_for_query(), exec_stmt_call(), exec_stmt_dynexecute(), exec_stmt_execsql(), exec_stmt_fetch(), exec_stmt_return_query(), plperl_spi_execute_fetch_result(), plperl_spi_fetchrow(), pltcl_process_SPI_result(), PLy_cursor_fetch(), PLy_cursor_iternext(), PLy_spi_execute_fetch_result(), ts_stat_sql(), and tsquery_rewrite_query().

1163 {
1164  bool found = false;
1165 
1166  /* ignore call if NULL pointer */
1167  if (tuptable == NULL)
1168  return;
1169 
1170  /*
1171  * Search only the topmost SPI context for a matching tuple table.
1172  */
1173  if (_SPI_current != NULL)
1174  {
1175  slist_mutable_iter siter;
1176 
1177  /* find tuptable in active list, then remove it */
1179  {
1180  SPITupleTable *tt;
1181 
1182  tt = slist_container(SPITupleTable, next, siter.cur);
1183  if (tt == tuptable)
1184  {
1185  slist_delete_current(&siter);
1186  found = true;
1187  break;
1188  }
1189  }
1190  }
1191 
1192  /*
1193  * Refuse the deletion if we didn't find it in the topmost SPI context.
1194  * This is primarily a guard against double deletion, but might prevent
1195  * other errors as well. Since the worst consequence of not deleting a
1196  * tuptable would be a transient memory leak, this is just a WARNING.
1197  */
1198  if (!found)
1199  {
1200  elog(WARNING, "attempt to delete invalid SPITupleTable %p", tuptable);
1201  return;
1202  }
1203 
1204  /* for safety, reset global variables that might point at tuptable */
1205  if (tuptable == _SPI_current->tuptable)
1206  _SPI_current->tuptable = NULL;
1207  if (tuptable == SPI_tuptable)
1208  SPI_tuptable = NULL;
1209 
1210  /* release all memory belonging to tuptable */
1211  MemoryContextDelete(tuptable->tuptabcxt);
1212 }
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:211
static int32 next
Definition: blutils.c:213
slist_node * cur
Definition: ilist.h:241
SPITupleTable * SPI_tuptable
Definition: spi.c:46
static _SPI_connection * _SPI_current
Definition: spi.c:50
#define slist_foreach_modify(iter, lhead)
Definition: ilist.h:716
SPITupleTable * tuptable
Definition: spi_priv.h:26
#define WARNING
Definition: elog.h:40
#define slist_container(type, membername, ptr)
Definition: ilist.h:674
#define elog(elevel,...)
Definition: elog.h:228
static void slist_delete_current(slist_mutable_iter *iter)
Definition: ilist.h:652
slist_head tuptables
Definition: spi_priv.h:32
MemoryContext tuptabcxt
Definition: spi.h:31

◆ SPI_getargcount()

int SPI_getargcount ( SPIPlanPtr  plan)

Definition at line 1623 of file spi.c.

References _SPI_PLAN_MAGIC, _SPI_plan::magic, _SPI_plan::nargs, SPI_ERROR_ARGUMENT, and SPI_result.

1624 {
1625  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC)
1626  {
1628  return -1;
1629  }
1630  return plan->nargs;
1631 }
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
int SPI_result
Definition: spi.c:47
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
int nargs
Definition: spi_priv.h:99

◆ SPI_getargtypeid()

Oid SPI_getargtypeid ( SPIPlanPtr  plan,
int  argIndex 
)

Definition at line 1608 of file spi.c.

References _SPI_PLAN_MAGIC, _SPI_plan::argtypes, InvalidOid, _SPI_plan::magic, _SPI_plan::nargs, SPI_ERROR_ARGUMENT, and SPI_result.

1609 {
1610  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC ||
1611  argIndex < 0 || argIndex >= plan->nargs)
1612  {
1614  return InvalidOid;
1615  }
1616  return plan->argtypes[argIndex];
1617 }
Oid * argtypes
Definition: spi_priv.h:100
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
int SPI_result
Definition: spi.c:47
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
int nargs
Definition: spi_priv.h:99
#define InvalidOid
Definition: postgres_ext.h:36

◆ SPI_getbinval()

Datum SPI_getbinval ( HeapTuple  tuple,
TupleDesc  tupdesc,
int  fnumber,
bool isnull 
)

Definition at line 1028 of file spi.c.

References FirstLowInvalidHeapAttributeNumber, heap_getattr, TupleDescData::natts, SPI_ERROR_NOATTRIBUTE, and SPI_result.

Referenced by autoinc(), check_foreign_key(), check_primary_key(), exec_eval_expr(), initialize_worker_spi(), make_ruledef(), make_viewdef(), query_to_oid_list(), SPI_sql_row_to_xmlelement(), test_predtest(), ts_stat_sql(), tsquery_rewrite_query(), tsvector_update_trigger(), and ttdummy().

1029 {
1030  SPI_result = 0;
1031 
1032  if (fnumber > tupdesc->natts || fnumber == 0 ||
1034  {
1036  *isnull = true;
1037  return (Datum) NULL;
1038  }
1039 
1040  return heap_getattr(tuple, fnumber, tupdesc, isnull);
1041 }
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:27
int SPI_result
Definition: spi.c:47
#define SPI_ERROR_NOATTRIBUTE
Definition: spi.h:47
#define heap_getattr(tup, attnum, tupleDesc, isnull)
Definition: htup_details.h:762
uintptr_t Datum
Definition: postgres.h:367

◆ SPI_getnspname()

char* SPI_getnspname ( Relation  rel)

Definition at line 1108 of file spi.c.

References get_namespace_name(), and RelationGetNamespace.

Referenced by plperl_trigger_build_args(), pltcl_trigger_handler(), and PLy_trigger_build_args().

1109 {
1111 }
char * get_namespace_name(Oid nspid)
Definition: lsyscache.c:3094
#define RelationGetNamespace(relation)
Definition: rel.h:464

◆ SPI_getrelname()

char* SPI_getrelname ( Relation  rel)

Definition at line 1102 of file spi.c.

References pstrdup(), and RelationGetRelationName.

Referenced by autoinc(), check_foreign_key(), check_primary_key(), insert_username(), moddatetime(), plperl_trigger_build_args(), pltcl_trigger_handler(), PLy_trigger_build_args(), and ttdummy().

1103 {
1104  return pstrdup(RelationGetRelationName(rel));
1105 }
char * pstrdup(const char *in)
Definition: mcxt.c:1186
#define RelationGetRelationName(relation)
Definition: rel.h:457

◆ SPI_gettype()

char* SPI_gettype ( TupleDesc  tupdesc,
int  fnumber 
)

Definition at line 1044 of file spi.c.

References atttypid, FirstLowInvalidHeapAttributeNumber, GETSTRUCT, HeapTupleIsValid, NameStr, TupleDescData::natts, ObjectIdGetDatum, pstrdup(), ReleaseSysCache(), SearchSysCache1(), SPI_ERROR_NOATTRIBUTE, SPI_ERROR_TYPUNKNOWN, SPI_result, SystemAttributeDefinition(), TupleDescAttr, TYPEOID, and typname.

Referenced by check_foreign_key().

1045 {
1046  Oid typoid;
1047  HeapTuple typeTuple;
1048  char *result;
1049 
1050  SPI_result = 0;
1051 
1052  if (fnumber > tupdesc->natts || fnumber == 0 ||
1054  {
1056  return NULL;
1057  }
1058 
1059  if (fnumber > 0)
1060  typoid = TupleDescAttr(tupdesc, fnumber - 1)->atttypid;
1061  else
1062  typoid = (SystemAttributeDefinition(fnumber))->atttypid;
1063 
1064  typeTuple = SearchSysCache1(TYPEOID, ObjectIdGetDatum(typoid));
1065 
1066  if (!HeapTupleIsValid(typeTuple))
1067  {
1069  return NULL;
1070  }
1071 
1072  result = pstrdup(NameStr(((Form_pg_type) GETSTRUCT(typeTuple))->typname));
1073  ReleaseSysCache(typeTuple);
1074  return result;
1075 }
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
char * pstrdup(const char *in)
Definition: mcxt.c:1186
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:27
unsigned int Oid
Definition: postgres_ext.h:31
const FormData_pg_attribute * SystemAttributeDefinition(AttrNumber attno)
Definition: heap.c:250
int SPI_result
Definition: spi.c:47
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define SPI_ERROR_NOATTRIBUTE
Definition: spi.h:47
Oid atttypid
Definition: pg_attribute.h:49
NameData typname
Definition: pg_type.h:42
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1116
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1164
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
FormData_pg_type * Form_pg_type
Definition: pg_type.h:251
#define SPI_ERROR_TYPUNKNOWN
Definition: spi.h:49
#define NameStr(name)
Definition: c.h:610

◆ SPI_gettypeid()

Oid SPI_gettypeid ( TupleDesc  tupdesc,
int  fnumber 
)

Definition at line 1084 of file spi.c.

References FirstLowInvalidHeapAttributeNumber, InvalidOid, TupleDescData::natts, SPI_ERROR_NOATTRIBUTE, SPI_result, SystemAttributeDefinition(), and TupleDescAttr.

Referenced by autoinc(), check_foreign_key(), check_primary_key(), insert_username(), moddatetime(), SPI_sql_row_to_xmlelement(), ts_stat_sql(), tsquery_rewrite_query(), tsvector_update_trigger(), and ttdummy().

1085 {
1086  SPI_result = 0;
1087 
1088  if (fnumber > tupdesc->natts || fnumber == 0 ||
1090  {
1092  return InvalidOid;
1093  }
1094 
1095  if (fnumber > 0)
1096  return TupleDescAttr(tupdesc, fnumber - 1)->atttypid;
1097  else
1098  return (SystemAttributeDefinition(fnumber))->atttypid;
1099 }
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:27
const FormData_pg_attribute * SystemAttributeDefinition(AttrNumber attno)
Definition: heap.c:250
int SPI_result
Definition: spi.c:47
#define SPI_ERROR_NOATTRIBUTE
Definition: spi.h:47
#define InvalidOid
Definition: postgres_ext.h:36

◆ SPI_getvalue()

char* SPI_getvalue ( HeapTuple  tuple,
TupleDesc  tupdesc,
int  fnumber 
)

Definition at line 996 of file spi.c.

References atttypid, FirstLowInvalidHeapAttributeNumber, getTypeOutputInfo(), heap_getattr, TupleDescData::natts, OidOutputFunctionCall(), SPI_ERROR_NOATTRIBUTE, SPI_result, SystemAttributeDefinition(), TupleDescAttr, and val.

Referenced by build_tuplestore_recursively(), check_foreign_key(), crosstab(), get_crosstab_tuplestore(), get_sql_insert(), get_sql_update(), lo_manage(), load_categories_hash(), make_ruledef(), make_viewdef(), refresh_by_match_merge(), triggered_change_notification(), and xpath_table().

997 {
998  Datum val;
999  bool isnull;
1000  Oid typoid,
1001  foutoid;
1002  bool typisvarlena;
1003 
1004  SPI_result = 0;
1005 
1006  if (fnumber > tupdesc->natts || fnumber == 0 ||
1008  {
1010  return NULL;
1011  }
1012 
1013  val = heap_getattr(tuple, fnumber, tupdesc, &isnull);
1014  if (isnull)
1015  return NULL;
1016 
1017  if (fnumber > 0)
1018  typoid = TupleDescAttr(tupdesc, fnumber - 1)->atttypid;
1019  else
1020  typoid = (SystemAttributeDefinition(fnumber))->atttypid;
1021 
1022  getTypeOutputInfo(typoid, &foutoid, &typisvarlena);
1023 
1024  return OidOutputFunctionCall(foutoid, val);
1025 }
void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena)
Definition: lsyscache.c:2674
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:27
unsigned int Oid
Definition: postgres_ext.h:31
const FormData_pg_attribute * SystemAttributeDefinition(AttrNumber attno)
Definition: heap.c:250
int SPI_result
Definition: spi.c:47
#define SPI_ERROR_NOATTRIBUTE
Definition: spi.h:47
Oid atttypid
Definition: pg_attribute.h:49
#define heap_getattr(tup, attnum, tupleDesc, isnull)
Definition: htup_details.h:762
uintptr_t Datum
Definition: postgres.h:367
char * OidOutputFunctionCall(Oid functionId, Datum val)
Definition: fmgr.c:1655
long val
Definition: informix.c:684

◆ SPI_inside_nonatomic_context()

bool SPI_inside_nonatomic_context ( void  )

Definition at line 484 of file spi.c.

References _SPI_connection::atomic.

Referenced by StartTransaction().

485 {
486  if (_SPI_current == NULL)
487  return false; /* not in any SPI context at all */
488  if (_SPI_current->atomic)
489  return false; /* it's atomic (ie function not procedure) */
490  return true;
491 }
static _SPI_connection * _SPI_current
Definition: spi.c:50

◆ SPI_is_cursor_plan()

bool SPI_is_cursor_plan ( SPIPlanPtr  plan)

Definition at line 1643 of file spi.c.

References _SPI_PLAN_MAGIC, linitial, list_length(), _SPI_plan::magic, _SPI_plan::plancache_list, CachedPlanSource::resultDesc, SPI_ERROR_ARGUMENT, and SPI_result.

Referenced by SPI_cursor_open_internal().

1644 {
1645  CachedPlanSource *plansource;
1646 
1647  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC)
1648  {
1650  return false;
1651  }
1652 
1653  if (list_length(plan->plancache_list) != 1)
1654  {
1655  SPI_result = 0;
1656  return false; /* not exactly 1 pre-rewrite command */
1657  }
1658  plansource = (CachedPlanSource *) linitial(plan->plancache_list);
1659 
1660  /*
1661  * We used to force revalidation of the cached plan here, but that seems
1662  * unnecessary: invalidation could mean a change in the rowtype of the
1663  * tuples returned by a plan, but not whether it returns tuples at all.
1664  */
1665  SPI_result = 0;
1666 
1667  /* Does it return tuples? */
1668  if (plansource->resultDesc)
1669  return true;
1670 
1671  return false;
1672 }
List * plancache_list
Definition: spi_priv.h:96
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
TupleDesc resultDesc
Definition: plancache.h:105
int SPI_result
Definition: spi.c:47
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
#define linitial(l)
Definition: pg_list.h:195
static int list_length(const List *l)
Definition: pg_list.h:169

◆ SPI_keepplan()

int SPI_keepplan ( SPIPlanPtr  plan)

Definition at line 752 of file spi.c.

References _SPI_PLAN_MAGIC, CacheMemoryContext, lfirst, _SPI_plan::magic, MemoryContextSetParent(), _SPI_plan::oneshot, _SPI_plan::plancache_list, _SPI_plan::plancxt, SaveCachedPlan(), _SPI_plan::saved, and SPI_ERROR_ARGUMENT.

Referenced by check_foreign_key(), check_primary_key(), exec_prepare_plan(), pg_get_ruledef_worker(), pg_get_viewdef_worker(), plperl_spi_prepare(), pltcl_SPI_prepare(), PLy_spi_prepare(), ri_PlanCheck(), and ttdummy().

753 {
754  ListCell *lc;
755 
756  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC ||
757  plan->saved || plan->oneshot)
758  return SPI_ERROR_ARGUMENT;
759 
760  /*
761  * Mark it saved, reparent it under CacheMemoryContext, and mark all the
762  * component CachedPlanSources as saved. This sequence cannot fail
763  * partway through, so there's no risk of long-term memory leakage.
764  */
765  plan->saved = true;
767 
768  foreach(lc, plan->plancache_list)
769  {
770  CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc);
771 
772  SaveCachedPlan(plansource);
773  }
774 
775  return 0;
776 }
List * plancache_list
Definition: spi_priv.h:96
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
void MemoryContextSetParent(MemoryContext context, MemoryContext new_parent)
Definition: mcxt.c:354
int magic
Definition: spi_priv.h:92
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
MemoryContext plancxt
Definition: spi_priv.h:97
bool saved
Definition: spi_priv.h:93
void SaveCachedPlan(CachedPlanSource *plansource)
Definition: plancache.c:452
#define lfirst(lc)
Definition: pg_list.h:190
bool oneshot
Definition: spi_priv.h:94
MemoryContext CacheMemoryContext
Definition: mcxt.c:47

◆ SPI_modifytuple()

HeapTuple SPI_modifytuple ( Relation  rel,
HeapTuple  tuple,
int  natts,
int *  attnum,
Datum Values,
const char *  Nulls 
)

Definition at line 882 of file spi.c.

References heap_deform_tuple(), heap_form_tuple(), i, MemoryContextSwitchTo(), TupleDescData::natts, palloc(), pfree(), RelationData::rd_att, _SPI_connection::savedcxt, SPI_ERROR_ARGUMENT, SPI_ERROR_NOATTRIBUTE, SPI_ERROR_UNCONNECTED, SPI_result, HeapTupleHeaderData::t_ctid, HeapTupleData::t_data, HeapTupleData::t_self, and HeapTupleData::t_tableOid.

Referenced by ttdummy().

884 {
885  MemoryContext oldcxt;
886  HeapTuple mtuple;
887  int numberOfAttributes;
888  Datum *v;
889  bool *n;
890  int i;
891 
892  if (rel == NULL || tuple == NULL || natts < 0 || attnum == NULL || Values == NULL)
893  {
895  return NULL;
896  }
897 
898  if (_SPI_current == NULL)
899  {
901  return NULL;
902  }
903 
905 
906  SPI_result = 0;
907 
908  numberOfAttributes = rel->rd_att->natts;
909  v = (Datum *) palloc(numberOfAttributes * sizeof(Datum));
910  n = (bool *) palloc(numberOfAttributes * sizeof(bool));
911 
912  /* fetch old values and nulls */
913  heap_deform_tuple(tuple, rel->rd_att, v, n);
914 
915  /* replace values and nulls */
916  for (i = 0; i < natts; i++)
917  {
918  if (attnum[i] <= 0 || attnum[i] > numberOfAttributes)
919  break;
920  v[attnum[i] - 1] = Values[i];
921  n[attnum[i] - 1] = (Nulls && Nulls[i] == 'n') ? true : false;
922  }
923 
924  if (i == natts) /* no errors in *attnum */
925  {
926  mtuple = heap_form_tuple(rel->rd_att, v, n);
927 
928  /*
929  * copy the identification info of the old tuple: t_ctid, t_self, and
930  * OID (if any)
931  */
932  mtuple->t_data->t_ctid = tuple->t_data->t_ctid;
933  mtuple->t_self = tuple->t_self;
934  mtuple->t_tableOid = tuple->t_tableOid;
935  }
936  else
937  {
938  mtuple = NULL;
940  }
941 
942  pfree(v);
943  pfree(n);
944 
945  MemoryContextSwitchTo(oldcxt);
946 
947  return mtuple;
948 }
#define SPI_ERROR_UNCONNECTED
Definition: spi.h:42
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
static _SPI_connection * _SPI_current
Definition: spi.c:50
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, Datum *values, bool *isnull)
Definition: heaptuple.c:1020
HeapTupleHeader t_data
Definition: htup.h:68
int SPI_result
Definition: spi.c:47
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
void pfree(void *pointer)
Definition: mcxt.c:1056
ItemPointerData t_ctid
Definition: htup_details.h:160
ItemPointerData t_self
Definition: htup.h:65
#define SPI_ERROR_NOATTRIBUTE
Definition: spi.h:47
Oid t_tableOid
Definition: htup.h:66
MemoryContext savedcxt
Definition: spi_priv.h:35
uintptr_t Datum
Definition: postgres.h:367
TupleDesc rd_att
Definition: rel.h:84
int16 attnum
Definition: pg_attribute.h:79
void heap_deform_tuple(HeapTuple tuple, TupleDesc tupleDesc, Datum *values, bool *isnull)
Definition: heaptuple.c:1249
void * palloc(Size size)
Definition: mcxt.c:949
int i
static bool Nulls[MAXATTR]
Definition: bootstrap.c:168

◆ SPI_palloc()

void* SPI_palloc ( Size  size)

Definition at line 1114 of file spi.c.

References elog, ERROR, MemoryContextAlloc(), and _SPI_connection::savedcxt.

Referenced by _SPI_strdup(), and coerce_function_result_tuple().

1115 {
1116  if (_SPI_current == NULL)
1117  elog(ERROR, "SPI_palloc called while not connected to SPI");
1118 
1119  return MemoryContextAlloc(_SPI_current->savedcxt, size);
1120 }
static _SPI_connection * _SPI_current
Definition: spi.c:50
#define ERROR
Definition: elog.h:43
MemoryContext savedcxt
Definition: spi_priv.h:35
void * MemoryContextAlloc(MemoryContext context, Size size)
Definition: mcxt.c:796
#define elog(elevel,...)
Definition: elog.h:228

◆ SPI_pfree()

void SPI_pfree ( void *  pointer)

Definition at line 1130 of file spi.c.

References pfree().

1131 {
1132  /* No longer need to worry which context chunk was in... */
1133  pfree(pointer);
1134 }
void pfree(void *pointer)
Definition: mcxt.c:1056

◆ SPI_plan_get_cached_plan()

CachedPlan* SPI_plan_get_cached_plan ( SPIPlanPtr  plan)

Definition at line 1798 of file spi.c.

References _SPI_error_callback(), _SPI_PLAN_MAGIC, ErrorContextCallback::arg, Assert, ErrorContextCallback::callback, error_context_stack, GetCachedPlan(), CachedPlanSource::gplan, linitial, list_length(), _SPI_plan::magic, _SPI_plan::oneshot, _SPI_plan::plancache_list, ErrorContextCallback::previous, CachedPlanSource::query_string, _SPI_connection::queryEnv, _SPI_plan::saved, and unconstify.

Referenced by exec_eval_simple_expr(), exec_simple_check_plan(), and test_predtest().

1799 {
1800  CachedPlanSource *plansource;
1801  CachedPlan *cplan;
1802  ErrorContextCallback spierrcontext;
1803 
1804  Assert(plan->magic == _SPI_PLAN_MAGIC);
1805 
1806  /* Can't support one-shot plans here */
1807  if (plan->oneshot)
1808  return NULL;
1809 
1810  /* Must have exactly one CachedPlanSource */
1811  if (list_length(plan->plancache_list) != 1)
1812  return NULL;
1813  plansource = (CachedPlanSource *) linitial(plan->plancache_list);
1814 
1815  /* Setup error traceback support for ereport() */
1816  spierrcontext.callback = _SPI_error_callback;
1817  spierrcontext.arg = unconstify(char *, plansource->query_string);
1818  spierrcontext.previous = error_context_stack;
1819  error_context_stack = &spierrcontext;
1820 
1821  /* Get the generic plan for the query */
1822  cplan = GetCachedPlan(plansource, NULL, plan->saved,
1824  Assert(cplan == plansource->gplan);
1825 
1826  /* Pop the error context stack */
1827  error_context_stack = spierrcontext.previous;
1828 
1829  return cplan;
1830 }
List * plancache_list
Definition: spi_priv.h:96
CachedPlan * GetCachedPlan(CachedPlanSource *plansource, ParamListInfo boundParams, bool useResOwner, QueryEnvironment *queryEnv)
Definition: plancache.c:1138
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
static _SPI_connection * _SPI_current
Definition: spi.c:50
void(* callback)(void *arg)
Definition: elog.h:256
struct ErrorContextCallback * previous
Definition: elog.h:255
struct CachedPlan * gplan
Definition: plancache.h:118
ErrorContextCallback * error_context_stack
Definition: elog.c:91
static void _SPI_error_callback(void *arg)
Definition: spi.c:2550
#define linitial(l)
Definition: pg_list.h:195
QueryEnvironment * queryEnv
Definition: spi_priv.h:37
#define unconstify(underlying_type, expr)
Definition: c.h:1188
bool saved
Definition: spi_priv.h:93
#define Assert(condition)
Definition: c.h:733
bool oneshot
Definition: spi_priv.h:94
const char * query_string
Definition: plancache.h:97
static int list_length(const List *l)
Definition: pg_list.h:169

◆ SPI_plan_get_plan_sources()

List* SPI_plan_get_plan_sources ( SPIPlanPtr  plan)

Definition at line 1782 of file spi.c.

References _SPI_PLAN_MAGIC, Assert, _SPI_plan::magic, and _SPI_plan::plancache_list.

Referenced by exec_simple_check_plan(), and exec_stmt_execsql().

1783 {
1784  Assert(plan->magic == _SPI_PLAN_MAGIC);
1785  return plan->plancache_list;
1786 }
List * plancache_list
Definition: spi_priv.h:96
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
#define Assert(condition)
Definition: c.h:733

◆ SPI_plan_is_valid()

bool SPI_plan_is_valid ( SPIPlanPtr  plan)

Definition at line 1681 of file spi.c.

References _SPI_PLAN_MAGIC, Assert, CachedPlanIsValid(), lfirst, _SPI_plan::magic, and _SPI_plan::plancache_list.

Referenced by ri_FetchPreparedPlan().

1682 {
1683  ListCell *lc;
1684 
1685  Assert(plan->magic == _SPI_PLAN_MAGIC);
1686 
1687  foreach(lc, plan->plancache_list)
1688  {
1689  CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc);
1690 
1691  if (!CachedPlanIsValid(plansource))
1692  return false;
1693  }
1694  return true;
1695 }
List * plancache_list
Definition: spi_priv.h:96
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
#define Assert(condition)
Definition: c.h:733
#define lfirst(lc)
Definition: pg_list.h:190
bool CachedPlanIsValid(CachedPlanSource *plansource)
Definition: plancache.c:1415

◆ SPI_prepare()

SPIPlanPtr SPI_prepare ( const char *  src,
int  nargs,
Oid argtypes 
)

◆ SPI_prepare_cursor()

SPIPlanPtr SPI_prepare_cursor ( const char *  src,
int  nargs,
Oid argtypes,
int  cursorOptions 
)

Definition at line 680 of file spi.c.

References _SPI_begin_call(), _SPI_end_call(), _SPI_make_plan_non_temp(), _SPI_PLAN_MAGIC, _SPI_prepare_plan(), _SPI_plan::argtypes, _SPI_plan::cursor_options, _SPI_plan::magic, _SPI_plan::nargs, _SPI_plan::parserSetup, _SPI_plan::parserSetupArg, SPI_ERROR_ARGUMENT, and SPI_result.

Referenced by SPI_prepare().

682 {
683  _SPI_plan plan;
684  SPIPlanPtr result;
685 
686  if (src == NULL || nargs < 0 || (nargs > 0 && argtypes == NULL))
687  {
689  return NULL;
690  }
691 
692  SPI_result = _SPI_begin_call(true);
693  if (SPI_result < 0)
694  return NULL;
695 
696  memset(&plan, 0, sizeof(_SPI_plan));
697  plan.magic = _SPI_PLAN_MAGIC;
698  plan.cursor_options = cursorOptions;
699  plan.nargs = nargs;
700  plan.argtypes = argtypes;
701  plan.parserSetup = NULL;
702  plan.parserSetupArg = NULL;
703 
704  _SPI_prepare_plan(src, &plan);
705 
706  /* copy plan to procedure context */
707  result = _SPI_make_plan_non_temp(&plan);
708 
709  _SPI_end_call(true);
710 
711  return result;
712 }
static void _SPI_prepare_plan(const char *src, SPIPlanPtr plan)
Definition: spi.c:1938
Oid * argtypes
Definition: spi_priv.h:100
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:2649
int SPI_result
Definition: spi.c:47
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
static SPIPlanPtr _SPI_make_plan_non_temp(SPIPlanPtr plan)
Definition: spi.c:2713
static int _SPI_end_call(bool use_exec)
Definition: spi.c:2673
int nargs
Definition: spi_priv.h:99
ParserSetupHook parserSetup
Definition: spi_priv.h:101
void * parserSetupArg
Definition: spi_priv.h:102
int cursor_options
Definition: spi_priv.h:98

◆ SPI_prepare_params()

SPIPlanPtr SPI_prepare_params ( const char *  src,
ParserSetupHook  parserSetup,
void *  parserSetupArg,
int  cursorOptions 
)

Definition at line 715 of file spi.c.

References _SPI_begin_call(), _SPI_end_call(), _SPI_make_plan_non_temp(), _SPI_PLAN_MAGIC, _SPI_prepare_plan(), _SPI_plan::argtypes, _SPI_plan::cursor_options, _SPI_plan::magic, _SPI_plan::nargs, _SPI_plan::parserSetup, _SPI_plan::parserSetupArg, SPI_ERROR_ARGUMENT, and SPI_result.

Referenced by exec_prepare_plan().

719 {
720  _SPI_plan plan;
721  SPIPlanPtr result;
722 
723  if (src == NULL)
724  {
726  return NULL;
727  }
728 
729  SPI_result = _SPI_begin_call(true);
730  if (SPI_result < 0)
731  return NULL;
732 
733  memset(&plan, 0, sizeof(_SPI_plan));
734  plan.magic = _SPI_PLAN_MAGIC;
735  plan.cursor_options = cursorOptions;
736  plan.nargs = 0;
737  plan.argtypes = NULL;
738  plan.parserSetup = parserSetup;
739  plan.parserSetupArg = parserSetupArg;
740 
741  _SPI_prepare_plan(src, &plan);
742 
743  /* copy plan to procedure context */
744  result = _SPI_make_plan_non_temp(&plan);
745 
746  _SPI_end_call(true);
747 
748  return result;
749 }
static void _SPI_prepare_plan(const char *src, SPIPlanPtr plan)
Definition: spi.c:1938
Oid * argtypes
Definition: spi_priv.h:100
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:2649
int SPI_result
Definition: spi.c:47
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
static SPIPlanPtr _SPI_make_plan_non_temp(SPIPlanPtr plan)
Definition: spi.c:2713
static int _SPI_end_call(bool use_exec)
Definition: spi.c:2673
int nargs
Definition: spi_priv.h:99
ParserSetupHook parserSetup
Definition: spi_priv.h:101
void * parserSetupArg
Definition: spi_priv.h:102
int cursor_options
Definition: spi_priv.h:98

◆ SPI_register_relation()

int SPI_register_relation ( EphemeralNamedRelation  enr)

Definition at line 2867 of file spi.c.

References _SPI_begin_call(), _SPI_end_call(), _SPI_find_ENR_by_name(), create_queryEnv(), EphemeralNamedRelationData::md, EphemeralNamedRelationMetadataData::name, _SPI_connection::queryEnv, register_ENR(), SPI_ERROR_ARGUMENT, SPI_ERROR_REL_DUPLICATE, and SPI_OK_REL_REGISTER.

Referenced by SPI_register_trigger_data().

2868 {
2869  EphemeralNamedRelation match;
2870  int res;
2871 
2872  if (enr == NULL || enr->md.name == NULL)
2873  return SPI_ERROR_ARGUMENT;
2874 
2875  res = _SPI_begin_call(false); /* keep current memory context */
2876  if (res < 0)
2877  return res;
2878 
2879  match = _SPI_find_ENR_by_name(enr->md.name);
2880  if (match)
2882  else
2883  {
2884  if (_SPI_current->queryEnv == NULL)
2886 
2888  res = SPI_OK_REL_REGISTER;
2889  }
2890 
2891  _SPI_end_call(false);
2892 
2893  return res;
2894 }
EphemeralNamedRelationMetadataData md
#define SPI_ERROR_REL_DUPLICATE
Definition: spi.h:50
static EphemeralNamedRelation _SPI_find_ENR_by_name(const char *name)
Definition: spi.c:2850
static _SPI_connection * _SPI_current
Definition: spi.c:50
#define SPI_OK_REL_REGISTER
Definition: spi.h:67
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:2649
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
QueryEnvironment * queryEnv
Definition: spi_priv.h:37
static int _SPI_end_call(bool use_exec)
Definition: spi.c:2673
void register_ENR(QueryEnvironment *queryEnv, EphemeralNamedRelation enr)
QueryEnvironment * create_queryEnv()

◆ SPI_register_trigger_data()

int SPI_register_trigger_data ( TriggerData tdata)

Definition at line 2934 of file spi.c.

References ENR_NAMED_TUPLESTORE, EphemeralNamedRelationMetadataData::enrtuples, EphemeralNamedRelationMetadataData::enrtype, EphemeralNamedRelationData::md, EphemeralNamedRelationMetadataData::name, palloc(), RelationData::rd_id, EphemeralNamedRelationData::reldata, EphemeralNamedRelationMetadataData::reliddesc, SPI_ERROR_ARGUMENT, SPI_OK_REL_REGISTER, SPI_OK_TD_REGISTER, SPI_register_relation(), TriggerData::tg_newtable, TriggerData::tg_oldtable, TriggerData::tg_relation, TriggerData::tg_trigger, Trigger::tgnewtable, Trigger::tgoldtable, EphemeralNamedRelationMetadataData::tupdesc, and tuplestore_tuple_count().

Referenced by plperl_trigger_handler(), plpgsql_exec_trigger(), pltcl_trigger_handler(), and PLy_exec_trigger().

2935 {
2936  if (tdata == NULL)
2937  return SPI_ERROR_ARGUMENT;
2938 
2939  if (tdata->tg_newtable)
2940  {
2943  int rc;
2944 
2945  enr->md.name = tdata->tg_trigger->tgnewtable;
2946  enr->md.reliddesc = tdata->tg_relation->rd_id;
2947  enr->md.tupdesc = NULL;
2950  enr->reldata = tdata->tg_newtable;
2951  rc = SPI_register_relation(enr);
2952  if (rc != SPI_OK_REL_REGISTER)
2953  return rc;
2954  }
2955 
2956  if (tdata->tg_oldtable)
2957  {
2960  int rc;
2961 
2962  enr->md.name = tdata->tg_trigger->tgoldtable;
2963  enr->md.reliddesc = tdata->tg_relation->rd_id;
2964  enr->md.tupdesc = NULL;
2967  enr->reldata = tdata->tg_oldtable;
2968  rc = SPI_register_relation(enr);
2969  if (rc != SPI_OK_REL_REGISTER)
2970  return rc;
2971  }
2972 
2973  return SPI_OK_TD_REGISTER;
2974 }
EphemeralNamedRelationMetadataData md
#define SPI_OK_REL_REGISTER
Definition: spi.h:67
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
#define SPI_OK_TD_REGISTER
Definition: spi.h:69
Oid rd_id
Definition: rel.h:85
char * tgnewtable
Definition: reltrigger.h:43
Trigger * tg_trigger
Definition: trigger.h:37
int64 tuplestore_tuple_count(Tuplestorestate *state)
Definition: tuplestore.c:546
Tuplestorestate * tg_oldtable
Definition: trigger.h:40
int SPI_register_relation(EphemeralNamedRelation enr)
Definition: spi.c:2867
void * palloc(Size size)
Definition: mcxt.c:949
Tuplestorestate * tg_newtable
Definition: trigger.h:41
EphemeralNameRelationType enrtype
char * tgoldtable
Definition: reltrigger.h:42
Relation tg_relation
Definition: trigger.h:34

◆ SPI_repalloc()

void* SPI_repalloc ( void *  pointer,
Size  size 
)

Definition at line 1123 of file spi.c.

References repalloc().

1124 {
1125  /* No longer need to worry which context chunk was in... */
1126  return repalloc(pointer, size);
1127 }
void * repalloc(void *pointer, Size size)
Definition: mcxt.c:1069

◆ SPI_result_code_string()

const char* SPI_result_code_string ( int  code)

Definition at line 1705 of file spi.c.

References buf, SPI_ERROR_ARGUMENT, SPI_ERROR_CONNECT, SPI_ERROR_COPY, SPI_ERROR_NOATTRIBUTE, SPI_ERROR_NOOUTFUNC, SPI_ERROR_OPUNKNOWN, SPI_ERROR_PARAM, SPI_ERROR_REL_DUPLICATE, SPI_ERROR_REL_NOT_FOUND, SPI_ERROR_TRANSACTION, SPI_ERROR_TYPUNKNOWN, SPI_ERROR_UNCONNECTED, SPI_OK_CONNECT, SPI_OK_CURSOR, SPI_OK_DELETE, SPI_OK_DELETE_RETURNING, SPI_OK_FETCH, SPI_OK_FINISH, SPI_OK_INSERT, SPI_OK_INSERT_RETURNING, SPI_OK_REL_REGISTER, SPI_OK_REL_UNREGISTER, SPI_OK_REWRITTEN, SPI_OK_SELECT, SPI_OK_SELINTO, SPI_OK_UPDATE, SPI_OK_UPDATE_RETURNING, SPI_OK_UTILITY, and sprintf.

Referenced by check_foreign_key(), check_primary_key(), exec_dynquery_with_params(), exec_prepare_plan(), exec_run_select(), exec_stmt_call(), exec_stmt_dynexecute(), exec_stmt_execsql(), exec_stmt_forc(), exec_stmt_open(), exec_stmt_set(), plperl_spi_execute_fetch_result(), plperl_spi_prepare(), plperl_spi_query(), plperl_spi_query_prepared(), plpgsql_call_handler(), plpgsql_inline_handler(), plpgsql_validator(), pltcl_process_SPI_result(), PLy_cursor_plan(), PLy_cursor_query(), PLy_spi_execute_plan(), PLy_spi_execute_query(), PLy_spi_prepare(), query_to_oid_list(), RI_Initial_Check(), RI_PartitionRemove_Check(), ri_PerformCheck(), ri_PlanCheck(), and ttdummy().

1706 {
1707  static char buf[64];
1708 
1709  switch (code)
1710  {
1711  case SPI_ERROR_CONNECT:
1712  return "SPI_ERROR_CONNECT";
1713  case SPI_ERROR_COPY:
1714  return "SPI_ERROR_COPY";
1715  case SPI_ERROR_OPUNKNOWN:
1716  return "SPI_ERROR_OPUNKNOWN";
1717  case SPI_ERROR_UNCONNECTED:
1718  return "SPI_ERROR_UNCONNECTED";
1719  case SPI_ERROR_ARGUMENT:
1720  return "SPI_ERROR_ARGUMENT";
1721  case SPI_ERROR_PARAM:
1722  return "SPI_ERROR_PARAM";
1723  case SPI_ERROR_TRANSACTION:
1724  return "SPI_ERROR_TRANSACTION";
1725  case SPI_ERROR_NOATTRIBUTE:
1726  return "SPI_ERROR_NOATTRIBUTE";
1727  case SPI_ERROR_NOOUTFUNC:
1728  return "SPI_ERROR_NOOUTFUNC";
1729  case SPI_ERROR_TYPUNKNOWN:
1730  return "SPI_ERROR_TYPUNKNOWN";
1732  return "SPI_ERROR_REL_DUPLICATE";
1734  return "SPI_ERROR_REL_NOT_FOUND";
1735  case SPI_OK_CONNECT:
1736  return "SPI_OK_CONNECT";
1737  case SPI_OK_FINISH:
1738  return "SPI_OK_FINISH";
1739  case SPI_OK_FETCH:
1740  return "SPI_OK_FETCH";
1741  case SPI_OK_UTILITY:
1742  return "SPI_OK_UTILITY";
1743  case SPI_OK_SELECT:
1744  return "SPI_OK_SELECT";
1745  case SPI_OK_SELINTO:
1746  return "SPI_OK_SELINTO";
1747  case SPI_OK_INSERT:
1748  return "SPI_OK_INSERT";
1749  case SPI_OK_DELETE:
1750  return "SPI_OK_DELETE";
1751  case SPI_OK_UPDATE:
1752  return "SPI_OK_UPDATE";
1753  case SPI_OK_CURSOR:
1754  return "SPI_OK_CURSOR";
1756  return "SPI_OK_INSERT_RETURNING";
1758  return "SPI_OK_DELETE_RETURNING";
1760  return "SPI_OK_UPDATE_RETURNING";
1761  case SPI_OK_REWRITTEN:
1762  return "SPI_OK_REWRITTEN";
1763  case SPI_OK_REL_REGISTER:
1764  return "SPI_OK_REL_REGISTER";
1765  case SPI_OK_REL_UNREGISTER:
1766  return "SPI_OK_REL_UNREGISTER";
1767  }
1768  /* Unrecognized code ... return something useful ... */
1769  sprintf(buf, "Unrecognized SPI code %d", code);
1770  return buf;
1771 }
#define SPI_OK_CONNECT
Definition: spi.h:53
#define SPI_ERROR_PARAM
Definition: spi.h:45
#define SPI_ERROR_REL_NOT_FOUND
Definition: spi.h:51
#define SPI_ERROR_REL_DUPLICATE
Definition: spi.h:50
#define SPI_ERROR_UNCONNECTED
Definition: spi.h:42
#define SPI_OK_DELETE_RETURNING
Definition: spi.h:64
#define SPI_OK_DELETE
Definition: spi.h:60
#define SPI_ERROR_COPY
Definition: spi.h:40
#define SPI_ERROR_OPUNKNOWN
Definition: spi.h:41
#define SPI_OK_REL_REGISTER
Definition: spi.h:67
#define SPI_ERROR_CONNECT
Definition: spi.h:39
#define SPI_OK_CURSOR
Definition: spi.h:62
#define sprintf
Definition: port.h:194
#define SPI_ERROR_NOOUTFUNC
Definition: spi.h:48
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
#define SPI_OK_INSERT_RETURNING
Definition: spi.h:63
static char * buf
Definition: pg_test_fsync.c:67
#define SPI_ERROR_NOATTRIBUTE
Definition: spi.h:47
#define SPI_OK_UTILITY
Definition: spi.h:56
#define SPI_OK_UPDATE_RETURNING
Definition: spi.h:65
#define SPI_OK_REWRITTEN
Definition: spi.h:66
#define SPI_ERROR_TRANSACTION
Definition: spi.h:46
#define SPI_OK_SELINTO
Definition: spi.h:58
#define SPI_OK_FETCH
Definition: spi.h:55
#define SPI_OK_SELECT
Definition: spi.h:57
#define SPI_OK_FINISH
Definition: spi.h:54
#define SPI_ERROR_TYPUNKNOWN
Definition: spi.h:49
#define SPI_OK_UPDATE
Definition: spi.h:61
#define SPI_OK_INSERT
Definition: spi.h:59
#define SPI_OK_REL_UNREGISTER
Definition: spi.h:68

◆ SPI_returntuple()

HeapTupleHeader SPI_returntuple ( HeapTuple  tuple,
TupleDesc  tupdesc 
)

Definition at line 850 of file spi.c.

References assign_record_type_typmod(), DatumGetHeapTupleHeader, heap_copy_tuple_as_datum(), MemoryContextSwitchTo(), _SPI_connection::savedcxt, SPI_ERROR_ARGUMENT, SPI_ERROR_UNCONNECTED, SPI_result, TupleDescData::tdtypeid, and TupleDescData::tdtypmod.

Referenced by coerce_function_result_tuple().

851 {
852  MemoryContext oldcxt;
853  HeapTupleHeader dtup;
854 
855  if (tuple == NULL || tupdesc == NULL)
856  {
858  return NULL;
859  }
860 
861  if (_SPI_current == NULL)
862  {
864  return NULL;
865  }
866 
867  /* For RECORD results, make sure a typmod has been assigned */
868  if (tupdesc->tdtypeid == RECORDOID &&
869  tupdesc->tdtypmod < 0)
870  assign_record_type_typmod(tupdesc);
871 
873 
874  dtup = DatumGetHeapTupleHeader(heap_copy_tuple_as_datum(tuple, tupdesc));
875 
876  MemoryContextSwitchTo(oldcxt);
877 
878  return dtup;
879 }
#define SPI_ERROR_UNCONNECTED
Definition: spi.h:42
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
static _SPI_connection * _SPI_current
Definition: spi.c:50
#define DatumGetHeapTupleHeader(X)
Definition: fmgr.h:289
void assign_record_type_typmod(TupleDesc tupDesc)
Definition: typcache.c:1772
int SPI_result
Definition: spi.c:47
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
int32 tdtypmod
Definition: tupdesc.h:83
MemoryContext savedcxt
Definition: spi_priv.h:35
Datum heap_copy_tuple_as_datum(HeapTuple tuple, TupleDesc tupleDesc)
Definition: heaptuple.c:984
Oid tdtypeid
Definition: tupdesc.h:82

◆ SPI_rollback()

void SPI_rollback ( void  )

Definition at line 333 of file spi.c.

References _SPI_rollback().

Referenced by exec_stmt_rollback(), plperl_spi_rollback(), pltcl_rollback(), and PLy_rollback().

334 {
335  _SPI_rollback(false);
336 }
static void _SPI_rollback(bool chain)
Definition: spi.c:290

◆ SPI_rollback_and_chain()

void SPI_rollback_and_chain ( void  )

Definition at line 339 of file spi.c.

References _SPI_rollback().

Referenced by exec_stmt_rollback().

340 {
341  _SPI_rollback(true);
342 }
static void _SPI_rollback(bool chain)
Definition: spi.c:290

◆ SPI_saveplan()

SPIPlanPtr SPI_saveplan ( SPIPlanPtr  plan)

Definition at line 779 of file spi.c.

References _SPI_begin_call(), _SPI_end_call(), _SPI_PLAN_MAGIC, _SPI_save_plan(), _SPI_plan::magic, SPI_ERROR_ARGUMENT, and SPI_result.

780 {
781  SPIPlanPtr newplan;
782 
783  if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC)
784  {
786  return NULL;
787  }
788 
789  SPI_result = _SPI_begin_call(false); /* don't change context */
790  if (SPI_result < 0)
791  return NULL;
792 
793  newplan = _SPI_save_plan(plan);
794 
795  SPI_result = _SPI_end_call(false);
796 
797  return newplan;
798 }
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20
int magic
Definition: spi_priv.h:92
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:2649
int SPI_result
Definition: spi.c:47
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
static SPIPlanPtr _SPI_save_plan(SPIPlanPtr plan)
Definition: spi.c:2780
static int _SPI_end_call(bool use_exec)
Definition: spi.c:2673

◆ SPI_scroll_cursor_fetch()

void SPI_scroll_cursor_fetch ( Portal  ,
FetchDirection  direction,
long  count 
)

Definition at line 1568 of file spi.c.

References _SPI_cursor_operation(), CreateDestReceiver(), and DestSPI.

Referenced by exec_stmt_fetch().

1569 {
1570  _SPI_cursor_operation(portal,
1571  direction, count,
1573  /* we know that the DestSPI receiver doesn't need a destroy call */
1574 }
Definition: dest.h:93
DestReceiver * CreateDestReceiver(CommandDest dest)
Definition: dest.c:113
static void _SPI_cursor_operation(Portal portal, FetchDirection direction, long count, DestReceiver *dest)
Definition: spi.c:2579

◆ SPI_scroll_cursor_move()

void SPI_scroll_cursor_move ( Portal  ,
FetchDirection  direction,
long  count 
)

Definition at line 1583 of file spi.c.

References _SPI_cursor_operation(), and None_Receiver.

Referenced by exec_stmt_fetch().

1584 {
1585  _SPI_cursor_operation(portal, direction, count, None_Receiver);
1586 }
DestReceiver * None_Receiver
Definition: dest.c:96
static void _SPI_cursor_operation(Portal portal, FetchDirection direction, long count, DestReceiver *dest)
Definition: spi.c:2579

◆ SPI_start_transaction()

void SPI_start_transaction ( void  )

Definition at line 212 of file spi.c.

References CurrentMemoryContext, MemoryContextSwitchTo(), and StartTransactionCommand().

Referenced by exec_stmt_commit(), exec_stmt_rollback(), plperl_spi_commit(), plperl_spi_rollback(), pltcl_commit(), pltcl_rollback(), PLy_commit(), and PLy_rollback().

213 {
214  MemoryContext oldcontext = CurrentMemoryContext;
215 
217  MemoryContextSwitchTo(oldcontext);
218 }
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
void StartTransactionCommand(void)
Definition: xact.c:2796

◆ SPI_unregister_relation()

int SPI_unregister_relation ( const char *  name)

Definition at line 2901 of file spi.c.

References _SPI_begin_call(), _SPI_end_call(), _SPI_find_ENR_by_name(), EphemeralNamedRelationData::md, EphemeralNamedRelationMetadataData::name, _SPI_connection::queryEnv, SPI_ERROR_ARGUMENT, SPI_ERROR_REL_NOT_FOUND, SPI_OK_REL_UNREGISTER, and unregister_ENR().

2902 {
2903  EphemeralNamedRelation match;
2904  int res;
2905 
2906  if (name == NULL)
2907  return SPI_ERROR_ARGUMENT;
2908 
2909  res = _SPI_begin_call(false); /* keep current memory context */
2910  if (res < 0)
2911  return res;
2912 
2913  match = _SPI_find_ENR_by_name(name);
2914  if (match)
2915  {
2917  res = SPI_OK_REL_UNREGISTER;
2918  }
2919  else
2921 
2922  _SPI_end_call(false);
2923 
2924  return res;
2925 }
EphemeralNamedRelationMetadataData md
#define SPI_ERROR_REL_NOT_FOUND
Definition: spi.h:51
static EphemeralNamedRelation _SPI_find_ENR_by_name(const char *name)
Definition: spi.c:2850
static _SPI_connection * _SPI_current
Definition: spi.c:50
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:2649
#define SPI_ERROR_ARGUMENT
Definition: spi.h:44
QueryEnvironment * queryEnv
Definition: spi_priv.h:37
void unregister_ENR(QueryEnvironment *queryEnv, const char *name)
static int _SPI_end_call(bool use_exec)
Definition: spi.c:2673
const char * name
Definition: encode.c:521
#define SPI_OK_REL_UNREGISTER
Definition: spi.h:68

◆ SPICleanup()

void SPICleanup ( void  )

Definition at line 349 of file spi.c.

References _SPI_connected, SPI_processed, and SPI_result.

Referenced by AtEOXact_SPI(), and PostgresMain().

350 {
351  _SPI_current = NULL;
352  _SPI_connected = -1;
353  /* Reset API global variables, too */
354  SPI_processed = 0;
355  SPI_tuptable = NULL;
356  SPI_result = 0;
357 }
SPITupleTable * SPI_tuptable
Definition: spi.c:46
static int _SPI_connected
Definition: spi.c:52
static _SPI_connection * _SPI_current
Definition: spi.c:50
uint64 SPI_processed
Definition: spi.c:45
int SPI_result
Definition: spi.c:47

Variable Documentation

◆ SPI_processed

◆ SPI_result

◆ SPI_tuptable