db

package

v0.0.0-...-6721946 Latest Latest Go to latest Published: Feb 19, 2024 License: LGPL-2.1 Imports: 17 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/mlayerprotocol/go-mlayer

Documentation ¶

Index ¶

Variables
func Key(key string) ds.Key
type Datastore
- func New(mainCtx *context.Context, keyStore string) *Datastore
- func NewDatastore(path string, options *Options) (*Datastore, error)
type Options

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrClosed = errors.New("datastore closed")

Functions ¶

func Key ¶

func Key(key string) ds.Key

Types ¶

type Datastore ¶

type Datastore struct {
	DB *badger.DB
	// contains filtered or unexported fields
}

func New ¶

func New(mainCtx *context.Context, keyStore string) *Datastore

func NewDatastore ¶

func NewDatastore(path string, options *Options) (*Datastore, error)

NewDatastore creates a new badger datastore.

DO NOT set the Dir and/or ValuePath fields of opt, they will be set for you.

func (*Datastore) Batch ¶

func (d *Datastore) Batch(ctx context.Context) (ds.Batch, error)

Batch creats a new Batch object. This provides a way to do many writes, when there may be too many to fit into a single transaction.

func (*Datastore) Close ¶

func (d *Datastore) Close() error

func (*Datastore) CollectGarbage ¶

func (d *Datastore) CollectGarbage(ctx context.Context) (err error)

func (*Datastore) Delete ¶

func (d *Datastore) Delete(ctx context.Context, key ds.Key) error

func (*Datastore) DiskUsage ¶

func (d *Datastore) DiskUsage(ctx context.Context) (uint64, error)

DiskUsage implements the PersistentDatastore interface. It returns the sum of lsm and value log files sizes in bytes.

func (*Datastore) Get ¶

func (d *Datastore) Get(ctx context.Context, key ds.Key) (value []byte, err error)

func (*Datastore) GetExpiration ¶

func (d *Datastore) GetExpiration(ctx context.Context, key ds.Key) (time.Time, error)

func (*Datastore) GetSize ¶

func (d *Datastore) GetSize(ctx context.Context, key ds.Key) (size int, err error)

func (*Datastore) Has ¶

func (d *Datastore) Has(ctx context.Context, key ds.Key) (bool, error)

func (*Datastore) NewTransaction ¶

func (d *Datastore) NewTransaction(ctx context.Context, readOnly bool) (ds.Txn, error)

NewTransaction starts a new transaction. The resulting transaction object can be mutated without incurring changes to the underlying Datastore until the transaction is Committed.

func (*Datastore) Put ¶

func (d *Datastore) Put(ctx context.Context, key ds.Key, value []byte) error

func (*Datastore) PutWithTTL ¶

func (d *Datastore) PutWithTTL(ctx context.Context, key ds.Key, value []byte, ttl time.Duration) error

func (*Datastore) Query ¶

func (d *Datastore) Query(ctx context.Context, q dsq.Query) (dsq.Results, error)

func (*Datastore) Set ¶

func (d *Datastore) Set(ctx context.Context, key ds.Key, value []byte, replace bool) error

func (*Datastore) SetTTL ¶

func (d *Datastore) SetTTL(ctx context.Context, key ds.Key, ttl time.Duration) error

func (*Datastore) Sync ¶

func (d *Datastore) Sync(ctx context.Context, prefix ds.Key) error

type Options ¶

type Options struct {
	// Please refer to the Badger docs to see what this is for
	GcDiscardRatio float64

	// Interval between GC cycles
	//
	// If zero, the datastore will perform no automatic garbage collection.
	GcInterval time.Duration

	// Sleep time between rounds of a single GC cycle.
	//
	// If zero, the datastore will only perform one round of GC per
	// GcInterval.
	GcSleep time.Duration

	badger.Options
}

Options are the badger datastore options, reexported here for convenience.

var DefaultOptions Options

DefaultOptions are the default options for the badger datastore.

Source Files ¶

View all Source files

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