Module: FERRET

Add MongoDB-compatible protocol support to PostgreSQL using FerretDB

FERRET is an optional module in Pigsty for deploying FerretDB — a protocol translation middleware built on the PostgreSQL kernel and the DocumentDB extension. It enables applications using MongoDB drivers to connect and translates those requests into PostgreSQL operations.

Pigsty is a community partner of FerretDB. We have built binary packages for FerretDB and DocumentDB (FerretDB-specific fork), and provide a ready-to-use configuration template mongo.yml to help you easily deploy enterprise-grade FerretDB clusters.


Usage

Install client tools, connect to and use FerretDB

Configuration

Configure the FerretDB module and define cluster topology

Parameters

Customize FerretDB with 9 parameters

Administration

Create, remove, expand, shrink, and upgrade FerretDB clusters

Playbook

Ansible playbooks available for the FERRET module

Monitoring

Monitoring dashboards and alerting rules for the FerretDB module

Metrics

Complete list of monitoring metrics provided by the FerretDB module

FAQ

Frequently asked questions about FerretDB and DocumentDB modules


Last Modified 2026-01-09: add supabase asciinema demo (693cfa8)