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