GlcoinCore/squeaknode
1
0
Fork 0
mirror of https://github.com/yzernik/squeaknode.git synced 2026-08-13 12:33:25 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
squeaknode/docs/database-migration.md
Jonathan Zernik 058240841d
Use python venv (#1920) 
* Automatically install requirements.txt in setup

* Remove extra copy of requirements.txt in dockerfile
2021-12-29 18:48:53 -08:00

1,018 B
Raw Blame History

Database Migration

DB migration:

Alembic is used for database migrations.

To change any database model, follow these steps.

  • Make sure that squeaknode on your local machine is running with the most up-to-date database migration.
  • Make a note of the path to the ".db" sqlite database file. (Usually ~/.sqk/data/testnet/data.db by default). If this is an initial migration, then create an empty file at this location.
  • Make the changes to database models in squeaknode/db/models.py
  • Update the alembic.ini file to point to the sqlite file from before: 
    sqlalchemy.url = sqlite://///home/<USER>/.sqk/data/testnet/data.db
  • Run the command to generate a new alembic migration: 
    python3 -m venv venv
source venv/bin/activate
pip install -e .
alembic -c squeaknode/db/alembic.ini revision --autogenerate -m "<YOUR_MESSAGE>"
  • To generate a new initial version revision, follow the same steps as above, but the /home/<USER>/.sqk/data/testnet/data.db file should be an empty file.