boltkv

Documentation

Index

• Constants
• type Config
  • func (s *Config) InitDefaults()
• type Configurer
• type Driver
  • func NewBoltDBDriver(log *zap.Logger, key string, cfgPlugin Configurer) (*Driver, error)
  • func (d *Driver) Clear() error
  • func (d *Driver) Delete(keys ...string) error
  • func (d *Driver) Get(key string) ([]byte, error)
  • func (d *Driver) Has(keys ...string) (map[string]bool, error)
  • func (d *Driver) MExpire(items ...*kvv1.Item) error
  • func (d *Driver) MGet(keys ...string) (map[string][]byte, error)
  • func (d *Driver) Set(items ...*kvv1.Item) error
  • func (d *Driver) Stop()
  • func (d *Driver) TTL(keys ...string) (map[string]string, error)

Constants

const (
	RootPluginName string = "kv"
)

Types

type Config

type Config struct {
	// File is boltDB file. No need to create it by your own,
	// boltdb driver is able to create the file, or read existing
	File string

	// db file permissions
	Permissions int
	// timeout
	Interval int `mapstructure:"interval"`
	// contains filtered or unexported fields
}

func (*Config) InitDefaults

func (s *Config) InitDefaults()

InitDefaults initializes default values for the boltdb

type Configurer

type Configurer interface {
	// UnmarshalKey takes a single key and unmarshal it into a Struct.
	UnmarshalKey(name string, out any) error
	// Has checks if config section exists.
	Has(name string) bool
}

type Driver

type Driver struct {

	// db instance
	DB *bolt.DB
	// contains filtered or unexported fields
}

func NewBoltDBDriver

func NewBoltDBDriver(log *zap.Logger, key string, cfgPlugin Configurer) (*Driver, error)

func (*Driver) Clear

func (d *Driver) Clear() error

func (*Driver) Delete

func (d *Driver) Delete(keys ...string) error

Delete all keys from DB

func (*Driver) Get

func (d *Driver) Get(key string) ([]byte, error)

Get retrieves the value for a key in the bucket. Returns a nil value if the key does not exist or if the key is a nested bucket. The returned value is only valid for the life of the transaction.

func (*Driver) Has

func (d *Driver) Has(keys ...string) (map[string]bool, error)

func (*Driver) MExpire

func (d *Driver) MExpire(items ...*kvv1.Item) error

MExpire sets the expiration time to the key If key already has the expiration time, it will be overwritten

func (*Driver) MGet

func (d *Driver) MGet(keys ...string) (map[string][]byte, error)

func (*Driver) Set

func (d *Driver) Set(items ...*kvv1.Item) error

Set puts the K/V to the bolt

func (*Driver) Stop

func (d *Driver) Stop()

func (*Driver) TTL

func (d *Driver) TTL(keys ...string) (map[string]string, error)