storage

package

v0.1.0-alpha.1 Latest Latest Go to latest Published: Oct 28, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/CodexCircle/Regulus

Links

Open Source Insights

Documentation ¶

Overview ¶

Package storage opens the hub database (SQLite) and applies its migrations.

Index ¶

Constants
func Migrate(ctx context.Context, db *sql.DB) error
func Open(ctx context.Context, dataDir string) (*sql.DB, error)

Constants ¶

View Source

const FileName = "regulus.db"

FileName is the name of the database file inside the data directory.

Variables ¶

This section is empty.

Functions ¶

func Migrate ¶

func Migrate(ctx context.Context, db *sql.DB) error

Migrate applies, in order and each in its own transaction, the embedded migrations that are not yet recorded in schema_migrations. It refuses to run on a database that has migrations this binary does not know, which means the database was written by a newer version of Regulus.

func Open ¶

func Open(ctx context.Context, dataDir string) (*sql.DB, error)

Open opens (creating it if needed) the database in dataDir and applies all pending migrations.

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL