Back to Wekan

Databases

docs/Databases/README.md

10.512.4 KB
Original Source

Databases

WeKan stores its data in a MongoDB-compatible database. That can be MongoDB itself, or FerretDB — which speaks the MongoDB wire protocol and stores the data in SQLite, PostgreSQL, MySQL, MariaDB or SAP HANA. The default is FerretDB v1 with its embedded SQLite, so a fresh docker compose up -d needs no database server at all.

DirectoryWhat is in it
FerretDB/1/FerretDB v1 — the default. SQLite, PostgreSQL, MySQL, MariaDB, SAP HANA
FerretDB/2/FerretDB 2 — PostgreSQL with the DocumentDB extension
MongoDB/MongoDB itself: drivers, versions, the OpLog, and old CPUs
Migrations/WeKan's own schema migrations and how they are verified
ToroDB/ToroDB — a MongoDB proxy to PostgreSQL. No longer developed

FerretDB

Replacing MongoDB with FerretDB. Both of the v1 backends WeKan ships by default are confirmed working with a real Meteor 3 client — the embedded SQLite and vanilla PostgreSQL (#6509); MySQL, MariaDB and SAP HANA are experimental.

MongoDB

Migrations

  • Migrations/ — the schema-migration system, its review notes and verify-migrations.sh

ToroDB

ToroDB is not developed anymore. ToroDB was about adding a MongoDB proxy to PostgreSQL or MySQL.