boltdbclient

package module

v0.0.0-...-e76f0cb Latest Latest Go to latest Published: Oct 24, 2017 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/vpugar/boltdbclient

Links

Open Source Insights

README ¶

Simple BoltDB Client

Simple client with utility methods for

opening and closing DB - Open, Close
creation of initial entities (for example buckets) - InitEntity
read transaction with callback - ReadTransaction
write transaction with callback - WriteTransaction
delete entry from bucket - DeleteWithTransaction
find nested bucked according to path - FindBucket

Documentation ¶

Index ¶

Constants
func DeferRollback(tx *bolt.Tx, success *bool)
func FindBucket(b *bolt.Bucket, path []string) (*bolt.Bucket, string)
func I2B(v uint64) []byte
type Client
- func NewClient(config Config) *Client
type Config
- func NewConfig() Config
- func (config Config) Validate() error
- func (c *Config) WithDefaults() *Config
type TransactionCallback

Constants ¶

View Source

const (
	// DefaultBindAddress is the default binding interface if none is specified.
	DefaultDir      = ""
	DefaultFilename = "boltdb.db"
)

Variables ¶

This section is empty.

Functions ¶

func DeferRollback ¶

func DeferRollback(tx *bolt.Tx, success *bool)

func FindBucket ¶

func FindBucket(b *bolt.Bucket, path []string) (*bolt.Bucket, string)

Find nested bucked according to path. In case there is no some bucket in path, then return last not found name of bucket.

func I2B ¶

func I2B(v uint64) []byte

Types ¶

type Client ¶

type Client struct {
	Db *bolt.DB
	// contains filtered or unexported fields
}

Client represents a boltdbclient to the underlying BoltDB data store.

func NewClient ¶

func NewClient(config Config) *Client

Creates new client

func (*Client) Close ¶

func (c *Client) Close() error

Close closes then underlying BoltDB database.

func (*Client) DeleteWithTransaction ¶

func (client *Client) DeleteWithTransaction(bucket []byte, id string) error

Delete entry from bucket

func (*Client) InitEntity ¶

func (client *Client) InitEntity(initEntityCallback TransactionCallback) error

Creation of initial entities (for example buckets)

func (*Client) Open ¶

func (c *Client) Open() (string, error)

Open opens and initializes the BoltDB database.

func (*Client) Path ¶

func (c *Client) Path() string

func (*Client) ReadTransaction ¶

func (client *Client) ReadTransaction(read TransactionCallback) error

Read transaction with callback

func (*Client) WriteTransaction ¶

func (client *Client) WriteTransaction(write TransactionCallback) error

Write transaction with callback

type Config ¶

type Config struct {
	Dir      string `toml:"dir"`
	Filename string `toml:"filename"`
}

func NewConfig ¶

func NewConfig() Config

NewConfig returns a new instance of Config with defaults.

func (Config) Validate ¶

func (config Config) Validate() error

func (*Config) WithDefaults ¶

func (c *Config) WithDefaults() *Config

WithDefaults takes the given config and returns a new config with any required default values set.

type TransactionCallback ¶

type TransactionCallback func(*bolt.Tx) error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL