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	XmlExpr
struct	JsonFormat
struct	JsonReturning
struct	JsonValueExpr
struct	JsonConstructorExpr
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   (-1) /* reference to inner subplan */
#define	OUTER_VAR   (-2) /* reference to outer subplan */
#define	INDEX_VAR   (-3) /* reference to index column */
#define	ROWID_VAR   (-4) /* row identity column during planning */
#define	IS_SPECIAL_VARNO(varno)   ((int) (varno) < 0)
#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 XmlExprOp	XmlExprOp
typedef enum XmlOptionType	XmlOptionType
typedef struct XmlExpr	XmlExpr
typedef enum JsonEncoding	JsonEncoding
typedef enum JsonFormatType	JsonFormatType
typedef struct JsonFormat	JsonFormat
typedef struct JsonReturning	JsonReturning
typedef struct JsonValueExpr	JsonValueExpr
typedef enum JsonConstructorType	JsonConstructorType
typedef struct JsonConstructorExpr	JsonConstructorExpr
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_PLPGSQL , COERCION_EXPLICIT }
enum	CoercionForm { COERCE_EXPLICIT_CALL , COERCE_EXPLICIT_CAST , COERCE_IMPLICIT_CAST , COERCE_SQL_SYNTAX }
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	XmlExprOp {   IS_XMLCONCAT , IS_XMLELEMENT , IS_XMLFOREST , IS_XMLPARSE ,   IS_XMLPI , IS_XMLROOT , IS_XMLSERIALIZE , IS_DOCUMENT }
enum	XmlOptionType { XMLOPTION_DOCUMENT , XMLOPTION_CONTENT }
enum	JsonEncoding { JS_ENC_DEFAULT , JS_ENC_UTF8 , JS_ENC_UTF16 , JS_ENC_UTF32 }
enum	JsonFormatType { JS_FORMAT_DEFAULT , JS_FORMAT_JSON , JS_FORMAT_JSONB }
enum	JsonConstructorType { JSCTOR_JSON_OBJECT = 1 , JSCTOR_JSON_ARRAY = 2 , JSCTOR_JSON_OBJECTAGG = 3 , JSCTOR_JSON_ARRAYAGG = 4 }
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   (-3) /* reference to index column */

Definition at line 216 of file primnodes.h.

INNER_VAR

#define INNER_VAR   (-1) /* reference to inner subplan */

Definition at line 214 of file primnodes.h.

IS_SPECIAL_VARNO

#define IS_SPECIAL_VARNO

(

varno

)

((int) (varno) < 0)

Definition at line 219 of file primnodes.h.

OUTER_VAR

#define OUTER_VAR   (-2) /* reference to outer subplan */

Definition at line 215 of file primnodes.h.

PRS2_NEW_VARNO

#define PRS2_NEW_VARNO   2

Definition at line 223 of file primnodes.h.

PRS2_OLD_VARNO

#define PRS2_OLD_VARNO   1

Definition at line 222 of file primnodes.h.

ROWID_VAR

#define ROWID_VAR   (-4) /* row identity column during planning */

Definition at line 217 of file primnodes.h.

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 779 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

JsonConstructorExpr

typedef struct JsonConstructorExpr JsonConstructorExpr

JsonConstructorType

typedef enum JsonConstructorType JsonConstructorType

JsonEncoding

typedef enum JsonEncoding JsonEncoding

JsonFormat

typedef struct JsonFormat JsonFormat

JsonFormatType

typedef enum JsonFormatType JsonFormatType

JsonReturning

typedef struct JsonReturning JsonReturning

JsonValueExpr

typedef struct JsonValueExpr JsonValueExpr

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 787 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

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

XmlOptionType

typedef enum XmlOptionType XmlOptionType

Enumeration Type Documentation

BoolExprType

enum BoolExprType

Enumerator
AND_EXPR
OR_EXPR
NOT_EXPR

Definition at line 856 of file primnodes.h.

{
    AND_EXPR, OR_EXPR, NOT_EXPR
} BoolExprType;

BoolTestType

enum BoolTestType

Enumerator
IS_TRUE
IS_NOT_TRUE
IS_FALSE
IS_NOT_FALSE
IS_UNKNOWN
IS_NOT_UNKNOWN

Definition at line 1629 of file primnodes.h.

{
    IS_TRUE, IS_NOT_TRUE, IS_FALSE, IS_NOT_FALSE, IS_UNKNOWN, IS_NOT_UNKNOWN
} BoolTestType;

CoercionContext

enum CoercionContext

Enumerator
COERCION_IMPLICIT
COERCION_ASSIGNMENT
COERCION_PLPGSQL
COERCION_EXPLICIT

Definition at line 639 of file primnodes.h.

{
    COERCION_IMPLICIT,          /* coercion in context of expression */
    COERCION_ASSIGNMENT,        /* coercion in context of assignment */
    COERCION_PLPGSQL,           /* if no assignment cast, use CoerceViaIO */
    COERCION_EXPLICIT           /* explicit cast operation */
} CoercionContext;

CoercionForm

enum CoercionForm

Enumerator
COERCE_EXPLICIT_CALL
COERCE_EXPLICIT_CAST
COERCE_IMPLICIT_CAST
COERCE_SQL_SYNTAX

Definition at line 659 of file primnodes.h.

{
    COERCE_EXPLICIT_CALL,       /* display as a function call */
    COERCE_EXPLICIT_CAST,       /* display as an explicit cast */
    COERCE_IMPLICIT_CAST,       /* implicit cast, so hide it */
    COERCE_SQL_SYNTAX           /* display with SQL-mandated special syntax */
} CoercionForm;

JsonConstructorType

enum JsonConstructorType

Enumerator
JSCTOR_JSON_OBJECT
JSCTOR_JSON_ARRAY
JSCTOR_JSON_OBJECTAGG
JSCTOR_JSON_ARRAYAGG

Definition at line 1561 of file primnodes.h.

{
    JSCTOR_JSON_OBJECT = 1,
    JSCTOR_JSON_ARRAY = 2,
    JSCTOR_JSON_OBJECTAGG = 3,
    JSCTOR_JSON_ARRAYAGG = 4
} JsonConstructorType;

JsonEncoding

enum JsonEncoding

Enumerator
JS_ENC_DEFAULT
JS_ENC_UTF8
JS_ENC_UTF16
JS_ENC_UTF32

Definition at line 1505 of file primnodes.h.

{
    JS_ENC_DEFAULT,             /* unspecified */
    JS_ENC_UTF8,
    JS_ENC_UTF16,
    JS_ENC_UTF32,
} JsonEncoding;

JsonFormatType

enum JsonFormatType

Enumerator
JS_FORMAT_DEFAULT
JS_FORMAT_JSON
JS_FORMAT_JSONB

Definition at line 1517 of file primnodes.h.

{
    JS_FORMAT_DEFAULT,          /* unspecified */
    JS_FORMAT_JSON,             /* FORMAT JSON [ENCODING ...] */
    JS_FORMAT_JSONB             /* implicit internal format for RETURNING
                                 * jsonb */
} JsonFormatType;

MinMaxOp

enum MinMaxOp

Enumerator
IS_GREATEST
IS_LEAST

Definition at line 1425 of file primnodes.h.

{
    IS_GREATEST,
    IS_LEAST
} MinMaxOp;

NullTestType

enum NullTestType

Enumerator
IS_NULL
IS_NOT_NULL

Definition at line 1605 of file primnodes.h.

{
    IS_NULL, IS_NOT_NULL
} NullTestType;

OnCommitAction

enum OnCommitAction

Enumerator
ONCOMMIT_NOOP
ONCOMMIT_PRESERVE_ROWS
ONCOMMIT_DELETE_ROWS
ONCOMMIT_DROP

Definition at line 47 of file primnodes.h.

{
    ONCOMMIT_NOOP,              /* No ON COMMIT clause (do nothing) */
    ONCOMMIT_PRESERVE_ROWS,     /* ON COMMIT PRESERVE ROWS (do nothing) */
    ONCOMMIT_DELETE_ROWS,       /* ON COMMIT DELETE ROWS */
    ONCOMMIT_DROP               /* ON COMMIT DROP */
} OnCommitAction;

ParamKind

enum ParamKind

Enumerator
PARAM_EXTERN
PARAM_EXEC
PARAM_SUBLINK
PARAM_MULTIEXPR

Definition at line 343 of file primnodes.h.

{
    PARAM_EXTERN,
    PARAM_EXEC,
    PARAM_SUBLINK,
    PARAM_MULTIEXPR
} ParamKind;

RowCompareType

enum RowCompareType

Enumerator
ROWCOMPARE_LT
ROWCOMPARE_LE
ROWCOMPARE_EQ
ROWCOMPARE_GE
ROWCOMPARE_GT
ROWCOMPARE_NE

Definition at line 1377 of file primnodes.h.

{
    /* Values of this enum are chosen to match btree strategy numbers */
    ROWCOMPARE_LT = 1,          /* BTLessStrategyNumber */
    ROWCOMPARE_LE = 2,          /* BTLessEqualStrategyNumber */
    ROWCOMPARE_EQ = 3,          /* BTEqualStrategyNumber */
    ROWCOMPARE_GE = 4,          /* BTGreaterEqualStrategyNumber */
    ROWCOMPARE_GT = 5,          /* BTGreaterStrategyNumber */
    ROWCOMPARE_NE = 6           /* no such btree strategy */
} RowCompareType;

SubLinkType

enum SubLinkType

Enumerator
EXISTS_SUBLINK
ALL_SUBLINK
ANY_SUBLINK
ROWCOMPARE_SUBLINK
EXPR_SUBLINK
MULTIEXPR_SUBLINK
ARRAY_SUBLINK
CTE_SUBLINK

Definition at line 922 of file primnodes.h.

{
    EXISTS_SUBLINK,
    ALL_SUBLINK,
    ANY_SUBLINK,
    ROWCOMPARE_SUBLINK,
    EXPR_SUBLINK,
    MULTIEXPR_SUBLINK,
    ARRAY_SUBLINK,
    CTE_SUBLINK                 /* for SubPlans only */
} SubLinkType;

XmlExprOp

enum XmlExprOp

Enumerator
IS_XMLCONCAT
IS_XMLELEMENT
IS_XMLFOREST
IS_XMLPARSE
IS_XMLPI
IS_XMLROOT
IS_XMLSERIALIZE
IS_DOCUMENT

Definition at line 1459 of file primnodes.h.

{
    IS_XMLCONCAT,               /* XMLCONCAT(args) */
    IS_XMLELEMENT,              /* XMLELEMENT(name, xml_attributes, args) */
    IS_XMLFOREST,               /* XMLFOREST(xml_attributes) */
    IS_XMLPARSE,                /* XMLPARSE(text, is_doc, preserve_ws) */
    IS_XMLPI,                   /* XMLPI(name [, args]) */
    IS_XMLROOT,                 /* XMLROOT(xml, version, standalone) */
    IS_XMLSERIALIZE,            /* XMLSERIALIZE(is_document, xmlval, indent) */
    IS_DOCUMENT                 /* xmlval IS DOCUMENT */
} XmlExprOp;

XmlOptionType

enum XmlOptionType

Enumerator
XMLOPTION_DOCUMENT
XMLOPTION_CONTENT

Definition at line 1471 of file primnodes.h.

{
    XMLOPTION_DOCUMENT,
    XMLOPTION_CONTENT
} XmlOptionType;