Development Roadmap for v3

[mfridman]

This meta-issue captures upcoming improvements planned for the /v3 module of goose.

There are no plans to make backwards-incompatible changes.

The goal is to add new functionality while keeping the existing implementation as-is. There were references to cutting a new major version /v4, but after a lot of thought, experimentation and feedback, we believe there's a way to evolve the goose package without forcing a new major version.

Below are specific areas in the library we'd like to tackle.

Enhancements / New features

• Adding a new *goose.Provider struct. Adding a goose provider  #379
  • no global state
  • safe for concurrent use
    • Goose isn't thread safe? 🤔  #587
  • a prerequisite for adding database locking
  • update CLI to use *goose.Provider
• Add locking mechanism
  • consider a generic Locker interface. Unlocks the ability for users to bring their own.
    • Allow custom locker implementations #575
  • Add locking mechanism to prevent parallel execution as a safety measure #335
• Add grouped migrations feature
  • Wrap all incoming migrations inside a single transaction #485
  • Run all SQL upgrade steps a single transaction #222
• Add repeatable migration support
  • Ability to add repeatable SQL migrations #472
• Add environment variable interpolation
  • feature: environment variable interpolation #347

Performance

...

Bug fixes

...

Misc

• Add timeout functionality
  • Timeout Flag #576
• Improve engine support in ClickHouse
  • Clickhouse allow_deprecated_syntax_for_merge_tree #535
  • Add replication support for ClickHouse state table + Fixes ListMigration query for ClickHouse #520
  • Add new -engine option #530
• Allow baseline and ignore migration support
  • Feature request: baseline/ignore migrations #431
• Consider callback functions to skip/run migrations
  • Migrations per environment #413
• Add YDB support
  • Feature/add ydb support #590
  • Add YDB support #592

[mfridman]

Closing this for now. It was intended to be used while we were adding the initial goose provider implementation.