Version 2.0.0 Alpha 1

[cljoly]

Please share feedback on this alpha version, in particular the breaking changes. We can still make more changes before the stable release.

Version 2.0.0 Alpha 1

Breaking changes

Remove the alpha-async-tokio-rusqlite Feature

As the name of the feature suggest, we have had experimental support for async using tokio for a while now. Supporting that feature has been quite a big burden, introducing some duplicated code in the AsyncMigrations struct in particular, as well as a whole set of very similar tests. Plus the benefit of async is limited here, because everything gets executed in a blocking fashion in sqlite anyway.

It turns out that we don’t need the async support in rusqlite_migration for folks to use async libraries. For instance, with tokio-rusqlite, you can define migrations like in the sync context and run:

    async_conn
        .call_unwrap(|conn| MIGRATIONS.to_latest(conn))
        .await?;

See the updated async example for details, in particular why it’s fine to call a method with unwrap in its name.

Make the Builder Finalizer Method Not Generic

On a related note, now that we have removed the AsyncMigrations (see the section right above) struct, we only have Migrations so there is no need for the MigrationsBuilder.finalize method to be generic. Thus we removed the generic argument. To update your code, you can just do this:

-        .finalize::<Migrations>());
+        .finalize());

Remove Migrations::new_iter

This function has been deprecated for a while now, remove it as a part of the major version bump. You can use the standard FromIter trait implementation instead.

Behavior Change

• When the user version field is altered by other code in your application, we are now returning an explicit error (Error::InvalidUserVersion) when this can be detected. Previously, the library would silently misbehave.

Dependencies

Rusqlite was updated from 0.32.1 to 0.34.0.
Please see the release notes for 0.34.0 and
the release notes for 0.33.0.
Tokio Rusqlite was removed as a dependency.

Features

• Migrations::new is now const

Minimum Rust Version

Rust 1.84.

Moving forward, we expect to keep this aligned with rusqlite itself, now that it has a policy (introduced in october 2024).

---

What's Changed

• test: add a test for new_iter by @cljoly in test: add a test for new_iter #203
• chore(deps): bump anyhow from 1.0.89 to 1.0.91 by @dependabot in chore(deps): bump anyhow from 1.0.89 to 1.0.91 #206
• chore(deps): bump tokio from 1.40.0 to 1.41.0 by @dependabot in chore(deps): bump tokio from 1.40.0 to 1.41.0 #205
• chore(deps): bump insta from 1.40.0 to 1.41.0 by @dependabot in chore(deps): bump insta from 1.40.0 to 1.41.0 #207
• chore(deps): bump tokio from 1.41.0 to 1.41.1 by @dependabot in chore(deps): bump tokio from 1.41.0 to 1.41.1 #211
• chore(deps): bump anyhow from 1.0.91 to 1.0.93 by @dependabot in chore(deps): bump anyhow from 1.0.91 to 1.0.93 #210
• chore(deps): bump insta from 1.41.0 to 1.41.1 by @dependabot in chore(deps): bump insta from 1.41.0 to 1.41.1 #208
• Make Migrations::new const by @MonterraByte in Make Migrations::new const #212
• chore: clippy fixes by @cljoly in chore: clippy fixes #215
• chore(deps): bump tokio from 1.41.1 to 1.42.0 by @dependabot in chore(deps): bump tokio from 1.41.1 to 1.42.0 #213
• chore(deps): bump anyhow from 1.0.93 to 1.0.94 by @dependabot in chore(deps): bump anyhow from 1.0.93 to 1.0.94 #214
• chore(deps): bump anyhow from 1.0.94 to 1.0.95 by @dependabot in chore(deps): bump anyhow from 1.0.94 to 1.0.95 #217
• chore(deps): bump env_logger from 0.11.5 to 0.11.6 by @dependabot in chore(deps): bump env_logger from 0.11.5 to 0.11.6 #216
• chore: Use ubuntu-latest in CI by @cljoly in chore: Use ubuntu-latest in CI #218
• chore: further tweak CI trigger logic by @cljoly in chore: further tweak CI trigger logic #220
• chore(deps): bump tokio from 1.42.0 to 1.43.0 by @dependabot in chore(deps): bump tokio from 1.42.0 to 1.43.0 #221
• chore(deps): bump log from 0.4.22 to 0.4.25 by @dependabot in chore(deps): bump log from 0.4.22 to 0.4.25 #222
• docs(README): link to examples and other tweaks by @cljoly in docs(README): link to examples and other tweaks #225
• chore(msrv): align MSRV with rusqlite by @cljoly in chore(msrv): align MSRV with rusqlite #224
• chore: update GH upload-artifact by @cljoly in chore: update GH upload-artifact #227
• doc: update the example to use lazylock instead of lazy_static by @cljoly in doc: update the example to use lazylock instead of lazy_static #177
• chore(deps): bump log from 0.4.25 to 0.4.26 by @dependabot in chore(deps): bump log from 0.4.25 to 0.4.26 #231
• chore(deps): bump anyhow from 1.0.95 to 1.0.97 by @dependabot in chore(deps): bump anyhow from 1.0.95 to 1.0.97 #233
• chore(deps): bump tokio from 1.43.0 to 1.44.0 by @dependabot in chore(deps): bump tokio from 1.43.0 to 1.44.0 #234
• chore!: remove async support by @cljoly in chore!: remove async support #232
• refactor!: remove Migrations::new_iter by @cljoly in refactor!: remove Migrations::new_iter #235
• chore(deps): bump tokio from 1.44.0 to 1.44.1 by @dependabot in chore(deps): bump tokio from 1.44.0 to 1.44.1 #237
• chore: update copyright and license notices by @cljoly in chore: update copyright and license notices #238
• chore(deps): use tokio-rusqlite-new and bump rusqlite to 0.34 by @xuxiaocheng0201 in chore(deps): use tokio-rusqlite-new and bump rusqlite to 0.34 #229
• test: cleanup after async removal by @cljoly in test: cleanup after async removal #239
• fix: return explicit errors when user_version is wrong by @cljoly in fix: return explicit errors when user_version is wrong #241
• doc: update changelog for 2.0 by @cljoly in doc: update changelog for 2.0 #242
• refactor: test code, add message to unreachable! by @cljoly in refactor: test code, add message to unreachable! #243
• docs: fix typo in README by @cljoly in docs: fix typo in README #244
• docs: fix changelog version by @cljoly in docs: fix changelog version #245

New Contributors

• @MonterraByte made their first contribution in Make Migrations::new const #212
• @xuxiaocheng0201 made their first contribution in chore(deps): use tokio-rusqlite-new and bump rusqlite to 0.34 #229

Full Changelog: v1.3.1...v2.0.0-alpha.1

---

This discussion was created from the release Version 2.0.0 Alpha 1.