database

Documentation

Index

• Variables
• func AppSchemaVersion() uint
• func Backup(backupPath string) error
• func DatabaseBackupPath() string
• func Initialize(databasePath string)
• func NeedsMigration() bool
• func Reset(databasePath string) error
• func RestoreFromBackup(backupPath string) error
• func RunMigrations() error
• func Version() uint
• func WithInstance(instance *Packr2Source) (source.Driver, error)
• type Packr2Source
  • func (s *Packr2Source) Close() error
  • func (s *Packr2Source) First() (version uint, err error)
  • func (s *Packr2Source) Next(version uint) (nextVersion uint, err error)
  • func (s *Packr2Source) Open(url string) (source.Driver, error)
  • func (s *Packr2Source) Prev(version uint) (prevVersion uint, err error)
  • func (s *Packr2Source) ReadDown(version uint) (r io.ReadCloser, identifier string, err error)
  • func (s *Packr2Source) ReadUp(version uint) (r io.ReadCloser, identifier string, err error)

Variables

var DB *sqlx.DB

Functions

func AppSchemaVersion

func AppSchemaVersion() uint

func Backup

func Backup(backupPath string) error

Backup the database

func DatabaseBackupPath

func DatabaseBackupPath() string

func Initialize

func Initialize(databasePath string)

func NeedsMigration

func NeedsMigration() bool

Migrate the database

func Reset

func Reset(databasePath string) error

func RestoreFromBackup

func RestoreFromBackup(backupPath string) error

func RunMigrations

func RunMigrations() error

Migrate the database

func Version

func Version() uint

func WithInstance

func WithInstance(instance *Packr2Source) (source.Driver, error)

Types

type Packr2Source

type Packr2Source struct {
	Box        *packr.Box
	Migrations *source.Migrations
}

func (*Packr2Source) Close

func (s *Packr2Source) Close() error

func (*Packr2Source) First

func (s *Packr2Source) First() (version uint, err error)

func (*Packr2Source) Next

func (s *Packr2Source) Next(version uint) (nextVersion uint, err error)

func (*Packr2Source) Open

func (s *Packr2Source) Open(url string) (source.Driver, error)

func (*Packr2Source) Prev

func (s *Packr2Source) Prev(version uint) (prevVersion uint, err error)

func (*Packr2Source) ReadDown

func (s *Packr2Source) ReadDown(version uint) (r io.ReadCloser, identifier string, err error)

func (*Packr2Source) ReadUp

func (s *Packr2Source) ReadUp(version uint) (r io.ReadCloser, identifier string, err error)