migrations: Update user-facing commands (sourcegraph#30411)

Author: efritz

dev/sg/sg_migration.go

@@ -34,8 +34,10 @@ var (
 		LongHelp:   cliutil.ConstructLongHelp(),
 	}
 
-	upCommand   = cliutil.Up("sg migration", runMigration, stdout.Out)
-	downCommand = cliutil.Down("sg migration", runMigration, stdout.Out)
+	upCommand     = cliutil.Up("sg migration", runMigration, stdout.Out)
+	upToCommand   = cliutil.UpTo("sg migration", runMigration, stdout.Out)
+	UndoCommand   = cliutil.Undo("sg migration", runMigration, stdout.Out)
+	downToCommand = cliutil.DownTo("sg migration", runMigration, stdout.Out)
 
 	migrationSquashFlagSet          = flag.NewFlagSet("sg migration squash", flag.ExitOnError)
 	migrationSquashDatabaseNameFlag = migrationSquashFlagSet.String("db", db.DefaultDatabase.Name, "The target database instance")
@@ -60,7 +62,9 @@ var (
 		Subcommands: []*ffcli.Command{
 			migrationAddCommand,
 			upCommand,
-			downCommand,
+			upToCommand,
+			UndoCommand,
+			downToCommand,
 			migrationSquashCommand,
 		},
 	}

internal/database/migration/cliutil/down.go

@@ -0,0 +1,62 @@
+package cliutil
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"strconv"
+
+	"github.com/peterbourgon/ff/v3/ffcli"
+
+	"github.com/sourcegraph/sourcegraph/internal/database/migration/runner"
+	"github.com/sourcegraph/sourcegraph/lib/output"
+)
+
+func DownTo(commandName string, run RunFunc, out *output.Output) *ffcli.Command {
+	var (
+		flagSet        = flag.NewFlagSet(fmt.Sprintf("%s downto", commandName), flag.ExitOnError)
+		schemaNameFlag = flagSet.String("db", "", `The target schema to migrate.`)
+		targetFlag     = flagSet.String("target", "", "Revert all children of the given target.")
+	)
+
+	exec := func(ctx context.Context, args []string) error {
+		if len(args) != 0 {
+			out.WriteLine(output.Linef("", output.StyleWarning, "ERROR: too many arguments"))
+			return flag.ErrHelp
+		}
+
+		if *schemaNameFlag == "" {
+			out.WriteLine(output.Linef("", output.StyleWarning, "ERROR: supply a schema via -db"))
+			return flag.ErrHelp
+		}
+
+		if *targetFlag == "" {
+			out.WriteLine(output.Linef("", output.StyleWarning, "ERROR: supply a migration target via -target"))
+			return flag.ErrHelp
+		}
+
+		version, err := strconv.Atoi(*targetFlag)
+		if err != nil {
+			return err
+		}
+
+		return run(ctx, runner.Options{
+			Operations: []runner.MigrationOperation{
+				{
+					SchemaName:    *schemaNameFlag,
+					Type:          runner.MigrationOperationTypeTargetedDown,
+					TargetVersion: version,
+				},
+			},
+		})
+	}
+
+	return &ffcli.Command{
+		Name:       "downto",
+		ShortUsage: fmt.Sprintf("%s downto -db=<schema> -target=<target>,<target>,...", commandName),
+		ShortHelp:  `Revert any applied migrations that are children of the given targets - this effectively "resets" the database to the target migration`,
+		FlagSet:    flagSet,
+		Exec:       exec,
+		LongHelp:   ConstructLongHelp(),
+	}
+}

internal/database/migration/cliutil/downto.go

@@ -26,7 +26,9 @@ func Flags(commandName string, run RunFunc, out *output.Output) *ffcli.Command {
 		},
 		Subcommands: []*ffcli.Command{
 			Up(commandName, run, out),
-			Down(commandName, run, out),
+			UpTo(commandName, run, out),
+			Undo(commandName, run, out),
+			DownTo(commandName, run, out),
 		},
 	}
 }

internal/database/migration/cliutil/flags.go

@@ -0,0 +1,49 @@
+package cliutil
+
+import (
+	"context"
+	"flag"
+	"fmt"
+
+	"github.com/peterbourgon/ff/v3/ffcli"
+
+	"github.com/sourcegraph/sourcegraph/internal/database/migration/runner"
+	"github.com/sourcegraph/sourcegraph/lib/output"
+)
+
+func Undo(commandName string, run RunFunc, out *output.Output) *ffcli.Command {
+	var (
+		flagSet        = flag.NewFlagSet(fmt.Sprintf("%s undo", commandName), flag.ExitOnError)
+		schemaNameFlag = flagSet.String("db", "", `The target schema to migrate.`)
+	)
+
+	exec := func(ctx context.Context, args []string) error {
+		if len(args) != 0 {
+			out.WriteLine(output.Linef("", output.StyleWarning, "ERROR: too many arguments"))
+			return flag.ErrHelp
+		}
+
+		if *schemaNameFlag == "" {
+			out.WriteLine(output.Linef("", output.StyleWarning, "ERROR: supply a schema via -db"))
+			return flag.ErrHelp
+		}
+
+		return run(ctx, runner.Options{
+			Operations: []runner.MigrationOperation{
+				{
+					SchemaName: *schemaNameFlag,
+					Type:       runner.MigrationOperationTypeRevert,
+				},
+			},
+		})
+	}
+
+	return &ffcli.Command{
+		Name:       "undo",
+		ShortUsage: fmt.Sprintf("%s undo -db=<schema>", commandName),
+		ShortHelp:  `Revert the last migration applied - useful in local development`,
+		FlagSet:    flagSet,
+		Exec:       exec,
+		LongHelp:   ConstructLongHelp(),
+	}
+}

internal/database/migration/cliutil/undo.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"flag"
 	"fmt"
+	"strings"
 
 	"github.com/peterbourgon/ff/v3/ffcli"
 
@@ -14,35 +15,30 @@ import (
 
 func Up(commandName string, run RunFunc, out *output.Output) *ffcli.Command {
 	var (
-		upFlagSet          = flag.NewFlagSet(fmt.Sprintf("%s up", commandName), flag.ExitOnError)
-		upDatabaseNameFlag = upFlagSet.String("db", "all", `The target database instance. Supply "all" (the default) to migrate all databases.`)
-		upTargetFlag       = upFlagSet.Int("target", 0, "Apply all migrations up to this target. Zero (the default) applies all migrations.")
+		flagSet        = flag.NewFlagSet(fmt.Sprintf("%s up", commandName), flag.ExitOnError)
+		schemaNameFlag = flagSet.String("db", "all", `The target schema(s) to migrate. Comma-separated values are accepted. Supply "all" (the default) to migrate all schemas.`)
 	)
 
-	execUp := func(ctx context.Context, args []string) error {
+	exec := func(ctx context.Context, args []string) error {
 		if len(args) != 0 {
 			out.WriteLine(output.Linef("", output.StyleWarning, "ERROR: too many arguments"))
 			return flag.ErrHelp
 		}
 
-		if *upDatabaseNameFlag == "all" && *upTargetFlag != 0 {
-			out.WriteLine(output.Linef("", output.StyleWarning, "ERROR: supply -db to migrate a specific database"))
+		schemaNames := strings.Split(*schemaNameFlag, ",")
+		if len(schemaNames) == 0 {
+			out.WriteLine(output.Linef("", output.StyleWarning, "ERROR: supply a schema via -db"))
 			return flag.ErrHelp
 		}
-
-		var databaseNames []string
-		if *upDatabaseNameFlag == "all" {
-			databaseNames = append(databaseNames, schemas.SchemaNames...)
-		} else {
-			databaseNames = append(databaseNames, *upDatabaseNameFlag)
+		if len(schemaNames) == 1 && schemaNames[0] == "all" {
+			schemaNames = schemas.SchemaNames
 		}
 
 		operations := []runner.MigrationOperation{}
-		for _, databaseName := range databaseNames {
+		for _, schemaName := range schemaNames {
 			operations = append(operations, runner.MigrationOperation{
-				SchemaName:    databaseName,
-				Type:          runner.MigrationOperationTypeTargetedUp,
-				TargetVersion: *upTargetFlag,
+				SchemaName: schemaName,
+				Type:       runner.MigrationOperationTypeUpgrade,
 			})
 		}
 
@@ -53,10 +49,10 @@ func Up(commandName string, run RunFunc, out *output.Output) *ffcli.Command {
 
 	return &ffcli.Command{
 		Name:       "up",
-		ShortUsage: fmt.Sprintf("%s up [-db=all] [-target=0]", commandName),
-		ShortHelp:  "Run up migrations",
-		FlagSet:    upFlagSet,
-		Exec:       execUp,
+		ShortUsage: fmt.Sprintf("%s up -db=<schema>", commandName),
+		ShortHelp:  "Apply all migrations",
+		FlagSet:    flagSet,
+		Exec:       exec,
 		LongHelp:   ConstructLongHelp(),
 	}
 }

internal/database/migration/cliutil/up.go

@@ -0,0 +1,62 @@
+package cliutil
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"strconv"
+
+	"github.com/peterbourgon/ff/v3/ffcli"
+
+	"github.com/sourcegraph/sourcegraph/internal/database/migration/runner"
+	"github.com/sourcegraph/sourcegraph/lib/output"
+)
+
+func UpTo(commandName string, run RunFunc, out *output.Output) *ffcli.Command {
+	var (
+		flagSet        = flag.NewFlagSet(fmt.Sprintf("%s upto", commandName), flag.ExitOnError)
+		schemaNameFlag = flagSet.String("db", "", `The target schema to migrate.`)
+		targetFlag     = flagSet.String("target", "", "The migration to apply.")
+	)
+
+	exec := func(ctx context.Context, args []string) error {
+		if len(args) != 0 {
+			out.WriteLine(output.Linef("", output.StyleWarning, "ERROR: too many arguments"))
+			return flag.ErrHelp
+		}
+
+		if *schemaNameFlag == "" {
+			out.WriteLine(output.Linef("", output.StyleWarning, "ERROR: supply a schema via -db"))
+			return flag.ErrHelp
+		}
+
+		if *targetFlag == "" {
+			out.WriteLine(output.Linef("", output.StyleWarning, "ERROR: supply a migration target via -target"))
+			return flag.ErrHelp
+		}
+
+		version, err := strconv.Atoi(*targetFlag)
+		if err != nil {
+			return err
+		}
+
+		return run(ctx, runner.Options{
+			Operations: []runner.MigrationOperation{
+				{
+					SchemaName:    *schemaNameFlag,
+					Type:          runner.MigrationOperationTypeTargetedUp,
+					TargetVersion: version,
+				},
+			},
+		})
+	}
+
+	return &ffcli.Command{
+		Name:       "upto",
+		ShortUsage: fmt.Sprintf("%s upto -db=<schema> -target=<target>,<target>,...", commandName),
+		ShortHelp:  "Ensure a given migration has been applied - may apply dependency migrations",
+		FlagSet:    flagSet,
+		Exec:       exec,
+		LongHelp:   ConstructLongHelp(),
+	}
+}