1 /*-------------------------------------------------------------------------
4 * Server Programming Interface public declarations
6 * Portions Copyright (c) 1996-2014, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
9 * src/include/executor/spi.h
11 *-------------------------------------------------------------------------
16 #include "lib/ilist.h"
17 #include "nodes/parsenodes.h"
18 #include "utils/portal.h"
21 typedef struct SPITupleTable
23 MemoryContext tuptabcxt; /* memory context of result table */
24 uint32 alloced; /* # of alloced vals */
25 uint32 free; /* # of free vals */
26 TupleDesc tupdesc; /* tuple descriptor */
27 HeapTuple *vals; /* tuples */
28 slist_node next; /* link for internal bookkeeping */
29 SubTransactionId subid; /* subxact in which tuptable was created */
32 /* Plans are opaque structs for standard users of SPI */
33 typedef struct _SPI_plan *SPIPlanPtr;
35 #define SPI_ERROR_CONNECT (-1)
36 #define SPI_ERROR_COPY (-2)
37 #define SPI_ERROR_OPUNKNOWN (-3)
38 #define SPI_ERROR_UNCONNECTED (-4)
39 #define SPI_ERROR_CURSOR (-5) /* not used anymore */
40 #define SPI_ERROR_ARGUMENT (-6)
41 #define SPI_ERROR_PARAM (-7)
42 #define SPI_ERROR_TRANSACTION (-8)
43 #define SPI_ERROR_NOATTRIBUTE (-9)
44 #define SPI_ERROR_NOOUTFUNC (-10)
45 #define SPI_ERROR_TYPUNKNOWN (-11)
47 #define SPI_OK_CONNECT 1
48 #define SPI_OK_FINISH 2
49 #define SPI_OK_FETCH 3
50 #define SPI_OK_UTILITY 4
51 #define SPI_OK_SELECT 5
52 #define SPI_OK_SELINTO 6
53 #define SPI_OK_INSERT 7
54 #define SPI_OK_DELETE 8
55 #define SPI_OK_UPDATE 9
56 #define SPI_OK_CURSOR 10
57 #define SPI_OK_INSERT_RETURNING 11
58 #define SPI_OK_DELETE_RETURNING 12
59 #define SPI_OK_UPDATE_RETURNING 13
60 #define SPI_OK_REWRITTEN 14
62 extern PGDLLIMPORT uint32 SPI_processed;
63 extern PGDLLIMPORT Oid SPI_lastoid;
64 extern PGDLLIMPORT SPITupleTable *SPI_tuptable;
65 extern PGDLLIMPORT int SPI_result;
67 extern int SPI_connect(void);
68 extern int SPI_finish(void);
69 extern void SPI_push(void);
70 extern void SPI_pop(void);
71 extern bool SPI_push_conditional(void);
72 extern void SPI_pop_conditional(bool pushed);
73 extern void SPI_restore_connection(void);
74 extern int SPI_execute(const char *src, bool read_only, long tcount);
75 extern int SPI_execute_plan(SPIPlanPtr plan, Datum *Values, const char *Nulls,
76 bool read_only, long tcount);
77 extern int SPI_execute_plan_with_paramlist(SPIPlanPtr plan,
79 bool read_only, long tcount);
80 extern int SPI_exec(const char *src, long tcount);
81 extern int SPI_execp(SPIPlanPtr plan, Datum *Values, const char *Nulls,
83 extern int SPI_execute_snapshot(SPIPlanPtr plan,
84 Datum *Values, const char *Nulls,
86 Snapshot crosscheck_snapshot,
87 bool read_only, bool fire_triggers, long tcount);
88 extern int SPI_execute_with_args(const char *src,
89 int nargs, Oid *argtypes,
90 Datum *Values, const char *Nulls,
91 bool read_only, long tcount);
92 extern SPIPlanPtr SPI_prepare(const char *src, int nargs, Oid *argtypes);
93 extern SPIPlanPtr SPI_prepare_cursor(const char *src, int nargs, Oid *argtypes,
95 extern SPIPlanPtr SPI_prepare_params(const char *src,
96 ParserSetupHook parserSetup,
99 extern int SPI_keepplan(SPIPlanPtr plan);
100 extern SPIPlanPtr SPI_saveplan(SPIPlanPtr plan);
101 extern int SPI_freeplan(SPIPlanPtr plan);
103 extern Oid SPI_getargtypeid(SPIPlanPtr plan, int argIndex);
104 extern int SPI_getargcount(SPIPlanPtr plan);
105 extern bool SPI_is_cursor_plan(SPIPlanPtr plan);
106 extern bool SPI_plan_is_valid(SPIPlanPtr plan);
107 extern const char *SPI_result_code_string(int code);
109 extern List *SPI_plan_get_plan_sources(SPIPlanPtr plan);
110 extern CachedPlan *SPI_plan_get_cached_plan(SPIPlanPtr plan);
112 extern HeapTuple SPI_copytuple(HeapTuple tuple);
113 extern HeapTupleHeader SPI_returntuple(HeapTuple tuple, TupleDesc tupdesc);
114 extern HeapTuple SPI_modifytuple(Relation rel, HeapTuple tuple, int natts,
115 int *attnum, Datum *Values, const char *Nulls);
116 extern int SPI_fnumber(TupleDesc tupdesc, const char *fname);
117 extern char *SPI_fname(TupleDesc tupdesc, int fnumber);
118 extern char *SPI_getvalue(HeapTuple tuple, TupleDesc tupdesc, int fnumber);
119 extern Datum SPI_getbinval(HeapTuple tuple, TupleDesc tupdesc, int fnumber, bool *isnull);
120 extern char *SPI_gettype(TupleDesc tupdesc, int fnumber);
121 extern Oid SPI_gettypeid(TupleDesc tupdesc, int fnumber);
122 extern char *SPI_getrelname(Relation rel);
123 extern char *SPI_getnspname(Relation rel);
124 extern void *SPI_palloc(Size size);
125 extern void *SPI_repalloc(void *pointer, Size size);
126 extern void SPI_pfree(void *pointer);
127 extern void SPI_freetuple(HeapTuple pointer);
128 extern void SPI_freetuptable(SPITupleTable *tuptable);
130 extern Portal SPI_cursor_open(const char *name, SPIPlanPtr plan,
131 Datum *Values, const char *Nulls, bool read_only);
132 extern Portal SPI_cursor_open_with_args(const char *name,
134 int nargs, Oid *argtypes,
135 Datum *Values, const char *Nulls,
136 bool read_only, int cursorOptions);
137 extern Portal SPI_cursor_open_with_paramlist(const char *name, SPIPlanPtr plan,
138 ParamListInfo params, bool read_only);
139 extern Portal SPI_cursor_find(const char *name);
140 extern void SPI_cursor_fetch(Portal portal, bool forward, long count);
141 extern void SPI_cursor_move(Portal portal, bool forward, long count);
142 extern void SPI_scroll_cursor_fetch(Portal, FetchDirection direction, long count);
143 extern void SPI_scroll_cursor_move(Portal, FetchDirection direction, long count);
144 extern void SPI_cursor_close(Portal portal);
146 extern void AtEOXact_SPI(bool isCommit);
147 extern void AtEOSubXact_SPI(bool isCommit, SubTransactionId mySubid);