database

Overview ¶

Package database provides a robust and flexible abstraction over GORM, supporting both SQLite and MySQL/MariaDB as backend databases.

It offers features such as automatic connection handling, schema migrations, and version tracking. The package also allows registering custom on-connect handlers that are executed once the database connection is successfully established.

Core features:

• Automatic (re)connection with health checks and retry mechanism
• Support for SQLite and MySQL/MariaDB with configurable parameters
• Schema management and automatic migrations
• Versioning support using the go-core/version package
• Connection lifecycle management (Connect, Disconnect, AwaitConnection)
• Thread-safe access with `Execute(func(db *gorm.DB) error)` wrapper
• Registering on-connect hooks to perform actions like seeding or setup

Example:

package main

import (
	"fmt"
	"time"

	"github.com/valentin-kaiser/go-core/database"
	"github.com/valentin-kaiser/go-core/flag"
	"github.com/valentin-kaiser/go-core/version"
	"gorm.io/gorm"
)

type User struct {
	gorm.Model
	Name     string
	Email    string `gorm:"unique"`
	Password string
}

func main() {
	flag.Init()

	database.RegisterSchema(&User{})
	database.RegisterMigrationStep(version.Version{
		GitTag:    "v1.0.0",
		GitCommit: "abc123",
	}, func(db *gorm.DB) error {
		// Custom migration logic
		return nil
	})

	database.Connect(time.Second, database.Config{
		Driver: "sqlite",
		Name:   "test",
	})
	defer database.Disconnect()

	database.AwaitConnection()

	var ver version.Version
	err := database.Execute(func(db *gorm.DB) error {
		return db.First(&ver).Error
	})
	if err != nil {
		panic(err)
	}

	fmt.Println("Version:", ver.GitTag, ver.GitCommit)
}