Create documentation

This commit is contained in:
2021-07-11 19:07:29 +02:00
parent b8331e7420
commit 414dec1f98
10 changed files with 288 additions and 1 deletions

View File

@@ -0,0 +1,16 @@
# Execute migration in application
```kotlin
import fr.postgresjson.migration.Migrations
import fr.postgresjson.connexion.Connection
val conn: Connection = TODO()
val migrations = Migrations(
conn,
this::class.java.getResource("/sql/migrations")?.toURI() ?: error("No migrations found"),
this::class.java.getResource("/sql/functions")?.toURI() ?: error("No sql function found")
)
migrations.status() // Show executed and not executed migrations
migrations.runDry() // Execute migration in transaction and rollback at the end
migrations.run() // Execute migration in transaction and commit if no error
```