IF Commons GitHub

extensions/plpgsql/nodes

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

Source: commons/lang-sql/src/extensions/plpgsql/nodes.ts

4 of 39 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

PlBaseinterfaceno test imports it
interface PlBase

What every node of PL/pgSQL has: where its text is, in the whole text.

MemberTypeWhat it is
startnumber
endnumber
PlVariableinterfaceno test imports it
interface PlVariable extends PlBase

A variable: name [CONSTANT] type [NOT NULL] [DEFAULT expr].

MemberTypeWhat it is
kind"pl-variable"
nameIdent
constantboolean
typeDataType | undefined
notNullboolean
defaultExpr | undefined
startnumber
endnumber
PlAliasinterfaceno test imports it
interface PlAlias extends PlBase

name ALIAS FOR target.

MemberTypeWhat it is
kind"pl-alias"
nameIdent
targetstringWhat it is an alias for, as written ($1, a name).
startnumber
endnumber
PlCursorinterfaceno test imports it
interface PlCursor extends PlBase

name [[NO] SCROLL] CURSOR [(arguments)] FOR query.

MemberTypeWhat it is
kind"pl-cursor"
nameIdent
scroll"no-scroll" | "scroll" | undefined
paramsreadonly string[]The arguments as written, name type each.
queryStatement | undefined
startnumber
endnumber
PlDeclarationtypeno test imports it
type PlDeclaration = PlVariable | PlAlias | PlCursor;

A declaration.

PlHandlerinterfaceno test imports it
interface PlHandler extends PlBase

WHEN condition [OR condition] THEN statements of an EXCEPTION section.

MemberTypeWhat it is
kind"pl-handler"
conditionsreadonly string[]The conditions as written, upper case (OTHERS, NO_DATA_FOUND, SQLSTATE '22012').
statementsreadonly PlStatement[]
startnumber
endnumber
PlBlockinterface
interface PlBlock extends PlBase

[<<label>>] [DECLARE declarations] BEGIN statements [EXCEPTION handlers] END [label].

MemberTypeWhat it is
kind"pl-block"
labelIdent | undefined
declarationsreadonly PlDeclaration[]
statementsreadonly PlStatement[]
handlersreadonly PlHandler[]
endLabelIdent | undefined
startnumber
endnumber

Imported by 9 tests of the run (9 passed, 0 failed): the library's results

PlAssigninterfaceno test imports it
interface PlAssign extends PlBase

target := value.

MemberTypeWhat it is
kind"pl-assign"
targetExpr
valueExpr
startnumber
endnumber
PlElsifinterfaceno test imports it
interface PlElsif extends PlBase

ELSIF condition THEN statements.

MemberTypeWhat it is
kind"pl-elsif"
condExpr
bodyreadonly PlStatement[]
startnumber
endnumber
PlIfinterfaceno test imports it
interface PlIf extends PlBase

IF condition THEN statements [ELSIF ...] [ELSE statements] END IF.

MemberTypeWhat it is
kind"pl-if"
condExpr
thenreadonly PlStatement[]
elsifsreadonly PlElsif[]
otherwisereadonly PlStatement[] | undefined
startnumber
endnumber
PlWheninterfaceno test imports it
interface PlWhen extends PlBase

WHEN conditions THEN statements of a CASE.

MemberTypeWhat it is
kind"pl-when"
condsreadonly Expr[]
bodyreadonly PlStatement[]
startnumber
endnumber
PlCaseinterfaceno test imports it
interface PlCase extends PlBase

CASE [operand] WHEN ... THEN ... [ELSE statements] END CASE.

MemberTypeWhat it is
kind"pl-case"
operandExpr | undefined
whensreadonly PlWhen[]
otherwisereadonly PlStatement[] | undefined
startnumber
endnumber
PlLoopinterfaceno test imports it
interface PlLoop extends PlBase

[<<label>>] LOOP statements END LOOP.

MemberTypeWhat it is
kind"pl-loop"
labelIdent | undefined
bodyreadonly PlStatement[]
startnumber
endnumber
PlWhileinterfaceno test imports it
interface PlWhile extends PlBase

[<<label>>] WHILE condition LOOP statements END LOOP.

MemberTypeWhat it is
kind"pl-while"
labelIdent | undefined
condExpr
bodyreadonly PlStatement[]
startnumber
endnumber
PlForRangeinterfaceno test imports it
interface PlForRange extends PlBase

[<<label>>] FOR variable IN [REVERSE] from .. to [BY step] LOOP statements END LOOP.

MemberTypeWhat it is
kind"pl-for-range"
labelIdent | undefined
variableIdent
reverseboolean
fromExpr
toExpr
byExpr | undefined
bodyreadonly PlStatement[]
startnumber
endnumber
PlForQueryinterfaceno test imports it
interface PlForQuery extends PlBase

[<<label>>] FOR variables IN query | EXECUTE command [USING ...] LOOP statements END LOOP.

MemberTypeWhat it is
kind"pl-for-query"
labelIdent | undefined
variablesreadonly Ident[]
queryStatement | undefined
dynamicExpr | undefinedThe command of EXECUTE command.
cursorExpr | undefinedThe cursor of FOR variable IN cursor (arguments).
usingreadonly Expr[]
bodyreadonly PlStatement[]
startnumber
endnumber
PlForeachinterfaceno test imports it
interface PlForeach extends PlBase

[<<label>>] FOREACH variable [SLICE n] IN ARRAY array LOOP statements END LOOP.

MemberTypeWhat it is
kind"pl-foreach"
labelIdent | undefined
variablesreadonly Expr[]
slicestring | undefined
arrayExpr
bodyreadonly PlStatement[]
startnumber
endnumber
PlExitinterfaceno test imports it
interface PlExit extends PlBase

EXIT | CONTINUE [label] [WHEN condition].

MemberTypeWhat it is
kind"pl-exit"
exit"continue" | "exit"
labelIdent | undefined
whenExpr | undefined
startnumber
endnumber
PlReturninterfaceno test imports it
interface PlReturn extends PlBase

RETURN [value], RETURN NEXT [value], RETURN QUERY query, RETURN QUERY EXECUTE command [USING ...].

MemberTypeWhat it is
kind"pl-return"
mode"next" | "query" | "query-execute" | "return"
valueExpr | undefined
queryStatement | undefined
usingreadonly Expr[]
startnumber
endnumber
PlRaiseOptioninterfaceno test imports it
interface PlRaiseOption extends PlBase

name = value of a RAISE ... USING.

MemberTypeWhat it is
kind"pl-raise-option"
namestring
valueExpr
startnumber
endnumber
PlRaiseinterfaceno test imports it
interface PlRaise extends PlBase

RAISE [level] ['format', parameters | condition] [USING options].

MemberTypeWhat it is
kind"pl-raise"
levelstring | undefined
conditionstring | undefinedA condition name or SQLSTATE 'code', as written.
messageExpr | undefined
paramsreadonly Expr[]
optionsreadonly PlRaiseOption[]
startnumber
endnumber
PlPerforminterfaceno test imports it
interface PlPerform extends PlBase

PERFORM query.

MemberTypeWhat it is
kind"pl-perform"
queryStatement | undefined
startnumber
endnumber
PlExecuteinterfaceno test imports it
interface PlExecute extends PlBase

EXECUTE command [INTO [STRICT] targets] [USING parameters].

MemberTypeWhat it is
kind"pl-execute"
commandExpr | undefined
intoreadonly Expr[]
strictboolean
usingreadonly Expr[]
startnumber
endnumber
PlOpeninterfaceno test imports it
interface PlOpen extends PlBase

OPEN cursor [[NO] SCROLL] FOR query | EXECUTE command [USING ...], OPEN cursor (arguments).

MemberTypeWhat it is
kind"pl-open"
cursorIdent
queryStatement | undefined
dynamicExpr | undefined
argsreadonly Expr[]
usingreadonly Expr[]
startnumber
endnumber
PlFetchinterfaceno test imports it
interface PlFetch extends PlBase

FETCH | MOVE [direction] [FROM | IN] cursor [INTO targets].

MemberTypeWhat it is
kind"pl-fetch"
moveboolean
directionstring | undefinedThe direction as written, upper case (NEXT, ABSOLUTE 3).
cursorIdent
intoreadonly Expr[]
startnumber
endnumber
PlCloseinterfaceno test imports it
interface PlClose extends PlBase

CLOSE cursor.

MemberTypeWhat it is
kind"pl-close"
cursorIdent
startnumber
endnumber
PlCallinterfaceno test imports it
interface PlCall extends PlBase

CALL procedure(arguments).

MemberTypeWhat it is
kind"pl-call"
callExpr | undefined
startnumber
endnumber
PlNullinterfaceno test imports it
interface PlNull extends PlBase

NULL.

MemberTypeWhat it is
kind"pl-null"
startnumber
endnumber
PlDiagnosticsIteminterfaceno test imports it
interface PlDiagnosticsItem extends PlBase

target = item of GET DIAGNOSTICS.

MemberTypeWhat it is
kind"pl-diagnostics-item"
targetExpr
itemstring
startnumber
endnumber
PlDiagnosticsinterfaceno test imports it
interface PlDiagnostics extends PlBase

GET [CURRENT | STACKED] DIAGNOSTICS target = item, ....

MemberTypeWhat it is
kind"pl-diagnostics"
stackedboolean
itemsreadonly PlDiagnosticsItem[]
startnumber
endnumber
PlAssertinterfaceno test imports it
interface PlAssert extends PlBase

ASSERT condition [, message].

MemberTypeWhat it is
kind"pl-assert"
condExpr
messageExpr | undefined
startnumber
endnumber
PlTransactioninterfaceno test imports it
interface PlTransaction extends PlBase

COMMIT | ROLLBACK [AND [NO] CHAIN].

MemberTypeWhat it is
kind"pl-transaction"
action"commit" | "rollback"
chainboolean
startnumber
endnumber
PlSqlinterfaceno test imports it
interface PlSql extends PlBase

A SQL statement, with the targets of its INTO [STRICT] taken out of it.

MemberTypeWhat it is
kind"pl-sql"
statementStatement | undefined
intoreadonly Expr[]
strictboolean
startnumber
endnumber
PlUnparsedinterfaceno test imports it
interface PlUnparsed extends PlBase

A statement that could not be read.

MemberTypeWhat it is
kind"pl-unparsed"
startnumber
endnumber
PlStatementtype
type 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.

Imported by 9 tests of the run (9 passed, 0 failed): the library's results

PlNodetypeno test imports it
type PlNode = PlStatement | PlDeclaration | PlHandler | PlElsif | PlWhen | PlRaiseOption | PlDiagnosticsItem;

A node of PL/pgSQL.

PlTreetype
type PlTree = PlNode | Node;

A node of a tree of this extension: PL/pgSQL, or SQL of the core.

Imported by 9 tests of the run (9 passed, 0 failed): the library's results

isPlfunctionno test imports it
function isPl(n: PlTree): n is PlNode

Whether a node of the tree is PL/pgSQL's.

plChildrenfunction
function 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.

ParameterWhat it is
na node

Returns: its children

Imported by 9 tests of the run (9 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.