cachestore

Documentation

Overview

Package cachestore implements a blob.Store that wraps the keyspaces of an underlying store in memory caches.

Index

• type KV
  • func NewKV(s blob.KV, maxBytes int) *KV
  • func (s *KV) Delete(ctx context.Context, key string) error
  • func (s *KV) Get(ctx context.Context, key string) ([]byte, error)
  • func (s *KV) Has(ctx context.Context, keys ...string) (blob.KeySet, error)
  • func (s *KV) Len(ctx context.Context) (int64, error)
  • func (s *KV) List(ctx context.Context, start string) iter.Seq2[string, error]
  • func (s *KV) Put(ctx context.Context, opts blob.PutOptions) error
• type Store
  • func New(base blob.Store, maxBytes int) Store
  • func (s Store) Close(ctx context.Context) error

Types

type KV

type KV struct {
	// contains filtered or unexported fields
}

KV implements a blob.KV that delegates to an underlying store through an in-memory cache. This is appropriate for a high-latency or quota-limited remote store (such as a GCS or S3 bucket) that will not be concurrently written by other processes; concurrent readers are fine.

Both reads and writes are cached, and the store writes through to the underlying store. Negative hits from Get and Size are also cached.

func NewKV

func NewKV(s blob.KV, maxBytes int) *KV

NewKV constructs a new cached KV with the specified capacity in bytes, delegating storage operations to s. It will panic if maxBytes < 0.

func (*KV) Delete

func (s *KV) Delete(ctx context.Context, key string) error

Delete implements a method of blob.KV.

func (*KV) Get

func (s *KV) Get(ctx context.Context, key string) ([]byte, error)

Get implements a method of blob.KV.

func (*KV) Has

func (s *KV) Has(ctx context.Context, keys ...string) (blob.KeySet, error)

Has implements a method of blob.KV.

func (*KV) Len

func (s *KV) Len(ctx context.Context) (int64, error)

Len implements a method of blob.KV.

func (*KV) List

func (s *KV) List(ctx context.Context, start string) iter.Seq2[string, error]

List implements a method of blob.KV.

func (*KV) Put

func (s *KV) Put(ctx context.Context, opts blob.PutOptions) error

Put implements a method of blob.KV.

type Store

type Store struct {
	*monitor.M[state, *KV]
}

Store implements the blob.StoreCloser interface.

func New

func New(base blob.Store, maxBytes int) Store

New constructs a new root Store delegated to base. It will panic if maxBytes < 0.

func (Store) Close

func (s Store) Close(ctx context.Context) error

Close implements a method of the blob.StoreCloser interface.