PostgreSQL Source Code  git master
pathnode.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * pathnode.h
4  * prototypes for pathnode.c, relnode.c.
5  *
6  *
7  * Portions Copyright (c) 1996-2022, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/optimizer/pathnode.h
11  *
12  *-------------------------------------------------------------------------
13  */
14 #ifndef PATHNODE_H
15 #define PATHNODE_H
16 
17 #include "nodes/bitmapset.h"
18 #include "nodes/pathnodes.h"
19 
20 
21 /*
22  * prototypes for pathnode.c
23  */
24 extern int compare_path_costs(Path *path1, Path *path2,
25  CostSelector criterion);
26 extern int compare_fractional_path_costs(Path *path1, Path *path2,
27  double fraction);
28 extern void set_cheapest(RelOptInfo *parent_rel);
29 extern void add_path(RelOptInfo *parent_rel, Path *new_path);
30 extern bool add_path_precheck(RelOptInfo *parent_rel,
31  Cost startup_cost, Cost total_cost,
32  List *pathkeys, Relids required_outer);
33 extern void add_partial_path(RelOptInfo *parent_rel, Path *new_path);
34 extern bool add_partial_path_precheck(RelOptInfo *parent_rel,
35  Cost total_cost, List *pathkeys);
36 
38  Relids required_outer, int parallel_workers);
40  Relids required_outer);
43  List *indexclauses,
44  List *indexorderbys,
45  List *indexorderbycols,
46  List *pathkeys,
47  ScanDirection indexscandir,
48  bool indexonly,
49  Relids required_outer,
50  double loop_count,
51  bool partial_path);
53  RelOptInfo *rel,
54  Path *bitmapqual,
55  Relids required_outer,
56  double loop_count,
57  int parallel_degree);
59  RelOptInfo *rel,
60  List *bitmapquals);
62  RelOptInfo *rel,
63  List *bitmapquals);
65  List *tidquals, Relids required_outer);
67  RelOptInfo *rel,
68  List *tidrangequals,
69  Relids required_outer);
71  List *subpaths, List *partial_subpaths,
72  List *pathkeys, Relids required_outer,
73  int parallel_workers, bool parallel_aware,
74  double rows);
76  RelOptInfo *rel,
77  List *subpaths,
78  List *pathkeys,
79  Relids required_outer);
81  RelOptInfo *rel,
82  PathTarget *target,
83  List *havingqual);
86  RelOptInfo *rel,
87  Path *subpath,
88  List *param_exprs,
89  List *hash_operators,
90  bool singlerow,
91  bool binary_mode,
92  double calls);
94  Path *subpath, SpecialJoinInfo *sjinfo);
96  RelOptInfo *rel, Path *subpath, PathTarget *target,
97  Relids required_outer, double *rows);
99  RelOptInfo *rel,
100  Path *subpath,
101  PathTarget *target,
102  List *pathkeys,
103  Relids required_outer,
104  double *rows);
106  RelOptInfo *rel,
107  Path *subpath,
108  bool trivial_pathtarget,
109  List *pathkeys,
110  Relids required_outer);
112  List *pathkeys, Relids required_outer);
114  Relids required_outer);
116  Relids required_outer);
117 extern Path *create_ctescan_path(PlannerInfo *root, RelOptInfo *rel,
118  Relids required_outer);
120  Relids required_outer);
122  Relids required_outer);
124  Relids required_outer);
126  PathTarget *target,
127  double rows, Cost startup_cost, Cost total_cost,
128  List *pathkeys,
129  Relids required_outer,
130  Path *fdw_outerpath,
131  List *fdw_private);
133  PathTarget *target,
134  double rows, Cost startup_cost, Cost total_cost,
135  List *pathkeys,
136  Relids required_outer,
137  Path *fdw_outerpath,
138  List *fdw_private);
140  PathTarget *target,
141  double rows, Cost startup_cost, Cost total_cost,
142  List *pathkeys,
143  Path *fdw_outerpath,
144  List *fdw_private);
145 
146 extern Relids calc_nestloop_required_outer(Relids outerrelids,
147  Relids outer_paramrels,
148  Relids innerrelids,
149  Relids inner_paramrels);
150 extern Relids calc_non_nestloop_required_outer(Path *outer_path, Path *inner_path);
151 
153  RelOptInfo *joinrel,
154  JoinType jointype,
155  JoinCostWorkspace *workspace,
156  JoinPathExtraData *extra,
157  Path *outer_path,
158  Path *inner_path,
159  List *restrict_clauses,
160  List *pathkeys,
161  Relids required_outer);
162 
164  RelOptInfo *joinrel,
165  JoinType jointype,
166  JoinCostWorkspace *workspace,
167  JoinPathExtraData *extra,
168  Path *outer_path,
169  Path *inner_path,
170  List *restrict_clauses,
171  List *pathkeys,
172  Relids required_outer,
173  List *mergeclauses,
174  List *outersortkeys,
175  List *innersortkeys);
176 
178  RelOptInfo *joinrel,
179  JoinType jointype,
180  JoinCostWorkspace *workspace,
181  JoinPathExtraData *extra,
182  Path *outer_path,
183  Path *inner_path,
184  bool parallel_hash,
185  List *restrict_clauses,
186  Relids required_outer,
187  List *hashclauses);
188 
190  RelOptInfo *rel,
191  Path *subpath,
192  PathTarget *target);
194  RelOptInfo *rel,
195  Path *path,
196  PathTarget *target);
198  RelOptInfo *rel,
199  Path *subpath,
200  PathTarget *target);
202  RelOptInfo *rel,
203  Path *subpath,
204  List *pathkeys,
205  double limit_tuples);
207  RelOptInfo *rel,
208  Path *subpath,
209  List *pathkeys,
210  int presorted_keys,
211  double limit_tuples);
213  RelOptInfo *rel,
214  Path *subpath,
215  List *groupClause,
216  List *qual,
217  double numGroups);
219  RelOptInfo *rel,
220  Path *subpath,
221  int numCols,
222  double numGroups);
223 extern AggPath *create_agg_path(PlannerInfo *root,
224  RelOptInfo *rel,
225  Path *subpath,
226  PathTarget *target,
227  AggStrategy aggstrategy,
228  AggSplit aggsplit,
229  List *groupClause,
230  List *qual,
231  const AggClauseCosts *aggcosts,
232  double numGroups);
234  RelOptInfo *rel,
235  Path *subpath,
236  List *having_qual,
237  AggStrategy aggstrategy,
238  List *rollups,
239  const AggClauseCosts *agg_costs);
241  RelOptInfo *rel,
242  PathTarget *target,
243  List *mmaggregates,
244  List *quals);
246  RelOptInfo *rel,
247  Path *subpath,
248  PathTarget *target,
249  List *windowFuncs,
250  WindowClause *winclause,
251  List *qual,
252  bool topwindow);
254  RelOptInfo *rel,
255  Path *subpath,
256  SetOpCmd cmd,
257  SetOpStrategy strategy,
258  List *distinctList,
259  AttrNumber flagColIdx,
260  int firstFlag,
261  double numGroups,
262  double outputRows);
264  RelOptInfo *rel,
265  Path *leftpath,
266  Path *rightpath,
267  PathTarget *target,
268  List *distinctList,
269  int wtParam,
270  double numGroups);
272  Path *subpath, List *rowMarks, int epqParam);
274  RelOptInfo *rel,
275  Path *subpath,
276  CmdType operation, bool canSetTag,
277  Index nominalRelation, Index rootRelation,
278  bool partColsUpdated,
279  List *resultRelations,
280  List *updateColnosLists,
281  List *withCheckOptionLists, List *returningLists,
282  List *rowMarks, OnConflictExpr *onconflict,
283  List *mergeActionLists, int epqParam);
285  Path *subpath,
286  Node *limitOffset, Node *limitCount,
287  LimitOption limitOption,
288  int64 offset_est, int64 count_est);
289 extern void adjust_limit_rows_costs(double *rows,
290  Cost *startup_cost, Cost *total_cost,
291  int64 offset_est, int64 count_est);
292 
293 extern Path *reparameterize_path(PlannerInfo *root, Path *path,
294  Relids required_outer,
295  double loop_count);
297  RelOptInfo *child_rel);
298 
299 /*
300  * prototypes for relnode.c
301  */
302 extern void setup_simple_rel_arrays(PlannerInfo *root);
303 extern void expand_planner_arrays(PlannerInfo *root, int add_size);
304 extern RelOptInfo *build_simple_rel(PlannerInfo *root, int relid,
305  RelOptInfo *parent);
306 extern RelOptInfo *find_base_rel(PlannerInfo *root, int relid);
307 extern RelOptInfo *find_join_rel(PlannerInfo *root, Relids relids);
309  Relids joinrelids,
310  RelOptInfo *outer_rel,
311  RelOptInfo *inner_rel,
312  SpecialJoinInfo *sjinfo,
313  List **restrictlist_ptr);
315  Relids joinrelids,
316  RelOptInfo *outer_rel,
317  RelOptInfo *inner_rel);
319  Relids relids);
322  RelOptInfo *baserel,
323  Relids required_outer);
325  RelOptInfo *joinrel,
326  Path *outer_path,
327  Path *inner_path,
328  SpecialJoinInfo *sjinfo,
329  Relids required_outer,
330  List **restrict_clauses);
332  Relids required_outer);
334  Relids required_outer);
336  RelOptInfo *outer_rel, RelOptInfo *inner_rel,
337  RelOptInfo *parent_joinrel, List *restrictlist,
338  SpecialJoinInfo *sjinfo, JoinType jointype);
339 
340 #endif /* PATHNODE_H */
int16 AttrNumber
Definition: attnum.h:21
unsigned int Index
Definition: c.h:550
Datum subpath(PG_FUNCTION_ARGS)
Definition: ltree_op.c:241
SetOpCmd
Definition: nodes.h:388
SetOpStrategy
Definition: nodes.h:396
double Cost
Definition: nodes.h:245
CmdType
Definition: nodes.h:257
AggStrategy
Definition: nodes.h:344
AggSplit
Definition: nodes.h:366
LimitOption
Definition: nodes.h:421
JoinType
Definition: nodes.h:282
ForeignPath * create_foreign_upper_path(PlannerInfo *root, RelOptInfo *rel, PathTarget *target, double rows, Cost startup_cost, Cost total_cost, List *pathkeys, Path *fdw_outerpath, List *fdw_private)
Definition: pathnode.c:2320
AppendPath * create_append_path(PlannerInfo *root, RelOptInfo *rel, List *subpaths, List *partial_subpaths, List *pathkeys, Relids required_outer, int parallel_workers, bool parallel_aware, double rows)
Definition: pathnode.c:1244
void setup_simple_rel_arrays(PlannerInfo *root)
Definition: relnode.c:83
SortPath * create_sort_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *pathkeys, double limit_tuples)
Definition: pathnode.c:2961
TidPath * create_tidscan_path(PlannerInfo *root, RelOptInfo *rel, List *tidquals, Relids required_outer)
Definition: pathnode.c:1183
ParamPathInfo * get_baserel_parampathinfo(PlannerInfo *root, RelOptInfo *baserel, Relids required_outer)
Definition: relnode.c:1298
GroupResultPath * create_group_result_path(PlannerInfo *root, RelOptInfo *rel, PathTarget *target, List *havingqual)
Definition: pathnode.c:1516
NestPath * create_nestloop_path(PlannerInfo *root, RelOptInfo *joinrel, JoinType jointype, JoinCostWorkspace *workspace, JoinPathExtraData *extra, Path *outer_path, Path *inner_path, List *restrict_clauses, List *pathkeys, Relids required_outer)
Definition: pathnode.c:2426
Relids calc_non_nestloop_required_outer(Path *outer_path, Path *inner_path)
Definition: pathnode.c:2393
UniquePath * create_unique_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, SpecialJoinInfo *sjinfo)
Definition: pathnode.c:1652
WindowAggPath * create_windowagg_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target, List *windowFuncs, WindowClause *winclause, List *qual, bool topwindow)
Definition: pathnode.c:3417
IndexPath * create_index_path(PlannerInfo *root, IndexOptInfo *index, List *indexclauses, List *indexorderbys, List *indexorderbycols, List *pathkeys, ScanDirection indexscandir, bool indexonly, Relids required_outer, double loop_count, bool partial_path)
Definition: pathnode.c:997
LimitPath * create_limit_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, Node *limitOffset, Node *limitCount, LimitOption limitOption, int64 offset_est, int64 count_est)
Definition: pathnode.c:3754
ForeignPath * create_foreignscan_path(PlannerInfo *root, RelOptInfo *rel, PathTarget *target, double rows, Cost startup_cost, Cost total_cost, List *pathkeys, Relids required_outer, Path *fdw_outerpath, List *fdw_private)
Definition: pathnode.c:2226
ProjectionPath * create_projection_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target)
Definition: pathnode.c:2646
GatherMergePath * create_gather_merge_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target, List *pathkeys, Relids required_outer, double *rows)
Definition: pathnode.c:1873
UpperUniquePath * create_upper_unique_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, int numCols, double numGroups)
Definition: pathnode.c:3064
Relids calc_nestloop_required_outer(Relids outerrelids, Relids outer_paramrels, Relids innerrelids, Relids inner_paramrels)
Definition: pathnode.c:2360
Path * create_tablefuncscan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2064
Path * create_namedtuplestorescan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2141
Relids min_join_parameterization(PlannerInfo *root, Relids joinrelids, RelOptInfo *outer_rel, RelOptInfo *inner_rel)
Definition: relnode.c:918
LockRowsPath * create_lockrows_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *rowMarks, int epqParam)
Definition: pathnode.c:3593
RelOptInfo * find_base_rel(PlannerInfo *root, int relid)
Definition: relnode.c:360
ParamPathInfo * get_appendrel_parampathinfo(RelOptInfo *appendrel, Relids required_outer)
Definition: relnode.c:1595
RelOptInfo * build_simple_rel(PlannerInfo *root, int relid, RelOptInfo *parent)
Definition: relnode.c:181
Path * reparameterize_path_by_child(PlannerInfo *root, Path *path, RelOptInfo *child_rel)
Definition: pathnode.c:4019
MergePath * create_mergejoin_path(PlannerInfo *root, RelOptInfo *joinrel, JoinType jointype, JoinCostWorkspace *workspace, JoinPathExtraData *extra, Path *outer_path, Path *inner_path, List *restrict_clauses, List *pathkeys, Relids required_outer, List *mergeclauses, List *outersortkeys, List *innersortkeys)
Definition: pathnode.c:2514
GatherPath * create_gather_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target, Relids required_outer, double *rows)
Definition: pathnode.c:1964
Path * create_resultscan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2167
Path * create_samplescan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:954
MemoizePath * create_memoize_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *param_exprs, List *hash_operators, bool singlerow, bool binary_mode, double calls)
Definition: pathnode.c:1596
MergeAppendPath * create_merge_append_path(PlannerInfo *root, RelOptInfo *rel, List *subpaths, List *pathkeys, Relids required_outer)
Definition: pathnode.c:1413
void set_cheapest(RelOptInfo *parent_rel)
Definition: pathnode.c:244
Relids find_childrel_parents(PlannerInfo *root, RelOptInfo *rel)
Definition: relnode.c:1262
Path * reparameterize_path(PlannerInfo *root, Path *path, Relids required_outer, double loop_count)
Definition: pathnode.c:3877
void expand_planner_arrays(PlannerInfo *root, int add_size)
Definition: relnode.c:152
ProjectSetPath * create_set_projection_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target)
Definition: pathnode.c:2843
SubqueryScanPath * create_subqueryscan_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, bool trivial_pathtarget, List *pathkeys, Relids required_outer)
Definition: pathnode.c:2008
RelOptInfo * find_join_rel(PlannerInfo *root, Relids relids)
Definition: relnode.c:424
Path * create_ctescan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2116
void add_partial_path(RelOptInfo *parent_rel, Path *new_path)
Definition: pathnode.c:749
ParamPathInfo * get_joinrel_parampathinfo(PlannerInfo *root, RelOptInfo *joinrel, Path *outer_path, Path *inner_path, SpecialJoinInfo *sjinfo, Relids required_outer, List **restrict_clauses)
Definition: relnode.c:1388
MaterialPath * create_material_path(RelOptInfo *rel, Path *subpath)
Definition: pathnode.c:1564
Path * create_functionscan_path(PlannerInfo *root, RelOptInfo *rel, List *pathkeys, Relids required_outer)
Definition: pathnode.c:2038
BitmapOrPath * create_bitmap_or_path(PlannerInfo *root, RelOptInfo *rel, List *bitmapquals)
Definition: pathnode.c:1131
int compare_fractional_path_costs(Path *path1, Path *path2, double fraction)
Definition: pathnode.c:117
GroupPath * create_group_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *groupClause, List *qual, double numGroups)
Definition: pathnode.c:3005
ForeignPath * create_foreign_join_path(PlannerInfo *root, RelOptInfo *rel, PathTarget *target, double rows, Cost startup_cost, Cost total_cost, List *pathkeys, Relids required_outer, Path *fdw_outerpath, List *fdw_private)
Definition: pathnode.c:2270
HashPath * create_hashjoin_path(PlannerInfo *root, RelOptInfo *joinrel, JoinType jointype, JoinCostWorkspace *workspace, JoinPathExtraData *extra, Path *outer_path, Path *inner_path, bool parallel_hash, List *restrict_clauses, Relids required_outer, List *hashclauses)
Definition: pathnode.c:2580
bool add_partial_path_precheck(RelOptInfo *parent_rel, Cost total_cost, List *pathkeys)
Definition: pathnode.c:867
GroupingSetsPath * create_groupingsets_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *having_qual, AggStrategy aggstrategy, List *rollups, const AggClauseCosts *agg_costs)
Definition: pathnode.c:3182
SetOpPath * create_setop_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, SetOpCmd cmd, SetOpStrategy strategy, List *distinctList, AttrNumber flagColIdx, int firstFlag, double numGroups, double outputRows)
Definition: pathnode.c:3486
RelOptInfo * build_join_rel(PlannerInfo *root, Relids joinrelids, RelOptInfo *outer_rel, RelOptInfo *inner_rel, SpecialJoinInfo *sjinfo, List **restrictlist_ptr)
Definition: relnode.c:562
RecursiveUnionPath * create_recursiveunion_path(PlannerInfo *root, RelOptInfo *rel, Path *leftpath, Path *rightpath, PathTarget *target, List *distinctList, int wtParam, double numGroups)
Definition: pathnode.c:3548
IncrementalSortPath * create_incremental_sort_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *pathkeys, int presorted_keys, double limit_tuples)
Definition: pathnode.c:2912
MinMaxAggPath * create_minmaxagg_path(PlannerInfo *root, RelOptInfo *rel, PathTarget *target, List *mmaggregates, List *quals)
Definition: pathnode.c:3342
ModifyTablePath * create_modifytable_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, CmdType operation, bool canSetTag, Index nominalRelation, Index rootRelation, bool partColsUpdated, List *resultRelations, List *updateColnosLists, List *withCheckOptionLists, List *returningLists, List *rowMarks, OnConflictExpr *onconflict, List *mergeActionLists, int epqParam)
Definition: pathnode.c:3655
Path * create_worktablescan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2193
AggPath * create_agg_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target, AggStrategy aggstrategy, AggSplit aggsplit, List *groupClause, List *qual, const AggClauseCosts *aggcosts, double numGroups)
Definition: pathnode.c:3116
void add_path(RelOptInfo *parent_rel, Path *new_path)
Definition: pathnode.c:422
Path * create_valuesscan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2090
int compare_path_costs(Path *path1, Path *path2, CostSelector criterion)
Definition: pathnode.c:71
ParamPathInfo * find_param_path_info(RelOptInfo *rel, Relids required_outer)
Definition: relnode.c:1627
Path * apply_projection_to_path(PlannerInfo *root, RelOptInfo *rel, Path *path, PathTarget *target)
Definition: pathnode.c:2754
BitmapAndPath * create_bitmap_and_path(PlannerInfo *root, RelOptInfo *rel, List *bitmapquals)
Definition: pathnode.c:1079
TidRangePath * create_tidrangescan_path(PlannerInfo *root, RelOptInfo *rel, List *tidrangequals, Relids required_outer)
Definition: pathnode.c:1212
Path * create_seqscan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer, int parallel_workers)
Definition: pathnode.c:929
void adjust_limit_rows_costs(double *rows, Cost *startup_cost, Cost *total_cost, int64 offset_est, int64 count_est)
Definition: pathnode.c:3809
RelOptInfo * fetch_upper_rel(PlannerInfo *root, UpperRelationKind kind, Relids relids)
Definition: relnode.c:1211
RelOptInfo * build_child_join_rel(PlannerInfo *root, RelOptInfo *outer_rel, RelOptInfo *inner_rel, RelOptInfo *parent_joinrel, List *restrictlist, SpecialJoinInfo *sjinfo, JoinType jointype)
Definition: relnode.c:774
bool add_path_precheck(RelOptInfo *parent_rel, Cost startup_cost, Cost total_cost, List *pathkeys, Relids required_outer)
Definition: pathnode.c:644
BitmapHeapPath * create_bitmap_heap_path(PlannerInfo *root, RelOptInfo *rel, Path *bitmapqual, Relids required_outer, double loop_count, int parallel_degree)
Definition: pathnode.c:1046
CostSelector
Definition: pathnodes.h:37
UpperRelationKind
Definition: pathnodes.h:70
ScanDirection
Definition: sdir.h:23
Size add_size(Size s1, Size s2)
Definition: shmem.c:502
Definition: pg_list.h:52
Definition: nodes.h:112
Definition: type.h:95