Bbolt

A Bbolt storage driver using etcd-io/bbolt. Bolt is a pure Go key/value store inspired by Howard Chu's LMDB project. The goal of the project is to provide a simple, fast, and reliable database for projects that don't require a full database server such as Postgres or MySQL.

Table of Contents

• Signatures
• Installation
• Examples
• Config
• Default Config

Signatures

func New(config ...Config) Storage
func NewFromConnection(conn *bbolt.DB, config ...Config) *Storage
func (s *Storage) Get(key string) ([]byte, error)
func (s *Storage) GetWithContext(ctx context.Context, key string) ([]byte, error)
func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) SetWithContext(ctx context.Context, key string, val []byte, exp time.Duration) error
func (s *Storage) Delete(key string) error
func (s *Storage) DeleteWithContext(ctx context.Context, key string) error
func (s *Storage) Reset() error
func (s *Storage) ResetWithContext(ctx context.Context) error
func (s *Storage) Close() error
func (s *Storage) Conn() *bbolt.DB

Note: With ReadOnly set, Set, Delete and Reset return ErrReadOnly, which callers can match with errors.Is.

Note: ReadOnly opens the database without creating the bucket, so the bucket must already exist; New panics if it does not. Reset writes, so combining it with ReadOnly is rejected rather than silently ignored.

Note: If the configured bucket is dropped outside this driver, every method returns ErrBucketNotFound, which callers can match with errors.Is.

Note: Bbolt has no notion of key expiration, so the exp argument of Set is ignored and stored entries live until they are deleted or the storage is reset.

Note: Bbolt has no native context support, so the context methods run the operation to completion. They do honour a context that is already cancelled or past its deadline, returning the context error without touching the storage.

Installation

Bbolt is tested on the 2 last Go versions with support for modules. So make sure to initialize one first if you didn't do that yet:

go mod init github.com/<user>/<repo>

And then install the s3 implementation:

go get github.com/gofiber/storage/bbolt/v2

Examples

Import the storage package.

import "github.com/gofiber/storage/bbolt/v2"

You can use the following possibilities to create a storage:

// Initialize default config
store := bbolt.New()

// Initialize custom config
store := bbolt.New(bbolt.Config{
	Database: "my_database.db",
	Bucket:   "my-bucket",
	Reset:    false,
})

Config

// Config defines the config for storage.
type Config struct {
	// Database path
	//
	// Optional. Default is "fiber.db"
	Database string

	// Bbolt bucket name
	//
	// Optional. Default is "fiber_storage"
	Bucket string

	// Timeout is the amount of time to wait to obtain a file lock.
	// Only available on Darwin and Linux.
	//
	// Optional. Default is 60 * time.Second.
	Timeout time.Duration

	// Open database in read-only mode.
	//
	// Optional. Default is false
	ReadOnly bool

	// Reset clears any existing keys in existing Bucket
	//
	// Optional. Default is false
	Reset bool
}

Default Config

// ConfigDefault is the default config
var ConfigDefault = Config{
	Database: "fiber.db",
	Bucket:   "fiber_storage",
	Timeout:  60 * time.Second,
	ReadOnly: false,
	Reset:    false,
}

Using an Existing Bbolt Database

bbolt takes an exclusive lock on its file, so an application that already keeps a *bbolt.DB open cannot have the storage open the same file again. Pass the open database instead. Only the Bucket, Reset and ReadOnly options are read: a database opened with bbolt.Options{ReadOnly: true} makes the storage read-only on its own, so it needs no extra config, and setting ReadOnly yourself makes the storage read-only over a writable handle too.

The database stays yours to close: Close on a storage built this way leaves it open, so the rest of your application keeps working. The storage itself is closed: any operation on it afterwards returns ErrClosed.

import (
    bboltstorage "github.com/gofiber/storage/bbolt/v2"
    "go.etcd.io/bbolt"
)

func main() {
    conn, err := bbolt.Open("fiber.db", 0o666, nil)
    if err != nil {
        panic(err)
    }
    defer conn.Close()

    store := bboltstorage.NewFromConnection(conn, bboltstorage.Config{
        Bucket: "fiber_storage",
    })
    defer store.Close()
}