database

Documentation

Overview

Package database provides database initialization, migration, and management utilities for the 4y-ui panel using GORM with SQLite.

Index

• func Checkpoint() error
• func CloseDB() error
• func GetDB() *gorm.DB
• func InitDB(dbPath string) error
• func IsNotFound(err error) bool
• func IsSQLiteDB(file io.ReaderAt) (bool, error)
• func ValidateSQLiteDB(dbPath string) error

Functions

func Checkpoint

func Checkpoint() error

Checkpoint performs a WAL checkpoint on the SQLite database to ensure data consistency.

func CloseDB

func CloseDB() error

CloseDB closes the database connection if it exists.

func GetDB

func GetDB() *gorm.DB

GetDB returns the global GORM database instance.

func InitDB

func InitDB(dbPath string) error

InitDB sets up the database connection, migrates models, and runs seeders.

func IsNotFound

func IsNotFound(err error) bool

IsNotFound checks if the given error is a GORM record not found error.

func IsSQLiteDB

func IsSQLiteDB(file io.ReaderAt) (bool, error)

IsSQLiteDB checks if the given file is a valid SQLite database by reading its signature.

func ValidateSQLiteDB

func ValidateSQLiteDB(dbPath string) error

ValidateSQLiteDB opens the provided sqlite DB path with a throw-away connection and runs a PRAGMA integrity_check to ensure the file is structurally sound. It does not mutate global state or run migrations.