PIGSTY

documentdb

API surface for DocumentDB for PostgreSQL

Overview

Attributes

YesNoYesYesYesNoNo-

Packages

EL
PIGSTY
documentdb_$v*0.103postgresql$v-contrib
pg_cron_$v
pgvector_$v
rum_$v
17
16
15
14
13
Debian
PIGSTY
postgresql-$v-documentdb0.103postgresql-$v-cron
postgresql-$v-pgvector
postgresql-$v-rum
17
16
15
14
13

Dependencies

This extension depends on: documentdb_core, pg_cron, tsm_system_rows, vector, postgis, rum


Availability

PG17PG16PG15PG14PG13
el8.x86_64
0.103
0.103
0.103
el8.aarch64
0.103
0.103
0.103
el9.x86_64
0.103
0.103
0.103
el9.aarch64
0.103
0.103
0.103
d12.x86_64
0.103
0.103
0.103
d12.aarch64
0.103
0.103
0.103
u22.x86_64
0.103
0.103
0.103
u22.aarch64
0.103
0.103
0.103
u24.x86_64
0.103
0.103
0.103
u24.aarch64
0.103
0.103
0.103
CONTRIB
PGDG
PIGSTY

Download

To add the required PGDG / PIGSTY upstream repository, use:

pig repo add pgdg -u    # add PGDG repo and update cache (leave existing repos)
pig repo add pigsty -u  # add PIGSTY repo and update cache (leave existing repos)
pig repo add pgsql -u   # add PGDG + Pigsty repo and update cache (leave existing repos)
pig repo set all -u     # set repo to all = NODE + PGSQL + INFRA  (remove existing repos)
./node.yml -t node_repo -e node_repo_modules=node,pgsql # -l <cluster>

Or download the latest packages directly:


Install

Install this extension with:

pig ext install documentdb; # install by extension name, for the current active PG version

pig ext install documentdb -v 17;   # install for PG 17
pig ext install documentdb -v 16;   # install for PG 16
pig ext install documentdb -v 15;   # install for PG 15
dnf install documentdb_17*;
dnf install documentdb_16*;
dnf install documentdb_15*;
apt install postgresql-17-documentdb;
apt install postgresql-16-documentdb;
apt install postgresql-15-documentdb;
./pgsql.yml -t pg_ext -e '{"pg_extensions": ["documentdb"]}' # -l <cls>

Preload this extension with:

shared_preload_libraries = 'documentdb'; # add to pg cluster config

Create this extension with:

CREATE EXTENSION documentdb CASCADE;

Usage

Add to shared_preload_libraries first:

-    shared_preload_libraries: documentdb_core, pg_stat_statements, auto_explain
+    shared_preload_libraries: pg_documentdb_core, pg_stat_statements, auto_explain

Example, create extension and perform DDL & CRUD

CREATE EXTENSION documentdb_core ;

Currently we only have documentdb_core extension, It can be used with the FerretDB 2.0+