aboutsummaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/migrations.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/documentation/migrations.rst b/documentation/migrations.rst
index e69de29b..174c1132 100644
--- a/documentation/migrations.rst
+++ b/documentation/migrations.rst
@@ -0,0 +1,24 @@
+Migrations
+==========
+
+Migrations of the database are managed
+with the database migrations tool
+`Alembic <https://bitbucket.org/zzzeek/alembic>`_.
+
+The Flask extensions `Flask-Script <https://github.com/smurfix/flask-script>`_
+and `Flask-Migrate <https://github.com/miguelgrinberg/flask-migrate/>_`
+are used to ease remote migrations.
+
+Local migrations
+----------------
+
+.. code:: bash
+
+ $ python manage.py db upgrade
+
+Remote migrations
+-----------------
+
+.. code:: bash
+
+ $ heroku run python manage.py db upgrade
bgstack15