Skip to content

Commit

Permalink
Fix verifying migration docs (#4713)
Browse files Browse the repository at this point in the history
The verify task runs under `check` not `test`
  • Loading branch information
joshfriend committed Oct 11, 2023
1 parent 0b9795b commit 2eee6af
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/common/migrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ These SQL statements are run by the `Database.Schema.migrate()` method. Migratio

## Verifying Migrations

You can also place a `.db` file in the `src/main/sqldelight` folder of the same `<version number>.db` format. If there is a `.db` file present, a new `verifySqlDelightMigration` task will be added to the gradle project, and it will run as part of the `test` task, meaning your migrations will be verified against that `.db` file. It confirms that the migrations yield a database with the latest schema.
You can also place a `.db` file in the `src/main/sqldelight` folder of the same `<version number>.db` format. If there is a `.db` file present, a new `verifySqlDelightMigration` task will be added to the gradle project, and it will run as part of the `check` task, meaning your migrations will be verified against that `.db` file. It confirms that the migrations yield a database with the latest schema.

To generate a `.db` file from your latest schema, run the `generateSqlDelightSchema` task, which is available once you specify a `schemaOutputDirectory`, as described in the [gradle.md](gradle.md). You should probably do this before you create your first migration.

Expand Down

0 comments on commit 2eee6af

Please sign in to comment.