summaryrefslogtreecommitdiff
path: root/heat/db/migrations/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'heat/db/migrations/README.rst')
-rw-r--r--heat/db/migrations/README.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/heat/db/migrations/README.rst b/heat/db/migrations/README.rst
new file mode 100644
index 000000000..b2283fc82
--- /dev/null
+++ b/heat/db/migrations/README.rst
@@ -0,0 +1,15 @@
+Database migrations
+===================
+
+This directory contains migrations for the database. These are implemented
+using `alembic`__, a lightweight database migration tool designed for usage
+with `SQLAlchemy`__.
+
+The best place to start understanding Alembic is with its own `tutorial`__. You
+can also play around with the :command:`alembic` command::
+
+ $ alembic --help
+
+.. __: https://alembic.sqlalchemy.org/en/latest/
+.. __: https://www.sqlalchemy.org/
+.. __: https://alembic.sqlalchemy.org/en/latest/tutorial.html