database

Documentation

Index

• Variables
• func AppSchemaVersion() uint
• func Backup(db *sqlx.DB, backupPath string) error
• func Close() error
• func DatabaseBackupPath() string
• func DatabasePath() string
• func Initialize(databasePath string) error
• func NeedsMigration() bool
• func Ready() error
• func Reset(databasePath string) error
• func RestoreFromBackup(backupPath string) error
• func RunMigrations() error
• func Version() uint
• func WithTxn(fn func(tx *sqlx.Tx) error) error

Variables

var (
	// ErrMigrationNeeded indicates that a database migration is needed
	// before the database can be initialized
	ErrMigrationNeeded = errors.New("database migration required")

	// ErrDatabaseNotInitialized indicates that the database is not
	// initialized, usually due to an incomplete configuration.
	ErrDatabaseNotInitialized = errors.New("database not initialized")
)

var DB *sqlx.DB

var WriteMu sync.Mutex

Functions

func AppSchemaVersion

func AppSchemaVersion() uint

func Backup

func Backup(db *sqlx.DB, backupPath string) error

Backup the database. If db is nil, then uses the existing database connection.

func Close

func Close() error

func DatabaseBackupPath

func DatabaseBackupPath() string

func DatabasePath

func DatabasePath() string

func Initialize

func Initialize(databasePath string) error

Initialize initializes the database. If the database is new, then it performs a full migration to the latest schema version. Otherwise, any necessary migrations must be run separately using RunMigrations. Returns true if the database is new.

func NeedsMigration

func NeedsMigration() bool

Migrate the database

func Ready

func Ready() error

Ready returns an error if the database is not ready to begin transactions.

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 WithTxn

func WithTxn(fn func(tx *sqlx.Tx) error) error

WithTxn executes the provided function within a transaction. It rolls back the transaction if the function returns an error, otherwise the transaction is committed.