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-2021, 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  Path *subpath, SpecialJoinInfo *sjinfo);
88  RelOptInfo *rel, Path *subpath, PathTarget *target,
89  Relids required_outer, double *rows);
91  RelOptInfo *rel,
92  Path *subpath,
93  PathTarget *target,
94  List *pathkeys,
95  Relids required_outer,
96  double *rows);
98  RelOptInfo *rel, Path *subpath,
99  List *pathkeys, Relids required_outer);
101  List *pathkeys, Relids required_outer);
103  Relids required_outer);
105  Relids required_outer);
106 extern Path *create_ctescan_path(PlannerInfo *root, RelOptInfo *rel,
107  Relids required_outer);
109  Relids required_outer);
111  Relids required_outer);
113  Relids required_outer);
115  PathTarget *target,
116  double rows, Cost startup_cost, Cost total_cost,
117  List *pathkeys,
118  Relids required_outer,
119  Path *fdw_outerpath,
120  List *fdw_private);
122  PathTarget *target,
123  double rows, Cost startup_cost, Cost total_cost,
124  List *pathkeys,
125  Relids required_outer,
126  Path *fdw_outerpath,
127  List *fdw_private);
129  PathTarget *target,
130  double rows, Cost startup_cost, Cost total_cost,
131  List *pathkeys,
132  Path *fdw_outerpath,
133  List *fdw_private);
134 
135 extern Relids calc_nestloop_required_outer(Relids outerrelids,
136  Relids outer_paramrels,
137  Relids innerrelids,
138  Relids inner_paramrels);
139 extern Relids calc_non_nestloop_required_outer(Path *outer_path, Path *inner_path);
140 
142  RelOptInfo *joinrel,
143  JoinType jointype,
144  JoinCostWorkspace *workspace,
145  JoinPathExtraData *extra,
146  Path *outer_path,
147  Path *inner_path,
148  List *restrict_clauses,
149  List *pathkeys,
150  Relids required_outer);
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  List *mergeclauses,
163  List *outersortkeys,
164  List *innersortkeys);
165 
167  RelOptInfo *joinrel,
168  JoinType jointype,
169  JoinCostWorkspace *workspace,
170  JoinPathExtraData *extra,
171  Path *outer_path,
172  Path *inner_path,
173  bool parallel_hash,
174  List *restrict_clauses,
175  Relids required_outer,
176  List *hashclauses);
177 
179  RelOptInfo *rel,
180  Path *subpath,
181  PathTarget *target);
183  RelOptInfo *rel,
184  Path *path,
185  PathTarget *target);
187  RelOptInfo *rel,
188  Path *subpath,
189  PathTarget *target);
191  RelOptInfo *rel,
192  Path *subpath,
193  List *pathkeys,
194  double limit_tuples);
196  RelOptInfo *rel,
197  Path *subpath,
198  List *pathkeys,
199  int presorted_keys,
200  double limit_tuples);
202  RelOptInfo *rel,
203  Path *subpath,
204  List *groupClause,
205  List *qual,
206  double numGroups);
208  RelOptInfo *rel,
209  Path *subpath,
210  int numCols,
211  double numGroups);
212 extern AggPath *create_agg_path(PlannerInfo *root,
213  RelOptInfo *rel,
214  Path *subpath,
215  PathTarget *target,
216  AggStrategy aggstrategy,
217  AggSplit aggsplit,
218  List *groupClause,
219  List *qual,
220  const AggClauseCosts *aggcosts,
221  double numGroups);
223  RelOptInfo *rel,
224  Path *subpath,
225  List *having_qual,
226  AggStrategy aggstrategy,
227  List *rollups,
228  const AggClauseCosts *agg_costs,
229  double numGroups);
231  RelOptInfo *rel,
232  PathTarget *target,
233  List *mmaggregates,
234  List *quals);
236  RelOptInfo *rel,
237  Path *subpath,
238  PathTarget *target,
239  List *windowFuncs,
240  WindowClause *winclause);
242  RelOptInfo *rel,
243  Path *subpath,
244  SetOpCmd cmd,
245  SetOpStrategy strategy,
246  List *distinctList,
247  AttrNumber flagColIdx,
248  int firstFlag,
249  double numGroups,
250  double outputRows);
252  RelOptInfo *rel,
253  Path *leftpath,
254  Path *rightpath,
255  PathTarget *target,
256  List *distinctList,
257  int wtParam,
258  double numGroups);
260  Path *subpath, List *rowMarks, int epqParam);
262  RelOptInfo *rel,
263  CmdType operation, bool canSetTag,
264  Index nominalRelation, Index rootRelation,
265  bool partColsUpdated,
266  List *resultRelations, List *subpaths,
267  List *subroots,
268  List *withCheckOptionLists, List *returningLists,
269  List *rowMarks, OnConflictExpr *onconflict,
270  int epqParam);
272  Path *subpath,
273  Node *limitOffset, Node *limitCount,
274  LimitOption limitOption,
275  int64 offset_est, int64 count_est);
276 extern void adjust_limit_rows_costs(double *rows,
277  Cost *startup_cost, Cost *total_cost,
278  int64 offset_est, int64 count_est);
279 
280 extern Path *reparameterize_path(PlannerInfo *root, Path *path,
281  Relids required_outer,
282  double loop_count);
284  RelOptInfo *child_rel);
285 
286 /*
287  * prototypes for relnode.c
288  */
289 extern void setup_simple_rel_arrays(PlannerInfo *root);
290 extern void expand_planner_arrays(PlannerInfo *root, int add_size);
291 extern RelOptInfo *build_simple_rel(PlannerInfo *root, int relid,
292  RelOptInfo *parent);
293 extern RelOptInfo *find_base_rel(PlannerInfo *root, int relid);
294 extern RelOptInfo *find_join_rel(PlannerInfo *root, Relids relids);
296  Relids joinrelids,
297  RelOptInfo *outer_rel,
298  RelOptInfo *inner_rel,
299  SpecialJoinInfo *sjinfo,
300  List **restrictlist_ptr);
302  Relids joinrelids,
303  RelOptInfo *outer_rel,
304  RelOptInfo *inner_rel);
306  Relids relids);
309  RelOptInfo *baserel,
310  Relids required_outer);
312  RelOptInfo *joinrel,
313  Path *outer_path,
314  Path *inner_path,
315  SpecialJoinInfo *sjinfo,
316  Relids required_outer,
317  List **restrict_clauses);
319  Relids required_outer);
321  Relids required_outer);
323  RelOptInfo *outer_rel, RelOptInfo *inner_rel,
324  RelOptInfo *parent_joinrel, List *restrictlist,
325  SpecialJoinInfo *sjinfo, JoinType jointype);
326 
327 #endif /* PATHNODE_H */
Path * create_seqscan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer, int parallel_workers)
Definition: pathnode.c:929
bool add_path_precheck(RelOptInfo *parent_rel, Cost startup_cost, Cost total_cost, List *pathkeys, Relids required_outer)
Definition: pathnode.c:644
TidRangePath * create_tidrangescan_path(PlannerInfo *root, RelOptInfo *rel, List *tidrangequals, Relids required_outer)
Definition: pathnode.c:1212
void add_path(RelOptInfo *parent_rel, Path *new_path)
Definition: pathnode.c:422
void setup_simple_rel_arrays(PlannerInfo *root)
Definition: relnode.c:83
UpperRelationKind
Definition: pathnodes.h:67
Path * reparameterize_path(PlannerInfo *root, Path *path, Relids required_outer, double loop_count)
Definition: pathnode.c:3786
ProjectSetPath * create_set_projection_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target)
Definition: pathnode.c:2758
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:3392
RelOptInfo * find_join_rel(PlannerInfo *root, Relids relids)
Definition: relnode.c:438
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:3663
Definition: nodes.h:533
Path * create_namedtuplestorescan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2073
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:3031
IncrementalSortPath * create_incremental_sort_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *pathkeys, int presorted_keys, double limit_tuples)
Definition: pathnode.c:2827
RelOptInfo * find_base_rel(PlannerInfo *root, int relid)
Definition: relnode.c:374
MaterialPath * create_material_path(RelOptInfo *rel, Path *subpath)
Definition: pathnode.c:1552
ParamPathInfo * get_appendrel_parampathinfo(RelOptInfo *appendrel, Relids required_outer)
Definition: relnode.c:1575
void adjust_limit_rows_costs(double *rows, Cost *startup_cost, Cost *total_cost, int64 offset_est, int64 count_est)
Definition: pathnode.c:3718
Relids min_join_parameterization(PlannerInfo *root, Relids joinrelids, RelOptInfo *outer_rel, RelOptInfo *inner_rel)
Definition: relnode.c:928
SetOpStrategy
Definition: nodes.h:814
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:2446
JoinType
Definition: nodes.h:700
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:2920
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:2158
Definition: type.h:89
ParamPathInfo * get_baserel_parampathinfo(PlannerInfo *root, RelOptInfo *baserel, Relids required_outer)
Definition: relnode.c:1278
bool add_partial_path_precheck(RelOptInfo *parent_rel, Cost total_cost, List *pathkeys)
Definition: pathnode.c:867
RecursiveUnionPath * create_recursiveunion_path(PlannerInfo *root, RelOptInfo *rel, Path *leftpath, Path *rightpath, PathTarget *target, List *distinctList, int wtParam, double numGroups)
Definition: pathnode.c:3454
UniquePath * create_unique_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, SpecialJoinInfo *sjinfo)
Definition: pathnode.c:1591
int compare_path_costs(Path *path1, Path *path2, CostSelector criterion)
Definition: pathnode.c:71
Path * create_ctescan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2048
Path * create_tablefuncscan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:1996
Path * create_functionscan_path(PlannerInfo *root, RelOptInfo *rel, List *pathkeys, Relids required_outer)
Definition: pathnode.c:1970
Relids find_childrel_parents(PlannerInfo *root, RelOptInfo *rel)
Definition: relnode.c:1242
RelOptInfo * build_simple_rel(PlannerInfo *root, int relid, RelOptInfo *parent)
Definition: relnode.c:194
void set_cheapest(RelOptInfo *parent_rel)
Definition: pathnode.c:244
BitmapAndPath * create_bitmap_and_path(PlannerInfo *root, RelOptInfo *rel, List *bitmapquals)
Definition: pathnode.c:1079
RelOptInfo * build_join_rel(PlannerInfo *root, Relids joinrelids, RelOptInfo *outer_rel, RelOptInfo *inner_rel, SpecialJoinInfo *sjinfo, List **restrictlist_ptr)
Definition: relnode.c:576
GroupResultPath * create_group_result_path(PlannerInfo *root, RelOptInfo *rel, PathTarget *target, List *havingqual)
Definition: pathnode.c:1504
ScanDirection
Definition: sdir.h:22
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
LockRowsPath * create_lockrows_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *rowMarks, int epqParam)
Definition: pathnode.c:3499
ModifyTablePath * create_modifytable_path(PlannerInfo *root, RelOptInfo *rel, CmdType operation, bool canSetTag, Index nominalRelation, Index rootRelation, bool partColsUpdated, List *resultRelations, List *subpaths, List *subroots, List *withCheckOptionLists, List *returningLists, List *rowMarks, OnConflictExpr *onconflict, int epqParam)
Definition: pathnode.c:3558
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:2202
Path * reparameterize_path_by_child(PlannerInfo *root, Path *path, RelOptInfo *child_rel)
Definition: pathnode.c:3903
Path * create_samplescan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:954
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
bool canSetTag
Definition: plannodes.h:54
Relids calc_non_nestloop_required_outer(Path *outer_path, Path *inner_path)
Definition: pathnode.c:2325
GatherMergePath * create_gather_merge_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target, List *pathkeys, Relids required_outer, double *rows)
Definition: pathnode.c:1812
Size add_size(Size s1, Size s2)
Definition: shmem.c:502
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:2252
WindowAggPath * create_windowagg_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target, List *windowFuncs, WindowClause *winclause)
Definition: pathnode.c:3330
unsigned int Index
Definition: c.h:549
List * rowMarks
Definition: plannodes.h:78
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:2358
CostSelector
Definition: pathnodes.h:34
Path * create_worktablescan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2125
MergeAppendPath * create_merge_append_path(PlannerInfo *root, RelOptInfo *rel, List *subpaths, List *pathkeys, Relids required_outer)
Definition: pathnode.c:1404
Relids calc_nestloop_required_outer(Relids outerrelids, Relids outer_paramrels, Relids innerrelids, Relids inner_paramrels)
Definition: pathnode.c:2292
GroupingSetsPath * create_groupingsets_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *having_qual, AggStrategy aggstrategy, List *rollups, const AggClauseCosts *agg_costs, double numGroups)
Definition: pathnode.c:3098
Path * create_resultscan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2099
AggSplit
Definition: nodes.h:784
BitmapHeapPath * create_bitmap_heap_path(PlannerInfo *root, RelOptInfo *rel, Path *bitmapqual, Relids required_outer, double loop_count, int parallel_degree)
Definition: pathnode.c:1046
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:784
LimitOption
Definition: nodes.h:839
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:1368
ProjectionPath * create_projection_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target)
Definition: pathnode.c:2578
SortPath * create_sort_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *pathkeys, double limit_tuples)
Definition: pathnode.c:2876
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:2512
GatherPath * create_gather_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target, Relids required_outer, double *rows)
Definition: pathnode.c:1903
AggStrategy
Definition: nodes.h:762
SetOpCmd
Definition: nodes.h:806
List * resultRelations
Definition: plannodes.h:69
SubqueryScanPath * create_subqueryscan_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *pathkeys, Relids required_outer)
Definition: pathnode.c:1942
TidPath * create_tidscan_path(PlannerInfo *root, RelOptInfo *rel, List *tidquals, Relids required_outer)
Definition: pathnode.c:1183
RelOptInfo * fetch_upper_rel(PlannerInfo *root, UpperRelationKind kind, Relids relids)
Definition: relnode.c:1191
void add_partial_path(RelOptInfo *parent_rel, Path *new_path)
Definition: pathnode.c:749
ParamPathInfo * find_param_path_info(RelOptInfo *rel, Relids required_outer)
Definition: relnode.c:1607
UpperUniquePath * create_upper_unique_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, int numCols, double numGroups)
Definition: pathnode.c:2979
MinMaxAggPath * create_minmaxagg_path(PlannerInfo *root, RelOptInfo *rel, PathTarget *target, List *mmaggregates, List *quals)
Definition: pathnode.c:3259
void expand_planner_arrays(PlannerInfo *root, int add_size)
Definition: relnode.c:152
Path * create_valuesscan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2022
Definition: pg_list.h:50
int16 AttrNumber
Definition: attnum.h:21
BitmapOrPath * create_bitmap_or_path(PlannerInfo *root, RelOptInfo *rel, List *bitmapquals)
Definition: pathnode.c:1131
Path * apply_projection_to_path(PlannerInfo *root, RelOptInfo *rel, Path *path, PathTarget *target)
Definition: pathnode.c:2669
CmdType
Definition: nodes.h:676
double Cost
Definition: nodes.h:667
Datum subpath(PG_FUNCTION_ARGS)
Definition: ltree_op.c:241