]> granicus.if.org Git - postgresql/blobdiff - src/include/nodes/primnodes.h
Support GROUPING SETS, CUBE and ROLLUP.
[postgresql] / src / include / nodes / primnodes.h
index 3315329923e50027ba9b007db09f277fac928c1a..a5467c5379918b3eb5abc01c5a1c13a4395e8d11 100644 (file)
@@ -7,10 +7,10 @@
  *       and join trees.
  *
  *
- * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
+ * Portions Copyright (c) 1996-2015, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $PostgreSQL: pgsql/src/include/nodes/primnodes.h,v 1.146 2009/02/25 03:30:37 tgl Exp $
+ * src/include/nodes/primnodes.h
  *
  *-------------------------------------------------------------------------
  */
@@ -33,7 +33,7 @@
  *
  * Note: colnames is a list of Value nodes (always strings).  In Alias structs
  * associated with RTEs, there may be entries corresponding to dropped
- * columns; these are normally empty strings ("").     See parsenodes.h for info.
+ * columns; these are normally empty strings ("").  See parsenodes.h for info.
  */
 typedef struct Alias
 {
@@ -74,13 +74,18 @@ typedef struct RangeVar
        char       *relname;            /* the relation/sequence name */
        InhOption       inhOpt;                 /* expand rel by inheritance? recursively act
                                                                 * on children? */
-       bool            istemp;                 /* is this a temp relation/sequence? */
+       char            relpersistence; /* see RELPERSISTENCE_* in pg_class.h */
        Alias      *alias;                      /* table alias & optional column aliases */
        int                     location;               /* token location, or -1 if unknown */
 } RangeVar;
 
 /*
- * IntoClause - target information for SELECT INTO and CREATE TABLE AS
+ * IntoClause - target information for SELECT INTO, CREATE TABLE AS, and
+ * CREATE MATERIALIZED VIEW
+ *
+ * For CREATE MATERIALIZED VIEW, viewQuery is the parsed-but-not-rewritten
+ * SELECT Query for the view; otherwise it's NULL.  (Although it's actually
+ * Query*, we declare it as Node* to avoid a forward reference.)
  */
 typedef struct IntoClause
 {
@@ -91,6 +96,8 @@ typedef struct IntoClause
        List       *options;            /* options from WITH clause */
        OnCommitAction onCommit;        /* what do we do at COMMIT? */
        char       *tableSpaceName; /* table space to use, or NULL */
+       Node       *viewQuery;          /* materialized view's SELECT query */
+       bool            skipData;               /* true for WITH NO DATA */
 } IntoClause;
 
 
@@ -118,15 +125,23 @@ typedef struct Expr
  * Note: during parsing/planning, varnoold/varoattno are always just copies
  * of varno/varattno.  At the tail end of planning, Var nodes appearing in
  * upper-level plan nodes are reassigned to point to the outputs of their
- * subplans; for example, in a join node varno becomes INNER or OUTER and
- * varattno becomes the index of the proper element of that subplan's target
- * list.  But varnoold/varoattno continue to hold the original values.
- * The code doesn't really need varnoold/varoattno, but they are very useful
- * for debugging and interpreting completed plans, so we keep them around.
+ * subplans; for example, in a join node varno becomes INNER_VAR or OUTER_VAR
+ * and varattno becomes the index of the proper element of that subplan's
+ * target list.  Similarly, INDEX_VAR is used to identify Vars that reference
+ * an index column rather than a heap column.  (In ForeignScan and CustomScan
+ * plan nodes, INDEX_VAR is abused to signify references to columns of a
+ * custom scan tuple type.)  In all these cases, varnoold/varoattno hold the
+ * original values.  The code doesn't really need varnoold/varoattno, but they
+ * are very useful for debugging and interpreting completed plans, so we keep
+ * them around.
  */
-#define    INNER               65000
-#define    OUTER               65001
+#define    INNER_VAR           65000           /* reference to inner subplan */
+#define    OUTER_VAR           65001           /* reference to outer subplan */
+#define    INDEX_VAR           65002           /* reference to index column */
+
+#define IS_SPECIAL_VARNO(varno)                ((varno) >= INNER_VAR)
 
+/* Symbols for the indexes of the special RTE entries in rules */
 #define    PRS2_OLD_VARNO                      1
 #define    PRS2_NEW_VARNO                      2
 
@@ -134,11 +149,12 @@ typedef struct Var
 {
        Expr            xpr;
        Index           varno;                  /* index of this var's relation in the range
-                                                                * table (could also be INNER or OUTER) */
+                                                                * table, or INNER_VAR/OUTER_VAR/INDEX_VAR */
        AttrNumber      varattno;               /* attribute number of this var, or zero for
                                                                 * all */
        Oid                     vartype;                /* pg_type OID for the type of this var */
        int32           vartypmod;              /* pg_attribute typmod value */
+       Oid                     varcollid;              /* OID of collation, or InvalidOid if none */
        Index           varlevelsup;    /* for subquery variables referencing outer
                                                                 * relations; 0 in a normal var, >0 means N
                                                                 * levels up */
@@ -155,6 +171,7 @@ typedef struct Const
        Expr            xpr;
        Oid                     consttype;              /* pg_type OID of the constant's datatype */
        int32           consttypmod;    /* typmod value, if any */
+       Oid                     constcollid;    /* OID of collation, or InvalidOid if none */
        int                     constlen;               /* typlen of the constant's datatype */
        Datum           constvalue;             /* the constant's value */
        bool            constisnull;    /* whether the constant is null (if true,
@@ -166,16 +183,18 @@ typedef struct Const
        int                     location;               /* token location, or -1 if unknown */
 } Const;
 
-/* ----------------
+/*
  * Param
- *             paramkind - specifies the kind of parameter. The possible values
+ *
+ *             paramkind specifies the kind of parameter. The possible values
  *             for this field are:
  *
  *             PARAM_EXTERN:  The parameter value is supplied from outside the plan.
  *                             Such parameters are numbered from 1 to n.
  *
  *             PARAM_EXEC:  The parameter is an internal executor parameter, used
- *                             for passing values into and out of sub-queries.
+ *                             for passing values into and out of sub-queries or from
+ *                             nestloop joins to their inner scans.
  *                             For historical reasons, such parameters are numbered from 0.
  *                             These numbers are independent of PARAM_EXTERN numbers.
  *
@@ -184,17 +203,19 @@ typedef struct Const
  *                             `paramid' field.  (This type of Param is converted to
  *                             PARAM_EXEC during planning.)
  *
- * Note: currently, paramtypmod is valid for PARAM_SUBLINK Params, and for
- * PARAM_EXEC Params generated from them; it is always -1 for PARAM_EXTERN
- * params, since the APIs that supply values for such parameters don't carry
- * any typmod info.
- * ----------------
+ *             PARAM_MULTIEXPR:  Like PARAM_SUBLINK, the parameter represents an
+ *                             output column of a SubLink node's sub-select, but here, the
+ *                             SubLink is always a MULTIEXPR SubLink.  The high-order 16 bits
+ *                             of the `paramid' field contain the SubLink's subLinkId, and
+ *                             the low-order 16 bits contain the column number.  (This type
+ *                             of Param is also converted to PARAM_EXEC during planning.)
  */
 typedef enum ParamKind
 {
        PARAM_EXTERN,
        PARAM_EXEC,
-       PARAM_SUBLINK
+       PARAM_SUBLINK,
+       PARAM_MULTIEXPR
 } ParamKind;
 
 typedef struct Param
@@ -204,24 +225,87 @@ typedef struct Param
        int                     paramid;                /* numeric ID for parameter */
        Oid                     paramtype;              /* pg_type OID of parameter's datatype */
        int32           paramtypmod;    /* typmod value, if known */
+       Oid                     paramcollid;    /* OID of collation, or InvalidOid if none */
        int                     location;               /* token location, or -1 if unknown */
 } Param;
 
 /*
  * Aggref
+ *
+ * The aggregate's args list is a targetlist, ie, a list of TargetEntry nodes.
+ *
+ * For a normal (non-ordered-set) aggregate, the non-resjunk TargetEntries
+ * represent the aggregate's regular arguments (if any) and resjunk TLEs can
+ * be added at the end to represent ORDER BY expressions that are not also
+ * arguments.  As in a top-level Query, the TLEs can be marked with
+ * ressortgroupref indexes to let them be referenced by SortGroupClause
+ * entries in the aggorder and/or aggdistinct lists.  This represents ORDER BY
+ * and DISTINCT operations to be applied to the aggregate input rows before
+ * they are passed to the transition function.  The grammar only allows a
+ * simple "DISTINCT" specifier for the arguments, but we use the full
+ * query-level representation to allow more code sharing.
+ *
+ * For an ordered-set aggregate, the args list represents the WITHIN GROUP
+ * (aggregated) arguments, all of which will be listed in the aggorder list.
+ * DISTINCT is not supported in this case, so aggdistinct will be NIL.
+ * The direct arguments appear in aggdirectargs (as a list of plain
+ * expressions, not TargetEntry nodes).
  */
 typedef struct Aggref
 {
        Expr            xpr;
        Oid                     aggfnoid;               /* pg_proc Oid of the aggregate */
        Oid                     aggtype;                /* type Oid of result of the aggregate */
-       List       *args;                       /* arguments to the aggregate */
-       Index           agglevelsup;    /* > 0 if agg belongs to outer query */
+       Oid                     aggcollid;              /* OID of collation of result */
+       Oid                     inputcollid;    /* OID of collation that function should use */
+       List       *aggdirectargs;      /* direct arguments, if an ordered-set agg */
+       List       *args;                       /* aggregated arguments and sort expressions */
+       List       *aggorder;           /* ORDER BY (list of SortGroupClause) */
+       List       *aggdistinct;        /* DISTINCT (list of SortGroupClause) */
+       Expr       *aggfilter;          /* FILTER expression, if any */
        bool            aggstar;                /* TRUE if argument list was really '*' */
-       bool            aggdistinct;    /* TRUE if it's agg(DISTINCT ...) */
+       bool            aggvariadic;    /* true if variadic arguments have been
+                                                                * combined into an array last argument */
+       char            aggkind;                /* aggregate kind (see pg_aggregate.h) */
+       Index           agglevelsup;    /* > 0 if agg belongs to outer query */
        int                     location;               /* token location, or -1 if unknown */
 } Aggref;
 
+/*
+ * GroupingFunc
+ *
+ * A GroupingFunc is a GROUPING(...) expression, which behaves in many ways
+ * like an aggregate function (e.g. it "belongs" to a specific query level,
+ * which might not be the one immediately containing it), but also differs in
+ * an important respect: it never evaluates its arguments, they merely
+ * designate expressions from the GROUP BY clause of the query level to which
+ * it belongs.
+ *
+ * The spec defines the evaluation of GROUPING() purely by syntactic
+ * replacement, but we make it a real expression for optimization purposes so
+ * that one Agg node can handle multiple grouping sets at once.  Evaluating the
+ * result only needs the column positions to check against the grouping set
+ * being projected.  However, for EXPLAIN to produce meaningful output, we have
+ * to keep the original expressions around, since expression deparse does not
+ * give us any feasible way to get at the GROUP BY clause.
+ *
+ * Also, we treat two GroupingFunc nodes as equal if they have equal arguments
+ * lists and agglevelsup, without comparing the refs and cols annotations.
+ *
+ * In raw parse output we have only the args list; parse analysis fills in the
+ * refs list, and the planner fills in the cols list.
+ */
+typedef struct GroupingFunc
+{
+       Expr            xpr;
+       List       *args;                       /* arguments, not evaluated but kept for
+                                                                * benefit of EXPLAIN etc. */
+       List       *refs;                       /* ressortgrouprefs of arguments */
+       List       *cols;                       /* actual column positions set by planner */
+       Index           agglevelsup;    /* same as Aggref.agglevelsup */
+       int                     location;               /* token location */
+} GroupingFunc;
+
 /*
  * WindowFunc
  */
@@ -230,7 +314,10 @@ typedef struct WindowFunc
        Expr            xpr;
        Oid                     winfnoid;               /* pg_proc Oid of the function */
        Oid                     wintype;                /* type Oid of result of the window function */
+       Oid                     wincollid;              /* OID of collation of result */
+       Oid                     inputcollid;    /* OID of collation that function should use */
        List       *args;                       /* arguments to the window function */
+       Expr       *aggfilter;          /* FILTER expression, if any */
        Index           winref;                 /* index of associated WindowClause */
        bool            winstar;                /* TRUE if argument list was really '*' */
        bool            winagg;                 /* is function a simple aggregate? */
@@ -248,7 +335,7 @@ typedef struct WindowFunc
  * entire new modified array value.
  *
  * If reflowerindexpr = NIL, then we are fetching or storing a single array
- * element at the subscripts given by refupperindexpr. Otherwise we are
+ * element at the subscripts given by refupperindexpr.  Otherwise we are
  * fetching or storing an array slice, that is a rectangular subarray
  * with lower and upper bounds given by the index expressions.
  * reflowerindexpr must be the same length as refupperindexpr when it
@@ -257,6 +344,10 @@ typedef struct WindowFunc
  * Note: the result datatype is the element type when fetching a single
  * element; but it is the array type when doing subarray fetch or either
  * type of store.
+ *
+ * Note: for the cases where an array is returned, if refexpr yields a R/W
+ * expanded array, then the implementation is allowed to modify that object
+ * in-place and return the same object.)
  * ----------------
  */
 typedef struct ArrayRef
@@ -265,6 +356,7 @@ typedef struct ArrayRef
        Oid                     refarraytype;   /* type of the array proper */
        Oid                     refelemtype;    /* type of the array elements */
        int32           reftypmod;              /* typmod of the array (and elements too) */
+       Oid                     refcollid;              /* OID of collation, or InvalidOid if none */
        List       *refupperindexpr;/* expressions that evaluate to upper array
                                                                 * indexes */
        List       *reflowerindexpr;/* expressions that evaluate to lower array
@@ -289,14 +381,19 @@ typedef enum CoercionContext
 } CoercionContext;
 
 /*
- * CoercionForm - information showing how to display a function-call node
+ * CoercionForm - how to display a node that could have come from a cast
+ *
+ * NB: equal() ignores CoercionForm fields, therefore this *must* not carry
+ * any semantically significant information.  We need that behavior so that
+ * the planner will consider equivalent implicit and explicit casts to be
+ * equivalent.  In cases where those actually behave differently, the coercion
+ * function's arguments will be different.
  */
 typedef enum CoercionForm
 {
        COERCE_EXPLICIT_CALL,           /* display as a function call */
        COERCE_EXPLICIT_CAST,           /* display as an explicit cast */
-       COERCE_IMPLICIT_CAST,           /* implicit cast, so hide it */
-       COERCE_DONTCARE                         /* special case for planner */
+       COERCE_IMPLICIT_CAST            /* implicit cast, so hide it */
 } CoercionForm;
 
 /*
@@ -308,11 +405,38 @@ typedef struct FuncExpr
        Oid                     funcid;                 /* PG_PROC OID of the function */
        Oid                     funcresulttype; /* PG_TYPE OID of result value */
        bool            funcretset;             /* true if function returns set */
+       bool            funcvariadic;   /* true if variadic arguments have been
+                                                                * combined into an array last argument */
        CoercionForm funcformat;        /* how to display this function call */
+       Oid                     funccollid;             /* OID of collation of result */
+       Oid                     inputcollid;    /* OID of collation that function should use */
        List       *args;                       /* arguments to the function */
        int                     location;               /* token location, or -1 if unknown */
 } FuncExpr;
 
+/*
+ * NamedArgExpr - a named argument of a function
+ *
+ * This node type can only appear in the args list of a FuncCall or FuncExpr
+ * node.  We support pure positional call notation (no named arguments),
+ * named notation (all arguments are named), and mixed notation (unnamed
+ * arguments followed by named ones).
+ *
+ * Parse analysis sets argnumber to the positional index of the argument,
+ * but doesn't rearrange the argument list.
+ *
+ * The planner will convert argument lists to pure positional notation
+ * during expression preprocessing, so execution never sees a NamedArgExpr.
+ */
+typedef struct NamedArgExpr
+{
+       Expr            xpr;
+       Expr       *arg;                        /* the argument expression */
+       char       *name;                       /* the name */
+       int                     argnumber;              /* argument's number in positional notation */
+       int                     location;               /* argument name location, or -1 if unknown */
+} NamedArgExpr;
+
 /*
  * OpExpr - expression node for an operator invocation
  *
@@ -329,6 +453,8 @@ typedef struct OpExpr
        Oid                     opfuncid;               /* PG_PROC OID of underlying function */
        Oid                     opresulttype;   /* PG_TYPE OID of result value */
        bool            opretset;               /* true if operator returns set */
+       Oid                     opcollid;               /* OID of collation of result */
+       Oid                     inputcollid;    /* OID of collation that operator should use */
        List       *args;                       /* arguments to the operator (1 or 2) */
        int                     location;               /* token location, or -1 if unknown */
 } OpExpr;
@@ -345,6 +471,14 @@ typedef struct OpExpr
  */
 typedef OpExpr DistinctExpr;
 
+/*
+ * NullIfExpr - a NULLIF expression
+ *
+ * Like DistinctExpr, this is represented the same as an OpExpr referencing
+ * the "=" operator for x and y.
+ */
+typedef OpExpr NullIfExpr;
+
 /*
  * ScalarArrayOpExpr - expression node for "scalar op ANY/ALL (array)"
  *
@@ -353,7 +487,7 @@ typedef OpExpr DistinctExpr;
  * with OR or AND (for ANY or ALL respectively).  The node representation
  * is almost the same as for the underlying operator, but we need a useOr
  * flag to remember whether it's ANY or ALL, and we don't have to store
- * the result type because it must be boolean.
+ * the result type (or the collation) because it must be boolean.
  */
 typedef struct ScalarArrayOpExpr
 {
@@ -361,6 +495,7 @@ typedef struct ScalarArrayOpExpr
        Oid                     opno;                   /* PG_OPERATOR OID of the operator */
        Oid                     opfuncid;               /* PG_PROC OID of underlying function */
        bool            useOr;                  /* true for ANY, false for ALL */
+       Oid                     inputcollid;    /* OID of collation that operator should use */
        List       *args;                       /* the scalar and array operands */
        int                     location;               /* token location, or -1 if unknown */
 } ScalarArrayOpExpr;
@@ -369,12 +504,8 @@ typedef struct ScalarArrayOpExpr
  * BoolExpr - expression node for the basic Boolean operators AND, OR, NOT
  *
  * Notice the arguments are given as a List.  For NOT, of course the list
- * must always have exactly one element.  For AND and OR, the executor can
- * handle any number of arguments.  The parser generally treats AND and OR
- * as binary and so it typically only produces two-element lists, but the
- * optimizer will flatten trees of AND and OR nodes to produce longer lists
- * when possible.  There are also a few special cases where more arguments
- * can appear before optimization.
+ * must always have exactly one element.  For AND and OR, there can be two
+ * or more arguments.
  */
 typedef enum BoolExprType
 {
@@ -393,21 +524,23 @@ typedef struct BoolExpr
  * SubLink
  *
  * A SubLink represents a subselect appearing in an expression, and in some
- * cases also the combining operator(s) just above it. The subLinkType
+ * cases also the combining operator(s) just above it.  The subLinkType
  * indicates the form of the expression represented:
  *     EXISTS_SUBLINK          EXISTS(SELECT ...)
  *     ALL_SUBLINK                     (lefthand) op ALL (SELECT ...)
  *     ANY_SUBLINK                     (lefthand) op ANY (SELECT ...)
  *     ROWCOMPARE_SUBLINK      (lefthand) op (SELECT ...)
  *     EXPR_SUBLINK            (SELECT with single targetlist item ...)
+ *     MULTIEXPR_SUBLINK       (SELECT with multiple targetlist items ...)
  *     ARRAY_SUBLINK           ARRAY(SELECT with single targetlist item ...)
  *     CTE_SUBLINK                     WITH query (never actually part of an expression)
  * For ALL, ANY, and ROWCOMPARE, the lefthand is a list of expressions of the
  * same length as the subselect's targetlist.  ROWCOMPARE will *always* have
  * a list with more than one entry; if the subselect has just one target
  * then the parser will create an EXPR_SUBLINK instead (and any operator
- * above the subselect will be represented separately).  Note that both
- * ROWCOMPARE and EXPR require the subselect to deliver only one row.
+ * above the subselect will be represented separately).
+ * ROWCOMPARE, EXPR, and MULTIEXPR require the subselect to deliver at most
+ * one row (if it returns no rows, the result is NULL).
  * ALL, ANY, and ROWCOMPARE require the combining operators to deliver boolean
  * results.  ALL and ANY combine the per-row results using AND and OR
  * semantics respectively.
@@ -420,14 +553,20 @@ typedef struct BoolExpr
  *
  * NOTE: in the raw output of gram.y, testexpr contains just the raw form
  * of the lefthand expression (if any), and operName is the String name of
- * the combining operator.     Also, subselect is a raw parsetree.  During parse
+ * the combining operator.  Also, subselect is a raw parsetree.  During parse
  * analysis, the parser transforms testexpr into a complete boolean expression
  * that compares the lefthand value(s) to PARAM_SUBLINK nodes representing the
  * output columns of the subselect.  And subselect is transformed to a Query.
  * This is the representation seen in saved rules and in the rewriter.
  *
- * In EXISTS, EXPR, and ARRAY SubLinks, testexpr and operName are unused and
- * are always null.
+ * In EXISTS, EXPR, MULTIEXPR, and ARRAY SubLinks, testexpr and operName
+ * are unused and are always null.
+ *
+ * subLinkId is currently used only for MULTIEXPR SubLinks, and is zero in
+ * other SubLinks.  This number identifies different multiple-assignment
+ * subqueries within an UPDATE statement's SET list.  It is unique only
+ * within a particular targetlist.  The output column(s) of the MULTIEXPR
+ * are referenced by PARAM_MULTIEXPR Params appearing elsewhere in the tlist.
  *
  * The CTE_SUBLINK case never occurs in actual SubLink nodes, but it is used
  * in SubPlans generated for WITH subqueries.
@@ -439,6 +578,7 @@ typedef enum SubLinkType
        ANY_SUBLINK,
        ROWCOMPARE_SUBLINK,
        EXPR_SUBLINK,
+       MULTIEXPR_SUBLINK,
        ARRAY_SUBLINK,
        CTE_SUBLINK                                     /* for SubPlans only */
 } SubLinkType;
@@ -448,9 +588,10 @@ typedef struct SubLink
 {
        Expr            xpr;
        SubLinkType subLinkType;        /* see above */
+       int                     subLinkId;              /* ID (1..n); 0 if not MULTIEXPR */
        Node       *testexpr;           /* outer-query test for ALL/ANY/ROWCOMPARE */
        List       *operName;           /* originally specified operator name */
-       Node       *subselect;          /* subselect as Query* or parsetree */
+       Node       *subselect;          /* subselect as Query* or raw parsetree */
        int                     location;               /* token location, or -1 if unknown */
 } SubLink;
 
@@ -478,7 +619,7 @@ typedef struct SubLink
  * list).  In this case testexpr is NULL to avoid duplication.
  *
  * The planner also derives lists of the values that need to be passed into
- * and out of the subplan.     Input values are represented as a list "args" of
+ * and out of the subplan.  Input values are represented as a list "args" of
  * expressions to be evaluated in the outer-query context (currently these
  * args are always just Vars, but in principle they could be any expression).
  * The values are assigned to the global PARAM_EXEC params indexed by parParam
@@ -502,8 +643,13 @@ typedef struct SubPlan
        List       *paramIds;           /* IDs of Params embedded in the above */
        /* Identification of the Plan tree to use: */
        int                     plan_id;                /* Index (from 1) in PlannedStmt.subplans */
+       /* Identification of the SubPlan for EXPLAIN and debugging purposes: */
+       char       *plan_name;          /* A name assigned during planning */
        /* Extra data useful for determining subplan's output type: */
        Oid                     firstColType;   /* Type of first column of subplan result */
+       int32           firstColTypmod; /* Typmod of first column of subplan result */
+       Oid                     firstColCollation;              /* Collation of first column of
+                                                                                * subplan result */
        /* Information about execution strategy: */
        bool            useHashTable;   /* TRUE to store subselect output in a hash
                                                                 * table (implies we are doing "IN") */
@@ -552,6 +698,7 @@ typedef struct FieldSelect
        Oid                     resulttype;             /* type of the field (result type of this
                                                                 * node) */
        int32           resulttypmod;   /* output typmod (usually -1) */
+       Oid                     resultcollid;   /* OID of collation of the field */
 } FieldSelect;
 
 /* ----------------
@@ -563,7 +710,7 @@ typedef struct FieldSelect
  * portion of a column.
  *
  * A single FieldStore can actually represent updates of several different
- * fields.     The parser only generates FieldStores with single-element lists,
+ * fields.  The parser only generates FieldStores with single-element lists,
  * but the planner will collapse multiple updates of the same base column
  * into one FieldStore.
  * ----------------
@@ -576,7 +723,7 @@ typedef struct FieldStore
        List       *newvals;            /* new value(s) for field(s) */
        List       *fieldnums;          /* integer list of field attnums */
        Oid                     resulttype;             /* type of result (same as type of arg) */
-       /* Like RowExpr, we deliberately omit a typmod here */
+       /* Like RowExpr, we deliberately omit a typmod and collation here */
 } FieldStore;
 
 /* ----------------
@@ -598,6 +745,7 @@ typedef struct RelabelType
        Expr       *arg;                        /* input expression */
        Oid                     resulttype;             /* output type of coercion expression */
        int32           resulttypmod;   /* output typmod (usually -1) */
+       Oid                     resultcollid;   /* OID of collation, or InvalidOid if none */
        CoercionForm relabelformat; /* how to display this node */
        int                     location;               /* token location, or -1 if unknown */
 } RelabelType;
@@ -617,6 +765,7 @@ typedef struct CoerceViaIO
        Expr       *arg;                        /* input expression */
        Oid                     resulttype;             /* output type of coercion */
        /* output typmod is not stored, but is presumed -1 */
+       Oid                     resultcollid;   /* OID of collation, or InvalidOid if none */
        CoercionForm coerceformat;      /* how to display this node */
        int                     location;               /* token location, or -1 if unknown */
 } CoerceViaIO;
@@ -640,6 +789,7 @@ typedef struct ArrayCoerceExpr
        Oid                     elemfuncid;             /* OID of element coercion function, or 0 */
        Oid                     resulttype;             /* output type of coercion (an array type) */
        int32           resulttypmod;   /* output typmod (also element typmod) */
+       Oid                     resultcollid;   /* OID of collation, or InvalidOid if none */
        bool            isExplicit;             /* conversion semantics flag to pass to func */
        CoercionForm coerceformat;      /* how to display this node */
        int                     location;               /* token location, or -1 if unknown */
@@ -662,11 +812,26 @@ typedef struct ConvertRowtypeExpr
        Expr            xpr;
        Expr       *arg;                        /* input expression */
        Oid                     resulttype;             /* output type (always a composite type) */
-       /* result typmod is not stored, but must be -1; see RowExpr comments */
+       /* Like RowExpr, we deliberately omit a typmod and collation here */
        CoercionForm convertformat; /* how to display this node */
        int                     location;               /* token location, or -1 if unknown */
 } ConvertRowtypeExpr;
 
+/*----------
+ * CollateExpr - COLLATE
+ *
+ * The planner replaces CollateExpr with RelabelType during expression
+ * preprocessing, so execution never sees a CollateExpr.
+ *----------
+ */
+typedef struct CollateExpr
+{
+       Expr            xpr;
+       Expr       *arg;                        /* input expression */
+       Oid                     collOid;                /* collation's OID */
+       int                     location;               /* token location, or -1 if unknown */
+} CollateExpr;
+
 /*----------
  * CaseExpr - a CASE expression
  *
@@ -677,7 +842,7 @@ typedef struct ConvertRowtypeExpr
  * and the testexpr in the second case.
  *
  * In the raw grammar output for the second form, the condition expressions
- * of the WHEN clauses are just the comparison values. Parse analysis
+ * of the WHEN clauses are just the comparison values.  Parse analysis
  * converts these to valid boolean expressions of the form
  *             CaseTestExpr '=' compexpr
  * where the CaseTestExpr node is a placeholder that emits the correct
@@ -693,6 +858,7 @@ typedef struct CaseExpr
 {
        Expr            xpr;
        Oid                     casetype;               /* type of expression result */
+       Oid                     casecollid;             /* OID of collation, or InvalidOid if none */
        Expr       *arg;                        /* implicit equality comparison argument */
        List       *args;                       /* the arguments (list of WHEN clauses) */
        Expr       *defresult;          /* the default result (ELSE clause) */
@@ -723,6 +889,7 @@ typedef struct CaseTestExpr
        Expr            xpr;
        Oid                     typeId;                 /* type for substituted value */
        int32           typeMod;                /* typemod for substituted value */
+       Oid                     collation;              /* collation for the substituted value */
 } CaseTestExpr;
 
 /*
@@ -737,6 +904,7 @@ typedef struct ArrayExpr
 {
        Expr            xpr;
        Oid                     array_typeid;   /* type of expression result */
+       Oid                     array_collid;   /* OID of collation, or InvalidOid if none */
        Oid                     element_typeid; /* common type of array elements */
        List       *elements;           /* the array elements or sub-arrays */
        bool            multidims;              /* true if elements are sub-arrays */
@@ -748,19 +916,23 @@ typedef struct ArrayExpr
  *
  * Note: the list of fields must have a one-for-one correspondence with
  * physical fields of the associated rowtype, although it is okay for it
- * to be shorter than the rowtype.     That is, the N'th list element must
+ * to be shorter than the rowtype.  That is, the N'th list element must
  * match up with the N'th physical field.  When the N'th physical field
  * is a dropped column (attisdropped) then the N'th list element can just
- * be a NULL constant. (This case can only occur for named composite types,
+ * be a NULL constant.  (This case can only occur for named composite types,
  * not RECORD types, since those are built from the RowExpr itself rather
  * than vice versa.)  It is important not to assume that length(args) is
  * the same as the number of columns logically present in the rowtype.
  *
- * colnames is NIL in a RowExpr built from an ordinary ROW() expression.
- * It is provided in cases where we expand a whole-row Var into a RowExpr,
- * to retain the column alias names of the RTE that the Var referenced
- * (which would otherwise be very difficult to extract from the parsetree).
- * Like the args list, it is one-for-one with physical fields of the rowtype.
+ * colnames provides field names in cases where the names can't easily be
+ * obtained otherwise.  Names *must* be provided if row_typeid is RECORDOID.
+ * If row_typeid identifies a known composite type, colnames can be NIL to
+ * indicate the type's cataloged field names apply.  Note that colnames can
+ * be non-NIL even for a composite type, and typically is when the RowExpr
+ * was created by expanding a whole-row Var.  This is so that we can retain
+ * the column alias names of the RTE that the Var referenced (which would
+ * otherwise be very difficult to extract from the parsetree).  Like the
+ * args list, colnames is one-for-one with physical fields of the rowtype.
  */
 typedef struct RowExpr
 {
@@ -772,7 +944,10 @@ typedef struct RowExpr
         * Note: we deliberately do NOT store a typmod.  Although a typmod will be
         * associated with specific RECORD types at runtime, it will differ for
         * different backends, and so cannot safely be stored in stored
-        * parsetrees.  We must assume typmod -1 for a RowExpr node.
+        * parsetrees.  We must assume typmod -1 for a RowExpr node.
+        *
+        * We don't need to store a collation either.  The result type is
+        * necessarily composite, and composite types never have a collation.
         */
        CoercionForm row_format;        /* how to display this node */
        List       *colnames;           /* list of String, or NIL */
@@ -810,6 +985,7 @@ typedef struct RowCompareExpr
        RowCompareType rctype;          /* LT LE GE or GT, never EQ or NE */
        List       *opnos;                      /* OID list of pairwise comparison ops */
        List       *opfamilies;         /* OID list of containing operator families */
+       List       *inputcollids;       /* OID list of collations for comparisons */
        List       *largs;                      /* the left-hand input arguments */
        List       *rargs;                      /* the right-hand input arguments */
 } RowCompareExpr;
@@ -821,6 +997,7 @@ typedef struct CoalesceExpr
 {
        Expr            xpr;
        Oid                     coalescetype;   /* type of expression result */
+       Oid                     coalescecollid; /* OID of collation, or InvalidOid if none */
        List       *args;                       /* the arguments */
        int                     location;               /* token location, or -1 if unknown */
 } CoalesceExpr;
@@ -838,6 +1015,8 @@ typedef struct MinMaxExpr
 {
        Expr            xpr;
        Oid                     minmaxtype;             /* common type of arguments and result */
+       Oid                     minmaxcollid;   /* OID of collation of result */
+       Oid                     inputcollid;    /* OID of collation that function should use */
        MinMaxOp        op;                             /* function to execute */
        List       *args;                       /* the arguments */
        int                     location;               /* token location, or -1 if unknown */
@@ -849,6 +1028,10 @@ typedef struct MinMaxExpr
  * 'name' carries the "NAME foo" argument (already XML-escaped).
  * 'named_args' and 'arg_names' represent an xml_attribute list.
  * 'args' carries all other arguments.
+ *
+ * Note: result type/typmod/collation are not stored, but can be deduced
+ * from the XmlExprOp.  The type/typmod fields are just used for display
+ * purposes, and are NOT necessarily the true result type of the node.
  */
 typedef enum XmlExprOp
 {
@@ -877,19 +1060,11 @@ typedef struct XmlExpr
        List       *arg_names;          /* parallel list of Value strings */
        List       *args;                       /* list of expressions */
        XmlOptionType xmloption;        /* DOCUMENT or CONTENT */
-       Oid                     type;                   /* target type for XMLSERIALIZE */
+       Oid                     type;                   /* target type/typmod for XMLSERIALIZE */
        int32           typmod;
        int                     location;               /* token location, or -1 if unknown */
 } XmlExpr;
 
-/*
- * NullIfExpr - a NULLIF expression
- *
- * Like DistinctExpr, this is represented the same as an OpExpr referencing
- * the "=" operator for x and y.
- */
-typedef OpExpr NullIfExpr;
-
 /* ----------------
  * NullTest
  *
@@ -897,9 +1072,7 @@ typedef OpExpr NullIfExpr;
  * The appropriate test is performed and returned as a boolean Datum.
  *
  * NOTE: the semantics of this for rowtype inputs are noticeably different
- * from the scalar case.  It would probably be a good idea to include an
- * "argisrow" flag in the struct to reflect that, but for the moment,
- * we do not do so to avoid forcing an initdb during 8.2beta.
+ * from the scalar case.  We provide an "argisrow" flag to reflect that.
  * ----------------
  */
 
@@ -913,6 +1086,8 @@ typedef struct NullTest
        Expr            xpr;
        Expr       *arg;                        /* input expression */
        NullTestType nulltesttype;      /* IS NULL, IS NOT NULL */
+       bool            argisrow;               /* T if input is of a composite type */
+       int                     location;               /* token location, or -1 if unknown */
 } NullTest;
 
 /*
@@ -934,6 +1109,7 @@ typedef struct BooleanTest
        Expr            xpr;
        Expr       *arg;                        /* input expression */
        BoolTestType booltesttype;      /* test type */
+       int                     location;               /* token location, or -1 if unknown */
 } BooleanTest;
 
 /*
@@ -941,8 +1117,8 @@ typedef struct BooleanTest
  *
  * CoerceToDomain represents the operation of coercing a value to a domain
  * type.  At runtime (and not before) the precise set of constraints to be
- * checked will be determined. If the value passes, it is returned as the
- * result; if not, an error is raised. Note that this is equivalent to
+ * checked will be determined.  If the value passes, it is returned as the
+ * result; if not, an error is raised.  Note that this is equivalent to
  * RelabelType in the scenario where no constraints are applied.
  */
 typedef struct CoerceToDomain
@@ -951,24 +1127,26 @@ typedef struct CoerceToDomain
        Expr       *arg;                        /* input expression */
        Oid                     resulttype;             /* domain type ID (result type) */
        int32           resulttypmod;   /* output typmod (currently always -1) */
+       Oid                     resultcollid;   /* OID of collation, or InvalidOid if none */
        CoercionForm coercionformat;    /* how to display this node */
        int                     location;               /* token location, or -1 if unknown */
 } CoerceToDomain;
 
 /*
  * Placeholder node for the value to be processed by a domain's check
- * constraint. This is effectively like a Param, but can be implemented more
+ * constraint.  This is effectively like a Param, but can be implemented more
  * simply since we need only one replacement value at a time.
  *
- * Note: the typeId/typeMod will be set from the domain's base type, not
- * the domain itself.  This is because we shouldn't consider the value to
- * be a member of the domain if we haven't yet checked its constraints.
+ * Note: the typeId/typeMod/collation will be set from the domain's base type,
+ * not the domain itself.  This is because we shouldn't consider the value
+ * to be a member of the domain if we haven't yet checked its constraints.
  */
 typedef struct CoerceToDomainValue
 {
        Expr            xpr;
        Oid                     typeId;                 /* type for substituted value */
        int32           typeMod;                /* typemod for substituted value */
+       Oid                     collation;              /* collation for the substituted value */
        int                     location;               /* token location, or -1 if unknown */
 } CoerceToDomainValue;
 
@@ -976,7 +1154,7 @@ typedef struct CoerceToDomainValue
  * Placeholder node for a DEFAULT marker in an INSERT or UPDATE command.
  *
  * This is not an executable expression: it must be replaced by the actual
- * column default expression during rewriting. But it is convenient to
+ * column default expression during rewriting.  But it is convenient to
  * treat it as an expression node during parsing and rewriting.
  */
 typedef struct SetToDefault
@@ -984,6 +1162,7 @@ typedef struct SetToDefault
        Expr            xpr;
        Oid                     typeId;                 /* type for substituted value */
        int32           typeMod;                /* typemod for substituted value */
+       Oid                     collation;              /* collation for the substituted value */
        int                     location;               /* token location, or -1 if unknown */
 } SetToDefault;
 
@@ -1007,6 +1186,22 @@ typedef struct CurrentOfExpr
        int                     cursor_param;   /* refcursor parameter number, or 0 */
 } CurrentOfExpr;
 
+/*
+ * InferenceElem - an element of a unique index inference specification
+ *
+ * This mostly matches the structure of IndexElems, but having a dedicated
+ * primnode allows for a clean separation between the use of index parameters
+ * by utility commands, and this node.
+ */
+typedef struct InferenceElem
+{
+       Expr            xpr;
+       Node       *expr;                               /* expression to infer from, or NULL */
+       Oid                     infercollid;            /* OID of collation, or InvalidOid */
+       Oid                     inferopfamily;          /* OID of att opfamily, or InvalidOid */
+       Oid                     inferopcinputtype;      /* OID of att input type, or InvalidOid */
+} InferenceElem;
+
 /*--------------------
  * TargetEntry -
  *        a target entry (used in query target lists)
@@ -1017,14 +1212,14 @@ typedef struct CurrentOfExpr
  * single expression tree.
  *
  * In a SELECT's targetlist, resno should always be equal to the item's
- * ordinal position (counting from 1). However, in an INSERT or UPDATE
+ * ordinal position (counting from 1).  However, in an INSERT or UPDATE
  * targetlist, resno represents the attribute number of the destination
  * column for the item; so there may be missing or out-of-order resnos.
  * It is even legal to have duplicated resnos; consider
  *             UPDATE table SET arraycol[1] = ..., arraycol[2] = ..., ...
  * The two meanings come together in the executor, because the planner
  * transforms INSERT/UPDATE tlists into a normalized form with exactly
- * one entry for each column of the destination table. Before that's
+ * one entry for each column of the destination table.  Before that's
  * happened, however, it is risky to assume that resno == position.
  * Generally get_tle_by_resno() should be used rather than list_nth()
  * to fetch tlist entries by resno, and only in SELECT should you assume
@@ -1033,9 +1228,9 @@ typedef struct CurrentOfExpr
  * resname is required to represent the correct column name in non-resjunk
  * entries of top-level SELECT targetlists, since it will be used as the
  * column title sent to the frontend.  In most other contexts it is only
- * a debugging aid, and may be wrong or even NULL.     (In particular, it may
+ * a debugging aid, and may be wrong or even NULL.  (In particular, it may
  * be wrong in a tlist from a stored rule, if the referenced column has been
- * renamed by ALTER TABLE since the rule was made.     Also, the planner tends
+ * renamed by ALTER TABLE since the rule was made.  Also, the planner tends
  * to store NULL rather than look up a valid name for tlist entries in
  * non-toplevel plan nodes.)  In resjunk entries, resname should be either
  * a specific system-generated name (such as "ctid") or NULL; anything else
@@ -1051,7 +1246,7 @@ typedef struct CurrentOfExpr
  * The order of the associated SortGroupClause lists determine the semantics.
  *
  * resorigtbl/resorigcol identify the source of the column, if it is a
- * simple reference to a column of a base table (or view).     If it is not
+ * simple reference to a column of a base table (or view).  If it is not
  * a simple reference, these fields are zeroes.
  *
  * If resjunk is true then the column is a working column (such as a sort key)
@@ -1091,7 +1286,7 @@ typedef struct TargetEntry
  *
  * NOTE: the qualification expressions present in JoinExpr nodes are
  * *in addition to* the query's main WHERE clause, which appears as the
- * qual of the top-level FromExpr.     The reason for associating quals with
+ * qual of the top-level FromExpr.  The reason for associating quals with
  * specific nodes in the jointree is that the position of a qual is critical
  * when outer joins are present.  (If we enforce a qual too soon or too late,
  * that may cause the outer join to produce the wrong set of NULL-extended
@@ -1122,12 +1317,12 @@ typedef struct RangeTblRef
 /*----------
  * JoinExpr - for SQL JOIN expressions
  *
- * isNatural, using, and quals are interdependent.     The user can write only
- * one of NATURAL, USING(), or ON() (this is enforced by the grammar).
+ * isNatural, usingClause, and quals are interdependent.  The user can write
+ * only one of NATURAL, USING(), or ON() (this is enforced by the grammar).
  * If he writes NATURAL then parse analysis generates the equivalent USING()
  * list, and from that fills in "quals" with the right equality comparisons.
  * If he writes USING() then "quals" is filled with equality comparisons.
- * If he writes ON() then only "quals" is set. Note that NATURAL/USING
+ * If he writes ON() then only "quals" is set.  Note that NATURAL/USING
  * are not equivalent to ON() since they also affect the output column list.
  *
  * alias is an Alias node representing the AS alias-clause attached to the
@@ -1136,7 +1331,7 @@ typedef struct RangeTblRef
  * restricts visibility of the tables/columns inside it.
  *
  * During parse analysis, an RTE is created for the Join, and its index
- * is filled into rtindex.     This RTE is present mainly so that Vars can
+ * is filled into rtindex.  This RTE is present mainly so that Vars can
  * be created that refer to the outputs of the join.  The planner sometimes
  * generates JoinExprs internally; these can have rtindex = 0 if there are
  * no join alias variables referencing such joins.
@@ -1149,7 +1344,7 @@ typedef struct JoinExpr
        bool            isNatural;              /* Natural join? Will need to shape table */
        Node       *larg;                       /* left subtree */
        Node       *rarg;                       /* right subtree */
-       List       *using;                      /* USING clause, if any (list of String) */
+       List       *usingClause;        /* USING clause, if any (list of String) */
        Node       *quals;                      /* qualifiers on join, if any */
        Alias      *alias;                      /* user-written alias clause, if any */
        int                     rtindex;                /* RT index assigned for join, or 0 */
@@ -1171,4 +1366,30 @@ typedef struct FromExpr
        Node       *quals;                      /* qualifiers on join, if any */
 } FromExpr;
 
+/*----------
+ * OnConflictExpr - represents an ON CONFLICT DO ... expression
+ *
+ * The optimizer requires a list of inference elements, and optionally a WHERE
+ * clause to infer a unique index.  The unique index (or, occasionally,
+ * indexes) inferred are used to arbitrate whether or not the alternative ON
+ * CONFLICT path is taken.
+ *----------
+ */
+typedef struct OnConflictExpr
+{
+       NodeTag         type;
+       OnConflictAction action;        /* DO NOTHING or UPDATE? */
+
+       /* Arbiter */
+       List       *arbiterElems;       /* unique index arbiter list (of InferenceElem's) */
+       Node       *arbiterWhere;       /* unique index arbiter WHERE clause */
+       Oid                     constraint;             /* pg_constraint OID for arbiter */
+
+       /* ON CONFLICT UPDATE */
+       List       *onConflictSet;      /* List of ON CONFLICT SET TargetEntrys */
+       Node       *onConflictWhere;/* qualifiers to restrict UPDATE to */
+       int                     exclRelIndex;   /* RT index of 'excluded' relation */
+       List       *exclRelTlist;       /* tlist of the EXCLUDED pseudo relation */
+} OnConflictExpr;
+
 #endif   /* PRIMNODES_H */