PostgreSQL Source Code  git master
fdwapi.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * fdwapi.h
4  * API for foreign-data wrappers
5  *
6  * Copyright (c) 2010-2019, PostgreSQL Global Development Group
7  *
8  * src/include/foreign/fdwapi.h
9  *
10  *-------------------------------------------------------------------------
11  */
12 #ifndef FDWAPI_H
13 #define FDWAPI_H
14 
15 #include "access/parallel.h"
16 #include "nodes/execnodes.h"
17 #include "nodes/pathnodes.h"
18 
19 /* To avoid including explain.h here, reference ExplainState thus: */
20 struct ExplainState;
21 
22 
23 /*
24  * Callback function signatures --- see fdwhandler.sgml for more info.
25  */
26 
27 typedef void (*GetForeignRelSize_function) (PlannerInfo *root,
28  RelOptInfo *baserel,
29  Oid foreigntableid);
30 
31 typedef void (*GetForeignPaths_function) (PlannerInfo *root,
32  RelOptInfo *baserel,
33  Oid foreigntableid);
34 
35 typedef ForeignScan *(*GetForeignPlan_function) (PlannerInfo *root,
36  RelOptInfo *baserel,
37  Oid foreigntableid,
38  ForeignPath *best_path,
39  List *tlist,
40  List *scan_clauses,
41  Plan *outer_plan);
42 
44  int eflags);
45 
46 typedef TupleTableSlot *(*IterateForeignScan_function) (ForeignScanState *node);
47 
49  TupleTableSlot *slot);
50 
52 
53 typedef void (*EndForeignScan_function) (ForeignScanState *node);
54 
56  RelOptInfo *joinrel,
57  RelOptInfo *outerrel,
58  RelOptInfo *innerrel,
59  JoinType jointype,
60  JoinPathExtraData *extra);
61 
63  UpperRelationKind stage,
64  RelOptInfo *input_rel,
65  RelOptInfo *output_rel,
66  void *extra);
67 
68 typedef void (*AddForeignUpdateTargets_function) (Query *parsetree,
69  RangeTblEntry *target_rte,
70  Relation target_relation);
71 
72 typedef List *(*PlanForeignModify_function) (PlannerInfo *root,
73  ModifyTable *plan,
74  Index resultRelation,
75  int subplan_index);
76 
78  ResultRelInfo *rinfo,
79  List *fdw_private,
80  int subplan_index,
81  int eflags);
82 
83 typedef TupleTableSlot *(*ExecForeignInsert_function) (EState *estate,
84  ResultRelInfo *rinfo,
85  TupleTableSlot *slot,
86  TupleTableSlot *planSlot);
87 
88 typedef TupleTableSlot *(*ExecForeignUpdate_function) (EState *estate,
89  ResultRelInfo *rinfo,
90  TupleTableSlot *slot,
91  TupleTableSlot *planSlot);
92 
93 typedef TupleTableSlot *(*ExecForeignDelete_function) (EState *estate,
94  ResultRelInfo *rinfo,
95  TupleTableSlot *slot,
96  TupleTableSlot *planSlot);
97 
98 typedef void (*EndForeignModify_function) (EState *estate,
99  ResultRelInfo *rinfo);
100 
102  ResultRelInfo *rinfo);
103 
104 typedef void (*EndForeignInsert_function) (EState *estate,
105  ResultRelInfo *rinfo);
106 
108 
110  ModifyTable *plan,
111  Index resultRelation,
112  int subplan_index);
113 
115  int eflags);
116 
117 typedef TupleTableSlot *(*IterateDirectModify_function) (ForeignScanState *node);
118 
120 
122  LockClauseStrength strength);
123 
124 typedef void (*RefetchForeignRow_function) (EState *estate,
125  ExecRowMark *erm,
126  Datum rowid,
127  TupleTableSlot *slot,
128  bool *updated);
129 
131  struct ExplainState *es);
132 
134  ResultRelInfo *rinfo,
135  List *fdw_private,
136  int subplan_index,
137  struct ExplainState *es);
138 
140  struct ExplainState *es);
141 
142 typedef int (*AcquireSampleRowsFunc) (Relation relation, int elevel,
143  HeapTuple *rows, int targrows,
144  double *totalrows,
145  double *totaldeadrows);
146 
148  AcquireSampleRowsFunc *func,
149  BlockNumber *totalpages);
150 
151 typedef List *(*ImportForeignSchema_function) (ImportForeignSchemaStmt *stmt,
152  Oid serverOid);
153 
155  ParallelContext *pcxt);
157  ParallelContext *pcxt,
158  void *coordinate);
160  ParallelContext *pcxt,
161  void *coordinate);
163  shm_toc *toc,
164  void *coordinate);
167  RelOptInfo *rel,
168  RangeTblEntry *rte);
169 typedef List *(*ReparameterizeForeignPathByChild_function) (PlannerInfo *root,
170  List *fdw_private,
171  RelOptInfo *child_rel);
172 
173 /*
174  * FdwRoutine is the struct returned by a foreign-data wrapper's handler
175  * function. It provides pointers to the callback functions needed by the
176  * planner and executor.
177  *
178  * More function pointers are likely to be added in the future. Therefore
179  * it's recommended that the handler initialize the struct with
180  * makeNode(FdwRoutine) so that all fields are set to NULL. This will
181  * ensure that no fields are accidentally left undefined.
182  */
183 typedef struct FdwRoutine
184 {
186 
187  /* Functions for scanning foreign tables */
195 
196  /*
197  * Remaining functions are optional. Set the pointer to NULL for any that
198  * are not provided.
199  */
200 
201  /* Functions for remote-join planning */
203 
204  /* Functions for remote upper-relation (post scan/join) planning */
206 
207  /* Functions for updating foreign tables */
222 
223  /* Functions for SELECT FOR UPDATE/SHARE row locking */
227 
228  /* Support functions for EXPLAIN */
232 
233  /* Support functions for ANALYZE */
235 
236  /* Support functions for IMPORT FOREIGN SCHEMA */
238 
239  /* Support functions for parallelism under Gather node */
246 
247  /* Support functions for path reparameterization. */
249 } FdwRoutine;
250 
251 
252 /* Functions in foreign/foreign.c */
253 extern FdwRoutine *GetFdwRoutine(Oid fdwhandler);
254 extern Oid GetForeignServerIdByRelId(Oid relid);
255 extern FdwRoutine *GetFdwRoutineByServerId(Oid serverid);
256 extern FdwRoutine *GetFdwRoutineByRelId(Oid relid);
257 extern FdwRoutine *GetFdwRoutineForRelation(Relation relation, bool makecopy);
258 extern bool IsImportableForeignTable(const char *tablename,
260 extern Path *GetExistingLocalJoinPath(RelOptInfo *joinrel);
261 
262 #endif /* FDWAPI_H */
GetForeignPlan_function GetForeignPlan
Definition: fdwapi.h:190
BeginForeignScan_function BeginForeignScan
Definition: fdwapi.h:191
GetForeignUpperPaths_function GetForeignUpperPaths
Definition: fdwapi.h:205
ExecForeignDelete_function ExecForeignDelete
Definition: fdwapi.h:213
EndDirectModify_function EndDirectModify
Definition: fdwapi.h:221
UpperRelationKind
Definition: pathnodes.h:71
void(* GetForeignJoinPaths_function)(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, JoinPathExtraData *extra)
Definition: fdwapi.h:55
void(* EndForeignScan_function)(ForeignScanState *node)
Definition: fdwapi.h:53
EstimateDSMForeignScan_function EstimateDSMForeignScan
Definition: fdwapi.h:241
Path * GetExistingLocalJoinPath(RelOptInfo *joinrel)
Definition: foreign.c:751
ExplainForeignScan_function ExplainForeignScan
Definition: fdwapi.h:229
Size(* EstimateDSMForeignScan_function)(ForeignScanState *node, ParallelContext *pcxt)
Definition: fdwapi.h:154
AnalyzeForeignTable_function AnalyzeForeignTable
Definition: fdwapi.h:234
InitializeWorkerForeignScan_function InitializeWorkerForeignScan
Definition: fdwapi.h:244
void(* AddForeignUpdateTargets_function)(Query *parsetree, RangeTblEntry *target_rte, Relation target_relation)
Definition: fdwapi.h:68
BeginForeignInsert_function BeginForeignInsert
Definition: fdwapi.h:215
FdwRoutine * GetFdwRoutineForRelation(Relation relation, bool makecopy)
Definition: foreign.c:427
ExecForeignInsert_function ExecForeignInsert
Definition: fdwapi.h:211
void(* BeginForeignInsert_function)(ModifyTableState *mtstate, ResultRelInfo *rinfo)
Definition: fdwapi.h:101
FdwRoutine * GetFdwRoutine(Oid fdwhandler)
Definition: foreign.c:319
void(* EndForeignModify_function)(EState *estate, ResultRelInfo *rinfo)
Definition: fdwapi.h:98
void(* BeginForeignScan_function)(ForeignScanState *node, int eflags)
Definition: fdwapi.h:43
uint32 BlockNumber
Definition: block.h:31
void(* ExplainDirectModify_function)(ForeignScanState *node, struct ExplainState *es)
Definition: fdwapi.h:139
void(* ReInitializeDSMForeignScan_function)(ForeignScanState *node, ParallelContext *pcxt, void *coordinate)
Definition: fdwapi.h:159
bool(* RecheckForeignScan_function)(ForeignScanState *node, TupleTableSlot *slot)
Definition: fdwapi.h:48
unsigned int Oid
Definition: postgres_ext.h:31
NodeTag
Definition: nodes.h:26
bool IsImportableForeignTable(const char *tablename, ImportForeignSchemaStmt *stmt)
Definition: foreign.c:467
AddForeignUpdateTargets_function AddForeignUpdateTargets
Definition: fdwapi.h:208
JoinType
Definition: nodes.h:692
List *(* PlanForeignModify_function)(PlannerInfo *root, ModifyTable *plan, Index resultRelation, int subplan_index)
Definition: fdwapi.h:72
RecheckForeignScan_function RecheckForeignScan
Definition: fdwapi.h:226
IterateDirectModify_function IterateDirectModify
Definition: fdwapi.h:220
int(* IsForeignRelUpdatable_function)(Relation rel)
Definition: fdwapi.h:107
ForeignScan *(* GetForeignPlan_function)(PlannerInfo *root, RelOptInfo *baserel, Oid foreigntableid, ForeignPath *best_path, List *tlist, List *scan_clauses, Plan *outer_plan)
Definition: fdwapi.h:35
void(* BeginDirectModify_function)(ForeignScanState *node, int eflags)
Definition: fdwapi.h:114
NodeTag type
Definition: fdwapi.h:185
IsForeignScanParallelSafe_function IsForeignScanParallelSafe
Definition: fdwapi.h:240
void(* GetForeignRelSize_function)(PlannerInfo *root, RelOptInfo *baserel, Oid foreigntableid)
Definition: fdwapi.h:27
void(* GetForeignPaths_function)(PlannerInfo *root, RelOptInfo *baserel, Oid foreigntableid)
Definition: fdwapi.h:31
GetForeignJoinPaths_function GetForeignJoinPaths
Definition: fdwapi.h:202
TupleTableSlot *(* ExecForeignDelete_function)(EState *estate, ResultRelInfo *rinfo, TupleTableSlot *slot, TupleTableSlot *planSlot)
Definition: fdwapi.h:93
TupleTableSlot *(* ExecForeignInsert_function)(EState *estate, ResultRelInfo *rinfo, TupleTableSlot *slot, TupleTableSlot *planSlot)
Definition: fdwapi.h:83
GetForeignRelSize_function GetForeignRelSize
Definition: fdwapi.h:188
EndForeignScan_function EndForeignScan
Definition: fdwapi.h:194
ExplainDirectModify_function ExplainDirectModify
Definition: fdwapi.h:231
void(* EndDirectModify_function)(ForeignScanState *node)
Definition: fdwapi.h:119
bool(* IsForeignScanParallelSafe_function)(PlannerInfo *root, RelOptInfo *rel, RangeTblEntry *rte)
Definition: fdwapi.h:166
void(* BeginForeignModify_function)(ModifyTableState *mtstate, ResultRelInfo *rinfo, List *fdw_private, int subplan_index, int eflags)
Definition: fdwapi.h:77
ImportForeignSchema_function ImportForeignSchema
Definition: fdwapi.h:237
PlanForeignModify_function PlanForeignModify
Definition: fdwapi.h:209
EndForeignModify_function EndForeignModify
Definition: fdwapi.h:214
TupleTableSlot *(* IterateForeignScan_function)(ForeignScanState *node)
Definition: fdwapi.h:46
GetForeignPaths_function GetForeignPaths
Definition: fdwapi.h:189
PlanDirectModify_function PlanDirectModify
Definition: fdwapi.h:218
FdwRoutine * GetFdwRoutineByRelId(Oid relid)
Definition: foreign.c:404
static int elevel
Definition: vacuumlazy.c:143
BeginDirectModify_function BeginDirectModify
Definition: fdwapi.h:219
LockClauseStrength
Definition: lockoptions.h:21
uintptr_t Datum
Definition: postgres.h:367
void(* RefetchForeignRow_function)(EState *estate, ExecRowMark *erm, Datum rowid, TupleTableSlot *slot, bool *updated)
Definition: fdwapi.h:124
GetForeignRowMarkType_function GetForeignRowMarkType
Definition: fdwapi.h:224
unsigned int Index
Definition: c.h:475
InitializeDSMForeignScan_function InitializeDSMForeignScan
Definition: fdwapi.h:242
bool(* PlanDirectModify_function)(PlannerInfo *root, ModifyTable *plan, Index resultRelation, int subplan_index)
Definition: fdwapi.h:109
ExecForeignUpdate_function ExecForeignUpdate
Definition: fdwapi.h:212
void(* ExplainForeignScan_function)(ForeignScanState *node, struct ExplainState *es)
Definition: fdwapi.h:130
ReScanForeignScan_function ReScanForeignScan
Definition: fdwapi.h:193
bool(* AnalyzeForeignTable_function)(Relation relation, AcquireSampleRowsFunc *func, BlockNumber *totalpages)
Definition: fdwapi.h:147
List *(* ImportForeignSchema_function)(ImportForeignSchemaStmt *stmt, Oid serverOid)
Definition: fdwapi.h:151
IterateForeignScan_function IterateForeignScan
Definition: fdwapi.h:192
size_t Size
Definition: c.h:466
void(* ReScanForeignScan_function)(ForeignScanState *node)
Definition: fdwapi.h:51
void(* GetForeignUpperPaths_function)(PlannerInfo *root, UpperRelationKind stage, RelOptInfo *input_rel, RelOptInfo *output_rel, void *extra)
Definition: fdwapi.h:62
RowMarkType
Definition: plannodes.h:1003
FdwRoutine * GetFdwRoutineByServerId(Oid serverid)
Definition: foreign.c:362
TupleTableSlot *(* IterateDirectModify_function)(ForeignScanState *node)
Definition: fdwapi.h:117
void(* EndForeignInsert_function)(EState *estate, ResultRelInfo *rinfo)
Definition: fdwapi.h:104
struct FdwRoutine FdwRoutine
void(* InitializeWorkerForeignScan_function)(ForeignScanState *node, shm_toc *toc, void *coordinate)
Definition: fdwapi.h:162
ReInitializeDSMForeignScan_function ReInitializeDSMForeignScan
Definition: fdwapi.h:243
ShutdownForeignScan_function ShutdownForeignScan
Definition: fdwapi.h:245
int(* AcquireSampleRowsFunc)(Relation relation, int elevel, HeapTuple *rows, int targrows, double *totalrows, double *totaldeadrows)
Definition: fdwapi.h:142
void(* InitializeDSMForeignScan_function)(ForeignScanState *node, ParallelContext *pcxt, void *coordinate)
Definition: fdwapi.h:156
RowMarkType(* GetForeignRowMarkType_function)(RangeTblEntry *rte, LockClauseStrength strength)
Definition: fdwapi.h:121
ExplainForeignModify_function ExplainForeignModify
Definition: fdwapi.h:230
IsForeignRelUpdatable_function IsForeignRelUpdatable
Definition: fdwapi.h:217
Oid GetForeignServerIdByRelId(Oid relid)
Definition: foreign.c:340
List *(* ReparameterizeForeignPathByChild_function)(PlannerInfo *root, List *fdw_private, RelOptInfo *child_rel)
Definition: fdwapi.h:169
void(* ShutdownForeignScan_function)(ForeignScanState *node)
Definition: fdwapi.h:165
BeginForeignModify_function BeginForeignModify
Definition: fdwapi.h:210
Definition: pg_list.h:50
void(* ExplainForeignModify_function)(ModifyTableState *mtstate, ResultRelInfo *rinfo, List *fdw_private, int subplan_index, struct ExplainState *es)
Definition: fdwapi.h:133
TupleTableSlot *(* ExecForeignUpdate_function)(EState *estate, ResultRelInfo *rinfo, TupleTableSlot *slot, TupleTableSlot *planSlot)
Definition: fdwapi.h:88
EndForeignInsert_function EndForeignInsert
Definition: fdwapi.h:216
RefetchForeignRow_function RefetchForeignRow
Definition: fdwapi.h:225
unsigned char bool
Definition: c.h:308
ReparameterizeForeignPathByChild_function ReparameterizeForeignPathByChild
Definition: fdwapi.h:248