1 /*-------------------------------------------------------------------------
4 * Definitions for tagged nodes.
7 * Portions Copyright (c) 1996-2011, PostgreSQL Global Development Group
8 * Portions Copyright (c) 1994, Regents of the University of California
10 * src/include/nodes/nodes.h
12 *-------------------------------------------------------------------------
18 * The first field of every node is NodeTag. Each node created (with makeNode)
19 * will have one of the following tags as the value of its first field.
21 * Note that the numbers of the node tags are not contiguous. We left holes
22 * here so that we can add more tags without changing the existing enum's.
23 * (Since node tag numbers never exist outside backend memory, there's no
24 * real harm in renumbering, it just costs a full rebuild ...)
31 * TAGS FOR EXECUTOR NODES (execnodes.h)
42 * TAGS FOR PLAN NODES (plannodes.h)
77 /* these aren't subclasses of Plan: */
83 * TAGS FOR PLAN STATE NODES (execnodes.h)
85 * These should correspond one-to-one with Plan node types.
92 T_RecursiveUnionState,
98 T_BitmapIndexScanState,
99 T_BitmapHeapScanState,
105 T_WorkTableScanState,
122 * TAGS FOR PRIMITIVE NODES (primnodes.h)
141 T_AlternativeSubPlan,
147 T_ConvertRowtypeExpr,
161 T_CoerceToDomainValue,
171 * TAGS FOR EXPRESSION STATE NODES (execnodes.h)
173 * These correspond (not always one-for-one) to primitive nodes derived
179 T_WindowFuncExprState,
182 T_ScalarArrayOpExprState,
185 T_AlternativeSubPlanState,
189 T_ArrayCoerceExprState,
190 T_ConvertRowtypeExprState,
195 T_RowCompareExprState,
200 T_CoerceToDomainState,
201 T_DomainConstraintState,
204 * TAGS FOR PLANNER NODES (relation.h)
228 T_InnerIndexscanInfo,
237 * TAGS FOR MEMORY NODES (memnodes.h)
239 T_MemoryContext = 600,
243 * TAGS FOR VALUE NODES (value.h)
253 * TAGS FOR LIST NODES (pg_list.h)
260 * TAGS FOR STATEMENT NODES (mostly in parsenodes.h)
274 T_AlterDefaultPrivilegesStmt,
285 T_CreateFunctionStmt,
315 T_ConstraintsSetStmt,
320 T_AlterDatabaseSetStmt,
322 T_CreateConversionStmt,
326 T_CreateOpFamilyStmt,
329 T_RemoveOpFamilyStmt,
334 T_CreateTableSpaceStmt,
335 T_DropTableSpaceStmt,
336 T_AlterObjectSchemaStmt,
343 T_AlterTSDictionaryStmt,
344 T_AlterTSConfigurationStmt,
348 T_CreateForeignServerStmt,
349 T_AlterForeignServerStmt,
350 T_DropForeignServerStmt,
351 T_CreateUserMappingStmt,
352 T_AlterUserMappingStmt,
353 T_DropUserMappingStmt,
354 T_AlterTableSpaceOptionsStmt,
358 * TAGS FOR PARSE TREE NODES (parsenodes.h)
396 * TAGS FOR RANDOM OTHER STUFF
398 * These are objects that aren't part of parse/plan/execute node tree
399 * structures, but we give them NodeTags anyway for identification
400 * purposes (usually because they are involved in APIs where we want to
401 * pass multiple object types through the same pointer).
403 T_TriggerData = 950, /* in commands/trigger.h */
404 T_ReturnSetInfo, /* in nodes/execnodes.h */
405 T_WindowObjectData, /* private in nodeWindowAgg.c */
406 T_TIDBitmap, /* in nodes/tidbitmap.h */
407 T_InlineCodeBlock /* in nodes/parsenodes.h */
411 * The first field of a node of any type is guaranteed to be the NodeTag.
412 * Hence the type of any node can be gotten by casting it to Node. Declaring
413 * a variable to be of Node * (instead of void *) can also facilitate
421 #define nodeTag(nodeptr) (((Node*)(nodeptr))->type)
425 * create a new node of the specified size and tag the node with the
428 * !WARNING!: Avoid using newNode directly. You should be using the
429 * macro makeNode. eg. to create a Query node, use makeNode(Query)
431 * Note: the size argument should always be a compile-time constant, so the
432 * apparent risk of multiple evaluation doesn't matter in practice.
436 /* With GCC, we can use a compound statement within an expression */
437 #define newNode(size, tag) \
439 AssertMacro((size) >= sizeof(Node)); /* need the tag, at least */ \
440 _result = (Node *) palloc0fast(size); \
441 _result->type = (tag); \
447 * There is no way to dereference the palloc'ed pointer to assign the
448 * tag, and also return the pointer itself, so we need a holder variable.
449 * Fortunately, this macro isn't recursive so we just define
450 * a global variable for this purpose.
452 extern PGDLLIMPORT Node *newNodeMacroHolder;
454 #define newNode(size, tag) \
456 AssertMacro((size) >= sizeof(Node)), /* need the tag, at least */ \
457 newNodeMacroHolder = (Node *) palloc0fast(size), \
458 newNodeMacroHolder->type = (tag), \
461 #endif /* __GNUC__ */
464 #define makeNode(_type_) ((_type_ *) newNode(sizeof(_type_),T_##_type_))
465 #define NodeSetTag(nodeptr,t) (((Node*)(nodeptr))->type = (t))
467 #define IsA(nodeptr,_type_) (nodeTag(nodeptr) == T_##_type_)
469 /* ----------------------------------------------------------------
470 * extern declarations follow
471 * ----------------------------------------------------------------
475 * nodes/{outfuncs.c,print.c}
477 extern char *nodeToString(void *obj);
480 * nodes/{readfuncs.c,read.c}
482 extern void *stringToNode(char *str);
487 extern void *copyObject(void *obj);
492 extern bool equal(void *a, void *b);
496 * Typedefs for identifying qualifier selectivities and plan costs as such.
497 * These are just plain "double"s, but declaring a variable as Selectivity
498 * or Cost makes the intent more obvious.
500 * These could have gone into plannodes.h or some such, but many files
503 typedef double Selectivity; /* fraction of tuples a qualifier will pass */
504 typedef double Cost; /* execution cost (in page-access units) */
509 * enums for type of operation represented by a Query or PlannedStmt
511 * This is needed in both parsenodes.h and plannodes.h, so put it here...
516 CMD_SELECT, /* select stmt */
517 CMD_UPDATE, /* update stmt */
518 CMD_INSERT, /* insert stmt */
520 CMD_UTILITY, /* cmds like create, destroy, copy, vacuum,
522 CMD_NOTHING /* dummy command for instead nothing rules
529 * enums for types of relation joins
531 * JoinType determines the exact semantics of joining two relations using
532 * a matching qualification. For example, it tells what to do with a tuple
533 * that has no match in the other relation.
535 * This is needed in both parsenodes.h and plannodes.h, so put it here...
537 typedef enum JoinType
540 * The canonical kinds of joins according to the SQL JOIN syntax. Only
541 * these codes can appear in parser output (e.g., JoinExpr nodes).
543 JOIN_INNER, /* matching tuple pairs only */
544 JOIN_LEFT, /* pairs + unmatched LHS tuples */
545 JOIN_FULL, /* pairs + unmatched LHS + unmatched RHS */
546 JOIN_RIGHT, /* pairs + unmatched RHS tuples */
549 * Semijoins and anti-semijoins (as defined in relational theory) do not
550 * appear in the SQL JOIN syntax, but there are standard idioms for
551 * representing them (e.g., using EXISTS). The planner recognizes these
552 * cases and converts them to joins. So the planner and executor must
553 * support these codes. NOTE: in JOIN_SEMI output, it is unspecified
554 * which matching RHS row is joined to. In JOIN_ANTI output, the row is
555 * guaranteed to be null-extended.
557 JOIN_SEMI, /* 1 copy of each LHS row that has match(es) */
558 JOIN_ANTI, /* 1 copy of each LHS row that has no match */
561 * These codes are used internally in the planner, but are not supported
562 * by the executor (nor, indeed, by most of the planner).
564 JOIN_UNIQUE_OUTER, /* LHS path must be made unique */
565 JOIN_UNIQUE_INNER /* RHS path must be made unique */
568 * We might need additional join types someday.
573 * OUTER joins are those for which pushed-down quals must behave differently
574 * from the join's own quals. This is in fact everything except INNER and
575 * SEMI joins. However, this macro must also exclude the JOIN_UNIQUE symbols
576 * since those are temporary proxies for what will eventually be an INNER
579 * Note: semijoins are a hybrid case, but we choose to treat them as not
580 * being outer joins. This is okay principally because the SQL syntax makes
581 * it impossible to have a pushed-down qual that refers to the inner relation
582 * of a semijoin; so there is no strong need to distinguish join quals from
583 * pushed-down quals. This is convenient because for almost all purposes,
584 * quals attached to a semijoin can be treated the same as innerjoin quals.
586 #define IS_OUTER_JOIN(jointype) \
587 (((1 << (jointype)) & \
588 ((1 << JOIN_LEFT) | \
590 (1 << JOIN_RIGHT) | \
591 (1 << JOIN_ANTI))) != 0)