PostgreSQL Source Code git master
Typedefs | Functions
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.

Typedefs

typedef struct ExplainState ExplainState
 

Functions

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 ExplainOpenSetAsideGroup (const char *objtype, const char *labelname, bool labeled, int depth, ExplainState *es)
 
void ExplainSaveGroup (ExplainState *es, int depth, int *state_save)
 
void ExplainRestoreGroup (ExplainState *es, int depth, int *state_save)
 
void ExplainDummyGroup (const char *objtype, const char *labelname, ExplainState *es)
 
void ExplainBeginOutput (ExplainState *es)
 
void ExplainEndOutput (ExplainState *es)
 
void ExplainSeparatePlans (ExplainState *es)
 
void ExplainIndentText (ExplainState *es)
 

Typedef Documentation

◆ ExplainState

typedef struct ExplainState ExplainState

Definition at line 19 of file explain_format.h.

Function Documentation

◆ ExplainBeginOutput()

void ExplainBeginOutput ( ExplainState *  es)

Definition at line 535 of file explain_format.c.

536{
537 switch (es->format)
538 {
539 case EXPLAIN_FORMAT_TEXT:
540 /* nothing to do */
541 break;
542
543 case EXPLAIN_FORMAT_XML:
544 appendStringInfoString(es->str,
545 "<explain xmlns=\"http://www.postgresql.org/2009/explain\">\n");
546 es->indent++;
547 break;
548
549 case EXPLAIN_FORMAT_JSON:
550 /* top-level structure is an array of plans */
551 appendStringInfoChar(es->str, '[');
552 es->grouping_stack = lcons_int(0, es->grouping_stack);
553 es->indent++;
554 break;
555
556 case EXPLAIN_FORMAT_YAML:
557 es->grouping_stack = lcons_int(0, es->grouping_stack);
558 break;
559 }
560}
EXPLAIN_FORMAT_XML
@ EXPLAIN_FORMAT_XML
Definition: explain_state.h:30
EXPLAIN_FORMAT_YAML
@ EXPLAIN_FORMAT_YAML
Definition: explain_state.h:32
EXPLAIN_FORMAT_TEXT
@ EXPLAIN_FORMAT_TEXT
Definition: explain_state.h:29
EXPLAIN_FORMAT_JSON
@ EXPLAIN_FORMAT_JSON
Definition: explain_state.h:31
lcons_int
List * lcons_int(int datum, List *list)
Definition: list.c:513
appendStringInfoString
void appendStringInfoString(StringInfo str, const char *s)
Definition: stringinfo.c:230
appendStringInfoChar
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:242
ExplainState::grouping_stack
List * grouping_stack
Definition: explain_state.h:62
ExplainState::str
StringInfo str
Definition: explain_state.h:46
ExplainState::format
ExplainFormat format
Definition: explain_state.h:59

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 342 of file explain_format.c.

344{
345 switch (es->format)
346 {
347 case EXPLAIN_FORMAT_TEXT:
348 /* nothing to do */
349 break;
350
351 case EXPLAIN_FORMAT_XML:
352 es->indent--;
353 ExplainXMLTag(objtype, X_CLOSING, es);
354 break;
355
356 case EXPLAIN_FORMAT_JSON:
357 es->indent--;
358 appendStringInfoChar(es->str, '\n');
359 appendStringInfoSpaces(es->str, 2 * es->indent);
360 appendStringInfoChar(es->str, labeled ? '}' : ']');
361 es->grouping_stack = list_delete_first(es->grouping_stack);
362 break;
363
364 case EXPLAIN_FORMAT_YAML:
365 es->indent--;
366 es->grouping_stack = list_delete_first(es->grouping_stack);
367 break;
368 }
369}
ExplainXMLTag
static void ExplainXMLTag(const char *tagname, int flags, ExplainState *es)
Definition: explain_format.c:624
X_CLOSING
#define X_CLOSING
Definition: explain_format.c:24
list_delete_first
List * list_delete_first(List *list)
Definition: list.c:943
appendStringInfoSpaces
void appendStringInfoSpaces(StringInfo str, int count)
Definition: stringinfo.c:260

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,
ExplainState *  es 
)

Definition at line 489 of file explain_format.c.

490{
491 switch (es->format)
492 {
493 case EXPLAIN_FORMAT_TEXT:
494 /* nothing to do */
495 break;
496
497 case EXPLAIN_FORMAT_XML:
498 ExplainXMLTag(objtype, X_CLOSE_IMMEDIATE, es);
499 break;
500
501 case EXPLAIN_FORMAT_JSON:
502 ExplainJSONLineEnding(es);
503 appendStringInfoSpaces(es->str, 2 * es->indent);
504 if (labelname)
505 {
506 escape_json(es->str, labelname);
507 appendStringInfoString(es->str, ": ");
508 }
509 escape_json(es->str, objtype);
510 break;
511
512 case EXPLAIN_FORMAT_YAML:
513 ExplainYAMLLineStarting(es);
514 if (labelname)
515 {
516 escape_yaml(es->str, labelname);
517 appendStringInfoString(es->str, ": ");
518 }
519 else
520 {
521 appendStringInfoString(es->str, "- ");
522 }
523 escape_yaml(es->str, objtype);
524 break;
525 }
526}
X_CLOSE_IMMEDIATE
#define X_CLOSE_IMMEDIATE
Definition: explain_format.c:25
ExplainYAMLLineStarting
static void ExplainYAMLLineStarting(ExplainState *es)
Definition: explain_format.c:686
ExplainJSONLineEnding
static void ExplainJSONLineEnding(ExplainState *es)
Definition: explain_format.c:666
escape_yaml
static void escape_yaml(StringInfo buf, const char *str)
Definition: explain_format.c:711
escape_json
void escape_json(StringInfo buf, const char *str)
Definition: json.c:1604

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 566 of file explain_format.c.

567{
568 switch (es->format)
569 {
570 case EXPLAIN_FORMAT_TEXT:
571 /* nothing to do */
572 break;
573
574 case EXPLAIN_FORMAT_XML:
575 es->indent--;
576 appendStringInfoString(es->str, "</explain>");
577 break;
578
579 case EXPLAIN_FORMAT_JSON:
580 es->indent--;
581 appendStringInfoString(es->str, "\n]");
582 es->grouping_stack = list_delete_first(es->grouping_stack);
583 break;
584
585 case EXPLAIN_FORMAT_YAML:
586 es->grouping_stack = list_delete_first(es->grouping_stack);
587 break;
588 }
589}

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 ( ExplainState *  es)

Definition at line 651 of file explain_format.c.

652{
653 Assert(es->format == EXPLAIN_FORMAT_TEXT);
654 if (es->str->len == 0 || es->str->data[es->str->len - 1] == '\n')
655 appendStringInfoSpaces(es->str, es->indent * 2);
656}
Assert
Assert(PointerIsAligned(start, uint64))

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,
ExplainState *  es 
)

Definition at line 279 of file explain_format.c.

281{
282 switch (es->format)
283 {
284 case EXPLAIN_FORMAT_TEXT:
285 /* nothing to do */
286 break;
287
288 case EXPLAIN_FORMAT_XML:
289 ExplainXMLTag(objtype, X_OPENING, es);
290 es->indent++;
291 break;
292
293 case EXPLAIN_FORMAT_JSON:
294 ExplainJSONLineEnding(es);
295 appendStringInfoSpaces(es->str, 2 * es->indent);
296 if (labelname)
297 {
298 escape_json(es->str, labelname);
299 appendStringInfoString(es->str, ": ");
300 }
301 appendStringInfoChar(es->str, labeled ? '{' : '[');
302
303 /*
304 * In JSON format, the grouping_stack is an integer list. 0 means
305 * we've emitted nothing at this grouping level, 1 means we've
306 * emitted something (and so the next item needs a comma). See
307 * ExplainJSONLineEnding().
308 */
309 es->grouping_stack = lcons_int(0, es->grouping_stack);
310 es->indent++;
311 break;
312
313 case EXPLAIN_FORMAT_YAML:
314
315 /*
316 * In YAML format, the grouping stack is an integer list. 0 means
317 * we've emitted nothing at this grouping level AND this grouping
318 * level is unlabeled and must be marked with "- ". See
319 * ExplainYAMLLineStarting().
320 */
321 ExplainYAMLLineStarting(es);
322 if (labelname)
323 {
324 appendStringInfo(es->str, "%s: ", labelname);
325 es->grouping_stack = lcons_int(1, es->grouping_stack);
326 }
327 else
328 {
329 appendStringInfoString(es->str, "- ");
330 es->grouping_stack = lcons_int(0, es->grouping_stack);
331 }
332 es->indent++;
333 break;
334 }
335}
X_OPENING
#define X_OPENING
Definition: explain_format.c:23
appendStringInfo
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition: stringinfo.c:145

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,
ExplainState *  es 
)

Definition at line 389 of file explain_format.c.

391{
392 switch (es->format)
393 {
394 case EXPLAIN_FORMAT_TEXT:
395 /* nothing to do */
396 break;
397
398 case EXPLAIN_FORMAT_XML:
399 es->indent += depth;
400 break;
401
402 case EXPLAIN_FORMAT_JSON:
403 es->grouping_stack = lcons_int(0, es->grouping_stack);
404 es->indent += depth;
405 break;
406
407 case EXPLAIN_FORMAT_YAML:
408 if (labelname)
409 es->grouping_stack = lcons_int(1, es->grouping_stack);
410 else
411 es->grouping_stack = lcons_int(0, es->grouping_stack);
412 es->indent += depth;
413 break;
414 }
415}

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,
ExplainState *  es 
)

Definition at line 264 of file explain_format.c.

265{
266 ExplainProperty(qlabel, NULL, value ? "true" : "false", true, es);
267}
ExplainProperty
static void ExplainProperty(const char *qlabel, const char *unit, const char *value, bool numeric, ExplainState *es)
Definition: explain_format.c:161
value
static struct @171 value

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,
ExplainState *  es 
)

Definition at line 250 of file explain_format.c.

252{
253 char *buf;
254
255 buf = psprintf("%.*f", ndigits, value);
256 ExplainProperty(qlabel, unit, buf, true, es);
257 pfree(buf);
258}
pfree
void pfree(void *pointer)
Definition: mcxt.c:1594
buf
static char * buf
Definition: pg_test_fsync.c:72
psprintf
char * psprintf(const char *fmt,...)
Definition: psprintf.c:43

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

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

◆ ExplainPropertyInteger()

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

Definition at line 223 of file explain_format.c.

225{
226 char buf[32];
227
228 snprintf(buf, sizeof(buf), INT64_FORMAT, value);
229 ExplainProperty(qlabel, unit, buf, true, es);
230}
INT64_FORMAT
#define INT64_FORMAT
Definition: c.h:561
snprintf
#define snprintf
Definition: port.h:239

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,
ExplainState *  es 
)

Definition at line 38 of file explain_format.c.

39{
40 ListCell *lc;
41 bool first = true;
42
43 switch (es->format)
44 {
45 case EXPLAIN_FORMAT_TEXT:
46 ExplainIndentText(es);
47 appendStringInfo(es->str, "%s: ", qlabel);
48 foreach(lc, data)
49 {
50 if (!first)
51 appendStringInfoString(es->str, ", ");
52 appendStringInfoString(es->str, (const char *) lfirst(lc));
53 first = false;
54 }
55 appendStringInfoChar(es->str, '\n');
56 break;
57
58 case EXPLAIN_FORMAT_XML:
59 ExplainXMLTag(qlabel, X_OPENING, es);
60 foreach(lc, data)
61 {
62 char *str;
63
64 appendStringInfoSpaces(es->str, es->indent * 2 + 2);
65 appendStringInfoString(es->str, "<Item>");
66 str = escape_xml((const char *) lfirst(lc));
67 appendStringInfoString(es->str, str);
68 pfree(str);
69 appendStringInfoString(es->str, "</Item>\n");
70 }
71 ExplainXMLTag(qlabel, X_CLOSING, es);
72 break;
73
74 case EXPLAIN_FORMAT_JSON:
75 ExplainJSONLineEnding(es);
76 appendStringInfoSpaces(es->str, es->indent * 2);
77 escape_json(es->str, qlabel);
78 appendStringInfoString(es->str, ": [");
79 foreach(lc, data)
80 {
81 if (!first)
82 appendStringInfoString(es->str, ", ");
83 escape_json(es->str, (const char *) lfirst(lc));
84 first = false;
85 }
86 appendStringInfoChar(es->str, ']');
87 break;
88
89 case EXPLAIN_FORMAT_YAML:
90 ExplainYAMLLineStarting(es);
91 appendStringInfo(es->str, "%s: ", qlabel);
92 foreach(lc, data)
93 {
94 appendStringInfoChar(es->str, '\n');
95 appendStringInfoSpaces(es->str, es->indent * 2 + 2);
96 appendStringInfoString(es->str, "- ");
97 escape_yaml(es->str, (const char *) lfirst(lc));
98 }
99 break;
100 }
101}
ExplainIndentText
void ExplainIndentText(ExplainState *es)
Definition: explain_format.c:651
str
const char * str
Definition: hashfn_unstable.h:254
data
const void * data
Definition: pg_crc32c_sse42.c:27
lfirst
#define lfirst(lc)
Definition: pg_list.h:172
escape_xml
char * escape_xml(const char *str)
Definition: xml.c:2735

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,
ExplainState *  es 
)

Definition at line 108 of file explain_format.c.

109{
110 ListCell *lc;
111 bool first = true;
112
113 switch (es->format)
114 {
115 case EXPLAIN_FORMAT_TEXT:
116 case EXPLAIN_FORMAT_XML:
117 ExplainPropertyList(qlabel, data, es);
118 return;
119
120 case EXPLAIN_FORMAT_JSON:
121 ExplainJSONLineEnding(es);
122 appendStringInfoSpaces(es->str, es->indent * 2);
123 appendStringInfoChar(es->str, '[');
124 foreach(lc, data)
125 {
126 if (!first)
127 appendStringInfoString(es->str, ", ");
128 escape_json(es->str, (const char *) lfirst(lc));
129 first = false;
130 }
131 appendStringInfoChar(es->str, ']');
132 break;
133
134 case EXPLAIN_FORMAT_YAML:
135 ExplainYAMLLineStarting(es);
136 appendStringInfoString(es->str, "- [");
137 foreach(lc, data)
138 {
139 if (!first)
140 appendStringInfoString(es->str, ", ");
141 escape_yaml(es->str, (const char *) lfirst(lc));
142 first = false;
143 }
144 appendStringInfoChar(es->str, ']');
145 break;
146 }
147}
ExplainPropertyList
void ExplainPropertyList(const char *qlabel, List *data, ExplainState *es)
Definition: explain_format.c:38

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 214 of file explain_format.c.

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

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_result_replacement_info(), show_sort_info(), show_storage_info(), show_tablesample(), and show_window_def().

◆ ExplainPropertyUInteger()

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

Definition at line 236 of file explain_format.c.

238{
239 char buf[32];
240
241 snprintf(buf, sizeof(buf), UINT64_FORMAT, value);
242 ExplainProperty(qlabel, unit, buf, true, es);
243}
UINT64_FORMAT
#define UINT64_FORMAT
Definition: c.h:562

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

Referenced by ExplainPrintSerialize(), overexplain_range_table(), show_hash_info(), show_indexsearches_info(), show_memoize_info(), show_tidbitmap_info(), and show_wal_usage().

◆ ExplainRestoreGroup()

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

Definition at line 458 of file explain_format.c.

459{
460 switch (es->format)
461 {
462 case EXPLAIN_FORMAT_TEXT:
463 /* nothing to do */
464 break;
465
466 case EXPLAIN_FORMAT_XML:
467 es->indent += depth;
468 break;
469
470 case EXPLAIN_FORMAT_JSON:
471 es->grouping_stack = lcons_int(*state_save, es->grouping_stack);
472 es->indent += depth;
473 break;
474
475 case EXPLAIN_FORMAT_YAML:
476 es->grouping_stack = lcons_int(*state_save, es->grouping_stack);
477 es->indent += depth;
478 break;
479 }
480}

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 ( ExplainState *  es,
int  depth,
int *  state_save 
)

Definition at line 428 of file explain_format.c.

429{
430 switch (es->format)
431 {
432 case EXPLAIN_FORMAT_TEXT:
433 /* nothing to do */
434 break;
435
436 case EXPLAIN_FORMAT_XML:
437 es->indent -= depth;
438 break;
439
440 case EXPLAIN_FORMAT_JSON:
441 es->indent -= depth;
442 *state_save = linitial_int(es->grouping_stack);
443 es->grouping_stack = list_delete_first(es->grouping_stack);
444 break;
445
446 case EXPLAIN_FORMAT_YAML:
447 es->indent -= depth;
448 *state_save = linitial_int(es->grouping_stack);
449 es->grouping_stack = list_delete_first(es->grouping_stack);
450 break;
451 }
452}
linitial_int
#define linitial_int(l)
Definition: pg_list.h:179

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 ( ExplainState *  es)

Definition at line 595 of file explain_format.c.

596{
597 switch (es->format)
598 {
599 case EXPLAIN_FORMAT_TEXT:
600 /* add a blank line */
601 appendStringInfoChar(es->str, '\n');
602 break;
603
604 case EXPLAIN_FORMAT_XML:
605 case EXPLAIN_FORMAT_JSON:
606 case EXPLAIN_FORMAT_YAML:
607 /* nothing to do */
608 break;
609 }
610}

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

Referenced by ExplainExecuteQuery(), and ExplainQuery().