storage

Documentation

Index

• type Collection
  • func NewCollection(paths []string, txn DBTxn, parent *Collection) (*Collection, error)
  • func (c *Collection) Collection(id string) (*Collection, error)
  • func (c *Collection) Get(key string, v interface{}) (bool, error)
  • func (c *Collection) Path(path ...string) []string
  • func (c *Collection) Put(key string, v interface{}) error
  • func (c *Collection) String() string
• type DBRoot
• type DBTxn
• type Database
  • func Open(path string) (*Database, error)
  • func (d *Database) Close() error
  • func (d *Database) Collection(path string, txn DBTxn) (*Collection, error)
  • func (d *Database) Transaction(run TxnRunner) error
• type TxnRunner

Types

type Collection

type Collection struct {
	ID string
	// contains filtered or unexported fields
}

Collection represents a location in the database that holds keys and values This can be nested inside other Collections

func NewCollection

func NewCollection(paths []string, txn DBTxn, parent *Collection) (*Collection, error)

NewCollection recursively creates a collection starting at the given root

func (*Collection) Collection

func (c *Collection) Collection(id string) (*Collection, error)

Collection creates a nested collection

func (*Collection) Get

func (c *Collection) Get(key string, v interface{}) (bool, error)

Get returns a value from the collection by its key

func (*Collection) Path

func (c *Collection) Path(path ...string) []string

Path returns the path to the collection by traversing it's parents IDs

func (*Collection) Put

func (c *Collection) Put(key string, v interface{}) error

Put sets a value in the collection by its key

func (*Collection) String

func (c *Collection) String() string

String

type DBRoot

type DBRoot interface {
	DBTxn
	Get(key []byte) []byte
	Put(key []byte, data []byte) error
}

DBRoot an interface that describes a database storage root allowing you to store and retrieve data

type DBTxn

type DBTxn interface {
	Bucket(key []byte) *bolt.Bucket
	CreateBucketIfNotExists(key []byte) (*bolt.Bucket, error)
}

DBTxn an interface that describes a database storage root allow you to create nested roots

type Database

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

Database a storage interface

func Open

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

Open creates a connection to the database

func (*Database) Close

func (d *Database) Close() error

Close safely disconnects the database

func (*Database) Collection

func (d *Database) Collection(path string, txn DBTxn) (*Collection, error)

Collection creates a collection from the root at the given path Use a `/` to create a nested collection

func (*Database) Transaction

func (d *Database) Transaction(run TxnRunner) error

Transaction starts a transaction

type TxnRunner

type TxnRunner func(tx *bolt.Tx) error

TxnRunner a function that runs inside of a transaction If an error is returned the transaction is rolled back