badger

Documentation

Index

• Variables
• type Database
  • func New(directoryPath string) (*Database, error)
  • func NewFromDB(service *badger.KV) (*Database, error)
  • func (db *Database) Async(useGoRoutines bool) *Database
  • func (db *Database) Cleanup() error
  • func (db *Database) Close() error
  • func (db *Database) Load(sid string) (storeDB sessions.RemoteStore)
  • func (db *Database) Sync(p sessions.SyncPayload)

Variables

var (
	DefaultFileMode = 0666
)

DefaultFileMode used as the default database's "fileMode" for creating the sessions directory path, opening and write the session file.

Types

type Database

type Database struct {
	// Service is the underline badger database connection,
	// it's initialized at `New` or `NewFromDB`.
	// Can be used to get stats.
	Service *badger.KV
	// contains filtered or unexported fields
}

Database the badger(key-value file-based) session storage.

func New

func New(directoryPath string) (*Database, error)

New creates and returns a new badger(key-value file-based) storage instance based on the "directoryPath". DirectoryPath should is the directory which the badger database will store the sessions, i.e ./sessions

It will remove any old session files.

func NewFromDB

func NewFromDB(service *badger.KV) (*Database, error)

NewFromDB same as `New` but accepts an already-created custom badger connection instead.

func (*Database) Async

func (db *Database) Async(useGoRoutines bool) *Database

Async if true passed then it will use different go routines to update the badger(key-value file-based) storage.

func (*Database) Cleanup

func (db *Database) Cleanup() error

Cleanup removes any invalid(have expired) session entries, it's being called automatically on `New` as well.

func (*Database) Close

func (db *Database) Close() error

Close shutdowns the badger connection.

func (*Database) Load

func (db *Database) Load(sid string) (storeDB sessions.RemoteStore)

Load loads the sessions from the badger(key-value file-based) session storage.

func (*Database) Sync

func (db *Database) Sync(p sessions.SyncPayload)

Sync syncs the database with the session's (memory) store.