PlBaseinterfaceno test imports itinterface PlBaseWhat every node of PL/pgSQL has: where its text is, in the whole text.
| Member | Type | What it is |
|---|---|---|
start | number | |
end | number |
The nodes of PL/pgSQL (commons lang-sql 0006-sql-routines FR-005, FR-006): the blocks, declarations and statements of the language a PostgreSQL routine is written in, as a closed union like the core's. The SQL they hold (expressions, queries, types) is made of the core's nodes, so a tree of this extension holds both, and plChildren gives the children of both.
Spec: 0006-sql-routines FR-005, FR-006
PlBaseinterfaceno test imports itinterface PlBaseWhat every node of PL/pgSQL has: where its text is, in the whole text.
| Member | Type | What it is |
|---|---|---|
start | number | |
end | number |
PlVariableinterfaceno test imports itinterface PlVariable extends PlBaseA variable: name [CONSTANT] type [NOT NULL] [DEFAULT expr].
| Member | Type | What it is |
|---|---|---|
kind | "pl-variable" | |
name | Ident | |
constant | boolean | |
type | DataType | undefined | |
notNull | boolean | |
default | Expr | undefined | |
start | number | |
end | number |
PlAliasinterfaceno test imports itinterface PlAlias extends PlBasename ALIAS FOR target.
| Member | Type | What it is |
|---|---|---|
kind | "pl-alias" | |
name | Ident | |
target | string | What it is an alias for, as written ($1, a name). |
start | number | |
end | number |
PlCursorinterfaceno test imports itinterface PlCursor extends PlBasename [[NO] SCROLL] CURSOR [(arguments)] FOR query.
| Member | Type | What it is |
|---|---|---|
kind | "pl-cursor" | |
name | Ident | |
scroll | "no-scroll" | "scroll" | undefined | |
params | readonly string[] | The arguments as written, name type each. |
query | Statement | undefined | |
start | number | |
end | number |
PlDeclarationtypeno test imports ittype PlDeclaration = PlVariable | PlAlias | PlCursor;A declaration.
PlHandlerinterfaceno test imports itinterface PlHandler extends PlBaseWHEN condition [OR condition] THEN statements of an EXCEPTION section.
| Member | Type | What it is |
|---|---|---|
kind | "pl-handler" | |
conditions | readonly string[] | The conditions as written, upper case (OTHERS, NO_DATA_FOUND, SQLSTATE '22012'). |
statements | readonly PlStatement[] | |
start | number | |
end | number |
PlBlockinterfaceinterface PlBlock extends PlBase[<<label>>] [DECLARE declarations] BEGIN statements [EXCEPTION handlers] END [label].
| Member | Type | What it is |
|---|---|---|
kind | "pl-block" | |
label | Ident | undefined | |
declarations | readonly PlDeclaration[] | |
statements | readonly PlStatement[] | |
handlers | readonly PlHandler[] | |
endLabel | Ident | undefined | |
start | number | |
end | number |
PlAssigninterfaceno test imports itinterface PlAssign extends PlBasetarget := value.
| Member | Type | What it is |
|---|---|---|
kind | "pl-assign" | |
target | Expr | |
value | Expr | |
start | number | |
end | number |
PlElsifinterfaceno test imports itinterface PlElsif extends PlBaseELSIF condition THEN statements.
| Member | Type | What it is |
|---|---|---|
kind | "pl-elsif" | |
cond | Expr | |
body | readonly PlStatement[] | |
start | number | |
end | number |
PlIfinterfaceno test imports itinterface PlIf extends PlBaseIF condition THEN statements [ELSIF ...] [ELSE statements] END IF.
| Member | Type | What it is |
|---|---|---|
kind | "pl-if" | |
cond | Expr | |
then | readonly PlStatement[] | |
elsifs | readonly PlElsif[] | |
otherwise | readonly PlStatement[] | undefined | |
start | number | |
end | number |
PlWheninterfaceno test imports itinterface PlWhen extends PlBaseWHEN conditions THEN statements of a CASE.
| Member | Type | What it is |
|---|---|---|
kind | "pl-when" | |
conds | readonly Expr[] | |
body | readonly PlStatement[] | |
start | number | |
end | number |
PlCaseinterfaceno test imports itinterface PlCase extends PlBaseCASE [operand] WHEN ... THEN ... [ELSE statements] END CASE.
| Member | Type | What it is |
|---|---|---|
kind | "pl-case" | |
operand | Expr | undefined | |
whens | readonly PlWhen[] | |
otherwise | readonly PlStatement[] | undefined | |
start | number | |
end | number |
PlLoopinterfaceno test imports itinterface PlLoop extends PlBase[<<label>>] LOOP statements END LOOP.
| Member | Type | What it is |
|---|---|---|
kind | "pl-loop" | |
label | Ident | undefined | |
body | readonly PlStatement[] | |
start | number | |
end | number |
PlWhileinterfaceno test imports itinterface PlWhile extends PlBase[<<label>>] WHILE condition LOOP statements END LOOP.
| Member | Type | What it is |
|---|---|---|
kind | "pl-while" | |
label | Ident | undefined | |
cond | Expr | |
body | readonly PlStatement[] | |
start | number | |
end | number |
PlForRangeinterfaceno test imports itinterface PlForRange extends PlBase[<<label>>] FOR variable IN [REVERSE] from .. to [BY step] LOOP statements END LOOP.
| Member | Type | What it is |
|---|---|---|
kind | "pl-for-range" | |
label | Ident | undefined | |
variable | Ident | |
reverse | boolean | |
from | Expr | |
to | Expr | |
by | Expr | undefined | |
body | readonly PlStatement[] | |
start | number | |
end | number |
PlForQueryinterfaceno test imports itinterface PlForQuery extends PlBase[<<label>>] FOR variables IN query | EXECUTE command [USING ...] LOOP statements END LOOP.
| Member | Type | What it is |
|---|---|---|
kind | "pl-for-query" | |
label | Ident | undefined | |
variables | readonly Ident[] | |
query | Statement | undefined | |
dynamic | Expr | undefined | The command of EXECUTE command. |
cursor | Expr | undefined | The cursor of FOR variable IN cursor (arguments). |
using | readonly Expr[] | |
body | readonly PlStatement[] | |
start | number | |
end | number |
PlForeachinterfaceno test imports itinterface PlForeach extends PlBase[<<label>>] FOREACH variable [SLICE n] IN ARRAY array LOOP statements END LOOP.
| Member | Type | What it is |
|---|---|---|
kind | "pl-foreach" | |
label | Ident | undefined | |
variables | readonly Expr[] | |
slice | string | undefined | |
array | Expr | |
body | readonly PlStatement[] | |
start | number | |
end | number |
PlExitinterfaceno test imports itinterface PlExit extends PlBaseEXIT | CONTINUE [label] [WHEN condition].
| Member | Type | What it is |
|---|---|---|
kind | "pl-exit" | |
exit | "continue" | "exit" | |
label | Ident | undefined | |
when | Expr | undefined | |
start | number | |
end | number |
PlReturninterfaceno test imports itinterface PlReturn extends PlBaseRETURN [value], RETURN NEXT [value], RETURN QUERY query, RETURN QUERY EXECUTE command [USING ...].
| Member | Type | What it is |
|---|---|---|
kind | "pl-return" | |
mode | "next" | "query" | "query-execute" | "return" | |
value | Expr | undefined | |
query | Statement | undefined | |
using | readonly Expr[] | |
start | number | |
end | number |
PlRaiseOptioninterfaceno test imports itinterface PlRaiseOption extends PlBasename = value of a RAISE ... USING.
| Member | Type | What it is |
|---|---|---|
kind | "pl-raise-option" | |
name | string | |
value | Expr | |
start | number | |
end | number |
PlRaiseinterfaceno test imports itinterface PlRaise extends PlBaseRAISE [level] ['format', parameters | condition] [USING options].
| Member | Type | What it is |
|---|---|---|
kind | "pl-raise" | |
level | string | undefined | |
condition | string | undefined | A condition name or SQLSTATE 'code', as written. |
message | Expr | undefined | |
params | readonly Expr[] | |
options | readonly PlRaiseOption[] | |
start | number | |
end | number |
PlPerforminterfaceno test imports itinterface PlPerform extends PlBasePERFORM query.
| Member | Type | What it is |
|---|---|---|
kind | "pl-perform" | |
query | Statement | undefined | |
start | number | |
end | number |
PlExecuteinterfaceno test imports itinterface PlExecute extends PlBaseEXECUTE command [INTO [STRICT] targets] [USING parameters].
| Member | Type | What it is |
|---|---|---|
kind | "pl-execute" | |
command | Expr | undefined | |
into | readonly Expr[] | |
strict | boolean | |
using | readonly Expr[] | |
start | number | |
end | number |
PlOpeninterfaceno test imports itinterface PlOpen extends PlBaseOPEN cursor [[NO] SCROLL] FOR query | EXECUTE command [USING ...], OPEN cursor (arguments).
| Member | Type | What it is |
|---|---|---|
kind | "pl-open" | |
cursor | Ident | |
query | Statement | undefined | |
dynamic | Expr | undefined | |
args | readonly Expr[] | |
using | readonly Expr[] | |
start | number | |
end | number |
PlFetchinterfaceno test imports itinterface PlFetch extends PlBaseFETCH | MOVE [direction] [FROM | IN] cursor [INTO targets].
| Member | Type | What it is |
|---|---|---|
kind | "pl-fetch" | |
move | boolean | |
direction | string | undefined | The direction as written, upper case (NEXT, ABSOLUTE 3). |
cursor | Ident | |
into | readonly Expr[] | |
start | number | |
end | number |
PlCloseinterfaceno test imports itinterface PlClose extends PlBaseCLOSE cursor.
| Member | Type | What it is |
|---|---|---|
kind | "pl-close" | |
cursor | Ident | |
start | number | |
end | number |
PlCallinterfaceno test imports itinterface PlCall extends PlBaseCALL procedure(arguments).
| Member | Type | What it is |
|---|---|---|
kind | "pl-call" | |
call | Expr | undefined | |
start | number | |
end | number |
PlNullinterfaceno test imports itinterface PlNull extends PlBaseNULL.
| Member | Type | What it is |
|---|---|---|
kind | "pl-null" | |
start | number | |
end | number |
PlDiagnosticsIteminterfaceno test imports itinterface PlDiagnosticsItem extends PlBasetarget = item of GET DIAGNOSTICS.
| Member | Type | What it is |
|---|---|---|
kind | "pl-diagnostics-item" | |
target | Expr | |
item | string | |
start | number | |
end | number |
PlDiagnosticsinterfaceno test imports itinterface PlDiagnostics extends PlBaseGET [CURRENT | STACKED] DIAGNOSTICS target = item, ....
| Member | Type | What it is |
|---|---|---|
kind | "pl-diagnostics" | |
stacked | boolean | |
items | readonly PlDiagnosticsItem[] | |
start | number | |
end | number |
PlAssertinterfaceno test imports itinterface PlAssert extends PlBaseASSERT condition [, message].
| Member | Type | What it is |
|---|---|---|
kind | "pl-assert" | |
cond | Expr | |
message | Expr | undefined | |
start | number | |
end | number |
PlTransactioninterfaceno test imports itinterface PlTransaction extends PlBaseCOMMIT | ROLLBACK [AND [NO] CHAIN].
| Member | Type | What it is |
|---|---|---|
kind | "pl-transaction" | |
action | "commit" | "rollback" | |
chain | boolean | |
start | number | |
end | number |
PlSqlinterfaceno test imports itinterface PlSql extends PlBaseA SQL statement, with the targets of its INTO [STRICT] taken out of it.
| Member | Type | What it is |
|---|---|---|
kind | "pl-sql" | |
statement | Statement | undefined | |
into | readonly Expr[] | |
strict | boolean | |
start | number | |
end | number |
PlUnparsedinterfaceno test imports itinterface PlUnparsed extends PlBaseA statement that could not be read.
| Member | Type | What it is |
|---|---|---|
kind | "pl-unparsed" | |
start | number | |
end | number |
PlStatementtypetype PlStatement =
| PlBlock
| PlAssign
| PlIf
| PlCase
| PlLoop
| PlWhile
| PlForRange
| PlForQuery
| PlForeach
| PlExit
| PlReturn
| PlRaise
| PlPerform
| PlExecute
| PlOpen
| PlFetch
| PlClose
| PlCall
| PlNull
| PlDiagnostics
| PlAssert
| PlTransaction
| PlSql
| PlUnparsed;A statement of PL/pgSQL.
PlNodetypeno test imports ittype PlNode = PlStatement | PlDeclaration | PlHandler | PlElsif | PlWhen | PlRaiseOption | PlDiagnosticsItem;A node of PL/pgSQL.
PlTreetypetype PlTree = PlNode | Node;A node of a tree of this extension: PL/pgSQL, or SQL of the core.
isPlfunctionno test imports itfunction isPl(n: PlTree): n is PlNodeWhether a node of the tree is PL/pgSQL's.
plChildrenfunctionfunction plChildren(n: PlTree): readonly PlTree[]The children of a node of the tree, in the order of the text: PL/pgSQL's and the core's.
| Parameter | What it is |
|---|---|
n | a node |
Returns: its children