Migrations: Implement "photoprism migrations ls" command #2216

Lists the status of migrations. Changed "migrate" to "migrations run".

internal/commands/migrations.go

@@ -0,0 +1,156 @@
+package commands
+
+import (
+	"context"
+	"fmt"
+	"strings"
+	"time"
+
+	"github.com/sirupsen/logrus"
+	"github.com/urfave/cli"
+
+	"github.com/photoprism/photoprism/internal/config"
+	"github.com/photoprism/photoprism/internal/migrate"
+)
+
+// MigrationsCommand registers the "migrations" CLI command.
+var MigrationsCommand = cli.Command{
+	Name:  "migrations",
+	Usage: "Database schema migration subcommands",
+	Subcommands: []cli.Command{
+		{
+			Name:      "ls",
+			Aliases:   []string{"status", "show"},
+			Usage:     "Lists the status of schema migrations",
+			ArgsUsage: "[migrations...]",
+			Action:    migrationsStatusAction,
+		},
+		{
+			Name:      "run",
+			Aliases:   []string{"execute", "migrate"},
+			Usage:     "Executes database schema migrations",
+			ArgsUsage: "[migrations...]",
+			Flags: []cli.Flag{
+				cli.BoolFlag{
+					Name:  "failed, f",
+					Usage: "run previously failed migrations",
+				},
+				cli.BoolFlag{
+					Name:  "trace, t",
+					Usage: "show trace logs for debugging",
+				},
+			},
+			Action: migrationsRunAction,
+		},
+	},
+}
+
+// migrationsStatusAction lists the status of schema migration.
+func migrationsStatusAction(ctx *cli.Context) error {
+	conf := config.NewConfig(ctx)
+
+	_, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
+	if err := conf.Init(); err != nil {
+		return err
+	}
+
+	defer conf.Shutdown()
+
+	var ids []string
+
+	// Check argument for specific migrations to be run.
+	if migrations := strings.TrimSpace(ctx.Args().First()); migrations != "" {
+		ids = strings.Fields(migrations)
+	}
+
+	db := conf.Db()
+
+	status, err := migrate.Status(db, ids)
+
+	if err != nil {
+		return err
+	}
+
+	// Display value names.
+	fmt.Printf("%-17s %-9s %-21s %-21s %s\n", "ID", "Dialect", "Started At", "Finished At", "Status")
+
+	// Show migrations.
+	for _, m := range status {
+		var started, finished, info string
+
+		if m.StartedAt.IsZero() {
+			started = "-"
+		} else {
+			started = m.StartedAt.Format("2006-01-02 15:04:05")
+		}
+
+		if m.Finished() {
+			finished = m.FinishedAt.Format("2006-01-02 15:04:05")
+		} else {
+			finished = "-"
+		}
+
+		if m.Error != "" {
+			info = m.Error
+		} else if m.Finished() {
+			info = "OK"
+		} else if m.StartedAt.IsZero() {
+			info = "-"
+		} else if m.Repeat(false) {
+			info = "Repeat"
+		} else {
+			info = "Running?"
+		}
+
+		fmt.Printf("%-17s %-9s %-21s %-21s %s\n", m.ID, m.Dialect, started, finished, info)
+	}
+
+	return nil
+}
+
+// migrationsRunAction executes database schema migrations.
+func migrationsRunAction(ctx *cli.Context) error {
+	start := time.Now()
+
+	conf := config.NewConfig(ctx)
+
+	_, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
+	if err := conf.Init(); err != nil {
+		return err
+	}
+
+	defer conf.Shutdown()
+
+	if ctx.Bool("trace") {
+		log.SetLevel(logrus.TraceLevel)
+		log.Infoln("migrate: enabled trace mode")
+	}
+
+	runFailed := ctx.Bool("failed")
+
+	if runFailed {
+		log.Infoln("migrate: running previously failed migrations")
+	}
+
+	var ids []string
+
+	// Check argument for specific migrations to be run.
+	if migrations := strings.TrimSpace(ctx.Args().First()); migrations != "" {
+		ids = strings.Fields(migrations)
+	}
+
+	log.Infoln("migrating database schema...")
+
+	// Run migrations.
+	conf.MigrateDb(runFailed, ids)
+
+	elapsed := time.Since(start)
+
+	log.Infof("migration completed in %s", elapsed)
+
+	return nil
+}