PostgreSQL Source Code git master
spi.h File Reference
#include "commands/trigger.h"
#include "lib/ilist.h"
#include "parser/parser.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
 
struct  SPIPrepareOptions
 
struct  SPIExecuteOptions
 
struct  SPIParseOpenOptions
 

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_OK_MERGE   18
 
#define SPI_OK_MERGE_RETURNING   19
 
#define SPI_OPT_NONATOMIC   (1 << 0)
 

Typedefs

typedef struct SPITupleTable SPITupleTable
 
typedef struct SPIPrepareOptions SPIPrepareOptions
 
typedef struct SPIExecuteOptions SPIExecuteOptions
 
typedef struct SPIParseOpenOptions SPIParseOpenOptions
 
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_extended (const char *src, const SPIExecuteOptions *options)
 
int SPI_execute_plan (SPIPlanPtr plan, Datum *Values, const char *Nulls, bool read_only, long tcount)
 
int SPI_execute_plan_extended (SPIPlanPtr plan, const SPIExecuteOptions *options)
 
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_extended (const char *src, const SPIPrepareOptions *options)
 
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 tuple)
 
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_parse_open (const char *name, const char *src, const SPIParseOpenOptions *options)
 
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 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

#define SPI_ERROR_ARGUMENT   (-6)

Definition at line 73 of file spi.h.

◆ SPI_ERROR_CONNECT

#define SPI_ERROR_CONNECT   (-1)

Definition at line 68 of file spi.h.

◆ SPI_ERROR_COPY

#define SPI_ERROR_COPY   (-2)

Definition at line 69 of file spi.h.

◆ SPI_ERROR_CURSOR

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

Definition at line 72 of file spi.h.

◆ SPI_ERROR_NOATTRIBUTE

#define SPI_ERROR_NOATTRIBUTE   (-9)

Definition at line 76 of file spi.h.

◆ SPI_ERROR_NOOUTFUNC

#define SPI_ERROR_NOOUTFUNC   (-10)

Definition at line 77 of file spi.h.

◆ SPI_ERROR_OPUNKNOWN

#define SPI_ERROR_OPUNKNOWN   (-3)

Definition at line 70 of file spi.h.

◆ SPI_ERROR_PARAM

#define SPI_ERROR_PARAM   (-7)

Definition at line 74 of file spi.h.

◆ SPI_ERROR_REL_DUPLICATE

#define SPI_ERROR_REL_DUPLICATE   (-12)

Definition at line 79 of file spi.h.

◆ SPI_ERROR_REL_NOT_FOUND

#define SPI_ERROR_REL_NOT_FOUND   (-13)

Definition at line 80 of file spi.h.

◆ SPI_ERROR_TRANSACTION

#define SPI_ERROR_TRANSACTION   (-8)

Definition at line 75 of file spi.h.

◆ SPI_ERROR_TYPUNKNOWN

#define SPI_ERROR_TYPUNKNOWN   (-11)

Definition at line 78 of file spi.h.

◆ SPI_ERROR_UNCONNECTED

#define SPI_ERROR_UNCONNECTED   (-4)

Definition at line 71 of file spi.h.

◆ SPI_OK_CONNECT

#define SPI_OK_CONNECT   1

Definition at line 82 of file spi.h.

◆ SPI_OK_CURSOR

#define SPI_OK_CURSOR   10

Definition at line 91 of file spi.h.

◆ SPI_OK_DELETE

#define SPI_OK_DELETE   8

Definition at line 89 of file spi.h.

◆ SPI_OK_DELETE_RETURNING

#define SPI_OK_DELETE_RETURNING   12

Definition at line 93 of file spi.h.

◆ SPI_OK_FETCH

#define SPI_OK_FETCH   3

Definition at line 84 of file spi.h.

◆ SPI_OK_FINISH

#define SPI_OK_FINISH   2

Definition at line 83 of file spi.h.

◆ SPI_OK_INSERT

#define SPI_OK_INSERT   7

Definition at line 88 of file spi.h.

◆ SPI_OK_INSERT_RETURNING

#define SPI_OK_INSERT_RETURNING   11

Definition at line 92 of file spi.h.

◆ SPI_OK_MERGE

#define SPI_OK_MERGE   18

Definition at line 99 of file spi.h.

◆ SPI_OK_MERGE_RETURNING

#define SPI_OK_MERGE_RETURNING   19

Definition at line 100 of file spi.h.

◆ SPI_OK_REL_REGISTER

#define SPI_OK_REL_REGISTER   15

Definition at line 96 of file spi.h.

◆ SPI_OK_REL_UNREGISTER

#define SPI_OK_REL_UNREGISTER   16

Definition at line 97 of file spi.h.

◆ SPI_OK_REWRITTEN

#define SPI_OK_REWRITTEN   14

Definition at line 95 of file spi.h.

◆ SPI_OK_SELECT

#define SPI_OK_SELECT   5

Definition at line 86 of file spi.h.

◆ SPI_OK_SELINTO

#define SPI_OK_SELINTO   6

Definition at line 87 of file spi.h.

◆ SPI_OK_TD_REGISTER

#define SPI_OK_TD_REGISTER   17

Definition at line 98 of file spi.h.

◆ SPI_OK_UPDATE

#define SPI_OK_UPDATE   9

Definition at line 90 of file spi.h.

◆ SPI_OK_UPDATE_RETURNING

#define SPI_OK_UPDATE_RETURNING   13

Definition at line 94 of file spi.h.

◆ SPI_OK_UTILITY

#define SPI_OK_UTILITY   4

Definition at line 85 of file spi.h.

◆ SPI_OPT_NONATOMIC

#define SPI_OPT_NONATOMIC   (1 << 0)

Definition at line 102 of file spi.h.

Typedef Documentation

◆ SPIExecuteOptions

◆ SPIParseOpenOptions

◆ SPIPlanPtr

typedef struct _SPI_plan* SPIPlanPtr

Definition at line 66 of file spi.h.

◆ SPIPrepareOptions

◆ SPITupleTable

typedef struct SPITupleTable SPITupleTable

Function Documentation

◆ AtEOSubXact_SPI()

void AtEOSubXact_SPI ( bool  isCommit,
SubTransactionId  mySubid 
)

Definition at line 483 of file spi.c.

484{
485 bool found = false;
486
487 while (_SPI_connected >= 0)
488 {
490
491 if (connection->connectSubid != mySubid)
492 break; /* couldn't be any underneath it either */
493
494 if (connection->internal_xact)
495 break;
496
497 found = true;
498
499 /*
500 * Release procedure memory explicitly (see note in SPI_connect)
501 */
502 if (connection->execCxt)
503 {
505 connection->execCxt = NULL;
506 }
507 if (connection->procCxt)
508 {
510 connection->procCxt = NULL;
511 }
512
513 /*
514 * Restore outer global variables and pop the stack entry. Unlike
515 * SPI_finish(), we don't risk switching to memory contexts that might
516 * be already gone.
517 */
518 SPI_processed = connection->outer_processed;
519 SPI_tuptable = connection->outer_tuptable;
520 SPI_result = connection->outer_result;
521
523 if (_SPI_connected < 0)
524 _SPI_current = NULL;
525 else
527 }
528
529 if (found && isCommit)
531 (errcode(ERRCODE_WARNING),
532 errmsg("subtransaction left non-empty SPI stack"),
533 errhint("Check for missing \"SPI_finish\" calls.")));
534
535 /*
536 * If we are aborting a subtransaction and there is an open SPI context
537 * surrounding the subxact, clean up to prevent memory leakage.
538 */
539 if (_SPI_current && !isCommit)
540 {
541 slist_mutable_iter siter;
542
543 /*
544 * Throw away executor state if current executor operation was started
545 * within current subxact (essentially, force a _SPI_end_call(true)).
546 */
547 if (_SPI_current->execSubid >= mySubid)
548 {
551 }
552
553 /* throw away any tuple tables created within current subxact */
555 {
556 SPITupleTable *tuptable;
557
558 tuptable = slist_container(SPITupleTable, next, siter.cur);
559 if (tuptable->subid >= mySubid)
560 {
561 /*
562 * If we used SPI_freetuptable() here, its internal search of
563 * the tuptables list would make this operation O(N^2).
564 * Instead, just free the tuptable manually. This should
565 * match what SPI_freetuptable() does.
566 */
567 slist_delete_current(&siter);
568 if (tuptable == _SPI_current->tuptable)
569 _SPI_current->tuptable = NULL;
570 if (tuptable == SPI_tuptable)
571 SPI_tuptable = NULL;
573 }
574 }
575 }
576}
static int32 next
Definition: blutils.c:224
#define InvalidSubTransactionId
Definition: c.h:629
int errhint(const char *fmt,...)
Definition: elog.c:1317
int errcode(int sqlerrcode)
Definition: elog.c:853
int errmsg(const char *fmt,...)
Definition: elog.c:1070
#define WARNING
Definition: elog.h:36
#define ereport(elevel,...)
Definition: elog.h:149
static void slist_delete_current(slist_mutable_iter *iter)
Definition: ilist.h:1084
#define slist_foreach_modify(iter, lhead)
Definition: ilist.h:1148
#define slist_container(type, membername, ptr)
Definition: ilist.h:1106
void MemoryContextReset(MemoryContext context)
Definition: mcxt.c:383
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:454
static int _SPI_connected
Definition: spi.c:51
uint64 SPI_processed
Definition: spi.c:44
static _SPI_connection * _SPI_stack
Definition: spi.c:48
SPITupleTable * SPI_tuptable
Definition: spi.c:45
int SPI_result
Definition: spi.c:46
static _SPI_connection * _SPI_current
Definition: spi.c:49
MemoryContext tuptabcxt
Definition: spi.h:31
SubTransactionId subid
Definition: spi.h:33
slist_head tuptables
Definition: spi_priv.h:32
MemoryContext execCxt
Definition: spi_priv.h:34
SubTransactionId execSubid
Definition: spi_priv.h:29
SPITupleTable * tuptable
Definition: spi_priv.h:26
slist_node * cur
Definition: ilist.h:274

References _SPI_connected, _SPI_current, _SPI_stack, slist_mutable_iter::cur, ereport, errcode(), errhint(), errmsg(), _SPI_connection::execCxt, _SPI_connection::execSubid, InvalidSubTransactionId, MemoryContextDelete(), MemoryContextReset(), next, slist_container, slist_delete_current(), slist_foreach_modify, SPI_processed, SPI_result, SPI_tuptable, SPITupleTable::subid, SPITupleTable::tuptabcxt, _SPI_connection::tuptable, _SPI_connection::tuptables, and WARNING.

Referenced by AbortSubTransaction(), and CommitSubTransaction().

◆ AtEOXact_SPI()

void AtEOXact_SPI ( bool  isCommit)

Definition at line 429 of file spi.c.

430{
431 bool found = false;
432
433 /*
434 * Pop stack entries, stopping if we find one marked internal_xact (that
435 * one belongs to the caller of SPI_commit or SPI_rollback).
436 */
437 while (_SPI_connected >= 0)
438 {
440
441 if (connection->internal_xact)
442 break;
443
444 found = true;
445
446 /*
447 * We need not release the procedure's memory contexts explicitly, as
448 * they'll go away automatically when their parent context does; see
449 * notes in SPI_connect_ext.
450 */
451
452 /*
453 * Restore outer global variables and pop the stack entry. Unlike
454 * SPI_finish(), we don't risk switching to memory contexts that might
455 * be already gone.
456 */
457 SPI_processed = connection->outer_processed;
458 SPI_tuptable = connection->outer_tuptable;
459 SPI_result = connection->outer_result;
460
462 if (_SPI_connected < 0)
463 _SPI_current = NULL;
464 else
466 }
467
468 /* We should only find entries to pop during an ABORT. */
469 if (found && isCommit)
471 (errcode(ERRCODE_WARNING),
472 errmsg("transaction left non-empty SPI stack"),
473 errhint("Check for missing \"SPI_finish\" calls.")));
474}

References _SPI_connected, _SPI_current, _SPI_stack, ereport, errcode(), errhint(), errmsg(), SPI_processed, SPI_result, SPI_tuptable, and WARNING.

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

◆ SPI_commit()

void SPI_commit ( void  )

Definition at line 321 of file spi.c.

322{
323 _SPI_commit(false);
324}
static void _SPI_commit(bool chain)
Definition: spi.c:228

References _SPI_commit().

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

◆ SPI_commit_and_chain()

void SPI_commit_and_chain ( void  )

Definition at line 327 of file spi.c.

328{
329 _SPI_commit(true);
330}

References _SPI_commit().

Referenced by exec_stmt_commit().

◆ SPI_connect()

◆ SPI_connect_ext()

int SPI_connect_ext ( int  options)

Definition at line 101 of file spi.c.

102{
103 int newdepth;
104
105 /* Enlarge stack if necessary */
106 if (_SPI_stack == NULL)
107 {
108 if (_SPI_connected != -1 || _SPI_stack_depth != 0)
109 elog(ERROR, "SPI stack corrupted");
110 newdepth = 16;
113 newdepth * sizeof(_SPI_connection));
114 _SPI_stack_depth = newdepth;
115 }
116 else
117 {
119 elog(ERROR, "SPI stack corrupted");
121 {
122 newdepth = _SPI_stack_depth * 2;
125 newdepth * sizeof(_SPI_connection));
126 _SPI_stack_depth = newdepth;
127 }
128 }
129
130 /* Enter new stack level */
133
136 _SPI_current->tuptable = NULL;
139 _SPI_current->procCxt = NULL; /* in case we fail to create 'em */
140 _SPI_current->execCxt = NULL;
142 _SPI_current->queryEnv = NULL;
148
149 /*
150 * Create memory contexts for this procedure
151 *
152 * In atomic contexts (the normal case), we use TopTransactionContext,
153 * otherwise PortalContext, so that it lives across transaction
154 * boundaries.
155 *
156 * XXX It could be better to use PortalContext as the parent context in
157 * all cases, but we may not be inside a portal (consider deferred-trigger
158 * execution). Perhaps CurTransactionContext could be an option? For now
159 * it doesn't matter because we clean up explicitly in AtEOSubXact_SPI();
160 * but see also AtEOXact_SPI().
161 */
163 "SPI Proc",
166 "SPI Exec",
168 /* ... and switch to procedure's context */
170
171 /*
172 * Reset API global variables so that current caller cannot accidentally
173 * depend on state of an outer caller.
174 */
175 SPI_processed = 0;
176 SPI_tuptable = NULL;
177 SPI_result = 0;
178
179 return SPI_OK_CONNECT;
180}
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:225
Assert(PointerIsAligned(start, uint64))
static void slist_init(slist_head *head)
Definition: ilist.h:986
return false
Definition: isn.c:132
void * MemoryContextAlloc(MemoryContext context, Size size)
Definition: mcxt.c:1181
MemoryContext TopTransactionContext
Definition: mcxt.c:154
void * repalloc(void *pointer, Size size)
Definition: mcxt.c:1544
MemoryContext TopMemoryContext
Definition: mcxt.c:149
MemoryContext PortalContext
Definition: mcxt.c:158
#define AllocSetContextCreate
Definition: memutils.h:129
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:160
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:124
static int _SPI_stack_depth
Definition: spi.c:50
#define SPI_OPT_NONATOMIC
Definition: spi.h:102
#define SPI_OK_CONNECT
Definition: spi.h:82
SubTransactionId connectSubid
Definition: spi_priv.h:36
uint64 processed
Definition: spi_priv.h:25
SPITupleTable * outer_tuptable
Definition: spi_priv.h:47
QueryEnvironment * queryEnv
Definition: spi_priv.h:37
int outer_result
Definition: spi_priv.h:48
uint64 outer_processed
Definition: spi_priv.h:46
MemoryContext procCxt
Definition: spi_priv.h:33
bool internal_xact
Definition: spi_priv.h:42
MemoryContext savedcxt
Definition: spi_priv.h:35
SubTransactionId GetCurrentSubTransactionId(void)
Definition: xact.c:791

References _SPI_connected, _SPI_current, _SPI_stack, _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(), plpython3_call_handler(), plpython3_inline_handler(), pltcl_func_handler(), and SPI_connect().

◆ SPI_copytuple()

HeapTuple SPI_copytuple ( HeapTuple  tuple)

Definition at line 1048 of file spi.c.

1049{
1050 MemoryContext oldcxt;
1051 HeapTuple ctuple;
1052
1053 if (tuple == NULL)
1054 {
1056 return NULL;
1057 }
1058
1059 if (_SPI_current == NULL)
1060 {
1062 return NULL;
1063 }
1064
1066
1067 ctuple = heap_copytuple(tuple);
1068
1069 MemoryContextSwitchTo(oldcxt);
1070
1071 return ctuple;
1072}
HeapTuple heap_copytuple(HeapTuple tuple)
Definition: heaptuple.c:778
#define SPI_ERROR_UNCONNECTED
Definition: spi.h:71
#define SPI_ERROR_ARGUMENT
Definition: spi.h:73

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

◆ SPI_cursor_close()

void SPI_cursor_close ( Portal  portal)

Definition at line 1864 of file spi.c.

1865{
1866 if (!PortalIsValid(portal))
1867 elog(ERROR, "invalid portal in SPI cursor operation");
1868
1869 PortalDrop(portal, false);
1870}
#define PortalIsValid(p)
Definition: portal.h:212
void PortalDrop(Portal portal, bool isTopCommit)
Definition: portalmem.c:470

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

Referenced by exec_stmt_close(), exec_stmt_dynfors(), exec_stmt_forc(), exec_stmt_fors(), 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().

◆ SPI_cursor_fetch()

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

Definition at line 1808 of file spi.c.

1809{
1810 _SPI_cursor_operation(portal,
1811 forward ? FETCH_FORWARD : FETCH_BACKWARD, count,
1813 /* we know that the DestSPI receiver doesn't need a destroy call */
1814}
DestReceiver * CreateDestReceiver(CommandDest dest)
Definition: dest.c:113
@ DestSPI
Definition: dest.h:92
@ FETCH_FORWARD
Definition: parsenodes.h:3406
@ FETCH_BACKWARD
Definition: parsenodes.h:3407
static void _SPI_cursor_operation(Portal portal, FetchDirection direction, long count, DestReceiver *dest)
Definition: spi.c:3024

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

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

◆ SPI_cursor_find()

Portal SPI_cursor_find ( const char *  name)

Definition at line 1796 of file spi.c.

1797{
1798 return GetPortalByName(name);
1799}
Portal GetPortalByName(const char *name)
Definition: portalmem.c:130
const char * name

References GetPortalByName(), and name.

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

◆ SPI_cursor_move()

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

Definition at line 1823 of file spi.c.

1824{
1825 _SPI_cursor_operation(portal,
1826 forward ? FETCH_FORWARD : FETCH_BACKWARD, count,
1828}
DestReceiver * None_Receiver
Definition: dest.c:96

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

◆ SPI_cursor_open()

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

Definition at line 1446 of file spi.c.

1449{
1450 Portal portal;
1451 ParamListInfo paramLI;
1452
1453 /* build transient ParamListInfo in caller's context */
1454 paramLI = _SPI_convert_params(plan->nargs, plan->argtypes,
1455 Values, Nulls);
1456
1457 portal = SPI_cursor_open_internal(name, plan, paramLI, read_only);
1458
1459 /* done with the transient ParamListInfo */
1460 if (paramLI)
1461 pfree(paramLI);
1462
1463 return portal;
1464}
static bool Nulls[MAXATTR]
Definition: bootstrap.c:152
void pfree(void *pointer)
Definition: mcxt.c:1524
#define plan(x)
Definition: pg_regress.c:161
static ParamListInfo _SPI_convert_params(int nargs, Oid *argtypes, Datum *Values, const char *Nulls)
Definition: spi.c:2856
static Portal SPI_cursor_open_internal(const char *name, SPIPlanPtr plan, ParamListInfo paramLI, bool read_only)
Definition: spi.c:1578

References _SPI_convert_params(), name, Nulls, pfree(), plan, 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().

◆ 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 1473 of file spi.c.

1478{
1479 Portal result;
1481 ParamListInfo paramLI;
1482
1483 if (src == NULL || nargs < 0)
1484 elog(ERROR, "SPI_cursor_open_with_args called with invalid arguments");
1485
1486 if (nargs > 0 && (argtypes == NULL || Values == NULL))
1487 elog(ERROR, "SPI_cursor_open_with_args called with missing parameters");
1488
1490 if (SPI_result < 0)
1491 elog(ERROR, "SPI_cursor_open_with_args called while not connected");
1492
1493 memset(&plan, 0, sizeof(_SPI_plan));
1494 plan.magic = _SPI_PLAN_MAGIC;
1495 plan.parse_mode = RAW_PARSE_DEFAULT;
1496 plan.cursor_options = cursorOptions;
1497 plan.nargs = nargs;
1498 plan.argtypes = argtypes;
1499 plan.parserSetup = NULL;
1500 plan.parserSetupArg = NULL;
1501
1502 /* build transient ParamListInfo in executor context */
1503 paramLI = _SPI_convert_params(nargs, argtypes,
1504 Values, Nulls);
1505
1506 _SPI_prepare_plan(src, &plan);
1507
1508 /* We needn't copy the plan; SPI_cursor_open_internal will do so */
1509
1510 result = SPI_cursor_open_internal(name, &plan, paramLI, read_only);
1511
1512 /* And clean up */
1513 _SPI_end_call(true);
1514
1515 return result;
1516}
@ RAW_PARSE_DEFAULT
Definition: parser.h:39
static int _SPI_end_call(bool use_exec)
Definition: spi.c:3118
static void _SPI_prepare_plan(const char *src, SPIPlanPtr plan)
Definition: spi.c:2223
static int _SPI_begin_call(bool use_exec)
Definition: spi.c:3094
#define _SPI_PLAN_MAGIC
Definition: spi_priv.h:20

References _SPI_begin_call(), _SPI_convert_params(), _SPI_end_call(), _SPI_PLAN_MAGIC, _SPI_prepare_plan(), elog, ERROR, name, Nulls, plan, RAW_PARSE_DEFAULT, SPI_cursor_open_internal(), and SPI_result.

◆ SPI_cursor_open_with_paramlist()

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

Definition at line 1526 of file spi.c.

1528{
1529 return SPI_cursor_open_internal(name, plan, params, read_only);
1530}

References name, plan, and SPI_cursor_open_internal().

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

◆ SPI_cursor_parse_open()

Portal SPI_cursor_parse_open ( const char *  name,
const char *  src,
const SPIParseOpenOptions options 
)

Definition at line 1534 of file spi.c.

1537{
1538 Portal result;
1540
1541 if (src == NULL || options == NULL)
1542 elog(ERROR, "SPI_cursor_parse_open called with invalid arguments");
1543
1545 if (SPI_result < 0)
1546 elog(ERROR, "SPI_cursor_parse_open called while not connected");
1547
1548 memset(&plan, 0, sizeof(_SPI_plan));
1549 plan.magic = _SPI_PLAN_MAGIC;
1550 plan.parse_mode = RAW_PARSE_DEFAULT;
1551 plan.cursor_options = options->cursorOptions;
1552 if (options->params)
1553 {
1554 plan.parserSetup = options->params->parserSetup;
1555 plan.parserSetupArg = options->params->parserSetupArg;
1556 }
1557
1558 _SPI_prepare_plan(src, &plan);
1559
1560 /* We needn't copy the plan; SPI_cursor_open_internal will do so */
1561
1563 options->params, options->read_only);
1564
1565 /* And clean up */
1566 _SPI_end_call(true);
1567
1568 return result;
1569}

References _SPI_begin_call(), _SPI_end_call(), _SPI_PLAN_MAGIC, _SPI_prepare_plan(), elog, ERROR, name, plan, RAW_PARSE_DEFAULT, SPI_cursor_open_internal(), and SPI_result.

Referenced by exec_dynquery_with_params().

◆ SPI_datumTransfer()

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

Definition at line 1362 of file spi.c.

1363{
1364 MemoryContext oldcxt;
1365 Datum result;
1366
1367 if (_SPI_current == NULL)
1368 elog(ERROR, "SPI_datumTransfer called while not connected to SPI");
1369
1371
1372 result = datumTransfer(value, typByVal, typLen);
1373
1374 MemoryContextSwitchTo(oldcxt);
1375
1376 return result;
1377}
Datum datumTransfer(Datum value, bool typByVal, int typLen)
Definition: datum.c:194
static struct @165 value
uintptr_t Datum
Definition: postgres.h:69

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

Referenced by coerce_function_result_tuple(), and plpgsql_exec_function().

◆ SPI_exec()

int SPI_exec ( const char *  src,
long  tcount 
)

Definition at line 631 of file spi.c.

632{
633 return SPI_execute(src, false, tcount);
634}
int SPI_execute(const char *src, bool read_only, long tcount)
Definition: spi.c:597

References SPI_execute().

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

◆ SPI_execp()

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

Definition at line 705 of file spi.c.

706{
707 return SPI_execute_plan(plan, Values, Nulls, false, tcount);
708}
int SPI_execute_plan(SPIPlanPtr plan, Datum *Values, const char *Nulls, bool read_only, long tcount)
Definition: spi.c:673

References Nulls, plan, and SPI_execute_plan().

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

◆ SPI_execute()

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

Definition at line 597 of file spi.c.

598{
601 int res;
602
603 if (src == NULL || tcount < 0)
604 return SPI_ERROR_ARGUMENT;
605
606 res = _SPI_begin_call(true);
607 if (res < 0)
608 return res;
609
610 memset(&plan, 0, sizeof(_SPI_plan));
611 plan.magic = _SPI_PLAN_MAGIC;
612 plan.parse_mode = RAW_PARSE_DEFAULT;
613 plan.cursor_options = CURSOR_OPT_PARALLEL_OK;
614
616
617 memset(&options, 0, sizeof(options));
618 options.read_only = read_only;
619 options.tcount = tcount;
620
623 true);
624
625 _SPI_end_call(true);
626 return res;
627}
#define CURSOR_OPT_PARALLEL_OK
Definition: parsenodes.h:3378
static char ** options
#define InvalidSnapshot
Definition: snapshot.h:119
static int _SPI_execute_plan(SPIPlanPtr plan, const SPIExecuteOptions *options, Snapshot snapshot, Snapshot crosscheck_snapshot, bool fire_triggers)
Definition: spi.c:2401
static void _SPI_prepare_oneshot_plan(const char *src, SPIPlanPtr plan)
Definition: spi.c:2331

References _SPI_begin_call(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, _SPI_prepare_oneshot_plan(), CURSOR_OPT_PARALLEL_OK, InvalidSnapshot, options, plan, RAW_PARSE_DEFAULT, and SPI_ERROR_ARGUMENT.

Referenced by build_tuplestore_recursively(), crosstab(), 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(), SPI_exec(), and worker_spi_main().

◆ SPI_execute_extended()

int SPI_execute_extended ( const char *  src,
const SPIExecuteOptions options 
)

Definition at line 638 of file spi.c.

640{
641 int res;
643
644 if (src == NULL || options == NULL)
645 return SPI_ERROR_ARGUMENT;
646
647 res = _SPI_begin_call(true);
648 if (res < 0)
649 return res;
650
651 memset(&plan, 0, sizeof(_SPI_plan));
652 plan.magic = _SPI_PLAN_MAGIC;
653 plan.parse_mode = RAW_PARSE_DEFAULT;
654 plan.cursor_options = CURSOR_OPT_PARALLEL_OK;
655 if (options->params)
656 {
657 plan.parserSetup = options->params->parserSetup;
658 plan.parserSetupArg = options->params->parserSetupArg;
659 }
660
662
665 true);
666
667 _SPI_end_call(true);
668 return res;
669}

References _SPI_begin_call(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, _SPI_prepare_oneshot_plan(), CURSOR_OPT_PARALLEL_OK, InvalidSnapshot, plan, RAW_PARSE_DEFAULT, and SPI_ERROR_ARGUMENT.

Referenced by exec_stmt_dynexecute(), and exec_stmt_return_query().

◆ SPI_execute_plan()

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

Definition at line 673 of file spi.c.

675{
677 int res;
678
679 if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC || tcount < 0)
680 return SPI_ERROR_ARGUMENT;
681
682 if (plan->nargs > 0 && Values == NULL)
683 return SPI_ERROR_PARAM;
684
685 res = _SPI_begin_call(true);
686 if (res < 0)
687 return res;
688
689 memset(&options, 0, sizeof(options));
690 options.params = _SPI_convert_params(plan->nargs, plan->argtypes,
691 Values, Nulls);
692 options.read_only = read_only;
693 options.tcount = tcount;
694
697 true);
698
699 _SPI_end_call(true);
700 return res;
701}
#define SPI_ERROR_PARAM
Definition: spi.h:74

References _SPI_begin_call(), _SPI_convert_params(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, InvalidSnapshot, Nulls, options, plan, SPI_ERROR_ARGUMENT, and SPI_ERROR_PARAM.

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

◆ SPI_execute_plan_extended()

int SPI_execute_plan_extended ( SPIPlanPtr  plan,
const SPIExecuteOptions options 
)

Definition at line 712 of file spi.c.

714{
715 int res;
716
717 if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC || options == NULL)
718 return SPI_ERROR_ARGUMENT;
719
720 res = _SPI_begin_call(true);
721 if (res < 0)
722 return res;
723
726 true);
727
728 _SPI_end_call(true);
729 return res;
730}

References _SPI_begin_call(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, InvalidSnapshot, plan, and SPI_ERROR_ARGUMENT.

Referenced by exec_stmt_call(), and exec_stmt_return_query().

◆ SPI_execute_plan_with_paramlist()

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

Definition at line 734 of file spi.c.

736{
738 int res;
739
740 if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC || tcount < 0)
741 return SPI_ERROR_ARGUMENT;
742
743 res = _SPI_begin_call(true);
744 if (res < 0)
745 return res;
746
747 memset(&options, 0, sizeof(options));
748 options.params = params;
749 options.read_only = read_only;
750 options.tcount = tcount;
751
754 true);
755
756 _SPI_end_call(true);
757 return res;
758}

References _SPI_begin_call(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, InvalidSnapshot, options, plan, and SPI_ERROR_ARGUMENT.

Referenced by exec_run_select(), and exec_stmt_execsql().

◆ 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 774 of file spi.c.

778{
780 int res;
781
782 if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC || tcount < 0)
783 return SPI_ERROR_ARGUMENT;
784
785 if (plan->nargs > 0 && Values == NULL)
786 return SPI_ERROR_PARAM;
787
788 res = _SPI_begin_call(true);
789 if (res < 0)
790 return res;
791
792 memset(&options, 0, sizeof(options));
793 options.params = _SPI_convert_params(plan->nargs, plan->argtypes,
794 Values, Nulls);
795 options.read_only = read_only;
796 options.tcount = tcount;
797
799 snapshot, crosscheck_snapshot,
800 fire_triggers);
801
802 _SPI_end_call(true);
803 return res;
804}

References _SPI_begin_call(), _SPI_convert_params(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, Nulls, options, plan, SPI_ERROR_ARGUMENT, and SPI_ERROR_PARAM.

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

◆ 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 813 of file spi.c.

817{
818 int res;
820 ParamListInfo paramLI;
822
823 if (src == NULL || nargs < 0 || tcount < 0)
824 return SPI_ERROR_ARGUMENT;
825
826 if (nargs > 0 && (argtypes == NULL || Values == NULL))
827 return SPI_ERROR_PARAM;
828
829 res = _SPI_begin_call(true);
830 if (res < 0)
831 return res;
832
833 memset(&plan, 0, sizeof(_SPI_plan));
834 plan.magic = _SPI_PLAN_MAGIC;
835 plan.parse_mode = RAW_PARSE_DEFAULT;
836 plan.cursor_options = CURSOR_OPT_PARALLEL_OK;
837 plan.nargs = nargs;
838 plan.argtypes = argtypes;
839 plan.parserSetup = NULL;
840 plan.parserSetupArg = NULL;
841
842 paramLI = _SPI_convert_params(nargs, argtypes,
843 Values, Nulls);
844
846
847 memset(&options, 0, sizeof(options));
848 options.params = paramLI;
849 options.read_only = read_only;
850 options.tcount = tcount;
851
854 true);
855
856 _SPI_end_call(true);
857 return res;
858}

References _SPI_begin_call(), _SPI_convert_params(), _SPI_end_call(), _SPI_execute_plan(), _SPI_PLAN_MAGIC, _SPI_prepare_oneshot_plan(), CURSOR_OPT_PARALLEL_OK, InvalidSnapshot, Nulls, options, plan, RAW_PARSE_DEFAULT, SPI_ERROR_ARGUMENT, and SPI_ERROR_PARAM.

◆ SPI_finish()

int SPI_finish ( void  )

Definition at line 183 of file spi.c.

184{
185 int res;
186
187 res = _SPI_begin_call(false); /* just check we're connected */
188 if (res < 0)
189 return res;
190
191 /* Restore memory context as it was before procedure call */
193
194 /* Release memory used in procedure call (including tuptables) */
196 _SPI_current->execCxt = NULL;
198 _SPI_current->procCxt = NULL;
199
200 /*
201 * Restore outer API variables, especially SPI_tuptable which is probably
202 * pointing at a just-deleted tuptable
203 */
207
208 /* Exit stack level */
210 if (_SPI_connected < 0)
211 _SPI_current = NULL;
212 else
214
215 return SPI_OK_FINISH;
216}
#define SPI_OK_FINISH
Definition: spi.h:83

References _SPI_begin_call(), _SPI_connected, _SPI_current, _SPI_stack, _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, SPI_result, and SPI_tuptable.

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(), plsample_trigger_handler(), 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(), worker_spi_main(), and xpath_table().

◆ SPI_fname()

char * SPI_fname ( TupleDesc  tupdesc,
int  fnumber 
)

Definition at line 1199 of file spi.c.

1200{
1201 const FormData_pg_attribute *att;
1202
1203 SPI_result = 0;
1204
1205 if (fnumber > tupdesc->natts || fnumber == 0 ||
1207 {
1209 return NULL;
1210 }
1211
1212 if (fnumber > 0)
1213 att = TupleDescAttr(tupdesc, fnumber - 1);
1214 else
1215 att = SystemAttributeDefinition(fnumber);
1216
1217 return pstrdup(NameStr(att->attname));
1218}
#define NameStr(name)
Definition: c.h:717
const FormData_pg_attribute * SystemAttributeDefinition(AttrNumber attno)
Definition: heap.c:236
char * pstrdup(const char *in)
Definition: mcxt.c:1699
FormData_pg_attribute
Definition: pg_attribute.h:184
#define SPI_ERROR_NOATTRIBUTE
Definition: spi.h:76
#define FirstLowInvalidHeapAttributeNumber
Definition: sysattr.h:27
static FormData_pg_attribute * TupleDescAttr(TupleDesc tupdesc, int i)
Definition: tupdesc.h:154

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

◆ SPI_fnumber()

int SPI_fnumber ( TupleDesc  tupdesc,
const char *  fname 
)

Definition at line 1176 of file spi.c.

1177{
1178 int res;
1179 const FormData_pg_attribute *sysatt;
1180
1181 for (res = 0; res < tupdesc->natts; res++)
1182 {
1183 Form_pg_attribute attr = TupleDescAttr(tupdesc, res);
1184
1185 if (namestrcmp(&attr->attname, fname) == 0 &&
1186 !attr->attisdropped)
1187 return res + 1;
1188 }
1189
1190 sysatt = SystemAttributeByName(fname);
1191 if (sysatt != NULL)
1192 return sysatt->attnum;
1193
1194 /* SPI_ERROR_NOATTRIBUTE is different from all sys column numbers */
1195 return SPI_ERROR_NOATTRIBUTE;
1196}
const FormData_pg_attribute * SystemAttributeByName(const char *attname)
Definition: heap.c:248
int namestrcmp(Name name, const char *str)
Definition: name.c:247
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:200

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

◆ SPI_freeplan()

int SPI_freeplan ( SPIPlanPtr  plan)

Definition at line 1026 of file spi.c.

1027{
1028 ListCell *lc;
1029
1030 if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC)
1031 return SPI_ERROR_ARGUMENT;
1032
1033 /* Release the plancache entries */
1034 foreach(lc, plan->plancache_list)
1035 {
1036 CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc);
1037
1038 DropCachedPlan(plansource);
1039 }
1040
1041 /* Now get rid of the _SPI_plan and subsidiary data in its plancxt */
1042 MemoryContextDelete(plan->plancxt);
1043
1044 return 0;
1045}
#define lfirst(lc)
Definition: pg_list.h:172
void DropCachedPlan(CachedPlanSource *plansource)
Definition: plancache.c:527

References _SPI_PLAN_MAGIC, DropCachedPlan(), lfirst, MemoryContextDelete(), plan, 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().

◆ SPI_freetuple()

void SPI_freetuple ( HeapTuple  tuple)

Definition at line 1380 of file spi.c.

1381{
1382 /* No longer need to worry which context tuple was in... */
1383 heap_freetuple(tuple);
1384}
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1435

References heap_freetuple().

◆ SPI_freetuptable()

void SPI_freetuptable ( SPITupleTable tuptable)

Definition at line 1387 of file spi.c.

1388{
1389 bool found = false;
1390
1391 /* ignore call if NULL pointer */
1392 if (tuptable == NULL)
1393 return;
1394
1395 /*
1396 * Search only the topmost SPI context for a matching tuple table.
1397 */
1398 if (_SPI_current != NULL)
1399 {
1400 slist_mutable_iter siter;
1401
1402 /* find tuptable in active list, then remove it */
1404 {
1405 SPITupleTable *tt;
1406
1407 tt = slist_container(SPITupleTable, next, siter.cur);
1408 if (tt == tuptable)
1409 {
1410 slist_delete_current(&siter);
1411 found = true;
1412 break;
1413 }
1414 }
1415 }
1416
1417 /*
1418 * Refuse the deletion if we didn't find it in the topmost SPI context.
1419 * This is primarily a guard against double deletion, but might prevent
1420 * other errors as well. Since the worst consequence of not deleting a
1421 * tuptable would be a transient memory leak, this is just a WARNING.
1422 */
1423 if (!found)
1424 {
1425 elog(WARNING, "attempt to delete invalid SPITupleTable %p", tuptable);
1426 return;
1427 }
1428
1429 /* for safety, reset global variables that might point at tuptable */
1430 if (tuptable == _SPI_current->tuptable)
1431 _SPI_current->tuptable = NULL;
1432 if (tuptable == SPI_tuptable)
1433 SPI_tuptable = NULL;
1434
1435 /* release all memory belonging to tuptable */
1436 MemoryContextDelete(tuptable->tuptabcxt);
1437}

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

Referenced by _SPI_execute_plan(), exec_eval_cleanup(), exec_for_query(), exec_stmt_call(), exec_stmt_dynexecute(), exec_stmt_execsql(), exec_stmt_fetch(), 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().

◆ SPI_getargcount()

int SPI_getargcount ( SPIPlanPtr  plan)

Definition at line 1892 of file spi.c.

1893{
1894 if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC)
1895 {
1897 return -1;
1898 }
1899 return plan->nargs;
1900}

References _SPI_PLAN_MAGIC, plan, SPI_ERROR_ARGUMENT, and SPI_result.

◆ SPI_getargtypeid()

Oid SPI_getargtypeid ( SPIPlanPtr  plan,
int  argIndex 
)

Definition at line 1877 of file spi.c.

1878{
1879 if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC ||
1880 argIndex < 0 || argIndex >= plan->nargs)
1881 {
1883 return InvalidOid;
1884 }
1885 return plan->argtypes[argIndex];
1886}
#define InvalidOid
Definition: postgres_ext.h:37

References _SPI_PLAN_MAGIC, InvalidOid, plan, SPI_ERROR_ARGUMENT, and SPI_result.

◆ SPI_getbinval()

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

Definition at line 1253 of file spi.c.

1254{
1255 SPI_result = 0;
1256
1257 if (fnumber > tupdesc->natts || fnumber == 0 ||
1259 {
1261 *isnull = true;
1262 return (Datum) NULL;
1263 }
1264
1265 return heap_getattr(tuple, fnumber, tupdesc, isnull);
1266}
static Datum heap_getattr(HeapTuple tup, int attnum, TupleDesc tupleDesc, bool *isnull)
Definition: htup_details.h:903

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(), ttdummy(), and worker_spi_main().

◆ SPI_getnspname()

char * SPI_getnspname ( Relation  rel)

Definition at line 1333 of file spi.c.

1334{
1336}
char * get_namespace_name(Oid nspid)
Definition: lsyscache.c:3449
#define RelationGetNamespace(relation)
Definition: rel.h:554

References get_namespace_name(), and RelationGetNamespace.

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

◆ SPI_getrelname()

char * SPI_getrelname ( Relation  rel)

◆ SPI_gettype()

char * SPI_gettype ( TupleDesc  tupdesc,
int  fnumber 
)

Definition at line 1269 of file spi.c.

1270{
1271 Oid typoid;
1272 HeapTuple typeTuple;
1273 char *result;
1274
1275 SPI_result = 0;
1276
1277 if (fnumber > tupdesc->natts || fnumber == 0 ||
1279 {
1281 return NULL;
1282 }
1283
1284 if (fnumber > 0)
1285 typoid = TupleDescAttr(tupdesc, fnumber - 1)->atttypid;
1286 else
1287 typoid = (SystemAttributeDefinition(fnumber))->atttypid;
1288
1289 typeTuple = SearchSysCache1(TYPEOID, ObjectIdGetDatum(typoid));
1290
1291 if (!HeapTupleIsValid(typeTuple))
1292 {
1294 return NULL;
1295 }
1296
1297 result = pstrdup(NameStr(((Form_pg_type) GETSTRUCT(typeTuple))->typname));
1298 ReleaseSysCache(typeTuple);
1299 return result;
1300}
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
static void * GETSTRUCT(const HeapTupleData *tuple)
Definition: htup_details.h:728
FormData_pg_type * Form_pg_type
Definition: pg_type.h:261
NameData typname
Definition: pg_type.h:41
static Datum ObjectIdGetDatum(Oid X)
Definition: postgres.h:257
unsigned int Oid
Definition: postgres_ext.h:32
#define SPI_ERROR_TYPUNKNOWN
Definition: spi.h:78
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:269
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:221

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

Referenced by check_foreign_key().

◆ SPI_gettypeid()

Oid SPI_gettypeid ( TupleDesc  tupdesc,
int  fnumber 
)

Definition at line 1309 of file spi.c.

1310{
1311 SPI_result = 0;
1312
1313 if (fnumber > tupdesc->natts || fnumber == 0 ||
1315 {
1317 return InvalidOid;
1318 }
1319
1320 if (fnumber > 0)
1321 return TupleDescAttr(tupdesc, fnumber - 1)->atttypid;
1322 else
1323 return (SystemAttributeDefinition(fnumber))->atttypid;
1324}

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

◆ SPI_getvalue()

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

Definition at line 1221 of file spi.c.

1222{
1223 Datum val;
1224 bool isnull;
1225 Oid typoid,
1226 foutoid;
1227 bool typisvarlena;
1228
1229 SPI_result = 0;
1230
1231 if (fnumber > tupdesc->natts || fnumber == 0 ||
1233 {
1235 return NULL;
1236 }
1237
1238 val = heap_getattr(tuple, fnumber, tupdesc, &isnull);
1239 if (isnull)
1240 return NULL;
1241
1242 if (fnumber > 0)
1243 typoid = TupleDescAttr(tupdesc, fnumber - 1)->atttypid;
1244 else
1245 typoid = (SystemAttributeDefinition(fnumber))->atttypid;
1246
1247 getTypeOutputInfo(typoid, &foutoid, &typisvarlena);
1248
1249 return OidOutputFunctionCall(foutoid, val);
1250}
char * OidOutputFunctionCall(Oid functionId, Datum val)
Definition: fmgr.c:1763
long val
Definition: informix.c:689
void getTypeOutputInfo(Oid type, Oid *typOutput, bool *typIsVarlena)
Definition: lsyscache.c:2990

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

◆ SPI_inside_nonatomic_context()

bool SPI_inside_nonatomic_context ( void  )

Definition at line 582 of file spi.c.

583{
584 if (_SPI_current == NULL)
585 return false; /* not in any SPI context at all */
586 /* these tests must match _SPI_commit's opinion of what's atomic: */
587 if (_SPI_current->atomic)
588 return false; /* it's atomic (ie function not procedure) */
589 if (IsSubTransaction())
590 return false; /* if within subtransaction, it's atomic */
591 return true;
592}
bool IsSubTransaction(void)
Definition: xact.c:5044

References _SPI_current, _SPI_connection::atomic, and IsSubTransaction().

Referenced by StartTransaction().

◆ SPI_is_cursor_plan()

bool SPI_is_cursor_plan ( SPIPlanPtr  plan)

Definition at line 1912 of file spi.c.

1913{
1914 CachedPlanSource *plansource;
1915
1916 if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC)
1917 {
1919 return false;
1920 }
1921
1922 if (list_length(plan->plancache_list) != 1)
1923 {
1924 SPI_result = 0;
1925 return false; /* not exactly 1 pre-rewrite command */
1926 }
1927 plansource = (CachedPlanSource *) linitial(plan->plancache_list);
1928
1929 /*
1930 * We used to force revalidation of the cached plan here, but that seems
1931 * unnecessary: invalidation could mean a change in the rowtype of the
1932 * tuples returned by a plan, but not whether it returns tuples at all.
1933 */
1934 SPI_result = 0;
1935
1936 /* Does it return tuples? */
1937 if (plansource->resultDesc)
1938 return true;
1939
1940 return false;
1941}
static int list_length(const List *l)
Definition: pg_list.h:152
#define linitial(l)
Definition: pg_list.h:178
TupleDesc resultDesc
Definition: plancache.h:105

References _SPI_PLAN_MAGIC, linitial, list_length(), plan, CachedPlanSource::resultDesc, SPI_ERROR_ARGUMENT, and SPI_result.

Referenced by SPI_cursor_open_internal().

◆ SPI_keepplan()

int SPI_keepplan ( SPIPlanPtr  plan)

Definition at line 977 of file spi.c.

978{
979 ListCell *lc;
980
981 if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC ||
982 plan->saved || plan->oneshot)
983 return SPI_ERROR_ARGUMENT;
984
985 /*
986 * Mark it saved, reparent it under CacheMemoryContext, and mark all the
987 * component CachedPlanSources as saved. This sequence cannot fail
988 * partway through, so there's no risk of long-term memory leakage.
989 */
990 plan->saved = true;
992
993 foreach(lc, plan->plancache_list)
994 {
995 CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc);
996
997 SaveCachedPlan(plansource);
998 }
999
1000 return 0;
1001}
void MemoryContextSetParent(MemoryContext context, MemoryContext new_parent)
Definition: mcxt.c:637
MemoryContext CacheMemoryContext
Definition: mcxt.c:152
void SaveCachedPlan(CachedPlanSource *plansource)
Definition: plancache.c:483

References _SPI_PLAN_MAGIC, CacheMemoryContext, lfirst, MemoryContextSetParent(), plan, SaveCachedPlan(), 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().

◆ SPI_modifytuple()

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

Definition at line 1107 of file spi.c.

1109{
1110 MemoryContext oldcxt;
1111 HeapTuple mtuple;
1112 int numberOfAttributes;
1113 Datum *v;
1114 bool *n;
1115 int i;
1116
1117 if (rel == NULL || tuple == NULL || natts < 0 || attnum == NULL || Values == NULL)
1118 {
1120 return NULL;
1121 }
1122
1123 if (_SPI_current == NULL)
1124 {
1126 return NULL;
1127 }
1128
1130
1131 SPI_result = 0;
1132
1133 numberOfAttributes = rel->rd_att->natts;
1134 v = (Datum *) palloc(numberOfAttributes * sizeof(Datum));
1135 n = (bool *) palloc(numberOfAttributes * sizeof(bool));
1136
1137 /* fetch old values and nulls */
1138 heap_deform_tuple(tuple, rel->rd_att, v, n);
1139
1140 /* replace values and nulls */
1141 for (i = 0; i < natts; i++)
1142 {
1143 if (attnum[i] <= 0 || attnum[i] > numberOfAttributes)
1144 break;
1145 v[attnum[i] - 1] = Values[i];
1146 n[attnum[i] - 1] = (Nulls && Nulls[i] == 'n');
1147 }
1148
1149 if (i == natts) /* no errors in *attnum */
1150 {
1151 mtuple = heap_form_tuple(rel->rd_att, v, n);
1152
1153 /*
1154 * copy the identification info of the old tuple: t_ctid, t_self, and
1155 * OID (if any)
1156 */
1157 mtuple->t_data->t_ctid = tuple->t_data->t_ctid;
1158 mtuple->t_self = tuple->t_self;
1159 mtuple->t_tableOid = tuple->t_tableOid;
1160 }
1161 else
1162 {
1163 mtuple = NULL;
1165 }
1166
1167 pfree(v);
1168 pfree(n);
1169
1170 MemoryContextSwitchTo(oldcxt);
1171
1172 return mtuple;
1173}
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, const Datum *values, const bool *isnull)
Definition: heaptuple.c:1117
void heap_deform_tuple(HeapTuple tuple, TupleDesc tupleDesc, Datum *values, bool *isnull)
Definition: heaptuple.c:1346
int i
Definition: isn.c:74
void * palloc(Size size)
Definition: mcxt.c:1317
int16 attnum
Definition: pg_attribute.h:74
ItemPointerData t_self
Definition: htup.h:65
HeapTupleHeader t_data
Definition: htup.h:68
Oid t_tableOid
Definition: htup.h:66
ItemPointerData t_ctid
Definition: htup_details.h:161
TupleDesc rd_att
Definition: rel.h:112

References _SPI_current, attnum, heap_deform_tuple(), heap_form_tuple(), i, MemoryContextSwitchTo(), TupleDescData::natts, Nulls, 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().

◆ SPI_palloc()

void * SPI_palloc ( Size  size)

Definition at line 1339 of file spi.c.

1340{
1341 if (_SPI_current == NULL)
1342 elog(ERROR, "SPI_palloc called while not connected to SPI");
1343
1345}

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

Referenced by _SPI_strdup(), and coerce_function_result_tuple().

◆ SPI_pfree()

void SPI_pfree ( void *  pointer)

Definition at line 1355 of file spi.c.

1356{
1357 /* No longer need to worry which context chunk was in... */
1358 pfree(pointer);
1359}

References pfree().

◆ SPI_plan_get_cached_plan()

CachedPlan * SPI_plan_get_cached_plan ( SPIPlanPtr  plan)

Definition at line 2078 of file spi.c.

2079{
2080 CachedPlanSource *plansource;
2081 CachedPlan *cplan;
2082 SPICallbackArg spicallbackarg;
2083 ErrorContextCallback spierrcontext;
2084
2085 Assert(plan->magic == _SPI_PLAN_MAGIC);
2086
2087 /* Can't support one-shot plans here */
2088 if (plan->oneshot)
2089 return NULL;
2090
2091 /* Must have exactly one CachedPlanSource */
2092 if (list_length(plan->plancache_list) != 1)
2093 return NULL;
2094 plansource = (CachedPlanSource *) linitial(plan->plancache_list);
2095
2096 /* Setup error traceback support for ereport() */
2097 spicallbackarg.query = plansource->query_string;
2098 spicallbackarg.mode = plan->parse_mode;
2099 spierrcontext.callback = _SPI_error_callback;
2100 spierrcontext.arg = &spicallbackarg;
2101 spierrcontext.previous = error_context_stack;
2102 error_context_stack = &spierrcontext;
2103
2104 /* Get the generic plan for the query */
2105 cplan = GetCachedPlan(plansource, NULL,
2106 plan->saved ? CurrentResourceOwner : NULL,
2108 Assert(cplan == plansource->gplan);
2109
2110 /* Pop the error context stack */
2111 error_context_stack = spierrcontext.previous;
2112
2113 return cplan;
2114}
ErrorContextCallback * error_context_stack
Definition: elog.c:94
CachedPlan * GetCachedPlan(CachedPlanSource *plansource, ParamListInfo boundParams, ResourceOwner owner, QueryEnvironment *queryEnv)
Definition: plancache.c:1310
ResourceOwner CurrentResourceOwner
Definition: resowner.c:173
static void _SPI_error_callback(void *arg)
Definition: spi.c:2978
struct CachedPlan * gplan
Definition: plancache.h:118
const char * query_string
Definition: plancache.h:97
struct ErrorContextCallback * previous
Definition: elog.h:296
void(* callback)(void *arg)
Definition: elog.h:297
const char * query
Definition: spi.c:55
RawParseMode mode
Definition: spi.c:56

References _SPI_current, _SPI_error_callback(), _SPI_PLAN_MAGIC, ErrorContextCallback::arg, Assert(), ErrorContextCallback::callback, CurrentResourceOwner, error_context_stack, GetCachedPlan(), CachedPlanSource::gplan, linitial, list_length(), SPICallbackArg::mode, plan, ErrorContextCallback::previous, SPICallbackArg::query, CachedPlanSource::query_string, and _SPI_connection::queryEnv.

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

◆ SPI_plan_get_plan_sources()

List * SPI_plan_get_plan_sources ( SPIPlanPtr  plan)

Definition at line 2059 of file spi.c.

2060{
2061 Assert(plan->magic == _SPI_PLAN_MAGIC);
2062 return plan->plancache_list;
2063}

References _SPI_PLAN_MAGIC, Assert(), and plan.

Referenced by exec_is_simple_query(), exec_simple_check_plan(), and exec_stmt_execsql().

◆ SPI_plan_is_valid()

bool SPI_plan_is_valid ( SPIPlanPtr  plan)

Definition at line 1950 of file spi.c.

1951{
1952 ListCell *lc;
1953
1954 Assert(plan->magic == _SPI_PLAN_MAGIC);
1955
1956 foreach(lc, plan->plancache_list)
1957 {
1958 CachedPlanSource *plansource = (CachedPlanSource *) lfirst(lc);
1959
1960 if (!CachedPlanIsValid(plansource))
1961 return false;
1962 }
1963 return true;
1964}
bool CachedPlanIsValid(CachedPlanSource *plansource)
Definition: plancache.c:1771

References _SPI_PLAN_MAGIC, Assert(), CachedPlanIsValid(), lfirst, and plan.

Referenced by ri_FetchPreparedPlan().

◆ 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 867 of file spi.c.

869{
871 SPIPlanPtr result;
872
873 if (src == NULL || nargs < 0 || (nargs > 0 && argtypes == NULL))
874 {
876 return NULL;
877 }
878
880 if (SPI_result < 0)
881 return NULL;
882
883 memset(&plan, 0, sizeof(_SPI_plan));
884 plan.magic = _SPI_PLAN_MAGIC;
885 plan.parse_mode = RAW_PARSE_DEFAULT;
886 plan.cursor_options = cursorOptions;
887 plan.nargs = nargs;
888 plan.argtypes = argtypes;
889 plan.parserSetup = NULL;
890 plan.parserSetupArg = NULL;
891
892 _SPI_prepare_plan(src, &plan);
893
894 /* copy plan to procedure context */
895 result = _SPI_make_plan_non_temp(&plan);
896
897 _SPI_end_call(true);
898
899 return result;
900}
static SPIPlanPtr _SPI_make_plan_non_temp(SPIPlanPtr plan)
Definition: spi.c:3158

References _SPI_begin_call(), _SPI_end_call(), _SPI_make_plan_non_temp(), _SPI_PLAN_MAGIC, _SPI_prepare_plan(), plan, RAW_PARSE_DEFAULT, SPI_ERROR_ARGUMENT, and SPI_result.

Referenced by SPI_prepare().

◆ SPI_prepare_extended()

SPIPlanPtr SPI_prepare_extended ( const char *  src,
const SPIPrepareOptions options 
)

Definition at line 903 of file spi.c.

905{
907 SPIPlanPtr result;
908
909 if (src == NULL || options == NULL)
910 {
912 return NULL;
913 }
914
916 if (SPI_result < 0)
917 return NULL;
918
919 memset(&plan, 0, sizeof(_SPI_plan));
920 plan.magic = _SPI_PLAN_MAGIC;
921 plan.parse_mode = options->parseMode;
922 plan.cursor_options = options->cursorOptions;
923 plan.nargs = 0;
924 plan.argtypes = NULL;
925 plan.parserSetup = options->parserSetup;
926 plan.parserSetupArg = options->parserSetupArg;
927
928 _SPI_prepare_plan(src, &plan);
929
930 /* copy plan to procedure context */
931 result = _SPI_make_plan_non_temp(&plan);
932
933 _SPI_end_call(true);
934
935 return result;
936}

References _SPI_begin_call(), _SPI_end_call(), _SPI_make_plan_non_temp(), _SPI_PLAN_MAGIC, _SPI_prepare_plan(), plan, SPI_ERROR_ARGUMENT, and SPI_result.

Referenced by exec_prepare_plan().

◆ SPI_prepare_params()

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

Definition at line 939 of file spi.c.

943{
945 SPIPlanPtr result;
946
947 if (src == NULL)
948 {
950 return NULL;
951 }
952
954 if (SPI_result < 0)
955 return NULL;
956
957 memset(&plan, 0, sizeof(_SPI_plan));
958 plan.magic = _SPI_PLAN_MAGIC;
959 plan.parse_mode = RAW_PARSE_DEFAULT;
960 plan.cursor_options = cursorOptions;
961 plan.nargs = 0;
962 plan.argtypes = NULL;
963 plan.parserSetup = parserSetup;
964 plan.parserSetupArg = parserSetupArg;
965
966 _SPI_prepare_plan(src, &plan);
967
968 /* copy plan to procedure context */
969 result = _SPI_make_plan_non_temp(&plan);
970
971 _SPI_end_call(true);
972
973 return result;
974}

References _SPI_begin_call(), _SPI_end_call(), _SPI_make_plan_non_temp(), _SPI_PLAN_MAGIC, _SPI_prepare_plan(), plan, RAW_PARSE_DEFAULT, SPI_ERROR_ARGUMENT, and SPI_result.

◆ SPI_register_relation()

int SPI_register_relation ( EphemeralNamedRelation  enr)

Definition at line 3314 of file spi.c.

3315{
3317 int res;
3318
3319 if (enr == NULL || enr->md.name == NULL)
3320 return SPI_ERROR_ARGUMENT;
3321
3322 res = _SPI_begin_call(false); /* keep current memory context */
3323 if (res < 0)
3324 return res;
3325
3326 match = _SPI_find_ENR_by_name(enr->md.name);
3327 if (match)
3329 else
3330 {
3331 if (_SPI_current->queryEnv == NULL)
3333
3335 res = SPI_OK_REL_REGISTER;
3336 }
3337
3338 _SPI_end_call(false);
3339
3340 return res;
3341}
QueryEnvironment * create_queryEnv(void)
void register_ENR(QueryEnvironment *queryEnv, EphemeralNamedRelation enr)
static EphemeralNamedRelation _SPI_find_ENR_by_name(const char *name)
Definition: spi.c:3297
#define SPI_ERROR_REL_DUPLICATE
Definition: spi.h:79
#define SPI_OK_REL_REGISTER
Definition: spi.h:96
EphemeralNamedRelationMetadataData md

References _SPI_begin_call(), _SPI_current, _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().

◆ SPI_register_trigger_data()

int SPI_register_trigger_data ( TriggerData tdata)

Definition at line 3381 of file spi.c.

3382{
3383 if (tdata == NULL)
3384 return SPI_ERROR_ARGUMENT;
3385
3386 if (tdata->tg_newtable)
3387 {
3390 int rc;
3391
3392 enr->md.name = tdata->tg_trigger->tgnewtable;
3393 enr->md.reliddesc = tdata->tg_relation->rd_id;
3394 enr->md.tupdesc = NULL;
3397 enr->reldata = tdata->tg_newtable;
3398 rc = SPI_register_relation(enr);
3399 if (rc != SPI_OK_REL_REGISTER)
3400 return rc;
3401 }
3402
3403 if (tdata->tg_oldtable)
3404 {
3407 int rc;
3408
3409 enr->md.name = tdata->tg_trigger->tgoldtable;
3410 enr->md.reliddesc = tdata->tg_relation->rd_id;
3411 enr->md.tupdesc = NULL;
3414 enr->reldata = tdata->tg_oldtable;
3415 rc = SPI_register_relation(enr);
3416 if (rc != SPI_OK_REL_REGISTER)
3417 return rc;
3418 }
3419
3420 return SPI_OK_TD_REGISTER;
3421}
@ ENR_NAMED_TUPLESTORE
int SPI_register_relation(EphemeralNamedRelation enr)
Definition: spi.c:3314
#define SPI_OK_TD_REGISTER
Definition: spi.h:98
EphemeralNameRelationType enrtype
Oid rd_id
Definition: rel.h:113
Tuplestorestate * tg_oldtable
Definition: trigger.h:41
Relation tg_relation
Definition: trigger.h:35
Tuplestorestate * tg_newtable
Definition: trigger.h:42
Trigger * tg_trigger
Definition: trigger.h:38
char * tgoldtable
Definition: reltrigger.h:43
char * tgnewtable
Definition: reltrigger.h:44
int64 tuplestore_tuple_count(Tuplestorestate *state)
Definition: tuplestore.c:580

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(), plsample_trigger_handler(), pltcl_trigger_handler(), and PLy_exec_trigger().

◆ SPI_repalloc()

void * SPI_repalloc ( void *  pointer,
Size  size 
)

Definition at line 1348 of file spi.c.

1349{
1350 /* No longer need to worry which context chunk was in... */
1351 return repalloc(pointer, size);
1352}

References repalloc().

◆ SPI_result_code_string()

const char * SPI_result_code_string ( int  code)

Definition at line 1974 of file spi.c.

1975{
1976 static char buf[64];
1977
1978 switch (code)
1979 {
1980 case SPI_ERROR_CONNECT:
1981 return "SPI_ERROR_CONNECT";
1982 case SPI_ERROR_COPY:
1983 return "SPI_ERROR_COPY";
1985 return "SPI_ERROR_OPUNKNOWN";
1987 return "SPI_ERROR_UNCONNECTED";
1988 case SPI_ERROR_ARGUMENT:
1989 return "SPI_ERROR_ARGUMENT";
1990 case SPI_ERROR_PARAM:
1991 return "SPI_ERROR_PARAM";
1993 return "SPI_ERROR_TRANSACTION";
1995 return "SPI_ERROR_NOATTRIBUTE";
1997 return "SPI_ERROR_NOOUTFUNC";
1999 return "SPI_ERROR_TYPUNKNOWN";
2001 return "SPI_ERROR_REL_DUPLICATE";
2003 return "SPI_ERROR_REL_NOT_FOUND";
2004 case SPI_OK_CONNECT:
2005 return "SPI_OK_CONNECT";
2006 case SPI_OK_FINISH:
2007 return "SPI_OK_FINISH";
2008 case SPI_OK_FETCH:
2009 return "SPI_OK_FETCH";
2010 case SPI_OK_UTILITY:
2011 return "SPI_OK_UTILITY";
2012 case SPI_OK_SELECT:
2013 return "SPI_OK_SELECT";
2014 case SPI_OK_SELINTO:
2015 return "SPI_OK_SELINTO";
2016 case SPI_OK_INSERT:
2017 return "SPI_OK_INSERT";
2018 case SPI_OK_DELETE:
2019 return "SPI_OK_DELETE";
2020 case SPI_OK_UPDATE:
2021 return "SPI_OK_UPDATE";
2022 case SPI_OK_CURSOR:
2023 return "SPI_OK_CURSOR";
2025 return "SPI_OK_INSERT_RETURNING";
2027 return "SPI_OK_DELETE_RETURNING";
2029 return "SPI_OK_UPDATE_RETURNING";
2030 case SPI_OK_REWRITTEN:
2031 return "SPI_OK_REWRITTEN";
2033 return "SPI_OK_REL_REGISTER";
2035 return "SPI_OK_REL_UNREGISTER";
2036 case SPI_OK_TD_REGISTER:
2037 return "SPI_OK_TD_REGISTER";
2038 case SPI_OK_MERGE:
2039 return "SPI_OK_MERGE";
2041 return "SPI_OK_MERGE_RETURNING";
2042 }
2043 /* Unrecognized code ... return something useful ... */
2044 sprintf(buf, "Unrecognized SPI code %d", code);
2045 return buf;
2046}
static char * buf
Definition: pg_test_fsync.c:72
#define sprintf
Definition: port.h:241
#define SPI_ERROR_TRANSACTION
Definition: spi.h:75
#define SPI_ERROR_REL_NOT_FOUND
Definition: spi.h:80
#define SPI_OK_UTILITY
Definition: spi.h:85
#define SPI_OK_REWRITTEN
Definition: spi.h:95
#define SPI_OK_INSERT
Definition: spi.h:88
#define SPI_OK_UPDATE
Definition: spi.h:90
#define SPI_OK_CURSOR
Definition: spi.h:91
#define SPI_OK_FETCH
Definition: spi.h:84
#define SPI_OK_MERGE
Definition: spi.h:99
#define SPI_OK_SELINTO
Definition: spi.h:87
#define SPI_ERROR_OPUNKNOWN
Definition: spi.h:70
#define SPI_OK_UPDATE_RETURNING
Definition: spi.h:94
#define SPI_OK_DELETE
Definition: spi.h:89
#define SPI_OK_REL_UNREGISTER
Definition: spi.h:97
#define SPI_OK_INSERT_RETURNING
Definition: spi.h:92
#define SPI_ERROR_COPY
Definition: spi.h:69
#define SPI_ERROR_NOOUTFUNC
Definition: spi.h:77
#define SPI_OK_DELETE_RETURNING
Definition: spi.h:93
#define SPI_OK_MERGE_RETURNING
Definition: spi.h:100
#define SPI_ERROR_CONNECT
Definition: spi.h:68
#define SPI_OK_SELECT
Definition: spi.h:86

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_MERGE, SPI_OK_MERGE_RETURNING, SPI_OK_REL_REGISTER, SPI_OK_REL_UNREGISTER, SPI_OK_REWRITTEN, SPI_OK_SELECT, SPI_OK_SELINTO, SPI_OK_TD_REGISTER, 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_return_query(), 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().

◆ SPI_returntuple()

HeapTupleHeader SPI_returntuple ( HeapTuple  tuple,
TupleDesc  tupdesc 
)

Definition at line 1075 of file spi.c.

1076{
1077 MemoryContext oldcxt;
1078 HeapTupleHeader dtup;
1079
1080 if (tuple == NULL || tupdesc == NULL)
1081 {
1083 return NULL;
1084 }
1085
1086 if (_SPI_current == NULL)
1087 {
1089 return NULL;
1090 }
1091
1092 /* For RECORD results, make sure a typmod has been assigned */
1093 if (tupdesc->tdtypeid == RECORDOID &&
1094 tupdesc->tdtypmod < 0)
1096
1098
1099 dtup = DatumGetHeapTupleHeader(heap_copy_tuple_as_datum(tuple, tupdesc));
1100
1101 MemoryContextSwitchTo(oldcxt);
1102
1103 return dtup;
1104}
#define DatumGetHeapTupleHeader(X)
Definition: fmgr.h:295
Datum heap_copy_tuple_as_datum(HeapTuple tuple, TupleDesc tupleDesc)
Definition: heaptuple.c:1081
int32 tdtypmod
Definition: tupdesc.h:133
Oid tdtypeid
Definition: tupdesc.h:132
void assign_record_type_typmod(TupleDesc tupDesc)
Definition: typcache.c:2040

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

◆ SPI_rollback()

void SPI_rollback ( void  )

Definition at line 414 of file spi.c.

415{
416 _SPI_rollback(false);
417}
static void _SPI_rollback(bool chain)
Definition: spi.c:333

References _SPI_rollback().

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

◆ SPI_rollback_and_chain()

void SPI_rollback_and_chain ( void  )

Definition at line 420 of file spi.c.

421{
422 _SPI_rollback(true);
423}

References _SPI_rollback().

Referenced by exec_stmt_rollback().

◆ SPI_saveplan()

SPIPlanPtr SPI_saveplan ( SPIPlanPtr  plan)

Definition at line 1004 of file spi.c.

1005{
1006 SPIPlanPtr newplan;
1007
1008 if (plan == NULL || plan->magic != _SPI_PLAN_MAGIC)
1009 {
1011 return NULL;
1012 }
1013
1014 SPI_result = _SPI_begin_call(false); /* don't change context */
1015 if (SPI_result < 0)
1016 return NULL;
1017
1018 newplan = _SPI_save_plan(plan);
1019
1020 SPI_result = _SPI_end_call(false);
1021
1022 return newplan;
1023}
static SPIPlanPtr _SPI_save_plan(SPIPlanPtr plan)
Definition: spi.c:3226

References _SPI_begin_call(), _SPI_end_call(), _SPI_PLAN_MAGIC, _SPI_save_plan(), plan, SPI_ERROR_ARGUMENT, and SPI_result.

◆ SPI_scroll_cursor_fetch()

void SPI_scroll_cursor_fetch ( Portal  portal,
FetchDirection  direction,
long  count 
)

Definition at line 1837 of file spi.c.

1838{
1839 _SPI_cursor_operation(portal,
1840 direction, count,
1842 /* we know that the DestSPI receiver doesn't need a destroy call */
1843}

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

Referenced by exec_stmt_fetch().

◆ SPI_scroll_cursor_move()

void SPI_scroll_cursor_move ( Portal  portal,
FetchDirection  direction,
long  count 
)

Definition at line 1852 of file spi.c.

1853{
1854 _SPI_cursor_operation(portal, direction, count, None_Receiver);
1855}

References _SPI_cursor_operation(), and None_Receiver.

Referenced by exec_stmt_fetch().

◆ SPI_start_transaction()

void SPI_start_transaction ( void  )

Definition at line 223 of file spi.c.

224{
225}

◆ SPI_unregister_relation()

int SPI_unregister_relation ( const char *  name)

Definition at line 3348 of file spi.c.

3349{
3351 int res;
3352
3353 if (name == NULL)
3354 return SPI_ERROR_ARGUMENT;
3355
3356 res = _SPI_begin_call(false); /* keep current memory context */
3357 if (res < 0)
3358 return res;
3359
3360 match = _SPI_find_ENR_by_name(name);
3361 if (match)
3362 {
3365 }
3366 else
3368
3369 _SPI_end_call(false);
3370
3371 return res;
3372}
void unregister_ENR(QueryEnvironment *queryEnv, const char *name)

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

Variable Documentation

◆ SPI_processed

◆ SPI_result

◆ SPI_tuptable