README
¶
Simple Bolt
Simple way to use the Bolt database. Similar design to simpleredis.
Online API Documentation
Features and limitations
- Supports simple use of lists, hashmaps, sets and key/values
- Deals mainly with strings
Example usage
package main
import (
"log"
"github.com/xyproto/simplebolt"
)
func main() {
// New bolt database
db, err := simplebolt.New("bolt.db")
if err != nil {
log.Fatalf("Could not create database! %s", err)
}
defer db.Close()
// Create a list named "greetings"
list, err := simplebolt.NewList(db, "greetings")
if err != nil {
log.Fatalf("Could not create a list! %s", err)
}
// Add "hello" to the list
if err := list.Add("hello"); err != nil {
log.Fatalf("Could not add an item to the list! %s", err)
}
// Get the last item of the list
if item, err := list.GetLast(); err != nil {
log.Fatalf("Could not fetch the last item from the list! %s", err)
} else {
log.Println("The value of the stored item is:", item)
}
// Remove the list
if err := list.Remove(); err != nil {
log.Fatalf("Could not remove the list! %s", err)
}
}
Version, license and author
- License: MIT
- API version: 3.0
- Author: Alexander F Rødseth xyproto@archlinux.org
Documentation
¶
Overview ¶
Package simplebolt provides a simple way to use the Bolt database. The API design is similar to xyproto/simpleredis, and the database backends are interchangeable, by using the xyproto/pinterface package.
Index ¶
- Constants
- Variables
- type BoltCreator
- type Database
- type HashMap
- func (h *HashMap) All() (results []string, err error)
- func (h *HashMap) Clear() error
- func (h *HashMap) Del(elementid string) error
- func (h *HashMap) DelKey(elementid, key string) error
- func (h *HashMap) Exists(elementid string) (found bool, err error)
- func (h *HashMap) Get(elementid, key string) (val string, err error)
- func (h *HashMap) Has(elementid, key string) (found bool, err error)
- func (h *HashMap) Keys(owner string) ([]string, error)
- func (h *HashMap) Remove() error
- func (h *HashMap) Set(elementid, key, value string) (err error)
- type KeyValue
- type KeyValueB
- type List
- type Set
Constants ¶
View Source
const (
// Version number. Stable API within major version numbers.
Version = 3.0
)
Variables ¶
View Source
var ( ErrBucketNotFound = errors.New("Bucket not found") ErrKeyNotFound = errors.New("Key not found") ErrDoesNotExist = errors.New("Does not exist") ErrFoundIt = errors.New("Found it") ErrExistsInSet = errors.New("Element already exists in set") ErrInvalidID = errors.New("Element ID can not contain \":\"") )
Functions ¶
This section is empty.
Types ¶
type BoltCreator ¶
type BoltCreator struct {
// contains filtered or unexported fields
}
func NewCreator ¶
func NewCreator(db *Database) *BoltCreator
func (*BoltCreator) NewHashMap ¶
func (b *BoltCreator) NewHashMap(id string) (pinterface.IHashMap, error)
func (*BoltCreator) NewKeyValue ¶
func (b *BoltCreator) NewKeyValue(id string) (pinterface.IKeyValue, error)
func (*BoltCreator) NewList ¶
func (b *BoltCreator) NewList(id string) (pinterface.IList, error)
func (*BoltCreator) NewSet ¶
func (b *BoltCreator) NewSet(id string) (pinterface.ISet, error)
type HashMap ¶
type HashMap boltBucket
func (*HashMap) DelKey ¶
Remove a key for an entry in a hashmap (for instance the email field for a user)
func (*HashMap) Get ¶
Get a value from a hashmap given the element id (for instance a user id) and the key (for instance "password")
type KeyValue ¶
type KeyValue boltBucket
func NewKeyValue ¶
Create a new key/value if it does not already exist
type KeyValueB ¶
type KeyValueB struct {
// contains filtered or unexported fields
}
func NewKeyValueB ¶
Create a new key/value if it does not already exist
type List ¶
type List boltBucket
The wrapped datatypes
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.