Mukan Erkin Törük
26b204bd04
Some checks are pending
Docs Deploy / build_and_deploy (push) Waiting to run
Generate Docs / cli (push) Waiting to run
Generate Config Doc / cli (push) Waiting to run
Go formatting / go-formatting (push) Waiting to run
Check links / markdown-link-check (push) Waiting to run
Integration / pre-test (push) Waiting to run
Integration / test on (push) Blocked by required conditions
Integration / status (push) Blocked by required conditions
Lint / Lint Go code (push) Waiting to run
Test / test (ubuntu-latest) (push) Waiting to run
49 lines
1.4 KiB
Go
49 lines
1.4 KiB
Go
package modulemigration
|
|
|
|
import (
|
|
"fmt"
|
|
"path/filepath"
|
|
)
|
|
|
|
// Options represents the options to scaffold a module migration.
|
|
type Options struct {
|
|
ModuleName string
|
|
ModulePath string
|
|
FromVersion uint64
|
|
ToVersion uint64
|
|
}
|
|
|
|
// ModuleFile returns the path to the module definition file.
|
|
func (opts Options) ModuleFile() string {
|
|
return filepath.Join("x", opts.ModuleName, "module", "module.go")
|
|
}
|
|
|
|
// MigrationVersion returns the migration package name.
|
|
func (opts Options) MigrationVersion() string {
|
|
return fmt.Sprintf("v%d", opts.ToVersion)
|
|
}
|
|
|
|
// MigrationDir returns the path to the migration folder.
|
|
func (opts Options) MigrationDir() string {
|
|
return filepath.Join("x", opts.ModuleName, "migrations", opts.MigrationVersion())
|
|
}
|
|
|
|
// MigrationFile returns the path to the migration source file.
|
|
func (opts Options) MigrationFile() string {
|
|
return filepath.Join(opts.MigrationDir(), "migrate.go")
|
|
}
|
|
|
|
// MigrationFunc returns the migration handler function name.
|
|
func (opts Options) MigrationFunc() string {
|
|
return "Migrate"
|
|
}
|
|
|
|
// MigrationImportAlias returns the import alias used by module.go.
|
|
func (opts Options) MigrationImportAlias() string {
|
|
return fmt.Sprintf("migrationv%d", opts.ToVersion)
|
|
}
|
|
|
|
// MigrationImportPath returns the migration import path used by module.go.
|
|
func (opts Options) MigrationImportPath() string {
|
|
return fmt.Sprintf("%s/x/%s/migrations/%s", opts.ModulePath, opts.ModuleName, opts.MigrationVersion())
|
|
}
|