Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit34ae182

Browse files
committed
doc: Make function synopsis formatting more uniform
Whitespace use was inconsistent in the same chapter.
1 parent1c53f61 commit34ae182

File tree

1 file changed

+90
-87
lines changed

1 file changed

+90
-87
lines changed

‎doc/src/sgml/fdwhandler.sgml

Lines changed: 90 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,9 @@
101101
<para>
102102
<programlisting>
103103
void
104-
GetForeignRelSize(PlannerInfo *root,
105-
RelOptInfo *baserel,
106-
Oid foreigntableid);
104+
GetForeignRelSize(PlannerInfo *root,
105+
RelOptInfo *baserel,
106+
Oid foreigntableid);
107107
</programlisting>
108108

109109
Obtain relation size estimates for a foreign table. This is called
@@ -132,9 +132,9 @@ GetForeignRelSize (PlannerInfo *root,
132132
<para>
133133
<programlisting>
134134
void
135-
GetForeignPaths(PlannerInfo *root,
136-
RelOptInfo *baserel,
137-
Oid foreigntableid);
135+
GetForeignPaths(PlannerInfo *root,
136+
RelOptInfo *baserel,
137+
Oid foreigntableid);
138138
</programlisting>
139139

140140
Create possible access paths for a scan on a foreign table.
@@ -163,13 +163,13 @@ GetForeignPaths (PlannerInfo *root,
163163
<para>
164164
<programlisting>
165165
ForeignScan *
166-
GetForeignPlan(PlannerInfo *root,
167-
RelOptInfo *baserel,
168-
Oid foreigntableid,
169-
ForeignPath *best_path,
170-
List *tlist,
171-
List *scan_clauses,
172-
Plan *outer_plan);
166+
GetForeignPlan(PlannerInfo *root,
167+
RelOptInfo *baserel,
168+
Oid foreigntableid,
169+
ForeignPath *best_path,
170+
List *tlist,
171+
List *scan_clauses,
172+
Plan *outer_plan);
173173
</programlisting>
174174

175175
Create a <structname>ForeignScan</> plan node from the selected foreign
@@ -199,8 +199,8 @@ GetForeignPlan (PlannerInfo *root,
199199
<para>
200200
<programlisting>
201201
void
202-
BeginForeignScan(ForeignScanState *node,
203-
int eflags);
202+
BeginForeignScan(ForeignScanState *node,
203+
int eflags);
204204
</programlisting>
205205

206206
Begin executing a foreign scan. This is called during executor startup.
@@ -227,7 +227,7 @@ BeginForeignScan (ForeignScanState *node,
227227
<para>
228228
<programlisting>
229229
TupleTableSlot *
230-
IterateForeignScan(ForeignScanState *node);
230+
IterateForeignScan(ForeignScanState *node);
231231
</programlisting>
232232

233233
Fetch one row from the foreign source, returning it in a tuple table slot
@@ -264,7 +264,7 @@ IterateForeignScan (ForeignScanState *node);
264264
<para>
265265
<programlisting>
266266
void
267-
ReScanForeignScan(ForeignScanState *node);
267+
ReScanForeignScan(ForeignScanState *node);
268268
</programlisting>
269269

270270
Restart the scan from the beginning. Note that any parameters the
@@ -275,7 +275,7 @@ ReScanForeignScan (ForeignScanState *node);
275275
<para>
276276
<programlisting>
277277
void
278-
EndForeignScan(ForeignScanState *node);
278+
EndForeignScan(ForeignScanState *node);
279279
</programlisting>
280280

281281
End the scan and release resources. It is normally not important
@@ -297,12 +297,12 @@ EndForeignScan (ForeignScanState *node);
297297
<para>
298298
<programlisting>
299299
void
300-
GetForeignJoinPaths(PlannerInfo *root,
301-
RelOptInfo *joinrel,
302-
RelOptInfo *outerrel,
303-
RelOptInfo *innerrel,
304-
JoinType jointype,
305-
JoinPathExtraData *extra);
300+
GetForeignJoinPaths(PlannerInfo *root,
301+
RelOptInfo *joinrel,
302+
RelOptInfo *outerrel,
303+
RelOptInfo *innerrel,
304+
JoinType jointype,
305+
JoinPathExtraData *extra);
306306
</programlisting>
307307
Create possible access paths for a join of two (or more) foreign tables
308308
that all belong to the same foreign server. This optional
@@ -356,10 +356,10 @@ GetForeignJoinPaths (PlannerInfo *root,
356356
<para>
357357
<programlisting>
358358
void
359-
GetForeignUpperPaths(PlannerInfo *root,
360-
UpperRelationKind stage,
361-
RelOptInfo *input_rel,
362-
RelOptInfo *output_rel);
359+
GetForeignUpperPaths(PlannerInfo *root,
360+
UpperRelationKind stage,
361+
RelOptInfo *input_rel,
362+
RelOptInfo *output_rel);
363363
</programlisting>
364364
Create possible access paths for <firstterm>upper relation</> processing,
365365
which is the planner's term for all post-scan/join query processing, such
@@ -404,9 +404,9 @@ GetForeignUpperPaths (PlannerInfo *root,
404404
<para>
405405
<programlisting>
406406
void
407-
AddForeignUpdateTargets(Query *parsetree,
408-
RangeTblEntry *target_rte,
409-
Relation target_relation);
407+
AddForeignUpdateTargets(Query *parsetree,
408+
RangeTblEntry *target_rte,
409+
Relation target_relation);
410410
</programlisting>
411411

412412
<command>UPDATE</> and <command>DELETE</> operations are performed
@@ -451,10 +451,10 @@ AddForeignUpdateTargets (Query *parsetree,
451451
<para>
452452
<programlisting>
453453
List *
454-
PlanForeignModify(PlannerInfo *root,
455-
ModifyTable *plan,
456-
Index resultRelation,
457-
int subplan_index);
454+
PlanForeignModify(PlannerInfo *root,
455+
ModifyTable *plan,
456+
Index resultRelation,
457+
int subplan_index);
458458
</programlisting>
459459

460460
Perform any additional planning actions needed for an insert, update, or
@@ -490,11 +490,11 @@ PlanForeignModify (PlannerInfo *root,
490490
<para>
491491
<programlisting>
492492
void
493-
BeginForeignModify(ModifyTableState *mtstate,
494-
ResultRelInfo *rinfo,
495-
List *fdw_private,
496-
int subplan_index,
497-
int eflags);
493+
BeginForeignModify(ModifyTableState *mtstate,
494+
ResultRelInfo *rinfo,
495+
List *fdw_private,
496+
int subplan_index,
497+
int eflags);
498498
</programlisting>
499499

500500
Begin executing a foreign table modification operation. This routine is
@@ -536,10 +536,10 @@ BeginForeignModify (ModifyTableState *mtstate,
536536
<para>
537537
<programlisting>
538538
TupleTableSlot *
539-
ExecForeignInsert(EState *estate,
540-
ResultRelInfo *rinfo,
541-
TupleTableSlot *slot,
542-
TupleTableSlot *planSlot);
539+
ExecForeignInsert(EState *estate,
540+
ResultRelInfo *rinfo,
541+
TupleTableSlot *slot,
542+
TupleTableSlot *planSlot);
543543
</programlisting>
544544

545545
Insert one tuple into the foreign table.
@@ -582,10 +582,10 @@ ExecForeignInsert (EState *estate,
582582
<para>
583583
<programlisting>
584584
TupleTableSlot *
585-
ExecForeignUpdate(EState *estate,
586-
ResultRelInfo *rinfo,
587-
TupleTableSlot *slot,
588-
TupleTableSlot *planSlot);
585+
ExecForeignUpdate(EState *estate,
586+
ResultRelInfo *rinfo,
587+
TupleTableSlot *slot,
588+
TupleTableSlot *planSlot);
589589
</programlisting>
590590

591591
Update one tuple in the foreign table.
@@ -628,10 +628,10 @@ ExecForeignUpdate (EState *estate,
628628
<para>
629629
<programlisting>
630630
TupleTableSlot *
631-
ExecForeignDelete(EState *estate,
632-
ResultRelInfo *rinfo,
633-
TupleTableSlot *slot,
634-
TupleTableSlot *planSlot);
631+
ExecForeignDelete(EState *estate,
632+
ResultRelInfo *rinfo,
633+
TupleTableSlot *slot,
634+
TupleTableSlot *planSlot);
635635
</programlisting>
636636

637637
Delete one tuple from the foreign table.
@@ -672,8 +672,8 @@ ExecForeignDelete (EState *estate,
672672
<para>
673673
<programlisting>
674674
void
675-
EndForeignModify(EState *estate,
676-
ResultRelInfo *rinfo);
675+
EndForeignModify(EState *estate,
676+
ResultRelInfo *rinfo);
677677
</programlisting>
678678

679679
End the table update and release resources. It is normally not important
@@ -689,7 +689,7 @@ EndForeignModify (EState *estate,
689689
<para>
690690
<programlisting>
691691
int
692-
IsForeignRelUpdatable(Relation rel);
692+
IsForeignRelUpdatable(Relation rel);
693693
</programlisting>
694694

695695
Report which update operations the specified foreign table supports.
@@ -729,10 +729,10 @@ IsForeignRelUpdatable (Relation rel);
729729
<para>
730730
<programlisting>
731731
bool
732-
PlanDirectModify(PlannerInfo *root,
733-
ModifyTable *plan,
734-
Index resultRelation,
735-
int subplan_index);
732+
PlanDirectModify(PlannerInfo *root,
733+
ModifyTable *plan,
734+
Index resultRelation,
735+
int subplan_index);
736736
</programlisting>
737737

738738
Decide whether it is safe to execute a direct modification
@@ -771,8 +771,8 @@ PlanDirectModify (PlannerInfo *root,
771771
<para>
772772
<programlisting>
773773
void
774-
BeginDirectModify(ForeignScanState *node,
775-
int eflags);
774+
BeginDirectModify(ForeignScanState *node,
775+
int eflags);
776776
</programlisting>
777777

778778
Prepare to execute a direct modification on the remote server.
@@ -805,7 +805,7 @@ BeginDirectModify (ForeignScanState *node,
805805
<para>
806806
<programlisting>
807807
TupleTableSlot *
808-
IterateDirectModify(ForeignScanState *node);
808+
IterateDirectModify(ForeignScanState *node);
809809
</programlisting>
810810

811811
When the <command>INSERT</>, <command>UPDATE</> or <command>DELETE</>
@@ -851,7 +851,7 @@ IterateDirectModify (ForeignScanState *node);
851851
<para>
852852
<programlisting>
853853
void
854-
EndDirectModify(ForeignScanState *node);
854+
EndDirectModify(ForeignScanState *node);
855855
</programlisting>
856856

857857
Clean up following a direct modification on the remote server. It is
@@ -879,8 +879,8 @@ EndDirectModify (ForeignScanState *node);
879879
<para>
880880
<programlisting>
881881
RowMarkType
882-
GetForeignRowMarkType(RangeTblEntry *rte,
883-
LockClauseStrength strength);
882+
GetForeignRowMarkType(RangeTblEntry *rte,
883+
LockClauseStrength strength);
884884
</programlisting>
885885

886886
Report which row-marking option to use for a foreign table.
@@ -911,10 +911,10 @@ GetForeignRowMarkType (RangeTblEntry *rte,
911911
<para>
912912
<programlisting>
913913
HeapTuple
914-
RefetchForeignRow(EState *estate,
915-
ExecRowMark *erm,
916-
Datum rowid,
917-
bool *updated);
914+
RefetchForeignRow(EState *estate,
915+
ExecRowMark *erm,
916+
Datum rowid,
917+
bool *updated);
918918
</programlisting>
919919

920920
Re-fetch one tuple from the foreign table, after locking it if required.
@@ -970,7 +970,8 @@ RefetchForeignRow (EState *estate,
970970
<para>
971971
<programlisting>
972972
bool
973-
RecheckForeignScan (ForeignScanState *node, TupleTableSlot *slot);
973+
RecheckForeignScan(ForeignScanState *node,
974+
TupleTableSlot *slot);
974975
</programlisting>
975976
Recheck that a previously-returned tuple still matches the relevant
976977
scan and join qualifiers, and possibly provide a modified version of
@@ -1011,8 +1012,8 @@ RecheckForeignScan (ForeignScanState *node, TupleTableSlot *slot);
10111012
<para>
10121013
<programlisting>
10131014
void
1014-
ExplainForeignScan(ForeignScanState *node,
1015-
ExplainState *es);
1015+
ExplainForeignScan(ForeignScanState *node,
1016+
ExplainState *es);
10161017
</programlisting>
10171018

10181019
Print additional <command>EXPLAIN</> output for a foreign table scan.
@@ -1033,11 +1034,11 @@ ExplainForeignScan (ForeignScanState *node,
10331034
<para>
10341035
<programlisting>
10351036
void
1036-
ExplainForeignModify(ModifyTableState *mtstate,
1037-
ResultRelInfo *rinfo,
1038-
List *fdw_private,
1039-
int subplan_index,
1040-
struct ExplainState *es);
1037+
ExplainForeignModify(ModifyTableState *mtstate,
1038+
ResultRelInfo *rinfo,
1039+
List *fdw_private,
1040+
int subplan_index,
1041+
struct ExplainState *es);
10411042
</programlisting>
10421043

10431044
Print additional <command>EXPLAIN</> output for a foreign table update.
@@ -1059,8 +1060,8 @@ ExplainForeignModify (ModifyTableState *mtstate,
10591060
<para>
10601061
<programlisting>
10611062
void
1062-
ExplainDirectModify(ForeignScanState *node,
1063-
ExplainState *es);
1063+
ExplainDirectModify(ForeignScanState *node,
1064+
ExplainState *es);
10641065
</programlisting>
10651066

10661067
Print additional <command>EXPLAIN</> output for a direct modification
@@ -1087,9 +1088,9 @@ ExplainDirectModify (ForeignScanState *node,
10871088
<para>
10881089
<programlisting>
10891090
bool
1090-
AnalyzeForeignTable(Relation relation,
1091-
AcquireSampleRowsFunc *func,
1092-
BlockNumber *totalpages);
1091+
AnalyzeForeignTable(Relation relation,
1092+
AcquireSampleRowsFunc *func,
1093+
BlockNumber *totalpages);
10931094
</programlisting>
10941095

10951096
This function is called when <xref linkend="sql-analyze"> is executed on
@@ -1109,10 +1110,12 @@ AnalyzeForeignTable (Relation relation,
11091110
If provided, the sample collection function must have the signature
11101111
<programlisting>
11111112
int
1112-
AcquireSampleRowsFunc (Relation relation, int elevel,
1113-
HeapTuple *rows, int targrows,
1114-
double *totalrows,
1115-
double *totaldeadrows);
1113+
AcquireSampleRowsFunc(Relation relation,
1114+
int elevel,
1115+
HeapTuple *rows,
1116+
int targrows,
1117+
double *totalrows,
1118+
double *totaldeadrows);
11161119
</programlisting>
11171120

11181121
A random sample of up to <parameter>targrows</> rows should be collected
@@ -1132,7 +1135,7 @@ AcquireSampleRowsFunc (Relation relation, int elevel,
11321135
<para>
11331136
<programlisting>
11341137
List *
1135-
ImportForeignSchema(ImportForeignSchemaStmt *stmt, Oid serverOid);
1138+
ImportForeignSchema(ImportForeignSchemaStmt *stmt, Oid serverOid);
11361139
</programlisting>
11371140

11381141
Obtain a list of foreign table creation commands. This function is

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp