documentdb_core

Core API surface for DocumentDB for PostgreSQL

Overview

PIGSTY 3rd Party Extension: documentdb : Core API surface for DocumentDB for PostgreSQL

Information

Metadata

  • Latest Version: 0.101-0
  • Postgres Support: 17,16,15
  • Need Load: Explicit Loading Required
  • Need DDL: Need CREATE EXTENSION DDL
  • Relocatable: Can be installed into other schemas
  • Trusted: Untrusted, Require Superuser to Create
  • Schemas: N/A
  • Requires: N/A

RPM / DEB

  • RPM Repo: PIGSTY
  • RPM Name: documentdb_$v*
  • RPM Ver : 0.101-0
  • RPM Deps: postgresql$v-contrib, pg_cron_$v, pgvector_$v, rum_$v
  • DEB Repo: PIGSTY
  • DEB Name: postgresql-$v-documentdb
  • DEB Ver : 0.101-0
  • DEB Deps: postgresql-$v-cron, postgresql-$v-pgvector, postgresql-$v-rum

Availability

OS Arch PG17 PG16 PG15 PG14 PG13
el8 x86_64 documentdb_17
PIGSTY 0.101
documentdb_16
PIGSTY 0.101
documentdb_15
PIGSTY 0.101
el8 aarch64
el9 x86_64 documentdb_17
PIGSTY 0.101
documentdb_16
PIGSTY 0.101
documentdb_15
PIGSTY 0.101
el9 aarch64
d12 x86_64 postgresql-17-documentdb
PIGSTY 0.101
postgresql-16-documentdb
PIGSTY 0.101
postgresql-15-documentdb
PIGSTY 0.101
d12 aarch64
u22 x86_64 postgresql-17-documentdb
PIGSTY 0.101
postgresql-16-documentdb
PIGSTY 0.101
postgresql-15-documentdb
PIGSTY 0.101
u22 aarch64
u24 x86_64 postgresql-17-documentdb
PIGSTY 0.101
postgresql-16-documentdb
PIGSTY 0.101
postgresql-15-documentdb
PIGSTY 0.101
u24 aarch64

Installation

Install documentdb_core via the pig CLI tool:


pig ext install documentdb; # Extension Namepig ext install documentdb_core; # normalized package name

Install documentdb via Pigsty playbook:

./pgsql.yml -t pg_extension -e '{"pg_extensions": ["documentdb"]}' # -l <cls>

Install documentdb RPM from YUM repo directly:

dnf install documentdb_17*;
dnf install documentdb_16*;
dnf install documentdb_15*;

Install documentdb DEB from APT repo directly:

apt install postgresql-17-documentdb;
apt install postgresql-16-documentdb;
apt install postgresql-15-documentdb;

Extension documentdb_core has to be added to shared_preload_libraries

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

Enable documentdb_core extension on PostgreSQL cluster:

CREATE EXTENSION documentdb_core;

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+





Last modified 2025-02-23: update extension doc (ae76c50)