PostgreSQL Source Code  git master
parsenodes.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * parsenodes.h
4  * definitions for parse tree nodes
5  *
6  * Many of the node types used in parsetrees include a "location" field.
7  * This is a byte (not character) offset in the original source text, to be
8  * used for positioning an error cursor when there is an error related to
9  * the node. Access to the original source text is needed to make use of
10  * the location. At the topmost (statement) level, we also provide a
11  * statement length, likewise measured in bytes, for convenience in
12  * identifying statement boundaries in multi-statement source strings.
13  *
14  *
15  * Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
16  * Portions Copyright (c) 1994, Regents of the University of California
17  *
18  * src/include/nodes/parsenodes.h
19  *
20  *-------------------------------------------------------------------------
21  */
22 #ifndef PARSENODES_H
23 #define PARSENODES_H
24 
25 #include "nodes/bitmapset.h"
26 #include "nodes/lockoptions.h"
27 #include "nodes/primnodes.h"
28 #include "nodes/value.h"
29 #include "partitioning/partdefs.h"
30 
31 
32 typedef enum OverridingKind
33 {
38 
39 /* Possible sources of a Query */
40 typedef enum QuerySource
41 {
42  QSRC_ORIGINAL, /* original parsetree (explicit query) */
43  QSRC_PARSER, /* added by parse analysis (now unused) */
44  QSRC_INSTEAD_RULE, /* added by unconditional INSTEAD rule */
45  QSRC_QUAL_INSTEAD_RULE, /* added by conditional INSTEAD rule */
46  QSRC_NON_INSTEAD_RULE /* added by non-INSTEAD rule */
47 } QuerySource;
48 
49 /* Sort ordering options for ORDER BY and CREATE INDEX */
50 typedef enum SortByDir
51 {
55  SORTBY_USING /* not allowed in CREATE INDEX ... */
56 } SortByDir;
57 
58 typedef enum SortByNulls
59 {
63 } SortByNulls;
64 
65 /*
66  * Grantable rights are encoded so that we can OR them together in a bitmask.
67  * The present representation of AclItem limits us to 16 distinct rights,
68  * even though AclMode is defined as uint32. See utils/acl.h.
69  *
70  * Caution: changing these codes breaks stored ACLs, hence forces initdb.
71  */
72 typedef uint32 AclMode; /* a bitmask of privilege bits */
73 
74 #define ACL_INSERT (1<<0) /* for relations */
75 #define ACL_SELECT (1<<1)
76 #define ACL_UPDATE (1<<2)
77 #define ACL_DELETE (1<<3)
78 #define ACL_TRUNCATE (1<<4)
79 #define ACL_REFERENCES (1<<5)
80 #define ACL_TRIGGER (1<<6)
81 #define ACL_EXECUTE (1<<7) /* for functions */
82 #define ACL_USAGE (1<<8) /* for languages, namespaces, FDWs, and
83  * servers */
84 #define ACL_CREATE (1<<9) /* for namespaces and databases */
85 #define ACL_CREATE_TEMP (1<<10) /* for databases */
86 #define ACL_CONNECT (1<<11) /* for databases */
87 #define N_ACL_RIGHTS 12 /* 1 plus the last 1<<x */
88 #define ACL_NO_RIGHTS 0
89 /* Currently, SELECT ... FOR [KEY] UPDATE/SHARE requires UPDATE privileges */
90 #define ACL_SELECT_FOR_UPDATE ACL_UPDATE
91 
92 
93 /*****************************************************************************
94  * Query Tree
95  *****************************************************************************/
96 
97 /*
98  * Query -
99  * Parse analysis turns all statements into a Query tree
100  * for further processing by the rewriter and planner.
101  *
102  * Utility statements (i.e. non-optimizable statements) have the
103  * utilityStmt field set, and the rest of the Query is mostly dummy.
104  *
105  * Planning converts a Query tree into a Plan tree headed by a PlannedStmt
106  * node --- the Query structure is not used by the executor.
107  */
108 typedef struct Query
109 {
111 
112  CmdType commandType; /* select|insert|update|delete|utility */
113 
114  QuerySource querySource; /* where did I come from? */
115 
116  uint64 queryId; /* query identifier (can be set by plugins) */
117 
118  bool canSetTag; /* do I set the command result tag? */
119 
120  Node *utilityStmt; /* non-null if commandType == CMD_UTILITY */
121 
122  int resultRelation; /* rtable index of target relation for
123  * INSERT/UPDATE/DELETE; 0 for SELECT */
124 
125  bool hasAggs; /* has aggregates in tlist or havingQual */
126  bool hasWindowFuncs; /* has window functions in tlist */
127  bool hasTargetSRFs; /* has set-returning functions in tlist */
128  bool hasSubLinks; /* has subquery SubLink */
129  bool hasDistinctOn; /* distinctClause is from DISTINCT ON */
130  bool hasRecursive; /* WITH RECURSIVE was specified */
131  bool hasModifyingCTE; /* has INSERT/UPDATE/DELETE in WITH */
132  bool hasForUpdate; /* FOR [KEY] UPDATE/SHARE was specified */
133  bool hasRowSecurity; /* rewriter has applied some RLS policy */
134 
135  List *cteList; /* WITH list (of CommonTableExpr's) */
136 
137  List *rtable; /* list of range table entries */
138  FromExpr *jointree; /* table join tree (FROM and WHERE clauses) */
139 
140  List *targetList; /* target list (of TargetEntry) */
141 
142  OverridingKind override; /* OVERRIDING clause */
143 
144  OnConflictExpr *onConflict; /* ON CONFLICT DO [NOTHING | UPDATE] */
145 
146  List *returningList; /* return-values list (of TargetEntry) */
147 
148  List *groupClause; /* a list of SortGroupClause's */
149 
150  List *groupingSets; /* a list of GroupingSet's if present */
151 
152  Node *havingQual; /* qualifications applied to groups */
153 
154  List *windowClause; /* a list of WindowClause's */
155 
156  List *distinctClause; /* a list of SortGroupClause's */
157 
158  List *sortClause; /* a list of SortGroupClause's */
159 
160  Node *limitOffset; /* # of result tuples to skip (int8 expr) */
161  Node *limitCount; /* # of result tuples to return (int8 expr) */
162 
163  List *rowMarks; /* a list of RowMarkClause's */
164 
165  Node *setOperations; /* set-operation tree if this is top level of
166  * a UNION/INTERSECT/EXCEPT query */
167 
168  List *constraintDeps; /* a list of pg_constraint OIDs that the query
169  * depends on to be semantically valid */
170 
171  List *withCheckOptions; /* a list of WithCheckOption's (added
172  * during rewrite) */
173 
174  /*
175  * The following two fields identify the portion of the source text string
176  * containing this query. They are typically only populated in top-level
177  * Queries, not in sub-queries. When not set, they might both be zero, or
178  * both be -1 meaning "unknown".
179  */
180  int stmt_location; /* start location, or -1 if unknown */
181  int stmt_len; /* length in bytes; 0 means "rest of string" */
182 } Query;
183 
184 
185 /****************************************************************************
186  * Supporting data structures for Parse Trees
187  *
188  * Most of these node types appear in raw parsetrees output by the grammar,
189  * and get transformed to something else by the analyzer. A few of them
190  * are used as-is in transformed querytrees.
191  ****************************************************************************/
192 
193 /*
194  * TypeName - specifies a type in definitions
195  *
196  * For TypeName structures generated internally, it is often easier to
197  * specify the type by OID than by name. If "names" is NIL then the
198  * actual type OID is given by typeOid, otherwise typeOid is unused.
199  * Similarly, if "typmods" is NIL then the actual typmod is expected to
200  * be prespecified in typemod, otherwise typemod is unused.
201  *
202  * If pct_type is true, then names is actually a field name and we look up
203  * the type of that field. Otherwise (the normal case), names is a type
204  * name possibly qualified with schema and database name.
205  */
206 typedef struct TypeName
207 {
209  List *names; /* qualified name (list of Value strings) */
210  Oid typeOid; /* type identified by OID */
211  bool setof; /* is a set? */
212  bool pct_type; /* %TYPE specified? */
213  List *typmods; /* type modifier expression(s) */
214  int32 typemod; /* prespecified type modifier */
215  List *arrayBounds; /* array bounds */
216  int location; /* token location, or -1 if unknown */
217 } TypeName;
218 
219 /*
220  * ColumnRef - specifies a reference to a column, or possibly a whole tuple
221  *
222  * The "fields" list must be nonempty. It can contain string Value nodes
223  * (representing names) and A_Star nodes (representing occurrence of a '*').
224  * Currently, A_Star must appear only as the last list element --- the grammar
225  * is responsible for enforcing this!
226  *
227  * Note: any container subscripting or selection of fields from composite columns
228  * is represented by an A_Indirection node above the ColumnRef. However,
229  * for simplicity in the normal case, initial field selection from a table
230  * name is represented within ColumnRef and not by adding A_Indirection.
231  */
232 typedef struct ColumnRef
233 {
235  List *fields; /* field names (Value strings) or A_Star */
236  int location; /* token location, or -1 if unknown */
237 } ColumnRef;
238 
239 /*
240  * ParamRef - specifies a $n parameter reference
241  */
242 typedef struct ParamRef
243 {
245  int number; /* the number of the parameter */
246  int location; /* token location, or -1 if unknown */
247 } ParamRef;
248 
249 /*
250  * A_Expr - infix, prefix, and postfix expressions
251  */
252 typedef enum A_Expr_Kind
253 {
254  AEXPR_OP, /* normal operator */
255  AEXPR_OP_ANY, /* scalar op ANY (array) */
256  AEXPR_OP_ALL, /* scalar op ALL (array) */
257  AEXPR_DISTINCT, /* IS DISTINCT FROM - name must be "=" */
258  AEXPR_NOT_DISTINCT, /* IS NOT DISTINCT FROM - name must be "=" */
259  AEXPR_NULLIF, /* NULLIF - name must be "=" */
260  AEXPR_OF, /* IS [NOT] OF - name must be "=" or "<>" */
261  AEXPR_IN, /* [NOT] IN - name must be "=" or "<>" */
262  AEXPR_LIKE, /* [NOT] LIKE - name must be "~~" or "!~~" */
263  AEXPR_ILIKE, /* [NOT] ILIKE - name must be "~~*" or "!~~*" */
264  AEXPR_SIMILAR, /* [NOT] SIMILAR - name must be "~" or "!~" */
265  AEXPR_BETWEEN, /* name must be "BETWEEN" */
266  AEXPR_NOT_BETWEEN, /* name must be "NOT BETWEEN" */
267  AEXPR_BETWEEN_SYM, /* name must be "BETWEEN SYMMETRIC" */
268  AEXPR_NOT_BETWEEN_SYM, /* name must be "NOT BETWEEN SYMMETRIC" */
269  AEXPR_PAREN /* nameless dummy node for parentheses */
270 } A_Expr_Kind;
271 
272 typedef struct A_Expr
273 {
275  A_Expr_Kind kind; /* see above */
276  List *name; /* possibly-qualified name of operator */
277  Node *lexpr; /* left argument, or NULL if none */
278  Node *rexpr; /* right argument, or NULL if none */
279  int location; /* token location, or -1 if unknown */
280 } A_Expr;
281 
282 /*
283  * A_Const - a literal constant
284  */
285 typedef struct A_Const
286 {
288  Value val; /* value (includes type info, see value.h) */
289  int location; /* token location, or -1 if unknown */
290 } A_Const;
291 
292 /*
293  * TypeCast - a CAST expression
294  */
295 typedef struct TypeCast
296 {
298  Node *arg; /* the expression being casted */
299  TypeName *typeName; /* the target type */
300  int location; /* token location, or -1 if unknown */
301 } TypeCast;
302 
303 /*
304  * CollateClause - a COLLATE expression
305  */
306 typedef struct CollateClause
307 {
309  Node *arg; /* input expression */
310  List *collname; /* possibly-qualified collation name */
311  int location; /* token location, or -1 if unknown */
312 } CollateClause;
313 
314 /*
315  * RoleSpec - a role name or one of a few special values.
316  */
317 typedef enum RoleSpecType
318 {
319  ROLESPEC_CSTRING, /* role name is stored as a C string */
320  ROLESPEC_CURRENT_USER, /* role spec is CURRENT_USER */
321  ROLESPEC_SESSION_USER, /* role spec is SESSION_USER */
322  ROLESPEC_PUBLIC /* role name is "public" */
323 } RoleSpecType;
324 
325 typedef struct RoleSpec
326 {
328  RoleSpecType roletype; /* Type of this rolespec */
329  char *rolename; /* filled only for ROLESPEC_CSTRING */
330  int location; /* token location, or -1 if unknown */
331 } RoleSpec;
332 
333 /*
334  * FuncCall - a function or aggregate invocation
335  *
336  * agg_order (if not NIL) indicates we saw 'foo(... ORDER BY ...)', or if
337  * agg_within_group is true, it was 'foo(...) WITHIN GROUP (ORDER BY ...)'.
338  * agg_star indicates we saw a 'foo(*)' construct, while agg_distinct
339  * indicates we saw 'foo(DISTINCT ...)'. In any of these cases, the
340  * construct *must* be an aggregate call. Otherwise, it might be either an
341  * aggregate or some other kind of function. However, if FILTER or OVER is
342  * present it had better be an aggregate or window function.
343  *
344  * Normally, you'd initialize this via makeFuncCall() and then only change the
345  * parts of the struct its defaults don't match afterwards, as needed.
346  */
347 typedef struct FuncCall
348 {
350  List *funcname; /* qualified name of function */
351  List *args; /* the arguments (list of exprs) */
352  List *agg_order; /* ORDER BY (list of SortBy) */
353  Node *agg_filter; /* FILTER clause, if any */
354  bool agg_within_group; /* ORDER BY appeared in WITHIN GROUP */
355  bool agg_star; /* argument was really '*' */
356  bool agg_distinct; /* arguments were labeled DISTINCT */
357  bool func_variadic; /* last argument was labeled VARIADIC */
358  struct WindowDef *over; /* OVER clause, if any */
359  int location; /* token location, or -1 if unknown */
360 } FuncCall;
361 
362 /*
363  * A_Star - '*' representing all columns of a table or compound field
364  *
365  * This can appear within ColumnRef.fields, A_Indirection.indirection, and
366  * ResTarget.indirection lists.
367  */
368 typedef struct A_Star
369 {
371 } A_Star;
372 
373 /*
374  * A_Indices - array subscript or slice bounds ([idx] or [lidx:uidx])
375  *
376  * In slice case, either or both of lidx and uidx can be NULL (omitted).
377  * In non-slice case, uidx holds the single subscript and lidx is always NULL.
378  */
379 typedef struct A_Indices
380 {
382  bool is_slice; /* true if slice (i.e., colon present) */
383  Node *lidx; /* slice lower bound, if any */
384  Node *uidx; /* subscript, or slice upper bound if any */
385 } A_Indices;
386 
387 /*
388  * A_Indirection - select a field and/or array element from an expression
389  *
390  * The indirection list can contain A_Indices nodes (representing
391  * subscripting), string Value nodes (representing field selection --- the
392  * string value is the name of the field to select), and A_Star nodes
393  * (representing selection of all fields of a composite type).
394  * For example, a complex selection operation like
395  * (foo).field1[42][7].field2
396  * would be represented with a single A_Indirection node having a 4-element
397  * indirection list.
398  *
399  * Currently, A_Star must appear only as the last list element --- the grammar
400  * is responsible for enforcing this!
401  */
402 typedef struct A_Indirection
403 {
405  Node *arg; /* the thing being selected from */
406  List *indirection; /* subscripts and/or field names and/or * */
407 } A_Indirection;
408 
409 /*
410  * A_ArrayExpr - an ARRAY[] construct
411  */
412 typedef struct A_ArrayExpr
413 {
415  List *elements; /* array element expressions */
416  int location; /* token location, or -1 if unknown */
417 } A_ArrayExpr;
418 
419 /*
420  * ResTarget -
421  * result target (used in target list of pre-transformed parse trees)
422  *
423  * In a SELECT target list, 'name' is the column label from an
424  * 'AS ColumnLabel' clause, or NULL if there was none, and 'val' is the
425  * value expression itself. The 'indirection' field is not used.
426  *
427  * INSERT uses ResTarget in its target-column-names list. Here, 'name' is
428  * the name of the destination column, 'indirection' stores any subscripts
429  * attached to the destination, and 'val' is not used.
430  *
431  * In an UPDATE target list, 'name' is the name of the destination column,
432  * 'indirection' stores any subscripts attached to the destination, and
433  * 'val' is the expression to assign.
434  *
435  * See A_Indirection for more info about what can appear in 'indirection'.
436  */
437 typedef struct ResTarget
438 {
440  char *name; /* column name or NULL */
441  List *indirection; /* subscripts, field names, and '*', or NIL */
442  Node *val; /* the value expression to compute or assign */
443  int location; /* token location, or -1 if unknown */
444 } ResTarget;
445 
446 /*
447  * MultiAssignRef - element of a row source expression for UPDATE
448  *
449  * In an UPDATE target list, when we have SET (a,b,c) = row-valued-expression,
450  * we generate separate ResTarget items for each of a,b,c. Their "val" trees
451  * are MultiAssignRef nodes numbered 1..n, linking to a common copy of the
452  * row-valued-expression (which parse analysis will process only once, when
453  * handling the MultiAssignRef with colno=1).
454  */
455 typedef struct MultiAssignRef
456 {
458  Node *source; /* the row-valued expression */
459  int colno; /* column number for this target (1..n) */
460  int ncolumns; /* number of targets in the construct */
462 
463 /*
464  * SortBy - for ORDER BY clause
465  */
466 typedef struct SortBy
467 {
469  Node *node; /* expression to sort on */
470  SortByDir sortby_dir; /* ASC/DESC/USING/default */
471  SortByNulls sortby_nulls; /* NULLS FIRST/LAST */
472  List *useOp; /* name of op to use, if SORTBY_USING */
473  int location; /* operator location, or -1 if none/unknown */
474 } SortBy;
475 
476 /*
477  * WindowDef - raw representation of WINDOW and OVER clauses
478  *
479  * For entries in a WINDOW list, "name" is the window name being defined.
480  * For OVER clauses, we use "name" for the "OVER window" syntax, or "refname"
481  * for the "OVER (window)" syntax, which is subtly different --- the latter
482  * implies overriding the window frame clause.
483  */
484 typedef struct WindowDef
485 {
487  char *name; /* window's own name */
488  char *refname; /* referenced window name, if any */
489  List *partitionClause; /* PARTITION BY expression list */
490  List *orderClause; /* ORDER BY (list of SortBy) */
491  int frameOptions; /* frame_clause options, see below */
492  Node *startOffset; /* expression for starting bound, if any */
493  Node *endOffset; /* expression for ending bound, if any */
494  int location; /* parse location, or -1 if none/unknown */
495 } WindowDef;
496 
497 /*
498  * frameOptions is an OR of these bits. The NONDEFAULT and BETWEEN bits are
499  * used so that ruleutils.c can tell which properties were specified and
500  * which were defaulted; the correct behavioral bits must be set either way.
501  * The START_foo and END_foo options must come in pairs of adjacent bits for
502  * the convenience of gram.y, even though some of them are useless/invalid.
503  */
504 #define FRAMEOPTION_NONDEFAULT 0x00001 /* any specified? */
505 #define FRAMEOPTION_RANGE 0x00002 /* RANGE behavior */
506 #define FRAMEOPTION_ROWS 0x00004 /* ROWS behavior */
507 #define FRAMEOPTION_GROUPS 0x00008 /* GROUPS behavior */
508 #define FRAMEOPTION_BETWEEN 0x00010 /* BETWEEN given? */
509 #define FRAMEOPTION_START_UNBOUNDED_PRECEDING 0x00020 /* start is U. P. */
510 #define FRAMEOPTION_END_UNBOUNDED_PRECEDING 0x00040 /* (disallowed) */
511 #define FRAMEOPTION_START_UNBOUNDED_FOLLOWING 0x00080 /* (disallowed) */
512 #define FRAMEOPTION_END_UNBOUNDED_FOLLOWING 0x00100 /* end is U. F. */
513 #define FRAMEOPTION_START_CURRENT_ROW 0x00200 /* start is C. R. */
514 #define FRAMEOPTION_END_CURRENT_ROW 0x00400 /* end is C. R. */
515 #define FRAMEOPTION_START_OFFSET_PRECEDING 0x00800 /* start is O. P. */
516 #define FRAMEOPTION_END_OFFSET_PRECEDING 0x01000 /* end is O. P. */
517 #define FRAMEOPTION_START_OFFSET_FOLLOWING 0x02000 /* start is O. F. */
518 #define FRAMEOPTION_END_OFFSET_FOLLOWING 0x04000 /* end is O. F. */
519 #define FRAMEOPTION_EXCLUDE_CURRENT_ROW 0x08000 /* omit C.R. */
520 #define FRAMEOPTION_EXCLUDE_GROUP 0x10000 /* omit C.R. & peers */
521 #define FRAMEOPTION_EXCLUDE_TIES 0x20000 /* omit C.R.'s peers */
522 
523 #define FRAMEOPTION_START_OFFSET \
524  (FRAMEOPTION_START_OFFSET_PRECEDING | FRAMEOPTION_START_OFFSET_FOLLOWING)
525 #define FRAMEOPTION_END_OFFSET \
526  (FRAMEOPTION_END_OFFSET_PRECEDING | FRAMEOPTION_END_OFFSET_FOLLOWING)
527 #define FRAMEOPTION_EXCLUSION \
528  (FRAMEOPTION_EXCLUDE_CURRENT_ROW | FRAMEOPTION_EXCLUDE_GROUP | \
529  FRAMEOPTION_EXCLUDE_TIES)
530 
531 #define FRAMEOPTION_DEFAULTS \
532  (FRAMEOPTION_RANGE | FRAMEOPTION_START_UNBOUNDED_PRECEDING | \
533  FRAMEOPTION_END_CURRENT_ROW)
534 
535 /*
536  * RangeSubselect - subquery appearing in a FROM clause
537  */
538 typedef struct RangeSubselect
539 {
541  bool lateral; /* does it have LATERAL prefix? */
542  Node *subquery; /* the untransformed sub-select clause */
543  Alias *alias; /* table alias & optional column aliases */
545 
546 /*
547  * RangeFunction - function call appearing in a FROM clause
548  *
549  * functions is a List because we use this to represent the construct
550  * ROWS FROM(func1(...), func2(...), ...). Each element of this list is a
551  * two-element sublist, the first element being the untransformed function
552  * call tree, and the second element being a possibly-empty list of ColumnDef
553  * nodes representing any columndef list attached to that function within the
554  * ROWS FROM() syntax.
555  *
556  * alias and coldeflist represent any alias and/or columndef list attached
557  * at the top level. (We disallow coldeflist appearing both here and
558  * per-function, but that's checked in parse analysis, not by the grammar.)
559  */
560 typedef struct RangeFunction
561 {
563  bool lateral; /* does it have LATERAL prefix? */
564  bool ordinality; /* does it have WITH ORDINALITY suffix? */
565  bool is_rowsfrom; /* is result of ROWS FROM() syntax? */
566  List *functions; /* per-function information, see above */
567  Alias *alias; /* table alias & optional column aliases */
568  List *coldeflist; /* list of ColumnDef nodes to describe result
569  * of function returning RECORD */
570 } RangeFunction;
571 
572 /*
573  * RangeTableFunc - raw form of "table functions" such as XMLTABLE
574  */
575 typedef struct RangeTableFunc
576 {
578  bool lateral; /* does it have LATERAL prefix? */
579  Node *docexpr; /* document expression */
580  Node *rowexpr; /* row generator expression */
581  List *namespaces; /* list of namespaces as ResTarget */
582  List *columns; /* list of RangeTableFuncCol */
583  Alias *alias; /* table alias & optional column aliases */
584  int location; /* token location, or -1 if unknown */
586 
587 /*
588  * RangeTableFuncCol - one column in a RangeTableFunc->columns
589  *
590  * If for_ordinality is true (FOR ORDINALITY), then the column is an int4
591  * column and the rest of the fields are ignored.
592  */
593 typedef struct RangeTableFuncCol
594 {
596  char *colname; /* name of generated column */
597  TypeName *typeName; /* type of generated column */
598  bool for_ordinality; /* does it have FOR ORDINALITY? */
599  bool is_not_null; /* does it have NOT NULL? */
600  Node *colexpr; /* column filter expression */
601  Node *coldefexpr; /* column default value expression */
602  int location; /* token location, or -1 if unknown */
604 
605 /*
606  * RangeTableSample - TABLESAMPLE appearing in a raw FROM clause
607  *
608  * This node, appearing only in raw parse trees, represents
609  * <relation> TABLESAMPLE <method> (<params>) REPEATABLE (<num>)
610  * Currently, the <relation> can only be a RangeVar, but we might in future
611  * allow RangeSubselect and other options. Note that the RangeTableSample
612  * is wrapped around the node representing the <relation>, rather than being
613  * a subfield of it.
614  */
615 typedef struct RangeTableSample
616 {
618  Node *relation; /* relation to be sampled */
619  List *method; /* sampling method name (possibly qualified) */
620  List *args; /* argument(s) for sampling method */
621  Node *repeatable; /* REPEATABLE expression, or NULL if none */
622  int location; /* method name location, or -1 if unknown */
624 
625 /*
626  * ColumnDef - column definition (used in various creates)
627  *
628  * If the column has a default value, we may have the value expression
629  * in either "raw" form (an untransformed parse tree) or "cooked" form
630  * (a post-parse-analysis, executable expression tree), depending on
631  * how this ColumnDef node was created (by parsing, or by inheritance
632  * from an existing relation). We should never have both in the same node!
633  *
634  * Similarly, we may have a COLLATE specification in either raw form
635  * (represented as a CollateClause with arg==NULL) or cooked form
636  * (the collation's OID).
637  *
638  * The constraints list may contain a CONSTR_DEFAULT item in a raw
639  * parsetree produced by gram.y, but transformCreateStmt will remove
640  * the item and set raw_default instead. CONSTR_DEFAULT items
641  * should not appear in any subsequent processing.
642  */
643 typedef struct ColumnDef
644 {
646  char *colname; /* name of column */
647  TypeName *typeName; /* type of column */
648  int inhcount; /* number of times column is inherited */
649  bool is_local; /* column has local (non-inherited) def'n */
650  bool is_not_null; /* NOT NULL constraint specified? */
651  bool is_from_type; /* column definition came from table type */
652  char storage; /* attstorage setting, or 0 for default */
653  Node *raw_default; /* default value (untransformed parse tree) */
654  Node *cooked_default; /* default value (transformed expr tree) */
655  char identity; /* attidentity setting */
656  RangeVar *identitySequence; /* to store identity sequence name for
657  * ALTER TABLE ... ADD COLUMN */
658  char generated; /* attgenerated setting */
659  CollateClause *collClause; /* untransformed COLLATE spec, if any */
660  Oid collOid; /* collation OID (InvalidOid if not set) */
661  List *constraints; /* other constraints on column */
662  List *fdwoptions; /* per-column FDW options */
663  int location; /* parse location, or -1 if none/unknown */
664 } ColumnDef;
665 
666 /*
667  * TableLikeClause - CREATE TABLE ( ... LIKE ... ) clause
668  */
669 typedef struct TableLikeClause
670 {
673  bits32 options; /* OR of TableLikeOption flags */
675 
676 typedef enum TableLikeOption
677 {
688 
689 /*
690  * IndexElem - index parameters (used in CREATE INDEX, and in ON CONFLICT)
691  *
692  * For a plain index attribute, 'name' is the name of the table column to
693  * index, and 'expr' is NULL. For an index expression, 'name' is NULL and
694  * 'expr' is the expression tree.
695  */
696 typedef struct IndexElem
697 {
699  char *name; /* name of attribute to index, or NULL */
700  Node *expr; /* expression to index, or NULL */
701  char *indexcolname; /* name for index column; NULL = default */
702  List *collation; /* name of collation; NIL = default */
703  List *opclass; /* name of desired opclass; NIL = default */
704  SortByDir ordering; /* ASC/DESC/default */
705  SortByNulls nulls_ordering; /* FIRST/LAST/default */
706 } IndexElem;
707 
708 /*
709  * DefElem - a generic "name = value" option definition
710  *
711  * In some contexts the name can be qualified. Also, certain SQL commands
712  * allow a SET/ADD/DROP action to be attached to option settings, so it's
713  * convenient to carry a field for that too. (Note: currently, it is our
714  * practice that the grammar allows namespace and action only in statements
715  * where they are relevant; C code can just ignore those fields in other
716  * statements.)
717  */
718 typedef enum DefElemAction
719 {
720  DEFELEM_UNSPEC, /* no action given */
724 } DefElemAction;
725 
726 typedef struct DefElem
727 {
729  char *defnamespace; /* NULL if unqualified name */
730  char *defname;
731  Node *arg; /* a (Value *) or a (TypeName *) */
732  DefElemAction defaction; /* unspecified action, or SET/ADD/DROP */
733  int location; /* token location, or -1 if unknown */
734 } DefElem;
735 
736 /*
737  * LockingClause - raw representation of FOR [NO KEY] UPDATE/[KEY] SHARE
738  * options
739  *
740  * Note: lockedRels == NIL means "all relations in query". Otherwise it
741  * is a list of RangeVar nodes. (We use RangeVar mainly because it carries
742  * a location field --- currently, parse analysis insists on unqualified
743  * names in LockingClause.)
744  */
745 typedef struct LockingClause
746 {
748  List *lockedRels; /* FOR [KEY] UPDATE/SHARE relations */
750  LockWaitPolicy waitPolicy; /* NOWAIT and SKIP LOCKED */
751 } LockingClause;
752 
753 /*
754  * XMLSERIALIZE (in raw parse tree only)
755  */
756 typedef struct XmlSerialize
757 {
759  XmlOptionType xmloption; /* DOCUMENT or CONTENT */
762  int location; /* token location, or -1 if unknown */
763 } XmlSerialize;
764 
765 /* Partitioning related definitions */
766 
767 /*
768  * PartitionElem - parse-time representation of a single partition key
769  *
770  * expr can be either a raw expression tree or a parse-analyzed expression.
771  * We don't store these on-disk, though.
772  */
773 typedef struct PartitionElem
774 {
776  char *name; /* name of column to partition on, or NULL */
777  Node *expr; /* expression to partition on, or NULL */
778  List *collation; /* name of collation; NIL = default */
779  List *opclass; /* name of desired opclass; NIL = default */
780  int location; /* token location, or -1 if unknown */
781 } PartitionElem;
782 
783 /*
784  * PartitionSpec - parse-time representation of a partition key specification
785  *
786  * This represents the key space we will be partitioning on.
787  */
788 typedef struct PartitionSpec
789 {
791  char *strategy; /* partitioning strategy ('hash', 'list' or
792  * 'range') */
793  List *partParams; /* List of PartitionElems */
794  int location; /* token location, or -1 if unknown */
795 } PartitionSpec;
796 
797 /* Internal codes for partitioning strategies */
798 #define PARTITION_STRATEGY_HASH 'h'
799 #define PARTITION_STRATEGY_LIST 'l'
800 #define PARTITION_STRATEGY_RANGE 'r'
801 
802 /*
803  * PartitionBoundSpec - a partition bound specification
804  *
805  * This represents the portion of the partition key space assigned to a
806  * particular partition. These are stored on disk in pg_class.relpartbound.
807  */
809 {
811 
812  char strategy; /* see PARTITION_STRATEGY codes above */
813  bool is_default; /* is it a default partition bound? */
814 
815  /* Partitioning info for HASH strategy: */
816  int modulus;
818 
819  /* Partitioning info for LIST strategy: */
820  List *listdatums; /* List of Consts (or A_Consts in raw tree) */
821 
822  /* Partitioning info for RANGE strategy: */
823  List *lowerdatums; /* List of PartitionRangeDatums */
824  List *upperdatums; /* List of PartitionRangeDatums */
825 
826  int location; /* token location, or -1 if unknown */
827 };
828 
829 /*
830  * PartitionRangeDatum - one of the values in a range partition bound
831  *
832  * This can be MINVALUE, MAXVALUE or a specific bounded value.
833  */
835 {
836  PARTITION_RANGE_DATUM_MINVALUE = -1, /* less than any other value */
837  PARTITION_RANGE_DATUM_VALUE = 0, /* a specific (bounded) value */
838  PARTITION_RANGE_DATUM_MAXVALUE = 1 /* greater than any other value */
840 
841 typedef struct PartitionRangeDatum
842 {
844 
846  Node *value; /* Const (or A_Const in raw tree), if kind is
847  * PARTITION_RANGE_DATUM_VALUE, else NULL */
848 
849  int location; /* token location, or -1 if unknown */
851 
852 /*
853  * PartitionCmd - info for ALTER TABLE/INDEX ATTACH/DETACH PARTITION commands
854  */
855 typedef struct PartitionCmd
856 {
858  RangeVar *name; /* name of partition to attach/detach */
859  PartitionBoundSpec *bound; /* FOR VALUES, if attaching */
860 } PartitionCmd;
861 
862 /****************************************************************************
863  * Nodes for a Query tree
864  ****************************************************************************/
865 
866 /*--------------------
867  * RangeTblEntry -
868  * A range table is a List of RangeTblEntry nodes.
869  *
870  * A range table entry may represent a plain relation, a sub-select in
871  * FROM, or the result of a JOIN clause. (Only explicit JOIN syntax
872  * produces an RTE, not the implicit join resulting from multiple FROM
873  * items. This is because we only need the RTE to deal with SQL features
874  * like outer joins and join-output-column aliasing.) Other special
875  * RTE types also exist, as indicated by RTEKind.
876  *
877  * Note that we consider RTE_RELATION to cover anything that has a pg_class
878  * entry. relkind distinguishes the sub-cases.
879  *
880  * alias is an Alias node representing the AS alias-clause attached to the
881  * FROM expression, or NULL if no clause.
882  *
883  * eref is the table reference name and column reference names (either
884  * real or aliases). Note that system columns (OID etc) are not included
885  * in the column list.
886  * eref->aliasname is required to be present, and should generally be used
887  * to identify the RTE for error messages etc.
888  *
889  * In RELATION RTEs, the colnames in both alias and eref are indexed by
890  * physical attribute number; this means there must be colname entries for
891  * dropped columns. When building an RTE we insert empty strings ("") for
892  * dropped columns. Note however that a stored rule may have nonempty
893  * colnames for columns dropped since the rule was created (and for that
894  * matter the colnames might be out of date due to column renamings).
895  * The same comments apply to FUNCTION RTEs when a function's return type
896  * is a named composite type.
897  *
898  * In JOIN RTEs, the colnames in both alias and eref are one-to-one with
899  * joinaliasvars entries. A JOIN RTE will omit columns of its inputs when
900  * those columns are known to be dropped at parse time. Again, however,
901  * a stored rule might contain entries for columns dropped since the rule
902  * was created. (This is only possible for columns not actually referenced
903  * in the rule.) When loading a stored rule, we replace the joinaliasvars
904  * items for any such columns with null pointers. (We can't simply delete
905  * them from the joinaliasvars list, because that would affect the attnums
906  * of Vars referencing the rest of the list.)
907  *
908  * inh is true for relation references that should be expanded to include
909  * inheritance children, if the rel has any. This *must* be false for
910  * RTEs other than RTE_RELATION entries.
911  *
912  * inFromCl marks those range variables that are listed in the FROM clause.
913  * It's false for RTEs that are added to a query behind the scenes, such
914  * as the NEW and OLD variables for a rule, or the subqueries of a UNION.
915  * This flag is not used anymore during parsing, since the parser now uses
916  * a separate "namespace" data structure to control visibility, but it is
917  * needed by ruleutils.c to determine whether RTEs should be shown in
918  * decompiled queries.
919  *
920  * requiredPerms and checkAsUser specify run-time access permissions
921  * checks to be performed at query startup. The user must have *all*
922  * of the permissions that are OR'd together in requiredPerms (zero
923  * indicates no permissions checking). If checkAsUser is not zero,
924  * then do the permissions checks using the access rights of that user,
925  * not the current effective user ID. (This allows rules to act as
926  * setuid gateways.) Permissions checks only apply to RELATION RTEs.
927  *
928  * For SELECT/INSERT/UPDATE permissions, if the user doesn't have
929  * table-wide permissions then it is sufficient to have the permissions
930  * on all columns identified in selectedCols (for SELECT) and/or
931  * insertedCols and/or updatedCols (INSERT with ON CONFLICT DO UPDATE may
932  * have all 3). selectedCols, insertedCols and updatedCols are bitmapsets,
933  * which cannot have negative integer members, so we subtract
934  * FirstLowInvalidHeapAttributeNumber from column numbers before storing
935  * them in these fields. A whole-row Var reference is represented by
936  * setting the bit for InvalidAttrNumber.
937  *
938  * updatedCols is also used in some other places, for example, to determine
939  * which triggers to fire and in FDWs to know which changed columns they
940  * need to ship off. Generated columns that are caused to be updated by an
941  * update to a base column are collected in extraUpdatedCols. This is not
942  * considered for permission checking, but it is useful in those places
943  * that want to know the full set of columns being updated as opposed to
944  * only the ones the user explicitly mentioned in the query. (There is
945  * currently no need for an extraInsertedCols, but it could exist.)
946  *
947  * securityQuals is a list of security barrier quals (boolean expressions),
948  * to be tested in the listed order before returning a row from the
949  * relation. It is always NIL in parser output. Entries are added by the
950  * rewriter to implement security-barrier views and/or row-level security.
951  * Note that the planner turns each boolean expression into an implicitly
952  * AND'ed sublist, as is its usual habit with qualification expressions.
953  *--------------------
954  */
955 typedef enum RTEKind
956 {
957  RTE_RELATION, /* ordinary relation reference */
958  RTE_SUBQUERY, /* subquery in FROM */
959  RTE_JOIN, /* join */
960  RTE_FUNCTION, /* function in FROM */
961  RTE_TABLEFUNC, /* TableFunc(.., column list) */
962  RTE_VALUES, /* VALUES (<exprlist>), (<exprlist>), ... */
963  RTE_CTE, /* common table expr (WITH list element) */
964  RTE_NAMEDTUPLESTORE, /* tuplestore, e.g. for AFTER triggers */
965  RTE_RESULT /* RTE represents an empty FROM clause; such
966  * RTEs are added by the planner, they're not
967  * present during parsing or rewriting */
968 } RTEKind;
969 
970 typedef struct RangeTblEntry
971 {
973 
974  RTEKind rtekind; /* see above */
975 
976  /*
977  * XXX the fields applicable to only some rte kinds should be merged into
978  * a union. I didn't do this yet because the diffs would impact a lot of
979  * code that is being actively worked on. FIXME someday.
980  */
981 
982  /*
983  * Fields valid for a plain relation RTE (else zero):
984  *
985  * As a special case, RTE_NAMEDTUPLESTORE can also set relid to indicate
986  * that the tuple format of the tuplestore is the same as the referenced
987  * relation. This allows plans referencing AFTER trigger transition
988  * tables to be invalidated if the underlying table is altered.
989  *
990  * rellockmode is really LOCKMODE, but it's declared int to avoid having
991  * to include lock-related headers here. It must be RowExclusiveLock if
992  * the RTE is an INSERT/UPDATE/DELETE target, else RowShareLock if the RTE
993  * is a SELECT FOR UPDATE/FOR SHARE target, else AccessShareLock.
994  *
995  * Note: in some cases, rule expansion may result in RTEs that are marked
996  * with RowExclusiveLock even though they are not the target of the
997  * current query; this happens if a DO ALSO rule simply scans the original
998  * target table. We leave such RTEs with their original lockmode so as to
999  * avoid getting an additional, lesser lock.
1000  */
1001  Oid relid; /* OID of the relation */
1002  char relkind; /* relation kind (see pg_class.relkind) */
1003  int rellockmode; /* lock level that query requires on the rel */
1004  struct TableSampleClause *tablesample; /* sampling info, or NULL */
1005 
1006  /*
1007  * Fields valid for a subquery RTE (else NULL):
1008  */
1009  Query *subquery; /* the sub-query */
1010  bool security_barrier; /* is from security_barrier view? */
1011 
1012  /*
1013  * Fields valid for a join RTE (else NULL/zero):
1014  *
1015  * joinaliasvars is a list of (usually) Vars corresponding to the columns
1016  * of the join result. An alias Var referencing column K of the join
1017  * result can be replaced by the K'th element of joinaliasvars --- but to
1018  * simplify the task of reverse-listing aliases correctly, we do not do
1019  * that until planning time. In detail: an element of joinaliasvars can
1020  * be a Var of one of the join's input relations, or such a Var with an
1021  * implicit coercion to the join's output column type, or a COALESCE
1022  * expression containing the two input column Vars (possibly coerced).
1023  * Elements beyond the first joinmergedcols entries are always just Vars,
1024  * and are never referenced from elsewhere in the query (that is, join
1025  * alias Vars are generated only for merged columns). We keep these
1026  * entries only because they're needed in expandRTE() and similar code.
1027  *
1028  * Within a Query loaded from a stored rule, it is possible for non-merged
1029  * joinaliasvars items to be null pointers, which are placeholders for
1030  * (necessarily unreferenced) columns dropped since the rule was made.
1031  * Also, once planning begins, joinaliasvars items can be almost anything,
1032  * as a result of subquery-flattening substitutions.
1033  *
1034  * joinleftcols is an integer list of physical column numbers of the left
1035  * join input rel that are included in the join; likewise joinrighttcols
1036  * for the right join input rel. (Which rels those are can be determined
1037  * from the associated JoinExpr.) If the join is USING/NATURAL, then the
1038  * first joinmergedcols entries in each list identify the merged columns.
1039  * The merged columns come first in the join output, then remaining
1040  * columns of the left input, then remaining columns of the right.
1041  *
1042  * Note that input columns could have been dropped after creation of a
1043  * stored rule, if they are not referenced in the query (in particular,
1044  * merged columns could not be dropped); this is not accounted for in
1045  * joinleftcols/joinrighttcols.
1046  */
1047  JoinType jointype; /* type of join */
1048  int joinmergedcols; /* number of merged (JOIN USING) columns */
1049  List *joinaliasvars; /* list of alias-var expansions */
1050  List *joinleftcols; /* left-side input column numbers */
1051  List *joinrightcols; /* right-side input column numbers */
1052 
1053  /*
1054  * Fields valid for a function RTE (else NIL/zero):
1055  *
1056  * When funcordinality is true, the eref->colnames list includes an alias
1057  * for the ordinality column. The ordinality column is otherwise
1058  * implicit, and must be accounted for "by hand" in places such as
1059  * expandRTE().
1060  */
1061  List *functions; /* list of RangeTblFunction nodes */
1062  bool funcordinality; /* is this called WITH ORDINALITY? */
1063 
1064  /*
1065  * Fields valid for a TableFunc RTE (else NULL):
1066  */
1068 
1069  /*
1070  * Fields valid for a values RTE (else NIL):
1071  */
1072  List *values_lists; /* list of expression lists */
1073 
1074  /*
1075  * Fields valid for a CTE RTE (else NULL/zero):
1076  */
1077  char *ctename; /* name of the WITH list item */
1078  Index ctelevelsup; /* number of query levels up */
1079  bool self_reference; /* is this a recursive self-reference? */
1080 
1081  /*
1082  * Fields valid for CTE, VALUES, ENR, and TableFunc RTEs (else NIL):
1083  *
1084  * We need these for CTE RTEs so that the types of self-referential
1085  * columns are well-defined. For VALUES RTEs, storing these explicitly
1086  * saves having to re-determine the info by scanning the values_lists. For
1087  * ENRs, we store the types explicitly here (we could get the information
1088  * from the catalogs if 'relid' was supplied, but we'd still need these
1089  * for TupleDesc-based ENRs, so we might as well always store the type
1090  * info here). For TableFuncs, these fields are redundant with data in
1091  * the TableFunc node, but keeping them here allows some code sharing with
1092  * the other cases.
1093  *
1094  * For ENRs only, we have to consider the possibility of dropped columns.
1095  * A dropped column is included in these lists, but it will have zeroes in
1096  * all three lists (as well as an empty-string entry in eref). Testing
1097  * for zero coltype is the standard way to detect a dropped column.
1098  */
1099  List *coltypes; /* OID list of column type OIDs */
1100  List *coltypmods; /* integer list of column typmods */
1101  List *colcollations; /* OID list of column collation OIDs */
1102 
1103  /*
1104  * Fields valid for ENR RTEs (else NULL/zero):
1105  */
1106  char *enrname; /* name of ephemeral named relation */
1107  double enrtuples; /* estimated or actual from caller */
1108 
1109  /*
1110  * Fields valid in all RTEs:
1111  */
1112  Alias *alias; /* user-written alias clause, if any */
1113  Alias *eref; /* expanded reference names */
1114  bool lateral; /* subquery, function, or values is LATERAL? */
1115  bool inh; /* inheritance requested? */
1116  bool inFromCl; /* present in FROM clause? */
1117  AclMode requiredPerms; /* bitmask of required access permissions */
1118  Oid checkAsUser; /* if valid, check access as this role */
1119  Bitmapset *selectedCols; /* columns needing SELECT permission */
1120  Bitmapset *insertedCols; /* columns needing INSERT permission */
1121  Bitmapset *updatedCols; /* columns needing UPDATE permission */
1122  Bitmapset *extraUpdatedCols; /* generated columns being updated */
1123  List *securityQuals; /* security barrier quals to apply, if any */
1124 } RangeTblEntry;
1125 
1126 /*
1127  * RangeTblFunction -
1128  * RangeTblEntry subsidiary data for one function in a FUNCTION RTE.
1129  *
1130  * If the function had a column definition list (required for an
1131  * otherwise-unspecified RECORD result), funccolnames lists the names given
1132  * in the definition list, funccoltypes lists their declared column types,
1133  * funccoltypmods lists their typmods, funccolcollations their collations.
1134  * Otherwise, those fields are NIL.
1135  *
1136  * Notice we don't attempt to store info about the results of functions
1137  * returning named composite types, because those can change from time to
1138  * time. We do however remember how many columns we thought the type had
1139  * (including dropped columns!), so that we can successfully ignore any
1140  * columns added after the query was parsed.
1141  */
1142 typedef struct RangeTblFunction
1143 {
1145 
1146  Node *funcexpr; /* expression tree for func call */
1147  int funccolcount; /* number of columns it contributes to RTE */
1148  /* These fields record the contents of a column definition list, if any: */
1149  List *funccolnames; /* column names (list of String) */
1150  List *funccoltypes; /* OID list of column type OIDs */
1151  List *funccoltypmods; /* integer list of column typmods */
1152  List *funccolcollations; /* OID list of column collation OIDs */
1153  /* This is set during planning for use by the executor: */
1154  Bitmapset *funcparams; /* PARAM_EXEC Param IDs affecting this func */
1156 
1157 /*
1158  * TableSampleClause - TABLESAMPLE appearing in a transformed FROM clause
1159  *
1160  * Unlike RangeTableSample, this is a subnode of the relevant RangeTblEntry.
1161  */
1162 typedef struct TableSampleClause
1163 {
1165  Oid tsmhandler; /* OID of the tablesample handler function */
1166  List *args; /* tablesample argument expression(s) */
1167  Expr *repeatable; /* REPEATABLE expression, or NULL if none */
1169 
1170 /*
1171  * WithCheckOption -
1172  * representation of WITH CHECK OPTION checks to be applied to new tuples
1173  * when inserting/updating an auto-updatable view, or RLS WITH CHECK
1174  * policies to be applied when inserting/updating a relation with RLS.
1175  */
1176 typedef enum WCOKind
1177 {
1178  WCO_VIEW_CHECK, /* WCO on an auto-updatable view */
1179  WCO_RLS_INSERT_CHECK, /* RLS INSERT WITH CHECK policy */
1180  WCO_RLS_UPDATE_CHECK, /* RLS UPDATE WITH CHECK policy */
1181  WCO_RLS_CONFLICT_CHECK /* RLS ON CONFLICT DO UPDATE USING policy */
1182 } WCOKind;
1183 
1184 typedef struct WithCheckOption
1185 {
1187  WCOKind kind; /* kind of WCO */
1188  char *relname; /* name of relation that specified the WCO */
1189  char *polname; /* name of RLS policy being checked */
1190  Node *qual; /* constraint qual to check */
1191  bool cascaded; /* true for a cascaded WCO on a view */
1192 } WithCheckOption;
1193 
1194 /*
1195  * SortGroupClause -
1196  * representation of ORDER BY, GROUP BY, PARTITION BY,
1197  * DISTINCT, DISTINCT ON items
1198  *
1199  * You might think that ORDER BY is only interested in defining ordering,
1200  * and GROUP/DISTINCT are only interested in defining equality. However,
1201  * one way to implement grouping is to sort and then apply a "uniq"-like
1202  * filter. So it's also interesting to keep track of possible sort operators
1203  * for GROUP/DISTINCT, and in particular to try to sort for the grouping
1204  * in a way that will also yield a requested ORDER BY ordering. So we need
1205  * to be able to compare ORDER BY and GROUP/DISTINCT lists, which motivates
1206  * the decision to give them the same representation.
1207  *
1208  * tleSortGroupRef must match ressortgroupref of exactly one entry of the
1209  * query's targetlist; that is the expression to be sorted or grouped by.
1210  * eqop is the OID of the equality operator.
1211  * sortop is the OID of the ordering operator (a "<" or ">" operator),
1212  * or InvalidOid if not available.
1213  * nulls_first means about what you'd expect. If sortop is InvalidOid
1214  * then nulls_first is meaningless and should be set to false.
1215  * hashable is true if eqop is hashable (note this condition also depends
1216  * on the datatype of the input expression).
1217  *
1218  * In an ORDER BY item, all fields must be valid. (The eqop isn't essential
1219  * here, but it's cheap to get it along with the sortop, and requiring it
1220  * to be valid eases comparisons to grouping items.) Note that this isn't
1221  * actually enough information to determine an ordering: if the sortop is
1222  * collation-sensitive, a collation OID is needed too. We don't store the
1223  * collation in SortGroupClause because it's not available at the time the
1224  * parser builds the SortGroupClause; instead, consult the exposed collation
1225  * of the referenced targetlist expression to find out what it is.
1226  *
1227  * In a grouping item, eqop must be valid. If the eqop is a btree equality
1228  * operator, then sortop should be set to a compatible ordering operator.
1229  * We prefer to set eqop/sortop/nulls_first to match any ORDER BY item that
1230  * the query presents for the same tlist item. If there is none, we just
1231  * use the default ordering op for the datatype.
1232  *
1233  * If the tlist item's type has a hash opclass but no btree opclass, then
1234  * we will set eqop to the hash equality operator, sortop to InvalidOid,
1235  * and nulls_first to false. A grouping item of this kind can only be
1236  * implemented by hashing, and of course it'll never match an ORDER BY item.
1237  *
1238  * The hashable flag is provided since we generally have the requisite
1239  * information readily available when the SortGroupClause is constructed,
1240  * and it's relatively expensive to get it again later. Note there is no
1241  * need for a "sortable" flag since OidIsValid(sortop) serves the purpose.
1242  *
1243  * A query might have both ORDER BY and DISTINCT (or DISTINCT ON) clauses.
1244  * In SELECT DISTINCT, the distinctClause list is as long or longer than the
1245  * sortClause list, while in SELECT DISTINCT ON it's typically shorter.
1246  * The two lists must match up to the end of the shorter one --- the parser
1247  * rearranges the distinctClause if necessary to make this true. (This
1248  * restriction ensures that only one sort step is needed to both satisfy the
1249  * ORDER BY and set up for the Unique step. This is semantically necessary
1250  * for DISTINCT ON, and presents no real drawback for DISTINCT.)
1251  */
1252 typedef struct SortGroupClause
1253 {
1255  Index tleSortGroupRef; /* reference into targetlist */
1256  Oid eqop; /* the equality operator ('=' op) */
1257  Oid sortop; /* the ordering operator ('<' op), or 0 */
1258  bool nulls_first; /* do NULLs come before normal values? */
1259  bool hashable; /* can eqop be implemented by hashing? */
1260 } SortGroupClause;
1261 
1262 /*
1263  * GroupingSet -
1264  * representation of CUBE, ROLLUP and GROUPING SETS clauses
1265  *
1266  * In a Query with grouping sets, the groupClause contains a flat list of
1267  * SortGroupClause nodes for each distinct expression used. The actual
1268  * structure of the GROUP BY clause is given by the groupingSets tree.
1269  *
1270  * In the raw parser output, GroupingSet nodes (of all types except SIMPLE
1271  * which is not used) are potentially mixed in with the expressions in the
1272  * groupClause of the SelectStmt. (An expression can't contain a GroupingSet,
1273  * but a list may mix GroupingSet and expression nodes.) At this stage, the
1274  * content of each node is a list of expressions, some of which may be RowExprs
1275  * which represent sublists rather than actual row constructors, and nested
1276  * GroupingSet nodes where legal in the grammar. The structure directly
1277  * reflects the query syntax.
1278  *
1279  * In parse analysis, the transformed expressions are used to build the tlist
1280  * and groupClause list (of SortGroupClause nodes), and the groupingSets tree
1281  * is eventually reduced to a fixed format:
1282  *
1283  * EMPTY nodes represent (), and obviously have no content
1284  *
1285  * SIMPLE nodes represent a list of one or more expressions to be treated as an
1286  * atom by the enclosing structure; the content is an integer list of
1287  * ressortgroupref values (see SortGroupClause)
1288  *
1289  * CUBE and ROLLUP nodes contain a list of one or more SIMPLE nodes.
1290  *
1291  * SETS nodes contain a list of EMPTY, SIMPLE, CUBE or ROLLUP nodes, but after
1292  * parse analysis they cannot contain more SETS nodes; enough of the syntactic
1293  * transforms of the spec have been applied that we no longer have arbitrarily
1294  * deep nesting (though we still preserve the use of cube/rollup).
1295  *
1296  * Note that if the groupingSets tree contains no SIMPLE nodes (only EMPTY
1297  * nodes at the leaves), then the groupClause will be empty, but this is still
1298  * an aggregation query (similar to using aggs or HAVING without GROUP BY).
1299  *
1300  * As an example, the following clause:
1301  *
1302  * GROUP BY GROUPING SETS ((a,b), CUBE(c,(d,e)))
1303  *
1304  * looks like this after raw parsing:
1305  *
1306  * SETS( RowExpr(a,b) , CUBE( c, RowExpr(d,e) ) )
1307  *
1308  * and parse analysis converts it to:
1309  *
1310  * SETS( SIMPLE(1,2), CUBE( SIMPLE(3), SIMPLE(4,5) ) )
1311  */
1312 typedef enum
1313 {
1319 } GroupingSetKind;
1320 
1321 typedef struct GroupingSet
1322 {
1327 } GroupingSet;
1328 
1329 /*
1330  * WindowClause -
1331  * transformed representation of WINDOW and OVER clauses
1332  *
1333  * A parsed Query's windowClause list contains these structs. "name" is set
1334  * if the clause originally came from WINDOW, and is NULL if it originally
1335  * was an OVER clause (but note that we collapse out duplicate OVERs).
1336  * partitionClause and orderClause are lists of SortGroupClause structs.
1337  * If we have RANGE with offset PRECEDING/FOLLOWING, the semantics of that are
1338  * specified by startInRangeFunc/inRangeColl/inRangeAsc/inRangeNullsFirst
1339  * for the start offset, or endInRangeFunc/inRange* for the end offset.
1340  * winref is an ID number referenced by WindowFunc nodes; it must be unique
1341  * among the members of a Query's windowClause list.
1342  * When refname isn't null, the partitionClause is always copied from there;
1343  * the orderClause might or might not be copied (see copiedOrder); the framing
1344  * options are never copied, per spec.
1345  */
1346 typedef struct WindowClause
1347 {
1349  char *name; /* window name (NULL in an OVER clause) */
1350  char *refname; /* referenced window name, if any */
1351  List *partitionClause; /* PARTITION BY list */
1352  List *orderClause; /* ORDER BY list */
1353  int frameOptions; /* frame_clause options, see WindowDef */
1354  Node *startOffset; /* expression for starting bound, if any */
1355  Node *endOffset; /* expression for ending bound, if any */
1356  Oid startInRangeFunc; /* in_range function for startOffset */
1357  Oid endInRangeFunc; /* in_range function for endOffset */
1358  Oid inRangeColl; /* collation for in_range tests */
1359  bool inRangeAsc; /* use ASC sort order for in_range tests? */
1360  bool inRangeNullsFirst; /* nulls sort first for in_range tests? */
1361  Index winref; /* ID referenced by window functions */
1362  bool copiedOrder; /* did we copy orderClause from refname? */
1363 } WindowClause;
1364 
1365 /*
1366  * RowMarkClause -
1367  * parser output representation of FOR [KEY] UPDATE/SHARE clauses
1368  *
1369  * Query.rowMarks contains a separate RowMarkClause node for each relation
1370  * identified as a FOR [KEY] UPDATE/SHARE target. If one of these clauses
1371  * is applied to a subquery, we generate RowMarkClauses for all normal and
1372  * subquery rels in the subquery, but they are marked pushedDown = true to
1373  * distinguish them from clauses that were explicitly written at this query
1374  * level. Also, Query.hasForUpdate tells whether there were explicit FOR
1375  * UPDATE/SHARE/KEY SHARE clauses in the current query level.
1376  */
1377 typedef struct RowMarkClause
1378 {
1380  Index rti; /* range table index of target relation */
1382  LockWaitPolicy waitPolicy; /* NOWAIT and SKIP LOCKED */
1383  bool pushedDown; /* pushed down from higher query level? */
1384 } RowMarkClause;
1385 
1386 /*
1387  * WithClause -
1388  * representation of WITH clause
1389  *
1390  * Note: WithClause does not propagate into the Query representation;
1391  * but CommonTableExpr does.
1392  */
1393 typedef struct WithClause
1394 {
1396  List *ctes; /* list of CommonTableExprs */
1397  bool recursive; /* true = WITH RECURSIVE */
1398  int location; /* token location, or -1 if unknown */
1399 } WithClause;
1400 
1401 /*
1402  * InferClause -
1403  * ON CONFLICT unique index inference clause
1404  *
1405  * Note: InferClause does not propagate into the Query representation.
1406  */
1407 typedef struct InferClause
1408 {
1410  List *indexElems; /* IndexElems to infer unique index */
1411  Node *whereClause; /* qualification (partial-index predicate) */
1412  char *conname; /* Constraint name, or NULL if unnamed */
1413  int location; /* token location, or -1 if unknown */
1414 } InferClause;
1415 
1416 /*
1417  * OnConflictClause -
1418  * representation of ON CONFLICT clause
1419  *
1420  * Note: OnConflictClause does not propagate into the Query representation.
1421  */
1422 typedef struct OnConflictClause
1423 {
1425  OnConflictAction action; /* DO NOTHING or UPDATE? */
1426  InferClause *infer; /* Optional index inference clause */
1427  List *targetList; /* the target list (of ResTarget) */
1428  Node *whereClause; /* qualifications */
1429  int location; /* token location, or -1 if unknown */
1431 
1432 /*
1433  * CommonTableExpr -
1434  * representation of WITH list element
1435  *
1436  * We don't currently support the SEARCH or CYCLE clause.
1437  */
1438 typedef enum CTEMaterialize
1439 {
1440  CTEMaterializeDefault, /* no option specified */
1441  CTEMaterializeAlways, /* MATERIALIZED */
1442  CTEMaterializeNever /* NOT MATERIALIZED */
1443 } CTEMaterialize;
1444 
1445 typedef struct CommonTableExpr
1446 {
1448  char *ctename; /* query name (never qualified) */
1449  List *aliascolnames; /* optional list of column names */
1450  CTEMaterialize ctematerialized; /* is this an optimization fence? */
1451  /* SelectStmt/InsertStmt/etc before parse analysis, Query afterwards: */
1452  Node *ctequery; /* the CTE's subquery */
1453  int location; /* token location, or -1 if unknown */
1454  /* These fields are set during parse analysis: */
1455  bool cterecursive; /* is this CTE actually recursive? */
1456  int cterefcount; /* number of RTEs referencing this CTE
1457  * (excluding internal self-references) */
1458  List *ctecolnames; /* list of output column names */
1459  List *ctecoltypes; /* OID list of output column type OIDs */
1460  List *ctecoltypmods; /* integer list of output column typmods */
1461  List *ctecolcollations; /* OID list of column collation OIDs */
1462 } CommonTableExpr;
1463 
1464 /* Convenience macro to get the output tlist of a CTE's query */
1465 #define GetCTETargetList(cte) \
1466  (AssertMacro(IsA((cte)->ctequery, Query)), \
1467  ((Query *) (cte)->ctequery)->commandType == CMD_SELECT ? \
1468  ((Query *) (cte)->ctequery)->targetList : \
1469  ((Query *) (cte)->ctequery)->returningList)
1470 
1471 /*
1472  * TriggerTransition -
1473  * representation of transition row or table naming clause
1474  *
1475  * Only transition tables are initially supported in the syntax, and only for
1476  * AFTER triggers, but other permutations are accepted by the parser so we can
1477  * give a meaningful message from C code.
1478  */
1479 typedef struct TriggerTransition
1480 {
1482  char *name;
1483  bool isNew;
1484  bool isTable;
1486 
1487 /*****************************************************************************
1488  * Raw Grammar Output Statements
1489  *****************************************************************************/
1490 
1491 /*
1492  * RawStmt --- container for any one statement's raw parse tree
1493  *
1494  * Parse analysis converts a raw parse tree headed by a RawStmt node into
1495  * an analyzed statement headed by a Query node. For optimizable statements,
1496  * the conversion is complex. For utility statements, the parser usually just
1497  * transfers the raw parse tree (sans RawStmt) into the utilityStmt field of
1498  * the Query node, and all the useful work happens at execution time.
1499  *
1500  * stmt_location/stmt_len identify the portion of the source text string
1501  * containing this raw statement (useful for multi-statement strings).
1502  */
1503 typedef struct RawStmt
1504 {
1506  Node *stmt; /* raw parse tree */
1507  int stmt_location; /* start location, or -1 if unknown */
1508  int stmt_len; /* length in bytes; 0 means "rest of string" */
1509 } RawStmt;
1510 
1511 /*****************************************************************************
1512  * Optimizable Statements
1513  *****************************************************************************/
1514 
1515 /* ----------------------
1516  * Insert Statement
1517  *
1518  * The source expression is represented by SelectStmt for both the
1519  * SELECT and VALUES cases. If selectStmt is NULL, then the query
1520  * is INSERT ... DEFAULT VALUES.
1521  * ----------------------
1522  */
1523 typedef struct InsertStmt
1524 {
1526  RangeVar *relation; /* relation to insert into */
1527  List *cols; /* optional: names of the target columns */
1528  Node *selectStmt; /* the source SELECT/VALUES, or NULL */
1529  OnConflictClause *onConflictClause; /* ON CONFLICT clause */
1530  List *returningList; /* list of expressions to return */
1531  WithClause *withClause; /* WITH clause */
1532  OverridingKind override; /* OVERRIDING clause */
1533 } InsertStmt;
1534 
1535 /* ----------------------
1536  * Delete Statement
1537  * ----------------------
1538  */
1539 typedef struct DeleteStmt
1540 {
1542  RangeVar *relation; /* relation to delete from */
1543  List *usingClause; /* optional using clause for more tables */
1544  Node *whereClause; /* qualifications */
1545  List *returningList; /* list of expressions to return */
1546  WithClause *withClause; /* WITH clause */
1547 } DeleteStmt;
1548 
1549 /* ----------------------
1550  * Update Statement
1551  * ----------------------
1552  */
1553 typedef struct UpdateStmt
1554 {
1556  RangeVar *relation; /* relation to update */
1557  List *targetList; /* the target list (of ResTarget) */
1558  Node *whereClause; /* qualifications */
1559  List *fromClause; /* optional from clause for more tables */
1560  List *returningList; /* list of expressions to return */
1561  WithClause *withClause; /* WITH clause */
1562 } UpdateStmt;
1563 
1564 /* ----------------------
1565  * Select Statement
1566  *
1567  * A "simple" SELECT is represented in the output of gram.y by a single
1568  * SelectStmt node; so is a VALUES construct. A query containing set
1569  * operators (UNION, INTERSECT, EXCEPT) is represented by a tree of SelectStmt
1570  * nodes, in which the leaf nodes are component SELECTs and the internal nodes
1571  * represent UNION, INTERSECT, or EXCEPT operators. Using the same node
1572  * type for both leaf and internal nodes allows gram.y to stick ORDER BY,
1573  * LIMIT, etc, clause values into a SELECT statement without worrying
1574  * whether it is a simple or compound SELECT.
1575  * ----------------------
1576  */
1577 typedef enum SetOperation
1578 {
1583 } SetOperation;
1584 
1585 typedef struct SelectStmt
1586 {
1588 
1589  /*
1590  * These fields are used only in "leaf" SelectStmts.
1591  */
1592  List *distinctClause; /* NULL, list of DISTINCT ON exprs, or
1593  * lcons(NIL,NIL) for all (SELECT DISTINCT) */
1594  IntoClause *intoClause; /* target for SELECT INTO */
1595  List *targetList; /* the target list (of ResTarget) */
1596  List *fromClause; /* the FROM clause */
1597  Node *whereClause; /* WHERE qualification */
1598  List *groupClause; /* GROUP BY clauses */
1599  Node *havingClause; /* HAVING conditional-expression */
1600  List *windowClause; /* WINDOW window_name AS (...), ... */
1601 
1602  /*
1603  * In a "leaf" node representing a VALUES list, the above fields are all
1604  * null, and instead this field is set. Note that the elements of the
1605  * sublists are just expressions, without ResTarget decoration. Also note
1606  * that a list element can be DEFAULT (represented as a SetToDefault
1607  * node), regardless of the context of the VALUES list. It's up to parse
1608  * analysis to reject that where not valid.
1609  */
1610  List *valuesLists; /* untransformed list of expression lists */
1611 
1612  /*
1613  * These fields are used in both "leaf" SelectStmts and upper-level
1614  * SelectStmts.
1615  */
1616  List *sortClause; /* sort clause (a list of SortBy's) */
1617  Node *limitOffset; /* # of result tuples to skip */
1618  Node *limitCount; /* # of result tuples to return */
1619  List *lockingClause; /* FOR UPDATE (list of LockingClause's) */
1620  WithClause *withClause; /* WITH clause */
1621 
1622  /*
1623  * These fields are used only in upper-level SelectStmts.
1624  */
1625  SetOperation op; /* type of set op */
1626  bool all; /* ALL specified? */
1627  struct SelectStmt *larg; /* left child */
1628  struct SelectStmt *rarg; /* right child */
1629  /* Eventually add fields for CORRESPONDING spec here */
1630 } SelectStmt;
1631 
1632 
1633 /* ----------------------
1634  * Set Operation node for post-analysis query trees
1635  *
1636  * After parse analysis, a SELECT with set operations is represented by a
1637  * top-level Query node containing the leaf SELECTs as subqueries in its
1638  * range table. Its setOperations field shows the tree of set operations,
1639  * with leaf SelectStmt nodes replaced by RangeTblRef nodes, and internal
1640  * nodes replaced by SetOperationStmt nodes. Information about the output
1641  * column types is added, too. (Note that the child nodes do not necessarily
1642  * produce these types directly, but we've checked that their output types
1643  * can be coerced to the output column type.) Also, if it's not UNION ALL,
1644  * information about the types' sort/group semantics is provided in the form
1645  * of a SortGroupClause list (same representation as, eg, DISTINCT).
1646  * The resolved common column collations are provided too; but note that if
1647  * it's not UNION ALL, it's okay for a column to not have a common collation,
1648  * so a member of the colCollations list could be InvalidOid even though the
1649  * column has a collatable type.
1650  * ----------------------
1651  */
1652 typedef struct SetOperationStmt
1653 {
1655  SetOperation op; /* type of set op */
1656  bool all; /* ALL specified? */
1657  Node *larg; /* left child */
1658  Node *rarg; /* right child */
1659  /* Eventually add fields for CORRESPONDING spec here */
1660 
1661  /* Fields derived during parse analysis: */
1662  List *colTypes; /* OID list of output column type OIDs */
1663  List *colTypmods; /* integer list of output column typmods */
1664  List *colCollations; /* OID list of output column collation OIDs */
1665  List *groupClauses; /* a list of SortGroupClause's */
1666  /* groupClauses is NIL if UNION ALL, but must be set otherwise */
1668 
1669 
1670 /*****************************************************************************
1671  * Other Statements (no optimizations required)
1672  *
1673  * These are not touched by parser/analyze.c except to put them into
1674  * the utilityStmt field of a Query. This is eventually passed to
1675  * ProcessUtility (by-passing rewriting and planning). Some of the
1676  * statements do need attention from parse analysis, and this is
1677  * done by routines in parser/parse_utilcmd.c after ProcessUtility
1678  * receives the command for execution.
1679  * DECLARE CURSOR, EXPLAIN, and CREATE TABLE AS are special cases:
1680  * they contain optimizable statements, which get processed normally
1681  * by parser/analyze.c.
1682  *****************************************************************************/
1683 
1684 /*
1685  * When a command can act on several kinds of objects with only one
1686  * parse structure required, use these constants to designate the
1687  * object type. Note that commands typically don't support all the types.
1688  */
1689 
1690 typedef enum ObjectType
1691 {
1696  OBJECT_ATTRIBUTE, /* type's attribute, when distinct from column */
1742 } ObjectType;
1743 
1744 /* ----------------------
1745  * Create Schema Statement
1746  *
1747  * NOTE: the schemaElts list contains raw parsetrees for component statements
1748  * of the schema, such as CREATE TABLE, GRANT, etc. These are analyzed and
1749  * executed after the schema itself is created.
1750  * ----------------------
1751  */
1752 typedef struct CreateSchemaStmt
1753 {
1755  char *schemaname; /* the name of the schema to create */
1756  RoleSpec *authrole; /* the owner of the created schema */
1757  List *schemaElts; /* schema components (list of parsenodes) */
1758  bool if_not_exists; /* just do nothing if schema already exists? */
1760 
1761 typedef enum DropBehavior
1762 {
1763  DROP_RESTRICT, /* drop fails if any dependent objects */
1764  DROP_CASCADE /* remove dependent objects too */
1765 } DropBehavior;
1766 
1767 /* ----------------------
1768  * Alter Table
1769  * ----------------------
1770  */
1771 typedef struct AlterTableStmt
1772 {
1774  RangeVar *relation; /* table to work on */
1775  List *cmds; /* list of subcommands */
1776  ObjectType relkind; /* type of object */
1777  bool missing_ok; /* skip error if table missing */
1778 } AlterTableStmt;
1779 
1780 typedef enum AlterTableType
1781 {
1782  AT_AddColumn, /* add column */
1783  AT_AddColumnRecurse, /* internal to commands/tablecmds.c */
1784  AT_AddColumnToView, /* implicitly via CREATE OR REPLACE VIEW */
1785  AT_ColumnDefault, /* alter column default */
1786  AT_DropNotNull, /* alter column drop not null */
1787  AT_SetNotNull, /* alter column set not null */
1788  AT_DropExpression, /* alter column drop expression */
1789  AT_CheckNotNull, /* check column is already marked not null */
1790  AT_SetStatistics, /* alter column set statistics */
1791  AT_SetOptions, /* alter column set ( options ) */
1792  AT_ResetOptions, /* alter column reset ( options ) */
1793  AT_SetStorage, /* alter column set storage */
1794  AT_DropColumn, /* drop column */
1795  AT_DropColumnRecurse, /* internal to commands/tablecmds.c */
1796  AT_AddIndex, /* add index */
1797  AT_ReAddIndex, /* internal to commands/tablecmds.c */
1798  AT_AddConstraint, /* add constraint */
1799  AT_AddConstraintRecurse, /* internal to commands/tablecmds.c */
1800  AT_ReAddConstraint, /* internal to commands/tablecmds.c */
1801  AT_ReAddDomainConstraint, /* internal to commands/tablecmds.c */
1802  AT_AlterConstraint, /* alter constraint */
1803  AT_ValidateConstraint, /* validate constraint */
1804  AT_ValidateConstraintRecurse, /* internal to commands/tablecmds.c */
1805  AT_AddIndexConstraint, /* add constraint using existing index */
1806  AT_DropConstraint, /* drop constraint */
1807  AT_DropConstraintRecurse, /* internal to commands/tablecmds.c */
1808  AT_ReAddComment, /* internal to commands/tablecmds.c */
1809  AT_AlterColumnType, /* alter column type */
1810  AT_AlterColumnGenericOptions, /* alter column OPTIONS (...) */
1811  AT_ChangeOwner, /* change owner */
1812  AT_ClusterOn, /* CLUSTER ON */
1813  AT_DropCluster, /* SET WITHOUT CLUSTER */
1814  AT_SetLogged, /* SET LOGGED */
1815  AT_SetUnLogged, /* SET UNLOGGED */
1816  AT_DropOids, /* SET WITHOUT OIDS */
1817  AT_SetTableSpace, /* SET TABLESPACE */
1818  AT_SetRelOptions, /* SET (...) -- AM specific parameters */
1819  AT_ResetRelOptions, /* RESET (...) -- AM specific parameters */
1820  AT_ReplaceRelOptions, /* replace reloption list in its entirety */
1821  AT_EnableTrig, /* ENABLE TRIGGER name */
1822  AT_EnableAlwaysTrig, /* ENABLE ALWAYS TRIGGER name */
1823  AT_EnableReplicaTrig, /* ENABLE REPLICA TRIGGER name */
1824  AT_DisableTrig, /* DISABLE TRIGGER name */
1825  AT_EnableTrigAll, /* ENABLE TRIGGER ALL */
1826  AT_DisableTrigAll, /* DISABLE TRIGGER ALL */
1827  AT_EnableTrigUser, /* ENABLE TRIGGER USER */
1828  AT_DisableTrigUser, /* DISABLE TRIGGER USER */
1829  AT_EnableRule, /* ENABLE RULE name */
1830  AT_EnableAlwaysRule, /* ENABLE ALWAYS RULE name */
1831  AT_EnableReplicaRule, /* ENABLE REPLICA RULE name */
1832  AT_DisableRule, /* DISABLE RULE name */
1833  AT_AddInherit, /* INHERIT parent */
1834  AT_DropInherit, /* NO INHERIT parent */
1835  AT_AddOf, /* OF <type_name> */
1836  AT_DropOf, /* NOT OF */
1837  AT_ReplicaIdentity, /* REPLICA IDENTITY */
1838  AT_EnableRowSecurity, /* ENABLE ROW SECURITY */
1839  AT_DisableRowSecurity, /* DISABLE ROW SECURITY */
1840  AT_ForceRowSecurity, /* FORCE ROW SECURITY */
1841  AT_NoForceRowSecurity, /* NO FORCE ROW SECURITY */
1842  AT_GenericOptions, /* OPTIONS (...) */
1843  AT_AttachPartition, /* ATTACH PARTITION */
1844  AT_DetachPartition, /* DETACH PARTITION */
1845  AT_AddIdentity, /* ADD IDENTITY */
1846  AT_SetIdentity, /* SET identity column options */
1847  AT_DropIdentity /* DROP IDENTITY */
1848 } AlterTableType;
1849 
1850 typedef struct ReplicaIdentityStmt
1851 {
1854  char *name;
1856 
1857 typedef struct AlterTableCmd /* one subcommand of an ALTER TABLE */
1858 {
1860  AlterTableType subtype; /* Type of table alteration to apply */
1861  char *name; /* column, constraint, or trigger to act on,
1862  * or tablespace */
1863  int16 num; /* attribute number for columns referenced by
1864  * number */
1866  Node *def; /* definition of new column, index,
1867  * constraint, or parent table */
1868  DropBehavior behavior; /* RESTRICT or CASCADE for DROP cases */
1869  bool missing_ok; /* skip error if missing? */
1870 } AlterTableCmd;
1871 
1872 
1873 /* ----------------------
1874  * Alter Collation
1875  * ----------------------
1876  */
1877 typedef struct AlterCollationStmt
1878 {
1882 
1883 
1884 /* ----------------------
1885  * Alter Domain
1886  *
1887  * The fields are used in different ways by the different variants of
1888  * this command.
1889  * ----------------------
1890  */
1891 typedef struct AlterDomainStmt
1892 {
1894  char subtype; /*------------
1895  * T = alter column default
1896  * N = alter column drop not null
1897  * O = alter column set not null
1898  * C = add constraint
1899  * X = drop constraint
1900  *------------
1901  */
1902  List *typeName; /* domain to work on */
1903  char *name; /* column or constraint name to act on */
1904  Node *def; /* definition of default or constraint */
1905  DropBehavior behavior; /* RESTRICT or CASCADE for DROP cases */
1906  bool missing_ok; /* skip error if missing? */
1907 } AlterDomainStmt;
1908 
1909 
1910 /* ----------------------
1911  * Grant|Revoke Statement
1912  * ----------------------
1913  */
1914 typedef enum GrantTargetType
1915 {
1916  ACL_TARGET_OBJECT, /* grant on specific named object(s) */
1917  ACL_TARGET_ALL_IN_SCHEMA, /* grant on all objects in given schema(s) */
1918  ACL_TARGET_DEFAULTS /* ALTER DEFAULT PRIVILEGES */
1919 } GrantTargetType;
1920 
1921 typedef struct GrantStmt
1922 {
1924  bool is_grant; /* true = GRANT, false = REVOKE */
1925  GrantTargetType targtype; /* type of the grant target */
1926  ObjectType objtype; /* kind of object being operated on */
1927  List *objects; /* list of RangeVar nodes, ObjectWithArgs
1928  * nodes, or plain names (as Value strings) */
1929  List *privileges; /* list of AccessPriv nodes */
1930  /* privileges == NIL denotes ALL PRIVILEGES */
1931  List *grantees; /* list of RoleSpec nodes */
1932  bool grant_option; /* grant or revoke grant option */
1933  DropBehavior behavior; /* drop behavior (for REVOKE) */
1934 } GrantStmt;
1935 
1936 /*
1937  * Note: ObjectWithArgs carries only the types of the input parameters of the
1938  * function. So it is sufficient to identify an existing function, but it
1939  * is not enough info to define a function nor to call it.
1940  */
1941 typedef struct ObjectWithArgs
1942 {
1944  List *objname; /* qualified name of function/operator */
1945  List *objargs; /* list of Typename nodes */
1946  bool args_unspecified; /* argument list was omitted, so name must
1947  * be unique (note that objargs == NIL
1948  * means zero args) */
1949 } ObjectWithArgs;
1950 
1951 /*
1952  * An access privilege, with optional list of column names
1953  * priv_name == NULL denotes ALL PRIVILEGES (only used with a column list)
1954  * cols == NIL denotes "all columns"
1955  * Note that simple "ALL PRIVILEGES" is represented as a NIL list, not
1956  * an AccessPriv with both fields null.
1957  */
1958 typedef struct AccessPriv
1959 {
1961  char *priv_name; /* string name of privilege */
1962  List *cols; /* list of Value strings */
1963 } AccessPriv;
1964 
1965 /* ----------------------
1966  * Grant/Revoke Role Statement
1967  *
1968  * Note: because of the parsing ambiguity with the GRANT <privileges>
1969  * statement, granted_roles is a list of AccessPriv; the execution code
1970  * should complain if any column lists appear. grantee_roles is a list
1971  * of role names, as Value strings.
1972  * ----------------------
1973  */
1974 typedef struct GrantRoleStmt
1975 {
1977  List *granted_roles; /* list of roles to be granted/revoked */
1978  List *grantee_roles; /* list of member roles to add/delete */
1979  bool is_grant; /* true = GRANT, false = REVOKE */
1980  bool admin_opt; /* with admin option */
1981  RoleSpec *grantor; /* set grantor to other than current role */
1982  DropBehavior behavior; /* drop behavior (for REVOKE) */
1983 } GrantRoleStmt;
1984 
1985 /* ----------------------
1986  * Alter Default Privileges Statement
1987  * ----------------------
1988  */
1990 {
1992  List *options; /* list of DefElem */
1993  GrantStmt *action; /* GRANT/REVOKE action (with objects=NIL) */
1995 
1996 /* ----------------------
1997  * Copy Statement
1998  *
1999  * We support "COPY relation FROM file", "COPY relation TO file", and
2000  * "COPY (query) TO file". In any given CopyStmt, exactly one of "relation"
2001  * and "query" must be non-NULL.
2002  * ----------------------
2003  */
2004 typedef struct CopyStmt
2005 {
2007  RangeVar *relation; /* the relation to copy */
2008  Node *query; /* the query (SELECT or DML statement with
2009  * RETURNING) to copy, as a raw parse tree */
2010  List *attlist; /* List of column names (as Strings), or NIL
2011  * for all columns */
2012  bool is_from; /* TO or FROM */
2013  bool is_program; /* is 'filename' a program to popen? */
2014  char *filename; /* filename, or NULL for STDIN/STDOUT */
2015  List *options; /* List of DefElem nodes */
2016  Node *whereClause; /* WHERE condition (or NULL) */
2017 } CopyStmt;
2018 
2019 /* ----------------------
2020  * SET Statement (includes RESET)
2021  *
2022  * "SET var TO DEFAULT" and "RESET var" are semantically equivalent, but we
2023  * preserve the distinction in VariableSetKind for CreateCommandTag().
2024  * ----------------------
2025  */
2026 typedef enum
2027 {
2028  VAR_SET_VALUE, /* SET var = value */
2029  VAR_SET_DEFAULT, /* SET var TO DEFAULT */
2030  VAR_SET_CURRENT, /* SET var FROM CURRENT */
2031  VAR_SET_MULTI, /* special case for SET TRANSACTION ... */
2032  VAR_RESET, /* RESET var */
2033  VAR_RESET_ALL /* RESET ALL */
2034 } VariableSetKind;
2035 
2036 typedef struct VariableSetStmt
2037 {
2040  char *name; /* variable to be set */
2041  List *args; /* List of A_Const nodes */
2042  bool is_local; /* SET LOCAL? */
2043 } VariableSetStmt;
2044 
2045 /* ----------------------
2046  * Show Statement
2047  * ----------------------
2048  */
2049 typedef struct VariableShowStmt
2050 {
2052  char *name;
2054 
2055 /* ----------------------
2056  * Create Table Statement
2057  *
2058  * NOTE: in the raw gram.y output, ColumnDef and Constraint nodes are
2059  * intermixed in tableElts, and constraints is NIL. After parse analysis,
2060  * tableElts contains just ColumnDefs, and constraints contains just
2061  * Constraint nodes (in fact, only CONSTR_CHECK nodes, in the present
2062  * implementation).
2063  * ----------------------
2064  */
2065 
2066 typedef struct CreateStmt
2067 {
2069  RangeVar *relation; /* relation to create */
2070  List *tableElts; /* column definitions (list of ColumnDef) */
2071  List *inhRelations; /* relations to inherit from (list of
2072  * inhRelation) */
2073  PartitionBoundSpec *partbound; /* FOR VALUES clause */
2074  PartitionSpec *partspec; /* PARTITION BY clause */
2075  TypeName *ofTypename; /* OF typename */
2076  List *constraints; /* constraints (list of Constraint nodes) */
2077  List *options; /* options from WITH clause */
2078  OnCommitAction oncommit; /* what do we do at COMMIT? */
2079  char *tablespacename; /* table space to use, or NULL */
2080  char *accessMethod; /* table access method */
2081  bool if_not_exists; /* just do nothing if it already exists? */
2082 } CreateStmt;
2083 
2084 /* ----------
2085  * Definitions for constraints in CreateStmt
2086  *
2087  * Note that column defaults are treated as a type of constraint,
2088  * even though that's a bit odd semantically.
2089  *
2090  * For constraints that use expressions (CONSTR_CHECK, CONSTR_DEFAULT)
2091  * we may have the expression in either "raw" form (an untransformed
2092  * parse tree) or "cooked" form (the nodeToString representation of
2093  * an executable expression tree), depending on how this Constraint
2094  * node was created (by parsing, or by inheritance from an existing
2095  * relation). We should never have both in the same node!
2096  *
2097  * FKCONSTR_ACTION_xxx values are stored into pg_constraint.confupdtype
2098  * and pg_constraint.confdeltype columns; FKCONSTR_MATCH_xxx values are
2099  * stored into pg_constraint.confmatchtype. Changing the code values may
2100  * require an initdb!
2101  *
2102  * If skip_validation is true then we skip checking that the existing rows
2103  * in the table satisfy the constraint, and just install the catalog entries
2104  * for the constraint. A new FK constraint is marked as valid iff
2105  * initially_valid is true. (Usually skip_validation and initially_valid
2106  * are inverses, but we can set both true if the table is known empty.)
2107  *
2108  * Constraint attributes (DEFERRABLE etc) are initially represented as
2109  * separate Constraint nodes for simplicity of parsing. parse_utilcmd.c makes
2110  * a pass through the constraints list to insert the info into the appropriate
2111  * Constraint node.
2112  * ----------
2113  */
2114 
2115 typedef enum ConstrType /* types of constraints */
2116 {
2117  CONSTR_NULL, /* not standard SQL, but a lot of people
2118  * expect it */
2128  CONSTR_ATTR_DEFERRABLE, /* attributes for previous constraint node */
2132 } ConstrType;
2133 
2134 /* Foreign key action codes */
2135 #define FKCONSTR_ACTION_NOACTION 'a'
2136 #define FKCONSTR_ACTION_RESTRICT 'r'
2137 #define FKCONSTR_ACTION_CASCADE 'c'
2138 #define FKCONSTR_ACTION_SETNULL 'n'
2139 #define FKCONSTR_ACTION_SETDEFAULT 'd'
2140 
2141 /* Foreign key matchtype codes */
2142 #define FKCONSTR_MATCH_FULL 'f'
2143 #define FKCONSTR_MATCH_PARTIAL 'p'
2144 #define FKCONSTR_MATCH_SIMPLE 's'
2145 
2146 typedef struct Constraint
2147 {
2149  ConstrType contype; /* see above */
2150 
2151  /* Fields used for most/all constraint types: */
2152  char *conname; /* Constraint name, or NULL if unnamed */
2153  bool deferrable; /* DEFERRABLE? */
2154  bool initdeferred; /* INITIALLY DEFERRED? */
2155  int location; /* token location, or -1 if unknown */
2156 
2157  /* Fields used for constraints with expressions (CHECK and DEFAULT): */
2158  bool is_no_inherit; /* is constraint non-inheritable? */
2159  Node *raw_expr; /* expr, as untransformed parse tree */
2160  char *cooked_expr; /* expr, as nodeToString representation */
2161  char generated_when; /* ALWAYS or BY DEFAULT */
2162 
2163  /* Fields used for unique constraints (UNIQUE and PRIMARY KEY): */
2164  List *keys; /* String nodes naming referenced key
2165  * column(s) */
2166  List *including; /* String nodes naming referenced nonkey
2167  * column(s) */
2168 
2169  /* Fields used for EXCLUSION constraints: */
2170  List *exclusions; /* list of (IndexElem, operator name) pairs */
2171 
2172  /* Fields used for index constraints (UNIQUE, PRIMARY KEY, EXCLUSION): */
2173  List *options; /* options from WITH clause */
2174  char *indexname; /* existing index to use; otherwise NULL */
2175  char *indexspace; /* index tablespace; NULL for default */
2176  bool reset_default_tblspc; /* reset default_tablespace prior to
2177  * creating the index */
2178  /* These could be, but currently are not, used for UNIQUE/PKEY: */
2179  char *access_method; /* index access method; NULL for default */
2180  Node *where_clause; /* partial index predicate */
2181 
2182  /* Fields used for FOREIGN KEY constraints: */
2183  RangeVar *pktable; /* Primary key table */
2184  List *fk_attrs; /* Attributes of foreign key */
2185  List *pk_attrs; /* Corresponding attrs in PK table */
2186  char fk_matchtype; /* FULL, PARTIAL, SIMPLE */
2187  char fk_upd_action; /* ON UPDATE action */
2188  char fk_del_action; /* ON DELETE action */
2189  List *old_conpfeqop; /* pg_constraint.conpfeqop of my former self */
2190  Oid old_pktable_oid; /* pg_constraint.confrelid of my former
2191  * self */
2192 
2193  /* Fields used for constraints that allow a NOT VALID specification */
2194  bool skip_validation; /* skip validation of existing rows? */
2195  bool initially_valid; /* mark the new constraint as valid? */
2196 } Constraint;
2197 
2198 /* ----------------------
2199  * Create/Drop Table Space Statements
2200  * ----------------------
2201  */
2202 
2203 typedef struct CreateTableSpaceStmt
2204 {
2208  char *location;
2211 
2212 typedef struct DropTableSpaceStmt
2213 {
2216  bool missing_ok; /* skip error if missing? */
2218 
2220 {
2224  bool isReset;
2226 
2228 {
2231  ObjectType objtype; /* Object type to move */
2232  List *roles; /* List of roles to move objects of */
2234  bool nowait;
2236 
2237 /* ----------------------
2238  * Create/Alter Extension Statements
2239  * ----------------------
2240  */
2241 
2242 typedef struct CreateExtensionStmt
2243 {
2245  char *extname;
2246  bool if_not_exists; /* just do nothing if it already exists? */
2247  List *options; /* List of DefElem nodes */
2249 
2250 /* Only used for ALTER EXTENSION UPDATE; later might need an action field */
2251 typedef struct AlterExtensionStmt
2252 {
2254  char *extname;
2255  List *options; /* List of DefElem nodes */
2257 
2259 {
2261  char *extname; /* Extension's name */
2262  int action; /* +1 = add object, -1 = drop object */
2263  ObjectType objtype; /* Object's type */
2264  Node *object; /* Qualified name of the object */
2266 
2267 /* ----------------------
2268  * Create/Alter FOREIGN DATA WRAPPER Statements
2269  * ----------------------
2270  */
2271 
2272 typedef struct CreateFdwStmt
2273 {
2275  char *fdwname; /* foreign-data wrapper name */
2276  List *func_options; /* HANDLER/VALIDATOR options */
2277  List *options; /* generic options to FDW */
2278 } CreateFdwStmt;
2279 
2280 typedef struct AlterFdwStmt
2281 {
2283  char *fdwname; /* foreign-data wrapper name */
2284  List *func_options; /* HANDLER/VALIDATOR options */
2285  List *options; /* generic options to FDW */
2286 } AlterFdwStmt;
2287 
2288 /* ----------------------
2289  * Create/Alter FOREIGN SERVER Statements
2290  * ----------------------
2291  */
2292 
2294 {
2296  char *servername; /* server name */
2297  char *servertype; /* optional server type */
2298  char *version; /* optional server version */
2299  char *fdwname; /* FDW name */
2300  bool if_not_exists; /* just do nothing if it already exists? */
2301  List *options; /* generic options to server */
2303 
2305 {
2307  char *servername; /* server name */
2308  char *version; /* optional server version */
2309  List *options; /* generic options to server */
2310  bool has_version; /* version specified */
2312 
2313 /* ----------------------
2314  * Create FOREIGN TABLE Statement
2315  * ----------------------
2316  */
2317 
2319 {
2321  char *servername;
2324 
2325 /* ----------------------
2326  * Create/Drop USER MAPPING Statements
2327  * ----------------------
2328  */
2329 
2331 {
2333  RoleSpec *user; /* user role */
2334  char *servername; /* server name */
2335  bool if_not_exists; /* just do nothing if it already exists? */
2336  List *options; /* generic options to server */
2338 
2339 typedef struct AlterUserMappingStmt
2340 {
2342  RoleSpec *user; /* user role */
2343  char *servername; /* server name */
2344  List *options; /* generic options to server */
2346 
2347 typedef struct DropUserMappingStmt
2348 {
2350  RoleSpec *user; /* user role */
2351  char *servername; /* server name */
2352  bool missing_ok; /* ignore missing mappings */
2354 
2355 /* ----------------------
2356  * Import Foreign Schema Statement
2357  * ----------------------
2358  */
2359 
2361 {
2362  FDW_IMPORT_SCHEMA_ALL, /* all relations wanted */
2363  FDW_IMPORT_SCHEMA_LIMIT_TO, /* include only listed tables in import */
2364  FDW_IMPORT_SCHEMA_EXCEPT /* exclude listed tables from import */
2366 
2368 {
2370  char *server_name; /* FDW server name */
2371  char *remote_schema; /* remote schema name to query */
2372  char *local_schema; /* local schema to create objects in */
2373  ImportForeignSchemaType list_type; /* type of table list */
2374  List *table_list; /* List of RangeVar */
2375  List *options; /* list of options to pass to FDW */
2377 
2378 /*----------------------
2379  * Create POLICY Statement
2380  *----------------------
2381  */
2382 typedef struct CreatePolicyStmt
2383 {
2385  char *policy_name; /* Policy's name */
2386  RangeVar *table; /* the table name the policy applies to */
2387  char *cmd_name; /* the command name the policy applies to */
2388  bool permissive; /* restrictive or permissive policy */
2389  List *roles; /* the roles associated with the policy */
2390  Node *qual; /* the policy's condition */
2391  Node *with_check; /* the policy's WITH CHECK condition. */
2393 
2394 /*----------------------
2395  * Alter POLICY Statement
2396  *----------------------
2397  */
2398 typedef struct AlterPolicyStmt
2399 {
2401  char *policy_name; /* Policy's name */
2402  RangeVar *table; /* the table name the policy applies to */
2403  List *roles; /* the roles associated with the policy */
2404  Node *qual; /* the policy's condition */
2405  Node *with_check; /* the policy's WITH CHECK condition. */
2406 } AlterPolicyStmt;
2407 
2408 /*----------------------
2409  * Create ACCESS METHOD Statement
2410  *----------------------
2411  */
2412 typedef struct CreateAmStmt
2413 {
2415  char *amname; /* access method name */
2416  List *handler_name; /* handler function name */
2417  char amtype; /* type of access method */
2418 } CreateAmStmt;
2419 
2420 /* ----------------------
2421  * Create TRIGGER Statement
2422  * ----------------------
2423  */
2424 typedef struct CreateTrigStmt
2425 {
2427  char *trigname; /* TRIGGER's name */
2428  RangeVar *relation; /* relation trigger is on */
2429  List *funcname; /* qual. name of function to call */
2430  List *args; /* list of (T_String) Values or NIL */
2431  bool row; /* ROW/STATEMENT */
2432  /* timing uses the TRIGGER_TYPE bits defined in catalog/pg_trigger.h */
2433  int16 timing; /* BEFORE, AFTER, or INSTEAD */
2434  /* events uses the TRIGGER_TYPE bits defined in catalog/pg_trigger.h */
2435  int16 events; /* "OR" of INSERT/UPDATE/DELETE/TRUNCATE */
2436  List *columns; /* column names, or NIL for all columns */
2437  Node *whenClause; /* qual expression, or NULL if none */
2438  bool isconstraint; /* This is a constraint trigger */
2439  /* explicitly named transition data */
2440  List *transitionRels; /* TriggerTransition nodes, or NIL if none */
2441  /* The remaining fields are only used for constraint triggers */
2442  bool deferrable; /* [NOT] DEFERRABLE */
2443  bool initdeferred; /* INITIALLY {DEFERRED|IMMEDIATE} */
2444  RangeVar *constrrel; /* opposite relation, if RI trigger */
2445 } CreateTrigStmt;
2446 
2447 /* ----------------------
2448  * Create EVENT TRIGGER Statement
2449  * ----------------------
2450  */
2451 typedef struct CreateEventTrigStmt
2452 {
2454  char *trigname; /* TRIGGER's name */
2455  char *eventname; /* event's identifier */
2456  List *whenclause; /* list of DefElems indicating filtering */
2457  List *funcname; /* qual. name of function to call */
2459 
2460 /* ----------------------
2461  * Alter EVENT TRIGGER Statement
2462  * ----------------------
2463  */
2464 typedef struct AlterEventTrigStmt
2465 {
2467  char *trigname; /* TRIGGER's name */
2468  char tgenabled; /* trigger's firing configuration WRT
2469  * session_replication_role */
2471 
2472 /* ----------------------
2473  * Create LANGUAGE Statements
2474  * ----------------------
2475  */
2476 typedef struct CreatePLangStmt
2477 {
2479  bool replace; /* T => replace if already exists */
2480  char *plname; /* PL name */
2481  List *plhandler; /* PL call handler function (qual. name) */
2482  List *plinline; /* optional inline function (qual. name) */
2483  List *plvalidator; /* optional validator function (qual. name) */
2484  bool pltrusted; /* PL is trusted */
2485 } CreatePLangStmt;
2486 
2487 /* ----------------------
2488  * Create/Alter/Drop Role Statements
2489  *
2490  * Note: these node types are also used for the backwards-compatible
2491  * Create/Alter/Drop User/Group statements. In the ALTER and DROP cases
2492  * there's really no need to distinguish what the original spelling was,
2493  * but for CREATE we mark the type because the defaults vary.
2494  * ----------------------
2495  */
2496 typedef enum RoleStmtType
2497 {
2501 } RoleStmtType;
2502 
2503 typedef struct CreateRoleStmt
2504 {
2506  RoleStmtType stmt_type; /* ROLE/USER/GROUP */
2507  char *role; /* role name */
2508  List *options; /* List of DefElem nodes */
2509 } CreateRoleStmt;
2510 
2511 typedef struct AlterRoleStmt
2512 {
2514  RoleSpec *role; /* role */
2515  List *options; /* List of DefElem nodes */
2516  int action; /* +1 = add members, -1 = drop members */
2517 } AlterRoleStmt;
2518 
2519 typedef struct AlterRoleSetStmt
2520 {
2522  RoleSpec *role; /* role */
2523  char *database; /* database name, or NULL */
2524  VariableSetStmt *setstmt; /* SET or RESET subcommand */
2526 
2527 typedef struct DropRoleStmt
2528 {
2530  List *roles; /* List of roles to remove */
2531  bool missing_ok; /* skip error if a role is missing? */
2532 } DropRoleStmt;
2533 
2534 /* ----------------------
2535  * {Create|Alter} SEQUENCE Statement
2536  * ----------------------
2537  */
2538 
2539 typedef struct CreateSeqStmt
2540 {
2542  RangeVar *sequence; /* the sequence to create */
2544  Oid ownerId; /* ID of owner, or InvalidOid for default */
2546  bool if_not_exists; /* just do nothing if it already exists? */
2547 } CreateSeqStmt;
2548 
2549 typedef struct AlterSeqStmt
2550 {
2552  RangeVar *sequence; /* the sequence to alter */
2555  bool missing_ok; /* skip error if a role is missing? */
2556 } AlterSeqStmt;
2557 
2558 /* ----------------------
2559  * Create {Aggregate|Operator|Type} Statement
2560  * ----------------------
2561  */
2562 typedef struct DefineStmt
2563 {
2565  ObjectType kind; /* aggregate, operator, type */
2566  bool oldstyle; /* hack to signal old CREATE AGG syntax */
2567  List *defnames; /* qualified name (list of Value strings) */
2568  List *args; /* a list of TypeName (if needed) */
2569  List *definition; /* a list of DefElem */
2570  bool if_not_exists; /* just do nothing if it already exists? */
2571  bool replace; /* replace if already exists? */
2572 } DefineStmt;
2573 
2574 /* ----------------------
2575  * Create Domain Statement
2576  * ----------------------
2577  */
2578 typedef struct CreateDomainStmt
2579 {
2581  List *domainname; /* qualified name (list of Value strings) */
2582  TypeName *typeName; /* the base type */
2583  CollateClause *collClause; /* untransformed COLLATE spec, if any */
2584  List *constraints; /* constraints (list of Constraint nodes) */
2586 
2587 /* ----------------------
2588  * Create Operator Class Statement
2589  * ----------------------
2590  */
2591 typedef struct CreateOpClassStmt
2592 {
2594  List *opclassname; /* qualified name (list of Value strings) */
2595  List *opfamilyname; /* qualified name (ditto); NIL if omitted */
2596  char *amname; /* name of index AM opclass is for */
2597  TypeName *datatype; /* datatype of indexed column */
2598  List *items; /* List of CreateOpClassItem nodes */
2599  bool isDefault; /* Should be marked as default for type? */
2601 
2602 #define OPCLASS_ITEM_OPERATOR 1
2603 #define OPCLASS_ITEM_FUNCTION 2
2604 #define OPCLASS_ITEM_STORAGETYPE 3
2605 
2606 typedef struct CreateOpClassItem
2607 {
2609  int itemtype; /* see codes above */
2610  ObjectWithArgs *name; /* operator or function name and args */
2611  int number; /* strategy num or support proc num */
2612  List *order_family; /* only used for ordering operators */
2613  List *class_args; /* amproclefttype/amprocrighttype or
2614  * amoplefttype/amoprighttype */
2615  /* fields used for a storagetype item: */
2616  TypeName *storedtype; /* datatype stored in index */
2618 
2619 /* ----------------------
2620  * Create Operator Family Statement
2621  * ----------------------
2622  */
2623 typedef struct CreateOpFamilyStmt
2624 {
2626  List *opfamilyname; /* qualified name (list of Value strings) */
2627  char *amname; /* name of index AM opfamily is for */
2629 
2630 /* ----------------------
2631  * Alter Operator Family Statement
2632  * ----------------------
2633  */
2634 typedef struct AlterOpFamilyStmt
2635 {
2637  List *opfamilyname; /* qualified name (list of Value strings) */
2638  char *amname; /* name of index AM opfamily is for */
2639  bool isDrop; /* ADD or DROP the items? */
2640  List *items; /* List of CreateOpClassItem nodes */
2642 
2643 /* ----------------------
2644  * Drop Table|Sequence|View|Index|Type|Domain|Conversion|Schema Statement
2645  * ----------------------
2646  */
2647 
2648 typedef struct DropStmt
2649 {
2651  List *objects; /* list of names */
2652  ObjectType removeType; /* object type */
2653  DropBehavior behavior; /* RESTRICT or CASCADE behavior */
2654  bool missing_ok; /* skip error if object is missing? */
2655  bool concurrent; /* drop index concurrently? */
2656 } DropStmt;
2657 
2658 /* ----------------------
2659  * Truncate Table Statement
2660  * ----------------------
2661  */
2662 typedef struct TruncateStmt
2663 {
2665  List *relations; /* relations (RangeVars) to be truncated */
2666  bool restart_seqs; /* restart owned sequences? */
2667  DropBehavior behavior; /* RESTRICT or CASCADE behavior */
2668 } TruncateStmt;
2669 
2670 /* ----------------------
2671  * Comment On Statement
2672  * ----------------------
2673  */
2674 typedef struct CommentStmt
2675 {
2677  ObjectType objtype; /* Object's type */
2678  Node *object; /* Qualified name of the object */
2679  char *comment; /* Comment to insert, or NULL to remove */
2680 } CommentStmt;
2681 
2682 /* ----------------------
2683  * SECURITY LABEL Statement
2684  * ----------------------
2685  */
2686 typedef struct SecLabelStmt
2687 {
2689  ObjectType objtype; /* Object's type */
2690  Node *object; /* Qualified name of the object */
2691  char *provider; /* Label provider (or NULL) */
2692  char *label; /* New security label to be assigned */
2693 } SecLabelStmt;
2694 
2695 /* ----------------------
2696  * Declare Cursor Statement
2697  *
2698  * The "query" field is initially a raw parse tree, and is converted to a
2699  * Query node during parse analysis. Note that rewriting and planning
2700  * of the query are always postponed until execution.
2701  * ----------------------
2702  */
2703 #define CURSOR_OPT_BINARY 0x0001 /* BINARY */
2704 #define CURSOR_OPT_SCROLL 0x0002 /* SCROLL explicitly given */
2705 #define CURSOR_OPT_NO_SCROLL 0x0004 /* NO SCROLL explicitly given */
2706 #define CURSOR_OPT_INSENSITIVE 0x0008 /* INSENSITIVE */
2707 #define CURSOR_OPT_HOLD 0x0010 /* WITH HOLD */
2708 /* these planner-control flags do not correspond to any SQL grammar: */
2709 #define CURSOR_OPT_FAST_PLAN 0x0020 /* prefer fast-start plan */
2710 #define CURSOR_OPT_GENERIC_PLAN 0x0040 /* force use of generic plan */
2711 #define CURSOR_OPT_CUSTOM_PLAN 0x0080 /* force use of custom plan */
2712 #define CURSOR_OPT_PARALLEL_OK 0x0100 /* parallel mode OK */
2713 
2714 typedef struct DeclareCursorStmt
2715 {
2717  char *portalname; /* name of the portal (cursor) */
2718  int options; /* bitmask of options (see above) */
2719  Node *query; /* the query (see comments above) */
2721 
2722 /* ----------------------
2723  * Close Portal Statement
2724  * ----------------------
2725  */
2726 typedef struct ClosePortalStmt
2727 {
2729  char *portalname; /* name of the portal (cursor) */
2730  /* NULL means CLOSE ALL */
2731 } ClosePortalStmt;
2732 
2733 /* ----------------------
2734  * Fetch Statement (also Move)
2735  * ----------------------
2736  */
2737 typedef enum FetchDirection
2738 {
2739  /* for these, howMany is how many rows to fetch; FETCH_ALL means ALL */
2742  /* for these, howMany indicates a position; only one row is fetched */
2745 } FetchDirection;
2746 
2747 #define FETCH_ALL LONG_MAX
2748 
2749 typedef struct FetchStmt
2750 {
2752  FetchDirection direction; /* see above */
2753  long howMany; /* number of rows, or position argument */
2754  char *portalname; /* name of portal (cursor) */
2755  bool ismove; /* true if MOVE */
2756 } FetchStmt;
2757 
2758 /* ----------------------
2759  * Create Index Statement
2760  *
2761  * This represents creation of an index and/or an associated constraint.
2762  * If isconstraint is true, we should create a pg_constraint entry along
2763  * with the index. But if indexOid isn't InvalidOid, we are not creating an
2764  * index, just a UNIQUE/PKEY constraint using an existing index. isconstraint
2765  * must always be true in this case, and the fields describing the index
2766  * properties are empty.
2767  * ----------------------
2768  */
2769 typedef struct IndexStmt
2770 {
2772  char *idxname; /* name of new index, or NULL for default */
2773  RangeVar *relation; /* relation to build index on */
2774  char *accessMethod; /* name of access method (eg. btree) */
2775  char *tableSpace; /* tablespace, or NULL for default */
2776  List *indexParams; /* columns to index: a list of IndexElem */
2777  List *indexIncludingParams; /* additional columns to index: a list
2778  * of IndexElem */
2779  List *options; /* WITH clause options: a list of DefElem */
2780  Node *whereClause; /* qualification (partial-index predicate) */
2781  List *excludeOpNames; /* exclusion operator names, or NIL if none */
2782  char *idxcomment; /* comment to apply to index, or NULL */
2783  Oid indexOid; /* OID of an existing index, if any */
2784  Oid oldNode; /* relfilenode of existing storage, if any */
2785  bool unique; /* is index unique? */
2786  bool primary; /* is index a primary key? */
2787  bool isconstraint; /* is it for a pkey/unique constraint? */
2788  bool deferrable; /* is the constraint DEFERRABLE? */
2789  bool initdeferred; /* is the constraint INITIALLY DEFERRED? */
2790  bool transformed; /* true when transformIndexStmt is finished */
2791  bool concurrent; /* should this be a concurrent index build? */
2792  bool if_not_exists; /* just do nothing if index already exists? */
2793  bool reset_default_tblspc; /* reset default_tablespace prior to
2794  * executing */
2795 } IndexStmt;
2796 
2797 /* ----------------------
2798  * Create Statistics Statement
2799  * ----------------------
2800  */
2801 typedef struct CreateStatsStmt
2802 {
2804  List *defnames; /* qualified name (list of Value strings) */
2805  List *stat_types; /* stat types (list of Value strings) */
2806  List *exprs; /* expressions to build statistics on */
2807  List *relations; /* rels to build stats on (list of RangeVar) */
2808  char *stxcomment; /* comment to apply to stats, or NULL */
2809  bool if_not_exists; /* do nothing if stats name already exists */
2810 } CreateStatsStmt;
2811 
2812 /* ----------------------
2813  * Alter Statistics Statement
2814  * ----------------------
2815  */
2816 typedef struct AlterStatsStmt
2817 {
2819  List *defnames; /* qualified name (list of Value strings) */
2820  int stxstattarget; /* statistics target */
2821  bool missing_ok; /* skip error if statistics object is missing */
2822 } AlterStatsStmt;
2823 
2824 /* ----------------------
2825  * Create Function Statement
2826  * ----------------------
2827  */
2828 typedef struct CreateFunctionStmt
2829 {
2831  bool is_procedure; /* it's really CREATE PROCEDURE */
2832  bool replace; /* T => replace if already exists */
2833  List *funcname; /* qualified name of function to create */
2834  List *parameters; /* a list of FunctionParameter */
2835  TypeName *returnType; /* the return type */
2836  List *options; /* a list of DefElem */
2838 
2840 {
2841  /* the assigned enum values appear in pg_proc, don't change 'em! */
2842  FUNC_PARAM_IN = 'i', /* input only */
2843  FUNC_PARAM_OUT = 'o', /* output only */
2844  FUNC_PARAM_INOUT = 'b', /* both */
2845  FUNC_PARAM_VARIADIC = 'v', /* variadic (always input) */
2846  FUNC_PARAM_TABLE = 't' /* table function output column */
2848 
2849 typedef struct FunctionParameter
2850 {
2852  char *name; /* parameter name, or NULL if not given */
2853  TypeName *argType; /* TypeName for parameter type */
2854  FunctionParameterMode mode; /* IN/OUT/etc */
2855  Node *defexpr; /* raw default expr, or NULL if not given */
2857 
2858 typedef struct AlterFunctionStmt
2859 {
2862  ObjectWithArgs *func; /* name and args of function */
2863  List *actions; /* list of DefElem */
2865 
2866 /* ----------------------
2867  * DO Statement
2868  *
2869  * DoStmt is the raw parser output, InlineCodeBlock is the execution-time API
2870  * ----------------------
2871  */
2872 typedef struct DoStmt
2873 {
2875  List *args; /* List of DefElem nodes */
2876 } DoStmt;
2877 
2878 typedef struct InlineCodeBlock
2879 {
2881  char *source_text; /* source text of anonymous code block */
2882  Oid langOid; /* OID of selected language */
2883  bool langIsTrusted; /* trusted property of the language */
2884  bool atomic; /* atomic execution context */
2885 } InlineCodeBlock;
2886 
2887 /* ----------------------
2888  * CALL statement
2889  * ----------------------
2890  */
2891 typedef struct CallStmt
2892 {
2894  FuncCall *funccall; /* from the parser */
2895  FuncExpr *funcexpr; /* transformed */
2896 } CallStmt;
2897 
2898 typedef struct CallContext
2899 {
2901  bool atomic;
2902 } CallContext;
2903 
2904 /* ----------------------
2905  * Alter Object Rename Statement
2906  * ----------------------
2907  */
2908 typedef struct RenameStmt
2909 {
2911  ObjectType renameType; /* OBJECT_TABLE, OBJECT_COLUMN, etc */
2912  ObjectType relationType; /* if column name, associated relation type */
2913  RangeVar *relation; /* in case it's a table */
2914  Node *object; /* in case it's some other object */
2915  char *subname; /* name of contained object (column, rule,
2916  * trigger, etc) */
2917  char *newname; /* the new name */
2918  DropBehavior behavior; /* RESTRICT or CASCADE behavior */
2919  bool missing_ok; /* skip error if missing? */
2920 } RenameStmt;
2921 
2922 /* ----------------------
2923  * ALTER object DEPENDS ON EXTENSION extname
2924  * ----------------------
2925  */
2927 {
2929  ObjectType objectType; /* OBJECT_FUNCTION, OBJECT_TRIGGER, etc */
2930  RangeVar *relation; /* in case a table is involved */
2931  Node *object; /* name of the object */
2932  Value *extname; /* extension name */
2934 
2935 /* ----------------------
2936  * ALTER object SET SCHEMA Statement
2937  * ----------------------
2938  */
2940 {
2942  ObjectType objectType; /* OBJECT_TABLE, OBJECT_TYPE, etc */
2943  RangeVar *relation; /* in case it's a table */
2944  Node *object; /* in case it's some other object */
2945  char *newschema; /* the new schema */
2946  bool missing_ok; /* skip error if missing? */
2948 
2949 /* ----------------------
2950  * Alter Object Owner Statement
2951  * ----------------------
2952  */
2953 typedef struct AlterOwnerStmt
2954 {
2956  ObjectType objectType; /* OBJECT_TABLE, OBJECT_TYPE, etc */
2957  RangeVar *relation; /* in case it's a table */
2958  Node *object; /* in case it's some other object */
2959  RoleSpec *newowner; /* the new owner */
2960 } AlterOwnerStmt;
2961 
2962 
2963 /* ----------------------
2964  * Alter Operator Set Restrict, Join
2965  * ----------------------
2966  */
2967 typedef struct AlterOperatorStmt
2968 {
2970  ObjectWithArgs *opername; /* operator name and argument types */
2971  List *options; /* List of DefElem nodes */
2973 
2974 
2975 /* ----------------------
2976  * Create Rule Statement
2977  * ----------------------
2978  */
2979 typedef struct RuleStmt
2980 {
2982  RangeVar *relation; /* relation the rule is for */
2983  char *rulename; /* name of the rule */
2984  Node *whereClause; /* qualifications */
2985  CmdType event; /* SELECT, INSERT, etc */
2986  bool instead; /* is a 'do instead'? */
2987  List *actions; /* the action statements */
2988  bool replace; /* OR REPLACE */
2989 } RuleStmt;
2990 
2991 /* ----------------------
2992  * Notify Statement
2993  * ----------------------
2994  */
2995 typedef struct NotifyStmt
2996 {
2998  char *conditionname; /* condition name to notify */
2999  char *payload; /* the payload string, or NULL if none */
3000 } NotifyStmt;
3001 
3002 /* ----------------------
3003  * Listen Statement
3004  * ----------------------
3005  */
3006 typedef struct ListenStmt
3007 {
3009  char *conditionname; /* condition name to listen on */
3010 } ListenStmt;
3011 
3012 /* ----------------------
3013  * Unlisten Statement
3014  * ----------------------
3015  */
3016 typedef struct UnlistenStmt
3017 {
3019  char *conditionname; /* name to unlisten on, or NULL for all */
3020 } UnlistenStmt;
3021 
3022 /* ----------------------
3023  * {Begin|Commit|Rollback} Transaction Statement
3024  * ----------------------
3025  */
3027 {
3029  TRANS_STMT_START, /* semantically identical to BEGIN */
3039 
3040 typedef struct TransactionStmt
3041 {
3043  TransactionStmtKind kind; /* see above */
3044  List *options; /* for BEGIN/START commands */
3045  char *savepoint_name; /* for savepoint commands */
3046  char *gid; /* for two-phase-commit related commands */
3047  bool chain; /* AND CHAIN option */
3048 } TransactionStmt;
3049 
3050 /* ----------------------
3051  * Create Type Statement, composite types
3052  * ----------------------
3053  */
3054 typedef struct CompositeTypeStmt
3055 {
3057  RangeVar *typevar; /* the composite type to be created */
3058  List *coldeflist; /* list of ColumnDef nodes */
3060 
3061 /* ----------------------
3062  * Create Type Statement, enum types
3063  * ----------------------
3064  */
3065 typedef struct CreateEnumStmt
3066 {
3068  List *typeName; /* qualified name (list of Value strings) */
3069  List *vals; /* enum values (list of Value strings) */
3070 } CreateEnumStmt;
3071 
3072 /* ----------------------
3073  * Create Type Statement, range types
3074  * ----------------------
3075  */
3076 typedef struct CreateRangeStmt
3077 {
3079  List *typeName; /* qualified name (list of Value strings) */
3080  List *params; /* range parameters (list of DefElem) */
3081 } CreateRangeStmt;
3082 
3083 /* ----------------------
3084  * Alter Type Statement, enum types
3085  * ----------------------
3086  */
3087 typedef struct AlterEnumStmt
3088 {
3090  List *typeName; /* qualified name (list of Value strings) */
3091  char *oldVal; /* old enum value's name, if renaming */
3092  char *newVal; /* new enum value's name */
3093  char *newValNeighbor; /* neighboring enum value, if specified */
3094  bool newValIsAfter; /* place new enum value after neighbor? */
3095  bool skipIfNewValExists; /* no error if new already exists? */
3096 } AlterEnumStmt;
3097 
3098 /* ----------------------
3099  * Create View Statement
3100  * ----------------------
3101  */
3102 typedef enum ViewCheckOption
3103 {
3107 } ViewCheckOption;
3108 
3109 typedef struct ViewStmt
3110 {
3112  RangeVar *view; /* the view to be created */
3113  List *aliases; /* target column names */
3114  Node *query; /* the SELECT query (as a raw parse tree) */
3115  bool replace; /* replace an existing view? */
3116  List *options; /* options from WITH clause */
3117  ViewCheckOption withCheckOption; /* WITH CHECK OPTION */
3118 } ViewStmt;
3119 
3120 /* ----------------------
3121  * Load Statement
3122  * ----------------------
3123  */
3124 typedef struct LoadStmt
3125 {
3127  char *filename; /* file to load */
3128 } LoadStmt;
3129 
3130 /* ----------------------
3131  * Createdb Statement
3132  * ----------------------
3133  */
3134 typedef struct CreatedbStmt
3135 {
3137  char *dbname; /* name of database to create */
3138  List *options; /* List of DefElem nodes */
3139 } CreatedbStmt;
3140 
3141 /* ----------------------
3142  * Alter Database
3143  * ----------------------
3144  */
3145 typedef struct AlterDatabaseStmt
3146 {
3148  char *dbname; /* name of database to alter */
3149  List *options; /* List of DefElem nodes */
3151 
3152 typedef struct AlterDatabaseSetStmt
3153 {
3155  char *dbname; /* database name */
3156  VariableSetStmt *setstmt; /* SET or RESET subcommand */
3158 
3159 /* ----------------------
3160  * Dropdb Statement
3161  * ----------------------
3162  */
3163 typedef struct DropdbStmt
3164 {
3166  char *dbname; /* database to drop */
3167  bool missing_ok; /* skip error if db is missing? */
3168  List *options; /* currently only FORCE is supported */
3169 } DropdbStmt;
3170 
3171 /* ----------------------
3172  * Alter System Statement
3173  * ----------------------
3174  */
3175 typedef struct AlterSystemStmt
3176 {
3178  VariableSetStmt *setstmt; /* SET subcommand */
3179 } AlterSystemStmt;
3180 
3181 /* ----------------------
3182  * Cluster Statement (support pbrown's cluster index implementation)
3183  * ----------------------
3184  */
3185 typedef enum ClusterOption
3186 {
3187  CLUOPT_RECHECK = 1 << 0, /* recheck relation state */
3188  CLUOPT_VERBOSE = 1 << 1 /* print progress info */
3189 } ClusterOption;
3190 
3191 typedef struct ClusterStmt
3192 {
3194  RangeVar *relation; /* relation being indexed, or NULL if all */
3195  char *indexname; /* original index defined */
3196  int options; /* OR of ClusterOption flags */
3197 } ClusterStmt;
3198 
3199 /* ----------------------
3200  * Vacuum and Analyze Statements
3201  *
3202  * Even though these are nominally two statements, it's convenient to use
3203  * just one node type for both.
3204  * ----------------------
3205  */
3206 typedef struct VacuumStmt
3207 {
3209  List *options; /* list of DefElem nodes */
3210  List *rels; /* list of VacuumRelation, or NIL for all */
3211  bool is_vacuumcmd; /* true for VACUUM, false for ANALYZE */
3212 } VacuumStmt;
3213 
3214 /*
3215  * Info about a single target table of VACUUM/ANALYZE.
3216  *
3217  * If the OID field is set, it always identifies the table to process.
3218  * Then the relation field can be NULL; if it isn't, it's used only to report
3219  * failure to open/lock the relation.
3220  */
3221 typedef struct VacuumRelation
3222 {
3224  RangeVar *relation; /* table name to process, or NULL */
3225  Oid oid; /* table's OID; InvalidOid if not looked up */
3226  List *va_cols; /* list of column names, or NIL for all */
3227 } VacuumRelation;
3228 
3229 /* ----------------------
3230  * Explain Statement
3231  *
3232  * The "query" field is initially a raw parse tree, and is converted to a
3233  * Query node during parse analysis. Note that rewriting and planning
3234  * of the query are always postponed until execution.
3235  * ----------------------
3236  */
3237 typedef struct ExplainStmt
3238 {
3240  Node *query; /* the query (see comments above) */
3241  List *options; /* list of DefElem nodes */
3242 } ExplainStmt;
3243 
3244 /* ----------------------
3245  * CREATE TABLE AS Statement (a/k/a SELECT INTO)
3246  *
3247  * A query written as CREATE TABLE AS will produce this node type natively.
3248  * A query written as SELECT ... INTO will be transformed to this form during
3249  * parse analysis.
3250  * A query written as CREATE MATERIALIZED view will produce this node type,
3251  * during parse analysis, since it needs all the same data.
3252  *
3253  * The "query" field is handled similarly to EXPLAIN, though note that it
3254  * can be a SELECT or an EXECUTE, but not other DML statements.
3255  * ----------------------
3256  */
3257 typedef struct CreateTableAsStmt
3258 {
3260  Node *query; /* the query (see comments above) */
3261  IntoClause *into; /* destination table */
3262  ObjectType relkind; /* OBJECT_TABLE or OBJECT_MATVIEW */
3263  bool is_select_into; /* it was written as SELECT INTO */
3264  bool if_not_exists; /* just do nothing if it already exists? */
3266 
3267 /* ----------------------
3268  * REFRESH MATERIALIZED VIEW Statement
3269  * ----------------------
3270  */
3271 typedef struct RefreshMatViewStmt
3272 {
3274  bool concurrent; /* allow concurrent access? */
3275  bool skipData; /* true for WITH NO DATA */
3276  RangeVar *relation; /* relation to insert into */
3278 
3279 /* ----------------------
3280  * Checkpoint Statement
3281  * ----------------------
3282  */
3283 typedef struct CheckPointStmt
3284 {
3286 } CheckPointStmt;
3287 
3288 /* ----------------------
3289  * Discard Statement
3290  * ----------------------
3291  */
3292 
3293 typedef enum DiscardMode
3294 {
3299 } DiscardMode;
3300 
3301 typedef struct DiscardStmt
3302 {
3305 } DiscardStmt;
3306 
3307 /* ----------------------
3308  * LOCK Statement
3309  * ----------------------
3310  */
3311 typedef struct LockStmt
3312 {
3314  List *relations; /* relations to lock */
3315  int mode; /* lock mode */
3316  bool nowait; /* no wait mode */
3317 } LockStmt;
3318 
3319 /* ----------------------
3320  * SET CONSTRAINTS Statement
3321  * ----------------------
3322  */
3323 typedef struct ConstraintsSetStmt
3324 {
3326  List *constraints; /* List of names as RangeVars */
3327  bool deferred;
3329 
3330 /* ----------------------
3331  * REINDEX Statement
3332  * ----------------------
3333  */
3334 
3335 /* Reindex options */
3336 #define REINDEXOPT_VERBOSE (1 << 0) /* print progress info */
3337 #define REINDEXOPT_REPORT_PROGRESS (1 << 1) /* report pgstat progress */
3338 
3339 typedef enum ReindexObjectType
3340 {
3342  REINDEX_OBJECT_TABLE, /* table or materialized view */
3344  REINDEX_OBJECT_SYSTEM, /* system catalogs */
3347 
3348 typedef struct ReindexStmt
3349 {
3351  ReindexObjectType kind; /* REINDEX_OBJECT_INDEX, REINDEX_OBJECT_TABLE,
3352  * etc. */
3353  RangeVar *relation; /* Table or index to reindex */
3354  const char *name; /* name of database to reindex */
3355  int options; /* Reindex options flags */
3356  bool concurrent; /* reindex concurrently? */
3357 } ReindexStmt;
3358 
3359 /* ----------------------
3360  * CREATE CONVERSION Statement
3361  * ----------------------
3362  */
3363 typedef struct CreateConversionStmt
3364 {
3366  List *conversion_name; /* Name of the conversion */
3367  char *for_encoding_name; /* source encoding name */
3368  char *to_encoding_name; /* destination encoding name */
3369  List *func_name; /* qualified conversion function name */
3370  bool def; /* is this a default conversion? */
3372 
3373 /* ----------------------
3374  * CREATE CAST Statement
3375  * ----------------------
3376  */
3377 typedef struct CreateCastStmt
3378 {
3384  bool inout;
3385 } CreateCastStmt;
3386 
3387 /* ----------------------
3388  * CREATE TRANSFORM Statement
3389  * ----------------------
3390  */
3391 typedef struct CreateTransformStmt
3392 {
3394  bool replace;
3396  char *lang;
3400 
3401 /* ----------------------
3402  * PREPARE Statement
3403  * ----------------------
3404  */
3405 typedef struct PrepareStmt
3406 {
3408  char *name; /* Name of plan, arbitrary */
3409  List *argtypes; /* Types of parameters (List of TypeName) */
3410  Node *query; /* The query itself (as a raw parsetree) */
3411 } PrepareStmt;
3412 
3413 
3414 /* ----------------------
3415  * EXECUTE Statement
3416  * ----------------------
3417  */
3418 
3419 typedef struct ExecuteStmt
3420 {
3422  char *name; /* The name of the plan to execute */
3423  List *params; /* Values to assign to parameters */
3424 } ExecuteStmt;
3425 
3426 
3427 /* ----------------------
3428  * DEALLOCATE Statement
3429  * ----------------------
3430  */
3431 typedef struct DeallocateStmt
3432 {
3434  char *name; /* The name of the plan to remove */
3435  /* NULL means DEALLOCATE ALL */
3436 } DeallocateStmt;
3437 
3438 /*
3439  * DROP OWNED statement
3440  */
3441 typedef struct DropOwnedStmt
3442 {
3446 } DropOwnedStmt;
3447 
3448 /*
3449  * REASSIGN OWNED statement
3450  */
3451 typedef struct ReassignOwnedStmt
3452 {
3457 
3458 /*
3459  * TS Dictionary stmts: DefineStmt, RenameStmt and DropStmt are default
3460  */
3462 {
3464  List *dictname; /* qualified name (list of Value strings) */
3465  List *options; /* List of DefElem nodes */
3467 
3468 /*
3469  * TS Configuration stmts: DefineStmt, RenameStmt and DropStmt are default
3470  */
3471 typedef enum AlterTSConfigType
3472 {
3479 
3481 {
3483  AlterTSConfigType kind; /* ALTER_TSCONFIG_ADD_MAPPING, etc */
3484  List *cfgname; /* qualified name (list of Value strings) */
3485 
3486  /*
3487  * dicts will be non-NIL if ADD/ALTER MAPPING was specified. If dicts is
3488  * NIL, but tokentype isn't, DROP MAPPING was specified.
3489  */
3490  List *tokentype; /* list of Value strings */
3491  List *dicts; /* list of list of Value strings */
3492  bool override; /* if true - remove old variant */
3493  bool replace; /* if true - replace dictionary by another */
3494  bool missing_ok; /* for DROP - skip error if missing? */
3496 
3497 
3499 {
3501  char *pubname; /* Name of the publication */
3502  List *options; /* List of DefElem nodes */
3503  List *tables; /* Optional list of tables to add */
3504  bool for_all_tables; /* Special publication for all tables in db */
3506 
3507 typedef struct AlterPublicationStmt
3508 {
3510  char *pubname; /* Name of the publication */
3511 
3512  /* parameters used for ALTER PUBLICATION ... WITH */
3513  List *options; /* List of DefElem nodes */
3514 
3515  /* parameters used for ALTER PUBLICATION ... ADD/DROP TABLE */
3516  List *tables; /* List of tables to add/drop */
3517  bool for_all_tables; /* Special publication for all tables in db */
3518  DefElemAction tableAction; /* What action to perform with the tables */
3520 
3522 {
3524  char *subname; /* Name of the subscription */
3525  char *conninfo; /* Connection string to publisher */
3526  List *publication; /* One or more publication to subscribe to */
3527  List *options; /* List of DefElem nodes */
3529 
3531 {
3538 
3540 {
3542  AlterSubscriptionType kind; /* ALTER_SUBSCRIPTION_OPTIONS, etc */
3543  char *subname; /* Name of the subscription */
3544  char *conninfo; /* Connection string to publisher */
3545  List *publication; /* One or more publication to subscribe to */
3546  List *options; /* List of DefElem nodes */
3548 
3549 typedef struct DropSubscriptionStmt
3550 {
3552  char *subname; /* Name of the subscription */
3553  bool missing_ok; /* Skip error if missing? */
3554  DropBehavior behavior; /* RESTRICT or CASCADE behavior */
3556 
3557 #endif /* PARSENODES_H */
struct CreateFdwStmt CreateFdwStmt
bool deferrable
Definition: parsenodes.h:2788
RangeVar * relation
Definition: parsenodes.h:2069
ObjectType objtype
Definition: parsenodes.h:2677
bool replace
Definition: parsenodes.h:3115
List * lockedRels
Definition: parsenodes.h:748
RoleSpec * newowner
Definition: parsenodes.h:2959
struct FetchStmt FetchStmt
signed short int16
Definition: c.h:346
List * indirection
Definition: parsenodes.h:441
Node * limitOffset
Definition: parsenodes.h:160
struct AlterDatabaseSetStmt AlterDatabaseSetStmt
List * partitionClause
Definition: parsenodes.h:489
SortByDir
Definition: parsenodes.h:50
char * refname
Definition: parsenodes.h:1350
NodeTag type
Definition: parsenodes.h:2997
Node * whereClause
Definition: parsenodes.h:2016
struct SelectStmt * larg
Definition: parsenodes.h:1627
bool primary
Definition: parsenodes.h:2786
bool copiedOrder
Definition: parsenodes.h:1362
OnCommitAction oncommit
Definition: parsenodes.h:2078
TypeName * sourcetype
Definition: parsenodes.h:3380
ConstrType
Definition: parsenodes.h:2115
RoleSpec * role
Definition: parsenodes.h:2514
NodeTag type
Definition: parsenodes.h:3443
List * fromClause
Definition: parsenodes.h:1559
struct DropTableSpaceStmt DropTableSpaceStmt
struct ViewStmt ViewStmt
List * inhRelations
Definition: parsenodes.h:2071
NodeTag type
Definition: parsenodes.h:3350
bool nowait
Definition: parsenodes.h:3316
struct CreateSchemaStmt CreateSchemaStmt
Alias * alias
Definition: parsenodes.h:567
Oid typeOid
Definition: parsenodes.h:210
ObjectType objtype
Definition: parsenodes.h:2689
List * keys
Definition: parsenodes.h:2164
struct CreateForeignTableStmt CreateForeignTableStmt
NodeTag type
Definition: parsenodes.h:2664
NodeTag type
Definition: parsenodes.h:3111
List * exclusions
Definition: parsenodes.h:2170
struct TableLikeClause TableLikeClause
ObjectWithArgs * tosql
Definition: parsenodes.h:3398
List * joinaliasvars
Definition: parsenodes.h:1049
Node * val
Definition: parsenodes.h:442
SortByDir ordering
Definition: parsenodes.h:704
Node * subquery
Definition: parsenodes.h:542
NodeTag type
Definition: parsenodes.h:2874
int stmt_location
Definition: parsenodes.h:180
Node * object
Definition: parsenodes.h:2690
char generated_when
Definition: parsenodes.h:2161
NodeTag type
Definition: parsenodes.h:2650
List * sortClause
Definition: parsenodes.h:158
struct CreateExtensionStmt CreateExtensionStmt
List * old_conpfeqop
Definition: parsenodes.h:2189
struct WindowDef WindowDef
struct FuncCall FuncCall
FetchDirection
Definition: parsenodes.h:2737
List * content
Definition: parsenodes.h:1325
bool inRangeNullsFirst
Definition: parsenodes.h:1360
List * names
Definition: parsenodes.h:209
IntoClause * intoClause
Definition: parsenodes.h:1594
A_Expr_Kind kind
Definition: parsenodes.h:275
struct DeclareCursorStmt DeclareCursorStmt
List * options
Definition: parsenodes.h:2779
struct CopyStmt CopyStmt
char storage
Definition: parsenodes.h:652
DropBehavior behavior
Definition: parsenodes.h:1905
VariableSetKind kind
Definition: parsenodes.h:2039
List * attlist
Definition: parsenodes.h:2010
struct VacuumStmt VacuumStmt
List * fromClause
Definition: parsenodes.h:1596
char * subname
Definition: parsenodes.h:2915
SortByDir sortby_dir
Definition: parsenodes.h:470
RangeVar * relation
Definition: parsenodes.h:3224
NodeTag type
Definition: parsenodes.h:3239
Alias * alias
Definition: parsenodes.h:1112
List * partParams
Definition: parsenodes.h:793
NodeTag type
Definition: parsenodes.h:3089
FuncExpr * funcexpr
Definition: parsenodes.h:2895
NodeTag type
Definition: parsenodes.h:468
bool is_local
Definition: parsenodes.h:649
ObjectType renameType
Definition: parsenodes.h:2911
struct AlterDomainStmt AlterDomainStmt
struct CreateCastStmt CreateCastStmt
RangeVar * relation
Definition: parsenodes.h:1542
FromExpr * jointree
Definition: parsenodes.h:138
TransactionStmtKind
Definition: parsenodes.h:3026
char * name
Definition: parsenodes.h:440
struct LoadStmt LoadStmt
int frameOptions
Definition: parsenodes.h:491
OnConflictExpr * onConflict
Definition: parsenodes.h:144
NodeTag type
Definition: parsenodes.h:349
TypeName * storedtype
Definition: parsenodes.h:2616
struct A_Indices A_Indices
struct AlterExtensionContentsStmt AlterExtensionContentsStmt
struct AlterObjectSchemaStmt AlterObjectSchemaStmt
RoleStmtType
Definition: parsenodes.h:2496
char identity
Definition: parsenodes.h:655
PartitionRangeDatumKind
Definition: parsenodes.h:834
struct ColumnDef ColumnDef
struct VariableShowStmt VariableShowStmt
FuncCall * funccall
Definition: parsenodes.h:2894
char * tableSpace
Definition: parsenodes.h:2775
NodeTag type
Definition: parsenodes.h:857
struct PartitionSpec PartitionSpec
Node * limitOffset
Definition: parsenodes.h:1617
List * constraintDeps
Definition: parsenodes.h:168
struct WithCheckOption WithCheckOption
struct CompositeTypeStmt CompositeTypeStmt
char fk_matchtype
Definition: parsenodes.h:2186
List * constraints
Definition: parsenodes.h:661
Node * whenClause
Definition: parsenodes.h:2437
List * securityQuals
Definition: parsenodes.h:1123
List * withCheckOptions
Definition: parsenodes.h:171
RoleStmtType stmt_type
Definition: parsenodes.h:2506
Node * agg_filter
Definition: parsenodes.h:353
struct DropUserMappingStmt DropUserMappingStmt
Node * raw_expr
Definition: parsenodes.h:2159
struct CreateRoleStmt CreateRoleStmt
struct A_Indirection A_Indirection
struct RoleSpec RoleSpec
List * objects
Definition: parsenodes.h:2651
bool missing_ok
Definition: parsenodes.h:2654
struct DeallocateStmt DeallocateStmt
struct InferClause InferClause
struct GrantRoleStmt GrantRoleStmt
bool if_not_exists
Definition: parsenodes.h:2546
struct TypeName TypeName
List * coltypmods
Definition: parsenodes.h:1100
struct AlterRoleSetStmt AlterRoleSetStmt
List * useOp
Definition: parsenodes.h:472
bool hasAggs
Definition: parsenodes.h:125
char * name
Definition: parsenodes.h:487
struct CommonTableExpr CommonTableExpr
struct WindowClause WindowClause
struct AlterForeignServerStmt AlterForeignServerStmt
struct PartitionElem PartitionElem
ObjectType objectType
Definition: parsenodes.h:2956
List * columns
Definition: parsenodes.h:582
NodeTag type
Definition: parsenodes.h:244
int resultRelation
Definition: parsenodes.h:122
struct AccessPriv AccessPriv
bool is_vacuumcmd
Definition: parsenodes.h:3211
List * indexElems
Definition: parsenodes.h:1410
RangeVar * typevar
Definition: parsenodes.h:3057
char * defnamespace
Definition: parsenodes.h:729
struct CreateStmt CreateStmt
Index tleSortGroupRef
Definition: parsenodes.h:1255
QuerySource
Definition: parsenodes.h:40
PartitionRangeDatumKind kind
Definition: parsenodes.h:845
Node * whereClause
Definition: parsenodes.h:2780
Oid endInRangeFunc
Definition: parsenodes.h:1357
AlterTSConfigType
Definition: parsenodes.h:3471
char * provider
Definition: parsenodes.h:2691
bool grant_option
Definition: parsenodes.h:1932
List * groupingSets
Definition: parsenodes.h:150
DefElemAction defaction
Definition: parsenodes.h:732
NodeTag type
Definition: parsenodes.h:234
Definition: nodes.h:525
struct AlterCollationStmt AlterCollationStmt
struct RangeTableSample RangeTableSample
NodeTag type
Definition: parsenodes.h:3008
struct RenameStmt RenameStmt
NodeTag type
Definition: parsenodes.h:3208
bool initdeferred
Definition: parsenodes.h:2154
char * filename
Definition: parsenodes.h:3127
AlterTableType subtype
Definition: parsenodes.h:1860
List * actions
Definition: parsenodes.h:2987
List * granted_roles
Definition: parsenodes.h:1977
char * comment
Definition: parsenodes.h:2679
List * targetList
Definition: parsenodes.h:1557
List * options
Definition: parsenodes.h:3241
RoleSpec * role
Definition: parsenodes.h:2522
AclMode requiredPerms
Definition: parsenodes.h:1117
char generated
Definition: parsenodes.h:658
List * roles
Definition: parsenodes.h:2530
List * pk_attrs
Definition: parsenodes.h:2185
List * cols
Definition: parsenodes.h:1962
TypeName * typeName
Definition: parsenodes.h:761
char * conname
Definition: parsenodes.h:2152
struct AlterOpFamilyStmt AlterOpFamilyStmt
bool is_not_null
Definition: parsenodes.h:650
NodeTag type
Definition: parsenodes.h:1323
struct DropStmt DropStmt
Node * object
Definition: parsenodes.h:2678
NodeTag type
Definition: parsenodes.h:1348
bool funcordinality
Definition: parsenodes.h:1062
NodeTag type
Definition: parsenodes.h:3126
int location
Definition: parsenodes.h:359
char * newname
Definition: parsenodes.h:2917
struct SetOperationStmt SetOperationStmt
unsigned int Oid
Definition: postgres_ext.h:31
NodeTag
Definition: nodes.h:26
List * rowMarks
Definition: parsenodes.h:163
Node * utilityStmt
Definition: parsenodes.h:120
bool is_program
Definition: parsenodes.h:2013
struct CreateDomainStmt CreateDomainStmt
struct TransactionStmt TransactionStmt
struct PrepareStmt PrepareStmt
ReindexObjectType
Definition: parsenodes.h:3339
struct LockingClause LockingClause
List * colcollations
Definition: parsenodes.h:1101
CoercionContext
Definition: primnodes.h:440
WithClause * withClause
Definition: parsenodes.h:1531
struct RangeFunction RangeFunction
RangeVar * relation
Definition: parsenodes.h:3276
List * agg_order
Definition: parsenodes.h:352
List * values_lists
Definition: parsenodes.h:1072
ObjectType removeType
Definition: parsenodes.h:2652
bool instead
Definition: parsenodes.h:2986
OnCommitAction
Definition: primnodes.h:47
LockClauseStrength strength
Definition: parsenodes.h:1381
bool hasDistinctOn
Definition: parsenodes.h:129
RangeVar * table
Definition: parsenodes.h:2402
Node * whereClause
Definition: parsenodes.h:1558
List * options
Definition: parsenodes.h:2553
struct VacuumRelation VacuumRelation
RangeVar * view
Definition: parsenodes.h:3112
signed int int32
Definition: c.h:347
OnConflictClause * onConflictClause
Definition: parsenodes.h:1529
struct TruncateStmt TruncateStmt
struct CreatePLangStmt CreatePLangStmt
List * options
Definition: parsenodes.h:2173
List * windowClause
Definition: parsenodes.h:154
DropBehavior behavior
Definition: parsenodes.h:3554
JoinType
Definition: nodes.h:692
List * targetList
Definition: parsenodes.h:140
RoleSpec * newowner
Definition: parsenodes.h:1865
NodeTag type
Definition: parsenodes.h:2148
int location
Definition: parsenodes.h:300
VariableSetStmt * setstmt
Definition: parsenodes.h:3156
bool hasRecursive
Definition: parsenodes.h:130
List * indexIncludingParams
Definition: parsenodes.h:2777
int location
Definition: parsenodes.h:236
NodeTag type
Definition: parsenodes.h:1525
struct ParamRef ParamRef
int location
Definition: parsenodes.h:443
NodeTag type
Definition: parsenodes.h:2282
struct CreateEventTrigStmt CreateEventTrigStmt
GroupingSetKind kind
Definition: parsenodes.h:1324
struct SelectStmt SelectStmt
struct LockStmt LockStmt
List * constraints
Definition: parsenodes.h:2076
AlterSubscriptionType
Definition: parsenodes.h:3530
bool if_not_exists
Definition: parsenodes.h:2081
struct A_Expr A_Expr
struct ListenStmt ListenStmt
RangeVar * identitySequence
Definition: parsenodes.h:656
char * accessMethod
Definition: parsenodes.h:2080
PartitionBoundSpec * partbound
Definition: parsenodes.h:2073
Node * cooked_default
Definition: parsenodes.h:654
struct AlterEventTrigStmt AlterEventTrigStmt
NodeTag type
Definition: parsenodes.h:1976
WithClause * withClause
Definition: parsenodes.h:1546
struct RuleStmt RuleStmt
RangeVar * constrrel
Definition: parsenodes.h:2444
Node * query
Definition: parsenodes.h:3240
NodeTag type
Definition: parsenodes.h:3421
Oid indexOid
Definition: parsenodes.h:2783
struct ClusterStmt ClusterStmt
Node * expr
Definition: parsenodes.h:700
char * newValNeighbor
Definition: parsenodes.h:3093
struct DropOwnedStmt DropOwnedStmt
uint32 AclMode
Definition: parsenodes.h:72
struct CreatedbStmt CreatedbStmt
RangeVar * relation
Definition: parsenodes.h:2773
DropBehavior behavior
Definition: parsenodes.h:2667
struct ColumnRef ColumnRef
Bitmapset * extraUpdatedCols
Definition: parsenodes.h:1122
bool is_slice
Definition: parsenodes.h:382
List * distinctClause
Definition: parsenodes.h:1592
Bitmapset * selectedCols
Definition: parsenodes.h:1119
RoleSpec * authrole
Definition: parsenodes.h:1756
List * returningList
Definition: parsenodes.h:1545
Node * startOffset
Definition: parsenodes.h:492
char * indexname
Definition: parsenodes.h:3195
NodeTag type
Definition: parsenodes.h:2414
NodeTag type
Definition: parsenodes.h:308
struct AlterTSConfigurationStmt AlterTSConfigurationStmt
SetOperation
Definition: parsenodes.h:1577
AlterTableType
Definition: parsenodes.h:1780
List * options
Definition: parsenodes.h:2277
List * rtable
Definition: parsenodes.h:137
NodeTag type
Definition: parsenodes.h:2771
struct AlterEnumStmt AlterEnumStmt
CollateClause * collClause
Definition: parsenodes.h:2583
List * distinctClause
Definition: parsenodes.h:156
struct CreateTableSpaceStmt CreateTableSpaceStmt
bool missing_ok
Definition: parsenodes.h:2919
List * args
Definition: parsenodes.h:2568
SortByNulls nulls_ordering
Definition: parsenodes.h:705
struct OnConflictClause OnConflictClause
char * policy_name
Definition: parsenodes.h:2401
List * aliases
Definition: parsenodes.h:3113
CTEMaterialize
Definition: parsenodes.h:1438
char * savepoint_name
Definition: parsenodes.h:3045
struct FunctionParameter FunctionParameter
struct UpdateStmt UpdateStmt
bool concurrent
Definition: parsenodes.h:2655
struct WindowDef * over
Definition: parsenodes.h:358
NodeTag type
Definition: parseno