db

Documentation

Index

• func ExecStatements(db *gorm.DB, statements []string) error
• type Migrate
  • func Migrations() *Migrate
  • func (m *Migrate) Add(migration *gormigrate.Migration)
  • func (m *Migrate) Close() error
  • func (m *Migrate) Current() string
  • func (m *Migrate) Migrate() error
  • func (m *Migrate) MigrateNextTo(version string) error
  • func (m *Migrate) MigratePreviousTo(version string) error
  • func (m *Migrate) MigrateTo(version string) error
  • func (m *Migrate) NextFrom(version string) (string, error)
  • func (m *Migrate) PreviousFrom(version string) (string, error)
  • func (m *Migrate) Rollback() error
  • func (m *Migrate) RollbackTo(version string) error
  • func (m *Migrate) SetDB(db *gorm.DB) *Migrate
• type MigrationData
• type MigrationInfo
  • func (MigrationInfo) TableName() string
• type NewMigrationCommand
  • func (x *NewMigrationCommand) Execute(_ []string) error
  • func (x *NewMigrationCommand) FileExists(filename string) bool
• type ORM
  • func NewORM(config config.DatabaseConfig) *ORM
  • func (orm *ORM) CloseDB()
  • func (orm *ORM) CreateDB(config config.DatabaseConfig)

Functions

func ExecStatements

func ExecStatements(db *gorm.DB, statements []string) error

ExecStatements will execute a list of statements for the provided *gorm.DB. This method can be used to simplify migrations. Any other usage is discouraged.

Types

type Migrate

type Migrate struct {
	GORMigrate *gormigrate.Gormigrate
	// contains filtered or unexported fields
}

Migrate tool, decorates gormigrate.Migration in order to provide better interface & versioning.

func Migrations

func Migrations() *Migrate

Migrations returns default migrate.

func (*Migrate) Add

func (m *Migrate) Add(migration *gormigrate.Migration)

Add GORMigrate to migrate.

func (*Migrate) Close

func (m *Migrate) Close() error

Close db connection.

func (*Migrate) Current

func (m *Migrate) Current() string

Current migration version.

func (*Migrate) Migrate

func (m *Migrate) Migrate() error

Migrate all, including schema initialization.

func (*Migrate) MigrateNextTo

func (m *Migrate) MigrateNextTo(version string) error

MigrateNextTo migrate to next version from specified version.

func (*Migrate) MigratePreviousTo

func (m *Migrate) MigratePreviousTo(version string) error

MigratePreviousTo migrate to previous version from specified version.

func (*Migrate) MigrateTo

func (m *Migrate) MigrateTo(version string) error

MigrateTo specified version.

func (*Migrate) NextFrom

func (m *Migrate) NextFrom(version string) (string, error)

NextFrom returns next version from passed version.

func (*Migrate) PreviousFrom

func (m *Migrate) PreviousFrom(version string) (string, error)

PreviousFrom returns previous version from passed version.

func (*Migrate) Rollback

func (m *Migrate) Rollback() error

Rollback all migrations.

func (*Migrate) RollbackTo

func (m *Migrate) RollbackTo(version string) error

RollbackTo specified version.

func (*Migrate) SetDB

func (m *Migrate) SetDB(db *gorm.DB) *Migrate

SetDB to migrate.

type MigrationData

type MigrationData struct {
	Package string
	Version string
}

MigrationData contains base variables for the new migration.

type MigrationInfo

type MigrationInfo struct {
	ID string `gorm:"column:id; type:varchar(255)"`
}

MigrationInfo with migration info.

func (MigrationInfo) TableName

func (MigrationInfo) TableName() string

TableName for MigrationInfo.

type NewMigrationCommand

type NewMigrationCommand struct {
	Directory string `short:"d" long:"directory" default:"./migrations" description:"Directory where migration will be created"` // nolint:lll
}

NewMigrationCommand struct.

func (*NewMigrationCommand) Execute

func (x *NewMigrationCommand) Execute(_ []string) error

Execute migration generator command.

func (*NewMigrationCommand) FileExists

func (x *NewMigrationCommand) FileExists(filename string) bool

FileExists returns true if provided file exist and it's not directory.

type ORM

type ORM struct {
	DB *gorm.DB
}

ORM struct.

func NewORM

func NewORM(config config.DatabaseConfig) *ORM

NewORM will init new database connection.

func (*ORM) CloseDB

func (orm *ORM) CloseDB()

CloseDB close database connection.

func (*ORM) CreateDB

func (orm *ORM) CreateDB(config config.DatabaseConfig)

CreateDB connection using provided config.