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-2019, 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  List *subpaths, List *partial_subpaths,
68  List *pathkeys, Relids required_outer,
69  int parallel_workers, bool parallel_aware,
70  List *partitioned_rels, double rows);
72  RelOptInfo *rel,
73  List *subpaths,
74  List *pathkeys,
75  Relids required_outer,
76  List *partitioned_rels);
78  RelOptInfo *rel,
79  PathTarget *target,
80  List *havingqual);
83  Path *subpath, SpecialJoinInfo *sjinfo);
85  RelOptInfo *rel, Path *subpath, PathTarget *target,
86  Relids required_outer, double *rows);
88  RelOptInfo *rel,
89  Path *subpath,
90  PathTarget *target,
91  List *pathkeys,
92  Relids required_outer,
93  double *rows);
95  RelOptInfo *rel, Path *subpath,
96  List *pathkeys, Relids required_outer);
98  List *pathkeys, Relids required_outer);
100  Relids required_outer);
102  Relids required_outer);
103 extern Path *create_ctescan_path(PlannerInfo *root, RelOptInfo *rel,
104  Relids required_outer);
106  Relids required_outer);
108  Relids required_outer);
110  Relids required_outer);
112  PathTarget *target,
113  double rows, Cost startup_cost, Cost total_cost,
114  List *pathkeys,
115  Relids required_outer,
116  Path *fdw_outerpath,
117  List *fdw_private);
119  PathTarget *target,
120  double rows, Cost startup_cost, Cost total_cost,
121  List *pathkeys,
122  Relids required_outer,
123  Path *fdw_outerpath,
124  List *fdw_private);
126  PathTarget *target,
127  double rows, Cost startup_cost, Cost total_cost,
128  List *pathkeys,
129  Path *fdw_outerpath,
130  List *fdw_private);
131 
132 extern Relids calc_nestloop_required_outer(Relids outerrelids,
133  Relids outer_paramrels,
134  Relids innerrelids,
135  Relids inner_paramrels);
136 extern Relids calc_non_nestloop_required_outer(Path *outer_path, Path *inner_path);
137 
139  RelOptInfo *joinrel,
140  JoinType jointype,
141  JoinCostWorkspace *workspace,
142  JoinPathExtraData *extra,
143  Path *outer_path,
144  Path *inner_path,
145  List *restrict_clauses,
146  List *pathkeys,
147  Relids required_outer);
148 
150  RelOptInfo *joinrel,
151  JoinType jointype,
152  JoinCostWorkspace *workspace,
153  JoinPathExtraData *extra,
154  Path *outer_path,
155  Path *inner_path,
156  List *restrict_clauses,
157  List *pathkeys,
158  Relids required_outer,
159  List *mergeclauses,
160  List *outersortkeys,
161  List *innersortkeys);
162 
164  RelOptInfo *joinrel,
165  JoinType jointype,
166  JoinCostWorkspace *workspace,
167  JoinPathExtraData *extra,
168  Path *outer_path,
169  Path *inner_path,
170  bool parallel_hash,
171  List *restrict_clauses,
172  Relids required_outer,
173  List *hashclauses);
174 
176  RelOptInfo *rel,
177  Path *subpath,
178  PathTarget *target);
180  RelOptInfo *rel,
181  Path *path,
182  PathTarget *target);
184  RelOptInfo *rel,
185  Path *subpath,
186  PathTarget *target);
188  RelOptInfo *rel,
189  Path *subpath,
190  List *pathkeys,
191  double limit_tuples);
193  RelOptInfo *rel,
194  Path *subpath,
195  List *groupClause,
196  List *qual,
197  double numGroups);
199  RelOptInfo *rel,
200  Path *subpath,
201  int numCols,
202  double numGroups);
203 extern AggPath *create_agg_path(PlannerInfo *root,
204  RelOptInfo *rel,
205  Path *subpath,
206  PathTarget *target,
207  AggStrategy aggstrategy,
208  AggSplit aggsplit,
209  List *groupClause,
210  List *qual,
211  const AggClauseCosts *aggcosts,
212  double numGroups);
214  RelOptInfo *rel,
215  Path *subpath,
216  List *having_qual,
217  AggStrategy aggstrategy,
218  List *rollups,
219  const AggClauseCosts *agg_costs,
220  double numGroups);
222  RelOptInfo *rel,
223  PathTarget *target,
224  List *mmaggregates,
225  List *quals);
227  RelOptInfo *rel,
228  Path *subpath,
229  PathTarget *target,
230  List *windowFuncs,
231  WindowClause *winclause);
233  RelOptInfo *rel,
234  Path *subpath,
235  SetOpCmd cmd,
236  SetOpStrategy strategy,
237  List *distinctList,
238  AttrNumber flagColIdx,
239  int firstFlag,
240  double numGroups,
241  double outputRows);
243  RelOptInfo *rel,
244  Path *leftpath,
245  Path *rightpath,
246  PathTarget *target,
247  List *distinctList,
248  int wtParam,
249  double numGroups);
251  Path *subpath, List *rowMarks, int epqParam);
253  RelOptInfo *rel,
254  CmdType operation, bool canSetTag,
255  Index nominalRelation, Index rootRelation,
256  bool partColsUpdated,
257  List *resultRelations, List *subpaths,
258  List *subroots,
259  List *withCheckOptionLists, List *returningLists,
260  List *rowMarks, OnConflictExpr *onconflict,
261  int epqParam);
263  Path *subpath,
264  Node *limitOffset, Node *limitCount,
265  int64 offset_est, int64 count_est);
266 extern void adjust_limit_rows_costs(double *rows,
267  Cost *startup_cost, Cost *total_cost,
268  int64 offset_est, int64 count_est);
269 
270 extern Path *reparameterize_path(PlannerInfo *root, Path *path,
271  Relids required_outer,
272  double loop_count);
274  RelOptInfo *child_rel);
275 
276 /*
277  * prototypes for relnode.c
278  */
279 extern void setup_simple_rel_arrays(PlannerInfo *root);
280 extern void expand_planner_arrays(PlannerInfo *root, int add_size);
281 extern RelOptInfo *build_simple_rel(PlannerInfo *root, int relid,
282  RelOptInfo *parent);
283 extern RelOptInfo *find_base_rel(PlannerInfo *root, int relid);
284 extern RelOptInfo *find_join_rel(PlannerInfo *root, Relids relids);
286  Relids joinrelids,
287  RelOptInfo *outer_rel,
288  RelOptInfo *inner_rel,
289  SpecialJoinInfo *sjinfo,
290  List **restrictlist_ptr);
292  Relids joinrelids,
293  RelOptInfo *outer_rel,
294  RelOptInfo *inner_rel);
296  Relids relids);
299  RelOptInfo *baserel,
300  Relids required_outer);
302  RelOptInfo *joinrel,
303  Path *outer_path,
304  Path *inner_path,
305  SpecialJoinInfo *sjinfo,
306  Relids required_outer,
307  List **restrict_clauses);
309  Relids required_outer);
311  Relids required_outer);
313  RelOptInfo *outer_rel, RelOptInfo *inner_rel,
314  RelOptInfo *parent_joinrel, List *restrictlist,
315  SpecialJoinInfo *sjinfo, JoinType jointype);
316 
317 #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
void add_path(RelOptInfo *parent_rel, Path *new_path)
Definition: pathnode.c:422
void setup_simple_rel_arrays(PlannerInfo *root)
Definition: relnode.c:74
UpperRelationKind
Definition: pathnodes.h:71
Path * reparameterize_path(PlannerInfo *root, Path *path, Relids required_outer, double loop_count)
Definition: pathnode.c:3666
ProjectSetPath * create_set_projection_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target)
Definition: pathnode.c:2699
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:3277
RelOptInfo * find_join_rel(PlannerInfo *root, Relids relids)
Definition: relnode.c:428
AppendPath * create_append_path(PlannerInfo *root, RelOptInfo *rel, List *subpaths, List *partial_subpaths, List *pathkeys, Relids required_outer, int parallel_workers, bool parallel_aware, List *partitioned_rels, double rows)
Definition: pathnode.c:1183
Definition: nodes.h:525
Path * create_namedtuplestorescan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2014
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:2921
RelOptInfo * find_base_rel(PlannerInfo *root, int relid)
Definition: relnode.c:363
MaterialPath * create_material_path(RelOptInfo *rel, Path *subpath)
Definition: pathnode.c:1495
ParamPathInfo * get_appendrel_parampathinfo(RelOptInfo *appendrel, Relids required_outer)
Definition: relnode.c:1561
void adjust_limit_rows_costs(double *rows, Cost *startup_cost, Cost *total_cost, int64 offset_est, int64 count_est)
Definition: pathnode.c:3598
Relids min_join_parameterization(PlannerInfo *root, Relids joinrelids, RelOptInfo *outer_rel, RelOptInfo *inner_rel)
Definition: relnode.c:914
MergeAppendPath * create_merge_append_path(PlannerInfo *root, RelOptInfo *rel, List *subpaths, List *pathkeys, Relids required_outer, List *partitioned_rels)
Definition: pathnode.c:1345
SetOpStrategy
Definition: nodes.h:806
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:2387
JoinType
Definition: nodes.h:692
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:2810
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:2099
Definition: type.h:89
ParamPathInfo * get_baserel_parampathinfo(PlannerInfo *root, RelOptInfo *baserel, Relids required_outer)
Definition: relnode.c:1264
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:3339
UniquePath * create_unique_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, SpecialJoinInfo *sjinfo)
Definition: pathnode.c:1534
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:1989
Path * create_tablefuncscan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:1937
Path * create_functionscan_path(PlannerInfo *root, RelOptInfo *rel, List *pathkeys, Relids required_outer)
Definition: pathnode.c:1911
Relids find_childrel_parents(PlannerInfo *root, RelOptInfo *rel)
Definition: relnode.c:1228
RelOptInfo * build_simple_rel(PlannerInfo *root, int relid, RelOptInfo *parent)
Definition: relnode.c:185
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:566
GroupResultPath * create_group_result_path(PlannerInfo *root, RelOptInfo *rel, PathTarget *target, List *havingqual)
Definition: pathnode.c:1447
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:3384
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:3443
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:2143
Path * reparameterize_path_by_child(PlannerInfo *root, Path *path, RelOptInfo *child_rel)
Definition: pathnode.c:3784
Path * create_samplescan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:954
bool canSetTag
Definition: plannodes.h:54
Relids calc_non_nestloop_required_outer(Path *outer_path, Path *inner_path)
Definition: pathnode.c:2266
GatherMergePath * create_gather_merge_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target, List *pathkeys, Relids required_outer, double *rows)
Definition: pathnode.c:1753
Size add_size(Size s1, Size s2)
Definition: shmem.c:475
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:2193
WindowAggPath * create_windowagg_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target, List *windowFuncs, WindowClause *winclause)
Definition: pathnode.c:3215
unsigned int Index
Definition: c.h:476
List * rowMarks
Definition: plannodes.h:82
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:2299
CostSelector
Definition: pathnodes.h:34
LimitPath * create_limit_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, Node *limitOffset, Node *limitCount, int64 offset_est, int64 count_est)
Definition: pathnode.c:3545
Path * create_worktablescan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2066
Relids calc_nestloop_required_outer(Relids outerrelids, Relids outer_paramrels, Relids innerrelids, Relids inner_paramrels)
Definition: pathnode.c:2233
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:2987
Path * create_resultscan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:2040
AggSplit
Definition: nodes.h:776
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:772
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:1354
ProjectionPath * create_projection_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target)
Definition: pathnode.c:2519
SortPath * create_sort_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *pathkeys, double limit_tuples)
Definition: pathnode.c:2766
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:2453
GatherPath * create_gather_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, PathTarget *target, Relids required_outer, double *rows)
Definition: pathnode.c:1844
AggStrategy
Definition: nodes.h:754
SetOpCmd
Definition: nodes.h:798
List * resultRelations
Definition: plannodes.h:69
SubqueryScanPath * create_subqueryscan_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *pathkeys, Relids required_outer)
Definition: pathnode.c:1883
TidPath * create_tidscan_path(PlannerInfo *root, RelOptInfo *rel, List *tidquals, Relids required_outer)
Definition: pathnode.c:1151
RelOptInfo * fetch_upper_rel(PlannerInfo *root, UpperRelationKind kind, Relids relids)
Definition: relnode.c:1177
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:1593
UpperUniquePath * create_upper_unique_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, int numCols, double numGroups)
Definition: pathnode.c:2869
MinMaxAggPath * create_minmaxagg_path(PlannerInfo *root, RelOptInfo *rel, PathTarget *target, List *mmaggregates, List *quals)
Definition: pathnode.c:3144
void expand_planner_arrays(PlannerInfo *root, int add_size)
Definition: relnode.c:143
Path * create_valuesscan_path(PlannerInfo *root, RelOptInfo *rel, Relids required_outer)
Definition: pathnode.c:1963
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:1115
Path * apply_projection_to_path(PlannerInfo *root, RelOptInfo *rel, Path *path, PathTarget *target)
Definition: pathnode.c:2610
CmdType
Definition: nodes.h:668
double Cost
Definition: nodes.h:659
Datum subpath(PG_FUNCTION_ARGS)
Definition: ltree_op.c:241