db

README

db

Database abstractions for Snart.

Documentation

Overview

Package db contains a generic key:value database system.

Index

• type DB
  • func New(o opts.Opts) (*DB, error)
  • func Open(uri string) (*DB, error)
  • func (d *DB) Close() error
  • func (d *DB) Del(k string) error
  • func (d *DB) Get(k string, v interface{}) error
  • func (d *DB) Keys() ([]string, error)
  • func (d *DB) Set(k string, v interface{}) error
  • func (d *DB) String() string
  • func (d *DB) Table(k string) *DB

Types

type DB

type DB struct {
	Opts opts.Opts
	Impl impl.Impl
}

DB is a wrapper for a number of database implementations.

func New

func New(o opts.Opts) (*DB, error)

New creates a new DB with the given Opts.

func Open

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

Open creates a new DB from the given URI.

func (*DB) Close

func (d *DB) Close() error

Close wraps d.Impl.Close.

func (*DB) Del

func (d *DB) Del(k string) error

Del wraps d.Impl.Del.

func (*DB) Get

func (d *DB) Get(k string, v interface{}) error

Get wraps d.Impl.Get and json.Unmarshal.

func (*DB) Keys

func (d *DB) Keys() ([]string, error)

Keys wraps d.Impl.Keys.

func (*DB) Set

func (d *DB) Set(k string, v interface{}) error

Set wraps json.Marshal and d.Impl.Set.

func (*DB) String

func (d *DB) String() string

String returns the DB's URI, with "(table x.y.z)" appended if the Impl is a Table.

func (*DB) Table

func (d *DB) Table(k string) *DB

Table makes a new DB, with the same Opts and a Table that wraps the original Impl.