Permalink
Browse files

Document the available database migration tools.

Resolve #46.
  • Loading branch information...
1 parent 67f7f2e commit d388e3f3e1bc93b6179318ee2869998d31f2565f @lastland lastland committed May 21, 2016
Showing with 27 additions and 0 deletions.
  1. +1 −0 slick/src/sphinx/index.rst
  2. +26 −0 slick/src/sphinx/migrations.rst
@@ -31,6 +31,7 @@ User Manual
orm-to-slick
sql-to-slick
upgrade
+ migrations
Appendix
________
@@ -0,0 +1,26 @@
+Database Migrations
+===========================
+Slick itself does not support database migrations, but there are some
+third-party tools that work well with Slick. This page provides a list
+of them.
+
+Scala Forklift
+---------------------------
+`Scala Forklift <https://github.com/lastland/scala-forklift>`_ is a
+type-safe data migration tool with great supports for Slick. Users can
+define their database migrations using either type-safe Slick queries
+or plain SQL queries. Scala Forklift will automatically apply the
+unapplied user-defined database migrations in the right order, and
+manage the Scala code corresponding to the database schemas using
+the Slick code generator.
+
+An example can be found `here <https://github.com/lastland/scala-forklift/tree/develop/example>`_.
+
+An example of using Play, Slick, and Forklift can be found `here <https://github.com/lastland/play-slick-forklift-example>`_.
+
+slick-migration-api
+--------------------------
+`slick-migration-api <https://github.com/nafg/slick-migration-api>`_ is a
+library for defining database migrations, for use with Slick. It supports
+altering database schemas using a type-safe Scala DSL. Unfortunately, it
+does not support Slick of version 3.0 or later for the time being.

0 comments on commit d388e3f

Please sign in to comment.