database

package

v0.2.4 Latest Latest Go to latest Published: Jan 3, 2026 License: AGPL-3.0 Imports: 10 Imported by: 0

Details

This section is empty.

This section is empty.

func RunMigrations(ctx context.Context, db model.DB, migrations []Migration) error

RunMigrations runs the given migrations on the database.

type Engine struct {
	// contains filtered or unexported fields
}

func New(databaseURI string) (*Engine, error)

type EngineWithMigrations struct {
	// contains filtered or unexported fields
}

EngineWithMigrations extends Engine with migration support

func NewWithMigrations(readURI, writeURI string) (*EngineWithMigrations, error)

NewWithMigrations creates a new Engine with read/write separation and migration support

func (e *EngineWithMigrations) Close() error

Close closes all database connections

func (e *EngineWithMigrations) GetDatabaseSchemaVersion(ctx context.Context) (string, error)

GetDatabaseSchemaVersion returns the current database schema version

func (e *EngineWithMigrations) ReaderDB() *sql.DB

ReaderDB returns the read database connection

func (e *EngineWithMigrations) SetDatabaseSchemaVersion(ctx context.Context, version string) error

SetDatabaseSchemaVersion sets the database schema version

func (e *EngineWithMigrations) WriterDB() *sql.DB

WriterDB returns the write database connection

type Migration struct {
	FromVersion   Version
	ToVersion     Version
	MigrationFunc func(db *sql.DB) error
}

Migration represents a database schema migration

func NewFileMigration(fromVersion, toVersion, filename string, migrationFiles embed.FS) (Migration, error)

NewFileMigration creates a new migration from an embedded file system.

func NewFuncMigration(fromVersion, toVersion string, migrationFunc func(db *sql.DB) error) (Migration, error)

NewFuncMigration creates a new migration from a function.

type Version = semver.Version

Version is a type alias for semver.Version for convenience

func ParseVersion(v string) (Version, error)

ParseVersion parses a version string