explain_format.h File Reference

#include "nodes/pg_list.h"

Include dependency graph for explain_format.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	ExplainPropertyList (const char *qlabel, List *data, struct ExplainState *es)
void	ExplainPropertyListNested (const char *qlabel, List *data, struct ExplainState *es)
void	ExplainPropertyText (const char *qlabel, const char *value, struct ExplainState *es)
void	ExplainPropertyInteger (const char *qlabel, const char *unit, int64 value, struct ExplainState *es)
void	ExplainPropertyUInteger (const char *qlabel, const char *unit, uint64 value, struct ExplainState *es)
void	ExplainPropertyFloat (const char *qlabel, const char *unit, double value, int ndigits, struct ExplainState *es)
void	ExplainPropertyBool (const char *qlabel, bool value, struct ExplainState *es)
void	ExplainOpenGroup (const char *objtype, const char *labelname, bool labeled, struct ExplainState *es)
void	ExplainCloseGroup (const char *objtype, const char *labelname, bool labeled, struct ExplainState *es)
void	ExplainOpenSetAsideGroup (const char *objtype, const char *labelname, bool labeled, int depth, struct ExplainState *es)
void	ExplainSaveGroup (struct ExplainState *es, int depth, int *state_save)
void	ExplainRestoreGroup (struct ExplainState *es, int depth, int *state_save)
void	ExplainDummyGroup (const char *objtype, const char *labelname, struct ExplainState *es)
void	ExplainBeginOutput (struct ExplainState *es)
void	ExplainEndOutput (struct ExplainState *es)
void	ExplainSeparatePlans (struct ExplainState *es)
void	ExplainIndentText (struct ExplainState *es)

Function Documentation

ExplainBeginOutput()

void ExplainBeginOutput

(

struct ExplainState *

es

)

Definition at line 535 of file explain_format.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,
		struct ExplainState *	es
	)

Definition at line 342 of file explain_format.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(), ExplainPrintSerialize(), ExplainPrintSettings(), ExplainPrintTriggers(), overexplain_debug(), overexplain_range_table(), report_triggers(), show_grouping_set_keys(), show_grouping_sets(), show_incremental_sort_group_info(), and show_modifytable_info().

ExplainDummyGroup()

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

Definition at line 489 of file explain_format.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

(

struct ExplainState *

es

)

Definition at line 566 of file explain_format.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().

ExplainIndentText()

void ExplainIndentText

(

struct ExplainState *

es

)

Definition at line 651 of file explain_format.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(), ExplainOnePlan(), ExplainOpenWorker(), ExplainPrintJIT(), ExplainPrintSerialize(), ExplainProperty(), ExplainPropertyList(), overexplain_debug(), overexplain_range_table(), show_buffer_usage(), show_hash_info(), show_hashagg_info(), show_memoize_info(), show_memory_counters(), show_modifytable_info(), show_sort_info(), show_storage_info(), show_tablesample(), show_tidbitmap_info(), and show_wal_usage().

ExplainOpenGroup()

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

Definition at line 279 of file explain_format.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(), ExplainPrintSerialize(), ExplainPrintSettings(), ExplainPrintTriggers(), overexplain_debug(), overexplain_range_table(), report_triggers(), show_grouping_set_keys(), show_grouping_sets(), show_incremental_sort_group_info(), and show_modifytable_info().

ExplainOpenSetAsideGroup()

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

Definition at line 389 of file explain_format.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().

ExplainPropertyBool()

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

Definition at line 264 of file explain_format.c.

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

References ExplainProperty(), and value.

Referenced by ExplainNode(), ExplainPrintJIT(), overexplain_per_node_hook(), and overexplain_range_table().

ExplainPropertyFloat()

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

Definition at line 250 of file explain_format.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(), ExplainPrintSerialize(), overexplain_range_table(), report_triggers(), show_buffer_usage(), show_instrumentation_count(), and show_modifytable_info().

ExplainPropertyInteger()

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

Definition at line 223 of file explain_format.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(), overexplain_per_node_hook(), overexplain_range_table(), postgresExplainForeignModify(), show_buffer_usage(), show_hash_info(), show_hashagg_info(), show_incremental_sort_group_info(), show_memoize_info(), show_memory_counters(), show_sort_info(), show_storage_info(), and show_wal_usage().

ExplainPropertyList()

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

Definition at line 38 of file explain_format.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(), ExplainState::str, str, X_CLOSING, and X_OPENING.

Referenced by ExplainPropertyListNested(), 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,
		struct ExplainState *	es
	)

Definition at line 108 of file explain_format.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,
		struct ExplainState *	es
	)

Definition at line 214 of file explain_format.c.

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

References ExplainProperty(), and value.

Referenced by ExplainIndexScanDetails(), ExplainNode(), ExplainPrintSerialize(), ExplainPrintSettings(), ExplainQueryParameters(), ExplainQueryText(), ExplainTargetRel(), fileExplainForeignScan(), overexplain_alias(), overexplain_bitmapset(), overexplain_debug(), overexplain_intlist(), overexplain_range_table(), postgresExplainDirectModify(), postgresExplainForeignModify(), postgresExplainForeignScan(), report_triggers(), show_expression(), show_grouping_set_keys(), show_memoize_info(), show_modifytable_info(), show_sort_info(), show_storage_info(), show_tablesample(), and show_window_def().

ExplainPropertyUInteger()

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

Definition at line 236 of file explain_format.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 ExplainPrintSerialize(), overexplain_range_table(), show_hash_info(), show_indexsearches_info(), show_tidbitmap_info(), and show_wal_usage().

ExplainRestoreGroup()

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

Definition at line 458 of file explain_format.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().

ExplainSaveGroup()

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

Definition at line 428 of file explain_format.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().

ExplainSeparatePlans()

void ExplainSeparatePlans

(

struct ExplainState *

es

)

Definition at line 595 of file explain_format.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().