PostgreSQL Source Code  git master
explain.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * explain.h
4  * prototypes for explain.c
5  *
6  * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group
7  * Portions Copyright (c) 1994-5, Regents of the University of California
8  *
9  * src/include/commands/explain.h
10  *
11  *-------------------------------------------------------------------------
12  */
13 #ifndef EXPLAIN_H
14 #define EXPLAIN_H
15 
16 #include "executor/executor.h"
17 #include "lib/stringinfo.h"
18 #include "parser/parse_node.h"
19 
20 typedef enum ExplainFormat
21 {
27 
28 typedef struct ExplainWorkersState
29 {
30  int num_workers; /* # of worker processes the plan used */
31  bool *worker_inited; /* per-worker state-initialized flags */
32  StringInfoData *worker_str; /* per-worker transient output buffers */
33  int *worker_state_save; /* per-worker grouping state save areas */
34  StringInfo prev_str; /* saved output buffer while redirecting */
36 
37 typedef struct ExplainState
38 {
39  StringInfo str; /* output buffer */
40  /* options */
41  bool verbose; /* be verbose */
42  bool analyze; /* print actual times */
43  bool costs; /* print estimated costs */
44  bool buffers; /* print buffer usage */
45  bool wal; /* print WAL usage */
46  bool timing; /* print detailed node timing */
47  bool summary; /* print total planning and execution timing */
48  bool settings; /* print modified settings */
49  bool generic; /* generate a generic plan */
50  ExplainFormat format; /* output format */
51  /* state for output formatting --- not reset for each new plan tree */
52  int indent; /* current indentation level */
53  List *grouping_stack; /* format-specific grouping state */
54  /* state related to the current plan tree (filled by ExplainPrintPlan) */
55  PlannedStmt *pstmt; /* top of plan */
56  List *rtable; /* range table */
57  List *rtable_names; /* alias names for RTEs */
58  List *deparse_cxt; /* context list for deparsing expressions */
59  Bitmapset *printed_subplans; /* ids of SubPlans we've printed */
60  bool hide_workers; /* set if we find an invisible Gather */
61  /* state related to the current plan node */
62  ExplainWorkersState *workers_state; /* needed if parallel plan */
64 
65 /* Hook for plugins to get control in ExplainOneQuery() */
66 typedef void (*ExplainOneQuery_hook_type) (Query *query,
67  int cursorOptions,
68  IntoClause *into,
69  ExplainState *es,
70  const char *queryString,
71  ParamListInfo params,
72  QueryEnvironment *queryEnv);
74 
75 /* Hook for plugins to get control in explain_get_index_name() */
76 typedef const char *(*explain_get_index_name_hook_type) (Oid indexId);
78 
79 
80 extern void ExplainQuery(ParseState *pstate, ExplainStmt *stmt,
82 
83 extern ExplainState *NewExplainState(void);
84 
86 
87 extern void ExplainOneUtility(Node *utilityStmt, IntoClause *into,
88  ExplainState *es, const char *queryString,
89  ParamListInfo params, QueryEnvironment *queryEnv);
90 
91 extern void ExplainOnePlan(PlannedStmt *plannedstmt, IntoClause *into,
92  ExplainState *es, const char *queryString,
93  ParamListInfo params, QueryEnvironment *queryEnv,
94  const instr_time *planduration,
95  const BufferUsage *bufusage);
96 
97 extern void ExplainPrintPlan(ExplainState *es, QueryDesc *queryDesc);
98 extern void ExplainPrintTriggers(ExplainState *es, QueryDesc *queryDesc);
99 
100 extern void ExplainPrintJITSummary(ExplainState *es, QueryDesc *queryDesc);
101 
102 extern void ExplainQueryText(ExplainState *es, QueryDesc *queryDesc);
103 extern void ExplainQueryParameters(ExplainState *es, ParamListInfo params, int maxlen);
104 
105 extern void ExplainBeginOutput(ExplainState *es);
106 extern void ExplainEndOutput(ExplainState *es);
107 extern void ExplainSeparatePlans(ExplainState *es);
108 
109 extern void ExplainPropertyList(const char *qlabel, List *data,
110  ExplainState *es);
111 extern void ExplainPropertyListNested(const char *qlabel, List *data,
112  ExplainState *es);
113 extern void ExplainPropertyText(const char *qlabel, const char *value,
114  ExplainState *es);
115 extern void ExplainPropertyInteger(const char *qlabel, const char *unit,
116  int64 value, ExplainState *es);
117 extern void ExplainPropertyUInteger(const char *qlabel, const char *unit,
118  uint64 value, ExplainState *es);
119 extern void ExplainPropertyFloat(const char *qlabel, const char *unit,
120  double value, int ndigits, ExplainState *es);
121 extern void ExplainPropertyBool(const char *qlabel, bool value,
122  ExplainState *es);
123 
124 extern void ExplainOpenGroup(const char *objtype, const char *labelname,
125  bool labeled, ExplainState *es);
126 extern void ExplainCloseGroup(const char *objtype, const char *labelname,
127  bool labeled, ExplainState *es);
128 
129 #endif /* EXPLAIN_H */
#define PGDLLIMPORT
Definition: c.h:1326
void ExplainPropertyText(const char *qlabel, const char *value, ExplainState *es)
Definition: explain.c:4584
void ExplainOpenGroup(const char *objtype, const char *labelname, bool labeled, ExplainState *es)
Definition: explain.c:4649
void ExplainPropertyUInteger(const char *qlabel, const char *unit, uint64 value, ExplainState *es)
Definition: explain.c:4606
void ExplainOnePlan(PlannedStmt *plannedstmt, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv, const instr_time *planduration, const BufferUsage *bufusage)
Definition: explain.c:527
PGDLLIMPORT explain_get_index_name_hook_type explain_get_index_name_hook
Definition: explain.c:48
PGDLLIMPORT ExplainOneQuery_hook_type ExplainOneQuery_hook
Definition: explain.c:45
void ExplainPropertyInteger(const char *qlabel, const char *unit, int64 value, ExplainState *es)
Definition: explain.c:4593
void ExplainPropertyListNested(const char *qlabel, List *data, ExplainState *es)
Definition: explain.c:4478
void ExplainQuery(ParseState *pstate, ExplainStmt *stmt, ParamListInfo params, DestReceiver *dest)
Definition: explain.c:164
void ExplainSeparatePlans(ExplainState *es)
Definition: explain.c:4965
void(* ExplainOneQuery_hook_type)(Query *query, int cursorOptions, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv)
Definition: explain.h:66
void ExplainEndOutput(ExplainState *es)
Definition: explain.c:4936
void ExplainOneUtility(Node *utilityStmt, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv)
Definition: explain.c:437
TupleDesc ExplainResultDesc(ExplainStmt *stmt)
Definition: explain.c:337
void ExplainPrintJITSummary(ExplainState *es, QueryDesc *queryDesc)
Definition: explain.c:860
void ExplainPropertyFloat(const char *qlabel, const char *unit, double value, int ndigits, ExplainState *es)
Definition: explain.c:4620
void ExplainCloseGroup(const char *objtype, const char *labelname, bool labeled, ExplainState *es)
Definition: explain.c:4712
struct ExplainWorkersState ExplainWorkersState
void ExplainQueryText(ExplainState *es, QueryDesc *queryDesc)
Definition: explain.c:988
void ExplainBeginOutput(ExplainState *es)
Definition: explain.c:4905
ExplainState * NewExplainState(void)
Definition: explain.c:320
ExplainFormat
Definition: explain.h:21
@ EXPLAIN_FORMAT_XML
Definition: explain.h:23
@ EXPLAIN_FORMAT_YAML
Definition: explain.h:25
@ EXPLAIN_FORMAT_TEXT
Definition: explain.h:22
@ EXPLAIN_FORMAT_JSON
Definition: explain.h:24
void ExplainPrintPlan(ExplainState *es, QueryDesc *queryDesc)
Definition: explain.c:752
void ExplainQueryParameters(ExplainState *es, ParamListInfo params, int maxlen)
Definition: explain.c:1003
struct ExplainState ExplainState
const char *(* explain_get_index_name_hook_type)(Oid indexId)
Definition: explain.h:76
void ExplainPropertyBool(const char *qlabel, bool value, ExplainState *es)
Definition: explain.c:4634
void ExplainPrintTriggers(ExplainState *es, QueryDesc *queryDesc)
Definition: explain.c:817
void ExplainPropertyList(const char *qlabel, List *data, ExplainState *es)
Definition: explain.c:4408
#define stmt
Definition: indent_codes.h:59
static struct @148 value
const void * data
unsigned int Oid
Definition: postgres_ext.h:31
bool verbose
Definition: explain.h:41
bool settings
Definition: explain.h:48
Bitmapset * printed_subplans
Definition: explain.h:59
bool hide_workers
Definition: explain.h:60
bool timing
Definition: explain.h:46
List * grouping_stack
Definition: explain.h:53
List * rtable_names
Definition: explain.h:57
ExplainWorkersState * workers_state
Definition: explain.h:62
bool analyze
Definition: explain.h:42
StringInfo str
Definition: explain.h:39
ExplainFormat format
Definition: explain.h:50
bool wal
Definition: explain.h:45
List * rtable
Definition: explain.h:56
PlannedStmt * pstmt
Definition: explain.h:55
bool summary
Definition: explain.h:47
bool costs
Definition: explain.h:43
bool buffers
Definition: explain.h:44
int indent
Definition: explain.h:52
List * deparse_cxt
Definition: explain.h:58
StringInfoData * worker_str
Definition: explain.h:32
bool * worker_inited
Definition: explain.h:31
int * worker_state_save
Definition: explain.h:33
StringInfo prev_str
Definition: explain.h:34
Definition: pg_list.h:54
Definition: nodes.h:129