jsonb_plruby

Overview

Extension control default_version is 1.0; shipped in the PL/Ruby 2.5.0 package.

Version

Build

You can build the RPM / DEB packages for plruby using pig build:

pig build pkg plruby         # build RPM / DEB packages

Install

You can install plruby directly. First, make sure the PGDG and PIGSTY repositories are added and enabled:

pig repo add pgsql -u          # Add repo and update cache

Install the extension using pig or apt/yum/dnf:

• Install
• pig
• dnf
• apt

pig install plruby;          # Install for current active PG version

pig ext install -y plruby -v 18  # PG 18
pig ext install -y plruby -v 17  # PG 17
pig ext install -y plruby -v 16  # PG 16
pig ext install -y plruby -v 15  # PG 15
pig ext install -y plruby -v 14  # PG 14

dnf install -y plruby_18       # PG 18
dnf install -y plruby_17       # PG 17
dnf install -y plruby_16       # PG 16
dnf install -y plruby_15       # PG 15
dnf install -y plruby_14       # PG 14

apt install -y postgresql-18-plruby   # PG 18
apt install -y postgresql-17-plruby   # PG 17
apt install -y postgresql-16-plruby   # PG 16
apt install -y postgresql-15-plruby   # PG 15
apt install -y postgresql-14-plruby   # PG 14

Create Extension:

CREATE EXTENSION jsonb_plruby CASCADE;  -- requires: plruby

Usage

Sources:

• PL/Ruby v2.5.0 README
• jsonb_plruby v1.0 control file
• jsonb_plruby v1.0 extension SQL

jsonb_plruby installs a PostgreSQL transform between jsonb and native Ruby values for the plruby language. A transformed jsonb argument becomes a Ruby Hash, Array, String, Integer, Float, true, false, or nil; compatible Ruby values can be returned directly as jsonb.

Install and Use the Transform

CREATE EXTENSION plruby;
CREATE EXTENSION jsonb_plruby;

CREATE FUNCTION ruby_mark_processed(jsonb)
RETURNS jsonb
LANGUAGE plruby
TRANSFORM FOR TYPE jsonb
AS $$
  value = args[0]
  value['processed'] = true
  value
$$;

SELECT ruby_mark_processed('{"id": 42}'::jsonb);

The transform is used only by functions that declare TRANSFORM FOR TYPE jsonb. Other PL/Ruby functions keep the language’s ordinary JSONB conversion behavior.

Objects and Caveats

• jsonb_to_plruby(internal) implements SQL-to-Ruby conversion.
• plruby_to_jsonb(internal) implements Ruby-to-SQL conversion.
• The extension version is 1.0, it requires plruby, and it is relocatable.
• Ruby Hash keys returned to PostgreSQL must be valid JSON object keys, and numeric/special values must be representable by PostgreSQL jsonb. Test nested values and numeric limits explicitly.
• PL/Ruby remains untrusted. Installing this transform does not sandbox Ruby code or reduce the privileges required to create PL/Ruby functions.