boltkv

package

v0.0.0-...-075775b Latest Latest Go to latest Published: Oct 25, 2023 License: MIT Imports: 5 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/ChrisRx/kvstore

Documentation ¶

Overview ¶

Package boltkv provides an implementation of the gRPC service KV using boltdb as a backend.

Index ¶

Constants
type BoltKV
- func NewBoltKV(path string, options ...BoltKVOption) (_ *BoltKV, err error)
type BoltKVOption
- func WithBucketName(bucket string) BoltKVOption

Constants ¶

View Source

const DefaultBoltBucketName = "kv"

DefaultBoltBucketName is the default bucket name used for the underlying boltdb for BoltKV.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BoltKV ¶

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

BoltKV represents a boltdb connection and implements the KVServer interface, allowing it to be used by the KV gRPC service.

func NewBoltKV ¶

func NewBoltKV(path string, options ...BoltKVOption) (_ *BoltKV, err error)

NewBoltKV takes the path and any functional options, and constructs a new BoltKV.

func (*BoltKV) Delete ¶

func (b *BoltKV) Delete(ctx context.Context, req *kvpb.DeleteRequest) (*emptypb.Empty, error)

Delete takes the provided DeleteRequest, containing a key to lookup, and deletes the key/value from the underlying boltdb storage. This will not check if a key is set before attempting to delete.

func (*BoltKV) Get ¶

func (b *BoltKV) Get(ctx context.Context, req *kvpb.GetRequest) (*kvpb.GetResponse, error)

Get takes the provided GetRequest, containing a key to lookup, and returns the key and value from the underlying boltdb storage. If the key is not set, an error is returned.

func (*BoltKV) Set ¶

func (b *BoltKV) Set(ctx context.Context, req *kvpb.SetRequest) (*emptypb.Empty, error)

Set takes the provided SetRequest, containing a key and the desired value, and sets this in the underlying boltdb storage. If a key is already set, the value will be overwritten.

type BoltKVOption ¶

type BoltKVOption func(*BoltKV)

BoltKVOption represents the function signature for any BoltKV functional options.

func WithBucketName ¶

func WithBucketName(bucket string) BoltKVOption

WithBucketName is a functional option for specifying a boltdb bucket name other than the default.

Source Files ¶

View all Source files

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