UniqAI/open-webui
1
0
Fork 0
mirror of https://github.com/open-webui/open-webui synced 2024-11-06 00:32:05 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
01c4647dfc
open-webui/backend/apps/web/internal/migrations
History
Jun Siang Cheah e91a49c455 feat: add support for using postgres for the backend DB
2024-04-27 15:33:20 +01:00
..
001_initial_schema.py feat: add support for using postgres for the backend DB 2024-04-27 15:33:20 +01:00
002_add_local_sharing.py feat: migrate db schema for local sharing 2024-04-02 08:58:03 -07:00
003_add_auth_api_key.py refac: api_key field moved to user 2024-04-02 09:23:55 -07:00
004_add_archived.py feat: archive chat 2024-04-20 17:03:39 -05:00
005_add_updated_at.py feat: add support for using postgres for the backend DB 2024-04-27 15:33:20 +01:00
006_migrate_timestamps_and_charfields.py feat: add support for using postgres for the backend DB 2024-04-27 15:33:20 +01:00
README.md feat: add ability to run db migrations 2024-04-02 08:58:03 -07:00

README.md

Database Migrations

This directory contains all the database migrations for the web app. Migrations are done using the peewee-migrate library.

Migrations are automatically ran at app startup.

Creating a migration

Have you made a change to the schema of an existing model? You will need to create a migration file to ensure that existing databases are updated for backwards compatibility.

  1. Have a database file (webui.db) that has the old schema prior to any of your changes.
  2. Make your changes to the models.
  3. From the backend directory, run the following command: 
    pw_migrate create --auto --auto-source apps.web.models --database sqlite:///${SQLITE_DB} --directory apps/web/internal/migrations ${MIGRATION_NAME}
    • $SQLITE_DB should be the path to the database file.
    • $MIGRATION_NAME should be a descriptive name for the migration.
  4. The migration file will be created in the apps/web/internal/migrations directory.