mirror of
https://github.com/postgres/postgres.git
synced 2026-04-11 03:56:42 -04:00
2c16deee2f
Until now extensions that wanted to measure overall query execution could
create QueryDesc->totaltime, which the core executor would then start and
stop. That's a bit odd and composes badly, e.g. extensions always had to use
INSTRUMENT_ALL, because otherwise another extension might not get what they
need.
Instead this introduces a new field, QueryDesc->query_instr_options, that
extensions can use to indicate whether they need query level instrumentation
populated, and with which instrumentation options. Extensions should take care
to only add options they need, instead of replacing the options of others.
The prior name of the field, totaltime, sounded like it would only measure
time, but these days the instrumentation infrastructure can track more
resources. The secondary benefit is that this will make it obvious to
extensions that they may not create the Instrumentation struct themselves
anymore (often extensions build only against a postgres build without
assertions).
Adjust pg_stat_statements and auto_explain to match, and lower the
requested instrumentation level for auto_explain to INSTRUMENT_TIMER,
since the summary instrumentation it needs is only runtime.
The reason to push this now, rather in the PG 20 cycle, is that 5a79e78501
already required extensions using query level instrumentations to adjust their
code, and it seemed undesirable to require them to do so again for 20.
Author: Lukas Fittl <lukas@fittl.com>
Reviewed-by: Andres Freund <andres@anarazel.de>
Discussion: https://postgr.es/m/CAP53Pkyqsht+exJQYRsjhSWYKu+vFGHhPub7m6PmFD6Or0=p1g@mail.gmail.com
72 lines
2.4 KiB
C
72 lines
2.4 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* execdesc.h
|
|
* plan and query descriptor accessor macros used by the executor
|
|
* and related modules.
|
|
*
|
|
*
|
|
* Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
|
|
* Portions Copyright (c) 1994, Regents of the University of California
|
|
*
|
|
* src/include/executor/execdesc.h
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
#ifndef EXECDESC_H
|
|
#define EXECDESC_H
|
|
|
|
#include "nodes/execnodes.h"
|
|
#include "tcop/dest.h"
|
|
|
|
|
|
/* ----------------
|
|
* query descriptor:
|
|
*
|
|
* a QueryDesc encapsulates everything that the executor
|
|
* needs to execute the query.
|
|
*
|
|
* For the convenience of SQL-language functions, we also support QueryDescs
|
|
* containing utility statements; these must not be passed to the executor
|
|
* however.
|
|
* ---------------------
|
|
*/
|
|
typedef struct QueryDesc
|
|
{
|
|
/* These fields are provided by CreateQueryDesc */
|
|
CmdType operation; /* CMD_SELECT, CMD_UPDATE, etc. */
|
|
PlannedStmt *plannedstmt; /* planner's output (could be utility, too) */
|
|
const char *sourceText; /* source text of the query */
|
|
Snapshot snapshot; /* snapshot to use for query */
|
|
Snapshot crosscheck_snapshot; /* crosscheck for RI update/delete */
|
|
DestReceiver *dest; /* the destination for tuple output */
|
|
ParamListInfo params; /* param values being passed in */
|
|
QueryEnvironment *queryEnv; /* query environment passed in */
|
|
int instrument_options; /* OR of InstrumentOption flags */
|
|
int query_instr_options; /* OR of InstrumentOption flags for
|
|
* query_instr */
|
|
|
|
/* These fields are set by ExecutorStart */
|
|
TupleDesc tupDesc; /* descriptor for result tuples */
|
|
EState *estate; /* executor's query-wide state */
|
|
PlanState *planstate; /* tree of per-plan-node state */
|
|
|
|
/* This field is set by ExecutePlan */
|
|
bool already_executed; /* true if previously executed */
|
|
|
|
/* This field is allocated by ExecutorStart if needed */
|
|
struct Instrumentation *query_instr; /* query level instrumentation */
|
|
} QueryDesc;
|
|
|
|
/* in pquery.c */
|
|
extern QueryDesc *CreateQueryDesc(PlannedStmt *plannedstmt,
|
|
const char *sourceText,
|
|
Snapshot snapshot,
|
|
Snapshot crosscheck_snapshot,
|
|
DestReceiver *dest,
|
|
ParamListInfo params,
|
|
QueryEnvironment *queryEnv,
|
|
int instrument_options);
|
|
|
|
extern void FreeQueryDesc(QueryDesc *qdesc);
|
|
|
|
#endif /* EXECDESC_H */
|