v3.23.0

What's Changed

• Add WithLogger to NewProvider to allow custom loggers (#833)
• Update Provider WithVerbose behavior to log all SQL statements (#851)
• Upgrade dependencies and rebuild binaries with latest Go version (go1.23.3)

New Contributors

• @barloc made their first contribution in #810
• @vfoucault made their first contribution in #833
• @Fish1 made their first contribution in #853

Full Changelog: v3.22.1...v3.23.0

v3.22.1

• Upgrade dependencies and rebuild binaries with latest Go version (go1.23.1)

v3.22.0

Changelog

• Minimum Go version is now 1.21

• Add Unwrap to PartialError (#815)

• Allow flags anywhere on the CLI (#814)

  goose uses the default Go flag parsing library, which means flags must be defined before the
  first positional argument. We've updated this behavior to allow flags to be defined anywhere. For
  more details, see blog post.

• Update WithDisableGlobalRegistry behavior (#783). When set, this will ignore globally-registered
  migrationse entirely instead of the previous behavior of raising an error.

  This enables creating isolated goose provider(s) in legacy environments where global migrations may
  be registered. Without updating this behavior, it would be impossible to use
  WithDisableGlobalRegistry in combination with provider-scoped WithGoMigrations.

  Specifically, the following check is removed:

if len(global) > 0 {
  return nil, errors.New("global registry disabled, but provider has registered go migrations")
}

• Postgres, updated schema to use identity instead of serial and make tstamp not nullable (#556)

- id serial NOT NULL,
+ id integer PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY,

- tstamp timestamp NULL default now(),
+ tstamp timestamp NOT NULL DEFAULT now()

• MySQL, updated schema to not use SERIAL alias (#816)

- id serial NOT NULL,
+ id bigint(20) unsigned NOT NULL AUTO_INCREMENT,

v3.21.1

• Add GetVersions method to goose.Provider, returns the current (max db) version and the latest
  (max filesystem) version. (#756)
• Clarify GetLatestVersion method MUST return ErrVersionNotFound if no latest migration is
  found. Previously it was returning a -1 and nil error, which was inconsistent with the rest of the
  API surface.
• Add GetLatestVersion implementations to all existing dialects. This is an optimization to avoid
  loading all migrations when only the latest version is needed. This uses the max function in SQL
  to get the latest version_id irrespective of the order of applied migrations.
  • Refactor existing portions of the code to use the new GetLatestVersion method.

Note, v3.21.0 was retracted due to a reported user issue #779 with Go modules and replace directives when using go run, hence the patch bump to v3.21.1.

v3.21.0

Caution

Retracted, please use v3.21.1 instead.

v3.20.0

What's Changed

• Expand the Store interface by adding a GetLatestVersion method and make the interface public.
• Add a (non-blocking) method to check if there are pending migrations to the goose.Provider
  (#751):

func (p *Provider) HasPending(context.Context) (bool, error) {}

Note

The underlying implementation does not respect the SessionLocker (if one is enabled) and can
be used to check for pending migrations without blocking or being blocked by other operations.

• The methods .Up, .UpByOne, and .UpTo from goose.Provider will invoke .HasPending before
  acquiring a lock with SessionLocker (if enabled). This addresses an edge case in
  Kubernetes-style deployments where newer pods with long-running migrations prevent older pods -
  which have all known migrations applied - from starting up due to an advisory lock. For more
  details, refer to #507 (comment) and #751.
• Move integration tests to ./internal/testing and make it a separate Go module. This will allow
  us to have a cleaner top-level go.mod file and avoid imports unrelated to the goose project. See
  integration/README.md
  for more details. This shouldn't affect users of the goose library.

v3.19.2

• Remove duckdb support. The driver uses Cgo and we've decided to remove it until we can find a
  better solution. If you were using duckdb with goose, please let us know by opening an issue.

v3.19.1

• Fix selecting dialect for redshift
• Add GOOSE_MIGRATION_DIR documentation
• Bump github.com/opencontainers/runc to v1.1.12 (security fix)
• Update CI tests for go1.22
• Make goose annotations case-insensitive
  • All -- +goose annotations are now case-insensitive. This means that -- +goose Up and -- +goose up are now equivalent. This change was made to improve the user experience and to make the annotations more consistent.

New Contributors

• @jbking made their first contribution in #692
• @JosefuMealsom made their first contribution in #697
• @dpeckett made their first contribution in #696 (currently disabled until build is resolved, uses CGO. But thank you for the contribution 😄)
• @obalunenko made their first contribution in #704

v3.18.0

⚠️ Note, starting with goose v3.18.0 (current release) the minimum supported Go version is go1.20

New features

• Add environment variable substitution for SQL migrations. (#604)

  • This feature is disabled by default, and can be enabled by adding an annotation to the
    migration file:

    -- +goose ENVSUB ON

  • When enabled, goose will attempt to substitute environment variables in the SQL migration
    queries until the end of the file, or until the annotation -- +goose ENVSUB OFF is found. For
    example, if the environment variable REGION is set to us_east_1, the following SQL migration
    will be substituted to SELECT * FROM regions WHERE name = 'us_east_1';

    -- +goose ENVSUB ON
    -- +goose Up
    SELECT * FROM regions WHERE name = '${REGION}';

  • This feature intentionally supports a minimal expansion set; see Supported Expansions in the https://github.com/mfridman/interpolate repository (forked from https://github.com/buildkite/interpolate)

• Add native Turso support with libsql driver. (#658)

Fixes

• Fixed query for list migrations in YDB (#684)

v3.17.0

• Standardised the MIT license (#647)
• Improve provider Apply() errors, add ErrNotApplied when attempting to rollback a migration
  that has not been previously applied. (#660)
• Add WithDisableGlobalRegistry option to NewProvider to disable the global registry. (#645)
• Add -timeout flag to CLI to set the maximum allowed duration for queries to run. Default remains
  no timeout. (#627)
• Add optional logging in Provider when WithVerbose option is supplied. (#668)

⚠️ Potential Breaking Change ⚠️

• Update goose create to use UTC time instead of local time. (#242)