boltdb

Documentation

Overview

Package boltdb provides tools for using Bolt as a standard persistence layer for services

Index

• Constants
• func NewDAO(ctx context.Context, driver string, dsn string, prefix string) (dao.DAO, error)
• type DAO
• type Handler
  • func (h *Handler) Compact(ctx context.Context, opts map[string]interface{}) (old int64, new int64, err error)
  • func (h *Handler) DB() *bolt.DB
  • func (h *Handler) Init(context.Context, configx.Values) error
  • func (h *Handler) LocalAccess() bool

Constants

const Driver = "boltdb"

Functions

func NewDAO

func NewDAO(ctx context.Context, driver string, dsn string, prefix string) (dao.DAO, error)

NewDAO creates a new handler for the boltdb dao

Types

type DAO

type DAO interface {
	dao.DAO
	DB() *bolt.DB
	Compact(ctx context.Context, opts map[string]interface{}) (int64, int64, error)
}

DAO defines the functions specific to the boltdb dao

type Handler

type Handler struct {
	dao.DAO
	// contains filtered or unexported fields
}

Handler for the main functions of the DAO

func (*Handler) Compact

func (h *Handler) Compact(ctx context.Context, opts map[string]interface{}) (old int64, new int64, err error)

Compact makes a copy of the current DB and replace it as a connection

func (*Handler) DB

func (h *Handler) DB() *bolt.DB

DB returns the bolt DB object

func (*Handler) Init

func (h *Handler) Init(context.Context, configx.Values) error

Init initialises the handler

func (*Handler) LocalAccess

func (h *Handler) LocalAccess() bool

LocalAccess overrides DAO