mirror of https://github.com/open-webui/open-webui synced 2024-12-26 05:42:05 +00:00

History

Timothy J. Baek ba0523cd69 refac: api_key field moved to user		2024-04-02 09:23:55 -07:00
..
001_initial_schema.py	Update 001_initial_schema.py	2024-04-02 08:58:03 -07: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
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.

Have a database file (webui.db) that has the old schema prior to any of your changes.
Make your changes to the models.
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.
The migration file will be created in the apps/web/internal/migrations directory.