Contents
plxjs: the JavaScript dialect
plxjs lets you write PostgreSQL functions with JavaScript syntax (current
ECMAScript). At CREATE FUNCTION time plx transpiles the body to plpgsql and
stores the plpgsql in pg_proc.prosrc. The function runs on the standard plpgsql
interpreter.
The language name is plxjs.
Setup
CREATE EXTENSION plx;
Function basics
Blocks are brace-delimited and statements end with ;. A scalar function ends
with an explicit return.
CREATE FUNCTION add(a int, b int) RETURNS int LANGUAGE plxjs AS $$
return a + b;
$$;
Function arguments are referenced by name. Any SQL expression is valid, because expressions are passed through to plpgsql and SQL unchanged.
Local variables and types
Declare locals with let, const, or var; the keyword is removed in the
generated plpgsql. plx infers the type from the first value when it is an
integer, numeric, text, or boolean literal. Otherwise annotate the variable with
a /*:: type */ comment before the ;. An annotation before an initializer
(let n /*:: bigint */ = 3;) is rejected; write let n = 3 /*:: bigint */;.
let n = 42; // inferred integer
let label = "count"; // inferred text
let amount /*:: numeric */;
amount = principal * rate;
The annotation becomes the plpgsql type. It must be a type name and nothing
else (plx checks this at CREATE FUNCTION time), and %TYPE and %ROWTYPE
work:
let e /*:: emp%ROWTYPE */;
let s /*:: emp.sal%TYPE */;
A constant uses the const suffix in the annotation:
let pi = 3.14159 /*:: numeric const */;
A constant becomes a plpgsql CONSTANT, whose value is computed when the
function starts. So it can use literals, parameters and earlier constants, but
not another local variable: that would read the variable’s initial value, not
the one assigned above it, and is rejected.
Control flow
if / else if / else
if (score >= 90) { grade = "A"; }
else if (score >= 80) { grade = "B"; }
else { grade = "F"; }
switch
switch lowers to plpgsql CASE. Stacked labels become a value list. Each arm
must end with break or another statement that leaves the arm (return,
throw, continue, or break with a loop label); genuine fall-through is
rejected.
A break inside an if or try within an arm leaves the switch, as it
does in the source language. A break inside a loop within an arm leaves only
that loop.
switch (n) {
case 1: return "one";
case 2: case 3: return "few";
default: return "many";
}
Loops
Counting for and while:
for (let i = 1; i <= n; i++) {
total = total + i;
}
while (n > 0) { n = n - 1; }
A counting for becomes a plpgsql integer FOR. That loop works out its
bounds once and keeps its own copy of the loop variable. So plx accepts a for
only when the result is the same:
- The condition compares the loop variable with a single value (
i < nori <= n). - The step changes the loop variable (
i++ori += K). - The body does not assign the loop variable, or any variable in the bound or the step.
- In a loop without
letorconst, the code after the loop does not read the loop variable before it assigns it again.vardoes not count aslet: avarvariable keeps its value after the loop. - In a loop without
letorconstthat is inside another loop, the outer loop does not read the loop variable on its next pass before theforruns again: not in its condition, and not in its body before thefor.
CREATE FUNCTION rejects any other for. Write it as a while loop instead.
continue and break map to CONTINUE and EXIT.
Loop labels
outer: for (let i = 1; i <= n; i++) {
for (let j = 1; j <= n; j++) {
if (i + j >= lim) { break outer; }
}
}
Working with data
Iterating a query
for (const row of query(`SELECT id, amount FROM orders WHERE grp = ${g}`)) {
total = total + row.amount;
}
The row variable is a record. Field access is row.col. For bind parameters or
non-literal SQL, pass extra arguments: for (const row of query(sql, a)), which
becomes FOR row IN EXECUTE sql USING a.
Iterating an array
let v /*:: int */;
for (const v of values) {
total = total + v;
}
The loop variable must be annotated with its element type.
Fetching one row
let u = fetch_one(`SELECT id, name FROM users WHERE id = ${uid}`);
return u.name;
fetch_one returns all-NULL on no row. fetch_one! raises on zero or more than
one row.
Running SQL
perform(`UPDATE counters SET n = n + 1 WHERE id = ${cid}`);
execute("INSERT INTO t(msg) VALUES ($1)", note);
return_query(`SELECT id FROM vip ORDER BY id`); // set-returning function
Use bind arguments in execute for untrusted input.
Cursors
let c = open_cursor(`SELECT v FROM t ORDER BY v`);
let row = fetch_from(c);
while (found()) {
total = total + row.v;
row = fetch_from(c);
}
close_cursor(c);
move_cursor(c) and move_cursor(c, n) map to MOVE.
Diagnostics
let rc = row_count(); // GET DIAGNOSTICS rc = ROW_COUNT
if (found()) { return rc; } // the FOUND variable
Set-returning functions
CREATE FUNCTION squares(n int) RETURNS SETOF int LANGUAGE plxjs AS $$
for (let i = 1; i <= n; i++) { return_next(i * i); }
return;
$$;
Errors
Throwing
throw new Error(`negative: ${v}`);
throw takes a constructor call, such as new Error(message), and raises its first
argument as the error message. CREATE FUNCTION rejects any other thrown
expression, such as throw msg; or throw a + b(c);. To throw a computed
message, build it inside the call.
The call form raise("notice", "message") emits a RAISE at the named level
(notice, warning, info, log, debug, exception).
Handling
let r = 0;
try {
r = 100 / d;
} catch (e) {
raise("notice", `caught: ${e.message}`);
r = -1;
} finally {
perform("INSERT INTO log(msg) VALUES ('done')");
}
return r;
catch (e) maps to WHEN OTHERS. Accessors: e.message to SQLERRM,
e.sqlstate to SQLSTATE, and e.detail, e.hint, e.constraint, e.column,
e.table, e.schema, e.datatype to the matching GET STACKED DIAGNOSTICS
fields.
The finally body runs once, whether the try block completes, returns,
breaks, continues or raises an error. After an error it runs and then raises
the error again, with its SQLSTATE, message, detail, hint and the names of
the objects it is about (schema, table, column, constraint, type); the
CONTEXT of the raised error points at the re-raise, not the original
statement. It does not run when the statement is cancelled (a query cancel
or statement_timeout) or an assert fails, because WHEN OTHERS does not
catch those two errors; for the same reason catch (e) does not catch them.
Assertions
assert(n > 0, "must be positive");
Expressions
- Interpolation: template literals,
`total is ${amount}`. Plain"..."and'...'strings do not interpolate. Use template literals for concatenation. - Comparison:
==,===,!=,!==map to=and<>.x === nullbecomesx IS NULL. - Boolean:
&&and!map toANDandNOT.||maps toORonly in anif/whilecondition or a ternary test. Elsewhere (assignments,return) it passes through as SQL||(string concatenation), so writeORthere:let ok = a OR b /*:: boolean */;. - Power and XOR:
a ** bbecomes((a) ^ (b)), so it keeps the dialect’s meaning:2 ** 3 ** 2is 512.a ^ bis bitwise XOR and becomes SQLa # b; it works on integers. SQL reads&,|,#,<<and>>from left to right, soCREATE FUNCTIONrejects a mix that JavaScript groups differently, such asa ^ b & c. Writea ^ (b & c). - Ternary:
c ? a : bbecomesCASE WHEN c THEN a ELSE b END. nullandundefinedbecomeNULL.
Building strings in a loop
Concatenating onto a string in a loop is slow in plpgsql: s := s || 'x' is
O(n2) because text is immutable and each step copies the whole string. Use +=
on a string variable, which plx lowers to its string builder (plx_strbuild):
let s = "" /*:: text */;
for (const row of query(`SELECT name FROM t ORDER BY id`)) {
s += row.name;
s += ",";
}
return s;
If an appended value is NULL, the whole string becomes NULL, as with ||.
To skip NULL values, append coalesce(x, '').
On PostgreSQL 18 this is amortized O(1) per append. On PostgreSQL 13 to 17 it is
correct but not accelerated (the in-place optimization needs a PostgreSQL 18
feature). Note that += is treated as string append only when the variable is a
string; on a numeric variable it is numeric addition.
Trigger functions
A function returning trigger can be used as a trigger. Assign to NEW fields
and return NEW:
CREATE FUNCTION stamp() RETURNS trigger LANGUAGE plxjs AS $$
NEW.tag = `row ${NEW.id}`;
return NEW;
$$;
NEW, OLD, and the TG_ variables are available. Assigning to a record field
(NEW.col = e) or an array element (arr[i] = e) is supported.
Semantic differences
These are intentional. plx pins semantics to SQL and plpgsql.
- Decimal literals infer
numeric, not a floating-point type. Arithmetic is exact, not IEEE 754. - Comparisons use SQL three-valued logic:
==,===,!=,!==map to=and<>, so a comparison involving NULL is unknown. Only a comparison with the literalnullbecomesIS NULL/IS NOT NULL. A positiveif/whilecondition treats NULL as false. ===and!==do not preserve JavaScript strict-type semantics; they behave like==and!=and use SQL type resolution.1 === "1"is false in JavaScript but compares as equal here. Compare like-typed values.+is numeric addition; use template literals for string building.- Interpolating a NULL in a template literal propagates it, so the whole string
is NULL. It is neither the JavaScript string
"null"nor an empty string. In athroworraisemessage, including theraise("level", ...)call form, the value falls back to an empty string instead, so one NULL cannot swallow the message. Anassertmessage gets no fallback: a NULL there replaces your message with plpgsql’s genericassertion failed. - Integer division and modulo follow SQL (truncate toward zero).
- JavaScript truthiness is not emulated. A condition must be a boolean
expression. A non-boolean condition is not rejected at CREATE time. When the function runs, plpgsql coerces it
through its text form: a value whose text is a boolean literal (
0,1,t,yes,off, …) is silently accepted, and anything else raisesinvalid input syntax for type boolean. - Locals are function-scoped, matching JavaScript
varscope.letandconstinside a block are not block-scoped: a redeclaration in an inner block assigns the outer variable.constis not enforced.
Not supported
Rejected at CREATE FUNCTION time with a line number:
- Function definitions, classes,
import. for...in.- A
forthat is not a counting loop (see Loops). switchfall-through (end each case withbreakorreturn).
Not translated:
- Arrow functions and object and array literals as general values. Unannotated,
they fail at
CREATE FUNCTIONtime withcannot infer a PostgreSQL type; annotated, they pass through and fail when the function runs. for...oftreats anything other thanquery(...)as an array (FOREACH ... IN ARRAY); a non-array fails when the function runs.
See PARITY.md for the full plpgsql construct matrix and ARCHITECTURE.md for how plx maps to the plpgsql engine.