database

Documentation

Overview

Package database implements common functionality for database with gorm.

Index

• Variables
• type ConnectionURI
  • func (uri *ConnectionURI) String() string
• type Database
  • func (config *Database) AddMigration(m ...*gormigrate.Migration)
  • func (config *Database) AddMigrationTestdata(m ...*gormigrate.Migration)
  • func (config *Database) Migrate() error
  • func (config *Database) MigrateTestdata() error
  • func (config *Database) ReMigrate(id string) error
  • func (config *Database) ReRun() error
  • func (config *Database) Run() error
  • func (config *Database) Status() error

Variables

var (
	// ErrNotConnected - database is not connected
	ErrNotConnected = errors.New("database is not connected")
	// ErrNothingToMigrate if nothing has to be migrated
	ErrNothingToMigrate = errors.New("there is nothing to migrate")
)

Types

type ConnectionURI

type ConnectionURI struct {
	URI          string `config:"string"`
	Hostname     string `config:"hostname"`
	Username     string `config:"username"`
	Password     string `config:"password"`
	DatabaseName string `config:"dbname"`
	ExtraOptions string `config:"extra_options"`
}

func (*ConnectionURI) String

func (uri *ConnectionURI) String() string

type Database

type Database struct {
	DB         *gorm.DB        `config:"-" toml:"-"`
	Connection ConnectionURI   `config:"connection" toml:"connection"`
	Debug      bool            `config:"debug" toml:"debug"`
	Testdata   bool            `config:"testdata" toml:"testdata"`
	LogLevel   logger.LogLevel `config:"log_level" toml:"log_level"`
	// contains filtered or unexported fields
}

Database struct to read from config

func (*Database) AddMigration

func (config *Database) AddMigration(m ...*gormigrate.Migration)

AddMigration add to database config migration step

func (*Database) AddMigrationTestdata

func (config *Database) AddMigrationTestdata(m ...*gormigrate.Migration)

AddMigrationTestdata add to database config migration step of testdata

func (*Database) Migrate

func (config *Database) Migrate() error

Migrate run migration

func (*Database) MigrateTestdata

func (config *Database) MigrateTestdata() error

MigrateTestdata run migration and testdata migration

func (*Database) ReMigrate

func (config *Database) ReMigrate(id string) error

ReMigrate Rollback und run every migration step again till id

func (*Database) ReRun

func (config *Database) ReRun() error

ReRun database config - connect and re migration

func (*Database) Run

func (config *Database) Run() error

Run database config - connect and migrate

func (*Database) Status

func (config *Database) Status() error

Status get status - is database pingable