moonstream/db
Neeraj Kashyap b9c828fc7f Merge branch 'main' into smart-contract-crawlers 2021-07-28 10:34:55 -07:00
..
alembic Typo in import in moonstreamdb mmodule 2021-07-27 21:22:14 +00:00
moonstreamdb Merge branch 'main' into smart-contract-crawlers 2021-07-28 10:02:53 -07:00
.gitignore Added Ethereum Signature Database tables to database 2021-07-27 00:06:23 -07:00
README.md Documentation for moonstreamdb package 2021-07-27 01:05:10 -07:00
alembic.sample.ini Added Ethereum Signature Database tables to database 2021-07-27 00:06:23 -07:00
alembic.sh Typo in import in moonstreamdb mmodule 2021-07-27 21:22:14 +00:00
requirements.txt moonstream-db -> moonstreamdb 2021-07-26 09:24:46 -07:00
sample.env Merge branch 'main' into smart-contract-crawlers 2021-07-28 10:34:55 -07:00
setup.py Updated setup and requirements for db and crawlers 2021-07-28 13:17:39 +03:00

README.md

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 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:

alembic -c ./secrets/alembic.dev.ini upgrade head

Adding a new table to database

Add SQLAlchemy model in moonstreamdb/models.py

Import new model and add tablename to whitelist in alembic/env.py

Create a migration:

alembic -c <alembic config file> revision -m "<revision message>" --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:

alembic -c <alembic config file> upgrade head