1 /*-------------------------------------------------------------------------
4 * Output functions for Postgres tree nodes.
6 * Portions Copyright (c) 1996-2003, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
11 * $Header: /cvsroot/pgsql/src/backend/nodes/outfuncs.c,v 1.220 2003/11/12 21:15:52 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/parsenodes.h"
28 #include "nodes/plannodes.h"
29 #include "nodes/relation.h"
30 #include "utils/datum.h"
34 * Macros to simplify output of different kinds of fields. Use these
35 * wherever possible to reduce the chance for silly typos. Note that these
36 * hard-wire conventions about the names of the local variables in an Out
40 /* Write the label for the node type */
41 #define WRITE_NODE_TYPE(nodelabel) \
42 appendStringInfoString(str, nodelabel)
44 /* Write an integer field (anything written as ":fldname %d") */
45 #define WRITE_INT_FIELD(fldname) \
46 appendStringInfo(str, " :" CppAsString(fldname) " %d", node->fldname)
48 /* Write an unsigned integer field (anything written as ":fldname %u") */
49 #define WRITE_UINT_FIELD(fldname) \
50 appendStringInfo(str, " :" CppAsString(fldname) " %u", node->fldname)
52 /* Write an OID field (don't hard-wire assumption that OID is same as uint) */
53 #define WRITE_OID_FIELD(fldname) \
54 appendStringInfo(str, " :" CppAsString(fldname) " %u", node->fldname)
56 /* Write a long-integer field */
57 #define WRITE_LONG_FIELD(fldname) \
58 appendStringInfo(str, " :" CppAsString(fldname) " %ld", node->fldname)
60 /* Write a char field (ie, one ascii character) */
61 #define WRITE_CHAR_FIELD(fldname) \
62 appendStringInfo(str, " :" CppAsString(fldname) " %c", node->fldname)
64 /* Write an enumerated-type field as an integer code */
65 #define WRITE_ENUM_FIELD(fldname, enumtype) \
66 appendStringInfo(str, " :" CppAsString(fldname) " %d", \
69 /* Write a float field --- caller must give format to define precision */
70 #define WRITE_FLOAT_FIELD(fldname,format) \
71 appendStringInfo(str, " :" CppAsString(fldname) " " format, node->fldname)
73 /* Write a boolean field */
74 #define WRITE_BOOL_FIELD(fldname) \
75 appendStringInfo(str, " :" CppAsString(fldname) " %s", \
76 booltostr(node->fldname))
78 /* Write a character-string (possibly NULL) field */
79 #define WRITE_STRING_FIELD(fldname) \
80 (appendStringInfo(str, " :" CppAsString(fldname) " "), \
81 _outToken(str, node->fldname))
83 /* Write a Node field */
84 #define WRITE_NODE_FIELD(fldname) \
85 (appendStringInfo(str, " :" CppAsString(fldname) " "), \
86 _outNode(str, node->fldname))
88 /* Write an integer-list field */
89 #define WRITE_INTLIST_FIELD(fldname) \
90 (appendStringInfo(str, " :" CppAsString(fldname) " "), \
91 _outIntList(str, node->fldname))
93 /* Write an OID-list field */
94 #define WRITE_OIDLIST_FIELD(fldname) \
95 (appendStringInfo(str, " :" CppAsString(fldname) " "), \
96 _outOidList(str, node->fldname))
98 /* Write a bitmapset field */
99 #define WRITE_BITMAPSET_FIELD(fldname) \
100 (appendStringInfo(str, " :" CppAsString(fldname) " "), \
101 _outBitmapset(str, node->fldname))
104 #define booltostr(x) ((x) ? "true" : "false")
106 static void _outNode(StringInfo str, void *obj);
111 * Convert an ordinary string (eg, an identifier) into a form that
112 * will be decoded back to a plain token by read.c's functions.
114 * If a null or empty string is given, it is encoded as "<>".
117 _outToken(StringInfo str, char *s)
119 if (s == NULL || *s == '\0')
121 appendStringInfo(str, "<>");
126 * Look for characters or patterns that are treated specially by
127 * read.c (either in pg_strtok() or in nodeRead()), and therefore need
128 * a protective backslash.
130 /* These characters only need to be quoted at the start of the string */
134 isdigit((unsigned char) *s) ||
135 ((*s == '+' || *s == '-') &&
136 (isdigit((unsigned char) s[1]) || s[1] == '.')))
137 appendStringInfoChar(str, '\\');
140 /* These chars must be backslashed anywhere in the string */
141 if (*s == ' ' || *s == '\n' || *s == '\t' ||
142 *s == '(' || *s == ')' || *s == '{' || *s == '}' ||
144 appendStringInfoChar(str, '\\');
145 appendStringInfoChar(str, *s++);
151 * converts a List of integers
154 _outIntList(StringInfo str, List *list)
158 appendStringInfoChar(str, '(');
160 appendStringInfo(str, " %d", lfirsti(l));
161 appendStringInfoChar(str, ')');
166 * converts a List of OIDs
169 _outOidList(StringInfo str, List *list)
173 appendStringInfoChar(str, '(');
175 appendStringInfo(str, " %u", lfirsto(l));
176 appendStringInfoChar(str, ')');
181 * converts a bitmap set of integers
183 * Note: for historical reasons, the output is formatted exactly like
184 * an integer List would be.
187 _outBitmapset(StringInfo str, Bitmapset *bms)
192 appendStringInfoChar(str, '(');
193 tmpset = bms_copy(bms);
194 while ((x = bms_first_member(tmpset)) >= 0)
195 appendStringInfo(str, " %d", x);
197 appendStringInfoChar(str, ')');
201 * Print the value of a Datum given its type.
204 _outDatum(StringInfo str, Datum value, int typlen, bool typbyval)
210 length = datumGetSize(value, typbyval, typlen);
214 s = (char *) (&value);
215 appendStringInfo(str, "%u [ ", (unsigned int) length);
216 for (i = 0; i < (Size) sizeof(Datum); i++)
217 appendStringInfo(str, "%d ", (int) (s[i]));
218 appendStringInfo(str, "]");
222 s = (char *) DatumGetPointer(value);
223 if (!PointerIsValid(s))
224 appendStringInfo(str, "0 [ ]");
227 appendStringInfo(str, "%u [ ", (unsigned int) length);
228 for (i = 0; i < length; i++)
229 appendStringInfo(str, "%d ", (int) (s[i]));
230 appendStringInfo(str, "]");
237 * Stuff from plannodes.h
241 * print the basic stuff of all nodes that inherit from Plan
244 _outPlanInfo(StringInfo str, Plan *node)
246 WRITE_FLOAT_FIELD(startup_cost, "%.2f");
247 WRITE_FLOAT_FIELD(total_cost, "%.2f");
248 WRITE_FLOAT_FIELD(plan_rows, "%.0f");
249 WRITE_INT_FIELD(plan_width);
250 WRITE_NODE_FIELD(targetlist);
251 WRITE_NODE_FIELD(qual);
252 WRITE_NODE_FIELD(lefttree);
253 WRITE_NODE_FIELD(righttree);
254 WRITE_NODE_FIELD(initPlan);
255 WRITE_BITMAPSET_FIELD(extParam);
256 WRITE_BITMAPSET_FIELD(allParam);
257 WRITE_INT_FIELD(nParamExec);
261 * print the basic stuff of all nodes that inherit from Scan
264 _outScanInfo(StringInfo str, Scan *node)
266 _outPlanInfo(str, (Plan *) node);
268 WRITE_UINT_FIELD(scanrelid);
272 * print the basic stuff of all nodes that inherit from Join
275 _outJoinPlanInfo(StringInfo str, Join *node)
277 _outPlanInfo(str, (Plan *) node);
279 WRITE_ENUM_FIELD(jointype, JoinType);
280 WRITE_NODE_FIELD(joinqual);
285 _outPlan(StringInfo str, Plan *node)
287 WRITE_NODE_TYPE("PLAN");
289 _outPlanInfo(str, (Plan *) node);
293 _outResult(StringInfo str, Result *node)
295 WRITE_NODE_TYPE("RESULT");
297 _outPlanInfo(str, (Plan *) node);
299 WRITE_NODE_FIELD(resconstantqual);
303 _outAppend(StringInfo str, Append *node)
305 WRITE_NODE_TYPE("APPEND");
307 _outPlanInfo(str, (Plan *) node);
309 WRITE_NODE_FIELD(appendplans);
310 WRITE_BOOL_FIELD(isTarget);
314 _outScan(StringInfo str, Scan *node)
316 WRITE_NODE_TYPE("SCAN");
318 _outScanInfo(str, (Scan *) node);
322 _outSeqScan(StringInfo str, SeqScan *node)
324 WRITE_NODE_TYPE("SEQSCAN");
326 _outScanInfo(str, (Scan *) node);
330 _outIndexScan(StringInfo str, IndexScan *node)
332 WRITE_NODE_TYPE("INDEXSCAN");
334 _outScanInfo(str, (Scan *) node);
336 WRITE_OIDLIST_FIELD(indxid);
337 WRITE_NODE_FIELD(indxqual);
338 WRITE_NODE_FIELD(indxqualorig);
339 /* this can become WRITE_NODE_FIELD when intlists are normal objects: */
343 appendStringInfo(str, " :indxstrategy ");
344 foreach(tmp, node->indxstrategy)
346 _outIntList(str, lfirst(tmp));
349 /* this can become WRITE_NODE_FIELD when OID lists are normal objects: */
353 appendStringInfo(str, " :indxsubtype ");
354 foreach(tmp, node->indxsubtype)
356 _outOidList(str, lfirst(tmp));
359 WRITE_ENUM_FIELD(indxorderdir, ScanDirection);
363 _outTidScan(StringInfo str, TidScan *node)
365 WRITE_NODE_TYPE("TIDSCAN");
367 _outScanInfo(str, (Scan *) node);
369 WRITE_NODE_FIELD(tideval);
373 _outSubqueryScan(StringInfo str, SubqueryScan *node)
375 WRITE_NODE_TYPE("SUBQUERYSCAN");
377 _outScanInfo(str, (Scan *) node);
379 WRITE_NODE_FIELD(subplan);
383 _outFunctionScan(StringInfo str, FunctionScan *node)
385 WRITE_NODE_TYPE("FUNCTIONSCAN");
387 _outScanInfo(str, (Scan *) node);
391 _outJoin(StringInfo str, Join *node)
393 WRITE_NODE_TYPE("JOIN");
395 _outJoinPlanInfo(str, (Join *) node);
399 _outNestLoop(StringInfo str, NestLoop *node)
401 WRITE_NODE_TYPE("NESTLOOP");
403 _outJoinPlanInfo(str, (Join *) node);
407 _outMergeJoin(StringInfo str, MergeJoin *node)
409 WRITE_NODE_TYPE("MERGEJOIN");
411 _outJoinPlanInfo(str, (Join *) node);
413 WRITE_NODE_FIELD(mergeclauses);
417 _outHashJoin(StringInfo str, HashJoin *node)
419 WRITE_NODE_TYPE("HASHJOIN");
421 _outJoinPlanInfo(str, (Join *) node);
423 WRITE_NODE_FIELD(hashclauses);
427 _outAgg(StringInfo str, Agg *node)
429 WRITE_NODE_TYPE("AGG");
431 _outPlanInfo(str, (Plan *) node);
433 WRITE_ENUM_FIELD(aggstrategy, AggStrategy);
434 WRITE_INT_FIELD(numCols);
435 WRITE_LONG_FIELD(numGroups);
439 _outGroup(StringInfo str, Group *node)
443 WRITE_NODE_TYPE("GROUP");
445 _outPlanInfo(str, (Plan *) node);
447 WRITE_INT_FIELD(numCols);
449 appendStringInfo(str, " :grpColIdx");
450 for (i = 0; i < node->numCols; i++)
451 appendStringInfo(str, " %d", node->grpColIdx[i]);
455 _outMaterial(StringInfo str, Material *node)
457 WRITE_NODE_TYPE("MATERIAL");
459 _outPlanInfo(str, (Plan *) node);
463 _outSort(StringInfo str, Sort *node)
467 WRITE_NODE_TYPE("SORT");
469 _outPlanInfo(str, (Plan *) node);
471 WRITE_INT_FIELD(numCols);
473 appendStringInfo(str, " :sortColIdx");
474 for (i = 0; i < node->numCols; i++)
475 appendStringInfo(str, " %d", node->sortColIdx[i]);
477 appendStringInfo(str, " :sortOperators");
478 for (i = 0; i < node->numCols; i++)
479 appendStringInfo(str, " %u", node->sortOperators[i]);
483 _outUnique(StringInfo str, Unique *node)
487 WRITE_NODE_TYPE("UNIQUE");
489 _outPlanInfo(str, (Plan *) node);
491 WRITE_INT_FIELD(numCols);
493 appendStringInfo(str, " :uniqColIdx");
494 for (i = 0; i < node->numCols; i++)
495 appendStringInfo(str, " %d", node->uniqColIdx[i]);
499 _outSetOp(StringInfo str, SetOp *node)
503 WRITE_NODE_TYPE("SETOP");
505 _outPlanInfo(str, (Plan *) node);
507 WRITE_ENUM_FIELD(cmd, SetOpCmd);
508 WRITE_INT_FIELD(numCols);
510 appendStringInfo(str, " :dupColIdx");
511 for (i = 0; i < node->numCols; i++)
512 appendStringInfo(str, " %d", node->dupColIdx[i]);
514 WRITE_INT_FIELD(flagColIdx);
518 _outLimit(StringInfo str, Limit *node)
520 WRITE_NODE_TYPE("LIMIT");
522 _outPlanInfo(str, (Plan *) node);
524 WRITE_NODE_FIELD(limitOffset);
525 WRITE_NODE_FIELD(limitCount);
529 _outHash(StringInfo str, Hash *node)
531 WRITE_NODE_TYPE("HASH");
533 _outPlanInfo(str, (Plan *) node);
535 WRITE_NODE_FIELD(hashkeys);
538 /*****************************************************************************
540 * Stuff from primnodes.h.
542 *****************************************************************************/
545 _outResdom(StringInfo str, Resdom *node)
547 WRITE_NODE_TYPE("RESDOM");
549 WRITE_INT_FIELD(resno);
550 WRITE_OID_FIELD(restype);
551 WRITE_INT_FIELD(restypmod);
552 WRITE_STRING_FIELD(resname);
553 WRITE_UINT_FIELD(ressortgroupref);
554 WRITE_OID_FIELD(resorigtbl);
555 WRITE_INT_FIELD(resorigcol);
556 WRITE_BOOL_FIELD(resjunk);
560 _outAlias(StringInfo str, Alias *node)
562 WRITE_NODE_TYPE("ALIAS");
564 WRITE_STRING_FIELD(aliasname);
565 WRITE_NODE_FIELD(colnames);
569 _outRangeVar(StringInfo str, RangeVar *node)
571 WRITE_NODE_TYPE("RANGEVAR");
574 * we deliberately ignore catalogname here, since it is presently not
575 * semantically meaningful
577 WRITE_STRING_FIELD(schemaname);
578 WRITE_STRING_FIELD(relname);
579 WRITE_ENUM_FIELD(inhOpt, InhOption);
580 WRITE_BOOL_FIELD(istemp);
581 WRITE_NODE_FIELD(alias);
585 _outVar(StringInfo str, Var *node)
587 WRITE_NODE_TYPE("VAR");
589 WRITE_UINT_FIELD(varno);
590 WRITE_INT_FIELD(varattno);
591 WRITE_OID_FIELD(vartype);
592 WRITE_INT_FIELD(vartypmod);
593 WRITE_UINT_FIELD(varlevelsup);
594 WRITE_UINT_FIELD(varnoold);
595 WRITE_INT_FIELD(varoattno);
599 _outConst(StringInfo str, Const *node)
601 WRITE_NODE_TYPE("CONST");
603 WRITE_OID_FIELD(consttype);
604 WRITE_INT_FIELD(constlen);
605 WRITE_BOOL_FIELD(constbyval);
606 WRITE_BOOL_FIELD(constisnull);
608 appendStringInfo(str, " :constvalue ");
609 if (node->constisnull)
610 appendStringInfo(str, "<>");
612 _outDatum(str, node->constvalue, node->constlen, node->constbyval);
616 _outParam(StringInfo str, Param *node)
618 WRITE_NODE_TYPE("PARAM");
620 WRITE_INT_FIELD(paramkind);
621 WRITE_INT_FIELD(paramid);
622 WRITE_STRING_FIELD(paramname);
623 WRITE_OID_FIELD(paramtype);
627 _outAggref(StringInfo str, Aggref *node)
629 WRITE_NODE_TYPE("AGGREF");
631 WRITE_OID_FIELD(aggfnoid);
632 WRITE_OID_FIELD(aggtype);
633 WRITE_NODE_FIELD(target);
634 WRITE_UINT_FIELD(agglevelsup);
635 WRITE_BOOL_FIELD(aggstar);
636 WRITE_BOOL_FIELD(aggdistinct);
640 _outArrayRef(StringInfo str, ArrayRef *node)
642 WRITE_NODE_TYPE("ARRAYREF");
644 WRITE_OID_FIELD(refrestype);
645 WRITE_OID_FIELD(refarraytype);
646 WRITE_OID_FIELD(refelemtype);
647 WRITE_NODE_FIELD(refupperindexpr);
648 WRITE_NODE_FIELD(reflowerindexpr);
649 WRITE_NODE_FIELD(refexpr);
650 WRITE_NODE_FIELD(refassgnexpr);
654 _outFuncExpr(StringInfo str, FuncExpr *node)
656 WRITE_NODE_TYPE("FUNCEXPR");
658 WRITE_OID_FIELD(funcid);
659 WRITE_OID_FIELD(funcresulttype);
660 WRITE_BOOL_FIELD(funcretset);
661 WRITE_ENUM_FIELD(funcformat, CoercionForm);
662 WRITE_NODE_FIELD(args);
666 _outOpExpr(StringInfo str, OpExpr *node)
668 WRITE_NODE_TYPE("OPEXPR");
670 WRITE_OID_FIELD(opno);
671 WRITE_OID_FIELD(opfuncid);
672 WRITE_OID_FIELD(opresulttype);
673 WRITE_BOOL_FIELD(opretset);
674 WRITE_NODE_FIELD(args);
678 _outDistinctExpr(StringInfo str, DistinctExpr *node)
680 WRITE_NODE_TYPE("DISTINCTEXPR");
682 WRITE_OID_FIELD(opno);
683 WRITE_OID_FIELD(opfuncid);
684 WRITE_OID_FIELD(opresulttype);
685 WRITE_BOOL_FIELD(opretset);
686 WRITE_NODE_FIELD(args);
690 _outScalarArrayOpExpr(StringInfo str, ScalarArrayOpExpr *node)
692 WRITE_NODE_TYPE("SCALARARRAYOPEXPR");
694 WRITE_OID_FIELD(opno);
695 WRITE_OID_FIELD(opfuncid);
696 WRITE_BOOL_FIELD(useOr);
697 WRITE_NODE_FIELD(args);
701 _outBoolExpr(StringInfo str, BoolExpr *node)
705 WRITE_NODE_TYPE("BOOLEXPR");
707 /* do-it-yourself enum representation */
708 switch (node->boolop)
720 appendStringInfo(str, " :boolop ");
721 _outToken(str, opstr);
723 WRITE_NODE_FIELD(args);
727 _outSubLink(StringInfo str, SubLink *node)
729 WRITE_NODE_TYPE("SUBLINK");
731 WRITE_ENUM_FIELD(subLinkType, SubLinkType);
732 WRITE_BOOL_FIELD(useOr);
733 WRITE_NODE_FIELD(lefthand);
734 WRITE_NODE_FIELD(operName);
735 WRITE_OIDLIST_FIELD(operOids);
736 WRITE_NODE_FIELD(subselect);
740 _outSubPlan(StringInfo str, SubPlan *node)
742 WRITE_NODE_TYPE("SUBPLAN");
744 WRITE_ENUM_FIELD(subLinkType, SubLinkType);
745 WRITE_BOOL_FIELD(useOr);
746 WRITE_NODE_FIELD(exprs);
747 WRITE_INTLIST_FIELD(paramIds);
748 WRITE_NODE_FIELD(plan);
749 WRITE_INT_FIELD(plan_id);
750 WRITE_NODE_FIELD(rtable);
751 WRITE_BOOL_FIELD(useHashTable);
752 WRITE_BOOL_FIELD(unknownEqFalse);
753 WRITE_INTLIST_FIELD(setParam);
754 WRITE_INTLIST_FIELD(parParam);
755 WRITE_NODE_FIELD(args);
759 _outFieldSelect(StringInfo str, FieldSelect *node)
761 WRITE_NODE_TYPE("FIELDSELECT");
763 WRITE_NODE_FIELD(arg);
764 WRITE_INT_FIELD(fieldnum);
765 WRITE_OID_FIELD(resulttype);
766 WRITE_INT_FIELD(resulttypmod);
770 _outRelabelType(StringInfo str, RelabelType *node)
772 WRITE_NODE_TYPE("RELABELTYPE");
774 WRITE_NODE_FIELD(arg);
775 WRITE_OID_FIELD(resulttype);
776 WRITE_INT_FIELD(resulttypmod);
777 WRITE_ENUM_FIELD(relabelformat, CoercionForm);
781 _outCaseExpr(StringInfo str, CaseExpr *node)
783 WRITE_NODE_TYPE("CASE");
785 WRITE_OID_FIELD(casetype);
786 WRITE_NODE_FIELD(arg);
787 WRITE_NODE_FIELD(args);
788 WRITE_NODE_FIELD(defresult);
792 _outCaseWhen(StringInfo str, CaseWhen *node)
794 WRITE_NODE_TYPE("WHEN");
796 WRITE_NODE_FIELD(expr);
797 WRITE_NODE_FIELD(result);
801 _outArrayExpr(StringInfo str, ArrayExpr *node)
803 WRITE_NODE_TYPE("ARRAY");
805 WRITE_OID_FIELD(array_typeid);
806 WRITE_OID_FIELD(element_typeid);
807 WRITE_NODE_FIELD(elements);
808 WRITE_BOOL_FIELD(multidims);
812 _outCoalesceExpr(StringInfo str, CoalesceExpr *node)
814 WRITE_NODE_TYPE("COALESCE");
816 WRITE_OID_FIELD(coalescetype);
817 WRITE_NODE_FIELD(args);
821 _outNullIfExpr(StringInfo str, NullIfExpr *node)
823 WRITE_NODE_TYPE("NULLIFEXPR");
825 WRITE_OID_FIELD(opno);
826 WRITE_OID_FIELD(opfuncid);
827 WRITE_OID_FIELD(opresulttype);
828 WRITE_BOOL_FIELD(opretset);
829 WRITE_NODE_FIELD(args);
833 _outNullTest(StringInfo str, NullTest *node)
835 WRITE_NODE_TYPE("NULLTEST");
837 WRITE_NODE_FIELD(arg);
838 WRITE_ENUM_FIELD(nulltesttype, NullTestType);
842 _outBooleanTest(StringInfo str, BooleanTest *node)
844 WRITE_NODE_TYPE("BOOLEANTEST");
846 WRITE_NODE_FIELD(arg);
847 WRITE_ENUM_FIELD(booltesttype, BoolTestType);
851 _outCoerceToDomain(StringInfo str, CoerceToDomain *node)
853 WRITE_NODE_TYPE("COERCETODOMAIN");
855 WRITE_NODE_FIELD(arg);
856 WRITE_OID_FIELD(resulttype);
857 WRITE_INT_FIELD(resulttypmod);
858 WRITE_ENUM_FIELD(coercionformat, CoercionForm);
862 _outCoerceToDomainValue(StringInfo str, CoerceToDomainValue *node)
864 WRITE_NODE_TYPE("COERCETODOMAINVALUE");
866 WRITE_OID_FIELD(typeId);
867 WRITE_INT_FIELD(typeMod);
871 _outSetToDefault(StringInfo str, SetToDefault *node)
873 WRITE_NODE_TYPE("SETTODEFAULT");
875 WRITE_OID_FIELD(typeId);
876 WRITE_INT_FIELD(typeMod);
880 _outTargetEntry(StringInfo str, TargetEntry *node)
882 WRITE_NODE_TYPE("TARGETENTRY");
884 WRITE_NODE_FIELD(resdom);
885 WRITE_NODE_FIELD(expr);
889 _outRangeTblRef(StringInfo str, RangeTblRef *node)
891 WRITE_NODE_TYPE("RANGETBLREF");
893 WRITE_INT_FIELD(rtindex);
897 _outJoinExpr(StringInfo str, JoinExpr *node)
899 WRITE_NODE_TYPE("JOINEXPR");
901 WRITE_ENUM_FIELD(jointype, JoinType);
902 WRITE_BOOL_FIELD(isNatural);
903 WRITE_NODE_FIELD(larg);
904 WRITE_NODE_FIELD(rarg);
905 WRITE_NODE_FIELD(using);
906 WRITE_NODE_FIELD(quals);
907 WRITE_NODE_FIELD(alias);
908 WRITE_INT_FIELD(rtindex);
912 _outFromExpr(StringInfo str, FromExpr *node)
914 WRITE_NODE_TYPE("FROMEXPR");
916 WRITE_NODE_FIELD(fromlist);
917 WRITE_NODE_FIELD(quals);
920 /*****************************************************************************
922 * Stuff from relation.h.
924 *****************************************************************************/
927 * print the basic stuff of all nodes that inherit from Path
929 * Note we do NOT print the parent, else we'd be in infinite recursion
932 _outPathInfo(StringInfo str, Path *node)
934 WRITE_ENUM_FIELD(pathtype, NodeTag);
935 WRITE_FLOAT_FIELD(startup_cost, "%.2f");
936 WRITE_FLOAT_FIELD(total_cost, "%.2f");
937 WRITE_NODE_FIELD(pathkeys);
941 * print the basic stuff of all nodes that inherit from JoinPath
944 _outJoinPathInfo(StringInfo str, JoinPath *node)
946 _outPathInfo(str, (Path *) node);
948 WRITE_ENUM_FIELD(jointype, JoinType);
949 WRITE_NODE_FIELD(outerjoinpath);
950 WRITE_NODE_FIELD(innerjoinpath);
951 WRITE_NODE_FIELD(joinrestrictinfo);
955 _outPath(StringInfo str, Path *node)
957 WRITE_NODE_TYPE("PATH");
959 _outPathInfo(str, (Path *) node);
963 * IndexPath is a subclass of Path.
966 _outIndexPath(StringInfo str, IndexPath *node)
968 WRITE_NODE_TYPE("INDEXPATH");
970 _outPathInfo(str, (Path *) node);
972 WRITE_NODE_FIELD(indexinfo);
973 WRITE_NODE_FIELD(indexqual);
974 WRITE_NODE_FIELD(indexjoinclauses);
975 WRITE_ENUM_FIELD(indexscandir, ScanDirection);
976 WRITE_FLOAT_FIELD(rows, "%.2f");
980 _outTidPath(StringInfo str, TidPath *node)
982 WRITE_NODE_TYPE("TIDPATH");
984 _outPathInfo(str, (Path *) node);
986 WRITE_NODE_FIELD(tideval);
990 _outAppendPath(StringInfo str, AppendPath *node)
992 WRITE_NODE_TYPE("APPENDPATH");
994 _outPathInfo(str, (Path *) node);
996 WRITE_NODE_FIELD(subpaths);
1000 _outResultPath(StringInfo str, ResultPath *node)
1002 WRITE_NODE_TYPE("RESULTPATH");
1004 _outPathInfo(str, (Path *) node);
1006 WRITE_NODE_FIELD(subpath);
1007 WRITE_NODE_FIELD(constantqual);
1011 _outMaterialPath(StringInfo str, MaterialPath *node)
1013 WRITE_NODE_TYPE("MATERIALPATH");
1015 _outPathInfo(str, (Path *) node);
1017 WRITE_NODE_FIELD(subpath);
1021 _outUniquePath(StringInfo str, UniquePath *node)
1023 WRITE_NODE_TYPE("UNIQUEPATH");
1025 _outPathInfo(str, (Path *) node);
1027 WRITE_NODE_FIELD(subpath);
1028 WRITE_BOOL_FIELD(use_hash);
1029 WRITE_FLOAT_FIELD(rows, "%.0f");
1033 _outNestPath(StringInfo str, NestPath *node)
1035 WRITE_NODE_TYPE("NESTPATH");
1037 _outJoinPathInfo(str, (JoinPath *) node);
1041 _outMergePath(StringInfo str, MergePath *node)
1043 WRITE_NODE_TYPE("MERGEPATH");
1045 _outJoinPathInfo(str, (JoinPath *) node);
1047 WRITE_NODE_FIELD(path_mergeclauses);
1048 WRITE_NODE_FIELD(outersortkeys);
1049 WRITE_NODE_FIELD(innersortkeys);
1053 _outHashPath(StringInfo str, HashPath *node)
1055 WRITE_NODE_TYPE("HASHPATH");
1057 _outJoinPathInfo(str, (JoinPath *) node);
1059 WRITE_NODE_FIELD(path_hashclauses);
1063 _outPathKeyItem(StringInfo str, PathKeyItem *node)
1065 WRITE_NODE_TYPE("PATHKEYITEM");
1067 WRITE_NODE_FIELD(key);
1068 WRITE_OID_FIELD(sortop);
1072 _outRestrictInfo(StringInfo str, RestrictInfo *node)
1074 WRITE_NODE_TYPE("RESTRICTINFO");
1076 /* NB: this isn't a complete set of fields */
1077 WRITE_NODE_FIELD(clause);
1078 WRITE_BOOL_FIELD(ispusheddown);
1079 WRITE_NODE_FIELD(subclauseindices);
1080 WRITE_BITMAPSET_FIELD(left_relids);
1081 WRITE_BITMAPSET_FIELD(right_relids);
1082 WRITE_OID_FIELD(mergejoinoperator);
1083 WRITE_OID_FIELD(left_sortop);
1084 WRITE_OID_FIELD(right_sortop);
1085 WRITE_NODE_FIELD(left_pathkey);
1086 WRITE_NODE_FIELD(right_pathkey);
1087 WRITE_OID_FIELD(hashjoinoperator);
1091 _outJoinInfo(StringInfo str, JoinInfo *node)
1093 WRITE_NODE_TYPE("JOININFO");
1095 WRITE_BITMAPSET_FIELD(unjoined_relids);
1096 WRITE_NODE_FIELD(jinfo_restrictinfo);
1100 _outInClauseInfo(StringInfo str, InClauseInfo *node)
1102 WRITE_NODE_TYPE("INCLAUSEINFO");
1104 WRITE_BITMAPSET_FIELD(lefthand);
1105 WRITE_BITMAPSET_FIELD(righthand);
1106 WRITE_NODE_FIELD(sub_targetlist);
1109 /*****************************************************************************
1111 * Stuff from parsenodes.h.
1113 *****************************************************************************/
1116 _outCreateStmt(StringInfo str, CreateStmt *node)
1118 WRITE_NODE_TYPE("CREATE");
1120 WRITE_NODE_FIELD(relation);
1121 WRITE_NODE_FIELD(tableElts);
1122 WRITE_NODE_FIELD(inhRelations);
1123 WRITE_NODE_FIELD(constraints);
1124 WRITE_BOOL_FIELD(hasoids);
1125 WRITE_ENUM_FIELD(oncommit, OnCommitAction);
1129 _outIndexStmt(StringInfo str, IndexStmt *node)
1131 WRITE_NODE_TYPE("INDEX");
1133 WRITE_STRING_FIELD(idxname);
1134 WRITE_NODE_FIELD(relation);
1135 WRITE_STRING_FIELD(accessMethod);
1136 WRITE_NODE_FIELD(indexParams);
1137 WRITE_NODE_FIELD(whereClause);
1138 WRITE_NODE_FIELD(rangetable);
1139 WRITE_BOOL_FIELD(unique);
1140 WRITE_BOOL_FIELD(primary);
1141 WRITE_BOOL_FIELD(isconstraint);
1145 _outNotifyStmt(StringInfo str, NotifyStmt *node)
1147 WRITE_NODE_TYPE("NOTIFY");
1149 WRITE_NODE_FIELD(relation);
1153 _outDeclareCursorStmt(StringInfo str, DeclareCursorStmt *node)
1155 WRITE_NODE_TYPE("DECLARECURSOR");
1157 WRITE_STRING_FIELD(portalname);
1158 WRITE_INT_FIELD(options);
1159 WRITE_NODE_FIELD(query);
1163 _outSelectStmt(StringInfo str, SelectStmt *node)
1165 WRITE_NODE_TYPE("SELECT");
1167 /* XXX this is pretty durn incomplete */
1168 WRITE_NODE_FIELD(whereClause);
1172 _outFuncCall(StringInfo str, FuncCall *node)
1174 WRITE_NODE_TYPE("FUNCCALL");
1176 WRITE_NODE_FIELD(funcname);
1177 WRITE_NODE_FIELD(args);
1178 WRITE_BOOL_FIELD(agg_star);
1179 WRITE_BOOL_FIELD(agg_distinct);
1183 _outColumnDef(StringInfo str, ColumnDef *node)
1185 WRITE_NODE_TYPE("COLUMNDEF");
1187 WRITE_STRING_FIELD(colname);
1188 WRITE_NODE_FIELD(typename);
1189 WRITE_INT_FIELD(inhcount);
1190 WRITE_BOOL_FIELD(is_local);
1191 WRITE_BOOL_FIELD(is_not_null);
1192 WRITE_NODE_FIELD(raw_default);
1193 WRITE_STRING_FIELD(cooked_default);
1194 WRITE_NODE_FIELD(constraints);
1195 WRITE_NODE_FIELD(support);
1199 _outTypeName(StringInfo str, TypeName *node)
1201 WRITE_NODE_TYPE("TYPENAME");
1203 WRITE_NODE_FIELD(names);
1204 WRITE_OID_FIELD(typeid);
1205 WRITE_BOOL_FIELD(timezone);
1206 WRITE_BOOL_FIELD(setof);
1207 WRITE_BOOL_FIELD(pct_type);
1208 WRITE_INT_FIELD(typmod);
1209 WRITE_NODE_FIELD(arrayBounds);
1213 _outTypeCast(StringInfo str, TypeCast *node)
1215 WRITE_NODE_TYPE("TYPECAST");
1217 WRITE_NODE_FIELD(arg);
1218 WRITE_NODE_FIELD(typename);
1222 _outIndexElem(StringInfo str, IndexElem *node)
1224 WRITE_NODE_TYPE("INDEXELEM");
1226 WRITE_STRING_FIELD(name);
1227 WRITE_NODE_FIELD(expr);
1228 WRITE_NODE_FIELD(opclass);
1232 _outQuery(StringInfo str, Query *node)
1234 WRITE_NODE_TYPE("QUERY");
1236 WRITE_ENUM_FIELD(commandType, CmdType);
1237 WRITE_ENUM_FIELD(querySource, QuerySource);
1238 WRITE_BOOL_FIELD(canSetTag);
1241 * Hack to work around missing outfuncs routines for a lot of the
1242 * utility-statement node types. (The only one we actually *need* for
1243 * rules support is NotifyStmt.) Someday we ought to support 'em all,
1244 * but for the meantime do this to avoid getting lots of warnings when
1245 * running with debug_print_parse on.
1247 if (node->utilityStmt)
1249 switch (nodeTag(node->utilityStmt))
1254 case T_DeclareCursorStmt:
1255 WRITE_NODE_FIELD(utilityStmt);
1258 appendStringInfo(str, " :utilityStmt ?");
1263 appendStringInfo(str, " :utilityStmt <>");
1265 WRITE_INT_FIELD(resultRelation);
1266 WRITE_NODE_FIELD(into);
1267 WRITE_BOOL_FIELD(hasAggs);
1268 WRITE_BOOL_FIELD(hasSubLinks);
1269 WRITE_NODE_FIELD(rtable);
1270 WRITE_NODE_FIELD(jointree);
1271 WRITE_INTLIST_FIELD(rowMarks);
1272 WRITE_NODE_FIELD(targetList);
1273 WRITE_NODE_FIELD(groupClause);
1274 WRITE_NODE_FIELD(havingQual);
1275 WRITE_NODE_FIELD(distinctClause);
1276 WRITE_NODE_FIELD(sortClause);
1277 WRITE_NODE_FIELD(limitOffset);
1278 WRITE_NODE_FIELD(limitCount);
1279 WRITE_NODE_FIELD(setOperations);
1280 WRITE_INTLIST_FIELD(resultRelations);
1282 /* planner-internal fields are not written out */
1286 _outSortClause(StringInfo str, SortClause *node)
1288 WRITE_NODE_TYPE("SORTCLAUSE");
1290 WRITE_UINT_FIELD(tleSortGroupRef);
1291 WRITE_OID_FIELD(sortop);
1295 _outGroupClause(StringInfo str, GroupClause *node)
1297 WRITE_NODE_TYPE("GROUPCLAUSE");
1299 WRITE_UINT_FIELD(tleSortGroupRef);
1300 WRITE_OID_FIELD(sortop);
1304 _outSetOperationStmt(StringInfo str, SetOperationStmt *node)
1306 WRITE_NODE_TYPE("SETOPERATIONSTMT");
1308 WRITE_ENUM_FIELD(op, SetOperation);
1309 WRITE_BOOL_FIELD(all);
1310 WRITE_NODE_FIELD(larg);
1311 WRITE_NODE_FIELD(rarg);
1312 WRITE_OIDLIST_FIELD(colTypes);
1316 _outRangeTblEntry(StringInfo str, RangeTblEntry *node)
1318 WRITE_NODE_TYPE("RTE");
1320 /* put alias + eref first to make dump more legible */
1321 WRITE_NODE_FIELD(alias);
1322 WRITE_NODE_FIELD(eref);
1323 WRITE_ENUM_FIELD(rtekind, RTEKind);
1325 switch (node->rtekind)
1329 WRITE_OID_FIELD(relid);
1332 WRITE_NODE_FIELD(subquery);
1335 WRITE_NODE_FIELD(funcexpr);
1336 WRITE_NODE_FIELD(coldeflist);
1339 WRITE_ENUM_FIELD(jointype, JoinType);
1340 WRITE_NODE_FIELD(joinaliasvars);
1343 elog(ERROR, "unrecognized RTE kind: %d", (int) node->rtekind);
1347 WRITE_BOOL_FIELD(inh);
1348 WRITE_BOOL_FIELD(inFromCl);
1349 WRITE_BOOL_FIELD(checkForRead);
1350 WRITE_BOOL_FIELD(checkForWrite);
1351 WRITE_OID_FIELD(checkAsUser);
1355 _outAExpr(StringInfo str, A_Expr *node)
1357 WRITE_NODE_TYPE("AEXPR");
1362 appendStringInfo(str, " ");
1363 WRITE_NODE_FIELD(name);
1366 appendStringInfo(str, " AND");
1369 appendStringInfo(str, " OR");
1372 appendStringInfo(str, " NOT");
1375 appendStringInfo(str, " ");
1376 WRITE_NODE_FIELD(name);
1377 appendStringInfo(str, " ANY ");
1380 appendStringInfo(str, " ");
1381 WRITE_NODE_FIELD(name);
1382 appendStringInfo(str, " ALL ");
1384 case AEXPR_DISTINCT:
1385 appendStringInfo(str, " DISTINCT ");
1386 WRITE_NODE_FIELD(name);
1389 appendStringInfo(str, " NULLIF ");
1390 WRITE_NODE_FIELD(name);
1393 appendStringInfo(str, " OF ");
1394 WRITE_NODE_FIELD(name);
1397 appendStringInfo(str, " ??");
1401 WRITE_NODE_FIELD(lexpr);
1402 WRITE_NODE_FIELD(rexpr);
1406 _outValue(StringInfo str, Value *value)
1408 switch (value->type)
1411 appendStringInfo(str, "%ld", value->val.ival);
1416 * We assume the value is a valid numeric literal and so does
1419 appendStringInfo(str, "%s", value->val.str);
1422 appendStringInfoChar(str, '"');
1423 _outToken(str, value->val.str);
1424 appendStringInfoChar(str, '"');
1427 /* internal representation already has leading 'b' */
1428 appendStringInfo(str, "%s", value->val.str);
1431 elog(ERROR, "unrecognized node type: %d", (int) value->type);
1437 _outColumnRef(StringInfo str, ColumnRef *node)
1439 WRITE_NODE_TYPE("COLUMNREF");
1441 WRITE_NODE_FIELD(fields);
1442 WRITE_NODE_FIELD(indirection);
1446 _outParamRef(StringInfo str, ParamRef *node)
1448 WRITE_NODE_TYPE("PARAMREF");
1450 WRITE_INT_FIELD(number);
1451 WRITE_NODE_FIELD(fields);
1452 WRITE_NODE_FIELD(indirection);
1456 _outAConst(StringInfo str, A_Const *node)
1458 WRITE_NODE_TYPE("CONST ");
1460 _outValue(str, &(node->val));
1461 WRITE_NODE_FIELD(typename);
1465 _outExprFieldSelect(StringInfo str, ExprFieldSelect *node)
1467 WRITE_NODE_TYPE("EXPRFIELDSELECT");
1469 WRITE_NODE_FIELD(arg);
1470 WRITE_NODE_FIELD(fields);
1471 WRITE_NODE_FIELD(indirection);
1475 _outConstraint(StringInfo str, Constraint *node)
1477 WRITE_NODE_TYPE("CONSTRAINT");
1479 WRITE_STRING_FIELD(name);
1481 appendStringInfo(str, " :contype ");
1482 switch (node->contype)
1484 case CONSTR_PRIMARY:
1485 appendStringInfo(str, "PRIMARY_KEY");
1486 WRITE_NODE_FIELD(keys);
1490 appendStringInfo(str, "CHECK");
1491 WRITE_NODE_FIELD(raw_expr);
1492 WRITE_STRING_FIELD(cooked_expr);
1495 case CONSTR_DEFAULT:
1496 appendStringInfo(str, "DEFAULT");
1497 WRITE_NODE_FIELD(raw_expr);
1498 WRITE_STRING_FIELD(cooked_expr);
1501 case CONSTR_NOTNULL:
1502 appendStringInfo(str, "NOT_NULL");
1506 appendStringInfo(str, "UNIQUE");
1507 WRITE_NODE_FIELD(keys);
1511 appendStringInfo(str, "<unrecognized_constraint>");
1517 _outFkConstraint(StringInfo str, FkConstraint *node)
1519 WRITE_NODE_TYPE("FKCONSTRAINT");
1521 WRITE_STRING_FIELD(constr_name);
1522 WRITE_NODE_FIELD(pktable);
1523 WRITE_NODE_FIELD(fk_attrs);
1524 WRITE_NODE_FIELD(pk_attrs);
1525 WRITE_CHAR_FIELD(fk_matchtype);
1526 WRITE_CHAR_FIELD(fk_upd_action);
1527 WRITE_CHAR_FIELD(fk_del_action);
1528 WRITE_BOOL_FIELD(deferrable);
1529 WRITE_BOOL_FIELD(initdeferred);
1530 WRITE_BOOL_FIELD(skip_validation);
1536 * converts a Node into ascii string and append it to 'str'
1539 _outNode(StringInfo str, void *obj)
1543 appendStringInfo(str, "<>");
1551 appendStringInfoChar(str, '(');
1552 foreach(l, (List *) obj)
1554 _outNode(str, lfirst(l));
1556 appendStringInfoChar(str, ' ');
1558 appendStringInfoChar(str, ')');
1560 else if (IsA(obj, Integer) ||
1563 IsA(obj, BitString))
1565 /* nodeRead does not want to see { } around these! */
1566 _outValue(str, obj);
1570 appendStringInfoChar(str, '{');
1571 switch (nodeTag(obj))
1577 _outResult(str, obj);
1580 _outAppend(str, obj);
1586 _outSeqScan(str, obj);
1589 _outIndexScan(str, obj);
1592 _outTidScan(str, obj);
1594 case T_SubqueryScan:
1595 _outSubqueryScan(str, obj);
1597 case T_FunctionScan:
1598 _outFunctionScan(str, obj);
1604 _outNestLoop(str, obj);
1607 _outMergeJoin(str, obj);
1610 _outHashJoin(str, obj);
1616 _outGroup(str, obj);
1619 _outMaterial(str, obj);
1625 _outUnique(str, obj);
1628 _outSetOp(str, obj);
1631 _outLimit(str, obj);
1637 _outResdom(str, obj);
1640 _outAlias(str, obj);
1643 _outRangeVar(str, obj);
1649 _outConst(str, obj);
1652 _outParam(str, obj);
1655 _outAggref(str, obj);
1658 _outArrayRef(str, obj);
1661 _outFuncExpr(str, obj);
1664 _outOpExpr(str, obj);
1666 case T_DistinctExpr:
1667 _outDistinctExpr(str, obj);
1669 case T_ScalarArrayOpExpr:
1670 _outScalarArrayOpExpr(str, obj);
1673 _outBoolExpr(str, obj);
1676 _outSubLink(str, obj);
1679 _outSubPlan(str, obj);
1682 _outFieldSelect(str, obj);
1685 _outRelabelType(str, obj);
1688 _outCaseExpr(str, obj);
1691 _outCaseWhen(str, obj);
1694 _outArrayExpr(str, obj);
1696 case T_CoalesceExpr:
1697 _outCoalesceExpr(str, obj);
1700 _outNullIfExpr(str, obj);
1703 _outNullTest(str, obj);
1706 _outBooleanTest(str, obj);
1708 case T_CoerceToDomain:
1709 _outCoerceToDomain(str, obj);
1711 case T_CoerceToDomainValue:
1712 _outCoerceToDomainValue(str, obj);
1714 case T_SetToDefault:
1715 _outSetToDefault(str, obj);
1718 _outTargetEntry(str, obj);
1721 _outRangeTblRef(str, obj);
1724 _outJoinExpr(str, obj);
1727 _outFromExpr(str, obj);
1734 _outIndexPath(str, obj);
1737 _outTidPath(str, obj);
1740 _outAppendPath(str, obj);
1743 _outResultPath(str, obj);
1745 case T_MaterialPath:
1746 _outMaterialPath(str, obj);
1749 _outUniquePath(str, obj);
1752 _outNestPath(str, obj);
1755 _outMergePath(str, obj);
1758 _outHashPath(str, obj);
1761 _outPathKeyItem(str, obj);
1763 case T_RestrictInfo:
1764 _outRestrictInfo(str, obj);
1767 _outJoinInfo(str, obj);
1769 case T_InClauseInfo:
1770 _outInClauseInfo(str, obj);
1774 _outCreateStmt(str, obj);
1777 _outIndexStmt(str, obj);
1780 _outNotifyStmt(str, obj);
1782 case T_DeclareCursorStmt:
1783 _outDeclareCursorStmt(str, obj);
1786 _outSelectStmt(str, obj);
1789 _outColumnDef(str, obj);
1792 _outTypeName(str, obj);
1795 _outTypeCast(str, obj);
1798 _outIndexElem(str, obj);
1801 _outQuery(str, obj);
1804 _outSortClause(str, obj);
1807 _outGroupClause(str, obj);
1809 case T_SetOperationStmt:
1810 _outSetOperationStmt(str, obj);
1812 case T_RangeTblEntry:
1813 _outRangeTblEntry(str, obj);
1816 _outAExpr(str, obj);
1819 _outColumnRef(str, obj);
1822 _outParamRef(str, obj);
1825 _outAConst(str, obj);
1827 case T_ExprFieldSelect:
1828 _outExprFieldSelect(str, obj);
1831 _outConstraint(str, obj);
1833 case T_FkConstraint:
1834 _outFkConstraint(str, obj);
1837 _outFuncCall(str, obj);
1843 * This should be an ERROR, but it's too useful to be able
1844 * to dump structures that _outNode only understands part
1847 elog(WARNING, "could not dump unrecognized node type: %d",
1848 (int) nodeTag(obj));
1851 appendStringInfoChar(str, '}');
1857 * returns the ascii representation of the Node as a palloc'd string
1860 nodeToString(void *obj)
1864 /* see stringinfo.h for an explanation of this maneuver */
1865 initStringInfo(&str);
1866 _outNode(&str, obj);