slap

README

slap

Badger DB wrapper

Documentation

Index

• Variables
• type DB
• type Store
  • func New(path, schema string) *Store
  • func (p *Store) Create(data interface{}) ([]string, error)
  • func (p *Store) Delete(data interface{}, ids ...string) error
  • func (p *Store) Read(data interface{}, ftr []string, ids ...string) ([]interface{}, error)
  • func (p *Store) Select(x interface{}, ftr []string) ([]interface{}, error)
  • func (p *Store) Take(table interface{}, filter []string, seek string, limit int) ([]interface{}, error)
  • func (p *Store) Tidy()
  • func (p *Store) Update(data interface{}, ids ...string) error
  • func (p *Store) WithDB(f func(*badger.DB) error) (err error)

Variables

var (
	// ErrInvalidParameter ...
	ErrInvalidParameter = errors.New("invalid parameter")
	// ErrTypeConversion ...
	ErrTypeConversion = errors.New("type conversion")
	// ErrNoRecord ...
	ErrNoRecord = errors.New("record does not exist")
	// ErrReservedWord ...
	ErrReservedWord = errors.New("reserved identifier used")
	// ErrNoPrimaryID ...
	ErrNoPrimaryID = errors.New("primary ID field does not exist")
	// ErrMalformedKey ...
	ErrMalformedKey = errors.New("malformed key or zero key fields")
)

Types

type DB

type DB struct {
	*badger.DB
}

DB ...

type Store

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

Store ...

func New

func New(path, schema string) *Store

New ...

func (*Store) Create

func (p *Store) Create(data interface{}) ([]string, error)

Create accepts struct or slice of struct pointers Returns slice of record IDs saved

func (*Store) Delete

func (p *Store) Delete(data interface{}, ids ...string) error

Delete removes one or many records with given IDs Accepts a struct and variadic IDs

func (*Store) Read

func (p *Store) Read(data interface{}, ftr []string, ids ...string) ([]interface{}, error)

Read retrieves one or many records with given IDs Returns slice of interfaces

func (*Store) Select

func (p *Store) Select(x interface{}, ftr []string) ([]interface{}, error)

Select retrieves records ANDing non zero values Returns slice of interfaces

func (*Store) Take

func (p *Store) Take(table interface{}, filter []string, seek string, limit int) ([]interface{}, error)

Take ...

func (*Store) Tidy

func (p *Store) Tidy()

Tidy ...

func (*Store) Update

func (p *Store) Update(data interface{}, ids ...string) error

Update mofifies records with given IDs Non zero values are updated

func (*Store) WithDB

func (p *Store) WithDB(f func(*badger.DB) error) (err error)

WithDB ...