atlasdb

package

v0.0.0-...-8e88d4a Latest Latest Go to latest Published: Jan 22, 2024 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package atlasdb implements sqlite3 database storage for accounts and other atlas data.

This section is empty.

This section is empty.

This section is empty.

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

DB stores atlas data in a sqlite3 database.

func Open(name string) (*DB, error)

Open opens a DB from the provided sqlite3 filename.

func (db *DB) Close() error

func (db *DB) GetAccount(uid uint64) (*api0.Account, error)

func (db *DB) GetUIDsByUsername(username string) ([]uint64, error)

func (db *DB) MigrateDown(ctx context.Context, to uint64) error

MigrateDown migrates the database down to the provided version. This will probably eat your data.

func (db *DB) MigrateUp(ctx context.Context, to uint64) error

MigrateUp migrates the database to the provided version.

func (db *DB) SaveAccount(a *api0.Account) error

func (db *DB) Version() (current, required uint64, err error)

Version gets the current and required database versions. It should be checked before using the database.