FerretDB

<!-- textlint-disable one-sentence-per-line -->

> [!TIP]
> Looking for FerretDB v1?
> It is there.

<!-- textlint-enable one-sentence-per-line -->




FerretDB is an open-source alternative to MongoDB.
It is a proxy that converts MongoDB 5.0+ wire protocol queries to SQL
and uses PostgreSQL with DocumentDB extension as a database engine.

mermaid
flowchart LR
  A["Any applicationAny MongoDB driver"]
  F{{FerretDB}}
  P[(PostgreSQLDocumentDB extension)]

  A -- "MongoDB protocolBSON" --> F
  F -- "PostgreSQL protocolSQL" --> P

Why do we need FerretDB?

MongoDB was originally an eye-opening technology for many of us developers,
empowering us to build applications faster than using relational databases.
In its early days, its ease-to-use and well-documented drivers made MongoDB one of the simplest database solutions available.
However, as time passed, MongoDB abandoned its open-source roots;
changing the license to SSPL - making it unusable for many open-source and early-stage commercial projects.

Most MongoDB users do not require any advanced features offered by MongoDB;
however, they need an easy-to-use open-source document database solution.
Recognizing this, FerretDB is here to fill that gap.

Scope and current state

FerretDB is compatible with MongoDB drivers and popular MongoDB tools.
It functions as a drop-in replacement for MongoDB 5.0+ in many cases.
Features are constantly being added to further increase compatibility and performance.

We welcome all contributors.
See our public roadmap,
lists of known differences and supported commands,
and [contributing guidelines](CONTRIBUTING.md).

Quickstart

Run this command to start FerretDB with PostgreSQL, make sure to update ` and :

sh
docker run -d --rm --name ferretdb -p 27017:27017 \
  -e POSTGRES_USER= \
  -e POSTGRES_PASSWORD= \
  ghcr.io/ferretdb/ferretdb-eval:2

• Connect to it with any MongoDB client application using the MongoDB URI mongodb://:@127.0.0.1:27017/.
• Connect to it using the MongoDB Shell by just running mongosh.

• For PostgreSQL, connect to it by running docker exec -it ferretdb psql -U postgres.

We also provide binaries and packages for various Linux distributions.
as well as Go library package
that embeds FerretDB into your application.
See our documentation for more details.

Building and packaging

<!-- textlint-disable one-sentence-per-line -->

> [!NOTE]
> We advise users not to build FerretDB themselves.
> Instead, use binaries, Docker images, or packages provided by us.

<!-- textlint-enable one-sentence-per-line -->

FerretDB could be built as any other Go program,
but a few generated files and build tags could affect it.
See there for more details.

Managed FerretDB at cloud providers

• FerretDB Cloud
• Civo
• Tembo
• Elestio
• Cozystack

Community

• Website: https://www.ferretdb.com/.
• Blog: https://blog.ferretdb.io/.
• Documentation: https://docs.ferretdb.io/.
• X (Twitter): @ferret_db.
• Mastodon: @[email protected].
• Slack chat for quick questions.
• GitHub Discussions for longer topics.
• GitHub Issues for bugs and missing features.

Collapse