This project converts Typescript functions into PLV8 functions.

• Type checking, linting, prettier.
• Code will be correctly highlighted by editors.
• Automatically adds "create function" wrapper with correct parameters and return type.
• Supports trigger functions.

• No support for including external packages.

npm run install

Add Typescript functions to the src/functions directory, one function per file. Use the type names from the 'plv8' package to define parameters and return types. Be sure to export the function with export function. This trivial example:

export function sample_function(event_id_param: int8): smallint {
  return 2;
}

will produce this:

create or replace function sample_function(event_id_param int8)
returns smallint AS $$
  return 2;
$$ language plv8 security definer;

To define functions in a schema (other than the default "public") create a subdirectory in src/functions. This example will be defined in the private schema.

Import plv8 and use the functions that it defines. Some allow defining a type that will help with type checking in the Typescript compiler. For example, adding a type Foo when calling execute will cast the return type as Foo[]. For example:

const value_rows = plv8.execute<{value: string}>(
  "select value from private.keys where key = 'EMAIL_TEMPLATE_PROMOTE_ATTENDEE'");
// Use value_rows[0].value

will cast the return value as {value: string}[]. More examples in the function sample.

To convert the Typescript functions into SQL statements use npm run convert. The results will be in build/src/functions/**.sql.

To add DROP statements use npm run convert -- -d.

To write a trigger function, return trigger<MyTableRow> where MyTableRow defines the type of the row for the trigger. You can also add a NEW parameter for insert and update triggers, and OLD for update and delete triggers.

export function sample_trigger(
  NEW: MyTableRow,
  OLD: MyTableRow
): trigger<MyTableRow> { ... }

See sample trigger for more details.

To add security definer, immutable, or stable to the function definition, add a comment in the function that starts with plv8:. For example:

// plv8: security definer, immutable

Run npm run lint or npm run fix to lint or fix the formattings for the functions. This package is using the Google Typescript Style.

TODO: Add example of testing the functions.

The Typescript config is currently using a module settings of es2015. This was found through experimentation to produce the easiest output to parse. This also seems to set the target to ES6, which seems to be supported by current version of PLV8. The PLV8 documentation doesn't mention which ECMAScript version it supports.