Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lastland/scala-forklift
Type-safe data migration tool for Slick, Git and beyond.
https://github.com/lastland/scala-forklift
database-migrations scala slick
Last synced: 6 days ago
JSON representation
Type-safe data migration tool for Slick, Git and beyond.
- Host: GitHub
- URL: https://github.com/lastland/scala-forklift
- Owner: lastland
- License: other
- Created: 2015-08-18T16:26:21.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2024-08-19T14:36:15.000Z (5 months ago)
- Last Synced: 2024-10-11T21:52:25.532Z (3 months ago)
- Topics: database-migrations, scala, slick
- Language: Scala
- Homepage:
- Size: 309 KB
- Stars: 188
- Watchers: 11
- Forks: 31
- Open Issues: 15
-
Metadata Files:
- Readme: README.markdown
- License: LICENSE
Awesome Lists containing this project
- awesome-scala - Scala-Forklift ★ 91 ⧗ 1 - Type-safe database migration for Slick, Git, etc. (Database)
- awesome-scala - scala-forklift - safe data migration tool for Slick, Git and beyond. |   (Table of Contents / Database)
README
# Scala-Forklift
[](https://circleci.com/gh/lastland/scala-forklift)
[](https://gitter.im/lastland/scala-forklift?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Scala-Forklift helps manage and apply database migrations for your Scala project.
Write your migrations in plain SQL:
```scala
MyMigrations.migrations = MyMigrations.migrations :+ SqlMigration(1)(List(
sqlu"""create table "users" ("id" INTEGER NOT NULL PRIMARY KEY,"first" VARCHAR NOT NULL,"last" VARCHAR NOT NULL)"""
))
```
Or type-safe Slick queries:
``` scala
MyMigrations.migrations = MyMigrations.migrations :+ DBIOMigration(2)(
DBIO.seq(Users ++= Seq(
UsersRow(1, "Chris","Vogt"),
UsersRow(2, "Yao","Li")
)))
```
Or use [slick-migration-api](https://github.com/nafg/slick-migration-api):
``` scala
MyMigrations.migrations = MyMigrations.migrations :+ APIMigration(3)(
TableMigration(Users).
renameColumn(_.first, "firstname").
renameColumn(_.last, "lastname"))
```
(Note: `APIMigration` is not supported in versions prior to `v0.2.3`)
Don't worry about keeping the Scala code and your database schema consistent. Our source code generator will have it generated for you.
**Key Features**:
- Supports for type-safe database migration with [Slick](https://github.com/slick/slick) and [slick-migration-api](https://github.com/nafg/slick-migration-api).
- A source code generator to generate and manage Scala models from your database schemas.
- A tool to help you manage your dev db with git, with supports for branching and merging.
- High customizability.
## How to Use
Scala-Forklift supports both Slick 3.1 and Slick 3.2. The latest versions of Scala-Forklift are given below:
| Scala Version | Slick Version | SBT dependency |
|----------------|---------------|----------------|
| 2.11.x | `3.1.x` | `libraryDependencies += "com.liyaos" %% "scala-forklift-slick" % "0.2.3"` |
| 2.12.x, 2.11.x | `3.2.x` | `libraryDependencies += "com.liyaos" %% "scala-forklift-slick" % "0.3.1"` |
| 2.13.x, 2.12.x | `3.3.x` | `libraryDependencies += "com.liyaos" %% "scala-forklift-slick" % "0.3.2"` |
For tutorial and example code, please check [example](/example).
Here is also a wonderful [tutorial](http://blog.novatec-gmbh.de/database-migration-slick-scala-forklift/) written by Andreas Burkard and Julian Tragé.
### Quick Start
You can use our start template on GitHub to quickly start a project with Scala-Forklift:
``` shell
git clone https://github.com/lastland/scala-forklift-start-template.git
```
## More Examples
- [Demo with Play and Slick](https://github.com/lastland/play-slick-forklift-example)
- [Demo with Quill](https://github.com/lastland/scala-forklift-quill)
## Known Issues
- The `reset` command may not correctly handle database schemas with foreign keys.