added docs for alembic migrations

ankitchiplunkar · ankitchiplunkar · commit 2529c2d38daf · 2018-05-31T09:58:00.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -11,6 +11,7 @@ src/*
 *.pytest_cache
 tests/*.cache
 *.cache
+*.coverage
 
 # removing doc builds
 docs/_build/*
diff --git a/docs/guides/contribution.rst b/docs/guides/contribution.rst
@@ -23,6 +23,27 @@ All our tests can be run using the following command:
   $ python -m pytest ether_sql/tests/
 
 
+Updating the database tables
+----------------------------
+
+We use `Alembic <http://alembic.zzzcomputing.com/en/latest/tutorial.html>`_ to
+handle database migrations.
+
+You can create new tables by adding a new class in the :code:`ether_sql/models` module. More details on available columns are available at `SQLAlchemy guides <http://docs.sqlalchemy.org/en/latest/orm/tutorial.html>`_
+
+To create SQL commands that can reflect the changes in the database, run the following command.
+
+
+.. code :: shell
+
+  $ ether_sql sql migrate -m "message for changes"
+
+Next upgrade the database using the following command:
+
+.. code :: shell
+
+  $ ether_sql sql upgrade
+
 Updating the docs
 -----------------
 
