badger

Documentation

Index

• type Database
  • func Open(name string) (*Database, error)
  • func (db *Database) Close(context.Context) error
  • func (db *Database) Create(_ context.Context, e database.Entry) error
  • func (db *Database) Lookup(_ context.Context, slug string) (e database.Entry, err error)
  • func (db *Database) Ping(context.Context) error
  • func (db *Database) Remove(_ context.Context, slug string) error

Types

type Database

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

Database is a wrapper around a badger database, providing high level functions to act a kipp entry database.

func Open

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

Open opens a new badger database.

func (*Database) Close

func (db *Database) Close(context.Context) error

Close closes the database.

func (*Database) Create

func (db *Database) Create(_ context.Context, e database.Entry) error

Create sets the key, slug with the gob encoded value of e.

func (*Database) Lookup

func (db *Database) Lookup(_ context.Context, slug string) (e database.Entry, err error)

Lookup looks up the named entry.

func (*Database) Ping

func (db *Database) Ping(context.Context) error

Ping pings the database.

func (*Database) Remove

func (db *Database) Remove(_ context.Context, slug string) error

Remove removes the key with the given slug.