SQL API Reference

Selected pg_ripple SQL functions with full parameter descriptions, return schemas, and copy-pasteable examples. For the complete alphabetical list of all 157 functions see sql-functions.md.

Compatibility & diagnostics

compat_check

Return a JSON object describing the installed extension version and its compatibility with the HTTP companion.

pg_ripple.compat_check() → TEXT

Returns — a JSON string with the following keys:

Example return value:

{
  "extension_version": "0.123.0",
  "http_min_version": "0.122.0",
  "compatible": true
}

Example usage:

SELECT pg_ripple.compat_check();
-- {"extension_version":"0.123.0","http_min_version":"0.122.0","compatible":true}

-- Parse as JSON:
SELECT
  (pg_ripple.compat_check()::jsonb) ->> 'extension_version' AS ext_version,
  (pg_ripple.compat_check()::jsonb) ->> 'compatible'        AS compatible;

Benchmarking

bench_workload

Run a benchmark workload profile against the local triple store and record the results in _pg_ripple.bench_history.

pg_ripple.bench_workload(
    profile TEXT DEFAULT 'bsbm'
) → BIGINT

Parameters:

Returns — the run_id of the newly inserted _pg_ripple.bench_history row.

-- Run BSBM benchmark:
SELECT pg_ripple.bench_workload('bsbm');

-- Run WatDiv benchmark:
SELECT pg_ripple.bench_workload('watdiv');

bench_workload_result

Return the most recent benchmark run for the given profile. Convenience wrapper over _pg_ripple.bench_history — no raw SQL required.

pg_ripple.bench_workload_result(
    profile TEXT DEFAULT 'bsbm'
) → TABLE (
    run_id              BIGINT,
    profile             TEXT,
    started_at          TIMESTAMPTZ,
    duration_ms         BIGINT,
    queries_per_second  FLOAT8,
    triples_processed   BIGINT
)

Parameters:

Example usage:

-- Run a benchmark and immediately retrieve the result:
SELECT pg_ripple.bench_workload('bsbm');
SELECT * FROM pg_ripple.bench_workload_result('bsbm');

-- Output:
--  run_id | profile | started_at               | duration_ms | queries_per_second | triples_processed
--  -------+---------+--------------------------+-------------+--------------------+------------------
--       1 | bsbm    | 2026-05-19 12:00:00+00   |         342 |             175.44 |             50000

Rule library federation

publish_rule_library

Publish an installed rule library so it can be subscribed to from remote pg_ripple instances through the HTTP companion's rule-library stream endpoint.

pg_ripple.publish_rule_library(
    name         TEXT,
    endpoint_uri TEXT
) → VOID

Parameters:

Errors — raises PT046x error codes for invalid name/URI, missing library, or catalog write failure.

-- Publish the "rdfs-base" library on this instance:
SELECT pg_ripple.publish_rule_library(
    'rdfs-base',
    'https://instance-a.example.com/rule-libraries/rdfs-base/stream'
);

subscribe_rule_library

Record the intent to subscribe to a remote rule-library stream. The source URI must pass the SSRF policy check. The SQL function does not perform outbound network I/O; fetching and installing the remote rules is performed by the HTTP companion's POST /rule-libraries/{name}/subscribe endpoint.

pg_ripple.subscribe_rule_library(
    source_uri TEXT,
    name       TEXT
) → VOID

Parameters:

Errors — raises PT046x error codes for SSRF-blocked URIs, invalid names, or catalog write failure.

-- Record subscription intent for a rule library published on instance A:
SELECT pg_ripple.subscribe_rule_library(
    'https://instance-a.example.com/rule-libraries/rdfs-base/stream',
    'rdfs-base'
);

Allen's interval relations

All seven Allen's interval relations are available as both SQL functions and SPARQL extension functions (pg:before, pg:meets, etc.).

Each function accepts four TIMESTAMPTZ arguments representing the start and end of two intervals: (a_start, a_end, b_start, b_end).

allen_before

pg_ripple.allen_before(
    a_start TIMESTAMPTZ,
    a_end   TIMESTAMPTZ,
    b_start TIMESTAMPTZ,
    b_end   TIMESTAMPTZ
) → BOOLEAN

Returns true when interval A ends strictly before interval B starts (a_end < b_start).

SELECT pg_ripple.allen_before(
    '2026-01-01'::timestamptz, '2026-01-15'::timestamptz,
    '2026-02-01'::timestamptz, '2026-02-28'::timestamptz
);  -- true

allen_meets

pg_ripple.allen_meets(
    a_start TIMESTAMPTZ,
    a_end   TIMESTAMPTZ,
    b_start TIMESTAMPTZ,
    b_end   TIMESTAMPTZ
) → BOOLEAN

Returns true when interval A ends at exactly the same instant B starts (a_end = b_start).

allen_overlaps

pg_ripple.allen_overlaps(
    a_start TIMESTAMPTZ,
    a_end   TIMESTAMPTZ,
    b_start TIMESTAMPTZ,
    b_end   TIMESTAMPTZ
) → BOOLEAN

Returns true when A starts before B and the intervals overlap but neither contains the other (a_start < b_start AND a_end > b_start AND a_end < b_end).

allen_during

pg_ripple.allen_during(
    a_start TIMESTAMPTZ,
    a_end   TIMESTAMPTZ,
    b_start TIMESTAMPTZ,
    b_end   TIMESTAMPTZ
) → BOOLEAN

Returns true when interval A is entirely within interval B (b_start < a_start AND a_end < b_end).

allen_finishes

pg_ripple.allen_finishes(
    a_start TIMESTAMPTZ,
    a_end   TIMESTAMPTZ,
    b_start TIMESTAMPTZ,
    b_end   TIMESTAMPTZ
) → BOOLEAN

Returns true when A ends at the same time as B but starts later (a_start > b_start AND a_end = b_end).

allen_starts

pg_ripple.allen_starts(
    a_start TIMESTAMPTZ,
    a_end   TIMESTAMPTZ,
    b_start TIMESTAMPTZ,
    b_end   TIMESTAMPTZ
) → BOOLEAN

Returns true when A starts at the same time as B but ends earlier (a_start = b_start AND a_end < b_end).

allen_equals

pg_ripple.allen_equals(
    a_start TIMESTAMPTZ,
    a_end   TIMESTAMPTZ,
    b_start TIMESTAMPTZ,
    b_end   TIMESTAMPTZ
) → BOOLEAN

Returns true when both intervals are identical (a_start = b_start AND a_end = b_end).

SPARQL example using interval relations:

PREFIX pg: <https://pgrdf.io/fn/>
PREFIX ex: <https://example.org/>

SELECT ?event ?label WHERE {
  ?event ex:startTime ?s ;
         ex:endTime   ?e ;
         ex:label     ?label .
  FILTER(pg:before(?s, ?e,
                   "2026-06-01T00:00:00Z"^^xsd:dateTime,
                   "2026-12-31T23:59:59Z"^^xsd:dateTime))
}

See also

• Full SQL function list
• GUC reference
• HTTP API reference