explain.c File Reference

#include "postgres.h"
#include "access/xact.h"
#include "catalog/pg_type.h"
#include "commands/createas.h"
#include "commands/defrem.h"
#include "commands/prepare.h"
#include "executor/nodeHash.h"
#include "foreign/fdwapi.h"
#include "jit/jit.h"
#include "nodes/extensible.h"
#include "nodes/makefuncs.h"
#include "nodes/nodeFuncs.h"
#include "parser/analyze.h"
#include "parser/parsetree.h"
#include "rewrite/rewriteHandler.h"
#include "storage/bufmgr.h"
#include "tcop/tcopprot.h"
#include "utils/builtins.h"
#include "utils/guc_tables.h"
#include "utils/json.h"
#include "utils/lsyscache.h"
#include "utils/rel.h"
#include "utils/ruleutils.h"
#include "utils/snapmgr.h"
#include "utils/tuplesort.h"
#include "utils/typcache.h"
#include "utils/xml.h"

Include dependency graph for explain.c:

Go to the source code of this file.

Macros
#define	X_OPENING   0
#define	X_CLOSING   1
#define	X_CLOSE_IMMEDIATE   2
#define	X_NOWHITESPACE   4

Functions
static void	ExplainOneQuery (Query *query, int cursorOptions, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv)
static void	ExplainPrintJIT (ExplainState *es, int jit_flags, JitInstrumentation *ji)
static void	report_triggers (ResultRelInfo *rInfo, bool show_relname, ExplainState *es)
static double	elapsed_time (instr_time *starttime)
static bool	ExplainPreScanNode (PlanState *planstate, Bitmapset **rels_used)
static void	ExplainNode (PlanState *planstate, List *ancestors, const char *relationship, const char *plan_name, ExplainState *es)
static void	show_plan_tlist (PlanState *planstate, List *ancestors, ExplainState *es)
static void	show_expression (Node *node, const char *qlabel, PlanState *planstate, List *ancestors, bool useprefix, ExplainState *es)
static void	show_qual (List *qual, const char *qlabel, PlanState *planstate, List *ancestors, bool useprefix, ExplainState *es)
static void	show_scan_qual (List *qual, const char *qlabel, PlanState *planstate, List *ancestors, ExplainState *es)
static void	show_upper_qual (List *qual, const char *qlabel, PlanState *planstate, List *ancestors, ExplainState *es)
static void	show_sort_keys (SortState *sortstate, List *ancestors, ExplainState *es)
static void	show_incremental_sort_keys (IncrementalSortState *incrsortstate, List *ancestors, ExplainState *es)
static void	show_merge_append_keys (MergeAppendState *mstate, List *ancestors, ExplainState *es)
static void	show_agg_keys (AggState *astate, List *ancestors, ExplainState *es)
static void	show_grouping_sets (PlanState *planstate, Agg *agg, List *ancestors, ExplainState *es)
static void	show_grouping_set_keys (PlanState *planstate, Agg *aggnode, Sort *sortnode, List *context, bool useprefix, List *ancestors, ExplainState *es)
static void	show_group_keys (GroupState *gstate, List *ancestors, ExplainState *es)
static void	show_sort_group_keys (PlanState *planstate, const char *qlabel, int nkeys, int nPresortedKeys, AttrNumber *keycols, Oid *sortOperators, Oid *collations, bool *nullsFirst, List *ancestors, ExplainState *es)
static void	show_sortorder_options (StringInfo buf, Node *sortexpr, Oid sortOperator, Oid collation, bool nullsFirst)
static void	show_tablesample (TableSampleClause *tsc, PlanState *planstate, List *ancestors, ExplainState *es)
static void	show_sort_info (SortState *sortstate, ExplainState *es)
static void	show_incremental_sort_info (IncrementalSortState *incrsortstate, ExplainState *es)
static void	show_hash_info (HashState *hashstate, ExplainState *es)
static void	show_memoize_info (MemoizeState *mstate, List *ancestors, ExplainState *es)
static void	show_hashagg_info (AggState *aggstate, ExplainState *es)
static void	show_tidbitmap_info (BitmapHeapScanState *planstate, ExplainState *es)
static void	show_instrumentation_count (const char *qlabel, int which, PlanState *planstate, ExplainState *es)
static void	show_foreignscan_info (ForeignScanState *fsstate, ExplainState *es)
static void	show_eval_params (Bitmapset *bms_params, ExplainState *es)
static const char *	explain_get_index_name (Oid indexId)
static void	show_buffer_usage (ExplainState *es, const BufferUsage *usage, bool planning)
static void	show_wal_usage (ExplainState *es, const WalUsage *usage)
static void	ExplainIndexScanDetails (Oid indexid, ScanDirection indexorderdir, ExplainState *es)
static void	ExplainScanTarget (Scan *plan, ExplainState *es)
static void	ExplainModifyTarget (ModifyTable *plan, ExplainState *es)
static void	ExplainTargetRel (Plan *plan, Index rti, ExplainState *es)
static void	show_modifytable_info (ModifyTableState *mtstate, List *ancestors, ExplainState *es)
static void	ExplainMemberNodes (PlanState **planstates, int nplans, List *ancestors, ExplainState *es)
static void	ExplainMissingMembers (int nplans, int nchildren, ExplainState *es)
static void	ExplainSubPlans (List *plans, List *ancestors, const char *relationship, ExplainState *es)
static void	ExplainCustomChildren (CustomScanState *css, List *ancestors, ExplainState *es)
static ExplainWorkersState *	ExplainCreateWorkersState (int num_workers)
static void	ExplainOpenWorker (int n, ExplainState *es)
static void	ExplainCloseWorker (int n, ExplainState *es)
static void	ExplainFlushWorkersState (ExplainState *es)
static void	ExplainProperty (const char *qlabel, const char *unit, const char *value, bool numeric, ExplainState *es)
static void	ExplainOpenSetAsideGroup (const char *objtype, const char *labelname, bool labeled, int depth, ExplainState *es)
static void	ExplainSaveGroup (ExplainState *es, int depth, int *state_save)
static void	ExplainRestoreGroup (ExplainState *es, int depth, int *state_save)
static void	ExplainDummyGroup (const char *objtype, const char *labelname, ExplainState *es)
static void	ExplainXMLTag (const char *tagname, int flags, ExplainState *es)
static void	ExplainIndentText (ExplainState *es)
static void	ExplainJSONLineEnding (ExplainState *es)
static void	ExplainYAMLLineStarting (ExplainState *es)
static void	escape_yaml (StringInfo buf, const char *str)
void	ExplainQuery (ParseState *pstate, ExplainStmt *stmt, ParamListInfo params, DestReceiver *dest)
ExplainState *	NewExplainState (void)
TupleDesc	ExplainResultDesc (ExplainStmt *stmt)
void	ExplainOneUtility (Node *utilityStmt, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv)
void	ExplainOnePlan (PlannedStmt *plannedstmt, IntoClause *into, ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv, const instr_time *planduration, const BufferUsage *bufusage)
static void	ExplainPrintSettings (ExplainState *es)
void	ExplainPrintPlan (ExplainState *es, QueryDesc *queryDesc)
void	ExplainPrintTriggers (ExplainState *es, QueryDesc *queryDesc)
void	ExplainPrintJITSummary (ExplainState *es, QueryDesc *queryDesc)
void	ExplainQueryText (ExplainState *es, QueryDesc *queryDesc)
void	ExplainQueryParameters (ExplainState *es, ParamListInfo params, int maxlen)
static void	show_incremental_sort_group_info (IncrementalSortGroupInfo *groupInfo, const char *groupLabel, bool indent, ExplainState *es)
void	ExplainPropertyList (const char *qlabel, List *data, ExplainState *es)
void	ExplainPropertyListNested (const char *qlabel, List *data, ExplainState *es)
void	ExplainPropertyText (const char *qlabel, const char *value, ExplainState *es)
void	ExplainPropertyInteger (const char *qlabel, const char *unit, int64 value, ExplainState *es)
void	ExplainPropertyUInteger (const char *qlabel, const char *unit, uint64 value, ExplainState *es)
void	ExplainPropertyFloat (const char *qlabel, const char *unit, double value, int ndigits, ExplainState *es)
void	ExplainPropertyBool (const char *qlabel, bool value, ExplainState *es)
void	ExplainOpenGroup (const char *objtype, const char *labelname, bool labeled, ExplainState *es)
void	ExplainCloseGroup (const char *objtype, const char *labelname, bool labeled, ExplainState *es)
void	ExplainBeginOutput (ExplainState *es)
void	ExplainEndOutput (ExplainState *es)
void	ExplainSeparatePlans (ExplainState *es)

Variables
ExplainOneQuery_hook_type	ExplainOneQuery_hook = NULL
explain_get_index_name_hook_type	explain_get_index_name_hook = NULL

Macro Definition Documentation

X_CLOSE_IMMEDIATE

#define X_CLOSE_IMMEDIATE   2

Definition at line 54 of file explain.c.

X_CLOSING

#define X_CLOSING   1

Definition at line 53 of file explain.c.

X_NOWHITESPACE

#define X_NOWHITESPACE   4

Definition at line 55 of file explain.c.

X_OPENING

#define X_OPENING   0

Definition at line 52 of file explain.c.

Function Documentation

elapsed_time()

static double elapsed_time ( instr_time *  starttime )

static

Definition at line 1092 of file explain.c.

{
    instr_time  endtime;
 
    INSTR_TIME_SET_CURRENT(endtime);
    INSTR_TIME_SUBTRACT(endtime, *starttime);
    return INSTR_TIME_GET_DOUBLE(endtime);
}

References INSTR_TIME_GET_DOUBLE, INSTR_TIME_SET_CURRENT, and INSTR_TIME_SUBTRACT.

Referenced by ExplainOnePlan(), and IsCheckpointOnSchedule().

escape_yaml()

static void escape_yaml ( StringInfo  buf, const char *  str  )

static

Definition at line 5059 of file explain.c.

{
    escape_json(buf, str);
}

References buf, escape_json(), and generate_unaccent_rules::str.

Referenced by ExplainDummyGroup(), ExplainProperty(), ExplainPropertyList(), and ExplainPropertyListNested().

explain_get_index_name()

static const char * explain_get_index_name ( Oid  indexId )

static

Definition at line 3529 of file explain.c.

{
    const char *result;
 
    if (explain_get_index_name_hook)
        result = (*explain_get_index_name_hook) (indexId);
    else
        result = NULL;
    if (result == NULL)
    {
        /* default behavior: look it up in the catalogs */
        result = get_rel_name(indexId);
        if (result == NULL)
            elog(ERROR, "cache lookup failed for index %u", indexId);
    }
    return result;
}

References elog(), ERROR, explain_get_index_name_hook, and get_rel_name().

Referenced by ExplainIndexScanDetails(), and ExplainNode().

ExplainBeginOutput()

void ExplainBeginOutput

(

ExplainState *

es

)

Definition at line 4883 of file explain.c.

{
    switch (es->format)
    {
        case EXPLAIN_FORMAT_TEXT:
            /* nothing to do */
            break;
 
        case EXPLAIN_FORMAT_XML:
            appendStringInfoString(es->str,
                                   "<explain xmlns=\"http://www.postgresql.org/2009/explain\">\n");
            es->indent++;
            break;
 
        case EXPLAIN_FORMAT_JSON:
            /* top-level structure is an array of plans */
            appendStringInfoChar(es->str, '[');
            es->grouping_stack = lcons_int(0, es->grouping_stack);
            es->indent++;
            break;
 
        case EXPLAIN_FORMAT_YAML:
            es->grouping_stack = lcons_int(0, es->grouping_stack);
            break;
    }
}

References appendStringInfoChar(), appendStringInfoString(), EXPLAIN_FORMAT_JSON, EXPLAIN_FORMAT_TEXT, EXPLAIN_FORMAT_XML, EXPLAIN_FORMAT_YAML, ExplainState::format, ExplainState::grouping_stack, ExplainState::indent, lcons_int(), and ExplainState::str.

Referenced by explain_ExecutorEnd(), and ExplainQuery().

ExplainCloseGroup()

void ExplainCloseGroup	(	const char *	objtype,
		const char *	labelname,
		bool	labeled,
		ExplainState *	es
	)

Definition at line 4690 of file explain.c.

{
    switch (es->format)
    {
        case EXPLAIN_FORMAT_TEXT:
            /* nothing to do */
            break;
 
        case EXPLAIN_FORMAT_XML:
            es->indent--;
            ExplainXMLTag(objtype, X_CLOSING, es);
            break;
 
        case EXPLAIN_FORMAT_JSON:
            es->indent--;
            appendStringInfoChar(es->str, '\n');
            appendStringInfoSpaces(es->str, 2 * es->indent);
            appendStringInfoChar(es->str, labeled ? '}' : ']');
            es->grouping_stack = list_delete_first(es->grouping_stack);
            break;
 
        case EXPLAIN_FORMAT_YAML:
            es->indent--;
            es->grouping_stack = list_delete_first(es->grouping_stack);
            break;
    }
}

References appendStringInfoChar(), appendStringInfoSpaces(), EXPLAIN_FORMAT_JSON, EXPLAIN_FORMAT_TEXT, EXPLAIN_FORMAT_XML, EXPLAIN_FORMAT_YAML, ExplainXMLTag(), ExplainState::format, ExplainState::grouping_stack, ExplainState::indent, list_delete_first(), ExplainState::str, and X_CLOSING.

Referenced by ExplainFlushWorkersState(), ExplainNode(), ExplainOnePlan(), ExplainPrintJIT(), ExplainPrintSettings(), ExplainPrintTriggers(), report_triggers(), show_grouping_set_keys(), show_grouping_sets(), show_incremental_sort_group_info(), and show_modifytable_info().

ExplainCloseWorker()

static void ExplainCloseWorker ( int  n, ExplainState *  es  )

static

Definition at line 4320 of file explain.c.

{
    ExplainWorkersState *wstate = es->workers_state;
 
    Assert(wstate);
    Assert(n >= 0 && n < wstate->num_workers);
    Assert(wstate->worker_inited[n]);
 
    /*
     * Save formatting state in case we do another ExplainOpenWorker(), then
     * pop the formatting stack.
     */
    ExplainSaveGroup(es, 2, &wstate->worker_state_save[n]);
 
    /*
     * In TEXT format, if we didn't actually produce any output line(s) then
     * truncate off the partial line emitted by ExplainOpenWorker.  (This is
     * to avoid bogus output if, say, show_buffer_usage chooses not to print
     * anything for the worker.)  Also fix up the indent level.
     */
    if (es->format == EXPLAIN_FORMAT_TEXT)
    {
        while (es->str->len > 0 && es->str->data[es->str->len - 1] != '\n')
            es->str->data[--(es->str->len)] = '\0';
 
        es->indent--;
    }
 
    /* Restore prior output buffer pointer */
    es->str = wstate->prev_str;
}

References Assert(), StringInfoData::data, EXPLAIN_FORMAT_TEXT, ExplainSaveGroup(), ExplainState::format, ExplainState::indent, StringInfoData::len, ExplainWorkersState::prev_str, ExplainState::str, ExplainWorkersState::worker_inited, ExplainWorkersState::worker_state_save, and ExplainState::workers_state.

Referenced by ExplainNode(), show_hashagg_info(), show_incremental_sort_info(), show_memoize_info(), and show_sort_info().

ExplainCreateWorkersState()

static ExplainWorkersState * ExplainCreateWorkersState ( int  num_workers )

static

Definition at line 4241 of file explain.c.

{
    ExplainWorkersState *wstate;
 
    wstate = (ExplainWorkersState *) palloc(sizeof(ExplainWorkersState));
    wstate->num_workers = num_workers;
    wstate->worker_inited = (bool *) palloc0(num_workers * sizeof(bool));
    wstate->worker_str = (StringInfoData *)
        palloc0(num_workers * sizeof(StringInfoData));
    wstate->worker_state_save = (int *) palloc(num_workers * sizeof(int));
    return wstate;
}

References ExplainWorkersState::num_workers, palloc(), palloc0(), ExplainWorkersState::worker_inited, ExplainWorkersState::worker_state_save, and ExplainWorkersState::worker_str.

Referenced by ExplainNode().

ExplainCustomChildren()

static void ExplainCustomChildren ( CustomScanState *  css, List *  ancestors, ExplainState *  es  )

static

Definition at line 4219 of file explain.c.

{
    ListCell   *cell;
    const char *label =
        (list_length(css->custom_ps) != 1 ? "children" : "child");
 
    foreach(cell, css->custom_ps)
        ExplainNode((PlanState *) lfirst(cell), ancestors, label, NULL, es);
}

References CustomScanState::custom_ps, ExplainNode(), label, lfirst, and list_length().

Referenced by ExplainNode().

ExplainDummyGroup()

static void ExplainDummyGroup ( const char *  objtype, const char *  labelname, ExplainState *  es  )

static

Definition at line 4837 of file explain.c.

{
    switch (es->format)
    {
        case EXPLAIN_FORMAT_TEXT:
            /* nothing to do */
            break;
 
        case EXPLAIN_FORMAT_XML:
            ExplainXMLTag(objtype, X_CLOSE_IMMEDIATE, es);
            break;
 
        case EXPLAIN_FORMAT_JSON:
            ExplainJSONLineEnding(es);
            appendStringInfoSpaces(es->str, 2 * es->indent);
            if (labelname)
            {
                escape_json(es->str, labelname);
                appendStringInfoString(es->str, ": ");
            }
            escape_json(es->str, objtype);
            break;
 
        case EXPLAIN_FORMAT_YAML:
            ExplainYAMLLineStarting(es);
            if (labelname)
            {
                escape_yaml(es->str, labelname);
                appendStringInfoString(es->str, ": ");
            }
            else
            {
                appendStringInfoString(es->str, "- ");
            }
            escape_yaml(es->str, objtype);
            break;
    }
}

References appendStringInfoSpaces(), appendStringInfoString(), escape_json(), escape_yaml(), EXPLAIN_FORMAT_JSON, EXPLAIN_FORMAT_TEXT, EXPLAIN_FORMAT_XML, EXPLAIN_FORMAT_YAML, ExplainJSONLineEnding(), ExplainXMLTag(), ExplainYAMLLineStarting(), ExplainState::format, ExplainState::indent, ExplainState::str, and X_CLOSE_IMMEDIATE.

Referenced by ExplainOneUtility().

ExplainEndOutput()

void ExplainEndOutput

(

ExplainState *

es

)

Definition at line 4914 of file explain.c.

{
    switch (es->format)
    {
        case EXPLAIN_FORMAT_TEXT:
            /* nothing to do */
            break;
 
        case EXPLAIN_FORMAT_XML:
            es->indent--;
            appendStringInfoString(es->str, "</explain>");
            break;
 
        case EXPLAIN_FORMAT_JSON:
            es->indent--;
            appendStringInfoString(es->str, "\n]");
            es->grouping_stack = list_delete_first(es->grouping_stack);
            break;
 
        case EXPLAIN_FORMAT_YAML:
            es->grouping_stack = list_delete_first(es->grouping_stack);
            break;
    }
}

References appendStringInfoString(), EXPLAIN_FORMAT_JSON, EXPLAIN_FORMAT_TEXT, EXPLAIN_FORMAT_XML, EXPLAIN_FORMAT_YAML, ExplainState::format, ExplainState::grouping_stack, ExplainState::indent, list_delete_first(), and ExplainState::str.

Referenced by explain_ExecutorEnd(), and ExplainQuery().

ExplainFlushWorkersState()

static void ExplainFlushWorkersState ( ExplainState *  es )

static

Definition at line 4356 of file explain.c.

{
    ExplainWorkersState *wstate = es->workers_state;
 
    ExplainOpenGroup("Workers", "Workers", false, es);
    for (int i = 0; i < wstate->num_workers; i++)
    {
        if (wstate->worker_inited[i])
        {
            /* This must match previous ExplainOpenSetAsideGroup call */
            ExplainOpenGroup("Worker", NULL, true, es);
            appendStringInfoString(es->str, wstate->worker_str[i].data);
            ExplainCloseGroup("Worker", NULL, true, es);
 
            pfree(wstate->worker_str[i].data);
        }
    }
    ExplainCloseGroup("Workers", "Workers", false, es);
 
    pfree(wstate->worker_inited);
    pfree(wstate->worker_str);
    pfree(wstate->worker_state_save);
    pfree(wstate);
}

References appendStringInfoString(), StringInfoData::data, ExplainCloseGroup(), ExplainOpenGroup(), i, ExplainWorkersState::num_workers, pfree(), ExplainState::str, ExplainWorkersState::worker_inited, ExplainWorkersState::worker_state_save, ExplainWorkersState::worker_str, and ExplainState::workers_state.

Referenced by ExplainNode().

ExplainIndentText()

static void ExplainIndentText ( ExplainState *  es )

static

Definition at line 4999 of file explain.c.

{
    Assert(es->format == EXPLAIN_FORMAT_TEXT);
    if (es->str->len == 0 || es->str->data[es->str->len - 1] == '\n')
        appendStringInfoSpaces(es->str, es->indent * 2);
}

References appendStringInfoSpaces(), Assert(), StringInfoData::data, EXPLAIN_FORMAT_TEXT, ExplainState::format, ExplainState::indent, StringInfoData::len, and ExplainState::str.

Referenced by ExplainNode(), ExplainOpenWorker(), ExplainPrintJIT(), ExplainProperty(), ExplainPropertyList(), show_buffer_usage(), show_hash_info(), show_hashagg_info(), show_memoize_info(), show_modifytable_info(), show_sort_info(), show_tablesample(), show_tidbitmap_info(), and show_wal_usage().

ExplainIndexScanDetails()

static void ExplainIndexScanDetails ( Oid  indexid, ScanDirection  indexorderdir, ExplainState *  es  )

static

Definition at line 3751 of file explain.c.

{
    const char *indexname = explain_get_index_name(indexid);
 
    if (es->format == EXPLAIN_FORMAT_TEXT)
    {
        if (ScanDirectionIsBackward(indexorderdir))
            appendStringInfoString(es->str, " Backward");
        appendStringInfo(es->str, " using %s", quote_identifier(indexname));
    }
    else
    {
        const char *scandir;
 
        switch (indexorderdir)
        {
            case BackwardScanDirection:
                scandir = "Backward";
                break;
            case ForwardScanDirection:
                scandir = "Forward";
                break;
            default:
                scandir = "???";
                break;
        }
        ExplainPropertyText("Scan Direction", scandir, es);
        ExplainPropertyText("Index Name", indexname, es);
    }
}

References appendStringInfo(), appendStringInfoString(), BackwardScanDirection, EXPLAIN_FORMAT_TEXT, explain_get_index_name(), ExplainPropertyText(), ExplainState::format, ForwardScanDirection, quote_identifier(), ScanDirectionIsBackward, and ExplainState::str.

Referenced by ExplainNode().

ExplainJSONLineEnding()

static void ExplainJSONLineEnding ( ExplainState *  es )

static

Definition at line 5014 of file explain.c.

{
    Assert(es->format == EXPLAIN_FORMAT_JSON);
    if (linitial_int(es->grouping_stack) != 0)
        appendStringInfoChar(es->str, ',');
    else
        linitial_int(es->grouping_stack) = 1;
    appendStringInfoChar(es->str, '\n');
}

References appendStringInfoChar(), Assert(), EXPLAIN_FORMAT_JSON, ExplainState::format, ExplainState::grouping_stack, linitial_int, and ExplainState::str.

Referenced by ExplainDummyGroup(), ExplainOpenGroup(), ExplainProperty(), ExplainPropertyList(), and ExplainPropertyListNested().

ExplainMemberNodes()

static void ExplainMemberNodes ( PlanState **  planstates, int  nplans, List *  ancestors, ExplainState *  es  )

static

Definition at line 4144 of file explain.c.

{
    int         j;
 
    for (j = 0; j < nplans; j++)
        ExplainNode(planstates[j], ancestors,
                    "Member", NULL, es);
}

References ExplainNode(), and j.

Referenced by ExplainNode().

ExplainMissingMembers()

static void ExplainMissingMembers ( int  nplans, int  nchildren, ExplainState *  es  )

static

Definition at line 4162 of file explain.c.

{
    if (nplans < nchildren || es->format != EXPLAIN_FORMAT_TEXT)
        ExplainPropertyInteger("Subplans Removed", NULL,
                               nchildren - nplans, es);
}

References EXPLAIN_FORMAT_TEXT, ExplainPropertyInteger(), and format.

Referenced by ExplainNode().

ExplainModifyTarget()

static void ExplainModifyTarget ( ModifyTable *  plan, ExplainState *  es  )

static

Definition at line 3800 of file explain.c.

{
    ExplainTargetRel((Plan *) plan, plan->nominalRelation, es);
}

References ExplainTargetRel(), and plan.

Referenced by ExplainNode().

ExplainNode()

static void ExplainNode ( PlanState *  planstate, List *  ancestors, const char *  relationship, const char *  plan_name, ExplainState *  es  )

static

Definition at line 1186 of file explain.c.

{
    Plan       *plan = planstate->plan;
    const char *pname;          /* node type name for text output */
    const char *sname;          /* node type name for non-text output */
    const char *strategy = NULL;
    const char *partialmode = NULL;
    const char *operation = NULL;
    const char *custom_name = NULL;
    ExplainWorkersState *save_workers_state = es->workers_state;
    int         save_indent = es->indent;
    bool        haschildren;
 
    /*
     * Prepare per-worker output buffers, if needed.  We'll append the data in
     * these to the main output string further down.
     */
    if (planstate->worker_instrument && es->analyze && !es->hide_workers)
        es->workers_state = ExplainCreateWorkersState(planstate->worker_instrument->num_workers);
    else
        es->workers_state = NULL;
 
    /* Identify plan node type, and print generic details */
    switch (nodeTag(plan))
    {
        case T_Result:
            pname = sname = "Result";
            break;
        case T_ProjectSet:
            pname = sname = "ProjectSet";
            break;
        case T_ModifyTable:
            sname = "ModifyTable";
            switch (((ModifyTable *) plan)->operation)
            {
                case CMD_INSERT:
                    pname = operation = "Insert";
                    break;
                case CMD_UPDATE:
                    pname = operation = "Update";
                    break;
                case CMD_DELETE:
                    pname = operation = "Delete";
                    break;
                case CMD_MERGE:
                    pname = operation = "Merge";
                    break;
                default:
                    pname = "???";
                    break;
            }
            break;
        case T_Append:
            pname = sname = "Append";
            break;
        case T_MergeAppend:
            pname = sname = "Merge Append";
            break;
        case T_RecursiveUnion:
            pname = sname = "Recursive Union";
            break;
        case T_BitmapAnd:
            pname = sname = "BitmapAnd";
            break;
        case T_BitmapOr:
            pname = sname = "BitmapOr";
            break;
        case T_NestLoop:
            pname = sname = "Nested Loop";
            break;
        case T_MergeJoin:
            pname = "Merge";    /* "Join" gets added by jointype switch */
            sname = "Merge Join";
            break;
        case T_HashJoin:
            pname = "Hash";     /* "Join" gets added by jointype switch */
            sname = "Hash Join";
            break;
        case T_SeqScan:
            pname = sname = "Seq Scan";
            break;
        case T_SampleScan:
            pname = sname = "Sample Scan";
            break;
        case T_Gather:
            pname = sname = "Gather";
            break;
        case T_GatherMerge:
            pname = sname = "Gather Merge";
            break;
        case T_IndexScan:
            pname = sname = "Index Scan";
            break;
        case T_IndexOnlyScan:
            pname = sname = "Index Only Scan";
            break;
        case T_BitmapIndexScan:
            pname = sname = "Bitmap Index Scan";
            break;
        case T_BitmapHeapScan:
            pname = sname = "Bitmap Heap Scan";
            break;
        case T_TidScan:
            pname = sname = "Tid Scan";
            break;
        case T_TidRangeScan:
            pname = sname = "Tid Range Scan";
            break;
        case T_SubqueryScan:
            pname = sname = "Subquery Scan";
            break;
        case T_FunctionScan:
            pname = sname = "Function Scan";
            break;
        case T_TableFuncScan:
            pname = sname = "Table Function Scan";
            break;
        case T_ValuesScan:
            pname = sname = "Values Scan";
            break;
        case T_CteScan:
            pname = sname = "CTE Scan";
            break;
        case T_NamedTuplestoreScan:
            pname = sname = "Named Tuplestore Scan";
            break;
        case T_WorkTableScan:
            pname = sname = "WorkTable Scan";
            break;
        case T_ForeignScan:
            sname = "Foreign Scan";
            switch (((ForeignScan *) plan)->operation)
            {
                case CMD_SELECT:
                    pname = "Foreign Scan";
                    operation = "Select";
                    break;
                case CMD_INSERT:
                    pname = "Foreign Insert";
                    operation = "Insert";
                    break;
                case CMD_UPDATE:
                    pname = "Foreign Update";
                    operation = "Update";
                    break;
                case CMD_DELETE:
                    pname = "Foreign Delete";
                    operation = "Delete";
                    break;
                default:
                    pname = "???";
                    break;
            }
            break;
        case T_CustomScan:
            sname = "Custom Scan";
            custom_name = ((CustomScan *) plan)->methods->CustomName;
            if (custom_name)
                pname = psprintf("Custom Scan (%s)", custom_name);
            else
                pname = sname;
            break;
        case T_Material:
            pname = sname = "Materialize";
            break;
        case T_Memoize:
            pname = sname = "Memoize";
            break;
        case T_Sort:
            pname = sname = "Sort";
            break;
        case T_IncrementalSort:
            pname = sname = "Incremental Sort";
            break;
        case T_Group:
            pname = sname = "Group";
            break;
        case T_Agg:
            {
                Agg        *agg = (Agg *) plan;
 
                sname = "Aggregate";
                switch (agg->aggstrategy)
                {
                    case AGG_PLAIN:
                        pname = "Aggregate";
                        strategy = "Plain";
                        break;
                    case AGG_SORTED:
                        pname = "GroupAggregate";
                        strategy = "Sorted";
                        break;
                    case AGG_HASHED:
                        pname = "HashAggregate";
                        strategy = "Hashed";
                        break;
                    case AGG_MIXED:
                        pname = "MixedAggregate";
                        strategy = "Mixed";
                        break;
                    default:
                        pname = "Aggregate ???";
                        strategy = "???";
                        break;
                }
 
                if (DO_AGGSPLIT_SKIPFINAL(agg->aggsplit))
                {
                    partialmode = "Partial";
                    pname = psprintf("%s %s", partialmode, pname);
                }
                else if (DO_AGGSPLIT_COMBINE(agg->aggsplit))
                {
                    partialmode = "Finalize";
                    pname = psprintf("%s %s", partialmode, pname);
                }
                else
                    partialmode = "Simple";
            }
            break;
        case T_WindowAgg:
            pname = sname = "WindowAgg";
            break;
        case T_Unique:
            pname = sname = "Unique";
            break;
        case T_SetOp:
            sname = "SetOp";
            switch (((SetOp *) plan)->strategy)
            {
                case SETOP_SORTED:
                    pname = "SetOp";
                    strategy = "Sorted";
                    break;
                case SETOP_HASHED:
                    pname = "HashSetOp";
                    strategy = "Hashed";
                    break;
                default:
                    pname = "SetOp ???";
                    strategy = "???";
                    break;
            }
            break;
        case T_LockRows:
            pname = sname = "LockRows";
            break;
        case T_Limit:
            pname = sname = "Limit";
            break;
        case T_Hash:
            pname = sname = "Hash";
            break;
        default:
            pname = sname = "???";
            break;
    }
 
    ExplainOpenGroup("Plan",
                     relationship ? NULL : "Plan",
                     true, es);
 
    if (es->format == EXPLAIN_FORMAT_TEXT)
    {
        if (plan_name)
        {
            ExplainIndentText(es);
            appendStringInfo(es->str, "%s\n", plan_name);
            es->indent++;
        }
        if (es->indent)
        {
            ExplainIndentText(es);
            appendStringInfoString(es->str, "->  ");
            es->indent += 2;
        }
        if (plan->parallel_aware)
            appendStringInfoString(es->str, "Parallel ");
        if (plan->async_capable)
            appendStringInfoString(es->str, "Async ");
        appendStringInfoString(es->str, pname);
        es->indent++;
    }
    else
    {
        ExplainPropertyText("Node Type", sname, es);
        if (strategy)
            ExplainPropertyText("Strategy", strategy, es);
        if (partialmode)
            ExplainPropertyText("Partial Mode", partialmode, es);
        if (operation)
            ExplainPropertyText("Operation", operation, es);
        if (relationship)
            ExplainPropertyText("Parent Relationship", relationship, es);
        if (plan_name)
            ExplainPropertyText("Subplan Name", plan_name, es);
        if (custom_name)
            ExplainPropertyText("Custom Plan Provider", custom_name, es);
        ExplainPropertyBool("Parallel Aware", plan->parallel_aware, es);
        ExplainPropertyBool("Async Capable", plan->async_capable, es);
    }
 
    switch (nodeTag(plan))
    {
        case T_SeqScan:
        case T_SampleScan:
        case T_BitmapHeapScan:
        case T_TidScan:
        case T_TidRangeScan:
        case T_SubqueryScan:
        case T_FunctionScan:
        case T_TableFuncScan:
        case T_ValuesScan:
        case T_CteScan:
        case T_WorkTableScan:
            ExplainScanTarget((Scan *) plan, es);
            break;
        case T_ForeignScan:
        case T_CustomScan:
            if (((Scan *) plan)->scanrelid > 0)
                ExplainScanTarget((Scan *) plan, es);
            break;
        case T_IndexScan:
            {
                IndexScan  *indexscan = (IndexScan *) plan;
 
                ExplainIndexScanDetails(indexscan->indexid,
                                        indexscan->indexorderdir,
                                        es);
                ExplainScanTarget((Scan *) indexscan, es);
            }
            break;
        case T_IndexOnlyScan:
            {
                IndexOnlyScan *indexonlyscan = (IndexOnlyScan *) plan;
 
                ExplainIndexScanDetails(indexonlyscan->indexid,
                                        indexonlyscan->indexorderdir,
                                        es);
                ExplainScanTarget((Scan *) indexonlyscan, es);
            }
            break;
        case T_BitmapIndexScan:
            {
                BitmapIndexScan *bitmapindexscan = (BitmapIndexScan *) plan;
                const char *indexname =
                    explain_get_index_name(bitmapindexscan->indexid);
 
                if (es->format == EXPLAIN_FORMAT_TEXT)
                    appendStringInfo(es->str, " on %s",
                                     quote_identifier(indexname));
                else
                    ExplainPropertyText("Index Name", indexname, es);
            }
            break;
        case T_ModifyTable:
            ExplainModifyTarget((ModifyTable *) plan, es);
            break;
        case T_NestLoop:
        case T_MergeJoin:
        case T_HashJoin:
            {
                const char *jointype;
 
                switch (((Join *) plan)->jointype)
                {
                    case JOIN_INNER:
                        jointype = "Inner";
                        break;
                    case JOIN_LEFT:
                        jointype = "Left";
                        break;
                    case JOIN_FULL:
                        jointype = "Full";
                        break;
                    case JOIN_RIGHT:
                        jointype = "Right";
                        break;
                    case JOIN_SEMI:
                        jointype = "Semi";
                        break;
                    case JOIN_ANTI:
                        jointype = "Anti";
                        break;
                    case JOIN_RIGHT_ANTI:
                        jointype = "Right Anti";
                        break;
                    default:
                        jointype = "???";
                        break;
                }
                if (es->format == EXPLAIN_FORMAT_TEXT)
                {
                    /*
                     * For historical reasons, the join type is interpolated
                     * into the node type name...
                     */
                    if (((Join *) plan)->jointype != JOIN_INNER)
                        appendStringInfo(es->str, " %s Join", jointype);
                    else if (!IsA(plan, NestLoop))
                        appendStringInfoString(es->str, " Join");
                }
                else
                    ExplainPropertyText("Join Type", jointype, es);
            }
            break;
        case T_SetOp:
            {
                const char *setopcmd;
 
                switch (((SetOp *) plan)->cmd)
                {
                    case SETOPCMD_INTERSECT:
                        setopcmd = "Intersect";
                        break;
                    case SETOPCMD_INTERSECT_ALL:
                        setopcmd = "Intersect All";
                        break;
                    case SETOPCMD_EXCEPT:
                        setopcmd = "Except";
                        break;
                    case SETOPCMD_EXCEPT_ALL:
                        setopcmd = "Except All";
                        break;
                    default:
                        setopcmd = "???";
                        break;
                }
                if (es->format == EXPLAIN_FORMAT_TEXT)
                    appendStringInfo(es->str, " %s", setopcmd);
                else
                    ExplainPropertyText("Command", setopcmd, es);
            }
            break;
        default:
            break;
    }
 
    if (es->costs)
    {
        if (es->format == EXPLAIN_FORMAT_TEXT)
        {
            appendStringInfo(es->str, "  (cost=%.2f..%.2f rows=%.0f width=%d)",
                             plan->startup_cost, plan->total_cost,
                             plan->plan_rows, plan->plan_width);
        }
        else
        {
            ExplainPropertyFloat("Startup Cost", NULL, plan->startup_cost,
                                 2, es);
            ExplainPropertyFloat("Total Cost", NULL, plan->total_cost,
                                 2, es);
            ExplainPropertyFloat("Plan Rows", NULL, plan->plan_rows,
                                 0, es);
            ExplainPropertyInteger("Plan Width", NULL, plan->plan_width,
                                   es);
        }
    }
 
    /*
     * We have to forcibly clean up the instrumentation state because we
     * haven't done ExecutorEnd yet.  This is pretty grotty ...
     *
     * Note: contrib/auto_explain could cause instrumentation to be set up
     * even though we didn't ask for it here.  Be careful not to print any
     * instrumentation results the user didn't ask for.  But we do the
     * InstrEndLoop call anyway, if possible, to reduce the number of cases
     * auto_explain has to contend with.
     */
    if (planstate->instrument)
        InstrEndLoop(planstate->instrument);
 
    if (es->analyze &&
        planstate->instrument && planstate->instrument->nloops > 0)
    {
        double      nloops = planstate->instrument->nloops;
        double      startup_ms = 1000.0 * planstate->instrument->startup / nloops;
        double      total_ms = 1000.0 * planstate->instrument->total / nloops;
        double      rows = planstate->instrument->ntuples / nloops;
 
        if (es->format == EXPLAIN_FORMAT_TEXT)
        {
            if (es->timing)
                appendStringInfo(es->str,
                                 " (actual time=%.3f..%.3f rows=%.0f loops=%.0f)",
                                 startup_ms, total_ms, rows, nloops);
            else
                appendStringInfo(es->str,
                                 " (actual rows=%.0f loops=%.0f)",
                                 rows, nloops);
        }
        else
        {
            if (es->timing)
            {
                ExplainPropertyFloat("Actual Startup Time", "ms", startup_ms,
                                     3, es);
                ExplainPropertyFloat("Actual Total Time", "ms", total_ms,
                                     3, es);
            }
            ExplainPropertyFloat("Actual Rows", NULL, rows, 0, es);
            ExplainPropertyFloat("Actual Loops", NULL, nloops, 0, es);
        }
    }
    else if (es->analyze)
    {
        if (es->format == EXPLAIN_FORMAT_TEXT)
            appendStringInfoString(es->str, " (never executed)");
        else
        {
            if (es->timing)
            {
                ExplainPropertyFloat("Actual Startup Time", "ms", 0.0, 3, es);
                ExplainPropertyFloat("Actual Total Time", "ms", 0.0, 3, es);
            }
            ExplainPropertyFloat("Actual Rows", NULL, 0.0, 0, es);
            ExplainPropertyFloat("Actual Loops", NULL, 0.0, 0, es);
        }
    }
 
    /* in text format, first line ends here */
    if (es->format == EXPLAIN_FORMAT_TEXT)
        appendStringInfoChar(es->str, '\n');
 
    /* prepare per-worker general execution details */
    if (es->workers_state && es->verbose)
    {
        WorkerInstrumentation *w = planstate->worker_instrument;
 
        for (int n = 0; n < w->num_workers; n++)
        {
            Instrumentation *instrument = &w->instrument[n];
            double      nloops = instrument->nloops;
            double      startup_ms;
            double      total_ms;
            double      rows;
 
            if (nloops <= 0)
                continue;
            startup_ms = 1000.0 * instrument->startup / nloops;
            total_ms = 1000.0 * instrument->total / nloops;
            rows = instrument->ntuples / nloops;
 
            ExplainOpenWorker(n, es);
 
            if (es->format == EXPLAIN_FORMAT_TEXT)
            {
                ExplainIndentText(es);
                if (es->timing)
                    appendStringInfo(es->str,
                                     "actual time=%.3f..%.3f rows=%.0f loops=%.0f\n",
                                     startup_ms, total_ms, rows, nloops);
                else
                    appendStringInfo(es->str,
                                     "actual rows=%.0f loops=%.0f\n",
                                     rows, nloops);
            }
            else
            {
                if (es->timing)
                {
                    ExplainPropertyFloat("Actual Startup Time", "ms",
                                         startup_ms, 3, es);
                    ExplainPropertyFloat("Actual Total Time", "ms",
                                         total_ms, 3, es);
                }
                ExplainPropertyFloat("Actual Rows", NULL, rows, 0, es);
                ExplainPropertyFloat("Actual Loops", NULL, nloops, 0, es);
            }
 
            ExplainCloseWorker(n, es);
        }
    }
 
    /* target list */
    if (es->verbose)
        show_plan_tlist(planstate, ancestors, es);
 
    /* unique join */
    switch (nodeTag(plan))
    {
        case T_NestLoop:
        case T_MergeJoin:
        case T_HashJoin:
            /* try not to be too chatty about this in text mode */
            if (es->format != EXPLAIN_FORMAT_TEXT ||
                (es->verbose && ((Join *) plan)->inner_unique))
                ExplainPropertyBool("Inner Unique",
                                    ((Join *) plan)->inner_unique,
                                    es);
            break;
        default:
            break;
    }
 
    /* quals, sort keys, etc */
    switch (nodeTag(plan))
    {
        case T_IndexScan:
            show_scan_qual(((IndexScan *) plan)->indexqualorig,
                           "Index Cond", planstate, ancestors, es);
            if (((IndexScan *) plan)->indexqualorig)
                show_instrumentation_count("Rows Removed by Index Recheck", 2,
                                           planstate, es);
            show_scan_qual(((IndexScan *) plan)->indexorderbyorig,
                           "Order By", planstate, ancestors, es);
            show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 1,
                                           planstate, es);
            break;
        case T_IndexOnlyScan:
            show_scan_qual(((IndexOnlyScan *) plan)->indexqual,
                           "Index Cond", planstate, ancestors, es);
            if (((IndexOnlyScan *) plan)->recheckqual)
                show_instrumentation_count("Rows Removed by Index Recheck", 2,
                                           planstate, es);
            show_scan_qual(((IndexOnlyScan *) plan)->indexorderby,
                           "Order By", planstate, ancestors, es);
            show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 1,
                                           planstate, es);
            if (es->analyze)
                ExplainPropertyFloat("Heap Fetches", NULL,
                                     planstate->instrument->ntuples2, 0, es);
            break;
        case T_BitmapIndexScan:
            show_scan_qual(((BitmapIndexScan *) plan)->indexqualorig,
                           "Index Cond", planstate, ancestors, es);
            break;
        case T_BitmapHeapScan:
            show_scan_qual(((BitmapHeapScan *) plan)->bitmapqualorig,
                           "Recheck Cond", planstate, ancestors, es);
            if (((BitmapHeapScan *) plan)->bitmapqualorig)
                show_instrumentation_count("Rows Removed by Index Recheck", 2,
                                           planstate, es);
            show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 1,
                                           planstate, es);
            if (es->analyze)
                show_tidbitmap_info((BitmapHeapScanState *) planstate, es);
            break;
        case T_SampleScan:
            show_tablesample(((SampleScan *) plan)->tablesample,
                             planstate, ancestors, es);
            /* fall through to print additional fields the same as SeqScan */
            /* FALLTHROUGH */
        case T_SeqScan:
        case T_ValuesScan:
        case T_CteScan:
        case T_NamedTuplestoreScan:
        case T_WorkTableScan:
        case T_SubqueryScan:
            show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 1,
                                           planstate, es);
            break;
        case T_Gather:
            {
                Gather     *gather = (Gather *) plan;
 
                show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
                if (plan->qual)
                    show_instrumentation_count("Rows Removed by Filter", 1,
                                               planstate, es);
                ExplainPropertyInteger("Workers Planned", NULL,
                                       gather->num_workers, es);
 
                /* Show params evaluated at gather node */
                if (gather->initParam)
                    show_eval_params(gather->initParam, es);
 
                if (es->analyze)
                {
                    int         nworkers;
 
                    nworkers = ((GatherState *) planstate)->nworkers_launched;
                    ExplainPropertyInteger("Workers Launched", NULL,
                                           nworkers, es);
                }
 
                if (gather->single_copy || es->format != EXPLAIN_FORMAT_TEXT)
                    ExplainPropertyBool("Single Copy", gather->single_copy, es);
            }
            break;
        case T_GatherMerge:
            {
                GatherMerge *gm = (GatherMerge *) plan;
 
                show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
                if (plan->qual)
                    show_instrumentation_count("Rows Removed by Filter", 1,
                                               planstate, es);
                ExplainPropertyInteger("Workers Planned", NULL,
                                       gm->num_workers, es);
 
                /* Show params evaluated at gather-merge node */
                if (gm->initParam)
                    show_eval_params(gm->initParam, es);
 
                if (es->analyze)
                {
                    int         nworkers;
 
                    nworkers = ((GatherMergeState *) planstate)->nworkers_launched;
                    ExplainPropertyInteger("Workers Launched", NULL,
                                           nworkers, es);
                }
            }
            break;
        case T_FunctionScan:
            if (es->verbose)
            {
                List       *fexprs = NIL;
                ListCell   *lc;
 
                foreach(lc, ((FunctionScan *) plan)->functions)
                {
                    RangeTblFunction *rtfunc = (RangeTblFunction *) lfirst(lc);
 
                    fexprs = lappend(fexprs, rtfunc->funcexpr);
                }
                /* We rely on show_expression to insert commas as needed */
                show_expression((Node *) fexprs,
                                "Function Call", planstate, ancestors,
                                es->verbose, es);
            }
            show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 1,
                                           planstate, es);
            break;
        case T_TableFuncScan:
            if (es->verbose)
            {
                TableFunc  *tablefunc = ((TableFuncScan *) plan)->tablefunc;
 
                show_expression((Node *) tablefunc,
                                "Table Function Call", planstate, ancestors,
                                es->verbose, es);
            }
            show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 1,
                                           planstate, es);
            break;
        case T_TidScan:
            {
                /*
                 * The tidquals list has OR semantics, so be sure to show it
                 * as an OR condition.
                 */
                List       *tidquals = ((TidScan *) plan)->tidquals;
 
                if (list_length(tidquals) > 1)
                    tidquals = list_make1(make_orclause(tidquals));
                show_scan_qual(tidquals, "TID Cond", planstate, ancestors, es);
                show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
                if (plan->qual)
                    show_instrumentation_count("Rows Removed by Filter", 1,
                                               planstate, es);
            }
            break;
        case T_TidRangeScan:
            {
                /*
                 * The tidrangequals list has AND semantics, so be sure to
                 * show it as an AND condition.
                 */
                List       *tidquals = ((TidRangeScan *) plan)->tidrangequals;
 
                if (list_length(tidquals) > 1)
                    tidquals = list_make1(make_andclause(tidquals));
                show_scan_qual(tidquals, "TID Cond", planstate, ancestors, es);
                show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
                if (plan->qual)
                    show_instrumentation_count("Rows Removed by Filter", 1,
                                               planstate, es);
            }
            break;
        case T_ForeignScan:
            show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 1,
                                           planstate, es);
            show_foreignscan_info((ForeignScanState *) planstate, es);
            break;
        case T_CustomScan:
            {
                CustomScanState *css = (CustomScanState *) planstate;
 
                show_scan_qual(plan->qual, "Filter", planstate, ancestors, es);
                if (plan->qual)
                    show_instrumentation_count("Rows Removed by Filter", 1,
                                               planstate, es);
                if (css->methods->ExplainCustomScan)
                    css->methods->ExplainCustomScan(css, ancestors, es);
            }
            break;
        case T_NestLoop:
            show_upper_qual(((NestLoop *) plan)->join.joinqual,
                            "Join Filter", planstate, ancestors, es);
            if (((NestLoop *) plan)->join.joinqual)
                show_instrumentation_count("Rows Removed by Join Filter", 1,
                                           planstate, es);
            show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 2,
                                           planstate, es);
            break;
        case T_MergeJoin:
            show_upper_qual(((MergeJoin *) plan)->mergeclauses,
                            "Merge Cond", planstate, ancestors, es);
            show_upper_qual(((MergeJoin *) plan)->join.joinqual,
                            "Join Filter", planstate, ancestors, es);
            if (((MergeJoin *) plan)->join.joinqual)
                show_instrumentation_count("Rows Removed by Join Filter", 1,
                                           planstate, es);
            show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 2,
                                           planstate, es);
            break;
        case T_HashJoin:
            show_upper_qual(((HashJoin *) plan)->hashclauses,
                            "Hash Cond", planstate, ancestors, es);
            show_upper_qual(((HashJoin *) plan)->join.joinqual,
                            "Join Filter", planstate, ancestors, es);
            if (((HashJoin *) plan)->join.joinqual)
                show_instrumentation_count("Rows Removed by Join Filter", 1,
                                           planstate, es);
            show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 2,
                                           planstate, es);
            break;
        case T_Agg:
            show_agg_keys(castNode(AggState, planstate), ancestors, es);
            show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
            show_hashagg_info((AggState *) planstate, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 1,
                                           planstate, es);
            break;
        case T_WindowAgg:
            show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 1,
                                           planstate, es);
            show_upper_qual(((WindowAgg *) plan)->runConditionOrig,
                            "Run Condition", planstate, ancestors, es);
            break;
        case T_Group:
            show_group_keys(castNode(GroupState, planstate), ancestors, es);
            show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 1,
                                           planstate, es);
            break;
        case T_Sort:
            show_sort_keys(castNode(SortState, planstate), ancestors, es);
            show_sort_info(castNode(SortState, planstate), es);
            break;
        case T_IncrementalSort:
            show_incremental_sort_keys(castNode(IncrementalSortState, planstate),
                                       ancestors, es);
            show_incremental_sort_info(castNode(IncrementalSortState, planstate),
                                       es);
            break;
        case T_MergeAppend:
            show_merge_append_keys(castNode(MergeAppendState, planstate),
                                   ancestors, es);
            break;
        case T_Result:
            show_upper_qual((List *) ((Result *) plan)->resconstantqual,
                            "One-Time Filter", planstate, ancestors, es);
            show_upper_qual(plan->qual, "Filter", planstate, ancestors, es);
            if (plan->qual)
                show_instrumentation_count("Rows Removed by Filter", 1,
                                           planstate, es);
            break;
        case T_ModifyTable:
            show_modifytable_info(castNode(ModifyTableState, planstate), ancestors,
                                  es);
            break;
        case T_Hash:
            show_hash_info(castNode(HashState, planstate), es);
            break;
        case T_Memoize:
            show_memoize_info(castNode(MemoizeState, planstate), ancestors,
                              es);
            break;
        default:
            break;
    }
 
    /*
     * Prepare per-worker JIT instrumentation.  As with the overall JIT
     * summary, this is printed only if printing costs is enabled.
     */
    if (es->workers_state && es->costs && es->verbose)
    {
        SharedJitInstrumentation *w = planstate->worker_jit_instrument;
 
        if (w)
        {
            for (int n = 0; n < w->num_workers; n++)
            {
                ExplainOpenWorker(n, es);
                ExplainPrintJIT(es, planstate->state->es_jit_flags,
                                &w->jit_instr[n]);
                ExplainCloseWorker(n, es);
            }
        }
    }
 
    /* Show buffer/WAL usage */
    if (es->buffers && planstate->instrument)
        show_buffer_usage(es, &planstate->instrument->bufusage, false);
    if (es->wal && planstate->instrument)
        show_wal_usage(es, &planstate->instrument->walusage);
 
    /* Prepare per-worker buffer/WAL usage */
    if (es->workers_state && (es->buffers || es->wal) && es->verbose)
    {
        WorkerInstrumentation *w = planstate->worker_instrument;
 
        for (int n = 0; n < w->num_workers; n++)
        {
            Instrumentation *instrument = &w->instrument[n];
            double      nloops = instrument->nloops;
 
            if (nloops <= 0)
                continue;
 
            ExplainOpenWorker(n, es);
            if (es->buffers)
                show_buffer_usage(es, &instrument->bufusage, false);
            if (es->wal)
                show_wal_usage(es, &instrument->walusage);
            ExplainCloseWorker(n, es);
        }
    }
 
    /* Show per-worker details for this plan node, then pop that stack */
    if (es->workers_state)
        ExplainFlushWorkersState(es);
    es->workers_state = save_workers_state;
 
    /*
     * If partition pruning was done during executor initialization, the
     * number of child plans we'll display below will be less than the number
     * of subplans that was specified in the plan.  To make this a bit less
     * mysterious, emit an indication that this happened.  Note that this
     * field is emitted now because we want it to be a property of the parent
     * node; it *cannot* be emitted within the Plans sub-node we'll open next.
     */
    switch (nodeTag(plan))
    {
        case T_Append:
            ExplainMissingMembers(((AppendState *) planstate)->as_nplans,
                                  list_length(((Append *) plan)->appendplans),
                                  es);
            break;
        case T_MergeAppend:
            ExplainMissingMembers(((MergeAppendState *) planstate)->ms_nplans,
                                  list_length(((MergeAppend *) plan)->mergeplans),
                                  es);
            break;
        default:
            break;
    }
 
    /* Get ready to display the child plans */
    haschildren = planstate->initPlan ||
        outerPlanState(planstate) ||
        innerPlanState(planstate) ||
        IsA(plan, Append) ||
        IsA(plan, MergeAppend) ||
        IsA(plan, BitmapAnd) ||
        IsA(plan, BitmapOr) ||
        IsA(plan, SubqueryScan) ||
        (IsA(planstate, CustomScanState) &&
         ((CustomScanState *) planstate)->custom_ps != NIL) ||
        planstate->subPlan;
    if (haschildren)
    {
        ExplainOpenGroup("Plans", "Plans", false, es);
        /* Pass current Plan as head of ancestors list for children */
        ancestors = lcons(plan, ancestors);
    }
 
    /* initPlan-s */
    if (planstate->initPlan)
        ExplainSubPlans(planstate->initPlan, ancestors, "InitPlan", es);
 
    /* lefttree */
    if (outerPlanState(planstate))
        ExplainNode(outerPlanState(planstate), ancestors,
                    "Outer", NULL, es);
 
    /* righttree */
    if (innerPlanState(planstate))
        ExplainNode(innerPlanState(planstate), ancestors,
                    "Inner", NULL, es);
 
    /* special child plans */
    switch (nodeTag(plan))
    {
        case T_Append:
            ExplainMemberNodes(((AppendState *) planstate)->appendplans,
                               ((AppendState *) planstate)->as_nplans,
                               ancestors, es);
            break;
        case T_MergeAppend:
            ExplainMemberNodes(((MergeAppendState *) planstate)->mergeplans,
                               ((MergeAppendState *) planstate)->ms_nplans,
                               ancestors, es);
            break;
        case T_BitmapAnd:
            ExplainMemberNodes(((BitmapAndState *) planstate)->bitmapplans,
                               ((BitmapAndState *) planstate)->nplans,
                               ancestors, es);
            break;
        case T_BitmapOr:
            ExplainMemberNodes(((BitmapOrState *) planstate)->bitmapplans,
                               ((BitmapOrState *) planstate)->nplans,
                               ancestors, es);
            break;
        case T_SubqueryScan:
            ExplainNode(((SubqueryScanState *) planstate)->subplan, ancestors,
                        "Subquery", NULL, es);
            break;
        case T_CustomScan:
            ExplainCustomChildren((CustomScanState *) planstate,
                                  ancestors, es);
            break;
        default:
            break;
    }
 
    /* subPlan-s */
    if (planstate->subPlan)
        ExplainSubPlans(planstate->subPlan, ancestors, "SubPlan", es);
 
    /* end of child plans */
    if (haschildren)
    {
        ancestors = list_delete_first(ancestors);
        ExplainCloseGroup("Plans", "Plans", false, es);
    }
 
    /* in text format, undo whatever indentation we added */
    if (es->format == EXPLAIN_FORMAT_TEXT)
        es->indent = save_indent;
 
    ExplainCloseGroup("Plan",
                      relationship ? NULL : "Plan",
                      true, es);
}

References AGG_HASHED, AGG_MIXED, AGG_PLAIN, AGG_SORTED, Agg::aggsplit, Agg::aggstrategy, ExplainState::analyze, appendStringInfo(), appendStringInfoChar(), appendStringInfoString(), ExplainState::buffers, Instrumentation::bufusage, castNode, CMD_DELETE, CMD_INSERT, CMD_MERGE, CMD_SELECT, CMD_UPDATE, ExplainState::costs, DO_AGGSPLIT_COMBINE, DO_AGGSPLIT_SKIPFINAL, EState::es_jit_flags, EXPLAIN_FORMAT_TEXT, explain_get_index_name(), ExplainCloseGroup(), ExplainCloseWorker(), ExplainCreateWorkersState(), ExplainCustomChildren(), CustomExecMethods::ExplainCustomScan, ExplainFlushWorkersState(), ExplainIndentText(), ExplainIndexScanDetails(), ExplainMemberNodes(), ExplainMissingMembers(), ExplainModifyTarget(), ExplainOpenGroup(), ExplainOpenWorker(), ExplainPrintJIT(), ExplainPropertyBool(), ExplainPropertyFloat(), ExplainPropertyInteger(), ExplainPropertyText(), ExplainScanTarget(), ExplainSubPlans(), ExplainState::format, RangeTblFunction::funcexpr, functions, ExplainState::hide_workers, if(), ExplainState::indent, IndexScan::indexid, IndexOnlyScan::indexid, BitmapIndexScan::indexid, IndexScan::indexorderdir, IndexOnlyScan::indexorderdir, Gather::initParam, GatherMerge::initParam, PlanState::initPlan, innerPlanState, InstrEndLoop(), WorkerInstrumentation::instrument, PlanState::instrument, IsA, SharedJitInstrumentation::jit_instr, JOIN_ANTI, JOIN_FULL, JOIN_INNER, JOIN_LEFT, JOIN_RIGHT, JOIN_RIGHT_ANTI, JOIN_SEMI, lappend(), lcons(), lfirst, list_delete_first(), list_length(), list_make1, make_andclause(), make_orclause(), CustomScanState::methods, NIL, Instrumentation::nloops, nodeTag, Instrumentation::ntuples, Instrumentation::ntuples2, WorkerInstrumentation::num_workers, SharedJitInstrumentation::num_workers, Gather::num_workers, GatherMerge::num_workers, outerPlanState, PlanState::plan, plan, psprintf(), quote_identifier(), SETOP_HASHED, SETOP_SORTED, SETOPCMD_EXCEPT, SETOPCMD_EXCEPT_ALL, SETOPCMD_INTERSECT, SETOPCMD_INTERSECT_ALL, show_agg_keys(), show_buffer_usage(), show_eval_params(), show_expression(), show_foreignscan_info(), show_group_keys(), show_hash_info(), show_hashagg_info(), show_incremental_sort_info(), show_incremental_sort_keys(), show_instrumentation_count(), show_memoize_info(), show_merge_append_keys(), show_modifytable_info(), show_plan_tlist(), show_scan_qual(), show_sort_info(), show_sort_keys(), show_tablesample(), show_tidbitmap_info(), show_upper_qual(), show_wal_usage(), Gather::single_copy, Instrumentation::startup, PlanState::state, ExplainState::str, PlanState::subPlan, ExplainState::timing, Instrumentation::total, ExplainState::verbose, ExplainState::wal, Instrumentation::walusage, PlanState::worker_instrument, PlanState::worker_jit_instrument, and ExplainState::workers_state.

Referenced by ExplainCustomChildren(), ExplainMemberNodes(), ExplainPrintPlan(), and ExplainSubPlans().

ExplainOnePlan()

void ExplainOnePlan	(	PlannedStmt *	plannedstmt,
		IntoClause *	into,
		ExplainState *	es,
		const char *	queryString,
		ParamListInfo	params,
		QueryEnvironment *	queryEnv,
		const instr_time *	planduration,
		const BufferUsage *	bufusage
	)

Definition at line 527 of file explain.c.

{
    DestReceiver *dest;
    QueryDesc  *queryDesc;
    instr_time  starttime;
    double      totaltime = 0;
    int         eflags;
    int         instrument_option = 0;
 
    Assert(plannedstmt->commandType != CMD_UTILITY);
 
    if (es->analyze && es->timing)
        instrument_option |= INSTRUMENT_TIMER;
    else if (es->analyze)
        instrument_option |= INSTRUMENT_ROWS;
 
    if (es->buffers)
        instrument_option |= INSTRUMENT_BUFFERS;
    if (es->wal)
        instrument_option |= INSTRUMENT_WAL;
 
    /*
     * We always collect timing for the entire statement, even when node-level
     * timing is off, so we don't look at es->timing here.  (We could skip
     * this if !es->summary, but it's hardly worth the complication.)
     */
    INSTR_TIME_SET_CURRENT(starttime);
 
    /*
     * Use a snapshot with an updated command ID to ensure this query sees
     * results of any previously executed queries.
     */
    PushCopiedSnapshot(GetActiveSnapshot());
    UpdateActiveSnapshotCommandId();
 
    /*
     * Normally we discard the query's output, but if explaining CREATE TABLE
     * AS, we'd better use the appropriate tuple receiver.
     */
    if (into)
        dest = CreateIntoRelDestReceiver(into);
    else
        dest = None_Receiver;
 
    /* Create a QueryDesc for the query */
    queryDesc = CreateQueryDesc(plannedstmt, queryString,
                                GetActiveSnapshot(), InvalidSnapshot,
                                dest, params, queryEnv, instrument_option);
 
    /* Select execution options */
    if (es->analyze)
        eflags = 0;             /* default run-to-completion flags */
    else
        eflags = EXEC_FLAG_EXPLAIN_ONLY;
    if (es->generic)
        eflags |= EXEC_FLAG_EXPLAIN_GENERIC;
    if (into)
        eflags |= GetIntoRelEFlags(into);
 
    /* call ExecutorStart to prepare the plan for execution */
    ExecutorStart(queryDesc, eflags);
 
    /* Execute the plan for statistics if asked for */
    if (es->analyze)
    {
        ScanDirection dir;
 
        /* EXPLAIN ANALYZE CREATE TABLE AS WITH NO DATA is weird */
        if (into && into->skipData)
            dir = NoMovementScanDirection;
        else
            dir = ForwardScanDirection;
 
        /* run the plan */
        ExecutorRun(queryDesc, dir, 0, true);
 
        /* run cleanup too */
        ExecutorFinish(queryDesc);
 
        /* We can't run ExecutorEnd 'till we're done printing the stats... */
        totaltime += elapsed_time(&starttime);
    }
 
    ExplainOpenGroup("Query", NULL, true, es);
 
    /* Create textual dump of plan tree */
    ExplainPrintPlan(es, queryDesc);
 
    /* Show buffer usage in planning */
    if (bufusage)
    {
        ExplainOpenGroup("Planning", "Planning", true, es);
        show_buffer_usage(es, bufusage, true);
        ExplainCloseGroup("Planning", "Planning", true, es);
    }
 
    if (es->summary && planduration)
    {
        double      plantime = INSTR_TIME_GET_DOUBLE(*planduration);
 
        ExplainPropertyFloat("Planning Time", "ms", 1000.0 * plantime, 3, es);
    }
 
    /* Print info about runtime of triggers */
    if (es->analyze)
        ExplainPrintTriggers(es, queryDesc);
 
    /*
     * Print info about JITing. Tied to es->costs because we don't want to
     * display this in regression tests, as it'd cause output differences
     * depending on build options.  Might want to separate that out from COSTS
     * at a later stage.
     */
    if (es->costs)
        ExplainPrintJITSummary(es, queryDesc);
 
    /*
     * Close down the query and free resources.  Include time for this in the
     * total execution time (although it should be pretty minimal).
     */
    INSTR_TIME_SET_CURRENT(starttime);
 
    ExecutorEnd(queryDesc);
 
    FreeQueryDesc(queryDesc);
 
    PopActiveSnapshot();
 
    /* We need a CCI just in case query expanded to multiple plans */
    if (es->analyze)
        CommandCounterIncrement();
 
    totaltime += elapsed_time(&starttime);
 
    /*
     * We only report execution time if we actually ran the query (that is,
     * the user specified ANALYZE), and if summary reporting is enabled (the
     * user can set SUMMARY OFF to not have the timing information included in
     * the output).  By default, ANALYZE sets SUMMARY to true.
     */
    if (es->summary && es->analyze)
        ExplainPropertyFloat("Execution Time", "ms", 1000.0 * totaltime, 3,
                             es);
 
    ExplainCloseGroup("Query", NULL, true, es);
}

References ExplainState::analyze, Assert(), ExplainState::buffers, CMD_UTILITY, CommandCounterIncrement(), PlannedStmt::commandType, ExplainState::costs, CreateIntoRelDestReceiver(), CreateQueryDesc(), generate_unaccent_rules::dest, elapsed_time(), EXEC_FLAG_EXPLAIN_GENERIC, EXEC_FLAG_EXPLAIN_ONLY, ExecutorEnd(), ExecutorFinish(), ExecutorRun(), ExecutorStart(), ExplainCloseGroup(), ExplainOpenGroup(), ExplainPrintJITSummary(), ExplainPrintPlan(), ExplainPrintTriggers(), ExplainPropertyFloat(), ForwardScanDirection, FreeQueryDesc(), ExplainState::generic, GetActiveSnapshot(), GetIntoRelEFlags(), INSTR_TIME_GET_DOUBLE, INSTR_TIME_SET_CURRENT, INSTRUMENT_BUFFERS, INSTRUMENT_ROWS, INSTRUMENT_TIMER, INSTRUMENT_WAL, InvalidSnapshot, NoMovementScanDirection, None_Receiver, PopActiveSnapshot(), PushCopiedSnapshot(), show_buffer_usage(), IntoClause::skipData, ExplainState::summary, ExplainState::timing, UpdateActiveSnapshotCommandId(), and ExplainState::wal.

Referenced by ExplainExecuteQuery(), and ExplainOneQuery().

ExplainOneQuery()

static void ExplainOneQuery ( Query *  query, int  cursorOptions, IntoClause *  into, ExplainState *  es, const char *  queryString, ParamListInfo  params, QueryEnvironment *  queryEnv  )

static

Definition at line 376 of file explain.c.

{
    /* planner will not cope with utility statements */
    if (query->commandType == CMD_UTILITY)
    {
        ExplainOneUtility(query->utilityStmt, into, es, queryString, params,
                          queryEnv);
        return;
    }
 
    /* if an advisor plugin is present, let it manage things */
    if (ExplainOneQuery_hook)
        (*ExplainOneQuery_hook) (query, cursorOptions, into, es,
                                 queryString, params, queryEnv);
    else
    {
        PlannedStmt *plan;
        instr_time  planstart,
                    planduration;
        BufferUsage bufusage_start,
                    bufusage;
 
        if (es->buffers)
            bufusage_start = pgBufferUsage;
        INSTR_TIME_SET_CURRENT(planstart);
 
        /* plan the query */
        plan = pg_plan_query(query, queryString, cursorOptions, params);
 
        INSTR_TIME_SET_CURRENT(planduration);
        INSTR_TIME_SUBTRACT(planduration, planstart);
 
        /* calc differences of buffer counters. */
        if (es->buffers)
        {
            memset(&bufusage, 0, sizeof(BufferUsage));
            BufferUsageAccumDiff(&bufusage, &pgBufferUsage, &bufusage_start);
        }
 
        /* run it (if needed) and produce output */
        ExplainOnePlan(plan, into, es, queryString, params, queryEnv,
                       &planduration, (es->buffers ? &bufusage : NULL));
    }
}

References ExplainState::buffers, BufferUsageAccumDiff(), CMD_UTILITY, Query::commandType, ExplainOnePlan(), ExplainOneQuery_hook, ExplainOneUtility(), INSTR_TIME_SET_CURRENT, INSTR_TIME_SUBTRACT, pg_plan_query(), pgBufferUsage, plan, and Query::utilityStmt.

Referenced by ExplainOneUtility(), and ExplainQuery().

ExplainOneUtility()

void ExplainOneUtility	(	Node *	utilityStmt,
		IntoClause *	into,
		ExplainState *	es,
		const char *	queryString,
		ParamListInfo	params,
		QueryEnvironment *	queryEnv
	)

Definition at line 437 of file explain.c.

{
    if (utilityStmt == NULL)
        return;
 
    if (IsA(utilityStmt, CreateTableAsStmt))
    {
        /*
         * We have to rewrite the contained SELECT and then pass it back to
         * ExplainOneQuery.  Copy to be safe in the EXPLAIN EXECUTE case.
         */
        CreateTableAsStmt *ctas = (CreateTableAsStmt *) utilityStmt;
        List       *rewritten;
 
        /*
         * Check if the relation exists or not.  This is done at this stage to
         * avoid query planning or execution.
         */
        if (CreateTableAsRelExists(ctas))
        {
            if (ctas->objtype == OBJECT_TABLE)
                ExplainDummyGroup("CREATE TABLE AS", NULL, es);
            else if (ctas->objtype == OBJECT_MATVIEW)
                ExplainDummyGroup("CREATE MATERIALIZED VIEW", NULL, es);
            else
                elog(ERROR, "unexpected object type: %d",
                     (int) ctas->objtype);
            return;
        }
 
        rewritten = QueryRewrite(castNode(Query, copyObject(ctas->query)));
        Assert(list_length(rewritten) == 1);
        ExplainOneQuery(linitial_node(Query, rewritten),
                        CURSOR_OPT_PARALLEL_OK, ctas->into, es,
                        queryString, params, queryEnv);
    }
    else if (IsA(utilityStmt, DeclareCursorStmt))
    {
        /*
         * Likewise for DECLARE CURSOR.
         *
         * Notice that if you say EXPLAIN ANALYZE DECLARE CURSOR then we'll
         * actually run the query.  This is different from pre-8.3 behavior
         * but seems more useful than not running the query.  No cursor will
         * be created, however.
         */
        DeclareCursorStmt *dcs = (DeclareCursorStmt *) utilityStmt;
        List       *rewritten;
 
        rewritten = QueryRewrite(castNode(Query, copyObject(dcs->query)));
        Assert(list_length(rewritten) == 1);
        ExplainOneQuery(linitial_node(Query, rewritten),
                        dcs->options, NULL, es,
                        queryString, params, queryEnv);
    }
    else if (IsA(utilityStmt, ExecuteStmt))
        ExplainExecuteQuery((ExecuteStmt *) utilityStmt, into, es,
                            queryString, params, queryEnv);
    else if (IsA(utilityStmt, NotifyStmt))
    {
        if (es->format == EXPLAIN_FORMAT_TEXT)
            appendStringInfoString(es->str, "NOTIFY\n");
        else
            ExplainDummyGroup("Notify", NULL, es);
    }
    else
    {
        if (es->format == EXPLAIN_FORMAT_TEXT)
            appendStringInfoString(es->str,
                                   "Utility statements have no plan structure\n");
        else
            ExplainDummyGroup("Utility Statement", NULL, es);
    }
}

References appendStringInfoString(), Assert(), castNode, copyObject, CreateTableAsRelExists(), CURSOR_OPT_PARALLEL_OK, elog(), ERROR, EXPLAIN_FORMAT_TEXT, ExplainDummyGroup(), ExplainExecuteQuery(), ExplainOneQuery(), ExplainState::format, CreateTableAsStmt::into, IsA, linitial_node, list_length(), OBJECT_MATVIEW, OBJECT_TABLE, CreateTableAsStmt::objtype, DeclareCursorStmt::options, DeclareCursorStmt::query, CreateTableAsStmt::query, QueryRewrite(), and ExplainState::str.

Referenced by ExplainExecuteQuery(), and ExplainOneQuery().

ExplainOpenGroup()

void ExplainOpenGroup	(	const char *	objtype,
		const char *	labelname,
		bool	labeled,
		ExplainState *	es
	)

Definition at line 4627 of file explain.c.

{
    switch (es->format)
    {
        case EXPLAIN_FORMAT_TEXT:
            /* nothing to do */
            break;
 
        case EXPLAIN_FORMAT_XML:
            ExplainXMLTag(objtype, X_OPENING, es);
            es->indent++;
            break;
 
        case EXPLAIN_FORMAT_JSON:
            ExplainJSONLineEnding(es);
            appendStringInfoSpaces(es->str, 2 * es->indent);
            if (labelname)
            {
                escape_json(es->str, labelname);
                appendStringInfoString(es->str, ": ");
            }
            appendStringInfoChar(es->str, labeled ? '{' : '[');
 
            /*
             * In JSON format, the grouping_stack is an integer list.  0 means
             * we've emitted nothing at this grouping level, 1 means we've
             * emitted something (and so the next item needs a comma). See
             * ExplainJSONLineEnding().
             */
            es->grouping_stack = lcons_int(0, es->grouping_stack);
            es->indent++;
            break;
 
        case EXPLAIN_FORMAT_YAML:
 
            /*
             * In YAML format, the grouping stack is an integer list.  0 means
             * we've emitted nothing at this grouping level AND this grouping
             * level is unlabeled and must be marked with "- ".  See
             * ExplainYAMLLineStarting().
             */
            ExplainYAMLLineStarting(es);
            if (labelname)
            {
                appendStringInfo(es->str, "%s: ", labelname);
                es->grouping_stack = lcons_int(1, es->grouping_stack);
            }
            else
            {
                appendStringInfoString(es->str, "- ");
                es->grouping_stack = lcons_int(0, es->grouping_stack);
            }
            es->indent++;
            break;
    }
}

References appendStringInfo(), appendStringInfoChar(), appendStringInfoSpaces(), appendStringInfoString(), escape_json(), EXPLAIN_FORMAT_JSON, EXPLAIN_FORMAT_TEXT, EXPLAIN_FORMAT_XML, EXPLAIN_FORMAT_YAML, ExplainJSONLineEnding(), ExplainXMLTag(), ExplainYAMLLineStarting(), ExplainState::format, ExplainState::grouping_stack, ExplainState::indent, lcons_int(), ExplainState::str, and X_OPENING.

Referenced by ExplainFlushWorkersState(), ExplainNode(), ExplainOnePlan(), ExplainPrintJIT(), ExplainPrintSettings(), ExplainPrintTriggers(), report_triggers(), show_grouping_set_keys(), show_grouping_sets(), show_incremental_sort_group_info(), and show_modifytable_info().

ExplainOpenSetAsideGroup()

static void ExplainOpenSetAsideGroup ( const char *  objtype, const char *  labelname, bool  labeled, int  depth, ExplainState *  es  )

static

Definition at line 4737 of file explain.c.

{
    switch (es->format)
    {
        case EXPLAIN_FORMAT_TEXT:
            /* nothing to do */
            break;
 
        case EXPLAIN_FORMAT_XML:
            es->indent += depth;
            break;
 
        case EXPLAIN_FORMAT_JSON:
            es->grouping_stack = lcons_int(0, es->grouping_stack);
            es->indent += depth;
            break;
 
        case EXPLAIN_FORMAT_YAML:
            if (labelname)
                es->grouping_stack = lcons_int(1, es->grouping_stack);
            else
                es->grouping_stack = lcons_int(0, es->grouping_stack);
            es->indent += depth;
            break;
    }
}

References EXPLAIN_FORMAT_JSON, EXPLAIN_FORMAT_TEXT, EXPLAIN_FORMAT_XML, EXPLAIN_FORMAT_YAML, ExplainState::format, ExplainState::grouping_stack, ExplainState::indent, and lcons_int().

Referenced by ExplainOpenWorker().

ExplainOpenWorker()

static void ExplainOpenWorker ( int  n, ExplainState *  es  )

static

Definition at line 4258 of file explain.c.

{
    ExplainWorkersState *wstate = es->workers_state;
 
    Assert(wstate);
    Assert(n >= 0 && n < wstate->num_workers);
 
    /* Save prior output buffer pointer */
    wstate->prev_str = es->str;
 
    if (!wstate->worker_inited[n])
    {
        /* First time through, so create the buffer for this worker */
        initStringInfo(&wstate->worker_str[n]);
        es->str = &wstate->worker_str[n];
 
        /*
         * Push suitable initial formatting state for this worker's field
         * group.  We allow one extra logical nesting level, since this group
         * will eventually be wrapped in an outer "Workers" group.
         */
        ExplainOpenSetAsideGroup("Worker", NULL, true, 2, es);
 
        /*
         * In non-TEXT formats we always emit a "Worker Number" field, even if
         * there's no other data for this worker.
         */
        if (es->format != EXPLAIN_FORMAT_TEXT)
            ExplainPropertyInteger("Worker Number", NULL, n, es);
 
        wstate->worker_inited[n] = true;
    }
    else
    {
        /* Resuming output for a worker we've already emitted some data for */
        es->str = &wstate->worker_str[n];
 
        /* Restore formatting state saved by last ExplainCloseWorker() */
        ExplainRestoreGroup(es, 2, &wstate->worker_state_save[n]);
    }
 
    /*
     * In TEXT format, prefix the first output line for this worker with
     * "Worker N:".  Then, any additional lines should be indented one more
     * stop than the "Worker N" line is.
     */
    if (es->format == EXPLAIN_FORMAT_TEXT)
    {
        if (es->str->len == 0)
        {
            ExplainIndentText(es);
            appendStringInfo(es->str, "Worker %d:  ", n);
        }
 
        es->indent++;
    }
}

References appendStringInfo(), Assert(), EXPLAIN_FORMAT_TEXT, ExplainIndentText(), ExplainOpenSetAsideGroup(), ExplainPropertyInteger(), ExplainRestoreGroup(), ExplainState::format, ExplainState::indent, initStringInfo(), StringInfoData::len, ExplainWorkersState::prev_str, ExplainState::str, ExplainWorkersState::worker_inited, ExplainWorkersState::worker_state_save, ExplainWorkersState::worker_str, and ExplainState::workers_state.

Referenced by ExplainNode(), show_hashagg_info(), show_incremental_sort_info(), show_memoize_info(), and show_sort_info().

ExplainPreScanNode()

static bool ExplainPreScanNode ( PlanState *  planstate, Bitmapset **  rels_used  )

static

Definition at line 1111 of file explain.c.

{
    Plan       *plan = planstate->plan;
 
    switch (nodeTag(plan))
    {
        case T_SeqScan:
        case T_SampleScan:
        case T_IndexScan:
        case T_IndexOnlyScan:
        case T_BitmapHeapScan:
        case T_TidScan:
        case T_TidRangeScan:
        case T_SubqueryScan:
        case T_FunctionScan:
        case T_TableFuncScan:
        case T_ValuesScan:
        case T_CteScan:
        case T_NamedTuplestoreScan:
        case T_WorkTableScan:
            *rels_used = bms_add_member(*rels_used,
                                        ((Scan *) plan)->scanrelid);
            break;
        case T_ForeignScan:
            *rels_used = bms_add_members(*rels_used,
                                         ((ForeignScan *) plan)->fs_base_relids);
            break;
        case T_CustomScan:
            *rels_used = bms_add_members(*rels_used,
                                         ((CustomScan *) plan)->custom_relids);
            break;
        case T_ModifyTable:
            *rels_used = bms_add_member(*rels_used,
                                        ((ModifyTable *) plan)->nominalRelation);
            if (((ModifyTable *) plan)->exclRelRTI)
                *rels_used = bms_add_member(*rels_used,
                                            ((ModifyTable *) plan)->exclRelRTI);
            break;
        case T_Append:
            *rels_used = bms_add_members(*rels_used,
                                         ((Append *) plan)->apprelids);
            break;
        case T_MergeAppend:
            *rels_used = bms_add_members(*rels_used,
                                         ((MergeAppend *) plan)->apprelids);
            break;
        default:
            break;
    }
 
    return planstate_tree_walker(planstate, ExplainPreScanNode, rels_used);
}

References bms_add_member(), bms_add_members(), nodeTag, PlanState::plan, plan, and planstate_tree_walker.

Referenced by ExplainPrintPlan().

ExplainPrintJIT()

static void ExplainPrintJIT ( ExplainState *  es, int  jit_flags, JitInstrumentation *  ji  )

static

Definition at line 886 of file explain.c.

{
    instr_time  total_time;
 
    /* don't print information if no JITing happened */
    if (!ji || ji->created_functions == 0)
        return;
 
    /* calculate total time */
    INSTR_TIME_SET_ZERO(total_time);
    /* don't add deform_counter, it's included in generation_counter */
    INSTR_TIME_ADD(total_time, ji->generation_counter);
    INSTR_TIME_ADD(total_time, ji->inlining_counter);
    INSTR_TIME_ADD(total_time, ji->optimization_counter);
    INSTR_TIME_ADD(total_time, ji->emission_counter);
 
    ExplainOpenGroup("JIT", "JIT", true, es);
 
    /* for higher density, open code the text output format */
    if (es->format == EXPLAIN_FORMAT_TEXT)
    {
        ExplainIndentText(es);
        appendStringInfoString(es->str, "JIT:\n");
        es->indent++;
 
        ExplainPropertyInteger("Functions", NULL, ji->created_functions, es);
 
        ExplainIndentText(es);
        appendStringInfo(es->str, "Options: %s %s, %s %s, %s %s, %s %s\n",
                         "Inlining", jit_flags & PGJIT_INLINE ? "true" : "false",
                         "Optimization", jit_flags & PGJIT_OPT3 ? "true" : "false",
                         "Expressions", jit_flags & PGJIT_EXPR ? "true" : "false",
                         "Deforming", jit_flags & PGJIT_DEFORM ? "true" : "false");
 
        if (es->analyze && es->timing)
        {
            ExplainIndentText(es);
            appendStringInfo(es->str,
                             "Timing: %s %.3f ms (%s %.3f ms), %s %.3f ms, %s %.3f ms, %s %.3f ms, %s %.3f ms\n",
                             "Generation", 1000.0 * INSTR_TIME_GET_DOUBLE(ji->generation_counter),
                             "Deform", 1000.0 * INSTR_TIME_GET_DOUBLE(ji->deform_counter),
                             "Inlining", 1000.0 * INSTR_TIME_GET_DOUBLE(ji->inlining_counter),
                             "Optimization", 1000.0 * INSTR_TIME_GET_DOUBLE(ji->optimization_counter),
                             "Emission", 1000.0 * INSTR_TIME_GET_DOUBLE(ji->emission_counter),
                             "Total", 1000.0 * INSTR_TIME_GET_DOUBLE(total_time));
        }
 
        es->indent--;
    }
    else
    {
        ExplainPropertyInteger("Functions", NULL, ji->created_functions, es);
 
        ExplainOpenGroup("Options", "Options", true, es);
        ExplainPropertyBool("Inlining", jit_flags & PGJIT_INLINE, es);
        ExplainPropertyBool("Optimization", jit_flags & PGJIT_OPT3, es);
        ExplainPropertyBool("Expressions", jit_flags & PGJIT_EXPR, es);
        ExplainPropertyBool("Deforming", jit_flags & PGJIT_DEFORM, es);
        ExplainCloseGroup("Options", "Options", true, es);
 
        if (es->analyze && es->timing)
        {
            ExplainOpenGroup("Timing", "Timing", true, es);
 
            ExplainOpenGroup("Generation", "Generation", true, es);
            ExplainPropertyFloat("Deform", "ms",
                                 1000.0 * INSTR_TIME_GET_DOUBLE(ji->deform_counter),
                                 3, es);
            ExplainPropertyFloat("Total", "ms",
                                 1000.0 * INSTR_TIME_GET_DOUBLE(ji->generation_counter),
                                 3, es);
            ExplainCloseGroup("Generation", "Generation", true, es);
 
            ExplainPropertyFloat("Inlining", "ms",
                                 1000.0 * INSTR_TIME_GET_DOUBLE(ji->inlining_counter),
                                 3, es);
            ExplainPropertyFloat("Optimization", "ms",
                                 1000.0 * INSTR_TIME_GET_DOUBLE(ji->optimization_counter),
                                 3, es);
            ExplainPropertyFloat("Emission", "ms",
                                 1000.0 * INSTR_TIME_GET_DOUBLE(ji->emission_counter),
                                 3, es);
            ExplainPropertyFloat("Total", "ms",
                                 1000.0 * INSTR_TIME_GET_DOUBLE(total_time),
                                 3, es);
 
            ExplainCloseGroup("Timing", "Timing", true, es);
        }
    }
 
    ExplainCloseGroup("JIT", "JIT", true, es);
}

References ExplainState::analyze, appendStringInfo(), appendStringInfoString(), JitInstrumentation::created_functions, JitInstrumentation::deform_counter, JitInstrumentation::emission_counter, EXPLAIN_FORMAT_TEXT, ExplainCloseGroup(), ExplainIndentText(), ExplainOpenGroup(), ExplainPropertyBool(), ExplainPropertyFloat(), ExplainPropertyInteger(), ExplainState::format, JitInstrumentation::generation_counter, ExplainState::indent, JitInstrumentation::inlining_counter, INSTR_TIME_ADD, INSTR_TIME_GET_DOUBLE, INSTR_TIME_SET_ZERO, JitInstrumentation::optimization_counter, PGJIT_DEFORM, PGJIT_EXPR, PGJIT_INLINE, PGJIT_OPT3, ExplainState::str, and ExplainState::timing.

Referenced by ExplainNode(), and ExplainPrintJITSummary().

ExplainPrintJITSummary()

void ExplainPrintJITSummary	(	ExplainState *	es,
		QueryDesc *	queryDesc
	)

Definition at line 860 of file explain.c.

{
    JitInstrumentation ji = {0};
 
    if (!(queryDesc->estate->es_jit_flags & PGJIT_PERFORM))
        return;
 
    /*
     * Work with a copy instead of modifying the leader state, since this
     * function may be called twice
     */
    if (queryDesc->estate->es_jit)
        InstrJitAgg(&ji, &queryDesc->estate->es_jit->instr);
 
    /* If this process has done JIT in parallel workers, merge stats */
    if (queryDesc->estate->es_jit_worker_instr)
        InstrJitAgg(&ji, queryDesc->estate->es_jit_worker_instr);
 
    ExplainPrintJIT(es, queryDesc->estate->es_jit_flags, &ji);
}

References EState::es_jit, EState::es_jit_flags, EState::es_jit_worker_instr, QueryDesc::estate, ExplainPrintJIT(), JitContext::instr, InstrJitAgg(), and PGJIT_PERFORM.

Referenced by explain_ExecutorEnd(), and ExplainOnePlan().

ExplainPrintPlan()

void ExplainPrintPlan	(	ExplainState *	es,
		QueryDesc *	queryDesc
	)

Definition at line 752 of file explain.c.

{
    Bitmapset  *rels_used = NULL;
    PlanState  *ps;
 
    /* Set up ExplainState fields associated with this plan tree */
    Assert(queryDesc->plannedstmt != NULL);
    es->pstmt = queryDesc->plannedstmt;
    es->rtable = queryDesc->plannedstmt->rtable;
    ExplainPreScanNode(queryDesc->planstate, &rels_used);
    es->rtable_names = select_rtable_names_for_explain(es->rtable, rels_used);
    es->deparse_cxt = deparse_context_for_plan_tree(queryDesc->plannedstmt,
                                                    es->rtable_names);
    es->printed_subplans = NULL;
 
    /*
     * Sometimes we mark a Gather node as "invisible", which means that it's
     * not to be displayed in EXPLAIN output.  The purpose of this is to allow
     * running regression tests with debug_parallel_query=regress to get the
     * same results as running the same tests with debug_parallel_query=off.
     * Such marking is currently only supported on a Gather at the top of the
     * plan.  We skip that node, and we must also hide per-worker detail data
     * further down in the plan tree.
     */
    ps = queryDesc->planstate;
    if (IsA(ps, GatherState) && ((Gather *) ps->plan)->invisible)
    {
        ps = outerPlanState(ps);
        es->hide_workers = true;
    }
    ExplainNode(ps, NIL, NULL, NULL, es);
 
    /*
     * If requested, include information about GUC parameters with values that
     * don't match the built-in defaults.
     */
    ExplainPrintSettings(es);
 
    /*
     * COMPUTE_QUERY_ID_REGRESS means COMPUTE_QUERY_ID_AUTO, but we don't show
     * the queryid in any of the EXPLAIN plans to keep stable the results
     * generated by regression test suites.
     */
    if (es->verbose && queryDesc->plannedstmt->queryId != UINT64CONST(0) &&
        compute_query_id != COMPUTE_QUERY_ID_REGRESS)
    {
        /*
         * Output the queryid as an int64 rather than a uint64 so we match
         * what would be seen in the BIGINT pg_stat_statements.queryid column.
         */
        ExplainPropertyInteger("Query Identifier", NULL, (int64)
                               queryDesc->plannedstmt->queryId, es);
    }
}

References Assert(), compute_query_id, COMPUTE_QUERY_ID_REGRESS, deparse_context_for_plan_tree(), ExplainState::deparse_cxt, ExplainNode(), ExplainPreScanNode(), ExplainPrintSettings(), ExplainPropertyInteger(), ExplainState::hide_workers, IsA, NIL, outerPlanState, QueryDesc::plannedstmt, QueryDesc::planstate, ExplainState::printed_subplans, ps, ExplainState::pstmt, PlannedStmt::queryId, ExplainState::rtable, PlannedStmt::rtable, ExplainState::rtable_names, select_rtable_names_for_explain(), and ExplainState::verbose.

Referenced by explain_ExecutorEnd(), and ExplainOnePlan().

ExplainPrintSettings()

static void ExplainPrintSettings ( ExplainState *  es )

static

Definition at line 682 of file explain.c.

{
    int         num;
    struct config_generic **gucs;
 
    /* bail out if information about settings not requested */
    if (!es->settings)
        return;
 
    /* request an array of relevant settings */
    gucs = get_explain_guc_options(&num);
 
    if (es->format != EXPLAIN_FORMAT_TEXT)
    {
        ExplainOpenGroup("Settings", "Settings", true, es);
 
        for (int i = 0; i < num; i++)
        {
            char       *setting;
            struct config_generic *conf = gucs[i];
 
            setting = GetConfigOptionByName(conf->name, NULL, true);
 
            ExplainPropertyText(conf->name, setting, es);
        }
 
        ExplainCloseGroup("Settings", "Settings", true, es);
    }
    else
    {
        StringInfoData str;
 
        /* In TEXT mode, print nothing if there are no options */
        if (num <= 0)
            return;
 
        initStringInfo(&str);
 
        for (int i = 0; i < num; i++)
        {
            char       *setting;
            struct config_generic *conf = gucs[i];
 
            if (i > 0)
                appendStringInfoString(&str, ", ");
 
            setting = GetConfigOptionByName(conf->name, NULL, true);
 
            if (setting)
                appendStringInfo(&str, "%s = '%s'", conf->name, setting);
            else
                appendStringInfo(&str, "%s = NULL", conf->name);
        }
 
        ExplainPropertyText("Settings", str.data, es);
    }
}

References appendStringInfo(), appendStringInfoString(), EXPLAIN_FORMAT_TEXT, ExplainCloseGroup(), ExplainOpenGroup(), ExplainPropertyText(), ExplainState::format, get_explain_guc_options(), GetConfigOptionByName(), i, initStringInfo(), config_generic::name, ExplainState::settings, and generate_unaccent_rules::str.

Referenced by ExplainPrintPlan().

ExplainPrintTriggers()

void ExplainPrintTriggers	(	ExplainState *	es,
		QueryDesc *	queryDesc
	)

Definition at line 817 of file explain.c.

{
    ResultRelInfo *rInfo;
    bool        show_relname;
    List       *resultrels;
    List       *routerels;
    List       *targrels;
    ListCell   *l;
 
    resultrels = queryDesc->estate->es_opened_result_relations;
    routerels = queryDesc->estate->es_tuple_routing_result_relations;
    targrels = queryDesc->estate->es_trig_target_relations;
 
    ExplainOpenGroup("Triggers", "Triggers", false, es);
 
    show_relname = (list_length(resultrels) > 1 ||
                    routerels != NIL || targrels != NIL);
    foreach(l, resultrels)
    {
        rInfo = (ResultRelInfo *) lfirst(l);
        report_triggers(rInfo, show_relname, es);
    }
 
    foreach(l, routerels)
    {
        rInfo = (ResultRelInfo *) lfirst(l);
        report_triggers(rInfo, show_relname, es);
    }
 
    foreach(l, targrels)
    {
        rInfo = (ResultRelInfo *) lfirst(l);
        report_triggers(rInfo, show_relname, es);
    }
 
    ExplainCloseGroup("Triggers", "Triggers", false, es);
}

References EState::es_opened_result_relations, EState::es_trig_target_relations, EState::es_tuple_routing_result_relations, QueryDesc::estate, ExplainCloseGroup(), ExplainOpenGroup(), lfirst, list_length(), NIL, and report_triggers().

Referenced by explain_ExecutorEnd(), and ExplainOnePlan().

ExplainProperty()

static void ExplainProperty ( const char *  qlabel, const char *  unit, const char *  value, bool  numeric, ExplainState *  es  )

static

Definition at line 4509 of file explain.c.

{
    switch (es->format)
    {
        case EXPLAIN_FORMAT_TEXT:
            ExplainIndentText(es);
            if (unit)
                appendStringInfo(es->str, "%s: %s %s\n", qlabel, value, unit);
            else
                appendStringInfo(es->str, "%s: %s\n", qlabel, value);
            break;
 
        case EXPLAIN_FORMAT_XML:
            {
                char       *str;
 
                appendStringInfoSpaces(es->str, es->indent * 2);
                ExplainXMLTag(qlabel, X_OPENING | X_NOWHITESPACE, es);
                str = escape_xml(value);
                appendStringInfoString(es->str, str);
                pfree(str);
                ExplainXMLTag(qlabel, X_CLOSING | X_NOWHITESPACE, es);
                appendStringInfoChar(es->str, '\n');
            }
            break;
 
        case EXPLAIN_FORMAT_JSON:
            ExplainJSONLineEnding(es);
            appendStringInfoSpaces(es->str, es->indent * 2);
            escape_json(es->str, qlabel);
            appendStringInfoString(es->str, ": ");
            if (numeric)
                appendStringInfoString(es->str, value);
            else
                escape_json(es->str, value);
            break;
 
        case EXPLAIN_FORMAT_YAML:
            ExplainYAMLLineStarting(es);
            appendStringInfo(es->str, "%s: ", qlabel);
            if (numeric)
                appendStringInfoString(es->str, value);
            else
                escape_yaml(es->str, value);
            break;
    }
}

References appendStringInfo(), appendStringInfoChar(), appendStringInfoSpaces(), appendStringInfoString(), escape_json(), escape_xml(), escape_yaml(), EXPLAIN_FORMAT_JSON, EXPLAIN_FORMAT_TEXT, EXPLAIN_FORMAT_XML, EXPLAIN_FORMAT_YAML, ExplainIndentText(), ExplainJSONLineEnding(), ExplainXMLTag(), ExplainYAMLLineStarting(), ExplainState::format, ExplainState::indent, pfree(), generate_unaccent_rules::str, ExplainState::str, value, X_CLOSING, X_NOWHITESPACE, and X_OPENING.

Referenced by ExplainPropertyBool(), ExplainPropertyFloat(), ExplainPropertyInteger(), ExplainPropertyText(), and ExplainPropertyUInteger().

ExplainPropertyBool()

void ExplainPropertyBool	(	const char *	qlabel,
		bool	value,
		ExplainState *	es
	)

Definition at line 4612 of file explain.c.

{
    ExplainProperty(qlabel, NULL, value ? "true" : "false", true, es);
}

References ExplainProperty(), and value.

Referenced by ExplainNode(), and ExplainPrintJIT().

ExplainPropertyFloat()

void ExplainPropertyFloat	(	const char *	qlabel,
		const char *	unit,
		double	value,
		int	ndigits,
		ExplainState *	es
	)

Definition at line 4598 of file explain.c.

{
    char       *buf;
 
    buf = psprintf("%.*f", ndigits, value);
    ExplainProperty(qlabel, unit, buf, true, es);
    pfree(buf);
}

References buf, ExplainProperty(), pfree(), psprintf(), and value.

Referenced by ExplainNode(), ExplainOnePlan(), ExplainPrintJIT(), report_triggers(), show_buffer_usage(), show_instrumentation_count(), and show_modifytable_info().

ExplainPropertyInteger()

void ExplainPropertyInteger	(	const char *	qlabel,
		const char *	unit,
		int64	value,
		ExplainState *	es
	)

Definition at line 4571 of file explain.c.

{
    char        buf[32];
 
    snprintf(buf, sizeof(buf), INT64_FORMAT, value);
    ExplainProperty(qlabel, unit, buf, true, es);
}

References buf, ExplainProperty(), INT64_FORMAT, snprintf, and value.

Referenced by ExplainMissingMembers(), ExplainNode(), ExplainOpenWorker(), ExplainPrintJIT(), ExplainPrintPlan(), fileExplainForeignScan(), postgresExplainForeignModify(), show_buffer_usage(), show_hash_info(), show_hashagg_info(), show_incremental_sort_group_info(), show_memoize_info(), show_sort_info(), show_tidbitmap_info(), and show_wal_usage().

ExplainPropertyList()

void ExplainPropertyList	(	const char *	qlabel,
		List *	data,
		ExplainState *	es
	)

Definition at line 4386 of file explain.c.

{
    ListCell   *lc;
    bool        first = true;
 
    switch (es->format)
    {
        case EXPLAIN_FORMAT_TEXT:
            ExplainIndentText(es);
            appendStringInfo(es->str, "%s: ", qlabel);
            foreach(lc, data)
            {
                if (!first)
                    appendStringInfoString(es->str, ", ");
                appendStringInfoString(es->str, (const char *) lfirst(lc));
                first = false;
            }
            appendStringInfoChar(es->str, '\n');
            break;
 
        case EXPLAIN_FORMAT_XML:
            ExplainXMLTag(qlabel, X_OPENING, es);
            foreach(lc, data)
            {
                char       *str;
 
                appendStringInfoSpaces(es->str, es->indent * 2 + 2);
                appendStringInfoString(es->str, "<Item>");
                str = escape_xml((const char *) lfirst(lc));
                appendStringInfoString(es->str, str);
                pfree(str);
                appendStringInfoString(es->str, "</Item>\n");
            }
            ExplainXMLTag(qlabel, X_CLOSING, es);
            break;
 
        case EXPLAIN_FORMAT_JSON:
            ExplainJSONLineEnding(es);
            appendStringInfoSpaces(es->str, es->indent * 2);
            escape_json(es->str, qlabel);
            appendStringInfoString(es->str, ": [");
            foreach(lc, data)
            {
                if (!first)
                    appendStringInfoString(es->str, ", ");
                escape_json(es->str, (const char *) lfirst(lc));
                first = false;
            }
            appendStringInfoChar(es->str, ']');
            break;
 
        case EXPLAIN_FORMAT_YAML:
            ExplainYAMLLineStarting(es);
            appendStringInfo(es->str, "%s: ", qlabel);
            foreach(lc, data)
            {
                appendStringInfoChar(es->str, '\n');
                appendStringInfoSpaces(es->str, es->indent * 2 + 2);
                appendStringInfoString(es->str, "- ");
                escape_yaml(es->str, (const char *) lfirst(lc));
            }
            break;
    }
}

References appendStringInfo(), appendStringInfoChar(), appendStringInfoSpaces(), appendStringInfoString(), data, escape_json(), escape_xml(), escape_yaml(), EXPLAIN_FORMAT_JSON, EXPLAIN_FORMAT_TEXT, EXPLAIN_FORMAT_XML, EXPLAIN_FORMAT_YAML, ExplainIndentText(), ExplainJSONLineEnding(), ExplainXMLTag(), ExplainYAMLLineStarting(), ExplainState::format, ExplainState::indent, lfirst, pfree(), generate_unaccent_rules::str, ExplainState::str, X_CLOSING, and X_OPENING.

Referenced by ExplainPropertyListNested(), show_eval_params(), show_incremental_sort_group_info(), show_modifytable_info(), show_plan_tlist(), show_sort_group_keys(), and show_tablesample().

ExplainPropertyListNested()

void ExplainPropertyListNested	(	const char *	qlabel,
		List *	data,
		ExplainState *	es
	)

Definition at line 4456 of file explain.c.

{
    ListCell   *lc;
    bool        first = true;
 
    switch (es->format)
    {
        case EXPLAIN_FORMAT_TEXT:
        case EXPLAIN_FORMAT_XML:
            ExplainPropertyList(qlabel, data, es);
            return;
 
        case EXPLAIN_FORMAT_JSON:
            ExplainJSONLineEnding(es);
            appendStringInfoSpaces(es->str, es->indent * 2);
            appendStringInfoChar(es->str, '[');
            foreach(lc, data)
            {
                if (!first)
                    appendStringInfoString(es->str, ", ");
                escape_json(es->str, (const char *) lfirst(lc));
                first = false;
            }
            appendStringInfoChar(es->str, ']');
            break;
 
        case EXPLAIN_FORMAT_YAML:
            ExplainYAMLLineStarting(es);
            appendStringInfoString(es->str, "- [");
            foreach(lc, data)
            {
                if (!first)
                    appendStringInfoString(es->str, ", ");
                escape_yaml(es->str, (const char *) lfirst(lc));
                first = false;
            }
            appendStringInfoChar(es->str, ']');
            break;
    }
}

References appendStringInfoChar(), appendStringInfoSpaces(), appendStringInfoString(), data, escape_json(), escape_yaml(), EXPLAIN_FORMAT_JSON, EXPLAIN_FORMAT_TEXT, EXPLAIN_FORMAT_XML, EXPLAIN_FORMAT_YAML, ExplainJSONLineEnding(), ExplainPropertyList(), ExplainYAMLLineStarting(), ExplainState::format, ExplainState::indent, lfirst, and ExplainState::str.

Referenced by show_grouping_set_keys().

ExplainPropertyText()

void ExplainPropertyText	(	const char *	qlabel,
		const char *	value,
		ExplainState *	es
	)

Definition at line 4562 of file explain.c.

{
    ExplainProperty(qlabel, NULL, value, false, es);
}

References ExplainProperty(), and value.

Referenced by ExplainIndexScanDetails(), ExplainNode(), ExplainPrintSettings(), ExplainQueryParameters(), ExplainQueryText(), ExplainTargetRel(), fileExplainForeignScan(), postgresExplainDirectModify(), postgresExplainForeignModify(), postgresExplainForeignScan(), report_triggers(), show_expression(), show_grouping_set_keys(), show_memoize_info(), show_modifytable_info(), show_sort_info(), and show_tablesample().

ExplainPropertyUInteger()

void ExplainPropertyUInteger	(	const char *	qlabel,
		const char *	unit,
		uint64	value,
		ExplainState *	es
	)

Definition at line 4584 of file explain.c.

{
    char        buf[32];
 
    snprintf(buf, sizeof(buf), UINT64_FORMAT, value);
    ExplainProperty(qlabel, unit, buf, true, es);
}

References buf, ExplainProperty(), snprintf, UINT64_FORMAT, and value.

Referenced by show_wal_usage().

ExplainQuery()

void ExplainQuery	(	ParseState *	pstate,
		ExplainStmt *	stmt,
		ParamListInfo	params,
		DestReceiver *	dest
	)

Definition at line 164 of file explain.c.

{
    ExplainState *es = NewExplainState();
    TupOutputState *tstate;
    JumbleState *jstate = NULL;
    Query      *query;
    List       *rewritten;
    ListCell   *lc;
    bool        timing_set = false;
    bool        summary_set = false;
 
    /* Parse options list. */
    foreach(lc, stmt->options)
    {
        DefElem    *opt = (DefElem *) lfirst(lc);
 
        if (strcmp(opt->defname, "analyze") == 0)
            es->analyze = defGetBoolean(opt);
        else if (strcmp(opt->defname, "verbose") == 0)
            es->verbose = defGetBoolean(opt);
        else if (strcmp(opt->defname, "costs") == 0)
            es->costs = defGetBoolean(opt);
        else if (strcmp(opt->defname, "buffers") == 0)
            es->buffers = defGetBoolean(opt);
        else if (strcmp(opt->defname, "wal") == 0)
            es->wal = defGetBoolean(opt);
        else if (strcmp(opt->defname, "settings") == 0)
            es->settings = defGetBoolean(opt);
        else if (strcmp(opt->defname, "generic_plan") == 0)
            es->generic = defGetBoolean(opt);
        else if (strcmp(opt->defname, "timing") == 0)
        {
            timing_set = true;
            es->timing = defGetBoolean(opt);
        }
        else if (strcmp(opt->defname, "summary") == 0)
        {
            summary_set = true;
            es->summary = defGetBoolean(opt);
        }
        else if (strcmp(opt->defname, "format") == 0)
        {
            char       *p = defGetString(opt);
 
            if (strcmp(p, "text") == 0)
                es->format = EXPLAIN_FORMAT_TEXT;
            else if (strcmp(p, "xml") == 0)
                es->format = EXPLAIN_FORMAT_XML;
            else if (strcmp(p, "json") == 0)
                es->format = EXPLAIN_FORMAT_JSON;
            else if (strcmp(p, "yaml") == 0)
                es->format = EXPLAIN_FORMAT_YAML;
            else
                ereport(ERROR,
                        (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                         errmsg("unrecognized value for EXPLAIN option \"%s\": \"%s\"",
                                opt->defname, p),
                         parser_errposition(pstate, opt->location)));
        }
        else
            ereport(ERROR,
                    (errcode(ERRCODE_SYNTAX_ERROR),
                     errmsg("unrecognized EXPLAIN option \"%s\"",
                            opt->defname),
                     parser_errposition(pstate, opt->location)));
    }
 
    /* check that WAL is used with EXPLAIN ANALYZE */
    if (es->wal && !es->analyze)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("EXPLAIN option WAL requires ANALYZE")));
 
    /* if the timing was not set explicitly, set default value */
    es->timing = (timing_set) ? es->timing : es->analyze;
 
    /* check that timing is used with EXPLAIN ANALYZE */
    if (es->timing && !es->analyze)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("EXPLAIN option TIMING requires ANALYZE")));
 
    /* check that GENERIC_PLAN is not used with EXPLAIN ANALYZE */
    if (es->generic && es->analyze)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("EXPLAIN options ANALYZE and GENERIC_PLAN cannot be used together")));
 
    /* if the summary was not set explicitly, set default value */
    es->summary = (summary_set) ? es->summary : es->analyze;
 
    query = castNode(Query, stmt->query);
    if (IsQueryIdEnabled())
        jstate = JumbleQuery(query);
 
    if (post_parse_analyze_hook)
        (*post_parse_analyze_hook) (pstate, query, jstate);
 
    /*
     * Parse analysis was done already, but we still have to run the rule
     * rewriter.  We do not do AcquireRewriteLocks: we assume the query either
     * came straight from the parser, or suitable locks were acquired by
     * plancache.c.
     */
    rewritten = QueryRewrite(castNode(Query, stmt->query));
 
    /* emit opening boilerplate */
    ExplainBeginOutput(es);
 
    if (rewritten == NIL)
    {
        /*
         * In the case of an INSTEAD NOTHING, tell at least that.  But in
         * non-text format, the output is delimited, so this isn't necessary.
         */
        if (es->format == EXPLAIN_FORMAT_TEXT)
            appendStringInfoString(es->str, "Query rewrites to nothing\n");
    }
    else
    {
        ListCell   *l;
 
        /* Explain every plan */
        foreach(l, rewritten)
        {
            ExplainOneQuery(lfirst_node(Query, l),
                            CURSOR_OPT_PARALLEL_OK, NULL, es,
                            pstate->p_sourcetext, params, pstate->p_queryEnv);
 
            /* Separate plans with an appropriate separator */
            if (lnext(rewritten, l) != NULL)
                ExplainSeparatePlans(es);
        }
    }
 
    /* emit closing boilerplate */
    ExplainEndOutput(es);
    Assert(es->indent == 0);
 
    /* output tuples */
    tstate = begin_tup_output_tupdesc(dest, ExplainResultDesc(stmt),
                                      &TTSOpsVirtual);
    if (es->format == EXPLAIN_FORMAT_TEXT)
        do_text_output_multiline(tstate, es->str->data);
    else
        do_text_output_oneline(tstate, es->str->data);
    end_tup_output(tstate);
 
    pfree(es->str->data);
}

References ExplainState::analyze, appendStringInfoString(), Assert(), begin_tup_output_tupdesc(), ExplainState::buffers, castNode, ExplainState::costs, CURSOR_OPT_PARALLEL_OK, StringInfoData::data, defGetBoolean(), defGetString(), DefElem::defname, generate_unaccent_rules::dest, do_text_output_multiline(), do_text_output_oneline, end_tup_output(), ereport, errcode(), errmsg(), ERROR, EXPLAIN_FORMAT_JSON, EXPLAIN_FORMAT_TEXT, EXPLAIN_FORMAT_XML, EXPLAIN_FORMAT_YAML, ExplainBeginOutput(), ExplainEndOutput(), ExplainOneQuery(), ExplainResultDesc(), ExplainSeparatePlans(), ExplainState::format, ExplainState::generic, if(), ExplainState::indent, IsQueryIdEnabled(), JumbleQuery(), lfirst, lfirst_node, lnext(), DefElem::location, NewExplainState(), NIL, ParseState::p_queryEnv, ParseState::p_sourcetext, parser_errposition(), pfree(), post_parse_analyze_hook, QueryRewrite(), ExplainState::settings, stmt, ExplainState::str, ExplainState::summary, ExplainState::timing, TTSOpsVirtual, ExplainState::verbose, and ExplainState::wal.

Referenced by standard_ProcessUtility().

ExplainQueryParameters()

void ExplainQueryParameters	(	ExplainState *	es,
		ParamListInfo	params,
		int	maxlen
	)

Definition at line 1003 of file explain.c.

{
    char       *str;
 
    /* This check is consistent with errdetail_params() */
    if (params == NULL || params->numParams <= 0 || maxlen == 0)
        return;
 
    str = BuildParamLogString(params, NULL, maxlen);
    if (str && str[0] != '\0')
        ExplainPropertyText("Query Parameters", str, es);
}

References BuildParamLogString(), ExplainPropertyText(), ParamListInfoData::numParams, and generate_unaccent_rules::str.

Referenced by explain_ExecutorEnd().

ExplainQueryText()

void ExplainQueryText	(	ExplainState *	es,
		QueryDesc *	queryDesc
	)

Definition at line 988 of file explain.c.

{
    if (queryDesc->sourceText)
        ExplainPropertyText("Query Text", queryDesc->sourceText, es);
}

References ExplainPropertyText(), and QueryDesc::sourceText.

Referenced by explain_ExecutorEnd().

ExplainRestoreGroup()

static void ExplainRestoreGroup ( ExplainState *  es, int  depth, int *  state_save  )

static

Definition at line 4806 of file explain.c.

{
    switch (es->format)
    {
        case EXPLAIN_FORMAT_TEXT:
            /* nothing to do */
            break;
 
        case EXPLAIN_FORMAT_XML:
            es->indent += depth;
            break;
 
        case EXPLAIN_FORMAT_JSON:
            es->grouping_stack = lcons_int(*state_save, es->grouping_stack);
            es->indent += depth;
            break;
 
        case EXPLAIN_FORMAT_YAML:
            es->grouping_stack = lcons_int(*state_save, es->grouping_stack);
            es->indent += depth;
            break;
    }
}

References EXPLAIN_FORMAT_JSON, EXPLAIN_FORMAT_TEXT, EXPLAIN_FORMAT_XML, EXPLAIN_FORMAT_YAML, ExplainState::format, ExplainState::grouping_stack, ExplainState::indent, and lcons_int().

Referenced by ExplainOpenWorker().

ExplainResultDesc()

TupleDesc ExplainResultDesc

(

ExplainStmt *

stmt

)

Definition at line 337 of file explain.c.

{
    TupleDesc   tupdesc;
    ListCell   *lc;
    Oid         result_type = TEXTOID;
 
    /* Check for XML format option */
    foreach(lc, stmt->options)
    {
        DefElem    *opt = (DefElem *) lfirst(lc);
 
        if (strcmp(opt->defname, "format") == 0)
        {
            char       *p = defGetString(opt);
 
            if (strcmp(p, "xml") == 0)
                result_type = XMLOID;
            else if (strcmp(p, "json") == 0)
                result_type = JSONOID;
            else
                result_type = TEXTOID;
            /* don't "break", as ExplainQuery will use the last value */
        }
    }
 
    /* Need a tuple descriptor representing a single TEXT or XML column */
    tupdesc = CreateTemplateTupleDesc(1);
    TupleDescInitEntry(tupdesc, (AttrNumber) 1, "QUERY PLAN",
                       result_type, -1, 0);
    return tupdesc;
}

References CreateTemplateTupleDesc(), defGetString(), DefElem::defname, lfirst, stmt, and TupleDescInitEntry().

Referenced by ExplainQuery(), and UtilityTupleDescriptor().

ExplainSaveGroup()

static void ExplainSaveGroup ( ExplainState *  es, int  depth, int *  state_save  )

static

Definition at line 4776 of file explain.c.

{
    switch (es->format)
    {
        case EXPLAIN_FORMAT_TEXT:
            /* nothing to do */
            break;
 
        case EXPLAIN_FORMAT_XML:
            es->indent -= depth;
            break;
 
        case EXPLAIN_FORMAT_JSON:
            es->indent -= depth;
            *state_save = linitial_int(es->grouping_stack);
            es->grouping_stack = list_delete_first(es->grouping_stack);
            break;
 
        case EXPLAIN_FORMAT_YAML:
            es->indent -= depth;
            *state_save = linitial_int(es->grouping_stack);
            es->grouping_stack = list_delete_first(es->grouping_stack);
            break;
    }
}

References EXPLAIN_FORMAT_JSON, EXPLAIN_FORMAT_TEXT, EXPLAIN_FORMAT_XML, EXPLAIN_FORMAT_YAML, ExplainState::format, ExplainState::grouping_stack, ExplainState::indent, linitial_int, and list_delete_first().

Referenced by ExplainCloseWorker().

ExplainScanTarget()

static void ExplainScanTarget ( Scan *  plan, ExplainState *  es  )

static

Definition at line 3787 of file explain.c.

{
    ExplainTargetRel((Plan *) plan, plan->scanrelid, es);
}

References ExplainTargetRel(), and plan.

Referenced by ExplainNode().

ExplainSeparatePlans()

void ExplainSeparatePlans

(

ExplainState *

es

)

Definition at line 4943 of file explain.c.

{
    switch (es->format)
    {
        case EXPLAIN_FORMAT_TEXT:
            /* add a blank line */
            appendStringInfoChar(es->str, '\n');
            break;
 
        case EXPLAIN_FORMAT_XML:
        case EXPLAIN_FORMAT_JSON:
        case EXPLAIN_FORMAT_YAML:
            /* nothing to do */
            break;
    }
}

References appendStringInfoChar(), EXPLAIN_FORMAT_JSON, EXPLAIN_FORMAT_TEXT, EXPLAIN_FORMAT_XML, EXPLAIN_FORMAT_YAML, ExplainState::format, and ExplainState::str.

Referenced by ExplainExecuteQuery(), and ExplainQuery().

ExplainSubPlans()

static void ExplainSubPlans ( List *  plans, List *  ancestors, const char *  relationship, ExplainState *  es  )

static

Definition at line 4176 of file explain.c.

{
    ListCell   *lst;
 
    foreach(lst, plans)
    {
        SubPlanState *sps = (SubPlanState *) lfirst(lst);
        SubPlan    *sp = sps->subplan;
 
        /*
         * There can be multiple SubPlan nodes referencing the same physical
         * subplan (same plan_id, which is its index in PlannedStmt.subplans).
         * We should print a subplan only once, so track which ones we already
         * printed.  This state must be global across the plan tree, since the
         * duplicate nodes could be in different plan nodes, eg both a bitmap
         * indexscan's indexqual and its parent heapscan's recheck qual.  (We
         * do not worry too much about which plan node we show the subplan as
         * attached to in such cases.)
         */
        if (bms_is_member(sp->plan_id, es->printed_subplans))
            continue;
        es->printed_subplans = bms_add_member(es->printed_subplans,
                                              sp->plan_id);
 
        /*
         * Treat the SubPlan node as an ancestor of the plan node(s) within
         * it, so that ruleutils.c can find the referents of subplan
         * parameters.
         */
        ancestors = lcons(sp, ancestors);
 
        ExplainNode(sps->planstate, ancestors,
                    relationship, sp->plan_name, es);
 
        ancestors = list_delete_first(ancestors);
    }
}

References bms_add_member(), bms_is_member(), ExplainNode(), lcons(), lfirst, list_delete_first(), SubPlan::plan_id, SubPlan::plan_name, SubPlanState::planstate, ExplainState::printed_subplans, and SubPlanState::subplan.

Referenced by ExplainNode().

ExplainTargetRel()

static void ExplainTargetRel ( Plan *  plan, Index  rti, ExplainState *  es  )

static

Definition at line 3809 of file explain.c.

{
    char       *objectname = NULL;
    char       *namespace = NULL;
    const char *objecttag = NULL;
    RangeTblEntry *rte;
    char       *refname;
 
    rte = rt_fetch(rti, es->rtable);
    refname = (char *) list_nth(es->rtable_names, rti - 1);
    if (refname == NULL)
        refname = rte->eref->aliasname;
 
    switch (nodeTag(plan))
    {
        case T_SeqScan:
        case T_SampleScan:
        case T_IndexScan:
        case T_IndexOnlyScan:
        case T_BitmapHeapScan:
        case T_TidScan:
        case T_TidRangeScan:
        case T_ForeignScan:
        case T_CustomScan:
        case T_ModifyTable:
            /* Assert it's on a real relation */
            Assert(rte->rtekind == RTE_RELATION);
            objectname = get_rel_name(rte->relid);
            if (es->verbose)
                namespace = get_namespace_name_or_temp(get_rel_namespace(rte->relid));
            objecttag = "Relation Name";
            break;
        case T_FunctionScan:
            {
                FunctionScan *fscan = (FunctionScan *) plan;
 
                /* Assert it's on a RangeFunction */
                Assert(rte->rtekind == RTE_FUNCTION);
 
                /*
                 * If the expression is still a function call of a single
                 * function, we can get the real name of the function.
                 * Otherwise, punt.  (Even if it was a single function call
                 * originally, the optimizer could have simplified it away.)
                 */
                if (list_length(fscan->functions) == 1)
                {
                    RangeTblFunction *rtfunc = (RangeTblFunction *) linitial(fscan->functions);
 
                    if (IsA(rtfunc->funcexpr, FuncExpr))
                    {
                        FuncExpr   *funcexpr = (FuncExpr *) rtfunc->funcexpr;
                        Oid         funcid = funcexpr->funcid;
 
                        objectname = get_func_name(funcid);
                        if (es->verbose)
                            namespace = get_namespace_name_or_temp(get_func_namespace(funcid));
                    }
                }
                objecttag = "Function Name";
            }
            break;
        case T_TableFuncScan:
            Assert(rte->rtekind == RTE_TABLEFUNC);
            objectname = "xmltable";
            objecttag = "Table Function Name";
            break;
        case T_ValuesScan:
            Assert(rte->rtekind == RTE_VALUES);
            break;
        case T_CteScan:
            /* Assert it's on a non-self-reference CTE */
            Assert(rte->rtekind == RTE_CTE);
            Assert(!rte->self_reference);
            objectname = rte->ctename;
            objecttag = "CTE Name";
            break;
        case T_NamedTuplestoreScan:
            Assert(rte->rtekind == RTE_NAMEDTUPLESTORE);
            objectname = rte->enrname;
            objecttag = "Tuplestore Name";
            break;
        case T_WorkTableScan:
            /* Assert it's on a self-reference CTE */
            Assert(rte->rtekind == RTE_CTE);
            Assert(rte->self_reference);
            objectname = rte->ctename;
            objecttag = "CTE Name";
            break;
        default:
            break;
    }
 
    if (es->format == EXPLAIN_FORMAT_TEXT)
    {
        appendStringInfoString(es->str, " on");
        if (namespace != NULL)
            appendStringInfo(es->str, " %s.%s", quote_identifier(namespace),
                             quote_identifier(objectname));
        else if (objectname != NULL)
            appendStringInfo(es->str, " %s", quote_identifier(objectname));
        if (objectname == NULL || strcmp(refname, objectname) != 0)
            appendStringInfo(es->str, " %s", quote_identifier(refname));
    }
    else
    {
        if (objecttag != NULL && objectname != NULL)
            ExplainPropertyText(objecttag, objectname, es);
        if (namespace != NULL)
            ExplainPropertyText("Schema", namespace, es);
        ExplainPropertyText("Alias", refname, es);
    }
}

References Alias::aliasname, appendStringInfo(), appendStringInfoString(), Assert(), RangeTblEntry::eref, EXPLAIN_FORMAT_TEXT, ExplainPropertyText(), ExplainState::format, RangeTblFunction::funcexpr, FuncExpr::funcid, FunctionScan::functions, get_func_name(), get_func_namespace(), get_namespace_name_or_temp(), get_rel_name(), get_rel_namespace(), IsA, linitial, list_length(), list_nth(), nodeTag, plan, quote_identifier(), RangeTblEntry::relid, rt_fetch, ExplainState::rtable, ExplainState::rtable_names, RTE_CTE, RTE_FUNCTION, RTE_NAMEDTUPLESTORE, RTE_RELATION, RTE_TABLEFUNC, RTE_VALUES, RangeTblEntry::rtekind, ExplainState::str, and ExplainState::verbose.

Referenced by ExplainModifyTarget(), ExplainScanTarget(), and show_modifytable_info().

ExplainXMLTag()

static void ExplainXMLTag ( const char *  tagname, int  flags, ExplainState *  es  )

static

Definition at line 4972 of file explain.c.

{
    const char *s;
    const char *valid = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_.";
 
    if ((flags & X_NOWHITESPACE) == 0)
        appendStringInfoSpaces(es->str, 2 * es->indent);
    appendStringInfoCharMacro(es->str, '<');
    if ((flags & X_CLOSING) != 0)
        appendStringInfoCharMacro(es->str, '/');
    for (s = tagname; *s; s++)
        appendStringInfoChar(es->str, strchr(valid, *s) ? *s : '-');
    if ((flags & X_CLOSE_IMMEDIATE) != 0)
        appendStringInfoString(es->str, " /");
    appendStringInfoCharMacro(es->str, '>');
    if ((flags & X_NOWHITESPACE) == 0)
        appendStringInfoCharMacro(es->str, '\n');
}

References appendStringInfoChar(), appendStringInfoCharMacro, appendStringInfoSpaces(), appendStringInfoString(), ExplainState::indent, ExplainState::str, X_CLOSE_IMMEDIATE, X_CLOSING, and X_NOWHITESPACE.

Referenced by ExplainCloseGroup(), ExplainDummyGroup(), ExplainOpenGroup(), ExplainProperty(), and ExplainPropertyList().

ExplainYAMLLineStarting()

static void ExplainYAMLLineStarting ( ExplainState *  es )

static

Definition at line 5034 of file explain.c.

{
    Assert(es->format == EXPLAIN_FORMAT_YAML);
    if (linitial_int(es->grouping_stack) == 0)
    {
        linitial_int(es->grouping_stack) = 1;
    }
    else
    {
        appendStringInfoChar(es->str, '\n');
        appendStringInfoSpaces(es->str, es->indent * 2);
    }
}

References appendStringInfoChar(), appendStringInfoSpaces(), Assert(), EXPLAIN_FORMAT_YAML, ExplainState::format, ExplainState::grouping_stack, ExplainState::indent, linitial_int, and ExplainState::str.

Referenced by ExplainDummyGroup(), ExplainOpenGroup(), ExplainProperty(), ExplainPropertyList(), and ExplainPropertyListNested().

NewExplainState()

ExplainState* NewExplainState

(

void

)

Definition at line 320 of file explain.c.

{
    ExplainState *es = (ExplainState *) palloc0(sizeof(ExplainState));
 
    /* Set default options (most fields can be left as zeroes). */
    es->costs = true;
    /* Prepare output buffer. */
    es->str = makeStringInfo();
 
    return es;
}

References ExplainState::costs, makeStringInfo(), palloc0(), and ExplainState::str.

Referenced by explain_ExecutorEnd(), and ExplainQuery().

report_triggers()

static void report_triggers ( ResultRelInfo *  rInfo, bool  show_relname, ExplainState *  es  )

static

Definition at line 1021 of file explain.c.

{
    int         nt;
 
    if (!rInfo->ri_TrigDesc || !rInfo->ri_TrigInstrument)
        return;
    for (nt = 0; nt < rInfo->ri_TrigDesc->numtriggers; nt++)
    {
        Trigger    *trig = rInfo->ri_TrigDesc->triggers + nt;
        Instrumentation *instr = rInfo->ri_TrigInstrument + nt;
        char       *relname;
        char       *conname = NULL;
 
        /* Must clean up instrumentation state */
        InstrEndLoop(instr);
 
        /*
         * We ignore triggers that were never invoked; they likely aren't
         * relevant to the current query type.
         */
        if (instr->ntuples == 0)
            continue;
 
        ExplainOpenGroup("Trigger", NULL, true, es);
 
        relname = RelationGetRelationName(rInfo->ri_RelationDesc);
        if (OidIsValid(trig->tgconstraint))
            conname = get_constraint_name(trig->tgconstraint);
 
        /*
         * In text format, we avoid printing both the trigger name and the
         * constraint name unless VERBOSE is specified.  In non-text formats
         * we just print everything.
         */
        if (es->format == EXPLAIN_FORMAT_TEXT)
        {
            if (es->verbose || conname == NULL)
                appendStringInfo(es->str, "Trigger %s", trig->tgname);
            else
                appendStringInfoString(es->str, "Trigger");
            if (conname)
                appendStringInfo(es->str, " for constraint %s", conname);
            if (show_relname)
                appendStringInfo(es->str, " on %s", relname);
            if (es->timing)
                appendStringInfo(es->str, ": time=%.3f calls=%.0f\n",
                                 1000.0 * instr->total, instr->ntuples);
            else
                appendStringInfo(es->str, ": calls=%.0f\n", instr->ntuples);
        }
        else
        {
            ExplainPropertyText("Trigger Name", trig->tgname, es);
            if (conname)
                ExplainPropertyText("Constraint Name", conname, es);
            ExplainPropertyText("Relation", relname, es);
            if (es->timing)
                ExplainPropertyFloat("Time", "ms", 1000.0 * instr->total, 3,
                                     es);
            ExplainPropertyFloat("Calls", NULL, instr->ntuples, 0, es);
        }
 
        if (conname)
            pfree(conname);
 
        ExplainCloseGroup("Trigger", NULL, true, es);
    }
}

References appendStringInfo(), appendStringInfoString(), EXPLAIN_FORMAT_TEXT, ExplainCloseGroup(), ExplainOpenGroup(), ExplainPropertyFloat(), ExplainPropertyText(), ExplainState::format, get_constraint_name(), InstrEndLoop(), Instrumentation::ntuples, TriggerDesc::numtriggers, OidIsValid, pfree(), RelationGetRelationName, relname, ResultRelInfo::ri_RelationDesc, ResultRelInfo::ri_TrigDesc, ResultRelInfo::ri_TrigInstrument, ExplainState::str, Trigger::tgconstraint, Trigger::tgname, ExplainState::timing, Instrumentation::total, TriggerDesc::triggers, and ExplainState::verbose.

Referenced by ExplainPrintTriggers().

show_agg_keys()

static void show_agg_keys ( AggState *  astate, List *  ancestors, ExplainState *  es  )

static

Definition at line 2434 of file explain.c.

{
    Agg        *plan = (Agg *) astate->ss.ps.plan;
 
    if (plan->numCols > 0 || plan->groupingSets)
    {
        /* The key columns refer to the tlist of the child plan */
        ancestors = lcons(plan, ancestors);
 
        if (plan->groupingSets)
            show_grouping_sets(outerPlanState(astate), plan, ancestors, es);
        else
            show_sort_group_keys(outerPlanState(astate), "Group Key",
                                 plan->numCols, 0, plan->grpColIdx,
                                 NULL, NULL, NULL,
                                 ancestors, es);
 
        ancestors = list_delete_first(ancestors);
    }
}

References if(), lcons(), list_delete_first(), outerPlanState, PlanState::plan, plan, ScanState::ps, show_grouping_sets(), show_sort_group_keys(), and AggState::ss.

Referenced by ExplainNode().

show_buffer_usage()

static void show_buffer_usage ( ExplainState *  es, const BufferUsage *  usage, bool  planning  )

static

Definition at line 3551 of file explain.c.

{
    if (es->format == EXPLAIN_FORMAT_TEXT)
    {
        bool        has_shared = (usage->shared_blks_hit > 0 ||
                                  usage->shared_blks_read > 0 ||
                                  usage->shared_blks_dirtied > 0 ||
                                  usage->shared_blks_written > 0);
        bool        has_local = (usage->local_blks_hit > 0 ||
                                 usage->local_blks_read > 0 ||
                                 usage->local_blks_dirtied > 0 ||
                                 usage->local_blks_written > 0);
        bool        has_temp = (usage->temp_blks_read > 0 ||
                                usage->temp_blks_written > 0);
        bool        has_timing = (!INSTR_TIME_IS_ZERO(usage->blk_read_time) ||
                                  !INSTR_TIME_IS_ZERO(usage->blk_write_time));
        bool        has_temp_timing = (!INSTR_TIME_IS_ZERO(usage->temp_blk_read_time) ||
                                       !INSTR_TIME_IS_ZERO(usage->temp_blk_write_time));
        bool        show_planning = (planning && (has_shared ||
                                                  has_local || has_temp || has_timing ||
                                                  has_temp_timing));
 
        if (show_planning)
        {
            ExplainIndentText(es);
            appendStringInfoString(es->str, "Planning:\n");
            es->indent++;
        }
 
        /* Show only positive counter values. */
        if (has_shared || has_local || has_temp)
        {
            ExplainIndentText(es);
            appendStringInfoString(es->str, "Buffers:");
 
            if (has_shared)
            {
                appendStringInfoString(es->str, " shared");
                if (usage->shared_blks_hit > 0)
                    appendStringInfo(es->str, " hit=%lld",
                                     (long long) usage->shared_blks_hit);
                if (usage->shared_blks_read > 0)
                    appendStringInfo(es->str, " read=%lld",
                                     (long long) usage->shared_blks_read);
                if (usage->shared_blks_dirtied > 0)
                    appendStringInfo(es->str, " dirtied=%lld",
                                     (long long) usage->shared_blks_dirtied);
                if (usage->shared_blks_written > 0)
                    appendStringInfo(es->str, " written=%lld",
                                     (long long) usage->shared_blks_written);
                if (has_local || has_temp)
                    appendStringInfoChar(es->str, ',');
            }
            if (has_local)
            {
                appendStringInfoString(es->str, " local");
                if (usage->local_blks_hit > 0)
                    appendStringInfo(es->str, " hit=%lld",
                                     (long long) usage->local_blks_hit);
                if (usage->local_blks_read > 0)
                    appendStringInfo(es->str, " read=%lld",
                                     (long long) usage->local_blks_read);
                if (usage->local_blks_dirtied > 0)
                    appendStringInfo(es->str, " dirtied=%lld",
                                     (long long) usage->local_blks_dirtied);
                if (usage->local_blks_written > 0)
                    appendStringInfo(es->str, " written=%lld",
                                     (long long) usage->local_blks_written);
                if (has_temp)
                    appendStringInfoChar(es->str, ',');
            }
            if (has_temp)
            {
                appendStringInfoString(es->str, " temp");
                if (usage->temp_blks_read > 0)
                    appendStringInfo(es->str, " read=%lld",
                                     (long long) usage->temp_blks_read);
                if (usage->temp_blks_written > 0)
                    appendStringInfo(es->str, " written=%lld",
                                     (long long) usage->temp_blks_written);
            }
            appendStringInfoChar(es->str, '\n');
        }
 
        /* As above, show only positive counter values. */
        if (has_timing || has_temp_timing)
        {
            ExplainIndentText(es);
            appendStringInfoString(es->str, "I/O Timings:");
 
            if (has_timing)
            {
                appendStringInfoString(es->str, " shared/local");
                if (!INSTR_TIME_IS_ZERO(usage->blk_read_time))
                    appendStringInfo(es->str, " read=%0.3f",
                                     INSTR_TIME_GET_MILLISEC(usage->blk_read_time));
                if (!INSTR_TIME_IS_ZERO(usage->blk_write_time))
                    appendStringInfo(es->str, " write=%0.3f",
                                     INSTR_TIME_GET_MILLISEC(usage->blk_write_time));
                if (has_temp_timing)
                    appendStringInfoChar(es->str, ',');
            }
            if (has_temp_timing)
            {
                appendStringInfoString(es->str, " temp");
                if (!INSTR_TIME_IS_ZERO(usage->temp_blk_read_time))
                    appendStringInfo(es->str, " read=%0.3f",
                                     INSTR_TIME_GET_MILLISEC(usage->temp_blk_read_time));
                if (!INSTR_TIME_IS_ZERO(usage->temp_blk_write_time))
                    appendStringInfo(es->str, " write=%0.3f",
                                     INSTR_TIME_GET_MILLISEC(usage->temp_blk_write_time));
            }
            appendStringInfoChar(es->str, '\n');
        }
 
        if (show_planning)
            es->indent--;
    }
    else
    {
        ExplainPropertyInteger("Shared Hit Blocks", NULL,
                               usage->shared_blks_hit, es);
        ExplainPropertyInteger("Shared Read Blocks", NULL,
                               usage->shared_blks_read, es);
        ExplainPropertyInteger("Shared Dirtied Blocks", NULL,
                               usage->shared_blks_dirtied, es);
        ExplainPropertyInteger("Shared Written Blocks", NULL,
                               usage->shared_blks_written, es);
        ExplainPropertyInteger("Local Hit Blocks", NULL,
                               usage->local_blks_hit, es);
        ExplainPropertyInteger("Local Read Blocks", NULL,
                               usage->local_blks_read, es);
        ExplainPropertyInteger("Local Dirtied Blocks", NULL,
                               usage->local_blks_dirtied, es);
        ExplainPropertyInteger("Local Written Blocks", NULL,
                               usage->local_blks_written, es);
        ExplainPropertyInteger("Temp Read Blocks", NULL,
                               usage->temp_blks_read, es);
        ExplainPropertyInteger("Temp Written Blocks", NULL,
                               usage->temp_blks_written, es);
        if (track_io_timing)
        {
            ExplainPropertyFloat("I/O Read Time", "ms",
                                 INSTR_TIME_GET_MILLISEC(usage->blk_read_time),
                                 3, es);
            ExplainPropertyFloat("I/O Write Time", "ms",
                                 INSTR_TIME_GET_MILLISEC(usage->blk_write_time),
                                 3, es);
            ExplainPropertyFloat("Temp I/O Read Time", "ms",
                                 INSTR_TIME_GET_MILLISEC(usage->temp_blk_read_time),
                                 3, es);
            ExplainPropertyFloat("Temp I/O Write Time", "ms",
                                 INSTR_TIME_GET_MILLISEC(usage->temp_blk_write_time),
                                 3, es);
        }
    }
}

References appendStringInfo(), appendStringInfoChar(), appendStringInfoString(), EXPLAIN_FORMAT_TEXT, ExplainIndentText(), ExplainPropertyFloat(), ExplainPropertyInteger(), ExplainState::format, ExplainState::indent, INSTR_TIME_GET_MILLISEC, INSTR_TIME_IS_ZERO, ExplainState::str, track_io_timing, and usage().

Referenced by ExplainNode(), and ExplainOnePlan().

show_eval_params()

static void show_eval_params ( Bitmapset *  bms_params, ExplainState *  es  )

static

Definition at line 3499 of file explain.c.

{
    int         paramid = -1;
    List       *params = NIL;
 
    Assert(bms_params);
 
    while ((paramid = bms_next_member(bms_params, paramid)) >= 0)
    {
        char        param[32];
 
        snprintf(param, sizeof(param), "$%d", paramid);
        params = lappend(params, pstrdup(param));
    }
 
    if (params)
        ExplainPropertyList("Params Evaluated", params, es);
}

References Assert(), bms_next_member(), ExplainPropertyList(), lappend(), NIL, pstrdup(), and snprintf.

Referenced by ExplainNode().

show_expression()

static void show_expression ( Node *  node, const char *  qlabel, PlanState *  planstate, List *  ancestors, bool  useprefix, ExplainState *  es  )

static

Definition at line 2314 of file explain.c.

{
    List       *context;
    char       *exprstr;
 
    /* Set up deparsing context */
    context = set_deparse_context_plan(es->deparse_cxt,
                                       planstate->plan,
                                       ancestors);
 
    /* Deparse the expression */
    exprstr = deparse_expression(node, context, useprefix, false);
 
    /* And add to es->str */
    ExplainPropertyText(qlabel, exprstr, es);
}

References config_generic::context, ExplainState::deparse_cxt, deparse_expression(), ExplainPropertyText(), PlanState::plan, and set_deparse_context_plan().

Referenced by ExplainNode(), and show_qual().

show_foreignscan_info()

static void show_foreignscan_info ( ForeignScanState *  fsstate, ExplainState *  es  )

static

Definition at line 3478 of file explain.c.

{
    FdwRoutine *fdwroutine = fsstate->fdwroutine;
 
    /* Let the FDW emit whatever fields it wants */
    if (((ForeignScan *) fsstate->ss.ps.plan)->operation != CMD_SELECT)
    {
        if (fdwroutine->ExplainDirectModify != NULL)
            fdwroutine->ExplainDirectModify(fsstate, es);
    }
    else
    {
        if (fdwroutine->ExplainForeignScan != NULL)
            fdwroutine->ExplainForeignScan(fsstate, es);
    }
}

References CMD_SELECT, FdwRoutine::ExplainDirectModify, FdwRoutine::ExplainForeignScan, ForeignScanState::fdwroutine, PlanState::plan, ScanState::ps, and ForeignScanState::ss.

Referenced by ExplainNode().

show_group_keys()

static void show_group_keys ( GroupState *  gstate, List *  ancestors, ExplainState *  es  )

static

Definition at line 2566 of file explain.c.

{
    Group      *plan = (Group *) gstate->ss.ps.plan;
 
    /* The key columns refer to the tlist of the child plan */
    ancestors = lcons(plan, ancestors);
    show_sort_group_keys(outerPlanState(gstate), "Group Key",
                         plan->numCols, 0, plan->grpColIdx,
                         NULL, NULL, NULL,
                         ancestors, es);
    ancestors = list_delete_first(ancestors);
}

References lcons(), list_delete_first(), outerPlanState, PlanState::plan, plan, ScanState::ps, show_sort_group_keys(), and GroupState::ss.

Referenced by ExplainNode().

show_grouping_set_keys()

static void show_grouping_set_keys ( PlanState *  planstate, Agg *  aggnode, Sort *  sortnode, List *  context, bool  useprefix, List *  ancestors, ExplainState *  es  )

static

Definition at line 2488 of file explain.c.

{
    Plan       *plan = planstate->plan;
    char       *exprstr;
    ListCell   *lc;
    List       *gsets = aggnode->groupingSets;
    AttrNumber *keycols = aggnode->grpColIdx;
    const char *keyname;
    const char *keysetname;
 
    if (aggnode->aggstrategy == AGG_HASHED || aggnode->aggstrategy == AGG_MIXED)
    {
        keyname = "Hash Key";
        keysetname = "Hash Keys";
    }
    else
    {
        keyname = "Group Key";
        keysetname = "Group Keys";
    }
 
    ExplainOpenGroup("Grouping Set", NULL, true, es);
 
    if (sortnode)
    {
        show_sort_group_keys(planstate, "Sort Key",
                             sortnode->numCols, 0, sortnode->sortColIdx,
                             sortnode->sortOperators, sortnode->collations,
                             sortnode->nullsFirst,
                             ancestors, es);
        if (es->format == EXPLAIN_FORMAT_TEXT)
            es->indent++;
    }
 
    ExplainOpenGroup(keysetname, keysetname, false, es);
 
    foreach(lc, gsets)
    {
        List       *result = NIL;
        ListCell   *lc2;
 
        foreach(lc2, (List *) lfirst(lc))
        {
            Index       i = lfirst_int(lc2);
            AttrNumber  keyresno = keycols[i];
            TargetEntry *target = get_tle_by_resno(plan->targetlist,
                                                   keyresno);
 
            if (!target)
                elog(ERROR, "no tlist entry for key %d", keyresno);
            /* Deparse the expression, showing any top-level cast */
            exprstr = deparse_expression((Node *) target->expr, context,
                                         useprefix, true);
 
            result = lappend(result, exprstr);
        }
 
        if (!result && es->format == EXPLAIN_FORMAT_TEXT)
            ExplainPropertyText(keyname, "()", es);
        else
            ExplainPropertyListNested(keyname, result, es);
    }
 
    ExplainCloseGroup(keysetname, keysetname, false, es);
 
    if (sortnode && es->format == EXPLAIN_FORMAT_TEXT)
        es->indent--;
 
    ExplainCloseGroup("Grouping Set", NULL, true, es);
}

References AGG_HASHED, AGG_MIXED, Agg::aggstrategy, config_generic::context, deparse_expression(), elog(), ERROR, EXPLAIN_FORMAT_TEXT, ExplainCloseGroup(), ExplainOpenGroup(), ExplainPropertyListNested(), ExplainPropertyText(), TargetEntry::expr, ExplainState::format, get_tle_by_resno(), Agg::groupingSets, i, ExplainState::indent, lappend(), lfirst, lfirst_int, NIL, Sort::numCols, PlanState::plan, plan, and show_sort_group_keys().

Referenced by show_grouping_sets().

show_grouping_sets()

static void show_grouping_sets ( PlanState *  planstate, Agg *  agg, List *  ancestors, ExplainState *  es  )

static

Definition at line 2457 of file explain.c.

{
    List       *context;
    bool        useprefix;
    ListCell   *lc;
 
    /* Set up deparsing context */
    context = set_deparse_context_plan(es->deparse_cxt,
                                       planstate->plan,
                                       ancestors);
    useprefix = (list_length(es->rtable) > 1 || es->verbose);
 
    ExplainOpenGroup("Grouping Sets", "Grouping Sets", false, es);
 
    show_grouping_set_keys(planstate, agg, NULL,
                           context, useprefix, ancestors, es);
 
    foreach(lc, agg->chain)
    {
        Agg        *aggnode = lfirst(lc);
        Sort       *sortnode = (Sort *) aggnode->plan.lefttree;
 
        show_grouping_set_keys(planstate, aggnode, sortnode,
                               context, useprefix, ancestors, es);
    }
 
    ExplainCloseGroup("Grouping Sets", "Grouping Sets", false, es);
}

References Agg::chain, config_generic::context, ExplainState::deparse_cxt, ExplainCloseGroup(), ExplainOpenGroup(), Plan::lefttree, lfirst, list_length(), PlanState::plan, Agg::plan, ExplainState::rtable, set_deparse_context_plan(), show_grouping_set_keys(), and ExplainState::verbose.

Referenced by show_agg_keys().

show_hash_info()

static void show_hash_info ( HashState *  hashstate, ExplainState *  es  )

static

Definition at line 3063 of file explain.c.

{
    HashInstrumentation hinstrument = {0};
 
    /*
     * Collect stats from the local process, even when it's a parallel query.
     * In a parallel query, the leader process may or may not have run the
     * hash join, and even if it did it may not have built a hash table due to
     * timing (if it started late it might have seen no tuples in the outer
     * relation and skipped building the hash table).  Therefore we have to be
     * prepared to get instrumentation data from all participants.
     */
    if (hashstate->hinstrument)
        memcpy(&hinstrument, hashstate->hinstrument,
               sizeof(HashInstrumentation));
 
    /*
     * Merge results from workers.  In the parallel-oblivious case, the
     * results from all participants should be identical, except where
     * participants didn't run the join at all so have no data.  In the
     * parallel-aware case, we need to consider all the results.  Each worker
     * may have seen a different subset of batches and we want to report the
     * highest memory usage across all batches.  We take the maxima of other
     * values too, for the same reasons as in ExecHashAccumInstrumentation.
     */
    if (hashstate->shared_info)
    {
        SharedHashInfo *shared_info = hashstate->shared_info;
        int         i;
 
        for (i = 0; i < shared_info->num_workers; ++i)
        {
            HashInstrumentation *worker_hi = &shared_info->hinstrument[i];
 
            hinstrument.nbuckets = Max(hinstrument.nbuckets,
                                       worker_hi->nbuckets);
            hinstrument.nbuckets_original = Max(hinstrument.nbuckets_original,
                                                worker_hi->nbuckets_original);
            hinstrument.nbatch = Max(hinstrument.nbatch,
                                     worker_hi->nbatch);
            hinstrument.nbatch_original = Max(hinstrument.nbatch_original,
                                              worker_hi->nbatch_original);
            hinstrument.space_peak = Max(hinstrument.space_peak,
                                         worker_hi->space_peak);
        }
    }
 
    if (hinstrument.nbatch > 0)
    {
        long        spacePeakKb = (hinstrument.space_peak + 1023) / 1024;
 
        if (es->format != EXPLAIN_FORMAT_TEXT)
        {
            ExplainPropertyInteger("Hash Buckets", NULL,
                                   hinstrument.nbuckets, es);
            ExplainPropertyInteger("Original Hash Buckets", NULL,
                                   hinstrument.nbuckets_original, es);
            ExplainPropertyInteger("Hash Batches", NULL,
                                   hinstrument.nbatch, es);
            ExplainPropertyInteger("Original Hash Batches", NULL,
                                   hinstrument.nbatch_original, es);
            ExplainPropertyInteger("Peak Memory Usage", "kB",
                                   spacePeakKb, es);
        }
        else if (hinstrument.nbatch_original != hinstrument.nbatch ||
                 hinstrument.nbuckets_original != hinstrument.nbuckets)
        {
            ExplainIndentText(es);
            appendStringInfo(es->str,
                             "Buckets: %d (originally %d)  Batches: %d (originally %d)  Memory Usage: %ldkB\n",
                             hinstrument.nbuckets,
                             hinstrument.nbuckets_original,
                             hinstrument.nbatch,
                             hinstrument.nbatch_original,
                             spacePeakKb);
        }
        else
        {
            ExplainIndentText(es);
            appendStringInfo(es->str,
                             "Buckets: %d  Batches: %d  Memory Usage: %ldkB\n",
                             hinstrument.nbuckets, hinstrument.nbatch,
                             spacePeakKb);
        }
    }
}

References appendStringInfo(), EXPLAIN_FORMAT_TEXT, ExplainIndentText(), ExplainPropertyInteger(), ExplainState::format, SharedHashInfo::hinstrument, HashState::hinstrument, i, Max, HashInstrumentation::nbatch, HashInstrumentation::nbatch_original, HashInstrumentation::nbuckets, HashInstrumentation::nbuckets_original, SharedHashInfo::num_workers, HashState::shared_info, HashInstrumentation::space_peak, and ExplainState::str.

Referenced by ExplainNode().

show_hashagg_info()

static void show_hashagg_info ( AggState *  aggstate, ExplainState *  es  )

static

Definition at line 3298 of file explain.c.

{
    Agg        *agg = (Agg *) aggstate->ss.ps.plan;
    int64       memPeakKb = (aggstate->hash_mem_peak + 1023) / 1024;
 
    if (agg->aggstrategy != AGG_HASHED &&
        agg->aggstrategy != AGG_MIXED)
        return;
 
    if (es->format != EXPLAIN_FORMAT_TEXT)
    {
        if (es->costs)
            ExplainPropertyInteger("Planned Partitions", NULL,
                                   aggstate->hash_planned_partitions, es);
 
        /*
         * During parallel query the leader may have not helped out.  We
         * detect this by checking how much memory it used.  If we find it
         * didn't do any work then we don't show its properties.
         */
        if (es->analyze && aggstate->hash_mem_peak > 0)
        {
            ExplainPropertyInteger("HashAgg Batches", NULL,
                                   aggstate->hash_batches_used, es);
            ExplainPropertyInteger("Peak Memory Usage", "kB", memPeakKb, es);
            ExplainPropertyInteger("Disk Usage", "kB",
                                   aggstate->hash_disk_used, es);
        }
    }
    else
    {
        bool        gotone = false;
 
        if (es->costs && aggstate->hash_planned_partitions > 0)
        {
            ExplainIndentText(es);
            appendStringInfo(es->str, "Planned Partitions: %d",
                             aggstate->hash_planned_partitions);
            gotone = true;
        }
 
        /*
         * During parallel query the leader may have not helped out.  We
         * detect this by checking how much memory it used.  If we find it
         * didn't do any work then we don't show its properties.
         */
        if (es->analyze && aggstate->hash_mem_peak > 0)
        {
            if (!gotone)
                ExplainIndentText(es);
            else
                appendStringInfoSpaces(es->str, 2);
 
            appendStringInfo(es->str, "Batches: %d  Memory Usage: " INT64_FORMAT "kB",
                             aggstate->hash_batches_used, memPeakKb);
            gotone = true;
 
            /* Only display disk usage if we spilled to disk */
            if (aggstate->hash_batches_used > 1)
            {
                appendStringInfo(es->str, "  Disk Usage: " UINT64_FORMAT "kB",
                                 aggstate->hash_disk_used);
            }
        }
 
        if (gotone)
            appendStringInfoChar(es->str, '\n');
    }
 
    /* Display stats for each parallel worker */
    if (es->analyze && aggstate->shared_info != NULL)
    {
        for (int n = 0; n < aggstate->shared_info->num_workers; n++)
        {
            AggregateInstrumentation *sinstrument;
            uint64      hash_disk_used;
            int         hash_batches_used;
 
            sinstrument = &aggstate->shared_info->sinstrument[n];
            /* Skip workers that didn't do anything */
            if (sinstrument->hash_mem_peak == 0)
                continue;
            hash_disk_used = sinstrument->hash_disk_used;
            hash_batches_used = sinstrument->hash_batches_used;
            memPeakKb = (sinstrument->hash_mem_peak + 1023) / 1024;
 
            if (es->workers_state)
                ExplainOpenWorker(n, es);
 
            if (es->format == EXPLAIN_FORMAT_TEXT)
            {
                ExplainIndentText(es);
 
                appendStringInfo(es->str, "Batches: %d  Memory Usage: " INT64_FORMAT "kB",
                                 hash_batches_used, memPeakKb);
 
                /* Only display disk usage if we spilled to disk */
                if (hash_batches_used > 1)
                    appendStringInfo(es->str, "  Disk Usage: " UINT64_FORMAT "kB",
                                     hash_disk_used);
                appendStringInfoChar(es->str, '\n');
            }
            else