storage

package module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 27, 2021 License: Apache-2.0 Imports: 6 Imported by: 1

README

storagedb

Storage DB Data Access Layer

Supported backends:

  • badger
  • boltdb
  • bbolt
  • pebbledb (like rocksdb)

Documentation

Index

Constants

View Source 
const NoTTL = 0

Variables

View Source 
var ErrNotFound = os.ErrNotExist
View Source 
var ManagedStorageClass = reflect.TypeOf((*ManagedStorage)(nil)).Elem()
View Source 
var StorageClass = reflect.TypeOf((*Storage)(nil)).Elem()
View Source 
var StorageManagementClass = reflect.TypeOf((*StorageManagement)(nil)).Elem()

Functions

This section is empty.

Types

type CompareAndSetOperation added in v0.2.0 

type CompareAndSetOperation struct {
	Storage
	// contains filtered or unexported fields
}

func (*CompareAndSetOperation) Binary added in v0.2.0 

func (t *CompareAndSetOperation) Binary(value []byte) (bool, error)

func (*CompareAndSetOperation) Bucket added in v0.2.0 

func (t *CompareAndSetOperation) Bucket(bucket []byte) *CompareAndSetOperation

func (*CompareAndSetOperation) ByKey added in v0.2.0 

func (t *CompareAndSetOperation) ByKey(formatKey string, args ...interface{}) *CompareAndSetOperation

func (*CompareAndSetOperation) ByRawKey added in v0.2.0 

func (t *CompareAndSetOperation) ByRawKey(key []byte) *CompareAndSetOperation

func (*CompareAndSetOperation) Proto added in v0.2.0 

func (t *CompareAndSetOperation) Proto(msg proto.Message) (bool, error)

func (*CompareAndSetOperation) String added in v0.2.0 

func (t *CompareAndSetOperation) String(value string) (bool, error)

func (*CompareAndSetOperation) WithTtl added in v0.2.0 

func (t *CompareAndSetOperation) WithTtl(ttlSeconds int) *CompareAndSetOperation

func (*CompareAndSetOperation) WithVersion added in v0.2.0 

func (t *CompareAndSetOperation) WithVersion(version int64) *CompareAndSetOperation

type EnumerateOperation 

type EnumerateOperation struct {
	Storage
	// contains filtered or unexported fields
}

func (*EnumerateOperation) Bucket 

func (t *EnumerateOperation) Bucket(bucket []byte) *EnumerateOperation

func (*EnumerateOperation) ByPrefix 

func (t *EnumerateOperation) ByPrefix(formatPrefix string, args ...interface{}) *EnumerateOperation

func (*EnumerateOperation) ByRawPrefix 

func (t *EnumerateOperation) ByRawPrefix(prefix []byte) *EnumerateOperation

func (*EnumerateOperation) Do 

func (t *EnumerateOperation) Do(cb func(key, value []byte, ttl int) bool) error

func (*EnumerateOperation) DoProto 

func (t *EnumerateOperation) DoProto(factory func() proto.Message, cb func(key []byte, value proto.Message, ttl int) bool) error

func (*EnumerateOperation) OnlyKeys 

func (t *EnumerateOperation) OnlyKeys() *EnumerateOperation

func (*EnumerateOperation) Seek 

func (t *EnumerateOperation) Seek(formatSeek string, args ...interface{}) *EnumerateOperation

func (*EnumerateOperation) WithBatchSize 

func (t *EnumerateOperation) WithBatchSize(batchSize int) *EnumerateOperation

type GetOperation 

type GetOperation struct {
	Storage
	// contains filtered or unexported fields
}

func (*GetOperation) Bucket 

func (t *GetOperation) Bucket(bucket []byte) *GetOperation

func (*GetOperation) ByKey 

func (t *GetOperation) ByKey(formatKey string, args ...interface{}) *GetOperation

func (*GetOperation) ByRawKey 

func (t *GetOperation) ByRawKey(key []byte) *GetOperation

func (*GetOperation) Required 

func (t *GetOperation) Required() *GetOperation

func (*GetOperation) ToBinary 

func (t *GetOperation) ToBinary() ([]byte, error)

func (*GetOperation) ToProto 

func (t *GetOperation) ToProto(container proto.Message) error

func (*GetOperation) ToString 

func (t *GetOperation) ToString() (string, error)

func (*GetOperation) WithVersion added in v0.2.0 

func (t *GetOperation) WithVersion(ptr *int64) *GetOperation

type ManagedStorage 

type ManagedStorage interface {
	Storage
	StorageManagement

	Instance() interface{}
}

type RemoveOperation 

type RemoveOperation struct {
	Storage
	// contains filtered or unexported fields
}

func (*RemoveOperation) Bucket 

func (t *RemoveOperation) Bucket(bucket []byte) *RemoveOperation

func (*RemoveOperation) ByKey 

func (t *RemoveOperation) ByKey(formatKey string, args ...interface{}) *RemoveOperation

func (*RemoveOperation) ByRawKey 

func (t *RemoveOperation) ByRawKey(key []byte) *RemoveOperation

func (*RemoveOperation) Do 

func (t *RemoveOperation) Do() error

type SetOperation added in v0.2.0 

type SetOperation struct {
	Storage
	// contains filtered or unexported fields
}

func (*SetOperation) Binary added in v0.2.0 

func (t *SetOperation) Binary(value []byte) error

func (*SetOperation) Bucket added in v0.2.0 

func (t *SetOperation) Bucket(bucket []byte) *SetOperation

func (*SetOperation) ByKey added in v0.2.0 

func (t *SetOperation) ByKey(formatKey string, args ...interface{}) *SetOperation

func (*SetOperation) ByRawKey added in v0.2.0 

func (t *SetOperation) ByRawKey(key []byte) *SetOperation

func (*SetOperation) Proto added in v0.2.0 

func (t *SetOperation) Proto(msg proto.Message) error

func (*SetOperation) String added in v0.2.0 

func (t *SetOperation) String(value string) error

func (*SetOperation) WithTtl added in v0.2.0 

func (t *SetOperation) WithTtl(ttlSeconds int) *SetOperation

type Storage 

type Storage interface {
	context.DisposableBean

	Get() *GetOperation

	Set() *SetOperation

	CompareAndSet() *CompareAndSetOperation

	Remove() *RemoveOperation

	Enumerate() *EnumerateOperation

	GetRaw(bucket, key []byte, required bool, versionPtr *int64) ([]byte, error)

	SetRaw(bucket, key, value []byte, ttlSeconds int) error

	CompareAndSetRaw(bucket, key, value []byte, ttlSeconds int, version int64) (bool, error)

	RemoveRaw(bucket, key []byte) error

	EnumerateRaw(bucket, seek []byte, batchSize int, onlyKeys bool, cb func(key, value []byte, ttl int) bool) error

	FetchKeysRaw(bucket []byte, batchSize int) ([][]byte, error)
}

type StorageManagement 

type StorageManagement interface {
	Compact(discardRatio float64) error

	Backup(w io.Writer, since uint64) (uint64, error)

	Restore(r io.Reader) error

	DropAll() error

	DropWithPrefix(prefix []byte) error
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.