1 /*-------------------------------------------------------------------------
4 * Output functions for Postgres tree nodes.
6 * Portions Copyright (c) 1996-2007, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
11 * $PostgreSQL: pgsql/src/backend/nodes/outfuncs.c,v 1.306 2007/04/27 22:05:47 tgl Exp $
14 * Every node type that can appear in stored rules' parsetrees *must*
15 * have an output function defined here (as well as an input function
16 * in readfuncs.c). For use in debugging, we also provide output
17 * functions for nodes that appear in raw parsetrees, path, and plan trees.
18 * These nodes however need not have input functions.
20 *-------------------------------------------------------------------------
26 #include "lib/stringinfo.h"
27 #include "nodes/plannodes.h"
28 #include "nodes/relation.h"
29 #include "utils/datum.h"
33 * Macros to simplify output of different kinds of fields. Use these
34 * wherever possible to reduce the chance for silly typos. Note that these
35 * hard-wire conventions about the names of the local variables in an Out
39 /* Write the label for the node type */
40 #define WRITE_NODE_TYPE(nodelabel) \
41 appendStringInfoString(str, nodelabel)
43 /* Write an integer field (anything written as ":fldname %d") */
44 #define WRITE_INT_FIELD(fldname) \
45 appendStringInfo(str, " :" CppAsString(fldname) " %d", node->fldname)
47 /* Write an unsigned integer field (anything written as ":fldname %u") */
48 #define WRITE_UINT_FIELD(fldname) \
49 appendStringInfo(str, " :" CppAsString(fldname) " %u", node->fldname)
51 /* Write an OID field (don't hard-wire assumption that OID is same as uint) */
52 #define WRITE_OID_FIELD(fldname) \
53 appendStringInfo(str, " :" CppAsString(fldname) " %u", node->fldname)
55 /* Write a long-integer field */
56 #define WRITE_LONG_FIELD(fldname) \
57 appendStringInfo(str, " :" CppAsString(fldname) " %ld", node->fldname)
59 /* Write a char field (ie, one ascii character) */
60 #define WRITE_CHAR_FIELD(fldname) \
61 appendStringInfo(str, " :" CppAsString(fldname) " %c", node->fldname)
63 /* Write an enumerated-type field as an integer code */
64 #define WRITE_ENUM_FIELD(fldname, enumtype) \
65 appendStringInfo(str, " :" CppAsString(fldname) " %d", \
68 /* Write a float field --- caller must give format to define precision */
69 #define WRITE_FLOAT_FIELD(fldname,format) \
70 appendStringInfo(str, " :" CppAsString(fldname) " " format, node->fldname)
72 /* Write a boolean field */
73 #define WRITE_BOOL_FIELD(fldname) \
74 appendStringInfo(str, " :" CppAsString(fldname) " %s", \
75 booltostr(node->fldname))
77 /* Write a character-string (possibly NULL) field */
78 #define WRITE_STRING_FIELD(fldname) \
79 (appendStringInfo(str, " :" CppAsString(fldname) " "), \
80 _outToken(str, node->fldname))
82 /* Write a Node field */
83 #define WRITE_NODE_FIELD(fldname) \
84 (appendStringInfo(str, " :" CppAsString(fldname) " "), \
85 _outNode(str, node->fldname))
87 /* Write a bitmapset field */
88 #define WRITE_BITMAPSET_FIELD(fldname) \
89 (appendStringInfo(str, " :" CppAsString(fldname) " "), \
90 _outBitmapset(str, node->fldname))
93 #define booltostr(x) ((x) ? "true" : "false")
95 static void _outNode(StringInfo str, void *obj);
100 * Convert an ordinary string (eg, an identifier) into a form that
101 * will be decoded back to a plain token by read.c's functions.
103 * If a null or empty string is given, it is encoded as "<>".
106 _outToken(StringInfo str, char *s)
108 if (s == NULL || *s == '\0')
110 appendStringInfo(str, "<>");
115 * Look for characters or patterns that are treated specially by read.c
116 * (either in pg_strtok() or in nodeRead()), and therefore need a
117 * protective backslash.
119 /* These characters only need to be quoted at the start of the string */
122 isdigit((unsigned char) *s) ||
123 ((*s == '+' || *s == '-') &&
124 (isdigit((unsigned char) s[1]) || s[1] == '.')))
125 appendStringInfoChar(str, '\\');
128 /* These chars must be backslashed anywhere in the string */
129 if (*s == ' ' || *s == '\n' || *s == '\t' ||
130 *s == '(' || *s == ')' || *s == '{' || *s == '}' ||
132 appendStringInfoChar(str, '\\');
133 appendStringInfoChar(str, *s++);
138 _outList(StringInfo str, List *node)
142 appendStringInfoChar(str, '(');
144 if (IsA(node, IntList))
145 appendStringInfoChar(str, 'i');
146 else if (IsA(node, OidList))
147 appendStringInfoChar(str, 'o');
152 * For the sake of backward compatibility, we emit a slightly
153 * different whitespace format for lists of nodes vs. other types of
154 * lists. XXX: is this necessary?
158 _outNode(str, lfirst(lc));
160 appendStringInfoChar(str, ' ');
162 else if (IsA(node, IntList))
163 appendStringInfo(str, " %d", lfirst_int(lc));
164 else if (IsA(node, OidList))
165 appendStringInfo(str, " %u", lfirst_oid(lc));
167 elog(ERROR, "unrecognized list node type: %d",
171 appendStringInfoChar(str, ')');
176 * converts a bitmap set of integers
178 * Note: the output format is "(b int int ...)", similar to an integer List.
179 * Currently bitmapsets do not appear in any node type that is stored in
180 * rules, so there is no support in readfuncs.c for reading this format.
183 _outBitmapset(StringInfo str, Bitmapset *bms)
188 appendStringInfoChar(str, '(');
189 appendStringInfoChar(str, 'b');
190 tmpset = bms_copy(bms);
191 while ((x = bms_first_member(tmpset)) >= 0)
192 appendStringInfo(str, " %d", x);
194 appendStringInfoChar(str, ')');
198 * Print the value of a Datum given its type.
201 _outDatum(StringInfo str, Datum value, int typlen, bool typbyval)
207 length = datumGetSize(value, typbyval, typlen);
211 s = (char *) (&value);
212 appendStringInfo(str, "%u [ ", (unsigned int) length);
213 for (i = 0; i < (Size) sizeof(Datum); i++)
214 appendStringInfo(str, "%d ", (int) (s[i]));
215 appendStringInfo(str, "]");
219 s = (char *) DatumGetPointer(value);
220 if (!PointerIsValid(s))
221 appendStringInfo(str, "0 [ ]");
224 appendStringInfo(str, "%u [ ", (unsigned int) length);
225 for (i = 0; i < length; i++)
226 appendStringInfo(str, "%d ", (int) (s[i]));
227 appendStringInfo(str, "]");
234 * Stuff from plannodes.h
238 _outPlannedStmt(StringInfo str, PlannedStmt *node)
240 WRITE_NODE_TYPE("PLANNEDSTMT");
242 WRITE_ENUM_FIELD(commandType, CmdType);
243 WRITE_BOOL_FIELD(canSetTag);
244 WRITE_NODE_FIELD(planTree);
245 WRITE_NODE_FIELD(rtable);
246 WRITE_NODE_FIELD(resultRelations);
247 WRITE_NODE_FIELD(utilityStmt);
248 WRITE_NODE_FIELD(intoClause);
249 WRITE_NODE_FIELD(subplans);
250 WRITE_BITMAPSET_FIELD(rewindPlanIDs);
251 WRITE_NODE_FIELD(returningLists);
252 WRITE_NODE_FIELD(rowMarks);
253 WRITE_INT_FIELD(nParamExec);
257 * print the basic stuff of all nodes that inherit from Plan
260 _outPlanInfo(StringInfo str, Plan *node)
262 WRITE_FLOAT_FIELD(startup_cost, "%.2f");
263 WRITE_FLOAT_FIELD(total_cost, "%.2f");
264 WRITE_FLOAT_FIELD(plan_rows, "%.0f");
265 WRITE_INT_FIELD(plan_width);
266 WRITE_NODE_FIELD(targetlist);
267 WRITE_NODE_FIELD(qual);
268 WRITE_NODE_FIELD(lefttree);
269 WRITE_NODE_FIELD(righttree);
270 WRITE_NODE_FIELD(initPlan);
271 WRITE_BITMAPSET_FIELD(extParam);
272 WRITE_BITMAPSET_FIELD(allParam);
276 * print the basic stuff of all nodes that inherit from Scan
279 _outScanInfo(StringInfo str, Scan *node)
281 _outPlanInfo(str, (Plan *) node);
283 WRITE_UINT_FIELD(scanrelid);
287 * print the basic stuff of all nodes that inherit from Join
290 _outJoinPlanInfo(StringInfo str, Join *node)
292 _outPlanInfo(str, (Plan *) node);
294 WRITE_ENUM_FIELD(jointype, JoinType);
295 WRITE_NODE_FIELD(joinqual);
300 _outPlan(StringInfo str, Plan *node)
302 WRITE_NODE_TYPE("PLAN");
304 _outPlanInfo(str, (Plan *) node);
308 _outResult(StringInfo str, Result *node)
310 WRITE_NODE_TYPE("RESULT");
312 _outPlanInfo(str, (Plan *) node);
314 WRITE_NODE_FIELD(resconstantqual);
318 _outAppend(StringInfo str, Append *node)
320 WRITE_NODE_TYPE("APPEND");
322 _outPlanInfo(str, (Plan *) node);
324 WRITE_NODE_FIELD(appendplans);
325 WRITE_BOOL_FIELD(isTarget);
329 _outBitmapAnd(StringInfo str, BitmapAnd *node)
331 WRITE_NODE_TYPE("BITMAPAND");
333 _outPlanInfo(str, (Plan *) node);
335 WRITE_NODE_FIELD(bitmapplans);
339 _outBitmapOr(StringInfo str, BitmapOr *node)
341 WRITE_NODE_TYPE("BITMAPOR");
343 _outPlanInfo(str, (Plan *) node);
345 WRITE_NODE_FIELD(bitmapplans);
349 _outScan(StringInfo str, Scan *node)
351 WRITE_NODE_TYPE("SCAN");
353 _outScanInfo(str, (Scan *) node);
357 _outSeqScan(StringInfo str, SeqScan *node)
359 WRITE_NODE_TYPE("SEQSCAN");
361 _outScanInfo(str, (Scan *) node);
365 _outIndexScan(StringInfo str, IndexScan *node)
367 WRITE_NODE_TYPE("INDEXSCAN");
369 _outScanInfo(str, (Scan *) node);
371 WRITE_OID_FIELD(indexid);
372 WRITE_NODE_FIELD(indexqual);
373 WRITE_NODE_FIELD(indexqualorig);
374 WRITE_NODE_FIELD(indexstrategy);
375 WRITE_NODE_FIELD(indexsubtype);
376 WRITE_ENUM_FIELD(indexorderdir, ScanDirection);
380 _outBitmapIndexScan(StringInfo str, BitmapIndexScan *node)
382 WRITE_NODE_TYPE("BITMAPINDEXSCAN");
384 _outScanInfo(str, (Scan *) node);
386 WRITE_OID_FIELD(indexid);
387 WRITE_NODE_FIELD(indexqual);
388 WRITE_NODE_FIELD(indexqualorig);
389 WRITE_NODE_FIELD(indexstrategy);
390 WRITE_NODE_FIELD(indexsubtype);
394 _outBitmapHeapScan(StringInfo str, BitmapHeapScan *node)
396 WRITE_NODE_TYPE("BITMAPHEAPSCAN");
398 _outScanInfo(str, (Scan *) node);
400 WRITE_NODE_FIELD(bitmapqualorig);
404 _outTidScan(StringInfo str, TidScan *node)
406 WRITE_NODE_TYPE("TIDSCAN");
408 _outScanInfo(str, (Scan *) node);
410 WRITE_NODE_FIELD(tidquals);
414 _outSubqueryScan(StringInfo str, SubqueryScan *node)
416 WRITE_NODE_TYPE("SUBQUERYSCAN");
418 _outScanInfo(str, (Scan *) node);
420 WRITE_NODE_FIELD(subplan);
421 WRITE_NODE_FIELD(subrtable);
425 _outFunctionScan(StringInfo str, FunctionScan *node)
427 WRITE_NODE_TYPE("FUNCTIONSCAN");
429 _outScanInfo(str, (Scan *) node);
431 WRITE_NODE_FIELD(funcexpr);
432 WRITE_NODE_FIELD(funccolnames);
433 WRITE_NODE_FIELD(funccoltypes);
434 WRITE_NODE_FIELD(funccoltypmods);
438 _outValuesScan(StringInfo str, ValuesScan *node)
440 WRITE_NODE_TYPE("VALUESSCAN");
442 _outScanInfo(str, (Scan *) node);
444 WRITE_NODE_FIELD(values_lists);
448 _outJoin(StringInfo str, Join *node)
450 WRITE_NODE_TYPE("JOIN");
452 _outJoinPlanInfo(str, (Join *) node);
456 _outNestLoop(StringInfo str, NestLoop *node)
458 WRITE_NODE_TYPE("NESTLOOP");
460 _outJoinPlanInfo(str, (Join *) node);
464 _outMergeJoin(StringInfo str, MergeJoin *node)
469 WRITE_NODE_TYPE("MERGEJOIN");
471 _outJoinPlanInfo(str, (Join *) node);
473 WRITE_NODE_FIELD(mergeclauses);
475 numCols = list_length(node->mergeclauses);
477 appendStringInfo(str, " :mergeFamilies");
478 for (i = 0; i < numCols; i++)
479 appendStringInfo(str, " %u", node->mergeFamilies[i]);
481 appendStringInfo(str, " :mergeStrategies");
482 for (i = 0; i < numCols; i++)
483 appendStringInfo(str, " %d", node->mergeStrategies[i]);
485 appendStringInfo(str, " :mergeNullsFirst");
486 for (i = 0; i < numCols; i++)
487 appendStringInfo(str, " %d", (int) node->mergeNullsFirst[i]);
491 _outHashJoin(StringInfo str, HashJoin *node)
493 WRITE_NODE_TYPE("HASHJOIN");
495 _outJoinPlanInfo(str, (Join *) node);
497 WRITE_NODE_FIELD(hashclauses);
501 _outAgg(StringInfo str, Agg *node)
503 WRITE_NODE_TYPE("AGG");
505 _outPlanInfo(str, (Plan *) node);
507 WRITE_ENUM_FIELD(aggstrategy, AggStrategy);
508 WRITE_INT_FIELD(numCols);
509 WRITE_LONG_FIELD(numGroups);
513 _outGroup(StringInfo str, Group *node)
517 WRITE_NODE_TYPE("GROUP");
519 _outPlanInfo(str, (Plan *) node);
521 WRITE_INT_FIELD(numCols);
523 appendStringInfo(str, " :grpColIdx");
524 for (i = 0; i < node->numCols; i++)
525 appendStringInfo(str, " %d", node->grpColIdx[i]);
527 appendStringInfo(str, " :grpOperators");
528 for (i = 0; i < node->numCols; i++)
529 appendStringInfo(str, " %u", node->grpOperators[i]);
533 _outMaterial(StringInfo str, Material *node)
535 WRITE_NODE_TYPE("MATERIAL");
537 _outPlanInfo(str, (Plan *) node);
541 _outSort(StringInfo str, Sort *node)
545 WRITE_NODE_TYPE("SORT");
547 _outPlanInfo(str, (Plan *) node);
549 WRITE_INT_FIELD(numCols);
551 appendStringInfo(str, " :sortColIdx");
552 for (i = 0; i < node->numCols; i++)
553 appendStringInfo(str, " %d", node->sortColIdx[i]);
555 appendStringInfo(str, " :sortOperators");
556 for (i = 0; i < node->numCols; i++)
557 appendStringInfo(str, " %u", node->sortOperators[i]);
559 appendStringInfo(str, " :nullsFirst");
560 for (i = 0; i < node->numCols; i++)
561 appendStringInfo(str, " %s", booltostr(node->nullsFirst[i]));
565 _outUnique(StringInfo str, Unique *node)
569 WRITE_NODE_TYPE("UNIQUE");
571 _outPlanInfo(str, (Plan *) node);
573 WRITE_INT_FIELD(numCols);
575 appendStringInfo(str, " :uniqColIdx");
576 for (i = 0; i < node->numCols; i++)
577 appendStringInfo(str, " %d", node->uniqColIdx[i]);
579 appendStringInfo(str, " :uniqOperators");
580 for (i = 0; i < node->numCols; i++)
581 appendStringInfo(str, " %u", node->uniqOperators[i]);
585 _outSetOp(StringInfo str, SetOp *node)
589 WRITE_NODE_TYPE("SETOP");
591 _outPlanInfo(str, (Plan *) node);
593 WRITE_ENUM_FIELD(cmd, SetOpCmd);
594 WRITE_INT_FIELD(numCols);
596 appendStringInfo(str, " :dupColIdx");
597 for (i = 0; i < node->numCols; i++)
598 appendStringInfo(str, " %d", node->dupColIdx[i]);
600 appendStringInfo(str, " :dupOperators");
601 for (i = 0; i < node->numCols; i++)
602 appendStringInfo(str, " %d", node->dupOperators[i]);
604 WRITE_INT_FIELD(flagColIdx);
608 _outLimit(StringInfo str, Limit *node)
610 WRITE_NODE_TYPE("LIMIT");
612 _outPlanInfo(str, (Plan *) node);
614 WRITE_NODE_FIELD(limitOffset);
615 WRITE_NODE_FIELD(limitCount);
619 _outHash(StringInfo str, Hash *node)
621 WRITE_NODE_TYPE("HASH");
623 _outPlanInfo(str, (Plan *) node);
626 /*****************************************************************************
628 * Stuff from primnodes.h.
630 *****************************************************************************/
633 _outAlias(StringInfo str, Alias *node)
635 WRITE_NODE_TYPE("ALIAS");
637 WRITE_STRING_FIELD(aliasname);
638 WRITE_NODE_FIELD(colnames);
642 _outRangeVar(StringInfo str, RangeVar *node)
644 WRITE_NODE_TYPE("RANGEVAR");
647 * we deliberately ignore catalogname here, since it is presently not
648 * semantically meaningful
650 WRITE_STRING_FIELD(schemaname);
651 WRITE_STRING_FIELD(relname);
652 WRITE_ENUM_FIELD(inhOpt, InhOption);
653 WRITE_BOOL_FIELD(istemp);
654 WRITE_NODE_FIELD(alias);
658 _outIntoClause(StringInfo str, IntoClause *node)
660 WRITE_NODE_TYPE("INTOCLAUSE");
662 WRITE_NODE_FIELD(rel);
663 WRITE_NODE_FIELD(colNames);
664 WRITE_NODE_FIELD(options);
665 WRITE_ENUM_FIELD(onCommit, OnCommitAction);
666 WRITE_STRING_FIELD(tableSpaceName);
670 _outVar(StringInfo str, Var *node)
672 WRITE_NODE_TYPE("VAR");
674 WRITE_UINT_FIELD(varno);
675 WRITE_INT_FIELD(varattno);
676 WRITE_OID_FIELD(vartype);
677 WRITE_INT_FIELD(vartypmod);
678 WRITE_UINT_FIELD(varlevelsup);
679 WRITE_UINT_FIELD(varnoold);
680 WRITE_INT_FIELD(varoattno);
684 _outConst(StringInfo str, Const *node)
686 WRITE_NODE_TYPE("CONST");
688 WRITE_OID_FIELD(consttype);
689 WRITE_INT_FIELD(consttypmod);
690 WRITE_INT_FIELD(constlen);
691 WRITE_BOOL_FIELD(constbyval);
692 WRITE_BOOL_FIELD(constisnull);
694 appendStringInfo(str, " :constvalue ");
695 if (node->constisnull)
696 appendStringInfo(str, "<>");
698 _outDatum(str, node->constvalue, node->constlen, node->constbyval);
702 _outParam(StringInfo str, Param *node)
704 WRITE_NODE_TYPE("PARAM");
706 WRITE_ENUM_FIELD(paramkind, ParamKind);
707 WRITE_INT_FIELD(paramid);
708 WRITE_OID_FIELD(paramtype);
709 WRITE_INT_FIELD(paramtypmod);
713 _outAggref(StringInfo str, Aggref *node)
715 WRITE_NODE_TYPE("AGGREF");
717 WRITE_OID_FIELD(aggfnoid);
718 WRITE_OID_FIELD(aggtype);
719 WRITE_NODE_FIELD(args);
720 WRITE_UINT_FIELD(agglevelsup);
721 WRITE_BOOL_FIELD(aggstar);
722 WRITE_BOOL_FIELD(aggdistinct);
726 _outArrayRef(StringInfo str, ArrayRef *node)
728 WRITE_NODE_TYPE("ARRAYREF");
730 WRITE_OID_FIELD(refarraytype);
731 WRITE_OID_FIELD(refelemtype);
732 WRITE_INT_FIELD(reftypmod);
733 WRITE_NODE_FIELD(refupperindexpr);
734 WRITE_NODE_FIELD(reflowerindexpr);
735 WRITE_NODE_FIELD(refexpr);
736 WRITE_NODE_FIELD(refassgnexpr);
740 _outFuncExpr(StringInfo str, FuncExpr *node)
742 WRITE_NODE_TYPE("FUNCEXPR");
744 WRITE_OID_FIELD(funcid);
745 WRITE_OID_FIELD(funcresulttype);
746 WRITE_BOOL_FIELD(funcretset);
747 WRITE_ENUM_FIELD(funcformat, CoercionForm);
748 WRITE_NODE_FIELD(args);
752 _outOpExpr(StringInfo str, OpExpr *node)
754 WRITE_NODE_TYPE("OPEXPR");
756 WRITE_OID_FIELD(opno);
757 WRITE_OID_FIELD(opfuncid);
758 WRITE_OID_FIELD(opresulttype);
759 WRITE_BOOL_FIELD(opretset);
760 WRITE_NODE_FIELD(args);
764 _outDistinctExpr(StringInfo str, DistinctExpr *node)
766 WRITE_NODE_TYPE("DISTINCTEXPR");
768 WRITE_OID_FIELD(opno);
769 WRITE_OID_FIELD(opfuncid);
770 WRITE_OID_FIELD(opresulttype);
771 WRITE_BOOL_FIELD(opretset);
772 WRITE_NODE_FIELD(args);
776 _outScalarArrayOpExpr(StringInfo str, ScalarArrayOpExpr *node)
778 WRITE_NODE_TYPE("SCALARARRAYOPEXPR");
780 WRITE_OID_FIELD(opno);
781 WRITE_OID_FIELD(opfuncid);
782 WRITE_BOOL_FIELD(useOr);
783 WRITE_NODE_FIELD(args);
787 _outBoolExpr(StringInfo str, BoolExpr *node)
791 WRITE_NODE_TYPE("BOOLEXPR");
793 /* do-it-yourself enum representation */
794 switch (node->boolop)
806 appendStringInfo(str, " :boolop ");
807 _outToken(str, opstr);
809 WRITE_NODE_FIELD(args);
813 _outSubLink(StringInfo str, SubLink *node)
815 WRITE_NODE_TYPE("SUBLINK");
817 WRITE_ENUM_FIELD(subLinkType, SubLinkType);
818 WRITE_NODE_FIELD(testexpr);
819 WRITE_NODE_FIELD(operName);
820 WRITE_NODE_FIELD(subselect);
824 _outSubPlan(StringInfo str, SubPlan *node)
826 WRITE_NODE_TYPE("SUBPLAN");
828 WRITE_ENUM_FIELD(subLinkType, SubLinkType);
829 WRITE_NODE_FIELD(testexpr);
830 WRITE_NODE_FIELD(paramIds);
831 WRITE_INT_FIELD(plan_id);
832 WRITE_OID_FIELD(firstColType);
833 WRITE_BOOL_FIELD(useHashTable);
834 WRITE_BOOL_FIELD(unknownEqFalse);
835 WRITE_NODE_FIELD(setParam);
836 WRITE_NODE_FIELD(parParam);
837 WRITE_NODE_FIELD(args);
841 _outFieldSelect(StringInfo str, FieldSelect *node)
843 WRITE_NODE_TYPE("FIELDSELECT");
845 WRITE_NODE_FIELD(arg);
846 WRITE_INT_FIELD(fieldnum);
847 WRITE_OID_FIELD(resulttype);
848 WRITE_INT_FIELD(resulttypmod);
852 _outFieldStore(StringInfo str, FieldStore *node)
854 WRITE_NODE_TYPE("FIELDSTORE");
856 WRITE_NODE_FIELD(arg);
857 WRITE_NODE_FIELD(newvals);
858 WRITE_NODE_FIELD(fieldnums);
859 WRITE_OID_FIELD(resulttype);
863 _outRelabelType(StringInfo str, RelabelType *node)
865 WRITE_NODE_TYPE("RELABELTYPE");
867 WRITE_NODE_FIELD(arg);
868 WRITE_OID_FIELD(resulttype);
869 WRITE_INT_FIELD(resulttypmod);
870 WRITE_ENUM_FIELD(relabelformat, CoercionForm);
874 _outArrayCoerceExpr(StringInfo str, ArrayCoerceExpr *node)
876 WRITE_NODE_TYPE("ARRAYCOERCEEXPR");
878 WRITE_NODE_FIELD(arg);
879 WRITE_OID_FIELD(elemfuncid);
880 WRITE_OID_FIELD(resulttype);
881 WRITE_INT_FIELD(resulttypmod);
882 WRITE_BOOL_FIELD(isExplicit);
883 WRITE_ENUM_FIELD(coerceformat, CoercionForm);
887 _outConvertRowtypeExpr(StringInfo str, ConvertRowtypeExpr *node)
889 WRITE_NODE_TYPE("CONVERTROWTYPEEXPR");
891 WRITE_NODE_FIELD(arg);
892 WRITE_OID_FIELD(resulttype);
893 WRITE_ENUM_FIELD(convertformat, CoercionForm);
897 _outCaseExpr(StringInfo str, CaseExpr *node)
899 WRITE_NODE_TYPE("CASE");
901 WRITE_OID_FIELD(casetype);
902 WRITE_NODE_FIELD(arg);
903 WRITE_NODE_FIELD(args);
904 WRITE_NODE_FIELD(defresult);
908 _outCaseWhen(StringInfo str, CaseWhen *node)
910 WRITE_NODE_TYPE("WHEN");
912 WRITE_NODE_FIELD(expr);
913 WRITE_NODE_FIELD(result);
917 _outCaseTestExpr(StringInfo str, CaseTestExpr *node)
919 WRITE_NODE_TYPE("CASETESTEXPR");
921 WRITE_OID_FIELD(typeId);
922 WRITE_INT_FIELD(typeMod);
926 _outArrayExpr(StringInfo str, ArrayExpr *node)
928 WRITE_NODE_TYPE("ARRAY");
930 WRITE_OID_FIELD(array_typeid);
931 WRITE_OID_FIELD(element_typeid);
932 WRITE_NODE_FIELD(elements);
933 WRITE_BOOL_FIELD(multidims);
937 _outRowExpr(StringInfo str, RowExpr *node)
939 WRITE_NODE_TYPE("ROW");
941 WRITE_NODE_FIELD(args);
942 WRITE_OID_FIELD(row_typeid);
943 WRITE_ENUM_FIELD(row_format, CoercionForm);
947 _outRowCompareExpr(StringInfo str, RowCompareExpr *node)
949 WRITE_NODE_TYPE("ROWCOMPARE");
951 WRITE_ENUM_FIELD(rctype, RowCompareType);
952 WRITE_NODE_FIELD(opnos);
953 WRITE_NODE_FIELD(opfamilies);
954 WRITE_NODE_FIELD(largs);
955 WRITE_NODE_FIELD(rargs);
959 _outCoalesceExpr(StringInfo str, CoalesceExpr *node)
961 WRITE_NODE_TYPE("COALESCE");
963 WRITE_OID_FIELD(coalescetype);
964 WRITE_NODE_FIELD(args);
968 _outMinMaxExpr(StringInfo str, MinMaxExpr *node)
970 WRITE_NODE_TYPE("MINMAX");
972 WRITE_OID_FIELD(minmaxtype);
973 WRITE_ENUM_FIELD(op, MinMaxOp);
974 WRITE_NODE_FIELD(args);
978 _outXmlExpr(StringInfo str, XmlExpr *node)
980 WRITE_NODE_TYPE("XMLEXPR");
982 WRITE_ENUM_FIELD(op, XmlExprOp);
983 WRITE_STRING_FIELD(name);
984 WRITE_NODE_FIELD(named_args);
985 WRITE_NODE_FIELD(arg_names);
986 WRITE_NODE_FIELD(args);
987 WRITE_ENUM_FIELD(xmloption, XmlOptionType);
988 WRITE_OID_FIELD(type);
989 WRITE_INT_FIELD(typmod);
993 _outNullIfExpr(StringInfo str, NullIfExpr *node)
995 WRITE_NODE_TYPE("NULLIFEXPR");
997 WRITE_OID_FIELD(opno);
998 WRITE_OID_FIELD(opfuncid);
999 WRITE_OID_FIELD(opresulttype);
1000 WRITE_BOOL_FIELD(opretset);
1001 WRITE_NODE_FIELD(args);
1005 _outNullTest(StringInfo str, NullTest *node)
1007 WRITE_NODE_TYPE("NULLTEST");
1009 WRITE_NODE_FIELD(arg);
1010 WRITE_ENUM_FIELD(nulltesttype, NullTestType);
1014 _outBooleanTest(StringInfo str, BooleanTest *node)
1016 WRITE_NODE_TYPE("BOOLEANTEST");
1018 WRITE_NODE_FIELD(arg);
1019 WRITE_ENUM_FIELD(booltesttype, BoolTestType);
1023 _outCoerceToDomain(StringInfo str, CoerceToDomain *node)
1025 WRITE_NODE_TYPE("COERCETODOMAIN");
1027 WRITE_NODE_FIELD(arg);
1028 WRITE_OID_FIELD(resulttype);
1029 WRITE_INT_FIELD(resulttypmod);
1030 WRITE_ENUM_FIELD(coercionformat, CoercionForm);
1034 _outCoerceToDomainValue(StringInfo str, CoerceToDomainValue *node)
1036 WRITE_NODE_TYPE("COERCETODOMAINVALUE");
1038 WRITE_OID_FIELD(typeId);
1039 WRITE_INT_FIELD(typeMod);
1043 _outSetToDefault(StringInfo str, SetToDefault *node)
1045 WRITE_NODE_TYPE("SETTODEFAULT");
1047 WRITE_OID_FIELD(typeId);
1048 WRITE_INT_FIELD(typeMod);
1052 _outTargetEntry(StringInfo str, TargetEntry *node)
1054 WRITE_NODE_TYPE("TARGETENTRY");
1056 WRITE_NODE_FIELD(expr);
1057 WRITE_INT_FIELD(resno);
1058 WRITE_STRING_FIELD(resname);
1059 WRITE_UINT_FIELD(ressortgroupref);
1060 WRITE_OID_FIELD(resorigtbl);
1061 WRITE_INT_FIELD(resorigcol);
1062 WRITE_BOOL_FIELD(resjunk);
1066 _outRangeTblRef(StringInfo str, RangeTblRef *node)
1068 WRITE_NODE_TYPE("RANGETBLREF");
1070 WRITE_INT_FIELD(rtindex);
1074 _outJoinExpr(StringInfo str, JoinExpr *node)
1076 WRITE_NODE_TYPE("JOINEXPR");
1078 WRITE_ENUM_FIELD(jointype, JoinType);
1079 WRITE_BOOL_FIELD(isNatural);
1080 WRITE_NODE_FIELD(larg);
1081 WRITE_NODE_FIELD(rarg);
1082 WRITE_NODE_FIELD(using);
1083 WRITE_NODE_FIELD(quals);
1084 WRITE_NODE_FIELD(alias);
1085 WRITE_INT_FIELD(rtindex);
1089 _outFromExpr(StringInfo str, FromExpr *node)
1091 WRITE_NODE_TYPE("FROMEXPR");
1093 WRITE_NODE_FIELD(fromlist);
1094 WRITE_NODE_FIELD(quals);
1097 /*****************************************************************************
1099 * Stuff from relation.h.
1101 *****************************************************************************/
1104 * print the basic stuff of all nodes that inherit from Path
1106 * Note we do NOT print the parent, else we'd be in infinite recursion
1109 _outPathInfo(StringInfo str, Path *node)
1111 WRITE_ENUM_FIELD(pathtype, NodeTag);
1112 WRITE_FLOAT_FIELD(startup_cost, "%.2f");
1113 WRITE_FLOAT_FIELD(total_cost, "%.2f");
1114 WRITE_NODE_FIELD(pathkeys);
1118 * print the basic stuff of all nodes that inherit from JoinPath
1121 _outJoinPathInfo(StringInfo str, JoinPath *node)
1123 _outPathInfo(str, (Path *) node);
1125 WRITE_ENUM_FIELD(jointype, JoinType);
1126 WRITE_NODE_FIELD(outerjoinpath);
1127 WRITE_NODE_FIELD(innerjoinpath);
1128 WRITE_NODE_FIELD(joinrestrictinfo);
1132 _outPath(StringInfo str, Path *node)
1134 WRITE_NODE_TYPE("PATH");
1136 _outPathInfo(str, (Path *) node);
1140 _outIndexPath(StringInfo str, IndexPath *node)
1142 WRITE_NODE_TYPE("INDEXPATH");
1144 _outPathInfo(str, (Path *) node);
1146 WRITE_NODE_FIELD(indexinfo);
1147 WRITE_NODE_FIELD(indexclauses);
1148 WRITE_NODE_FIELD(indexquals);
1149 WRITE_BOOL_FIELD(isjoininner);
1150 WRITE_ENUM_FIELD(indexscandir, ScanDirection);
1151 WRITE_FLOAT_FIELD(indextotalcost, "%.2f");
1152 WRITE_FLOAT_FIELD(indexselectivity, "%.4f");
1153 WRITE_FLOAT_FIELD(rows, "%.0f");
1157 _outBitmapHeapPath(StringInfo str, BitmapHeapPath *node)
1159 WRITE_NODE_TYPE("BITMAPHEAPPATH");
1161 _outPathInfo(str, (Path *) node);
1163 WRITE_NODE_FIELD(bitmapqual);
1164 WRITE_BOOL_FIELD(isjoininner);
1165 WRITE_FLOAT_FIELD(rows, "%.0f");
1169 _outBitmapAndPath(StringInfo str, BitmapAndPath *node)
1171 WRITE_NODE_TYPE("BITMAPANDPATH");
1173 _outPathInfo(str, (Path *) node);
1175 WRITE_NODE_FIELD(bitmapquals);
1176 WRITE_FLOAT_FIELD(bitmapselectivity, "%.4f");
1180 _outBitmapOrPath(StringInfo str, BitmapOrPath *node)
1182 WRITE_NODE_TYPE("BITMAPORPATH");
1184 _outPathInfo(str, (Path *) node);
1186 WRITE_NODE_FIELD(bitmapquals);
1187 WRITE_FLOAT_FIELD(bitmapselectivity, "%.4f");
1191 _outTidPath(StringInfo str, TidPath *node)
1193 WRITE_NODE_TYPE("TIDPATH");
1195 _outPathInfo(str, (Path *) node);
1197 WRITE_NODE_FIELD(tidquals);
1201 _outAppendPath(StringInfo str, AppendPath *node)
1203 WRITE_NODE_TYPE("APPENDPATH");
1205 _outPathInfo(str, (Path *) node);
1207 WRITE_NODE_FIELD(subpaths);
1211 _outResultPath(StringInfo str, ResultPath *node)
1213 WRITE_NODE_TYPE("RESULTPATH");
1215 _outPathInfo(str, (Path *) node);
1217 WRITE_NODE_FIELD(quals);
1221 _outMaterialPath(StringInfo str, MaterialPath *node)
1223 WRITE_NODE_TYPE("MATERIALPATH");
1225 _outPathInfo(str, (Path *) node);
1227 WRITE_NODE_FIELD(subpath);
1231 _outUniquePath(StringInfo str, UniquePath *node)
1233 WRITE_NODE_TYPE("UNIQUEPATH");
1235 _outPathInfo(str, (Path *) node);
1237 WRITE_NODE_FIELD(subpath);
1238 WRITE_ENUM_FIELD(umethod, UniquePathMethod);
1239 WRITE_FLOAT_FIELD(rows, "%.0f");
1243 _outNestPath(StringInfo str, NestPath *node)
1245 WRITE_NODE_TYPE("NESTPATH");
1247 _outJoinPathInfo(str, (JoinPath *) node);
1251 _outMergePath(StringInfo str, MergePath *node)
1253 WRITE_NODE_TYPE("MERGEPATH");
1255 _outJoinPathInfo(str, (JoinPath *) node);
1257 WRITE_NODE_FIELD(path_mergeclauses);
1258 WRITE_NODE_FIELD(outersortkeys);
1259 WRITE_NODE_FIELD(innersortkeys);
1263 _outHashPath(StringInfo str, HashPath *node)
1265 WRITE_NODE_TYPE("HASHPATH");
1267 _outJoinPathInfo(str, (JoinPath *) node);
1269 WRITE_NODE_FIELD(path_hashclauses);
1273 _outPlannerGlobal(StringInfo str, PlannerGlobal *node)
1275 WRITE_NODE_TYPE("PLANNERGLOBAL");
1277 /* NB: this isn't a complete set of fields */
1278 WRITE_NODE_FIELD(paramlist);
1279 WRITE_NODE_FIELD(subplans);
1280 WRITE_NODE_FIELD(subrtables);
1281 WRITE_BITMAPSET_FIELD(rewindPlanIDs);
1282 WRITE_NODE_FIELD(finalrtable);
1286 _outPlannerInfo(StringInfo str, PlannerInfo *node)
1288 WRITE_NODE_TYPE("PLANNERINFO");
1290 /* NB: this isn't a complete set of fields */
1291 WRITE_NODE_FIELD(parse);
1292 WRITE_NODE_FIELD(glob);
1293 WRITE_UINT_FIELD(query_level);
1294 WRITE_NODE_FIELD(join_rel_list);
1295 WRITE_NODE_FIELD(resultRelations);
1296 WRITE_NODE_FIELD(returningLists);
1297 WRITE_NODE_FIELD(init_plans);
1298 WRITE_NODE_FIELD(eq_classes);
1299 WRITE_NODE_FIELD(canon_pathkeys);
1300 WRITE_NODE_FIELD(left_join_clauses);
1301 WRITE_NODE_FIELD(right_join_clauses);
1302 WRITE_NODE_FIELD(full_join_clauses);
1303 WRITE_NODE_FIELD(oj_info_list);
1304 WRITE_NODE_FIELD(in_info_list);
1305 WRITE_NODE_FIELD(append_rel_list);
1306 WRITE_NODE_FIELD(query_pathkeys);
1307 WRITE_NODE_FIELD(group_pathkeys);
1308 WRITE_NODE_FIELD(sort_pathkeys);
1309 WRITE_FLOAT_FIELD(total_table_pages, "%.0f");
1310 WRITE_FLOAT_FIELD(tuple_fraction, "%.4f");
1311 WRITE_BOOL_FIELD(hasJoinRTEs);
1312 WRITE_BOOL_FIELD(hasOuterJoins);
1313 WRITE_BOOL_FIELD(hasHavingQual);
1314 WRITE_BOOL_FIELD(hasPseudoConstantQuals);
1318 _outRelOptInfo(StringInfo str, RelOptInfo *node)
1320 WRITE_NODE_TYPE("RELOPTINFO");
1322 /* NB: this isn't a complete set of fields */
1323 WRITE_ENUM_FIELD(reloptkind, RelOptKind);
1324 WRITE_BITMAPSET_FIELD(relids);
1325 WRITE_FLOAT_FIELD(rows, "%.0f");
1326 WRITE_INT_FIELD(width);
1327 WRITE_NODE_FIELD(reltargetlist);
1328 WRITE_NODE_FIELD(pathlist);
1329 WRITE_NODE_FIELD(cheapest_startup_path);
1330 WRITE_NODE_FIELD(cheapest_total_path);
1331 WRITE_NODE_FIELD(cheapest_unique_path);
1332 WRITE_UINT_FIELD(relid);
1333 WRITE_ENUM_FIELD(rtekind, RTEKind);
1334 WRITE_INT_FIELD(min_attr);
1335 WRITE_INT_FIELD(max_attr);
1336 WRITE_NODE_FIELD(indexlist);
1337 WRITE_UINT_FIELD(pages);
1338 WRITE_FLOAT_FIELD(tuples, "%.0f");
1339 WRITE_NODE_FIELD(subplan);
1340 WRITE_NODE_FIELD(subrtable);
1341 WRITE_NODE_FIELD(baserestrictinfo);
1342 WRITE_NODE_FIELD(joininfo);
1343 WRITE_BOOL_FIELD(has_eclass_joins);
1344 WRITE_BITMAPSET_FIELD(index_outer_relids);
1345 WRITE_NODE_FIELD(index_inner_paths);
1349 _outIndexOptInfo(StringInfo str, IndexOptInfo *node)
1351 WRITE_NODE_TYPE("INDEXOPTINFO");
1353 /* NB: this isn't a complete set of fields */
1354 WRITE_OID_FIELD(indexoid);
1355 /* Do NOT print rel field, else infinite recursion */
1356 WRITE_UINT_FIELD(pages);
1357 WRITE_FLOAT_FIELD(tuples, "%.0f");
1358 WRITE_INT_FIELD(ncolumns);
1359 WRITE_NODE_FIELD(indexprs);
1360 WRITE_NODE_FIELD(indpred);
1361 WRITE_BOOL_FIELD(predOK);
1362 WRITE_BOOL_FIELD(unique);
1366 _outEquivalenceClass(StringInfo str, EquivalenceClass *node)
1369 * To simplify reading, we just chase up to the topmost merged EC and
1370 * print that, without bothering to show the merge-ees separately.
1372 while (node->ec_merged)
1373 node = node->ec_merged;
1375 WRITE_NODE_TYPE("EQUIVALENCECLASS");
1377 WRITE_NODE_FIELD(ec_opfamilies);
1378 WRITE_NODE_FIELD(ec_members);
1379 WRITE_NODE_FIELD(ec_sources);
1380 WRITE_NODE_FIELD(ec_derives);
1381 WRITE_BITMAPSET_FIELD(ec_relids);
1382 WRITE_BOOL_FIELD(ec_has_const);
1383 WRITE_BOOL_FIELD(ec_has_volatile);
1384 WRITE_BOOL_FIELD(ec_below_outer_join);
1385 WRITE_BOOL_FIELD(ec_broken);
1389 _outEquivalenceMember(StringInfo str, EquivalenceMember *node)
1391 WRITE_NODE_TYPE("EQUIVALENCEMEMBER");
1393 WRITE_NODE_FIELD(em_expr);
1394 WRITE_BITMAPSET_FIELD(em_relids);
1395 WRITE_BOOL_FIELD(em_is_const);
1396 WRITE_BOOL_FIELD(em_is_child);
1397 WRITE_OID_FIELD(em_datatype);
1401 _outPathKey(StringInfo str, PathKey *node)
1403 WRITE_NODE_TYPE("PATHKEY");
1405 WRITE_NODE_FIELD(pk_eclass);
1406 WRITE_OID_FIELD(pk_opfamily);
1407 WRITE_INT_FIELD(pk_strategy);
1408 WRITE_BOOL_FIELD(pk_nulls_first);
1412 _outRestrictInfo(StringInfo str, RestrictInfo *node)
1414 WRITE_NODE_TYPE("RESTRICTINFO");
1416 /* NB: this isn't a complete set of fields */
1417 WRITE_NODE_FIELD(clause);
1418 WRITE_BOOL_FIELD(is_pushed_down);
1419 WRITE_BOOL_FIELD(outerjoin_delayed);
1420 WRITE_BOOL_FIELD(can_join);
1421 WRITE_BOOL_FIELD(pseudoconstant);
1422 WRITE_BITMAPSET_FIELD(clause_relids);
1423 WRITE_BITMAPSET_FIELD(required_relids);
1424 WRITE_BITMAPSET_FIELD(left_relids);
1425 WRITE_BITMAPSET_FIELD(right_relids);
1426 WRITE_NODE_FIELD(orclause);
1427 /* don't write parent_ec, leads to infinite recursion in plan tree dump */
1428 WRITE_NODE_FIELD(mergeopfamilies);
1429 /* don't write left_ec, leads to infinite recursion in plan tree dump */
1430 /* don't write right_ec, leads to infinite recursion in plan tree dump */
1431 WRITE_NODE_FIELD(left_em);
1432 WRITE_NODE_FIELD(right_em);
1433 WRITE_BOOL_FIELD(outer_is_left);
1434 WRITE_OID_FIELD(hashjoinoperator);
1438 _outInnerIndexscanInfo(StringInfo str, InnerIndexscanInfo *node)
1440 WRITE_NODE_TYPE("INNERINDEXSCANINFO");
1441 WRITE_BITMAPSET_FIELD(other_relids);
1442 WRITE_BOOL_FIELD(isouterjoin);
1443 WRITE_NODE_FIELD(best_innerpath);
1447 _outOuterJoinInfo(StringInfo str, OuterJoinInfo *node)
1449 WRITE_NODE_TYPE("OUTERJOININFO");
1451 WRITE_BITMAPSET_FIELD(min_lefthand);
1452 WRITE_BITMAPSET_FIELD(min_righthand);
1453 WRITE_BOOL_FIELD(is_full_join);
1454 WRITE_BOOL_FIELD(lhs_strict);
1458 _outInClauseInfo(StringInfo str, InClauseInfo *node)
1460 WRITE_NODE_TYPE("INCLAUSEINFO");
1462 WRITE_BITMAPSET_FIELD(lefthand);
1463 WRITE_BITMAPSET_FIELD(righthand);
1464 WRITE_NODE_FIELD(sub_targetlist);
1465 WRITE_NODE_FIELD(in_operators);
1469 _outAppendRelInfo(StringInfo str, AppendRelInfo *node)
1471 WRITE_NODE_TYPE("APPENDRELINFO");
1473 WRITE_UINT_FIELD(parent_relid);
1474 WRITE_UINT_FIELD(child_relid);
1475 WRITE_OID_FIELD(parent_reltype);
1476 WRITE_OID_FIELD(child_reltype);
1477 WRITE_NODE_FIELD(col_mappings);
1478 WRITE_NODE_FIELD(translated_vars);
1479 WRITE_OID_FIELD(parent_reloid);
1483 _outPlannerParamItem(StringInfo str, PlannerParamItem *node)
1485 WRITE_NODE_TYPE("PLANNERPARAMITEM");
1487 WRITE_NODE_FIELD(item);
1488 WRITE_UINT_FIELD(abslevel);
1491 /*****************************************************************************
1493 * Stuff from parsenodes.h.
1495 *****************************************************************************/
1498 _outCreateStmt(StringInfo str, CreateStmt *node)
1500 WRITE_NODE_TYPE("CREATESTMT");
1502 WRITE_NODE_FIELD(relation);
1503 WRITE_NODE_FIELD(tableElts);
1504 WRITE_NODE_FIELD(inhRelations);
1505 WRITE_NODE_FIELD(constraints);
1506 WRITE_NODE_FIELD(options);
1507 WRITE_ENUM_FIELD(oncommit, OnCommitAction);
1508 WRITE_STRING_FIELD(tablespacename);
1512 _outIndexStmt(StringInfo str, IndexStmt *node)
1514 WRITE_NODE_TYPE("INDEXSTMT");
1516 WRITE_STRING_FIELD(idxname);
1517 WRITE_NODE_FIELD(relation);
1518 WRITE_STRING_FIELD(accessMethod);
1519 WRITE_STRING_FIELD(tableSpace);
1520 WRITE_NODE_FIELD(indexParams);
1521 WRITE_NODE_FIELD(options);
1522 WRITE_NODE_FIELD(whereClause);
1523 WRITE_BOOL_FIELD(unique);
1524 WRITE_BOOL_FIELD(primary);
1525 WRITE_BOOL_FIELD(isconstraint);
1526 WRITE_BOOL_FIELD(concurrent);
1530 _outNotifyStmt(StringInfo str, NotifyStmt *node)
1532 WRITE_NODE_TYPE("NOTIFY");
1534 WRITE_NODE_FIELD(relation);
1538 _outDeclareCursorStmt(StringInfo str, DeclareCursorStmt *node)
1540 WRITE_NODE_TYPE("DECLARECURSOR");
1542 WRITE_STRING_FIELD(portalname);
1543 WRITE_INT_FIELD(options);
1544 WRITE_NODE_FIELD(query);
1548 _outSelectStmt(StringInfo str, SelectStmt *node)
1550 WRITE_NODE_TYPE("SELECT");
1552 WRITE_NODE_FIELD(distinctClause);
1553 WRITE_NODE_FIELD(intoClause);
1554 WRITE_NODE_FIELD(targetList);
1555 WRITE_NODE_FIELD(fromClause);
1556 WRITE_NODE_FIELD(whereClause);
1557 WRITE_NODE_FIELD(groupClause);
1558 WRITE_NODE_FIELD(havingClause);
1559 WRITE_NODE_FIELD(valuesLists);
1560 WRITE_NODE_FIELD(sortClause);
1561 WRITE_NODE_FIELD(limitOffset);
1562 WRITE_NODE_FIELD(limitCount);
1563 WRITE_NODE_FIELD(lockingClause);
1564 WRITE_ENUM_FIELD(op, SetOperation);
1565 WRITE_BOOL_FIELD(all);
1566 WRITE_NODE_FIELD(larg);
1567 WRITE_NODE_FIELD(rarg);
1571 _outFuncCall(StringInfo str, FuncCall *node)
1573 WRITE_NODE_TYPE("FUNCCALL");
1575 WRITE_NODE_FIELD(funcname);
1576 WRITE_NODE_FIELD(args);
1577 WRITE_BOOL_FIELD(agg_star);
1578 WRITE_BOOL_FIELD(agg_distinct);
1579 WRITE_INT_FIELD(location);
1583 _outDefElem(StringInfo str, DefElem *node)
1585 WRITE_NODE_TYPE("DEFELEM");
1587 WRITE_STRING_FIELD(defname);
1588 WRITE_NODE_FIELD(arg);
1592 _outLockingClause(StringInfo str, LockingClause *node)
1594 WRITE_NODE_TYPE("LOCKINGCLAUSE");
1596 WRITE_NODE_FIELD(lockedRels);
1597 WRITE_BOOL_FIELD(forUpdate);
1598 WRITE_BOOL_FIELD(noWait);
1602 _outXmlSerialize(StringInfo str, XmlSerialize *node)
1604 WRITE_NODE_TYPE("XMLSERIALIZE");
1606 WRITE_ENUM_FIELD(xmloption, XmlOptionType);
1607 WRITE_NODE_FIELD(expr);
1608 WRITE_NODE_FIELD(typename);
1612 _outColumnDef(StringInfo str, ColumnDef *node)
1614 WRITE_NODE_TYPE("COLUMNDEF");
1616 WRITE_STRING_FIELD(colname);
1617 WRITE_NODE_FIELD(typename);
1618 WRITE_INT_FIELD(inhcount);
1619 WRITE_BOOL_FIELD(is_local);
1620 WRITE_BOOL_FIELD(is_not_null);
1621 WRITE_NODE_FIELD(raw_default);
1622 WRITE_STRING_FIELD(cooked_default);
1623 WRITE_NODE_FIELD(constraints);
1627 _outTypeName(StringInfo str, TypeName *node)
1629 WRITE_NODE_TYPE("TYPENAME");
1631 WRITE_NODE_FIELD(names);
1632 WRITE_OID_FIELD(typeid);
1633 WRITE_BOOL_FIELD(timezone);
1634 WRITE_BOOL_FIELD(setof);
1635 WRITE_BOOL_FIELD(pct_type);
1636 WRITE_NODE_FIELD(typmods);
1637 WRITE_INT_FIELD(typemod);
1638 WRITE_NODE_FIELD(arrayBounds);
1639 WRITE_INT_FIELD(location);
1643 _outTypeCast(StringInfo str, TypeCast *node)
1645 WRITE_NODE_TYPE("TYPECAST");
1647 WRITE_NODE_FIELD(arg);
1648 WRITE_NODE_FIELD(typename);
1652 _outIndexElem(StringInfo str, IndexElem *node)
1654 WRITE_NODE_TYPE("INDEXELEM");
1656 WRITE_STRING_FIELD(name);
1657 WRITE_NODE_FIELD(expr);
1658 WRITE_NODE_FIELD(opclass);
1659 WRITE_ENUM_FIELD(ordering, SortByDir);
1660 WRITE_ENUM_FIELD(nulls_ordering, SortByNulls);
1664 _outQuery(StringInfo str, Query *node)
1666 WRITE_NODE_TYPE("QUERY");
1668 WRITE_ENUM_FIELD(commandType, CmdType);
1669 WRITE_ENUM_FIELD(querySource, QuerySource);
1670 WRITE_BOOL_FIELD(canSetTag);
1673 * Hack to work around missing outfuncs routines for a lot of the
1674 * utility-statement node types. (The only one we actually *need* for
1675 * rules support is NotifyStmt.) Someday we ought to support 'em all, but
1676 * for the meantime do this to avoid getting lots of warnings when running
1677 * with debug_print_parse on.
1679 if (node->utilityStmt)
1681 switch (nodeTag(node->utilityStmt))
1686 case T_DeclareCursorStmt:
1687 WRITE_NODE_FIELD(utilityStmt);
1690 appendStringInfo(str, " :utilityStmt ?");
1695 appendStringInfo(str, " :utilityStmt <>");
1697 WRITE_INT_FIELD(resultRelation);
1698 WRITE_NODE_FIELD(intoClause);
1699 WRITE_BOOL_FIELD(hasAggs);
1700 WRITE_BOOL_FIELD(hasSubLinks);
1701 WRITE_NODE_FIELD(rtable);
1702 WRITE_NODE_FIELD(jointree);
1703 WRITE_NODE_FIELD(targetList);
1704 WRITE_NODE_FIELD(returningList);
1705 WRITE_NODE_FIELD(groupClause);
1706 WRITE_NODE_FIELD(havingQual);
1707 WRITE_NODE_FIELD(distinctClause);
1708 WRITE_NODE_FIELD(sortClause);
1709 WRITE_NODE_FIELD(limitOffset);
1710 WRITE_NODE_FIELD(limitCount);
1711 WRITE_NODE_FIELD(rowMarks);
1712 WRITE_NODE_FIELD(setOperations);
1716 _outSortClause(StringInfo str, SortClause *node)
1718 WRITE_NODE_TYPE("SORTCLAUSE");
1720 WRITE_UINT_FIELD(tleSortGroupRef);
1721 WRITE_OID_FIELD(sortop);
1722 WRITE_BOOL_FIELD(nulls_first);
1726 _outGroupClause(StringInfo str, GroupClause *node)
1728 WRITE_NODE_TYPE("GROUPCLAUSE");
1730 WRITE_UINT_FIELD(tleSortGroupRef);
1731 WRITE_OID_FIELD(sortop);
1732 WRITE_BOOL_FIELD(nulls_first);
1736 _outRowMarkClause(StringInfo str, RowMarkClause *node)
1738 WRITE_NODE_TYPE("ROWMARKCLAUSE");
1740 WRITE_UINT_FIELD(rti);
1741 WRITE_BOOL_FIELD(forUpdate);
1742 WRITE_BOOL_FIELD(noWait);
1746 _outSetOperationStmt(StringInfo str, SetOperationStmt *node)
1748 WRITE_NODE_TYPE("SETOPERATIONSTMT");
1750 WRITE_ENUM_FIELD(op, SetOperation);
1751 WRITE_BOOL_FIELD(all);
1752 WRITE_NODE_FIELD(larg);
1753 WRITE_NODE_FIELD(rarg);
1754 WRITE_NODE_FIELD(colTypes);
1755 WRITE_NODE_FIELD(colTypmods);
1759 _outRangeTblEntry(StringInfo str, RangeTblEntry *node)
1761 WRITE_NODE_TYPE("RTE");
1763 /* put alias + eref first to make dump more legible */
1764 WRITE_NODE_FIELD(alias);
1765 WRITE_NODE_FIELD(eref);
1766 WRITE_ENUM_FIELD(rtekind, RTEKind);
1768 switch (node->rtekind)
1772 WRITE_OID_FIELD(relid);
1775 WRITE_NODE_FIELD(subquery);
1778 WRITE_NODE_FIELD(funcexpr);
1779 WRITE_NODE_FIELD(funccoltypes);
1780 WRITE_NODE_FIELD(funccoltypmods);
1783 WRITE_NODE_FIELD(values_lists);
1786 WRITE_ENUM_FIELD(jointype, JoinType);
1787 WRITE_NODE_FIELD(joinaliasvars);
1790 elog(ERROR, "unrecognized RTE kind: %d", (int) node->rtekind);
1794 WRITE_BOOL_FIELD(inh);
1795 WRITE_BOOL_FIELD(inFromCl);
1796 WRITE_UINT_FIELD(requiredPerms);
1797 WRITE_OID_FIELD(checkAsUser);
1801 _outAExpr(StringInfo str, A_Expr *node)
1803 WRITE_NODE_TYPE("AEXPR");
1808 appendStringInfo(str, " ");
1809 WRITE_NODE_FIELD(name);
1812 appendStringInfo(str, " AND");
1815 appendStringInfo(str, " OR");
1818 appendStringInfo(str, " NOT");
1821 appendStringInfo(str, " ");
1822 WRITE_NODE_FIELD(name);
1823 appendStringInfo(str, " ANY ");
1826 appendStringInfo(str, " ");
1827 WRITE_NODE_FIELD(name);
1828 appendStringInfo(str, " ALL ");
1830 case AEXPR_DISTINCT:
1831 appendStringInfo(str, " DISTINCT ");
1832 WRITE_NODE_FIELD(name);
1835 appendStringInfo(str, " NULLIF ");
1836 WRITE_NODE_FIELD(name);
1839 appendStringInfo(str, " OF ");
1840 WRITE_NODE_FIELD(name);
1843 appendStringInfo(str, " IN ");
1844 WRITE_NODE_FIELD(name);
1847 appendStringInfo(str, " ??");
1851 WRITE_NODE_FIELD(lexpr);
1852 WRITE_NODE_FIELD(rexpr);
1853 WRITE_INT_FIELD(location);
1857 _outValue(StringInfo str, Value *value)
1859 switch (value->type)
1862 appendStringInfo(str, "%ld", value->val.ival);
1867 * We assume the value is a valid numeric literal and so does not
1870 appendStringInfoString(str, value->val.str);
1873 appendStringInfoChar(str, '"');
1874 _outToken(str, value->val.str);
1875 appendStringInfoChar(str, '"');
1878 /* internal representation already has leading 'b' */
1879 appendStringInfoString(str, value->val.str);
1882 elog(ERROR, "unrecognized node type: %d", (int) value->type);
1888 _outColumnRef(StringInfo str, ColumnRef *node)
1890 WRITE_NODE_TYPE("COLUMNREF");
1892 WRITE_NODE_FIELD(fields);
1893 WRITE_INT_FIELD(location);
1897 _outParamRef(StringInfo str, ParamRef *node)
1899 WRITE_NODE_TYPE("PARAMREF");
1901 WRITE_INT_FIELD(number);
1905 _outAConst(StringInfo str, A_Const *node)
1907 WRITE_NODE_TYPE("A_CONST");
1909 appendStringInfo(str, " :val ");
1910 _outValue(str, &(node->val));
1911 WRITE_NODE_FIELD(typename);
1915 _outA_Indices(StringInfo str, A_Indices *node)
1917 WRITE_NODE_TYPE("A_INDICES");
1919 WRITE_NODE_FIELD(lidx);
1920 WRITE_NODE_FIELD(uidx);
1924 _outA_Indirection(StringInfo str, A_Indirection *node)
1926 WRITE_NODE_TYPE("A_INDIRECTION");
1928 WRITE_NODE_FIELD(arg);
1929 WRITE_NODE_FIELD(indirection);
1933 _outResTarget(StringInfo str, ResTarget *node)
1935 WRITE_NODE_TYPE("RESTARGET");
1937 WRITE_STRING_FIELD(name);
1938 WRITE_NODE_FIELD(indirection);
1939 WRITE_NODE_FIELD(val);
1940 WRITE_INT_FIELD(location);
1944 _outConstraint(StringInfo str, Constraint *node)
1946 WRITE_NODE_TYPE("CONSTRAINT");
1948 WRITE_STRING_FIELD(name);
1950 appendStringInfo(str, " :contype ");
1951 switch (node->contype)
1953 case CONSTR_PRIMARY:
1954 appendStringInfo(str, "PRIMARY_KEY");
1955 WRITE_NODE_FIELD(keys);
1956 WRITE_NODE_FIELD(options);
1957 WRITE_STRING_FIELD(indexspace);
1961 appendStringInfo(str, "UNIQUE");
1962 WRITE_NODE_FIELD(keys);
1963 WRITE_NODE_FIELD(options);
1964 WRITE_STRING_FIELD(indexspace);
1968 appendStringInfo(str, "CHECK");
1969 WRITE_NODE_FIELD(raw_expr);
1970 WRITE_STRING_FIELD(cooked_expr);
1973 case CONSTR_DEFAULT:
1974 appendStringInfo(str, "DEFAULT");
1975 WRITE_NODE_FIELD(raw_expr);
1976 WRITE_STRING_FIELD(cooked_expr);
1979 case CONSTR_NOTNULL:
1980 appendStringInfo(str, "NOT_NULL");
1984 appendStringInfo(str, "<unrecognized_constraint>");
1990 _outFkConstraint(StringInfo str, FkConstraint *node)
1992 WRITE_NODE_TYPE("FKCONSTRAINT");
1994 WRITE_STRING_FIELD(constr_name);
1995 WRITE_NODE_FIELD(pktable);
1996 WRITE_NODE_FIELD(fk_attrs);
1997 WRITE_NODE_FIELD(pk_attrs);
1998 WRITE_CHAR_FIELD(fk_matchtype);
1999 WRITE_CHAR_FIELD(fk_upd_action);
2000 WRITE_CHAR_FIELD(fk_del_action);
2001 WRITE_BOOL_FIELD(deferrable);
2002 WRITE_BOOL_FIELD(initdeferred);
2003 WRITE_BOOL_FIELD(skip_validation);
2009 * converts a Node into ascii string and append it to 'str'
2012 _outNode(StringInfo str, void *obj)
2015 appendStringInfo(str, "<>");
2016 else if (IsA(obj, List) ||IsA(obj, IntList) || IsA(obj, OidList))
2018 else if (IsA(obj, Integer) ||
2021 IsA(obj, BitString))
2023 /* nodeRead does not want to see { } around these! */
2024 _outValue(str, obj);
2028 appendStringInfoChar(str, '{');
2029 switch (nodeTag(obj))
2032 _outPlannedStmt(str, obj);
2038 _outResult(str, obj);
2041 _outAppend(str, obj);
2044 _outBitmapAnd(str, obj);
2047 _outBitmapOr(str, obj);
2053 _outSeqScan(str, obj);
2056 _outIndexScan(str, obj);
2058 case T_BitmapIndexScan:
2059 _outBitmapIndexScan(str, obj);
2061 case T_BitmapHeapScan:
2062 _outBitmapHeapScan(str, obj);
2065 _outTidScan(str, obj);
2067 case T_SubqueryScan:
2068 _outSubqueryScan(str, obj);
2070 case T_FunctionScan:
2071 _outFunctionScan(str, obj);
2074 _outValuesScan(str, obj);
2080 _outNestLoop(str, obj);
2083 _outMergeJoin(str, obj);
2086 _outHashJoin(str, obj);
2092 _outGroup(str, obj);
2095 _outMaterial(str, obj);
2101 _outUnique(str, obj);
2104 _outSetOp(str, obj);
2107 _outLimit(str, obj);
2113 _outAlias(str, obj);
2116 _outRangeVar(str, obj);
2119 _outIntoClause(str, obj);
2125 _outConst(str, obj);
2128 _outParam(str, obj);
2131 _outAggref(str, obj);
2134 _outArrayRef(str, obj);
2137 _outFuncExpr(str, obj);
2140 _outOpExpr(str, obj);
2142 case T_DistinctExpr:
2143 _outDistinctExpr(str, obj);
2145 case T_ScalarArrayOpExpr:
2146 _outScalarArrayOpExpr(str, obj);
2149 _outBoolExpr(str, obj);
2152 _outSubLink(str, obj);
2155 _outSubPlan(str, obj);
2158 _outFieldSelect(str, obj);
2161 _outFieldStore(str, obj);
2164 _outRelabelType(str, obj);
2166 case T_ArrayCoerceExpr:
2167 _outArrayCoerceExpr(str, obj);
2169 case T_ConvertRowtypeExpr:
2170 _outConvertRowtypeExpr(str, obj);
2173 _outCaseExpr(str, obj);
2176 _outCaseWhen(str, obj);
2178 case T_CaseTestExpr:
2179 _outCaseTestExpr(str, obj);
2182 _outArrayExpr(str, obj);
2185 _outRowExpr(str, obj);
2187 case T_RowCompareExpr:
2188 _outRowCompareExpr(str, obj);
2190 case T_CoalesceExpr:
2191 _outCoalesceExpr(str, obj);
2194 _outMinMaxExpr(str, obj);
2197 _outXmlExpr(str, obj);
2200 _outNullIfExpr(str, obj);
2203 _outNullTest(str, obj);
2206 _outBooleanTest(str, obj);
2208 case T_CoerceToDomain:
2209 _outCoerceToDomain(str, obj);
2211 case T_CoerceToDomainValue:
2212 _outCoerceToDomainValue(str, obj);
2214 case T_SetToDefault:
2215 _outSetToDefault(str, obj);
2218 _outTargetEntry(str, obj);
2221 _outRangeTblRef(str, obj);
2224 _outJoinExpr(str, obj);
2227 _outFromExpr(str, obj);
2234 _outIndexPath(str, obj);
2236 case T_BitmapHeapPath:
2237 _outBitmapHeapPath(str, obj);
2239 case T_BitmapAndPath:
2240 _outBitmapAndPath(str, obj);
2242 case T_BitmapOrPath:
2243 _outBitmapOrPath(str, obj);
2246 _outTidPath(str, obj);
2249 _outAppendPath(str, obj);
2252 _outResultPath(str, obj);
2254 case T_MaterialPath:
2255 _outMaterialPath(str, obj);
2258 _outUniquePath(str, obj);
2261 _outNestPath(str, obj);
2264 _outMergePath(str, obj);
2267 _outHashPath(str, obj);
2269 case T_PlannerGlobal:
2270 _outPlannerGlobal(str, obj);
2273 _outPlannerInfo(str, obj);
2276 _outRelOptInfo(str, obj);
2278 case T_IndexOptInfo:
2279 _outIndexOptInfo(str, obj);
2281 case T_EquivalenceClass:
2282 _outEquivalenceClass(str, obj);
2284 case T_EquivalenceMember:
2285 _outEquivalenceMember(str, obj);
2288 _outPathKey(str, obj);
2290 case T_RestrictInfo:
2291 _outRestrictInfo(str, obj);
2293 case T_InnerIndexscanInfo:
2294 _outInnerIndexscanInfo(str, obj);
2296 case T_OuterJoinInfo:
2297 _outOuterJoinInfo(str, obj);
2299 case T_InClauseInfo:
2300 _outInClauseInfo(str, obj);
2302 case T_AppendRelInfo:
2303 _outAppendRelInfo(str, obj);
2305 case T_PlannerParamItem:
2306 _outPlannerParamItem(str, obj);
2310 _outCreateStmt(str, obj);
2313 _outIndexStmt(str, obj);
2316 _outNotifyStmt(str, obj);
2318 case T_DeclareCursorStmt:
2319 _outDeclareCursorStmt(str, obj);
2322 _outSelectStmt(str, obj);
2325 _outColumnDef(str, obj);
2328 _outTypeName(str, obj);
2331 _outTypeCast(str, obj);
2334 _outIndexElem(str, obj);
2337 _outQuery(str, obj);
2340 _outSortClause(str, obj);
2343 _outGroupClause(str, obj);
2345 case T_RowMarkClause:
2346 _outRowMarkClause(str, obj);
2348 case T_SetOperationStmt:
2349 _outSetOperationStmt(str, obj);
2351 case T_RangeTblEntry:
2352 _outRangeTblEntry(str, obj);
2355 _outAExpr(str, obj);
2358 _outColumnRef(str, obj);
2361 _outParamRef(str, obj);
2364 _outAConst(str, obj);
2367 _outA_Indices(str, obj);
2369 case T_A_Indirection:
2370 _outA_Indirection(str, obj);
2373 _outResTarget(str, obj);
2376 _outConstraint(str, obj);
2378 case T_FkConstraint:
2379 _outFkConstraint(str, obj);
2382 _outFuncCall(str, obj);
2385 _outDefElem(str, obj);
2387 case T_LockingClause:
2388 _outLockingClause(str, obj);
2390 case T_XmlSerialize:
2391 _outXmlSerialize(str, obj);
2397 * This should be an ERROR, but it's too useful to be able to
2398 * dump structures that _outNode only understands part of.
2400 elog(WARNING, "could not dump unrecognized node type: %d",
2401 (int) nodeTag(obj));
2404 appendStringInfoChar(str, '}');
2410 * returns the ascii representation of the Node as a palloc'd string
2413 nodeToString(void *obj)
2417 /* see stringinfo.h for an explanation of this maneuver */
2418 initStringInfo(&str);
2419 _outNode(&str, obj);