db

Documentation

Index

• Constants
• func ExecuteMigrations(ctx context.Context, dbURL string, dir migrate.MigrationDirection, count int, ...) error
• func MigrateCmd(ctx context.Context, ...) *cobra.Command
• type DatabaseCommand
  • func (c *DatabaseCommand) Command(globalOptions *utils.GlobalOptionsType) *cobra.Command
• type SchemaMigrationManager
  • func NewSchemaMigrationManager(migrationRouter migrations.MigrationRouter, schemaName string, ...) (*SchemaMigrationManager, error)
  • func (m *SchemaMigrationManager) Close() error
  • func (m *SchemaMigrationManager) OrchestrateSchemaMigrations(ctx context.Context, dir migrate.MigrationDirection, count int) error

Constants

const DBConfigOptionFlagName = "database-url"

Functions

func ExecuteMigrations

func ExecuteMigrations(ctx context.Context, dbURL string, dir migrate.MigrationDirection, count int, migrationRouter migrations.MigrationRouter) error

ExecuteMigrations executes the migrations on the database, according with the direction, count and folder containing the migration files.

func MigrateCmd

func MigrateCmd(ctx context.Context, executeMigrationsFn func(ctx context.Context, dir migrate.MigrationDirection, count int) error) *cobra.Command

MigrateCmd returns a cobra.Command responsible for running the database migrations.

Types

type DatabaseCommand

type DatabaseCommand struct {
	// contains filtered or unexported fields
}

func (*DatabaseCommand) Command

func (c *DatabaseCommand) Command(globalOptions *utils.GlobalOptionsType) *cobra.Command

type SchemaMigrationManager

type SchemaMigrationManager struct {
	MigrationRouter   migrations.MigrationRouter
	SchemaName        string
	SchemaDatabaseDSN string
	// contains filtered or unexported fields
}

func NewSchemaMigrationManager

func NewSchemaMigrationManager(
	migrationRouter migrations.MigrationRouter,
	schemaName string,
	schemaDatabaseDSN string,
) (*SchemaMigrationManager, error)

func (*SchemaMigrationManager) Close

func (m *SchemaMigrationManager) Close() error

func (*SchemaMigrationManager) OrchestrateSchemaMigrations

func (m *SchemaMigrationManager) OrchestrateSchemaMigrations(ctx context.Context, dir migrate.MigrationDirection, count int) error