documentdb_distributed

Multi-Node API surface for DocumentDB

Overview

PackageVersionCategoryLicenseLanguage
documentdb0.109SIMMITC
IDExtensionBinLibLoadCreateTrustRelocSchema
9000documentdbNoYesYesYesNoNo-
9010documentdb_coreNoYesYesYesNoNo-
9020documentdb_distributedNoYesYesYesNoNo-
9030documentdb_extended_rumNoYesYesYesNoYes-
Relatedcitus documentdb_core documentdb citus mongo_fdw plproxy postgres_fdw rum pg_jsonschema jsquery

Version

TypeRepoVersionPG VerPackageDeps
EXTPIGSTY0.1091817161514documentdbcitus, documentdb_core, documentdb
RPMPIGSTY0.1091817161514documentdb_$vpostgresql$v-contrib, pg_cron_$v, pgvector_$v, rum_$v
DEBPIGSTY0.1091817161514postgresql-$v-documentdbpostgresql-$v-cron, postgresql-$v-pgvector, postgresql-$v-rum
OS / PGPG18PG17PG16PG15PG14
el8.x86_64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.107PIGSTY MISS
el8.aarch64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.107PIGSTY MISS
el9.x86_64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.107PIGSTY MISS
el9.aarch64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.107PIGSTY MISS
el10.x86_64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.107PIGSTY MISS
el10.aarch64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.107PIGSTY MISS
d12.x86_64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY MISS
d12.aarch64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY MISS
d13.x86_64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY MISS
d13.aarch64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY MISS
u22.x86_64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY MISS
u22.aarch64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY MISS
u24.x86_64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY MISS
u24.aarch64PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY 0.109PIGSTY MISS

Build

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

pig build pkg documentdb         # build RPM / DEB packages

Install

You can install documentdb 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:

pig install documentdb;          # Install for current active PG version
pig ext install -y documentdb -v 18  # PG 18
pig ext install -y documentdb -v 17  # PG 17
pig ext install -y documentdb -v 16  # PG 16
pig ext install -y documentdb -v 15  # PG 15
dnf install -y documentdb_18       # PG 18
dnf install -y documentdb_17       # PG 17
dnf install -y documentdb_16       # PG 16
dnf install -y documentdb_15       # PG 15
apt install -y postgresql-18-documentdb   # PG 18
apt install -y postgresql-17-documentdb   # PG 17
apt install -y postgresql-16-documentdb   # PG 16
apt install -y postgresql-15-documentdb   # PG 15

Preload:

shared_preload_libraries = 'citus, pg_documentdb, pg_documentdb_core';

Create Extension:

CREATE EXTENSION documentdb_distributed CASCADE;  -- requires: citus, documentdb_core, documentdb

Usage

documentdb_distributed: Multi-Node API surface for DocumentDB

The documentdb_distributed extension provides multi-node distributed capabilities for DocumentDB on PostgreSQL. It extends the core DocumentDB functionality to support horizontal scaling across multiple PostgreSQL nodes.

Overview

This extension works in conjunction with documentdb_core to provide distributed document database operations. It enables:

  • Sharding of document collections across multiple nodes
  • Distributed query execution for MongoDB-compatible operations
  • Horizontal scaling for large document workloads

Prerequisites

The documentdb_distributed extension requires:

  • documentdb_core extension installed and configured
  • A multi-node PostgreSQL cluster (typically using Citus for distribution)

Enabling

CREATE EXTENSION documentdb_distributed;

The distributed layer transparently routes CRUD operations and aggregation pipelines across the cluster nodes while maintaining MongoDB wire protocol compatibility.


Last Modified 2026-03-12: add pg extension catalog (95749bf)