persistence

package

v0.0.0-...-a657b10 Latest Latest Go to latest Published: Nov 29, 2021 License: MIT Imports: 9 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

This section is empty.

View Source

var (
	// DefaultPGURl is exported for testing purposes
	DefaultPGURL = "postgres://edhgo:edhgodev@localhost:5432/edhgo?sslmode=disable"
)

func NewDB(dbURL string) (*sql.DB, error)

NewDB returns a migrated app database or an error. If it is passed an empty string, it will attempt to connect to the default testing DB

func NewPostgres(migdir string, dbURL string) (*sql.DB, error)

NewPostgres returns a migrated sql.DB with a Postgres database connection migdir is the relative path to the migrations directory.

func NewRedis(url string, pass string, opts Config) (*redisDB, error)

NewRedis returns a new Redis Persistence that can be used in the application to persist and update state.

func NewSQLite(path string) (*sql.DB, error)

NewSQLite returns a DB object to persist data for the application.

type Config map[string]string

type KV interface {
	Put(key Key, val Value) (Value, error)
	Get(key Key) (Value, bool, error)
}

CLEANUP remove this interface KV is the KV store for the game engine to work with.

type Key string

Key is a type for handling and validating Keys in the game engine

func (k Key) String() (string, error)

String returns the string of the Key

type Persistence interface {
	Put(key Key, val Value) (Value, error)
	Get(key Key) (Value, bool, error)
}

Persistence allows us to use any database for persisting the state of this app if it can fulfill the Persistence layer.

type Value string

Value is a type for handling and validating Values in the game engine

func (v Value) String() (string, error)

String returns the string of Value.