PostgreSQL Source Code  git master
Data Structures | Macros | Typedefs | Enumerations
primnodes.h File Reference
#include "access/attnum.h"
#include "nodes/bitmapset.h"
#include "nodes/pg_list.h"
Include dependency graph for primnodes.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  Alias
 
struct  RangeVar
 
struct  TableFunc
 
struct  IntoClause
 
struct  Expr
 
struct  Var
 
struct  Const
 
struct  Param
 
struct  Aggref
 
struct  GroupingFunc
 
struct  WindowFunc
 
struct  SubscriptingRef
 
struct  FuncExpr
 
struct  NamedArgExpr
 
struct  OpExpr
 
struct  ScalarArrayOpExpr
 
struct  BoolExpr
 
struct  SubLink
 
struct  SubPlan
 
struct  AlternativeSubPlan
 
struct  FieldSelect
 
struct  FieldStore
 
struct  RelabelType
 
struct  CoerceViaIO
 
struct  ArrayCoerceExpr
 
struct  ConvertRowtypeExpr
 
struct  CollateExpr
 
struct  CaseExpr
 
struct  CaseWhen
 
struct  CaseTestExpr
 
struct  ArrayExpr
 
struct  RowExpr
 
struct  RowCompareExpr
 
struct  CoalesceExpr
 
struct  MinMaxExpr
 
struct  SQLValueFunction
 
struct  XmlExpr
 
struct  NullTest
 
struct  BooleanTest
 
struct  CoerceToDomain
 
struct  CoerceToDomainValue
 
struct  SetToDefault
 
struct  CurrentOfExpr
 
struct  NextValueExpr
 
struct  InferenceElem
 
struct  TargetEntry
 
struct  RangeTblRef
 
struct  JoinExpr
 
struct  FromExpr
 
struct  OnConflictExpr
 

Macros

#define INNER_VAR   65000 /* reference to inner subplan */
 
#define OUTER_VAR   65001 /* reference to outer subplan */
 
#define INDEX_VAR   65002 /* reference to index column */
 
#define IS_SPECIAL_VARNO(varno)   ((varno) >= INNER_VAR)
 
#define PRS2_OLD_VARNO   1
 
#define PRS2_NEW_VARNO   2
 

Typedefs

typedef struct Alias Alias
 
typedef enum OnCommitAction OnCommitAction
 
typedef struct RangeVar RangeVar
 
typedef struct TableFunc TableFunc
 
typedef struct IntoClause IntoClause
 
typedef struct Expr Expr
 
typedef struct Var Var
 
typedef struct Const Const
 
typedef enum ParamKind ParamKind
 
typedef struct Param Param
 
typedef struct Aggref Aggref
 
typedef struct GroupingFunc GroupingFunc
 
typedef struct WindowFunc WindowFunc
 
typedef struct SubscriptingRef SubscriptingRef
 
typedef enum CoercionContext CoercionContext
 
typedef enum CoercionForm CoercionForm
 
typedef struct FuncExpr FuncExpr
 
typedef struct NamedArgExpr NamedArgExpr
 
typedef struct OpExpr OpExpr
 
typedef OpExpr DistinctExpr
 
typedef OpExpr NullIfExpr
 
typedef struct ScalarArrayOpExpr ScalarArrayOpExpr
 
typedef enum BoolExprType BoolExprType
 
typedef struct BoolExpr BoolExpr
 
typedef enum SubLinkType SubLinkType
 
typedef struct SubLink SubLink
 
typedef struct SubPlan SubPlan
 
typedef struct AlternativeSubPlan AlternativeSubPlan
 
typedef struct FieldSelect FieldSelect
 
typedef struct FieldStore FieldStore
 
typedef struct RelabelType RelabelType
 
typedef struct CoerceViaIO CoerceViaIO
 
typedef struct ArrayCoerceExpr ArrayCoerceExpr
 
typedef struct ConvertRowtypeExpr ConvertRowtypeExpr
 
typedef struct CollateExpr CollateExpr
 
typedef struct CaseExpr CaseExpr
 
typedef struct CaseWhen CaseWhen
 
typedef struct CaseTestExpr CaseTestExpr
 
typedef struct ArrayExpr ArrayExpr
 
typedef struct RowExpr RowExpr
 
typedef enum RowCompareType RowCompareType
 
typedef struct RowCompareExpr RowCompareExpr
 
typedef struct CoalesceExpr CoalesceExpr
 
typedef enum MinMaxOp MinMaxOp
 
typedef struct MinMaxExpr MinMaxExpr
 
typedef enum SQLValueFunctionOp SQLValueFunctionOp
 
typedef struct SQLValueFunction SQLValueFunction
 
typedef enum XmlExprOp XmlExprOp
 
typedef struct XmlExpr XmlExpr
 
typedef enum NullTestType NullTestType
 
typedef struct NullTest NullTest
 
typedef enum BoolTestType BoolTestType
 
typedef struct BooleanTest BooleanTest
 
typedef struct CoerceToDomain CoerceToDomain
 
typedef struct CoerceToDomainValue CoerceToDomainValue
 
typedef struct SetToDefault SetToDefault
 
typedef struct CurrentOfExpr CurrentOfExpr
 
typedef struct NextValueExpr NextValueExpr
 
typedef struct InferenceElem InferenceElem
 
typedef struct TargetEntry TargetEntry
 
typedef struct RangeTblRef RangeTblRef
 
typedef struct JoinExpr JoinExpr
 
typedef struct FromExpr FromExpr
 
typedef struct OnConflictExpr OnConflictExpr
 

Enumerations

enum  OnCommitAction { ONCOMMIT_NOOP, ONCOMMIT_PRESERVE_ROWS, ONCOMMIT_DELETE_ROWS, ONCOMMIT_DROP }
 
enum  ParamKind { PARAM_EXTERN, PARAM_EXEC, PARAM_SUBLINK, PARAM_MULTIEXPR }
 
enum  CoercionContext { COERCION_IMPLICIT, COERCION_ASSIGNMENT, COERCION_EXPLICIT }
 
enum  CoercionForm { COERCE_EXPLICIT_CALL, COERCE_EXPLICIT_CAST, COERCE_IMPLICIT_CAST }
 
enum  BoolExprType { AND_EXPR, OR_EXPR, NOT_EXPR }
 
enum  SubLinkType {
  EXISTS_SUBLINK, ALL_SUBLINK, ANY_SUBLINK, ROWCOMPARE_SUBLINK,
  EXPR_SUBLINK, MULTIEXPR_SUBLINK, ARRAY_SUBLINK, CTE_SUBLINK
}
 
enum  RowCompareType {
  ROWCOMPARE_LT = 1, ROWCOMPARE_LE = 2, ROWCOMPARE_EQ = 3, ROWCOMPARE_GE = 4,
  ROWCOMPARE_GT = 5, ROWCOMPARE_NE = 6
}
 
enum  MinMaxOp { IS_GREATEST, IS_LEAST }
 
enum  SQLValueFunctionOp {
  SVFOP_CURRENT_DATE, SVFOP_CURRENT_TIME, SVFOP_CURRENT_TIME_N, SVFOP_CURRENT_TIMESTAMP,
  SVFOP_CURRENT_TIMESTAMP_N, SVFOP_LOCALTIME, SVFOP_LOCALTIME_N, SVFOP_LOCALTIMESTAMP,
  SVFOP_LOCALTIMESTAMP_N, SVFOP_CURRENT_ROLE, SVFOP_CURRENT_USER, SVFOP_USER,
  SVFOP_SESSION_USER, SVFOP_CURRENT_CATALOG, SVFOP_CURRENT_SCHEMA
}
 
enum  XmlExprOp {
  IS_XMLCONCAT, IS_XMLELEMENT, IS_XMLFOREST, IS_XMLPARSE,
  IS_XMLPI, IS_XMLROOT, IS_XMLSERIALIZE, IS_DOCUMENT
}
 
enum  XmlOptionType { XMLOPTION_DOCUMENT, XMLOPTION_CONTENT }
 
enum  NullTestType { IS_NULL, IS_NOT_NULL }
 
enum  BoolTestType {
  IS_TRUE, IS_NOT_TRUE, IS_FALSE, IS_NOT_FALSE,
  IS_UNKNOWN, IS_NOT_UNKNOWN
}
 

Macro Definition Documentation

◆ INDEX_VAR

#define INDEX_VAR   65002 /* reference to index column */

Definition at line 159 of file primnodes.h.

Referenced by ExecIndexBuildScanKeys(), ExecInitCustomScan(), ExecInitForeignScan(), ExecInitIndexOnlyScan(), fix_indexqual_operand(), get_name_for_var_field(), print_expr(), resolve_special_varno(), set_customscan_references(), set_foreignscan_references(), and set_indexonlyscan_references().

◆ INNER_VAR

#define INNER_VAR   65000 /* reference to inner subplan */

Definition at line 157 of file primnodes.h.

Referenced by ExecBuildProjectionInfo(), ExecEvalWholeRowVar(), ExecInitExprRec(), ExecInitPartitionInfo(), fix_join_expr_mutator(), fix_scan_expr_mutator(), get_last_attnums_walker(), get_name_for_var_field(), print_expr(), resolve_special_varno(), and TriggerEnabled().

◆ IS_SPECIAL_VARNO

#define IS_SPECIAL_VARNO (   varno)    ((varno) >= INNER_VAR)

Definition at line 161 of file primnodes.h.

Referenced by add_rte_to_flat_rtable(), currtid_for_view(), deparseColumnRef(), and fix_scan_expr_mutator().

◆ OUTER_VAR

#define OUTER_VAR   65001 /* reference to outer subplan */

Definition at line 158 of file primnodes.h.

Referenced by exec_save_simple_expr(), ExecBuildProjectionInfo(), ExecEvalWholeRowVar(), ExecInitExprRec(), ExecInitGather(), ExecInitGatherMerge(), ExecNestLoop(), find_unaggregated_cols_walker(), fix_join_expr_mutator(), fix_scan_expr_mutator(), get_last_attnums_walker(), get_name_for_var_field(), print_expr(), resolve_special_varno(), set_dummy_tlist_references(), set_hash_references(), set_join_references(), set_upper_references(), and TriggerEnabled().

◆ PRS2_NEW_VARNO

#define PRS2_NEW_VARNO   2

Definition at line 165 of file primnodes.h.

Referenced by CloneRowTriggersToPartition(), CopyAndAddInvertedQual(), CreateTrigger(), DefineQueryRewrite(), getInsertSelectQuery(), rewriteRuleAction(), transformRuleStmt(), and TriggerEnabled().

◆ PRS2_OLD_VARNO

#define PRS2_OLD_VARNO   1

Definition at line 164 of file primnodes.h.

Referenced by ApplyRetrieveRule(), CloneRowTriggersToPartition(), CopyAndAddInvertedQual(), CreateTrigger(), DefineQueryRewrite(), getInsertSelectQuery(), rewriteRuleAction(), transformRuleStmt(), and TriggerEnabled().

Typedef Documentation

◆ Aggref

typedef struct Aggref Aggref

◆ Alias

typedef struct Alias Alias

◆ AlternativeSubPlan

typedef struct AlternativeSubPlan AlternativeSubPlan

◆ ArrayCoerceExpr

typedef struct ArrayCoerceExpr ArrayCoerceExpr

◆ ArrayExpr

typedef struct ArrayExpr ArrayExpr

◆ BooleanTest

typedef struct BooleanTest BooleanTest

◆ BoolExpr

typedef struct BoolExpr BoolExpr

◆ BoolExprType

typedef enum BoolExprType BoolExprType

◆ BoolTestType

typedef enum BoolTestType BoolTestType

◆ CaseExpr

typedef struct CaseExpr CaseExpr

◆ CaseTestExpr

typedef struct CaseTestExpr CaseTestExpr

◆ CaseWhen

typedef struct CaseWhen CaseWhen

◆ CoalesceExpr

typedef struct CoalesceExpr CoalesceExpr

◆ CoerceToDomain

typedef struct CoerceToDomain CoerceToDomain

◆ CoerceToDomainValue

typedef struct CoerceToDomainValue CoerceToDomainValue

◆ CoerceViaIO

typedef struct CoerceViaIO CoerceViaIO

◆ CoercionContext

typedef enum CoercionContext CoercionContext

◆ CoercionForm

typedef enum CoercionForm CoercionForm

◆ CollateExpr

typedef struct CollateExpr CollateExpr

◆ Const

typedef struct Const Const

◆ ConvertRowtypeExpr

typedef struct ConvertRowtypeExpr ConvertRowtypeExpr

◆ CurrentOfExpr

typedef struct CurrentOfExpr CurrentOfExpr

◆ DistinctExpr

typedef OpExpr DistinctExpr

Definition at line 522 of file primnodes.h.

◆ Expr

typedef struct Expr Expr

◆ FieldSelect

typedef struct FieldSelect FieldSelect

◆ FieldStore

typedef struct FieldStore FieldStore

◆ FromExpr

typedef struct FromExpr FromExpr

◆ FuncExpr

typedef struct FuncExpr FuncExpr

◆ GroupingFunc

typedef struct GroupingFunc GroupingFunc

◆ InferenceElem

typedef struct InferenceElem InferenceElem

◆ IntoClause

typedef struct IntoClause IntoClause

◆ JoinExpr

typedef struct JoinExpr JoinExpr

◆ MinMaxExpr

typedef struct MinMaxExpr MinMaxExpr

◆ MinMaxOp

typedef enum MinMaxOp MinMaxOp

◆ NamedArgExpr

typedef struct NamedArgExpr NamedArgExpr

◆ NextValueExpr

typedef struct NextValueExpr NextValueExpr

◆ NullIfExpr

typedef OpExpr NullIfExpr

Definition at line 530 of file primnodes.h.

◆ NullTest

typedef struct NullTest NullTest

◆ NullTestType

typedef enum NullTestType NullTestType

◆ OnCommitAction

typedef enum OnCommitAction OnCommitAction

◆ OnConflictExpr

typedef struct OnConflictExpr OnConflictExpr

◆ OpExpr

typedef struct OpExpr OpExpr

◆ Param

typedef struct Param Param

◆ ParamKind

typedef enum ParamKind ParamKind

◆ RangeTblRef

typedef struct RangeTblRef RangeTblRef

◆ RangeVar

typedef struct RangeVar RangeVar

◆ RelabelType

typedef struct RelabelType RelabelType

◆ RowCompareExpr

typedef struct RowCompareExpr RowCompareExpr

◆ RowCompareType

typedef enum RowCompareType RowCompareType

◆ RowExpr

typedef struct RowExpr RowExpr

◆ ScalarArrayOpExpr

typedef struct ScalarArrayOpExpr ScalarArrayOpExpr

◆ SetToDefault

typedef struct SetToDefault SetToDefault

◆ SQLValueFunction

typedef struct SQLValueFunction SQLValueFunction

◆ SQLValueFunctionOp

typedef enum SQLValueFunctionOp SQLValueFunctionOp

◆ SubLink

typedef struct SubLink SubLink

◆ SubLinkType

typedef enum SubLinkType SubLinkType

◆ SubPlan

typedef struct SubPlan SubPlan

◆ SubscriptingRef

typedef struct SubscriptingRef SubscriptingRef

◆ TableFunc

typedef struct TableFunc TableFunc

◆ TargetEntry

typedef struct TargetEntry TargetEntry

◆ Var

typedef struct Var Var

◆ WindowFunc

typedef struct WindowFunc WindowFunc

◆ XmlExpr

typedef struct XmlExpr XmlExpr

◆ XmlExprOp

typedef enum XmlExprOp XmlExprOp

Enumeration Type Documentation

◆ BoolExprType

enum BoolExprType
Enumerator
AND_EXPR 
OR_EXPR 
NOT_EXPR 

Definition at line 560 of file primnodes.h.

561 {
562  AND_EXPR, OR_EXPR, NOT_EXPR
563 } BoolExprType;
BoolExprType
BoolExprType
Definition: primnodes.h:560

◆ BoolTestType

enum BoolTestType
Enumerator
IS_TRUE 
IS_NOT_TRUE 
IS_FALSE 
IS_NOT_FALSE 
IS_UNKNOWN 
IS_NOT_UNKNOWN 

Definition at line 1220 of file primnodes.h.

1221 {
1222  IS_TRUE, IS_NOT_TRUE, IS_FALSE, IS_NOT_FALSE, IS_UNKNOWN, IS_NOT_UNKNOWN
1223 } BoolTestType;
BoolTestType
BoolTestType
Definition: primnodes.h:1220

◆ CoercionContext

enum CoercionContext
Enumerator
COERCION_IMPLICIT 
COERCION_ASSIGNMENT 
COERCION_EXPLICIT 

Definition at line 426 of file primnodes.h.

427 {
428  COERCION_IMPLICIT, /* coercion in context of expression */
429  COERCION_ASSIGNMENT, /* coercion in context of assignment */
430  COERCION_EXPLICIT /* explicit cast operation */
431 } CoercionContext;
CoercionContext
CoercionContext
Definition: primnodes.h:426

◆ CoercionForm

enum CoercionForm
Enumerator
COERCE_EXPLICIT_CALL 
COERCE_EXPLICIT_CAST 
COERCE_IMPLICIT_CAST 

Definition at line 442 of file primnodes.h.

443 {
444  COERCE_EXPLICIT_CALL, /* display as a function call */
445  COERCE_EXPLICIT_CAST, /* display as an explicit cast */
446  COERCE_IMPLICIT_CAST /* implicit cast, so hide it */
447 } CoercionForm;
CoercionForm
CoercionForm
Definition: primnodes.h:442

◆ MinMaxOp

enum MinMaxOp
Enumerator
IS_GREATEST 
IS_LEAST 

Definition at line 1079 of file primnodes.h.

1080 {
1081  IS_GREATEST,
1082  IS_LEAST
1083 } MinMaxOp;
MinMaxOp
MinMaxOp
Definition: primnodes.h:1079

◆ NullTestType

enum NullTestType
Enumerator
IS_NULL 
IS_NOT_NULL 

Definition at line 1197 of file primnodes.h.

1198 {
1199  IS_NULL, IS_NOT_NULL
1200 } NullTestType;
NullTestType
NullTestType
Definition: primnodes.h:1197

◆ OnCommitAction

enum OnCommitAction
Enumerator
ONCOMMIT_NOOP 
ONCOMMIT_PRESERVE_ROWS 
ONCOMMIT_DELETE_ROWS 
ONCOMMIT_DROP 

Definition at line 47 of file primnodes.h.

48 {
49  ONCOMMIT_NOOP, /* No ON COMMIT clause (do nothing) */
50  ONCOMMIT_PRESERVE_ROWS, /* ON COMMIT PRESERVE ROWS (do nothing) */
51  ONCOMMIT_DELETE_ROWS, /* ON COMMIT DELETE ROWS */
52  ONCOMMIT_DROP /* ON COMMIT DROP */
53 } OnCommitAction;
OnCommitAction
OnCommitAction
Definition: primnodes.h:47

◆ ParamKind

enum ParamKind
Enumerator
PARAM_EXTERN 
PARAM_EXEC 
PARAM_SUBLINK 
PARAM_MULTIEXPR 

Definition at line 237 of file primnodes.h.

238 {
239  PARAM_EXTERN,
240  PARAM_EXEC,
241  PARAM_SUBLINK,
242  PARAM_MULTIEXPR
243 } ParamKind;
ParamKind
ParamKind
Definition: primnodes.h:237

◆ RowCompareType

enum RowCompareType
Enumerator
ROWCOMPARE_LT 
ROWCOMPARE_LE 
ROWCOMPARE_EQ 
ROWCOMPARE_GE 
ROWCOMPARE_GT 
ROWCOMPARE_NE 

Definition at line 1042 of file primnodes.h.

1043 {
1044  /* Values of this enum are chosen to match btree strategy numbers */
1045  ROWCOMPARE_LT = 1, /* BTLessStrategyNumber */
1046  ROWCOMPARE_LE = 2, /* BTLessEqualStrategyNumber */
1047  ROWCOMPARE_EQ = 3, /* BTEqualStrategyNumber */
1048  ROWCOMPARE_GE = 4, /* BTGreaterEqualStrategyNumber */
1049  ROWCOMPARE_GT = 5, /* BTGreaterStrategyNumber */
1050  ROWCOMPARE_NE = 6 /* no such btree strategy */
1051 } RowCompareType;
RowCompareType
RowCompareType
Definition: primnodes.h:1042

◆ SQLValueFunctionOp

enum SQLValueFunctionOp
Enumerator
SVFOP_CURRENT_DATE 
SVFOP_CURRENT_TIME 
SVFOP_CURRENT_TIME_N 
SVFOP_CURRENT_TIMESTAMP 
SVFOP_CURRENT_TIMESTAMP_N 
SVFOP_LOCALTIME 
SVFOP_LOCALTIME_N 
SVFOP_LOCALTIMESTAMP 
SVFOP_LOCALTIMESTAMP_N 
SVFOP_CURRENT_ROLE 
SVFOP_CURRENT_USER 
SVFOP_USER 
SVFOP_SESSION_USER 
SVFOP_CURRENT_CATALOG 
SVFOP_CURRENT_SCHEMA 

Definition at line 1107 of file primnodes.h.

1108 {
1109  SVFOP_CURRENT_DATE,
1110  SVFOP_CURRENT_TIME,
1111  SVFOP_CURRENT_TIME_N,
1112  SVFOP_CURRENT_TIMESTAMP,
1113  SVFOP_CURRENT_TIMESTAMP_N,
1114  SVFOP_LOCALTIME,
1115  SVFOP_LOCALTIME_N,
1116  SVFOP_LOCALTIMESTAMP,
1117  SVFOP_LOCALTIMESTAMP_N,
1118  SVFOP_CURRENT_ROLE,
1119  SVFOP_CURRENT_USER,
1120  SVFOP_USER,
1121  SVFOP_SESSION_USER,
1122  SVFOP_CURRENT_CATALOG,
1123  SVFOP_CURRENT_SCHEMA
1124 } SQLValueFunctionOp;
SQLValueFunctionOp
SQLValueFunctionOp
Definition: primnodes.h:1107

◆ SubLinkType

enum SubLinkType
Enumerator
EXISTS_SUBLINK 
ALL_SUBLINK 
ANY_SUBLINK 
ROWCOMPARE_SUBLINK 
EXPR_SUBLINK 
MULTIEXPR_SUBLINK 
ARRAY_SUBLINK 
CTE_SUBLINK 

Definition at line 624 of file primnodes.h.

625 {
626  EXISTS_SUBLINK,
627  ALL_SUBLINK,
628  ANY_SUBLINK,
629  ROWCOMPARE_SUBLINK,
630  EXPR_SUBLINK,
631  MULTIEXPR_SUBLINK,
632  ARRAY_SUBLINK,
633  CTE_SUBLINK /* for SubPlans only */
634 } SubLinkType;
SubLinkType
SubLinkType
Definition: primnodes.h:624

◆ XmlExprOp

enum XmlExprOp
Enumerator
IS_XMLCONCAT 
IS_XMLELEMENT 
IS_XMLFOREST 
IS_XMLPARSE 
IS_XMLPI 
IS_XMLROOT 
IS_XMLSERIALIZE 
IS_DOCUMENT 

Definition at line 1146 of file primnodes.h.

1147 {
1148  IS_XMLCONCAT, /* XMLCONCAT(args) */
1149  IS_XMLELEMENT, /* XMLELEMENT(name, xml_attributes, args) */
1150  IS_XMLFOREST, /* XMLFOREST(xml_attributes) */
1151  IS_XMLPARSE, /* XMLPARSE(text, is_doc, preserve_ws) */
1152  IS_XMLPI, /* XMLPI(name [, args]) */
1153  IS_XMLROOT, /* XMLROOT(xml, version, standalone) */
1154  IS_XMLSERIALIZE, /* XMLSERIALIZE(is_document, xmlval) */
1155  IS_DOCUMENT /* xmlval IS DOCUMENT */
1156 } XmlExprOp;
XmlExprOp
XmlExprOp
Definition: primnodes.h:1146

◆ XmlOptionType

enum XmlOptionType
Enumerator
XMLOPTION_DOCUMENT 
XMLOPTION_CONTENT 

Definition at line 1158 of file primnodes.h.

1159 {
1160  XMLOPTION_DOCUMENT,
1161  XMLOPTION_CONTENT
1162 } XmlOptionType;
XmlOptionType
XmlOptionType
Definition: primnodes.h:1158