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