PostgreSQL Source Code  git master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
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  uint32 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 ('list' or 'range') */
781  List *partParams; /* List of PartitionElems */
782  int location; /* token location, or -1 if unknown */
783 } PartitionSpec;
784 
785 /* Internal codes for partitioning strategies */
786 #define PARTITION_STRATEGY_LIST 'l'
787 #define PARTITION_STRATEGY_RANGE 'r'
788 
789 /*
790  * PartitionBoundSpec - a partition bound specification
791  *
792  * This represents the portion of the partition key space assigned to a
793  * particular partition. These are stored on disk in pg_class.relpartbound.
794  */
795 typedef struct PartitionBoundSpec
796 {
798 
799  char strategy; /* see PARTITION_STRATEGY codes above */
800 
801  /* Partitioning info for LIST strategy: */
802  List *listdatums; /* List of Consts (or A_Consts in raw tree) */
803 
804  /* Partitioning info for RANGE strategy: */
805  List *lowerdatums; /* List of PartitionRangeDatums */
806  List *upperdatums; /* List of PartitionRangeDatums */
807 
808  int location; /* token location, or -1 if unknown */
810 
811 /*
812  * PartitionRangeDatum - one of the values in a range partition bound
813  *
814  * This can be MINVALUE, MAXVALUE or a specific bounded value.
815  */
817 {
818  PARTITION_RANGE_DATUM_MINVALUE = -1, /* less than any other value */
819  PARTITION_RANGE_DATUM_VALUE = 0, /* a specific (bounded) value */
820  PARTITION_RANGE_DATUM_MAXVALUE = 1 /* greater than any other value */
822 
823 typedef struct PartitionRangeDatum
824 {
826 
828  Node *value; /* Const (or A_Const in raw tree), if kind is
829  * PARTITION_RANGE_DATUM_VALUE, else NULL */
830 
831  int location; /* token location, or -1 if unknown */
833 
834 /*
835  * PartitionCmd - info for ALTER TABLE ATTACH/DETACH PARTITION commands
836  */
837 typedef struct PartitionCmd
838 {
840  RangeVar *name; /* name of partition to attach/detach */
841  PartitionBoundSpec *bound; /* FOR VALUES, if attaching */
842 } PartitionCmd;
843 
844 /****************************************************************************
845  * Nodes for a Query tree
846  ****************************************************************************/
847 
848 /*--------------------
849  * RangeTblEntry -
850  * A range table is a List of RangeTblEntry nodes.
851  *
852  * A range table entry may represent a plain relation, a sub-select in
853  * FROM, or the result of a JOIN clause. (Only explicit JOIN syntax
854  * produces an RTE, not the implicit join resulting from multiple FROM
855  * items. This is because we only need the RTE to deal with SQL features
856  * like outer joins and join-output-column aliasing.) Other special
857  * RTE types also exist, as indicated by RTEKind.
858  *
859  * Note that we consider RTE_RELATION to cover anything that has a pg_class
860  * entry. relkind distinguishes the sub-cases.
861  *
862  * alias is an Alias node representing the AS alias-clause attached to the
863  * FROM expression, or NULL if no clause.
864  *
865  * eref is the table reference name and column reference names (either
866  * real or aliases). Note that system columns (OID etc) are not included
867  * in the column list.
868  * eref->aliasname is required to be present, and should generally be used
869  * to identify the RTE for error messages etc.
870  *
871  * In RELATION RTEs, the colnames in both alias and eref are indexed by
872  * physical attribute number; this means there must be colname entries for
873  * dropped columns. When building an RTE we insert empty strings ("") for
874  * dropped columns. Note however that a stored rule may have nonempty
875  * colnames for columns dropped since the rule was created (and for that
876  * matter the colnames might be out of date due to column renamings).
877  * The same comments apply to FUNCTION RTEs when a function's return type
878  * is a named composite type.
879  *
880  * In JOIN RTEs, the colnames in both alias and eref are one-to-one with
881  * joinaliasvars entries. A JOIN RTE will omit columns of its inputs when
882  * those columns are known to be dropped at parse time. Again, however,
883  * a stored rule might contain entries for columns dropped since the rule
884  * was created. (This is only possible for columns not actually referenced
885  * in the rule.) When loading a stored rule, we replace the joinaliasvars
886  * items for any such columns with null pointers. (We can't simply delete
887  * them from the joinaliasvars list, because that would affect the attnums
888  * of Vars referencing the rest of the list.)
889  *
890  * inh is TRUE for relation references that should be expanded to include
891  * inheritance children, if the rel has any. This *must* be FALSE for
892  * RTEs other than RTE_RELATION entries.
893  *
894  * inFromCl marks those range variables that are listed in the FROM clause.
895  * It's false for RTEs that are added to a query behind the scenes, such
896  * as the NEW and OLD variables for a rule, or the subqueries of a UNION.
897  * This flag is not used anymore during parsing, since the parser now uses
898  * a separate "namespace" data structure to control visibility, but it is
899  * needed by ruleutils.c to determine whether RTEs should be shown in
900  * decompiled queries.
901  *
902  * requiredPerms and checkAsUser specify run-time access permissions
903  * checks to be performed at query startup. The user must have *all*
904  * of the permissions that are OR'd together in requiredPerms (zero
905  * indicates no permissions checking). If checkAsUser is not zero,
906  * then do the permissions checks using the access rights of that user,
907  * not the current effective user ID. (This allows rules to act as
908  * setuid gateways.) Permissions checks only apply to RELATION RTEs.
909  *
910  * For SELECT/INSERT/UPDATE permissions, if the user doesn't have
911  * table-wide permissions then it is sufficient to have the permissions
912  * on all columns identified in selectedCols (for SELECT) and/or
913  * insertedCols and/or updatedCols (INSERT with ON CONFLICT DO UPDATE may
914  * have all 3). selectedCols, insertedCols and updatedCols are bitmapsets,
915  * which cannot have negative integer members, so we subtract
916  * FirstLowInvalidHeapAttributeNumber from column numbers before storing
917  * them in these fields. A whole-row Var reference is represented by
918  * setting the bit for InvalidAttrNumber.
919  *
920  * securityQuals is a list of security barrier quals (boolean expressions),
921  * to be tested in the listed order before returning a row from the
922  * relation. It is always NIL in parser output. Entries are added by the
923  * rewriter to implement security-barrier views and/or row-level security.
924  * Note that the planner turns each boolean expression into an implicitly
925  * AND'ed sublist, as is its usual habit with qualification expressions.
926  *--------------------
927  */
928 typedef enum RTEKind
929 {
930  RTE_RELATION, /* ordinary relation reference */
931  RTE_SUBQUERY, /* subquery in FROM */
932  RTE_JOIN, /* join */
933  RTE_FUNCTION, /* function in FROM */
934  RTE_TABLEFUNC, /* TableFunc(.., column list) */
935  RTE_VALUES, /* VALUES (<exprlist>), (<exprlist>), ... */
936  RTE_CTE, /* common table expr (WITH list element) */
937  RTE_NAMEDTUPLESTORE /* tuplestore, e.g. for AFTER triggers */
938 } RTEKind;
939 
940 typedef struct RangeTblEntry
941 {
943 
944  RTEKind rtekind; /* see above */
945 
946  /*
947  * XXX the fields applicable to only some rte kinds should be merged into
948  * a union. I didn't do this yet because the diffs would impact a lot of
949  * code that is being actively worked on. FIXME someday.
950  */
951 
952  /*
953  * Fields valid for a plain relation RTE (else zero):
954  *
955  * As a special case, RTE_NAMEDTUPLESTORE can also set relid to indicate
956  * that the tuple format of the tuplestore is the same as the referenced
957  * relation. This allows plans referencing AFTER trigger transition
958  * tables to be invalidated if the underlying table is altered.
959  */
960  Oid relid; /* OID of the relation */
961  char relkind; /* relation kind (see pg_class.relkind) */
962  struct TableSampleClause *tablesample; /* sampling info, or NULL */
963 
964  /*
965  * Fields valid for a subquery RTE (else NULL):
966  */
967  Query *subquery; /* the sub-query */
968  bool security_barrier; /* is from security_barrier view? */
969 
970  /*
971  * Fields valid for a join RTE (else NULL/zero):
972  *
973  * joinaliasvars is a list of (usually) Vars corresponding to the columns
974  * of the join result. An alias Var referencing column K of the join
975  * result can be replaced by the K'th element of joinaliasvars --- but to
976  * simplify the task of reverse-listing aliases correctly, we do not do
977  * that until planning time. In detail: an element of joinaliasvars can
978  * be a Var of one of the join's input relations, or such a Var with an
979  * implicit coercion to the join's output column type, or a COALESCE
980  * expression containing the two input column Vars (possibly coerced).
981  * Within a Query loaded from a stored rule, it is also possible for
982  * joinaliasvars items to be null pointers, which are placeholders for
983  * (necessarily unreferenced) columns dropped since the rule was made.
984  * Also, once planning begins, joinaliasvars items can be almost anything,
985  * as a result of subquery-flattening substitutions.
986  */
987  JoinType jointype; /* type of join */
988  List *joinaliasvars; /* list of alias-var expansions */
989 
990  /*
991  * Fields valid for a function RTE (else NIL/zero):
992  *
993  * When funcordinality is true, the eref->colnames list includes an alias
994  * for the ordinality column. The ordinality column is otherwise
995  * implicit, and must be accounted for "by hand" in places such as
996  * expandRTE().
997  */
998  List *functions; /* list of RangeTblFunction nodes */
999  bool funcordinality; /* is this called WITH ORDINALITY? */
1000 
1001  /*
1002  * Fields valid for a TableFunc RTE (else NULL):
1003  */
1005 
1006  /*
1007  * Fields valid for a values RTE (else NIL):
1008  */
1009  List *values_lists; /* list of expression lists */
1010 
1011  /*
1012  * Fields valid for a CTE RTE (else NULL/zero):
1013  */
1014  char *ctename; /* name of the WITH list item */
1015  Index ctelevelsup; /* number of query levels up */
1016  bool self_reference; /* is this a recursive self-reference? */
1017 
1018  /*
1019  * Fields valid for table functions, values, CTE and ENR RTEs (else NIL):
1020  *
1021  * We need these for CTE RTEs so that the types of self-referential
1022  * columns are well-defined. For VALUES RTEs, storing these explicitly
1023  * saves having to re-determine the info by scanning the values_lists. For
1024  * ENRs, we store the types explicitly here (we could get the information
1025  * from the catalogs if 'relid' was supplied, but we'd still need these
1026  * for TupleDesc-based ENRs, so we might as well always store the type
1027  * info here).
1028  */
1029  List *coltypes; /* OID list of column type OIDs */
1030  List *coltypmods; /* integer list of column typmods */
1031  List *colcollations; /* OID list of column collation OIDs */
1032 
1033  /*
1034  * Fields valid for ENR RTEs (else NULL/zero):
1035  */
1036  char *enrname; /* name of ephemeral named relation */
1037  double enrtuples; /* estimated or actual from caller */
1038 
1039  /*
1040  * Fields valid in all RTEs:
1041  */
1042  Alias *alias; /* user-written alias clause, if any */
1043  Alias *eref; /* expanded reference names */
1044  bool lateral; /* subquery, function, or values is LATERAL? */
1045  bool inh; /* inheritance requested? */
1046  bool inFromCl; /* present in FROM clause? */
1047  AclMode requiredPerms; /* bitmask of required access permissions */
1048  Oid checkAsUser; /* if valid, check access as this role */
1049  Bitmapset *selectedCols; /* columns needing SELECT permission */
1050  Bitmapset *insertedCols; /* columns needing INSERT permission */
1051  Bitmapset *updatedCols; /* columns needing UPDATE permission */
1052  List *securityQuals; /* security barrier quals to apply, if any */
1053 } RangeTblEntry;
1054 
1055 /*
1056  * RangeTblFunction -
1057  * RangeTblEntry subsidiary data for one function in a FUNCTION RTE.
1058  *
1059  * If the function had a column definition list (required for an
1060  * otherwise-unspecified RECORD result), funccolnames lists the names given
1061  * in the definition list, funccoltypes lists their declared column types,
1062  * funccoltypmods lists their typmods, funccolcollations their collations.
1063  * Otherwise, those fields are NIL.
1064  *
1065  * Notice we don't attempt to store info about the results of functions
1066  * returning named composite types, because those can change from time to
1067  * time. We do however remember how many columns we thought the type had
1068  * (including dropped columns!), so that we can successfully ignore any
1069  * columns added after the query was parsed.
1070  */
1071 typedef struct RangeTblFunction
1072 {
1074 
1075  Node *funcexpr; /* expression tree for func call */
1076  int funccolcount; /* number of columns it contributes to RTE */
1077  /* These fields record the contents of a column definition list, if any: */
1078  List *funccolnames; /* column names (list of String) */
1079  List *funccoltypes; /* OID list of column type OIDs */
1080  List *funccoltypmods; /* integer list of column typmods */
1081  List *funccolcollations; /* OID list of column collation OIDs */
1082  /* This is set during planning for use by the executor: */
1083  Bitmapset *funcparams; /* PARAM_EXEC Param IDs affecting this func */
1085 
1086 /*
1087  * TableSampleClause - TABLESAMPLE appearing in a transformed FROM clause
1088  *
1089  * Unlike RangeTableSample, this is a subnode of the relevant RangeTblEntry.
1090  */
1091 typedef struct TableSampleClause
1092 {
1094  Oid tsmhandler; /* OID of the tablesample handler function */
1095  List *args; /* tablesample argument expression(s) */
1096  Expr *repeatable; /* REPEATABLE expression, or NULL if none */
1098 
1099 /*
1100  * WithCheckOption -
1101  * representation of WITH CHECK OPTION checks to be applied to new tuples
1102  * when inserting/updating an auto-updatable view, or RLS WITH CHECK
1103  * policies to be applied when inserting/updating a relation with RLS.
1104  */
1105 typedef enum WCOKind
1106 {
1107  WCO_VIEW_CHECK, /* WCO on an auto-updatable view */
1108  WCO_RLS_INSERT_CHECK, /* RLS INSERT WITH CHECK policy */
1109  WCO_RLS_UPDATE_CHECK, /* RLS UPDATE WITH CHECK policy */
1110  WCO_RLS_CONFLICT_CHECK /* RLS ON CONFLICT DO UPDATE USING policy */
1111 } WCOKind;
1112 
1113 typedef struct WithCheckOption
1114 {
1116  WCOKind kind; /* kind of WCO */
1117  char *relname; /* name of relation that specified the WCO */
1118  char *polname; /* name of RLS policy being checked */
1119  Node *qual; /* constraint qual to check */
1120  bool cascaded; /* true for a cascaded WCO on a view */
1121 } WithCheckOption;
1122 
1123 /*
1124  * SortGroupClause -
1125  * representation of ORDER BY, GROUP BY, PARTITION BY,
1126  * DISTINCT, DISTINCT ON items
1127  *
1128  * You might think that ORDER BY is only interested in defining ordering,
1129  * and GROUP/DISTINCT are only interested in defining equality. However,
1130  * one way to implement grouping is to sort and then apply a "uniq"-like
1131  * filter. So it's also interesting to keep track of possible sort operators
1132  * for GROUP/DISTINCT, and in particular to try to sort for the grouping
1133  * in a way that will also yield a requested ORDER BY ordering. So we need
1134  * to be able to compare ORDER BY and GROUP/DISTINCT lists, which motivates
1135  * the decision to give them the same representation.
1136  *
1137  * tleSortGroupRef must match ressortgroupref of exactly one entry of the
1138  * query's targetlist; that is the expression to be sorted or grouped by.
1139  * eqop is the OID of the equality operator.
1140  * sortop is the OID of the ordering operator (a "<" or ">" operator),
1141  * or InvalidOid if not available.
1142  * nulls_first means about what you'd expect. If sortop is InvalidOid
1143  * then nulls_first is meaningless and should be set to false.
1144  * hashable is TRUE if eqop is hashable (note this condition also depends
1145  * on the datatype of the input expression).
1146  *
1147  * In an ORDER BY item, all fields must be valid. (The eqop isn't essential
1148  * here, but it's cheap to get it along with the sortop, and requiring it
1149  * to be valid eases comparisons to grouping items.) Note that this isn't
1150  * actually enough information to determine an ordering: if the sortop is
1151  * collation-sensitive, a collation OID is needed too. We don't store the
1152  * collation in SortGroupClause because it's not available at the time the
1153  * parser builds the SortGroupClause; instead, consult the exposed collation
1154  * of the referenced targetlist expression to find out what it is.
1155  *
1156  * In a grouping item, eqop must be valid. If the eqop is a btree equality
1157  * operator, then sortop should be set to a compatible ordering operator.
1158  * We prefer to set eqop/sortop/nulls_first to match any ORDER BY item that
1159  * the query presents for the same tlist item. If there is none, we just
1160  * use the default ordering op for the datatype.
1161  *
1162  * If the tlist item's type has a hash opclass but no btree opclass, then
1163  * we will set eqop to the hash equality operator, sortop to InvalidOid,
1164  * and nulls_first to false. A grouping item of this kind can only be
1165  * implemented by hashing, and of course it'll never match an ORDER BY item.
1166  *
1167  * The hashable flag is provided since we generally have the requisite
1168  * information readily available when the SortGroupClause is constructed,
1169  * and it's relatively expensive to get it again later. Note there is no
1170  * need for a "sortable" flag since OidIsValid(sortop) serves the purpose.
1171  *
1172  * A query might have both ORDER BY and DISTINCT (or DISTINCT ON) clauses.
1173  * In SELECT DISTINCT, the distinctClause list is as long or longer than the
1174  * sortClause list, while in SELECT DISTINCT ON it's typically shorter.
1175  * The two lists must match up to the end of the shorter one --- the parser
1176  * rearranges the distinctClause if necessary to make this true. (This
1177  * restriction ensures that only one sort step is needed to both satisfy the
1178  * ORDER BY and set up for the Unique step. This is semantically necessary
1179  * for DISTINCT ON, and presents no real drawback for DISTINCT.)
1180  */
1181 typedef struct SortGroupClause
1182 {
1184  Index tleSortGroupRef; /* reference into targetlist */
1185  Oid eqop; /* the equality operator ('=' op) */
1186  Oid sortop; /* the ordering operator ('<' op), or 0 */
1187  bool nulls_first; /* do NULLs come before normal values? */
1188  bool hashable; /* can eqop be implemented by hashing? */
1189 } SortGroupClause;
1190 
1191 /*
1192  * GroupingSet -
1193  * representation of CUBE, ROLLUP and GROUPING SETS clauses
1194  *
1195  * In a Query with grouping sets, the groupClause contains a flat list of
1196  * SortGroupClause nodes for each distinct expression used. The actual
1197  * structure of the GROUP BY clause is given by the groupingSets tree.
1198  *
1199  * In the raw parser output, GroupingSet nodes (of all types except SIMPLE
1200  * which is not used) are potentially mixed in with the expressions in the
1201  * groupClause of the SelectStmt. (An expression can't contain a GroupingSet,
1202  * but a list may mix GroupingSet and expression nodes.) At this stage, the
1203  * content of each node is a list of expressions, some of which may be RowExprs
1204  * which represent sublists rather than actual row constructors, and nested
1205  * GroupingSet nodes where legal in the grammar. The structure directly
1206  * reflects the query syntax.
1207  *
1208  * In parse analysis, the transformed expressions are used to build the tlist
1209  * and groupClause list (of SortGroupClause nodes), and the groupingSets tree
1210  * is eventually reduced to a fixed format:
1211  *
1212  * EMPTY nodes represent (), and obviously have no content
1213  *
1214  * SIMPLE nodes represent a list of one or more expressions to be treated as an
1215  * atom by the enclosing structure; the content is an integer list of
1216  * ressortgroupref values (see SortGroupClause)
1217  *
1218  * CUBE and ROLLUP nodes contain a list of one or more SIMPLE nodes.
1219  *
1220  * SETS nodes contain a list of EMPTY, SIMPLE, CUBE or ROLLUP nodes, but after
1221  * parse analysis they cannot contain more SETS nodes; enough of the syntactic
1222  * transforms of the spec have been applied that we no longer have arbitrarily
1223  * deep nesting (though we still preserve the use of cube/rollup).
1224  *
1225  * Note that if the groupingSets tree contains no SIMPLE nodes (only EMPTY
1226  * nodes at the leaves), then the groupClause will be empty, but this is still
1227  * an aggregation query (similar to using aggs or HAVING without GROUP BY).
1228  *
1229  * As an example, the following clause:
1230  *
1231  * GROUP BY GROUPING SETS ((a,b), CUBE(c,(d,e)))
1232  *
1233  * looks like this after raw parsing:
1234  *
1235  * SETS( RowExpr(a,b) , CUBE( c, RowExpr(d,e) ) )
1236  *
1237  * and parse analysis converts it to:
1238  *
1239  * SETS( SIMPLE(1,2), CUBE( SIMPLE(3), SIMPLE(4,5) ) )
1240  */
1241 typedef enum
1242 {
1248 } GroupingSetKind;
1249 
1250 typedef struct GroupingSet
1251 {
1256 } GroupingSet;
1257 
1258 /*
1259  * WindowClause -
1260  * transformed representation of WINDOW and OVER clauses
1261  *
1262  * A parsed Query's windowClause list contains these structs. "name" is set
1263  * if the clause originally came from WINDOW, and is NULL if it originally
1264  * was an OVER clause (but note that we collapse out duplicate OVERs).
1265  * partitionClause and orderClause are lists of SortGroupClause structs.
1266  * winref is an ID number referenced by WindowFunc nodes; it must be unique
1267  * among the members of a Query's windowClause list.
1268  * When refname isn't null, the partitionClause is always copied from there;
1269  * the orderClause might or might not be copied (see copiedOrder); the framing
1270  * options are never copied, per spec.
1271  */
1272 typedef struct WindowClause
1273 {
1275  char *name; /* window name (NULL in an OVER clause) */
1276  char *refname; /* referenced window name, if any */
1277  List *partitionClause; /* PARTITION BY list */
1278  List *orderClause; /* ORDER BY list */
1279  int frameOptions; /* frame_clause options, see WindowDef */
1280  Node *startOffset; /* expression for starting bound, if any */
1281  Node *endOffset; /* expression for ending bound, if any */
1282  Index winref; /* ID referenced by window functions */
1283  bool copiedOrder; /* did we copy orderClause from refname? */
1284 } WindowClause;
1285 
1286 /*
1287  * RowMarkClause -
1288  * parser output representation of FOR [KEY] UPDATE/SHARE clauses
1289  *
1290  * Query.rowMarks contains a separate RowMarkClause node for each relation
1291  * identified as a FOR [KEY] UPDATE/SHARE target. If one of these clauses
1292  * is applied to a subquery, we generate RowMarkClauses for all normal and
1293  * subquery rels in the subquery, but they are marked pushedDown = true to
1294  * distinguish them from clauses that were explicitly written at this query
1295  * level. Also, Query.hasForUpdate tells whether there were explicit FOR
1296  * UPDATE/SHARE/KEY SHARE clauses in the current query level.
1297  */
1298 typedef struct RowMarkClause
1299 {
1301  Index rti; /* range table index of target relation */
1303  LockWaitPolicy waitPolicy; /* NOWAIT and SKIP LOCKED */
1304  bool pushedDown; /* pushed down from higher query level? */
1305 } RowMarkClause;
1306 
1307 /*
1308  * WithClause -
1309  * representation of WITH clause
1310  *
1311  * Note: WithClause does not propagate into the Query representation;
1312  * but CommonTableExpr does.
1313  */
1314 typedef struct WithClause
1315 {
1317  List *ctes; /* list of CommonTableExprs */
1318  bool recursive; /* true = WITH RECURSIVE */
1319  int location; /* token location, or -1 if unknown */
1320 } WithClause;
1321 
1322 /*
1323  * InferClause -
1324  * ON CONFLICT unique index inference clause
1325  *
1326  * Note: InferClause does not propagate into the Query representation.
1327  */
1328 typedef struct InferClause
1329 {
1331  List *indexElems; /* IndexElems to infer unique index */
1332  Node *whereClause; /* qualification (partial-index predicate) */
1333  char *conname; /* Constraint name, or NULL if unnamed */
1334  int location; /* token location, or -1 if unknown */
1335 } InferClause;
1336 
1337 /*
1338  * OnConflictClause -
1339  * representation of ON CONFLICT clause
1340  *
1341  * Note: OnConflictClause does not propagate into the Query representation.
1342  */
1343 typedef struct OnConflictClause
1344 {
1346  OnConflictAction action; /* DO NOTHING or UPDATE? */
1347  InferClause *infer; /* Optional index inference clause */
1348  List *targetList; /* the target list (of ResTarget) */
1349  Node *whereClause; /* qualifications */
1350  int location; /* token location, or -1 if unknown */
1352 
1353 /*
1354  * CommonTableExpr -
1355  * representation of WITH list element
1356  *
1357  * We don't currently support the SEARCH or CYCLE clause.
1358  */
1359 typedef struct CommonTableExpr
1360 {
1362  char *ctename; /* query name (never qualified) */
1363  List *aliascolnames; /* optional list of column names */
1364  /* SelectStmt/InsertStmt/etc before parse analysis, Query afterwards: */
1365  Node *ctequery; /* the CTE's subquery */
1366  int location; /* token location, or -1 if unknown */
1367  /* These fields are set during parse analysis: */
1368  bool cterecursive; /* is this CTE actually recursive? */
1369  int cterefcount; /* number of RTEs referencing this CTE
1370  * (excluding internal self-references) */
1371  List *ctecolnames; /* list of output column names */
1372  List *ctecoltypes; /* OID list of output column type OIDs */
1373  List *ctecoltypmods; /* integer list of output column typmods */
1374  List *ctecolcollations; /* OID list of column collation OIDs */
1375 } CommonTableExpr;
1376 
1377 /* Convenience macro to get the output tlist of a CTE's query */
1378 #define GetCTETargetList(cte) \
1379  (AssertMacro(IsA((cte)->ctequery, Query)), \
1380  ((Query *) (cte)->ctequery)->commandType == CMD_SELECT ? \
1381  ((Query *) (cte)->ctequery)->targetList : \
1382  ((Query *) (cte)->ctequery)->returningList)
1383 
1384 /*
1385  * TriggerTransition -
1386  * representation of transition row or table naming clause
1387  *
1388  * Only transition tables are initially supported in the syntax, and only for
1389  * AFTER triggers, but other permutations are accepted by the parser so we can
1390  * give a meaningful message from C code.
1391  */
1392 typedef struct TriggerTransition
1393 {
1395  char *name;
1396  bool isNew;
1397  bool isTable;
1399 
1400 /*****************************************************************************
1401  * Raw Grammar Output Statements
1402  *****************************************************************************/
1403 
1404 /*
1405  * RawStmt --- container for any one statement's raw parse tree
1406  *
1407  * Parse analysis converts a raw parse tree headed by a RawStmt node into
1408  * an analyzed statement headed by a Query node. For optimizable statements,
1409  * the conversion is complex. For utility statements, the parser usually just
1410  * transfers the raw parse tree (sans RawStmt) into the utilityStmt field of
1411  * the Query node, and all the useful work happens at execution time.
1412  *
1413  * stmt_location/stmt_len identify the portion of the source text string
1414  * containing this raw statement (useful for multi-statement strings).
1415  */
1416 typedef struct RawStmt
1417 {
1419  Node *stmt; /* raw parse tree */
1420  int stmt_location; /* start location, or -1 if unknown */
1421  int stmt_len; /* length in bytes; 0 means "rest of string" */
1422 } RawStmt;
1423 
1424 /*****************************************************************************
1425  * Optimizable Statements
1426  *****************************************************************************/
1427 
1428 /* ----------------------
1429  * Insert Statement
1430  *
1431  * The source expression is represented by SelectStmt for both the
1432  * SELECT and VALUES cases. If selectStmt is NULL, then the query
1433  * is INSERT ... DEFAULT VALUES.
1434  * ----------------------
1435  */
1436 typedef struct InsertStmt
1437 {
1439  RangeVar *relation; /* relation to insert into */
1440  List *cols; /* optional: names of the target columns */
1441  Node *selectStmt; /* the source SELECT/VALUES, or NULL */
1442  OnConflictClause *onConflictClause; /* ON CONFLICT clause */
1443  List *returningList; /* list of expressions to return */
1444  WithClause *withClause; /* WITH clause */
1445  OverridingKind override; /* OVERRIDING clause */
1446 } InsertStmt;
1447 
1448 /* ----------------------
1449  * Delete Statement
1450  * ----------------------
1451  */
1452 typedef struct DeleteStmt
1453 {
1455  RangeVar *relation; /* relation to delete from */
1456  List *usingClause; /* optional using clause for more tables */
1457  Node *whereClause; /* qualifications */
1458  List *returningList; /* list of expressions to return */
1459  WithClause *withClause; /* WITH clause */
1460 } DeleteStmt;
1461 
1462 /* ----------------------
1463  * Update Statement
1464  * ----------------------
1465  */
1466 typedef struct UpdateStmt
1467 {
1469  RangeVar *relation; /* relation to update */
1470  List *targetList; /* the target list (of ResTarget) */
1471  Node *whereClause; /* qualifications */
1472  List *fromClause; /* optional from clause for more tables */
1473  List *returningList; /* list of expressions to return */
1474  WithClause *withClause; /* WITH clause */
1475 } UpdateStmt;
1476 
1477 /* ----------------------
1478  * Select Statement
1479  *
1480  * A "simple" SELECT is represented in the output of gram.y by a single
1481  * SelectStmt node; so is a VALUES construct. A query containing set
1482  * operators (UNION, INTERSECT, EXCEPT) is represented by a tree of SelectStmt
1483  * nodes, in which the leaf nodes are component SELECTs and the internal nodes
1484  * represent UNION, INTERSECT, or EXCEPT operators. Using the same node
1485  * type for both leaf and internal nodes allows gram.y to stick ORDER BY,
1486  * LIMIT, etc, clause values into a SELECT statement without worrying
1487  * whether it is a simple or compound SELECT.
1488  * ----------------------
1489  */
1490 typedef enum SetOperation
1491 {
1496 } SetOperation;
1497 
1498 typedef struct SelectStmt
1499 {
1501 
1502  /*
1503  * These fields are used only in "leaf" SelectStmts.
1504  */
1505  List *distinctClause; /* NULL, list of DISTINCT ON exprs, or
1506  * lcons(NIL,NIL) for all (SELECT DISTINCT) */
1507  IntoClause *intoClause; /* target for SELECT INTO */
1508  List *targetList; /* the target list (of ResTarget) */
1509  List *fromClause; /* the FROM clause */
1510  Node *whereClause; /* WHERE qualification */
1511  List *groupClause; /* GROUP BY clauses */
1512  Node *havingClause; /* HAVING conditional-expression */
1513  List *windowClause; /* WINDOW window_name AS (...), ... */
1514 
1515  /*
1516  * In a "leaf" node representing a VALUES list, the above fields are all
1517  * null, and instead this field is set. Note that the elements of the
1518  * sublists are just expressions, without ResTarget decoration. Also note
1519  * that a list element can be DEFAULT (represented as a SetToDefault
1520  * node), regardless of the context of the VALUES list. It's up to parse
1521  * analysis to reject that where not valid.
1522  */
1523  List *valuesLists; /* untransformed list of expression lists */
1524 
1525  /*
1526  * These fields are used in both "leaf" SelectStmts and upper-level
1527  * SelectStmts.
1528  */
1529  List *sortClause; /* sort clause (a list of SortBy's) */
1530  Node *limitOffset; /* # of result tuples to skip */
1531  Node *limitCount; /* # of result tuples to return */
1532  List *lockingClause; /* FOR UPDATE (list of LockingClause's) */
1533  WithClause *withClause; /* WITH clause */
1534 
1535  /*
1536  * These fields are used only in upper-level SelectStmts.
1537  */
1538  SetOperation op; /* type of set op */
1539  bool all; /* ALL specified? */
1540  struct SelectStmt *larg; /* left child */
1541  struct SelectStmt *rarg; /* right child */
1542  /* Eventually add fields for CORRESPONDING spec here */
1543 } SelectStmt;
1544 
1545 
1546 /* ----------------------
1547  * Set Operation node for post-analysis query trees
1548  *
1549  * After parse analysis, a SELECT with set operations is represented by a
1550  * top-level Query node containing the leaf SELECTs as subqueries in its
1551  * range table. Its setOperations field shows the tree of set operations,
1552  * with leaf SelectStmt nodes replaced by RangeTblRef nodes, and internal
1553  * nodes replaced by SetOperationStmt nodes. Information about the output
1554  * column types is added, too. (Note that the child nodes do not necessarily
1555  * produce these types directly, but we've checked that their output types
1556  * can be coerced to the output column type.) Also, if it's not UNION ALL,
1557  * information about the types' sort/group semantics is provided in the form
1558  * of a SortGroupClause list (same representation as, eg, DISTINCT).
1559  * The resolved common column collations are provided too; but note that if
1560  * it's not UNION ALL, it's okay for a column to not have a common collation,
1561  * so a member of the colCollations list could be InvalidOid even though the
1562  * column has a collatable type.
1563  * ----------------------
1564  */
1565 typedef struct SetOperationStmt
1566 {
1568  SetOperation op; /* type of set op */
1569  bool all; /* ALL specified? */
1570  Node *larg; /* left child */
1571  Node *rarg; /* right child */
1572  /* Eventually add fields for CORRESPONDING spec here */
1573 
1574  /* Fields derived during parse analysis: */
1575  List *colTypes; /* OID list of output column type OIDs */
1576  List *colTypmods; /* integer list of output column typmods */
1577  List *colCollations; /* OID list of output column collation OIDs */
1578  List *groupClauses; /* a list of SortGroupClause's */
1579  /* groupClauses is NIL if UNION ALL, but must be set otherwise */
1581 
1582 
1583 /*****************************************************************************
1584  * Other Statements (no optimizations required)
1585  *
1586  * These are not touched by parser/analyze.c except to put them into
1587  * the utilityStmt field of a Query. This is eventually passed to
1588  * ProcessUtility (by-passing rewriting and planning). Some of the
1589  * statements do need attention from parse analysis, and this is
1590  * done by routines in parser/parse_utilcmd.c after ProcessUtility
1591  * receives the command for execution.
1592  * DECLARE CURSOR, EXPLAIN, and CREATE TABLE AS are special cases:
1593  * they contain optimizable statements, which get processed normally
1594  * by parser/analyze.c.
1595  *****************************************************************************/
1596 
1597 /*
1598  * When a command can act on several kinds of objects with only one
1599  * parse structure required, use these constants to designate the
1600  * object type. Note that commands typically don't support all the types.
1601  */
1602 
1603 typedef enum ObjectType
1604 {
1609  OBJECT_ATTRIBUTE, /* type's attribute, when distinct from column */
1653 } ObjectType;
1654 
1655 /* ----------------------
1656  * Create Schema Statement
1657  *
1658  * NOTE: the schemaElts list contains raw parsetrees for component statements
1659  * of the schema, such as CREATE TABLE, GRANT, etc. These are analyzed and
1660  * executed after the schema itself is created.
1661  * ----------------------
1662  */
1663 typedef struct CreateSchemaStmt
1664 {
1666  char *schemaname; /* the name of the schema to create */
1667  RoleSpec *authrole; /* the owner of the created schema */
1668  List *schemaElts; /* schema components (list of parsenodes) */
1669  bool if_not_exists; /* just do nothing if schema already exists? */
1671 
1672 typedef enum DropBehavior
1673 {
1674  DROP_RESTRICT, /* drop fails if any dependent objects */
1675  DROP_CASCADE /* remove dependent objects too */
1676 } DropBehavior;
1677 
1678 /* ----------------------
1679  * Alter Table
1680  * ----------------------
1681  */
1682 typedef struct AlterTableStmt
1683 {
1685  RangeVar *relation; /* table to work on */
1686  List *cmds; /* list of subcommands */
1687  ObjectType relkind; /* type of object */
1688  bool missing_ok; /* skip error if table missing */
1689 } AlterTableStmt;
1690 
1691 typedef enum AlterTableType
1692 {
1693  AT_AddColumn, /* add column */
1694  AT_AddColumnRecurse, /* internal to commands/tablecmds.c */
1695  AT_AddColumnToView, /* implicitly via CREATE OR REPLACE VIEW */
1696  AT_ColumnDefault, /* alter column default */
1697  AT_DropNotNull, /* alter column drop not null */
1698  AT_SetNotNull, /* alter column set not null */
1699  AT_SetStatistics, /* alter column set statistics */
1700  AT_SetOptions, /* alter column set ( options ) */
1701  AT_ResetOptions, /* alter column reset ( options ) */
1702  AT_SetStorage, /* alter column set storage */
1703  AT_DropColumn, /* drop column */
1704  AT_DropColumnRecurse, /* internal to commands/tablecmds.c */
1705  AT_AddIndex, /* add index */
1706  AT_ReAddIndex, /* internal to commands/tablecmds.c */
1707  AT_AddConstraint, /* add constraint */
1708  AT_AddConstraintRecurse, /* internal to commands/tablecmds.c */
1709  AT_ReAddConstraint, /* internal to commands/tablecmds.c */
1710  AT_AlterConstraint, /* alter constraint */
1711  AT_ValidateConstraint, /* validate constraint */
1712  AT_ValidateConstraintRecurse, /* internal to commands/tablecmds.c */
1713  AT_ProcessedConstraint, /* pre-processed add constraint (local in
1714  * parser/parse_utilcmd.c) */
1715  AT_AddIndexConstraint, /* add constraint using existing index */
1716  AT_DropConstraint, /* drop constraint */
1717  AT_DropConstraintRecurse, /* internal to commands/tablecmds.c */
1718  AT_ReAddComment, /* internal to commands/tablecmds.c */
1719  AT_AlterColumnType, /* alter column type */
1720  AT_AlterColumnGenericOptions, /* alter column OPTIONS (...) */
1721  AT_ChangeOwner, /* change owner */
1722  AT_ClusterOn, /* CLUSTER ON */
1723  AT_DropCluster, /* SET WITHOUT CLUSTER */
1724  AT_SetLogged, /* SET LOGGED */
1725  AT_SetUnLogged, /* SET UNLOGGED */
1726  AT_AddOids, /* SET WITH OIDS */
1727  AT_AddOidsRecurse, /* internal to commands/tablecmds.c */
1728  AT_DropOids, /* SET WITHOUT OIDS */
1729  AT_SetTableSpace, /* SET TABLESPACE */
1730  AT_SetRelOptions, /* SET (...) -- AM specific parameters */
1731  AT_ResetRelOptions, /* RESET (...) -- AM specific parameters */
1732  AT_ReplaceRelOptions, /* replace reloption list in its entirety */
1733  AT_EnableTrig, /* ENABLE TRIGGER name */
1734  AT_EnableAlwaysTrig, /* ENABLE ALWAYS TRIGGER name */
1735  AT_EnableReplicaTrig, /* ENABLE REPLICA TRIGGER name */
1736  AT_DisableTrig, /* DISABLE TRIGGER name */
1737  AT_EnableTrigAll, /* ENABLE TRIGGER ALL */
1738  AT_DisableTrigAll, /* DISABLE TRIGGER ALL */
1739  AT_EnableTrigUser, /* ENABLE TRIGGER USER */
1740  AT_DisableTrigUser, /* DISABLE TRIGGER USER */
1741  AT_EnableRule, /* ENABLE RULE name */
1742  AT_EnableAlwaysRule, /* ENABLE ALWAYS RULE name */
1743  AT_EnableReplicaRule, /* ENABLE REPLICA RULE name */
1744  AT_DisableRule, /* DISABLE RULE name */
1745  AT_AddInherit, /* INHERIT parent */
1746  AT_DropInherit, /* NO INHERIT parent */
1747  AT_AddOf, /* OF <type_name> */
1748  AT_DropOf, /* NOT OF */
1749  AT_ReplicaIdentity, /* REPLICA IDENTITY */
1750  AT_EnableRowSecurity, /* ENABLE ROW SECURITY */
1751  AT_DisableRowSecurity, /* DISABLE ROW SECURITY */
1752  AT_ForceRowSecurity, /* FORCE ROW SECURITY */
1753  AT_NoForceRowSecurity, /* NO FORCE ROW SECURITY */
1754  AT_GenericOptions, /* OPTIONS (...) */
1755  AT_AttachPartition, /* ATTACH PARTITION */
1756  AT_DetachPartition, /* DETACH PARTITION */
1757  AT_AddIdentity, /* ADD IDENTITY */
1758  AT_SetIdentity, /* SET identity column options */
1759  AT_DropIdentity /* DROP IDENTITY */
1760 } AlterTableType;
1761 
1762 typedef struct ReplicaIdentityStmt
1763 {
1766  char *name;
1768 
1769 typedef struct AlterTableCmd /* one subcommand of an ALTER TABLE */
1770 {
1772  AlterTableType subtype; /* Type of table alteration to apply */
1773  char *name; /* column, constraint, or trigger to act on,
1774  * or tablespace */
1776  Node *def; /* definition of new column, index,
1777  * constraint, or parent table */
1778  DropBehavior behavior; /* RESTRICT or CASCADE for DROP cases */
1779  bool missing_ok; /* skip error if missing? */
1780 } AlterTableCmd;
1781 
1782 
1783 /* ----------------------
1784  * Alter Collation
1785  * ----------------------
1786  */
1787 typedef struct AlterCollationStmt
1788 {
1792 
1793 
1794 /* ----------------------
1795  * Alter Domain
1796  *
1797  * The fields are used in different ways by the different variants of
1798  * this command.
1799  * ----------------------
1800  */
1801 typedef struct AlterDomainStmt
1802 {
1804  char subtype; /*------------
1805  * T = alter column default
1806  * N = alter column drop not null
1807  * O = alter column set not null
1808  * C = add constraint
1809  * X = drop constraint
1810  *------------
1811  */
1812  List *typeName; /* domain to work on */
1813  char *name; /* column or constraint name to act on */
1814  Node *def; /* definition of default or constraint */
1815  DropBehavior behavior; /* RESTRICT or CASCADE for DROP cases */
1816  bool missing_ok; /* skip error if missing? */
1817 } AlterDomainStmt;
1818 
1819 
1820 /* ----------------------
1821  * Grant|Revoke Statement
1822  * ----------------------
1823  */
1824 typedef enum GrantTargetType
1825 {
1826  ACL_TARGET_OBJECT, /* grant on specific named object(s) */
1827  ACL_TARGET_ALL_IN_SCHEMA, /* grant on all objects in given schema(s) */
1828  ACL_TARGET_DEFAULTS /* ALTER DEFAULT PRIVILEGES */
1829 } GrantTargetType;
1830 
1831 typedef enum GrantObjectType
1832 {
1833  ACL_OBJECT_COLUMN, /* column */
1834  ACL_OBJECT_RELATION, /* table, view */
1835  ACL_OBJECT_SEQUENCE, /* sequence */
1836  ACL_OBJECT_DATABASE, /* database */
1837  ACL_OBJECT_DOMAIN, /* domain */
1838  ACL_OBJECT_FDW, /* foreign-data wrapper */
1839  ACL_OBJECT_FOREIGN_SERVER, /* foreign server */
1840  ACL_OBJECT_FUNCTION, /* function */
1841  ACL_OBJECT_LANGUAGE, /* procedural language */
1842  ACL_OBJECT_LARGEOBJECT, /* largeobject */
1843  ACL_OBJECT_NAMESPACE, /* namespace */
1844  ACL_OBJECT_TABLESPACE, /* tablespace */
1845  ACL_OBJECT_TYPE /* type */
1846 } GrantObjectType;
1847 
1848 typedef struct GrantStmt
1849 {
1851  bool is_grant; /* true = GRANT, false = REVOKE */
1852  GrantTargetType targtype; /* type of the grant target */
1853  GrantObjectType objtype; /* kind of object being operated on */
1854  List *objects; /* list of RangeVar nodes, ObjectWithArgs
1855  * nodes, or plain names (as Value strings) */
1856  List *privileges; /* list of AccessPriv nodes */
1857  /* privileges == NIL denotes ALL PRIVILEGES */
1858  List *grantees; /* list of RoleSpec nodes */
1859  bool grant_option; /* grant or revoke grant option */
1860  DropBehavior behavior; /* drop behavior (for REVOKE) */
1861 } GrantStmt;
1862 
1863 /*
1864  * Note: ObjectWithArgs carries only the types of the input parameters of the
1865  * function. So it is sufficient to identify an existing function, but it
1866  * is not enough info to define a function nor to call it.
1867  */
1868 typedef struct ObjectWithArgs
1869 {
1871  List *objname; /* qualified name of function/operator */
1872  List *objargs; /* list of Typename nodes */
1873  bool args_unspecified; /* argument list was omitted, so name must
1874  * be unique (note that objargs == NIL
1875  * means zero args) */
1876 } ObjectWithArgs;
1877 
1878 /*
1879  * An access privilege, with optional list of column names
1880  * priv_name == NULL denotes ALL PRIVILEGES (only used with a column list)
1881  * cols == NIL denotes "all columns"
1882  * Note that simple "ALL PRIVILEGES" is represented as a NIL list, not
1883  * an AccessPriv with both fields null.
1884  */
1885 typedef struct AccessPriv
1886 {
1888  char *priv_name; /* string name of privilege */
1889  List *cols; /* list of Value strings */
1890 } AccessPriv;
1891 
1892 /* ----------------------
1893  * Grant/Revoke Role Statement
1894  *
1895  * Note: because of the parsing ambiguity with the GRANT <privileges>
1896  * statement, granted_roles is a list of AccessPriv; the execution code
1897  * should complain if any column lists appear. grantee_roles is a list
1898  * of role names, as Value strings.
1899  * ----------------------
1900  */
1901 typedef struct GrantRoleStmt
1902 {
1904  List *granted_roles; /* list of roles to be granted/revoked */
1905  List *grantee_roles; /* list of member roles to add/delete */
1906  bool is_grant; /* true = GRANT, false = REVOKE */
1907  bool admin_opt; /* with admin option */
1908  RoleSpec *grantor; /* set grantor to other than current role */
1909  DropBehavior behavior; /* drop behavior (for REVOKE) */
1910 } GrantRoleStmt;
1911 
1912 /* ----------------------
1913  * Alter Default Privileges Statement
1914  * ----------------------
1915  */
1917 {
1919  List *options; /* list of DefElem */
1920  GrantStmt *action; /* GRANT/REVOKE action (with objects=NIL) */
1922 
1923 /* ----------------------
1924  * Copy Statement
1925  *
1926  * We support "COPY relation FROM file", "COPY relation TO file", and
1927  * "COPY (query) TO file". In any given CopyStmt, exactly one of "relation"
1928  * and "query" must be non-NULL.
1929  * ----------------------
1930  */
1931 typedef struct CopyStmt
1932 {
1934  RangeVar *relation; /* the relation to copy */
1935  Node *query; /* the query (SELECT or DML statement with
1936  * RETURNING) to copy, as a raw parse tree */
1937  List *attlist; /* List of column names (as Strings), or NIL
1938  * for all columns */
1939  bool is_from; /* TO or FROM */
1940  bool is_program; /* is 'filename' a program to popen? */
1941  char *filename; /* filename, or NULL for STDIN/STDOUT */
1942  List *options; /* List of DefElem nodes */
1943 } CopyStmt;
1944 
1945 /* ----------------------
1946  * SET Statement (includes RESET)
1947  *
1948  * "SET var TO DEFAULT" and "RESET var" are semantically equivalent, but we
1949  * preserve the distinction in VariableSetKind for CreateCommandTag().
1950  * ----------------------
1951  */
1952 typedef enum
1953 {
1954  VAR_SET_VALUE, /* SET var = value */
1955  VAR_SET_DEFAULT, /* SET var TO DEFAULT */
1956  VAR_SET_CURRENT, /* SET var FROM CURRENT */
1957  VAR_SET_MULTI, /* special case for SET TRANSACTION ... */
1958  VAR_RESET, /* RESET var */
1959  VAR_RESET_ALL /* RESET ALL */
1960 } VariableSetKind;
1961 
1962 typedef struct VariableSetStmt
1963 {
1966  char *name; /* variable to be set */
1967  List *args; /* List of A_Const nodes */
1968  bool is_local; /* SET LOCAL? */
1969 } VariableSetStmt;
1970 
1971 /* ----------------------
1972  * Show Statement
1973  * ----------------------
1974  */
1975 typedef struct VariableShowStmt
1976 {
1978  char *name;
1980 
1981 /* ----------------------
1982  * Create Table Statement
1983  *
1984  * NOTE: in the raw gram.y output, ColumnDef and Constraint nodes are
1985  * intermixed in tableElts, and constraints is NIL. After parse analysis,
1986  * tableElts contains just ColumnDefs, and constraints contains just
1987  * Constraint nodes (in fact, only CONSTR_CHECK nodes, in the present
1988  * implementation).
1989  * ----------------------
1990  */
1991 
1992 typedef struct CreateStmt
1993 {
1995  RangeVar *relation; /* relation to create */
1996  List *tableElts; /* column definitions (list of ColumnDef) */
1997  List *inhRelations; /* relations to inherit from (list of
1998  * inhRelation) */
1999  PartitionBoundSpec *partbound; /* FOR VALUES clause */
2000  PartitionSpec *partspec; /* PARTITION BY clause */
2001  TypeName *ofTypename; /* OF typename */
2002  List *constraints; /* constraints (list of Constraint nodes) */
2003  List *options; /* options from WITH clause */
2004  OnCommitAction oncommit; /* what do we do at COMMIT? */
2005  char *tablespacename; /* table space to use, or NULL */
2006  bool if_not_exists; /* just do nothing if it already exists? */
2007 } CreateStmt;
2008 
2009 /* ----------
2010  * Definitions for constraints in CreateStmt
2011  *
2012  * Note that column defaults are treated as a type of constraint,
2013  * even though that's a bit odd semantically.
2014  *
2015  * For constraints that use expressions (CONSTR_CHECK, CONSTR_DEFAULT)
2016  * we may have the expression in either "raw" form (an untransformed
2017  * parse tree) or "cooked" form (the nodeToString representation of
2018  * an executable expression tree), depending on how this Constraint
2019  * node was created (by parsing, or by inheritance from an existing
2020  * relation). We should never have both in the same node!
2021  *
2022  * FKCONSTR_ACTION_xxx values are stored into pg_constraint.confupdtype
2023  * and pg_constraint.confdeltype columns; FKCONSTR_MATCH_xxx values are
2024  * stored into pg_constraint.confmatchtype. Changing the code values may
2025  * require an initdb!
2026  *
2027  * If skip_validation is true then we skip checking that the existing rows
2028  * in the table satisfy the constraint, and just install the catalog entries
2029  * for the constraint. A new FK constraint is marked as valid iff
2030  * initially_valid is true. (Usually skip_validation and initially_valid
2031  * are inverses, but we can set both true if the table is known empty.)
2032  *
2033  * Constraint attributes (DEFERRABLE etc) are initially represented as
2034  * separate Constraint nodes for simplicity of parsing. parse_utilcmd.c makes
2035  * a pass through the constraints list to insert the info into the appropriate
2036  * Constraint node.
2037  * ----------
2038  */
2039 
2040 typedef enum ConstrType /* types of constraints */
2041 {
2042  CONSTR_NULL, /* not standard SQL, but a lot of people
2043  * expect it */
2052  CONSTR_ATTR_DEFERRABLE, /* attributes for previous constraint node */
2056 } ConstrType;
2057 
2058 /* Foreign key action codes */
2059 #define FKCONSTR_ACTION_NOACTION 'a'
2060 #define FKCONSTR_ACTION_RESTRICT 'r'
2061 #define FKCONSTR_ACTION_CASCADE 'c'
2062 #define FKCONSTR_ACTION_SETNULL 'n'
2063 #define FKCONSTR_ACTION_SETDEFAULT 'd'
2064 
2065 /* Foreign key matchtype codes */
2066 #define FKCONSTR_MATCH_FULL 'f'
2067 #define FKCONSTR_MATCH_PARTIAL 'p'
2068 #define FKCONSTR_MATCH_SIMPLE 's'
2069 
2070 typedef struct Constraint
2071 {
2073  ConstrType contype; /* see above */
2074 
2075  /* Fields used for most/all constraint types: */
2076  char *conname; /* Constraint name, or NULL if unnamed */
2077  bool deferrable; /* DEFERRABLE? */
2078  bool initdeferred; /* INITIALLY DEFERRED? */
2079  int location; /* token location, or -1 if unknown */
2080 
2081  /* Fields used for constraints with expressions (CHECK and DEFAULT): */
2082  bool is_no_inherit; /* is constraint non-inheritable? */
2083  Node *raw_expr; /* expr, as untransformed parse tree */
2084  char *cooked_expr; /* expr, as nodeToString representation */
2086 
2087  /* Fields used for unique constraints (UNIQUE and PRIMARY KEY): */
2088  List *keys; /* String nodes naming referenced column(s) */
2089 
2090  /* Fields used for EXCLUSION constraints: */
2091  List *exclusions; /* list of (IndexElem, operator name) pairs */
2092 
2093  /* Fields used for index constraints (UNIQUE, PRIMARY KEY, EXCLUSION): */
2094  List *options; /* options from WITH clause */
2095  char *indexname; /* existing index to use; otherwise NULL */
2096  char *indexspace; /* index tablespace; NULL for default */
2097  /* These could be, but currently are not, used for UNIQUE/PKEY: */
2098  char *access_method; /* index access method; NULL for default */
2099  Node *where_clause; /* partial index predicate */
2100 
2101  /* Fields used for FOREIGN KEY constraints: */
2102  RangeVar *pktable; /* Primary key table */
2103  List *fk_attrs; /* Attributes of foreign key */
2104  List *pk_attrs; /* Corresponding attrs in PK table */
2105  char fk_matchtype; /* FULL, PARTIAL, SIMPLE */
2106  char fk_upd_action; /* ON UPDATE action */
2107  char fk_del_action; /* ON DELETE action */
2108  List *old_conpfeqop; /* pg_constraint.conpfeqop of my former self */
2109  Oid old_pktable_oid; /* pg_constraint.confrelid of my former
2110  * self */
2111 
2112  /* Fields used for constraints that allow a NOT VALID specification */
2113  bool skip_validation; /* skip validation of existing rows? */
2114  bool initially_valid; /* mark the new constraint as valid? */
2115 } Constraint;
2116 
2117 /* ----------------------
2118  * Create/Drop Table Space Statements
2119  * ----------------------
2120  */
2121 
2122 typedef struct CreateTableSpaceStmt
2123 {
2127  char *location;
2130 
2131 typedef struct DropTableSpaceStmt
2132 {
2135  bool missing_ok; /* skip error if missing? */
2137 
2139 {
2143  bool isReset;
2145 
2147 {
2150  ObjectType objtype; /* Object type to move */
2151  List *roles; /* List of roles to move objects of */
2153  bool nowait;
2155 
2156 /* ----------------------
2157  * Create/Alter Extension Statements
2158  * ----------------------
2159  */
2160 
2161 typedef struct CreateExtensionStmt
2162 {
2164  char *extname;
2165  bool if_not_exists; /* just do nothing if it already exists? */
2166  List *options; /* List of DefElem nodes */
2168 
2169 /* Only used for ALTER EXTENSION UPDATE; later might need an action field */
2170 typedef struct AlterExtensionStmt
2171 {
2173  char *extname;
2174  List *options; /* List of DefElem nodes */
2176 
2178 {
2180  char *extname; /* Extension's name */
2181  int action; /* +1 = add object, -1 = drop object */
2182  ObjectType objtype; /* Object's type */
2183  Node *object; /* Qualified name of the object */
2185 
2186 /* ----------------------
2187  * Create/Alter FOREIGN DATA WRAPPER Statements
2188  * ----------------------
2189  */
2190 
2191 typedef struct CreateFdwStmt
2192 {
2194  char *fdwname; /* foreign-data wrapper name */
2195  List *func_options; /* HANDLER/VALIDATOR options */
2196  List *options; /* generic options to FDW */
2197 } CreateFdwStmt;
2198 
2199 typedef struct AlterFdwStmt
2200 {
2202  char *fdwname; /* foreign-data wrapper name */
2203  List *func_options; /* HANDLER/VALIDATOR options */
2204  List *options; /* generic options to FDW */
2205 } AlterFdwStmt;
2206 
2207 /* ----------------------
2208  * Create/Alter FOREIGN SERVER Statements
2209  * ----------------------
2210  */
2211 
2213 {
2215  char *servername; /* server name */
2216  char *servertype; /* optional server type */
2217  char *version; /* optional server version */
2218  char *fdwname; /* FDW name */
2219  bool if_not_exists; /* just do nothing if it already exists? */
2220  List *options; /* generic options to server */
2222 
2224 {
2226  char *servername; /* server name */
2227  char *version; /* optional server version */
2228  List *options; /* generic options to server */
2229  bool has_version; /* version specified */
2231 
2232 /* ----------------------
2233  * Create FOREIGN TABLE Statement
2234  * ----------------------
2235  */
2236 
2238 {
2240  char *servername;
2243 
2244 /* ----------------------
2245  * Create/Drop USER MAPPING Statements
2246  * ----------------------
2247  */
2248 
2250 {
2252  RoleSpec *user; /* user role */
2253  char *servername; /* server name */
2254  bool if_not_exists; /* just do nothing if it already exists? */
2255  List *options; /* generic options to server */
2257 
2258 typedef struct AlterUserMappingStmt
2259 {
2261  RoleSpec *user; /* user role */
2262  char *servername; /* server name */
2263  List *options; /* generic options to server */
2265 
2266 typedef struct DropUserMappingStmt
2267 {
2269  RoleSpec *user; /* user role */
2270  char *servername; /* server name */
2271  bool missing_ok; /* ignore missing mappings */
2273 
2274 /* ----------------------
2275  * Import Foreign Schema Statement
2276  * ----------------------
2277  */
2278 
2280 {
2281  FDW_IMPORT_SCHEMA_ALL, /* all relations wanted */
2282  FDW_IMPORT_SCHEMA_LIMIT_TO, /* include only listed tables in import */
2283  FDW_IMPORT_SCHEMA_EXCEPT /* exclude listed tables from import */
2285 
2287 {
2289  char *server_name; /* FDW server name */
2290  char *remote_schema; /* remote schema name to query */
2291  char *local_schema; /* local schema to create objects in */
2292  ImportForeignSchemaType list_type; /* type of table list */
2293  List *table_list; /* List of RangeVar */
2294  List *options; /* list of options to pass to FDW */
2296 
2297 /*----------------------
2298  * Create POLICY Statement
2299  *----------------------
2300  */
2301 typedef struct CreatePolicyStmt
2302 {
2304  char *policy_name; /* Policy's name */
2305  RangeVar *table; /* the table name the policy applies to */
2306  char *cmd_name; /* the command name the policy applies to */
2307  bool permissive; /* restrictive or permissive policy */
2308  List *roles; /* the roles associated with the policy */
2309  Node *qual; /* the policy's condition */
2310  Node *with_check; /* the policy's WITH CHECK condition. */
2312 
2313 /*----------------------
2314  * Alter POLICY Statement
2315  *----------------------
2316  */
2317 typedef struct AlterPolicyStmt
2318 {
2320  char *policy_name; /* Policy's name */
2321  RangeVar *table; /* the table name the policy applies to */
2322  List *roles; /* the roles associated with the policy */
2323  Node *qual; /* the policy's condition */
2324  Node *with_check; /* the policy's WITH CHECK condition. */
2325 } AlterPolicyStmt;
2326 
2327 /*----------------------
2328  * Create ACCESS METHOD Statement
2329  *----------------------
2330  */
2331 typedef struct CreateAmStmt
2332 {
2334  char *amname; /* access method name */
2335  List *handler_name; /* handler function name */
2336  char amtype; /* type of access method */
2337 } CreateAmStmt;
2338 
2339 /* ----------------------
2340  * Create TRIGGER Statement
2341  * ----------------------
2342  */
2343 typedef struct CreateTrigStmt
2344 {
2346  char *trigname; /* TRIGGER's name */
2347  RangeVar *relation; /* relation trigger is on */
2348  List *funcname; /* qual. name of function to call */
2349  List *args; /* list of (T_String) Values or NIL */
2350  bool row; /* ROW/STATEMENT */
2351  /* timing uses the TRIGGER_TYPE bits defined in catalog/pg_trigger.h */
2352  int16 timing; /* BEFORE, AFTER, or INSTEAD */
2353  /* events uses the TRIGGER_TYPE bits defined in catalog/pg_trigger.h */
2354  int16 events; /* "OR" of INSERT/UPDATE/DELETE/TRUNCATE */
2355  List *columns; /* column names, or NIL for all columns */
2356  Node *whenClause; /* qual expression, or NULL if none */
2357  bool isconstraint; /* This is a constraint trigger */
2358  /* explicitly named transition data */
2359  List *transitionRels; /* TriggerTransition nodes, or NIL if none */
2360  /* The remaining fields are only used for constraint triggers */
2361  bool deferrable; /* [NOT] DEFERRABLE */
2362  bool initdeferred; /* INITIALLY {DEFERRED|IMMEDIATE} */
2363  RangeVar *constrrel; /* opposite relation, if RI trigger */
2364 } CreateTrigStmt;
2365 
2366 /* ----------------------
2367  * Create EVENT TRIGGER Statement
2368  * ----------------------
2369  */
2370 typedef struct CreateEventTrigStmt
2371 {
2373  char *trigname; /* TRIGGER's name */
2374  char *eventname; /* event's identifier */
2375  List *whenclause; /* list of DefElems indicating filtering */
2376  List *funcname; /* qual. name of function to call */
2378 
2379 /* ----------------------
2380  * Alter EVENT TRIGGER Statement
2381  * ----------------------
2382  */
2383 typedef struct AlterEventTrigStmt
2384 {
2386  char *trigname; /* TRIGGER's name */
2387  char tgenabled; /* trigger's firing configuration WRT
2388  * session_replication_role */
2390 
2391 /* ----------------------
2392  * Create/Drop PROCEDURAL LANGUAGE Statements
2393  * Create PROCEDURAL LANGUAGE Statements
2394  * ----------------------
2395  */
2396 typedef struct CreatePLangStmt
2397 {
2399  bool replace; /* T => replace if already exists */
2400  char *plname; /* PL name */
2401  List *plhandler; /* PL call handler function (qual. name) */
2402  List *plinline; /* optional inline function (qual. name) */
2403  List *plvalidator; /* optional validator function (qual. name) */
2404  bool pltrusted; /* PL is trusted */
2405 } CreatePLangStmt;
2406 
2407 /* ----------------------
2408  * Create/Alter/Drop Role Statements
2409  *
2410  * Note: these node types are also used for the backwards-compatible
2411  * Create/Alter/Drop User/Group statements. In the ALTER and DROP cases
2412  * there's really no need to distinguish what the original spelling was,
2413  * but for CREATE we mark the type because the defaults vary.
2414  * ----------------------
2415  */
2416 typedef enum RoleStmtType
2417 {
2421 } RoleStmtType;
2422 
2423 typedef struct CreateRoleStmt
2424 {
2426  RoleStmtType stmt_type; /* ROLE/USER/GROUP */
2427  char *role; /* role name */
2428  List *options; /* List of DefElem nodes */
2429 } CreateRoleStmt;
2430 
2431 typedef struct AlterRoleStmt
2432 {
2434  RoleSpec *role; /* role */
2435  List *options; /* List of DefElem nodes */
2436  int action; /* +1 = add members, -1 = drop members */
2437 } AlterRoleStmt;
2438 
2439 typedef struct AlterRoleSetStmt
2440 {
2442  RoleSpec *role; /* role */
2443  char *database; /* database name, or NULL */
2444  VariableSetStmt *setstmt; /* SET or RESET subcommand */
2446 
2447 typedef struct DropRoleStmt
2448 {
2450  List *roles; /* List of roles to remove */
2451  bool missing_ok; /* skip error if a role is missing? */
2452 } DropRoleStmt;
2453 
2454 /* ----------------------
2455  * {Create|Alter} SEQUENCE Statement
2456  * ----------------------
2457  */
2458 
2459 typedef struct CreateSeqStmt
2460 {
2462  RangeVar *sequence; /* the sequence to create */
2464  Oid ownerId; /* ID of owner, or InvalidOid for default */
2466  bool if_not_exists; /* just do nothing if it already exists? */
2467 } CreateSeqStmt;
2468 
2469 typedef struct AlterSeqStmt
2470 {
2472  RangeVar *sequence; /* the sequence to alter */
2475  bool missing_ok; /* skip error if a role is missing? */
2476 } AlterSeqStmt;
2477 
2478 /* ----------------------
2479  * Create {Aggregate|Operator|Type} Statement
2480  * ----------------------
2481  */
2482 typedef struct DefineStmt
2483 {
2485  ObjectType kind; /* aggregate, operator, type */
2486  bool oldstyle; /* hack to signal old CREATE AGG syntax */
2487  List *defnames; /* qualified name (list of Value strings) */
2488  List *args; /* a list of TypeName (if needed) */
2489  List *definition; /* a list of DefElem */
2490  bool if_not_exists; /* just do nothing if it already exists? */
2491 } DefineStmt;
2492 
2493 /* ----------------------
2494  * Create Domain Statement
2495  * ----------------------
2496  */
2497 typedef struct CreateDomainStmt
2498 {
2500  List *domainname; /* qualified name (list of Value strings) */
2501  TypeName *typeName; /* the base type */
2502  CollateClause *collClause; /* untransformed COLLATE spec, if any */
2503  List *constraints; /* constraints (list of Constraint nodes) */
2505 
2506 /* ----------------------
2507  * Create Operator Class Statement
2508  * ----------------------
2509  */
2510 typedef struct CreateOpClassStmt
2511 {
2513  List *opclassname; /* qualified name (list of Value strings) */
2514  List *opfamilyname; /* qualified name (ditto); NIL if omitted */
2515  char *amname; /* name of index AM opclass is for */
2516  TypeName *datatype; /* datatype of indexed column */
2517  List *items; /* List of CreateOpClassItem nodes */
2518  bool isDefault; /* Should be marked as default for type? */
2520 
2521 #define OPCLASS_ITEM_OPERATOR 1
2522 #define OPCLASS_ITEM_FUNCTION 2
2523 #define OPCLASS_ITEM_STORAGETYPE 3
2524 
2525 typedef struct CreateOpClassItem
2526 {
2528  int itemtype; /* see codes above */
2529  ObjectWithArgs *name; /* operator or function name and args */
2530  int number; /* strategy num or support proc num */
2531  List *order_family; /* only used for ordering operators */
2532  List *class_args; /* amproclefttype/amprocrighttype or
2533  * amoplefttype/amoprighttype */
2534  /* fields used for a storagetype item: */
2535  TypeName *storedtype; /* datatype stored in index */
2537 
2538 /* ----------------------
2539  * Create Operator Family Statement
2540  * ----------------------
2541  */
2542 typedef struct CreateOpFamilyStmt
2543 {
2545  List *opfamilyname; /* qualified name (list of Value strings) */
2546  char *amname; /* name of index AM opfamily is for */
2548 
2549 /* ----------------------
2550  * Alter Operator Family Statement
2551  * ----------------------
2552  */
2553 typedef struct AlterOpFamilyStmt
2554 {
2556  List *opfamilyname; /* qualified name (list of Value strings) */
2557  char *amname; /* name of index AM opfamily is for */
2558  bool isDrop; /* ADD or DROP the items? */
2559  List *items; /* List of CreateOpClassItem nodes */
2561 
2562 /* ----------------------
2563  * Drop Table|Sequence|View|Index|Type|Domain|Conversion|Schema Statement
2564  * ----------------------
2565  */
2566 
2567 typedef struct DropStmt
2568 {
2570  List *objects; /* list of names */
2571  ObjectType removeType; /* object type */
2572  DropBehavior behavior; /* RESTRICT or CASCADE behavior */
2573  bool missing_ok; /* skip error if object is missing? */
2574  bool concurrent; /* drop index concurrently? */
2575 } DropStmt;
2576 
2577 /* ----------------------
2578  * Truncate Table Statement
2579  * ----------------------
2580  */
2581 typedef struct TruncateStmt
2582 {
2584  List *relations; /* relations (RangeVars) to be truncated */
2585  bool restart_seqs; /* restart owned sequences? */
2586  DropBehavior behavior; /* RESTRICT or CASCADE behavior */
2587 } TruncateStmt;
2588 
2589 /* ----------------------
2590  * Comment On Statement
2591  * ----------------------
2592  */
2593 typedef struct CommentStmt
2594 {
2596  ObjectType objtype; /* Object's type */
2597  Node *object; /* Qualified name of the object */
2598  char *comment; /* Comment to insert, or NULL to remove */
2599 } CommentStmt;
2600 
2601 /* ----------------------
2602  * SECURITY LABEL Statement
2603  * ----------------------
2604  */
2605 typedef struct SecLabelStmt
2606 {
2608  ObjectType objtype; /* Object's type */
2609  Node *object; /* Qualified name of the object */
2610  char *provider; /* Label provider (or NULL) */
2611  char *label; /* New security label to be assigned */
2612 } SecLabelStmt;
2613 
2614 /* ----------------------
2615  * Declare Cursor Statement
2616  *
2617  * The "query" field is initially a raw parse tree, and is converted to a
2618  * Query node during parse analysis. Note that rewriting and planning
2619  * of the query are always postponed until execution.
2620  * ----------------------
2621  */
2622 #define CURSOR_OPT_BINARY 0x0001 /* BINARY */
2623 #define CURSOR_OPT_SCROLL 0x0002 /* SCROLL explicitly given */
2624 #define CURSOR_OPT_NO_SCROLL 0x0004 /* NO SCROLL explicitly given */
2625 #define CURSOR_OPT_INSENSITIVE 0x0008 /* INSENSITIVE */
2626 #define CURSOR_OPT_HOLD 0x0010 /* WITH HOLD */
2627 /* these planner-control flags do not correspond to any SQL grammar: */
2628 #define CURSOR_OPT_FAST_PLAN 0x0020 /* prefer fast-start plan */
2629 #define CURSOR_OPT_GENERIC_PLAN 0x0040 /* force use of generic plan */
2630 #define CURSOR_OPT_CUSTOM_PLAN 0x0080 /* force use of custom plan */
2631 #define CURSOR_OPT_PARALLEL_OK 0x0100 /* parallel mode OK */
2632 
2633 typedef struct DeclareCursorStmt
2634 {
2636  char *portalname; /* name of the portal (cursor) */
2637  int options; /* bitmask of options (see above) */
2638  Node *query; /* the query (see comments above) */
2640 
2641 /* ----------------------
2642  * Close Portal Statement
2643  * ----------------------
2644  */
2645 typedef struct ClosePortalStmt
2646 {
2648  char *portalname; /* name of the portal (cursor) */
2649  /* NULL means CLOSE ALL */
2650 } ClosePortalStmt;
2651 
2652 /* ----------------------
2653  * Fetch Statement (also Move)
2654  * ----------------------
2655  */
2656 typedef enum FetchDirection
2657 {
2658  /* for these, howMany is how many rows to fetch; FETCH_ALL means ALL */
2661  /* for these, howMany indicates a position; only one row is fetched */
2664 } FetchDirection;
2665 
2666 #define FETCH_ALL LONG_MAX
2667 
2668 typedef struct FetchStmt
2669 {
2671  FetchDirection direction; /* see above */
2672  long howMany; /* number of rows, or position argument */
2673  char *portalname; /* name of portal (cursor) */
2674  bool ismove; /* TRUE if MOVE */
2675 } FetchStmt;
2676 
2677 /* ----------------------
2678  * Create Index Statement
2679  *
2680  * This represents creation of an index and/or an associated constraint.
2681  * If isconstraint is true, we should create a pg_constraint entry along
2682  * with the index. But if indexOid isn't InvalidOid, we are not creating an
2683  * index, just a UNIQUE/PKEY constraint using an existing index. isconstraint
2684  * must always be true in this case, and the fields describing the index
2685  * properties are empty.
2686  * ----------------------
2687  */
2688 typedef struct IndexStmt
2689 {
2691  char *idxname; /* name of new index, or NULL for default */
2692  RangeVar *relation; /* relation to build index on */
2693  char *accessMethod; /* name of access method (eg. btree) */
2694  char *tableSpace; /* tablespace, or NULL for default */
2695  List *indexParams; /* columns to index: a list of IndexElem */
2696  List *options; /* WITH clause options: a list of DefElem */
2697  Node *whereClause; /* qualification (partial-index predicate) */
2698  List *excludeOpNames; /* exclusion operator names, or NIL if none */
2699  char *idxcomment; /* comment to apply to index, or NULL */
2700  Oid indexOid; /* OID of an existing index, if any */
2701  Oid oldNode; /* relfilenode of existing storage, if any */
2702  bool unique; /* is index unique? */
2703  bool primary; /* is index a primary key? */
2704  bool isconstraint; /* is it for a pkey/unique constraint? */
2705  bool deferrable; /* is the constraint DEFERRABLE? */
2706  bool initdeferred; /* is the constraint INITIALLY DEFERRED? */
2707  bool transformed; /* true when transformIndexStmt is finished */
2708  bool concurrent; /* should this be a concurrent index build? */
2709  bool if_not_exists; /* just do nothing if index already exists? */
2710 } IndexStmt;
2711 
2712 /* ----------------------
2713  * Create Statistics Statement
2714  * ----------------------
2715  */
2716 typedef struct CreateStatsStmt
2717 {
2719  List *defnames; /* qualified name (list of Value strings) */
2720  List *stat_types; /* stat types (list of Value strings) */
2721  List *exprs; /* expressions to build statistics on */
2722  List *relations; /* rels to build stats on (list of RangeVar) */
2723  bool if_not_exists; /* do nothing if stats name already exists */
2724 } CreateStatsStmt;
2725 
2726 /* ----------------------
2727  * Create Function Statement
2728  * ----------------------
2729  */
2730 typedef struct CreateFunctionStmt
2731 {
2733  bool replace; /* T => replace if already exists */
2734  List *funcname; /* qualified name of function to create */
2735  List *parameters; /* a list of FunctionParameter */
2736  TypeName *returnType; /* the return type */
2737  List *options; /* a list of DefElem */
2738  List *withClause; /* a list of DefElem */
2740 
2742 {
2743  /* the assigned enum values appear in pg_proc, don't change 'em! */
2744  FUNC_PARAM_IN = 'i', /* input only */
2745  FUNC_PARAM_OUT = 'o', /* output only */
2746  FUNC_PARAM_INOUT = 'b', /* both */
2747  FUNC_PARAM_VARIADIC = 'v', /* variadic (always input) */
2748  FUNC_PARAM_TABLE = 't' /* table function output column */
2750 
2751 typedef struct FunctionParameter
2752 {
2754  char *name; /* parameter name, or NULL if not given */
2755  TypeName *argType; /* TypeName for parameter type */
2756  FunctionParameterMode mode; /* IN/OUT/etc */
2757  Node *defexpr; /* raw default expr, or NULL if not given */
2759 
2760 typedef struct AlterFunctionStmt
2761 {
2763  ObjectWithArgs *func; /* name and args of function */
2764  List *actions; /* list of DefElem */
2766 
2767 /* ----------------------
2768  * DO Statement
2769  *
2770  * DoStmt is the raw parser output, InlineCodeBlock is the execution-time API
2771  * ----------------------
2772  */
2773 typedef struct DoStmt
2774 {
2776  List *args; /* List of DefElem nodes */
2777 } DoStmt;
2778 
2779 typedef struct InlineCodeBlock
2780 {
2782  char *source_text; /* source text of anonymous code block */
2783  Oid langOid; /* OID of selected language */
2784  bool langIsTrusted; /* trusted property of the language */
2785 } InlineCodeBlock;
2786 
2787 /* ----------------------
2788  * Alter Object Rename Statement
2789  * ----------------------
2790  */
2791 typedef struct RenameStmt
2792 {
2794  ObjectType renameType; /* OBJECT_TABLE, OBJECT_COLUMN, etc */
2795  ObjectType relationType; /* if column name, associated relation type */
2796  RangeVar *relation; /* in case it's a table */
2797  Node *object; /* in case it's some other object */
2798  char *subname; /* name of contained object (column, rule,
2799  * trigger, etc) */
2800  char *newname; /* the new name */
2801  DropBehavior behavior; /* RESTRICT or CASCADE behavior */
2802  bool missing_ok; /* skip error if missing? */
2803 } RenameStmt;
2804 
2805 /* ----------------------
2806  * ALTER object DEPENDS ON EXTENSION extname
2807  * ----------------------
2808  */
2810 {
2812  ObjectType objectType; /* OBJECT_FUNCTION, OBJECT_TRIGGER, etc */
2813  RangeVar *relation; /* in case a table is involved */
2814  Node *object; /* name of the object */
2815  Value *extname; /* extension name */
2817 
2818 /* ----------------------
2819  * ALTER object SET SCHEMA Statement
2820  * ----------------------
2821  */
2823 {
2825  ObjectType objectType; /* OBJECT_TABLE, OBJECT_TYPE, etc */
2826  RangeVar *relation; /* in case it's a table */
2827  Node *object; /* in case it's some other object */
2828  char *newschema; /* the new schema */
2829  bool missing_ok; /* skip error if missing? */
2831 
2832 /* ----------------------
2833  * Alter Object Owner Statement
2834  * ----------------------
2835  */
2836 typedef struct AlterOwnerStmt
2837 {
2839  ObjectType objectType; /* OBJECT_TABLE, OBJECT_TYPE, etc */
2840  RangeVar *relation; /* in case it's a table */
2841  Node *object; /* in case it's some other object */
2842  RoleSpec *newowner; /* the new owner */
2843 } AlterOwnerStmt;
2844 
2845 
2846 /* ----------------------
2847  * Alter Operator Set Restrict, Join
2848  * ----------------------
2849  */
2850 typedef struct AlterOperatorStmt
2851 {
2853  ObjectWithArgs *opername; /* operator name and argument types */
2854  List *options; /* List of DefElem nodes */
2856 
2857 
2858 /* ----------------------
2859  * Create Rule Statement
2860  * ----------------------
2861  */
2862 typedef struct RuleStmt
2863 {
2865  RangeVar *relation; /* relation the rule is for */
2866  char *rulename; /* name of the rule */
2867  Node *whereClause; /* qualifications */
2868  CmdType event; /* SELECT, INSERT, etc */
2869  bool instead; /* is a 'do instead'? */
2870  List *actions; /* the action statements */
2871  bool replace; /* OR REPLACE */
2872 } RuleStmt;
2873 
2874 /* ----------------------
2875  * Notify Statement
2876  * ----------------------
2877  */
2878 typedef struct NotifyStmt
2879 {
2881  char *conditionname; /* condition name to notify */
2882  char *payload; /* the payload string, or NULL if none */
2883 } NotifyStmt;
2884 
2885 /* ----------------------
2886  * Listen Statement
2887  * ----------------------
2888  */
2889 typedef struct ListenStmt
2890 {
2892  char *conditionname; /* condition name to listen on */
2893 } ListenStmt;
2894 
2895 /* ----------------------
2896  * Unlisten Statement
2897  * ----------------------
2898  */
2899 typedef struct UnlistenStmt
2900 {
2902  char *conditionname; /* name to unlisten on, or NULL for all */
2903 } UnlistenStmt;
2904 
2905 /* ----------------------
2906  * {Begin|Commit|Rollback} Transaction Statement
2907  * ----------------------
2908  */
2910 {
2912  TRANS_STMT_START, /* semantically identical to BEGIN */
2922 
2923 typedef struct TransactionStmt
2924 {
2926  TransactionStmtKind kind; /* see above */
2927  List *options; /* for BEGIN/START and savepoint commands */
2928  char *gid; /* for two-phase-commit related commands */
2929 } TransactionStmt;
2930 
2931 /* ----------------------
2932  * Create Type Statement, composite types
2933  * ----------------------
2934  */
2935 typedef struct CompositeTypeStmt
2936 {
2938  RangeVar *typevar; /* the composite type to be created */
2939  List *coldeflist; /* list of ColumnDef nodes */
2941 
2942 /* ----------------------
2943  * Create Type Statement, enum types
2944  * ----------------------
2945  */
2946 typedef struct CreateEnumStmt
2947 {
2949  List *typeName; /* qualified name (list of Value strings) */
2950  List *vals; /* enum values (list of Value strings) */
2951 } CreateEnumStmt;
2952 
2953 /* ----------------------
2954  * Create Type Statement, range types
2955  * ----------------------
2956  */
2957 typedef struct CreateRangeStmt
2958 {
2960  List *typeName; /* qualified name (list of Value strings) */
2961  List *params; /* range parameters (list of DefElem) */
2962 } CreateRangeStmt;
2963 
2964 /* ----------------------
2965  * Alter Type Statement, enum types
2966  * ----------------------
2967  */
2968 typedef struct AlterEnumStmt
2969 {
2971  List *typeName; /* qualified name (list of Value strings) */
2972  char *oldVal; /* old enum value's name, if renaming */
2973  char *newVal; /* new enum value's name */
2974  char *newValNeighbor; /* neighboring enum value, if specified */
2975  bool newValIsAfter; /* place new enum value after neighbor? */
2976  bool skipIfNewValExists; /* no error if new already exists? */
2977 } AlterEnumStmt;
2978 
2979 /* ----------------------
2980  * Create View Statement
2981  * ----------------------
2982  */
2983 typedef enum ViewCheckOption
2984 {
2988 } ViewCheckOption;
2989 
2990 typedef struct ViewStmt
2991 {
2993  RangeVar *view; /* the view to be created */
2994  List *aliases; /* target column names */
2995  Node *query; /* the SELECT query (as a raw parse tree) */
2996  bool replace; /* replace an existing view? */
2997  List *options; /* options from WITH clause */
2998  ViewCheckOption withCheckOption; /* WITH CHECK OPTION */
2999 } ViewStmt;
3000 
3001 /* ----------------------
3002  * Load Statement
3003  * ----------------------
3004  */
3005 typedef struct LoadStmt
3006 {
3008  char *filename; /* file to load */
3009 } LoadStmt;
3010 
3011 /* ----------------------
3012  * Createdb Statement
3013  * ----------------------
3014  */
3015 typedef struct CreatedbStmt
3016 {
3018  char *dbname; /* name of database to create */
3019  List *options; /* List of DefElem nodes */
3020 } CreatedbStmt;
3021 
3022 /* ----------------------
3023  * Alter Database
3024  * ----------------------
3025  */
3026 typedef struct AlterDatabaseStmt
3027 {
3029  char *dbname; /* name of database to alter */
3030  List *options; /* List of DefElem nodes */
3032 
3033 typedef struct AlterDatabaseSetStmt
3034 {
3036  char *dbname; /* database name */
3037  VariableSetStmt *setstmt; /* SET or RESET subcommand */
3039 
3040 /* ----------------------
3041  * Dropdb Statement
3042  * ----------------------
3043  */
3044 typedef struct DropdbStmt
3045 {
3047  char *dbname; /* database to drop */
3048  bool missing_ok; /* skip error if db is missing? */
3049 } DropdbStmt;
3050 
3051 /* ----------------------
3052  * Alter System Statement
3053  * ----------------------
3054  */
3055 typedef struct AlterSystemStmt
3056 {
3058  VariableSetStmt *setstmt; /* SET subcommand */
3059 } AlterSystemStmt;
3060 
3061 /* ----------------------
3062  * Cluster Statement (support pbrown's cluster index implementation)
3063  * ----------------------
3064  */
3065 typedef struct ClusterStmt
3066 {
3068  RangeVar *relation; /* relation being indexed, or NULL if all */
3069  char *indexname; /* original index defined */
3070  bool verbose; /* print progress info */
3071 } ClusterStmt;
3072 
3073 /* ----------------------
3074  * Vacuum and Analyze Statements
3075  *
3076  * Even though these are nominally two statements, it's convenient to use
3077  * just one node type for both. Note that at least one of VACOPT_VACUUM
3078  * and VACOPT_ANALYZE must be set in options.
3079  * ----------------------
3080  */
3081 typedef enum VacuumOption
3082 {
3083  VACOPT_VACUUM = 1 << 0, /* do VACUUM */
3084  VACOPT_ANALYZE = 1 << 1, /* do ANALYZE */
3085  VACOPT_VERBOSE = 1 << 2, /* print progress info */
3086  VACOPT_FREEZE = 1 << 3, /* FREEZE option */
3087  VACOPT_FULL = 1 << 4, /* FULL (non-concurrent) vacuum */
3088  VACOPT_NOWAIT = 1 << 5, /* don't wait to get lock (autovacuum only) */
3089  VACOPT_SKIPTOAST = 1 << 6, /* don't process the TOAST table, if any */
3090  VACOPT_DISABLE_PAGE_SKIPPING = 1 << 7 /* don't skip any pages */
3091 } VacuumOption;
3092 
3093 typedef struct VacuumStmt
3094 {
3096  int options; /* OR of VacuumOption flags */
3097  RangeVar *relation; /* single table to process, or NULL */
3098  List *va_cols; /* list of column names, or NIL for all */
3099 } VacuumStmt;
3100 
3101 /* ----------------------
3102  * Explain Statement
3103  *
3104  * The "query" field is initially a raw parse tree, and is converted to a
3105  * Query node during parse analysis. Note that rewriting and planning
3106  * of the query are always postponed until execution.
3107  * ----------------------
3108  */
3109 typedef struct ExplainStmt
3110 {
3112  Node *query; /* the query (see comments above) */
3113  List *options; /* list of DefElem nodes */
3114 } ExplainStmt;
3115 
3116 /* ----------------------
3117  * CREATE TABLE AS Statement (a/k/a SELECT INTO)
3118  *
3119  * A query written as CREATE TABLE AS will produce this node type natively.
3120  * A query written as SELECT ... INTO will be transformed to this form during
3121  * parse analysis.
3122  * A query written as CREATE MATERIALIZED view will produce this node type,
3123  * during parse analysis, since it needs all the same data.
3124  *
3125  * The "query" field is handled similarly to EXPLAIN, though note that it
3126  * can be a SELECT or an EXECUTE, but not other DML statements.
3127  * ----------------------
3128  */
3129 typedef struct CreateTableAsStmt
3130 {
3132  Node *query; /* the query (see comments above) */
3133  IntoClause *into; /* destination table */
3134  ObjectType relkind; /* OBJECT_TABLE or OBJECT_MATVIEW */
3135  bool is_select_into; /* it was written as SELECT INTO */
3136  bool if_not_exists; /* just do nothing if it already exists? */
3138 
3139 /* ----------------------
3140  * REFRESH MATERIALIZED VIEW Statement
3141  * ----------------------
3142  */
3143 typedef struct RefreshMatViewStmt
3144 {
3146  bool concurrent; /* allow concurrent access? */
3147  bool skipData; /* true for WITH NO DATA */
3148  RangeVar *relation; /* relation to insert into */
3150 
3151 /* ----------------------
3152  * Checkpoint Statement
3153  * ----------------------
3154  */
3155 typedef struct CheckPointStmt
3156 {
3158 } CheckPointStmt;
3159 
3160 /* ----------------------
3161  * Discard Statement
3162  * ----------------------
3163  */
3164 
3165 typedef enum DiscardMode
3166 {
3171 } DiscardMode;
3172 
3173 typedef struct DiscardStmt
3174 {
3177 } DiscardStmt;
3178 
3179 /* ----------------------
3180  * LOCK Statement
3181  * ----------------------
3182  */
3183 typedef struct LockStmt
3184 {
3186  List *relations; /* relations to lock */
3187  int mode; /* lock mode */
3188  bool nowait; /* no wait mode */
3189 } LockStmt;
3190 
3191 /* ----------------------
3192  * SET CONSTRAINTS Statement
3193  * ----------------------
3194  */
3195 typedef struct ConstraintsSetStmt
3196 {
3198  List *constraints; /* List of names as RangeVars */
3199  bool deferred;
3201 
3202 /* ----------------------
3203  * REINDEX Statement
3204  * ----------------------
3205  */
3206 
3207 /* Reindex options */
3208 #define REINDEXOPT_VERBOSE 1 << 0 /* print progress info */
3209 
3210 typedef enum ReindexObjectType
3211 {
3213  REINDEX_OBJECT_TABLE, /* table or materialized view */
3215  REINDEX_OBJECT_SYSTEM, /* system catalogs */
3218 
3219 typedef struct ReindexStmt
3220 {
3222  ReindexObjectType kind; /* REINDEX_OBJECT_INDEX, REINDEX_OBJECT_TABLE,
3223  * etc. */
3224  RangeVar *relation; /* Table or index to reindex */
3225  const char *name; /* name of database to reindex */
3226  int options; /* Reindex options flags */
3227 } ReindexStmt;
3228 
3229 /* ----------------------
3230  * CREATE CONVERSION Statement
3231  * ----------------------
3232  */
3233 typedef struct CreateConversionStmt
3234 {
3236  List *conversion_name; /* Name of the conversion */
3237  char *for_encoding_name; /* source encoding name */
3238  char *to_encoding_name; /* destination encoding name */
3239  List *func_name; /* qualified conversion function name */
3240  bool def; /* is this a default conversion? */
3242 
3243 /* ----------------------
3244  * CREATE CAST Statement
3245  * ----------------------
3246  */
3247 typedef struct CreateCastStmt
3248 {
3254  bool inout;
3255 } CreateCastStmt;
3256 
3257 /* ----------------------
3258  * CREATE TRANSFORM Statement
3259  * ----------------------
3260  */
3261 typedef struct CreateTransformStmt
3262 {
3264  bool replace;
3266  char *lang;
3270 
3271 /* ----------------------
3272  * PREPARE Statement
3273  * ----------------------
3274  */
3275 typedef struct PrepareStmt
3276 {
3278  char *name; /* Name of plan, arbitrary */
3279  List *argtypes; /* Types of parameters (List of TypeName) */
3280  Node *query; /* The query itself (as a raw parsetree) */
3281 } PrepareStmt;
3282 
3283 
3284 /* ----------------------
3285  * EXECUTE Statement
3286  * ----------------------
3287  */
3288 
3289 typedef struct ExecuteStmt
3290 {
3292  char *name; /* The name of the plan to execute */
3293  List *params; /* Values to assign to parameters */
3294 } ExecuteStmt;
3295 
3296 
3297 /* ----------------------
3298  * DEALLOCATE Statement
3299  * ----------------------
3300  */
3301 typedef struct DeallocateStmt
3302 {
3304  char *name; /* The name of the plan to remove */
3305  /* NULL means DEALLOCATE ALL */
3306 } DeallocateStmt;
3307 
3308 /*
3309  * DROP OWNED statement
3310  */
3311 typedef struct DropOwnedStmt
3312 {
3316 } DropOwnedStmt;
3317 
3318 /*
3319  * REASSIGN OWNED statement
3320  */
3321 typedef struct ReassignOwnedStmt
3322 {
3327 
3328 /*
3329  * TS Dictionary stmts: DefineStmt, RenameStmt and DropStmt are default
3330  */
3332 {
3334  List *dictname; /* qualified name (list of Value strings) */
3335  List *options; /* List of DefElem nodes */
3337 
3338 /*
3339  * TS Configuration stmts: DefineStmt, RenameStmt and DropStmt are default
3340  */
3341 typedef enum AlterTSConfigType
3342 {
3349 
3351 {
3353  AlterTSConfigType kind; /* ALTER_TSCONFIG_ADD_MAPPING, etc */
3354  List *cfgname; /* qualified name (list of Value strings) */
3355 
3356  /*
3357  * dicts will be non-NIL if ADD/ALTER MAPPING was specified. If dicts is
3358  * NIL, but tokentype isn't, DROP MAPPING was specified.
3359  */
3360  List *tokentype; /* list of Value strings */
3361  List *dicts; /* list of list of Value strings */
3362  bool override; /* if true - remove old variant */
3363  bool replace; /* if true - replace dictionary by another */
3364  bool missing_ok; /* for DROP - skip error if missing? */
3366 
3367 
3369 {
3371  char *pubname; /* Name of of the publication */
3372  List *options; /* List of DefElem nodes */
3373  List *tables; /* Optional list of tables to add */
3374  bool for_all_tables; /* Special publication for all tables in db */
3376 
3377 typedef struct AlterPublicationStmt
3378 {
3380  char *pubname; /* Name of of the publication */
3381 
3382  /* parameters used for ALTER PUBLICATION ... WITH */
3383  List *options; /* List of DefElem nodes */
3384 
3385  /* parameters used for ALTER PUBLICATION ... ADD/DROP TABLE */
3386  List *tables; /* List of tables to add/drop */
3387  bool for_all_tables; /* Special publication for all tables in db */
3388  DefElemAction tableAction; /* What action to perform with the tables */
3390 
3392 {
3394  char *subname; /* Name of of the subscription */
3395  char *conninfo; /* Connection string to publisher */
3396  List *publication; /* One or more publication to subscribe to */
3397  List *options; /* List of DefElem nodes */
3399 
3401 {
3408 
3410 {
3412  AlterSubscriptionType kind; /* ALTER_SUBSCRIPTION_OPTIONS, etc */
3413  char *subname; /* Name of of the subscription */
3414  char *conninfo; /* Connection string to publisher */
3415  List *publication; /* One or more publication to subscribe to */
3416  List *options; /* List of DefElem nodes */
3418 
3419 typedef struct DropSubscriptionStmt
3420 {
3422  char *subname; /* Name of of the subscription */
3423  bool missing_ok; /* Skip error if missing? */
3424  DropBehavior behavior; /* RESTRICT or CASCADE behavior */
3426 
3427 #endif /* PARSENODES_H */
struct CreateFdwStmt CreateFdwStmt
bool deferrable
Definition: parsenodes.h:2705
RangeVar * relation
Definition: parsenodes.h:1995
ObjectType objtype
Definition: parsenodes.h:2596
bool replace
Definition: parsenodes.h:2996
List * lockedRels
Definition: parsenodes.h:737
RoleSpec * newowner
Definition: parsenodes.h:2842
struct FetchStmt FetchStmt
signed short int16
Definition: c.h:255
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:1276
NodeTag type
Definition: parsenodes.h:2880
struct SelectStmt * larg
Definition: parsenodes.h:1540
bool primary
Definition: parsenodes.h:2703
bool copiedOrder
Definition: parsenodes.h:1283
OnCommitAction oncommit
Definition: parsenodes.h:2004
TypeName * sourcetype
Definition: parsenodes.h:3250
ConstrType
Definition: parsenodes.h:2040
RoleSpec * role
Definition: parsenodes.h:2434
NodeTag type
Definition: parsenodes.h:3313
List * fromClause
Definition: parsenodes.h:1472
struct DropTableSpaceStmt DropTableSpaceStmt
struct ViewStmt ViewStmt
List * inhRelations
Definition: parsenodes.h:1997
NodeTag type
Definition: parsenodes.h:3221
uint32 queryId
Definition: parsenodes.h:114
bool nowait
Definition: parsenodes.h:3188
struct CreateSchemaStmt CreateSchemaStmt
Alias * alias
Definition: parsenodes.h:560
Oid typeOid
Definition: parsenodes.h:209
ObjectType objtype
Definition: parsenodes.h:2608
List * keys
Definition: parsenodes.h:2088
GrantObjectType
Definition: parsenodes.h:1831
struct CreateForeignTableStmt CreateForeignTableStmt
NodeTag type
Definition: parsenodes.h:2583
NodeTag type
Definition: parsenodes.h:2992
List * exclusions
Definition: parsenodes.h:2091
struct TableLikeClause TableLikeClause
ObjectWithArgs * tosql
Definition: parsenodes.h:3268
List * joinaliasvars
Definition: parsenodes.h:988
Node * val
Definition: parsenodes.h:441
SortByDir ordering
Definition: parsenodes.h:693
Node * subquery
Definition: parsenodes.h:535
NodeTag type
Definition: parsenodes.h:2775
int stmt_location
Definition: parsenodes.h:179
Node * object
Definition: parsenodes.h:2609
char generated_when
Definition: parsenodes.h:2085
NodeTag type
Definition: parsenodes.h:2569
List * sortClause
Definition: parsenodes.h:156
struct CreateExtensionStmt CreateExtensionStmt
List * old_conpfeqop
Definition: parsenodes.h:2108
struct WindowDef WindowDef
struct FuncCall FuncCall
FetchDirection
Definition: parsenodes.h:2656
List * content
Definition: parsenodes.h:1254
List * names
Definition: parsenodes.h:208
IntoClause * intoClause
Definition: parsenodes.h:1507
A_Expr_Kind kind
Definition: parsenodes.h:274
struct DeclareCursorStmt DeclareCursorStmt
List * options
Definition: parsenodes.h:2696
struct CopyStmt CopyStmt
char storage
Definition: parsenodes.h:646
DropBehavior behavior
Definition: parsenodes.h:1815
VariableSetKind kind
Definition: parsenodes.h:1965
List * attlist
Definition: parsenodes.h:1937
struct VacuumStmt VacuumStmt
List * fromClause
Definition: parsenodes.h:1509
char * subname
Definition: parsenodes.h:2798
SortByDir sortby_dir
Definition: parsenodes.h:469
NodeTag type
Definition: parsenodes.h:3111
Alias * alias
Definition: parsenodes.h:1042
List * partParams
Definition: parsenodes.h:781
NodeTag type
Definition: parsenodes.h:2970
NodeTag type
Definition: parsenodes.h:467
bool is_local
Definition: parsenodes.h:642
ObjectType renameType
Definition: parsenodes.h:2794
struct AlterDomainStmt AlterDomainStmt
struct CreateCastStmt CreateCastStmt
RangeVar * relation
Definition: parsenodes.h:1455
FromExpr * jointree
Definition: parsenodes.h:136
TransactionStmtKind
Definition: parsenodes.h:2909
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:2535
struct A_Indices A_Indices
struct AlterExtensionContentsStmt AlterExtensionContentsStmt
struct AlterObjectSchemaStmt AlterObjectSchemaStmt
RoleStmtType
Definition: parsenodes.h:2416
char identity
Definition: parsenodes.h:649
PartitionRangeDatumKind
Definition: parsenodes.h:816
struct ColumnDef ColumnDef
struct VariableShowStmt VariableShowStmt
char * tableSpace
Definition: parsenodes.h:2694
NodeTag type
Definition: parsenodes.h:839
struct PartitionSpec PartitionSpec
Node * limitOffset
Definition: parsenodes.h:1530
List * constraintDeps
Definition: parsenodes.h:166
struct WithCheckOption WithCheckOption
struct CompositeTypeStmt CompositeTypeStmt
char fk_matchtype
Definition: parsenodes.h:2105
List * constraints
Definition: parsenodes.h:652
Node * whenClause
Definition: parsenodes.h:2356
List * securityQuals
Definition: parsenodes.h:1052
List * withCheckOptions
Definition: parsenodes.h:169
RoleStmtType stmt_type
Definition: parsenodes.h:2426
Node * agg_filter
Definition: parsenodes.h:352
struct DropUserMappingStmt DropUserMappingStmt
Node * raw_expr
Definition: parsenodes.h:2083
struct CreateRoleStmt CreateRoleStmt
struct A_Indirection A_Indirection
struct RoleSpec RoleSpec
List * objects
Definition: parsenodes.h:2570
bool missing_ok
Definition: parsenodes.h:2573
struct DeallocateStmt DeallocateStmt
struct InferClause InferClause
struct GrantRoleStmt GrantRoleStmt
bool if_not_exists
Definition: parsenodes.h:2466
struct TypeName TypeName
List * coltypmods
Definition: parsenodes.h:1030
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:2839
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:1331
RangeVar * typevar
Definition: parsenodes.h:2938
char * defnamespace
Definition: parsenodes.h:718
struct CreateStmt CreateStmt
Index tleSortGroupRef
Definition: parsenodes.h:1184
QuerySource
Definition: parsenodes.h:38
PartitionRangeDatumKind kind
Definition: parsenodes.h:827
Node * whereClause
Definition: parsenodes.h:2697
AlterTSConfigType
Definition: parsenodes.h:3341
char * provider
Definition: parsenodes.h:2610
bool grant_option
Definition: parsenodes.h:1859
List * groupingSets
Definition: parsenodes.h:148
DefElemAction defaction
Definition: parsenodes.h:721
NodeTag type
Definition: parsenodes.h:233
Definition: nodes.h:509
struct AlterCollationStmt AlterCollationStmt
struct RangeTableSample RangeTableSample
NodeTag type
Definition: parsenodes.h:2891
struct RenameStmt RenameStmt
NodeTag type
Definition: parsenodes.h:3095
bool initdeferred
Definition: parsenodes.h:2078
char * filename
Definition: parsenodes.h:3008
AlterTableType subtype
Definition: parsenodes.h:1772
List * actions
Definition: parsenodes.h:2870
List * granted_roles
Definition: parsenodes.h:1904
char * comment
Definition: parsenodes.h:2598
List * targetList
Definition: parsenodes.h:1470
List * options
Definition: parsenodes.h:3113
RoleSpec * role
Definition: parsenodes.h:2442
AclMode requiredPerms
Definition: parsenodes.h:1047
List * roles
Definition: parsenodes.h:2450
List * pk_attrs
Definition: parsenodes.h:2104
List * cols
Definition: parsenodes.h:1889
TypeName * typeName
Definition: parsenodes.h:750
char * conname
Definition: parsenodes.h:2076
struct AlterOpFamilyStmt AlterOpFamilyStmt
bool is_not_null
Definition: parsenodes.h:643
NodeTag type
Definition: parsenodes.h:1252
struct DropStmt DropStmt
Node * object
Definition: parsenodes.h:2597
NodeTag type
Definition: parsenodes.h:1274
bool funcordinality
Definition: parsenodes.h:999
NodeTag type
Definition: parsenodes.h:3007
int location
Definition: parsenodes.h:358
char * newname
Definition: parsenodes.h:2800
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:1940
struct CreateDomainStmt CreateDomainStmt
struct TransactionStmt TransactionStmt
struct PrepareStmt PrepareStmt
ReindexObjectType
Definition: parsenodes.h:3210
struct LockingClause LockingClause
List * colcollations
Definition: parsenodes.h:1031
CoercionContext
Definition: primnodes.h:420
WithClause * withClause
Definition: parsenodes.h:1444
struct RangeFunction RangeFunction
RangeVar * relation
Definition: parsenodes.h:3148
List * agg_order
Definition: parsenodes.h:351
List * values_lists
Definition: parsenodes.h:1009
ObjectType removeType
Definition: parsenodes.h:2571
bool instead
Definition: parsenodes.h:2869
OnCommitAction
Definition: primnodes.h:47
LockClauseStrength strength
Definition: parsenodes.h:1302
bool hasDistinctOn
Definition: parsenodes.h:127
RangeVar * table
Definition: parsenodes.h:2321
Node * whereClause
Definition: parsenodes.h:1471
List * options
Definition: parsenodes.h:2473
RangeVar * view
Definition: parsenodes.h:2993
signed int int32
Definition: c.h:256
OnConflictClause * onConflictClause
Definition: parsenodes.h:1442
struct TruncateStmt TruncateStmt
struct CreatePLangStmt CreatePLangStmt
List * options
Definition: parsenodes.h:2094
List * windowClause
Definition: parsenodes.h:152
DropBehavior behavior
Definition: parsenodes.h:3424
JoinType
Definition: nodes.h:673
List * targetList
Definition: parsenodes.h:138
RoleSpec * newowner
Definition: parsenodes.h:1775
NodeTag type
Definition: parsenodes.h:2072
int location
Definition: parsenodes.h:299
VariableSetStmt * setstmt
Definition: parsenodes.h:3037
bool hasRecursive
Definition: parsenodes.h:128
int location
Definition: parsenodes.h:235
NodeTag type
Definition: parsenodes.h:1438
struct ParamRef ParamRef
int location
Definition: parsenodes.h:442
NodeTag type
Definition: parsenodes.h:2201
struct CreateEventTrigStmt CreateEventTrigStmt
GroupingSetKind kind
Definition: parsenodes.h:1253
struct SelectStmt SelectStmt
struct LockStmt LockStmt
List * constraints
Definition: parsenodes.h:2002
AlterSubscriptionType
Definition: parsenodes.h:3400
bool if_not_exists
Definition: parsenodes.h:2006
struct A_Expr A_Expr
struct ListenStmt ListenStmt
PartitionBoundSpec * partbound
Definition: parsenodes.h:1999
Node * cooked_default
Definition: parsenodes.h:648
struct AlterEventTrigStmt AlterEventTrigStmt
NodeTag type
Definition: parsenodes.h:1903
WithClause * withClause
Definition: parsenodes.h:1459
struct RuleStmt RuleStmt
RangeVar * constrrel
Definition: parsenodes.h:2363
Node * query
Definition: parsenodes.h:3112
NodeTag type
Definition: parsenodes.h:3291
Oid indexOid
Definition: parsenodes.h:2700
struct ClusterStmt ClusterStmt
Node * expr
Definition: parsenodes.h:689
char * newValNeighbor
Definition: parsenodes.h:2974
struct DropOwnedStmt DropOwnedStmt
uint32 AclMode
Definition: parsenodes.h:70
struct CreatedbStmt CreatedbStmt
RangeVar * relation
Definition: parsenodes.h:2692
DropBehavior behavior
Definition: parsenodes.h:2586
struct ColumnRef ColumnRef
bool is_slice
Definition: parsenodes.h:381
List * distinctClause
Definition: parsenodes.h:1505
Bitmapset * selectedCols
Definition: parsenodes.h:1049
RoleSpec * authrole
Definition: parsenodes.h:1667
List * returningList
Definition: parsenodes.h:1458
Node * startOffset
Definition: parsenodes.h:491
char * indexname
Definition: parsenodes.h:3069
NodeTag type
Definition: parsenodes.h:2333
NodeTag type
Definition: parsenodes.h:307
struct AlterTSConfigurationStmt AlterTSConfigurationStmt
SetOperation
Definition: parsenodes.h:1490
AlterTableType
Definition: parsenodes.h:1691
List * options
Definition: parsenodes.h:2196
List * rtable
Definition: parsenodes.h:135
NodeTag type
Definition: parsenodes.h:2690
struct AlterEnumStmt AlterEnumStmt
CollateClause * collClause
Definition: parsenodes.h:2502
List * distinctClause
Definition: parsenodes.h:154
struct CreateTableSpaceStmt CreateTableSpaceStmt
bool missing_ok
Definition: parsenodes.h:2802
List * args
Definition: parsenodes.h:2488
SortByNulls nulls_ordering
Definition: parsenodes.h:694
struct OnConflictClause OnConflictClause
char * policy_name
Definition: parsenodes.h:2320
List * aliases
Definition: parsenodes.h:2994
struct FunctionParameter FunctionParameter
struct UpdateStmt UpdateStmt
bool concurrent
Definition: parsenodes.h:2574
struct WindowDef * over
Definition: parsenodes.h:357
NodeTag type
Definition: parsenodes.h:1300
struct CreateFunctionStmt CreateFunctionStmt
TableFunc * tablefunc
Definition: parsenodes.h:1004
List * partitionClause
Definition: parsenodes.h:1277
struct A_ArrayExpr A_ArrayExpr
struct TriggerTransition TriggerTransition
List * coldeflist
Definition: parsenodes.h:561
Node * selectStmt
Definition: parsenodes.h:1441
bool deferrable
Definition: parsenodes.h:2077
int location
Definition: parsenodes.h:493
struct CreateTransformStmt CreateTransformStmt
char * label
Definition: parsenodes.h:2611
char * amname
Definition: parsenodes.h:2334
RangeVar * relation
Definition: parsenodes.h:1934
struct Query Query
struct CreateForeignServerStmt CreateForeignServerStmt
bool setof
Definition: parsenodes.h:210
GrantTargetType
Definition: parsenodes.h:1824
struct AlterFdwStmt AlterFdwStmt
struct A_Star A_Star
RangeVar * relation
Definition: parsenodes.h:3224
Node * endOffset
Definition: parsenodes.h:492
List * cols
Definition: parsenodes.h:1440
NodeTag type
Definition: parsenodes.h:1500
struct IndexStmt IndexStmt
RTEKind
Definition: parsenodes.h:928
List * relations
Definition: parsenodes.h:2584
List * typeName
Definition: parsenodes.h:2971
VariableSetStmt * setstmt
Definition: parsenodes.h:3058
NodeTag type
Definition: parsenodes.h:326
struct TypeCast TypeCast
char * dbname
Definition: parsenodes.h:3018
NodeTag type
Definition: parsenodes.h:1771
NodeTag type
Definition: parsenodes.h:2433
TableLikeOption
Definition: parsenodes.h:667
TypeName * datatype
Definition: parsenodes.h:2516
struct ImportForeignSchemaStmt ImportForeignSchemaStmt
FunctionParameterMode
Definition: parsenodes.h:2741