base on A truly Open Source MongoDB alternative # FerretDB <!-- textlint-disable one-sentence-per-line --> > [!TIP] > Looking for FerretDB v1? > It is [there](https://github.com/FerretDB/FerretDB/tree/main-v1). <!-- textlint-enable one-sentence-per-line --> [](https://pkg.go.dev/github.com/FerretDB/FerretDB/v2/ferretdb) [](https://github.com/FerretDB/FerretDB/actions/workflows/go.yml) [](https://codecov.io/gh/FerretDB/FerretDB) [](https://github.com/FerretDB/FerretDB/actions/workflows/security.yml) [](https://github.com/FerretDB/FerretDB/actions/workflows/packages.yml) [](https://github.com/FerretDB/FerretDB/actions/workflows/docs.yml) 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](https://github.com/microsoft/documentdb) as a database engine. ```mermaid flowchart LR A["Any application<br>Any MongoDB driver"] F{{FerretDB}} P[(PostgreSQL<br>DocumentDB extension)] A -- "MongoDB protocol<br>BSON" --> F F -- "PostgreSQL protocol<br>SQL" --> 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](https://www.ferretdb.com/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](https://github.com/orgs/FerretDB/projects/2/views/1), a list of [known differences with MongoDB](https://docs.ferretdb.io/diff/), and [contributing guidelines](CONTRIBUTING.md). ## Quickstart Run this command to start FerretDB with PostgreSQL: ```sh docker run -d --rm --name ferretdb -p 27017:27017 --platform linux/amd64 \ ghcr.io/ferretdb/ferretdb-eval:2 ``` This command will start a container with FerretDB, pre-packaged PostgreSQL with DocumentDB extension, and MongoDB Shell for quick testing and experiments. However, it is unsuitable for production use cases because it keeps all data inside and loses it on shutdown. See our [installation guides](https://docs.ferretdb.io/installation/) for instructions that don't have those problems. With that container running, you can: - Connect to it with any MongoDB client application using MongoDB URI `mongodb://username:[email protected]:27017/`. - Connect to it using MongoDB Shell by just running `mongosh`. If you don't have it installed locally, you can run `docker exec -it ferretdb mongosh`. - For PostgreSQL, connect to it by running `docker exec -it ferretdb psql -U username postgres`. You can stop the container with `docker stop ferretdb`. We also provide binaries and packages for various Linux distributions. as well as [Go library package](https://pkg.go.dev/github.com/FerretDB/FerretDB/v2/ferretdb) that embeds FerretDB into your application. See [our documentation](https://docs.ferretdb.io/installation/) 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](https://pkg.go.dev/github.com/FerretDB/FerretDB/v2/build/version) for more details. ## Managed FerretDB at cloud providers - [FerretDB Cloud](https://cloud.ferretdb.com/) - [Civo](https://www.civo.com/marketplace/FerretDB) - [Tembo](https://tembo.io/docs/tembo-stacks/mongo-alternative) - [Elestio](https://elest.io/open-source/ferretdb) - [Cozystack](https://cozystack.io/docs/components/#managed-ferretdb) ## Community - Website: https://www.ferretdb.com/. - Blog: https://blog.ferretdb.io/. - Documentation: https://docs.ferretdb.io/. - X (Twitter): [@ferret_db](https://x.com/ferret_db). - Mastodon: [@[email protected]](https://techhub.social/@ferretdb). - [Slack chat](https://slack.ferretdb.io/) for quick questions. - [GitHub Discussions](https://github.com/FerretDB/FerretDB/discussions) for longer topics. - [GitHub Issues](https://github.com/FerretDB/FerretDB/issues) for bugs and missing features. - [Open Office Hours meeting](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NGhrZTA5dXZ0MzQzN2gyaGVtZmx2aWxmN2pfMjAyNDA0MDhUMTcwMDAwWiBjX24zN3RxdW9yZWlsOWIwMm0wNzQwMDA3MjQ0QGc&tmsrc=c_n37tquoreil9b02m0740007244%40group.calendar.google.com&scp=ALL) every Monday at 17:00 UTC at [Google Meet](https://meet.google.com/mcb-arhw-qbq). If you want to contact FerretDB Inc., please use [this form](https://www.ferretdb.com/contact/). ", Assign "at most 3 tags" to the expected json: {"id":"2873","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"