PostgreSQL Source Code: src/include/optimizer/optimizer.h Source File

PostgreSQL Source Code git master
optimizer.h
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * optimizer.h
4 * External API for the Postgres planner.
5 *
6 * This header is meant to define everything that the core planner
7 * exposes for use by non-planner modules.
8 *
9 * Note that there are files outside src/backend/optimizer/ that are
10 * considered planner modules, because they're too much in bed with
11 * planner operations to be treated otherwise. FDW planning code is an
12 * example. For the most part, however, code outside the core planner
13 * should not need to include any optimizer/ header except this one.
14 *
15 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
16 * Portions Copyright (c) 1994, Regents of the University of California
17 *
18 * src/include/optimizer/optimizer.h
19 *
20 *-------------------------------------------------------------------------
21 */
22#ifndef OPTIMIZER_H
23#define OPTIMIZER_H
24
25#include "nodes/parsenodes.h"
26
27/*
28 * We don't want to include nodes/pathnodes.h here, because non-planner
29 * code should generally treat PlannerInfo as an opaque typedef.
30 * But we'd like such code to use that typedef name, so define the
31 * typedef both here and in pathnodes.h.
32 */
33 typedef struct PlannerInfo PlannerInfo;
34 typedef struct IndexOptInfo IndexOptInfo;
35 typedef struct SpecialJoinInfo SpecialJoinInfo;
36
37/* It also seems best not to include plannodes.h, params.h, or htup.h here */
38 typedef struct PlannedStmt PlannedStmt;
39 typedef struct ParamListInfoData *ParamListInfo;
40 typedef struct HeapTupleData *HeapTuple;
41
42
43/* in path/clausesel.c: */
44
45extern Selectivity clause_selectivity(PlannerInfo *root,
46 Node *clause,
47 int varRelid,
48 JoinType jointype,
49 SpecialJoinInfo *sjinfo);
50extern Selectivity clause_selectivity_ext(PlannerInfo *root,
51 Node *clause,
52 int varRelid,
53 JoinType jointype,
54 SpecialJoinInfo *sjinfo,
55 bool use_extended_stats);
56extern Selectivity clauselist_selectivity(PlannerInfo *root,
57 List *clauses,
58 int varRelid,
59 JoinType jointype,
60 SpecialJoinInfo *sjinfo);
61extern Selectivity clauselist_selectivity_ext(PlannerInfo *root,
62 List *clauses,
63 int varRelid,
64 JoinType jointype,
65 SpecialJoinInfo *sjinfo,
66 bool use_extended_stats);
67
68/* in path/costsize.c: */
69
70/* widely used cost parameters */
71extern PGDLLIMPORT double seq_page_cost;
72extern PGDLLIMPORT double random_page_cost;
73extern PGDLLIMPORT double cpu_tuple_cost;
74extern PGDLLIMPORT double cpu_index_tuple_cost;
75extern PGDLLIMPORT double cpu_operator_cost;
76extern PGDLLIMPORT double parallel_tuple_cost;
77extern PGDLLIMPORT double parallel_setup_cost;
78extern PGDLLIMPORT double recursive_worktable_factor;
79extern PGDLLIMPORT int effective_cache_size;
80
81extern double clamp_row_est(double nrows);
82extern int32 clamp_width_est(int64 tuple_width);
83extern long clamp_cardinality_to_long(Cardinality x);
84
85/* in path/indxpath.c: */
86
87extern bool is_pseudo_constant_for_index(PlannerInfo *root, Node *expr,
88 IndexOptInfo *index);
89
90/* in plan/planner.c: */
91
92/* possible values for debug_parallel_query */
93 typedef enum
94{
95 DEBUG_PARALLEL_OFF,
96 DEBUG_PARALLEL_ON,
97 DEBUG_PARALLEL_REGRESS,
98} DebugParallelMode;
99
100/* GUC parameters */
101extern PGDLLIMPORT int debug_parallel_query;
102extern PGDLLIMPORT bool parallel_leader_participation;
103extern PGDLLIMPORT bool enable_distinct_reordering;
104
105extern PlannedStmt *planner(Query *parse, const char *query_string,
106 int cursorOptions,
107 ParamListInfo boundParams);
108
109extern Expr *expression_planner(Expr *expr);
110extern Expr *expression_planner_with_deps(Expr *expr,
111 List **relationOids,
112 List **invalItems);
113
114extern bool plan_cluster_use_sort(Oid tableOid, Oid indexOid);
115extern int plan_create_index_workers(Oid tableOid, Oid indexOid);
116
117/* in plan/setrefs.c: */
118
119extern void extract_query_dependencies(Node *query,
120 List **relationOids,
121 List **invalItems,
122 bool *hasRowSecurity);
123
124/* in prep/prepqual.c: */
125
126extern Node *negate_clause(Node *node);
127extern Expr *canonicalize_qual(Expr *qual, bool is_check);
128
129/* in util/clauses.c: */
130
131extern bool contain_mutable_functions(Node *clause);
132extern bool contain_mutable_functions_after_planning(Expr *expr);
133extern bool contain_volatile_functions(Node *clause);
134extern bool contain_volatile_functions_after_planning(Expr *expr);
135extern bool contain_volatile_functions_not_nextval(Node *clause);
136
137extern Node *eval_const_expressions(PlannerInfo *root, Node *node);
138
139extern void convert_saop_to_hashed_saop(Node *node);
140
141extern Node *estimate_expression_value(PlannerInfo *root, Node *node);
142
143extern Expr *evaluate_expr(Expr *expr, Oid result_type, int32 result_typmod,
144 Oid result_collation);
145
146extern bool var_is_nonnullable(PlannerInfo *root, Var *var, bool use_rel_info);
147
148extern List *expand_function_arguments(List *args, bool include_out_arguments,
149 Oid result_type,
150 HeapTuple func_tuple);
151
152extern ScalarArrayOpExpr *make_SAOP_expr(Oid oper, Node *leftexpr,
153 Oid coltype, Oid arraycollid,
154 Oid inputcollid, List *exprs,
155 bool haveNonConst);
156
157/* in util/predtest.c: */
158
159extern bool predicate_implied_by(List *predicate_list, List *clause_list,
160 bool weak);
161extern bool predicate_refuted_by(List *predicate_list, List *clause_list,
162 bool weak);
163
164/* in util/tlist.c: */
165
166extern int count_nonjunk_tlist_entries(List *tlist);
167extern TargetEntry *get_sortgroupref_tle(Index sortref,
168 List *targetList);
169extern TargetEntry *get_sortgroupclause_tle(SortGroupClause *sgClause,
170 List *targetList);
171extern Node *get_sortgroupclause_expr(SortGroupClause *sgClause,
172 List *targetList);
173extern List *get_sortgrouplist_exprs(List *sgClauses,
174 List *targetList);
175extern SortGroupClause *get_sortgroupref_clause(Index sortref,
176 List *clauses);
177extern SortGroupClause *get_sortgroupref_clause_noerr(Index sortref,
178 List *clauses);
179
180/* in util/var.c: */
181
182/* Bits that can be OR'd into the flags argument of pull_var_clause() */
183 #define PVC_INCLUDE_AGGREGATES 0x0001 /* include Aggrefs in output list */
184 #define PVC_RECURSE_AGGREGATES 0x0002 /* recurse into Aggref arguments */
185 #define PVC_INCLUDE_WINDOWFUNCS 0x0004 /* include WindowFuncs in output list */
186 #define PVC_RECURSE_WINDOWFUNCS 0x0008 /* recurse into WindowFunc arguments */
187 #define PVC_INCLUDE_PLACEHOLDERS 0x0010 /* include PlaceHolderVars in
188 * output list */
189 #define PVC_RECURSE_PLACEHOLDERS 0x0020 /* recurse into PlaceHolderVar
190 * arguments */
191#define PVC_INCLUDE_CONVERTROWTYPES 0x0040 /* include ConvertRowtypeExprs in
192 * output list */
193
194extern Bitmapset *pull_varnos(PlannerInfo *root, Node *node);
195extern Bitmapset *pull_varnos_of_level(PlannerInfo *root, Node *node, int levelsup);
196extern void pull_varattnos(Node *node, Index varno, Bitmapset **varattnos);
197extern List *pull_vars_of_level(Node *node, int levelsup);
198extern bool contain_var_clause(Node *node);
199extern bool contain_vars_of_level(Node *node, int levelsup);
200extern bool contain_vars_returning_old_or_new(Node *node);
201extern int locate_var_of_level(Node *node, int levelsup);
202extern List *pull_var_clause(Node *node, int flags);
203extern Node *flatten_join_alias_vars(PlannerInfo *root, Query *query, Node *node);
204extern Node *flatten_group_exprs(PlannerInfo *root, Query *query, Node *node);
205
206#endif /* OPTIMIZER_H */
#define PGDLLIMPORT
Definition: c.h:1319
int64_t int64
Definition: c.h:535
int32_t int32
Definition: c.h:534
unsigned int Index
Definition: c.h:619
x
int x
Definition: isn.c:75
args
double Cardinality
Definition: nodes.h:262
double Selectivity
Definition: nodes.h:260
JoinType
Definition: nodes.h:298
PGDLLIMPORT double cpu_operator_cost
Definition: costsize.c:134
bool contain_volatile_functions_not_nextval(Node *clause)
Definition: clauses.c:677
PGDLLIMPORT bool parallel_leader_participation
Definition: planner.c:70
Expr * canonicalize_qual(Expr *qual, bool is_check)
Definition: prepqual.c:293
Expr * expression_planner_with_deps(Expr *expr, List **relationOids, List **invalItems)
Definition: planner.c:6746
struct HeapTupleData * HeapTuple
Definition: optimizer.h:40
Selectivity clause_selectivity_ext(PlannerInfo *root, Node *clause, int varRelid, JoinType jointype, SpecialJoinInfo *sjinfo, bool use_extended_stats)
Definition: clausesel.c:684
bool predicate_refuted_by(List *predicate_list, List *clause_list, bool weak)
Definition: predtest.c:222
Bitmapset * pull_varnos(PlannerInfo *root, Node *node)
Definition: var.c:114
PlannedStmt * planner(Query *parse, const char *query_string, int cursorOptions, ParamListInfo boundParams)
Definition: planner.c:293
bool contain_vars_of_level(Node *node, int levelsup)
Definition: var.c:444
Node * flatten_group_exprs(PlannerInfo *root, Query *query, Node *node)
Definition: var.c:968
PGDLLIMPORT bool enable_distinct_reordering
Definition: planner.c:71
bool contain_var_clause(Node *node)
Definition: var.c:406
SortGroupClause * get_sortgroupref_clause_noerr(Index sortref, List *clauses)
Definition: tlist.c:443
bool is_pseudo_constant_for_index(PlannerInfo *root, Node *expr, IndexOptInfo *index)
Definition: indxpath.c:4456
bool plan_cluster_use_sort(Oid tableOid, Oid indexOid)
Definition: planner.c:6799
PGDLLIMPORT double parallel_tuple_cost
Definition: costsize.c:135
bool contain_mutable_functions(Node *clause)
Definition: clauses.c:374
SortGroupClause * get_sortgroupref_clause(Index sortref, List *clauses)
Definition: tlist.c:422
Node * estimate_expression_value(PlannerInfo *root, Node *node)
Definition: clauses.c:2403
int plan_create_index_workers(Oid tableOid, Oid indexOid)
Definition: planner.c:6921
PGDLLIMPORT double parallel_setup_cost
Definition: costsize.c:136
Selectivity clauselist_selectivity(PlannerInfo *root, List *clauses, int varRelid, JoinType jointype, SpecialJoinInfo *sjinfo)
Definition: clausesel.c:100
List * pull_vars_of_level(Node *node, int levelsup)
Definition: var.c:339
List * pull_var_clause(Node *node, int flags)
Definition: var.c:653
Node * eval_const_expressions(PlannerInfo *root, Node *node)
Definition: clauses.c:2262
bool contain_volatile_functions_after_planning(Expr *expr)
Definition: clauses.c:663
Bitmapset * pull_varnos_of_level(PlannerInfo *root, Node *node, int levelsup)
Definition: var.c:140
PGDLLIMPORT int debug_parallel_query
Definition: planner.c:69
bool contain_mutable_functions_after_planning(Expr *expr)
Definition: clauses.c:494
TargetEntry * get_sortgroupclause_tle(SortGroupClause *sgClause, List *targetList)
Definition: tlist.c:367
Selectivity clauselist_selectivity_ext(PlannerInfo *root, List *clauses, int varRelid, JoinType jointype, SpecialJoinInfo *sjinfo, bool use_extended_stats)
Definition: clausesel.c:117
Node * flatten_join_alias_vars(PlannerInfo *root, Query *query, Node *node)
Definition: var.c:789
DebugParallelMode
Definition: optimizer.h:94
@ DEBUG_PARALLEL_REGRESS
Definition: optimizer.h:97
@ DEBUG_PARALLEL_ON
Definition: optimizer.h:96
@ DEBUG_PARALLEL_OFF
Definition: optimizer.h:95
struct ParamListInfoData * ParamListInfo
Definition: optimizer.h:39
Node * negate_clause(Node *node)
Definition: prepqual.c:73
void convert_saop_to_hashed_saop(Node *node)
Definition: clauses.c:2295
PGDLLIMPORT double cpu_tuple_cost
Definition: costsize.c:132
List * get_sortgrouplist_exprs(List *sgClauses, List *targetList)
Definition: tlist.c:392
bool predicate_implied_by(List *predicate_list, List *clause_list, bool weak)
Definition: predtest.c:152
List * expand_function_arguments(List *args, bool include_out_arguments, Oid result_type, HeapTuple func_tuple)
Definition: clauses.c:4279
PGDLLIMPORT double recursive_worktable_factor
Definition: costsize.c:137
TargetEntry * get_sortgroupref_tle(Index sortref, List *targetList)
Definition: tlist.c:345
void extract_query_dependencies(Node *query, List **relationOids, List **invalItems, bool *hasRowSecurity)
Definition: setrefs.c:3656
Expr * expression_planner(Expr *expr)
Definition: planner.c:6719
PGDLLIMPORT double cpu_index_tuple_cost
Definition: costsize.c:133
int count_nonjunk_tlist_entries(List *tlist)
Definition: tlist.c:186
void pull_varattnos(Node *node, Index varno, Bitmapset **varattnos)
Definition: var.c:296
PGDLLIMPORT double seq_page_cost
Definition: costsize.c:130
int locate_var_of_level(Node *node, int levelsup)
Definition: var.c:555
double clamp_row_est(double nrows)
Definition: costsize.c:213
PGDLLIMPORT int effective_cache_size
Definition: costsize.c:139
long clamp_cardinality_to_long(Cardinality x)
Definition: costsize.c:265
PGDLLIMPORT double random_page_cost
Definition: costsize.c:131
ScalarArrayOpExpr * make_SAOP_expr(Oid oper, Node *leftexpr, Oid coltype, Oid arraycollid, Oid inputcollid, List *exprs, bool haveNonConst)
Definition: clauses.c:5553
bool contain_vars_returning_old_or_new(Node *node)
Definition: var.c:511
int32 clamp_width_est(int64 tuple_width)
Definition: costsize.c:242
Expr * evaluate_expr(Expr *expr, Oid result_type, int32 result_typmod, Oid result_collation)
Definition: clauses.c:5076
bool contain_volatile_functions(Node *clause)
Definition: clauses.c:542
bool var_is_nonnullable(PlannerInfo *root, Var *var, bool use_rel_info)
Definition: clauses.c:4207
Node * get_sortgroupclause_expr(SortGroupClause *sgClause, List *targetList)
Definition: tlist.c:379
Selectivity clause_selectivity(PlannerInfo *root, Node *clause, int varRelid, JoinType jointype, SpecialJoinInfo *sjinfo)
Definition: clausesel.c:667
Operator oper(ParseState *pstate, List *opname, Oid ltypeId, Oid rtypeId, bool noError, int location)
Definition: parse_oper.c:371
unsigned int Oid
Definition: postgres_ext.h:32
tree ctl root
Definition: radixtree.h:1857
static struct subre * parse(struct vars *v, int stopper, int type, struct state *init, struct state *final)
Definition: regcomp.c:717
Definition: primnodes.h:189
Definition: pg_list.h:54
Definition: nodes.h:135
Definition: parsenodes.h:118
Definition: primnodes.h:262
Definition: type.h:96

AltStyle によって変換されたページ (->オリジナル) /