From a747fca7505f0e492c4d7840dff9148194b81922 Mon Sep 17 00:00:00 2001 From: Neeraj Kashyap Date: Tue, 27 Jul 2021 01:05:10 -0700 Subject: [PATCH] Documentation for moonstreamdb package --- db/README.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/db/README.md b/db/README.md index f1ed900c..26134732 100644 --- a/db/README.md +++ b/db/README.md @@ -1 +1,38 @@ -# moonstream db \ No newline at end of file +# moonstream db + +### Setting up moonstreamdb + +Copy `sample.env` to a new file and set the environment variables to appropriate values. This new file +should be sourced every time you want to access the database with the `moonstreamdb` application or any +dependents. + +To be able to run migrations, copy [`alembic.sample.ini`](./alembic.sample.ini) to a separate file +(e.g. `./secrets/alembic.dev.ini`) and modify the `sqlalchemy.url` setting in the new file to point +at your database. + +Make sure your database is at the latest alembic migration: + +```bash +alembic -c ./secrets/alembic.dev.ini upgrade head +``` + +### Adding a new table to database + +Add SQLAlchemy model in [`moonstreamdb/models.py`](./moonstreamdb/models.py) + +Import new model and add tablename to whitelist in [`alembic/env.py`](.alembic/env.py) + +Create a migration: + +```bash +alembic -c revision -m "" --autogenerate +``` + +Always check the autogenerated file to make sure that it isn't performing any actions that you don't want it to. +A good policy is to delete any operations that don't touch the tables that you created. + +Then run the migration: + +```bash +alembic -c upgrade head +```