mirror of
https://github.com/postgres/postgres.git
synced 2026-03-02 21:30:36 -05:00
06286709ee
EXPLAIN (ANALYZE, SERIALIZE) allows collection of statistics about the volume of data emitted by a query, as well as the time taken to convert the data to the on-the-wire format. Previously there was no way to investigate this without actually sending the data to the client, in which case network transmission costs might swamp what you wanted to see. In particular this feature allows investigating the costs of de-TOASTing compressed or out-of-line data during formatting. Stepan Rutz and Matthias van de Meent, reviewed by Tomas Vondra and myself Discussion: https://postgr.es/m/ca0adb0e-fa4e-c37e-1cd7-91170b18cae1@gmx.de
145 lines
5.6 KiB
C
145 lines
5.6 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* explain.h
|
|
* prototypes for explain.c
|
|
*
|
|
* Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
|
|
* Portions Copyright (c) 1994-5, Regents of the University of California
|
|
*
|
|
* src/include/commands/explain.h
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
#ifndef EXPLAIN_H
|
|
#define EXPLAIN_H
|
|
|
|
#include "executor/executor.h"
|
|
#include "lib/stringinfo.h"
|
|
#include "parser/parse_node.h"
|
|
|
|
typedef enum ExplainSerializeOption
|
|
{
|
|
EXPLAIN_SERIALIZE_NONE,
|
|
EXPLAIN_SERIALIZE_TEXT,
|
|
EXPLAIN_SERIALIZE_BINARY,
|
|
} ExplainSerializeOption;
|
|
|
|
typedef enum ExplainFormat
|
|
{
|
|
EXPLAIN_FORMAT_TEXT,
|
|
EXPLAIN_FORMAT_XML,
|
|
EXPLAIN_FORMAT_JSON,
|
|
EXPLAIN_FORMAT_YAML,
|
|
} ExplainFormat;
|
|
|
|
typedef struct ExplainWorkersState
|
|
{
|
|
int num_workers; /* # of worker processes the plan used */
|
|
bool *worker_inited; /* per-worker state-initialized flags */
|
|
StringInfoData *worker_str; /* per-worker transient output buffers */
|
|
int *worker_state_save; /* per-worker grouping state save areas */
|
|
StringInfo prev_str; /* saved output buffer while redirecting */
|
|
} ExplainWorkersState;
|
|
|
|
typedef struct ExplainState
|
|
{
|
|
StringInfo str; /* output buffer */
|
|
/* options */
|
|
bool verbose; /* be verbose */
|
|
bool analyze; /* print actual times */
|
|
bool costs; /* print estimated costs */
|
|
bool buffers; /* print buffer usage */
|
|
bool wal; /* print WAL usage */
|
|
bool timing; /* print detailed node timing */
|
|
bool summary; /* print total planning and execution timing */
|
|
bool memory; /* print planner's memory usage information */
|
|
bool settings; /* print modified settings */
|
|
bool generic; /* generate a generic plan */
|
|
ExplainSerializeOption serialize; /* serialize the query's output? */
|
|
ExplainFormat format; /* output format */
|
|
/* state for output formatting --- not reset for each new plan tree */
|
|
int indent; /* current indentation level */
|
|
List *grouping_stack; /* format-specific grouping state */
|
|
/* state related to the current plan tree (filled by ExplainPrintPlan) */
|
|
PlannedStmt *pstmt; /* top of plan */
|
|
List *rtable; /* range table */
|
|
List *rtable_names; /* alias names for RTEs */
|
|
List *deparse_cxt; /* context list for deparsing expressions */
|
|
Bitmapset *printed_subplans; /* ids of SubPlans we've printed */
|
|
bool hide_workers; /* set if we find an invisible Gather */
|
|
/* state related to the current plan node */
|
|
ExplainWorkersState *workers_state; /* needed if parallel plan */
|
|
} ExplainState;
|
|
|
|
/* Hook for plugins to get control in ExplainOneQuery() */
|
|
typedef void (*ExplainOneQuery_hook_type) (Query *query,
|
|
int cursorOptions,
|
|
IntoClause *into,
|
|
ExplainState *es,
|
|
const char *queryString,
|
|
ParamListInfo params,
|
|
QueryEnvironment *queryEnv);
|
|
extern PGDLLIMPORT ExplainOneQuery_hook_type ExplainOneQuery_hook;
|
|
|
|
/* Hook for plugins to get control in explain_get_index_name() */
|
|
typedef const char *(*explain_get_index_name_hook_type) (Oid indexId);
|
|
extern PGDLLIMPORT explain_get_index_name_hook_type explain_get_index_name_hook;
|
|
|
|
|
|
extern void ExplainQuery(ParseState *pstate, ExplainStmt *stmt,
|
|
ParamListInfo params, DestReceiver *dest);
|
|
extern void standard_ExplainOneQuery(Query *query, int cursorOptions,
|
|
IntoClause *into, ExplainState *es,
|
|
const char *queryString, ParamListInfo params,
|
|
QueryEnvironment *queryEnv);
|
|
|
|
extern ExplainState *NewExplainState(void);
|
|
|
|
extern TupleDesc ExplainResultDesc(ExplainStmt *stmt);
|
|
|
|
extern void ExplainOneUtility(Node *utilityStmt, IntoClause *into,
|
|
ExplainState *es, const char *queryString,
|
|
ParamListInfo params, QueryEnvironment *queryEnv);
|
|
|
|
extern void ExplainOnePlan(PlannedStmt *plannedstmt, IntoClause *into,
|
|
ExplainState *es, const char *queryString,
|
|
ParamListInfo params, QueryEnvironment *queryEnv,
|
|
const instr_time *planduration,
|
|
const BufferUsage *bufusage,
|
|
const MemoryContextCounters *mem_counters);
|
|
|
|
extern void ExplainPrintPlan(ExplainState *es, QueryDesc *queryDesc);
|
|
extern void ExplainPrintTriggers(ExplainState *es, QueryDesc *queryDesc);
|
|
|
|
extern void ExplainPrintJITSummary(ExplainState *es, QueryDesc *queryDesc);
|
|
|
|
extern void ExplainQueryText(ExplainState *es, QueryDesc *queryDesc);
|
|
extern void ExplainQueryParameters(ExplainState *es, ParamListInfo params, int maxlen);
|
|
|
|
extern void ExplainBeginOutput(ExplainState *es);
|
|
extern void ExplainEndOutput(ExplainState *es);
|
|
extern void ExplainSeparatePlans(ExplainState *es);
|
|
|
|
extern void ExplainPropertyList(const char *qlabel, List *data,
|
|
ExplainState *es);
|
|
extern void ExplainPropertyListNested(const char *qlabel, List *data,
|
|
ExplainState *es);
|
|
extern void ExplainPropertyText(const char *qlabel, const char *value,
|
|
ExplainState *es);
|
|
extern void ExplainPropertyInteger(const char *qlabel, const char *unit,
|
|
int64 value, ExplainState *es);
|
|
extern void ExplainPropertyUInteger(const char *qlabel, const char *unit,
|
|
uint64 value, ExplainState *es);
|
|
extern void ExplainPropertyFloat(const char *qlabel, const char *unit,
|
|
double value, int ndigits, ExplainState *es);
|
|
extern void ExplainPropertyBool(const char *qlabel, bool value,
|
|
ExplainState *es);
|
|
|
|
extern void ExplainOpenGroup(const char *objtype, const char *labelname,
|
|
bool labeled, ExplainState *es);
|
|
extern void ExplainCloseGroup(const char *objtype, const char *labelname,
|
|
bool labeled, ExplainState *es);
|
|
|
|
extern DestReceiver *CreateExplainSerializeDestReceiver(ExplainState *es);
|
|
|
|
#endif /* EXPLAIN_H */
|