inmemory

Documentation

Overview

Package inmemory contains an in-memory implementation of the databroker backend.

Index

• type Backend
  • func New(options ...Option) *Backend
  • func (backend *Backend) Close() error
  • func (backend *Backend) Get(_ context.Context, recordType, id string) (*databroker.Record, error)
  • func (backend *Backend) GetOptions(_ context.Context, recordType string) (*databroker.Options, error)
  • func (backend *Backend) Lease(_ context.Context, leaseName, leaseID string, ttl time.Duration) (bool, error)
  • func (backend *Backend) ListTypes(_ context.Context) ([]string, error)
  • func (backend *Backend) Patch(ctx context.Context, records []*databroker.Record, ...) (serverVersion uint64, patchedRecords []*databroker.Record, err error)
  • func (backend *Backend) Put(ctx context.Context, records []*databroker.Record) (serverVersion uint64, err error)
  • func (backend *Backend) SetOptions(_ context.Context, recordType string, options *databroker.Options) error
  • func (backend *Backend) Sync(ctx context.Context, recordType string, serverVersion, recordVersion uint64) (storage.RecordStream, error)
  • func (backend *Backend) SyncLatest(ctx context.Context, recordType string, expr storage.FilterExpression) (serverVersion, recordVersion uint64, stream storage.RecordStream, err error)
• type Option
  • func WithBTreeDegree(degree int) Option
  • func WithExpiry(expiry time.Duration) Option
• type RecordCollection
  • func NewRecordCollection() *RecordCollection
  • func (c *RecordCollection) Delete(recordID string)
  • func (c *RecordCollection) Get(recordID string) *databroker.Record
  • func (c *RecordCollection) Len() int
  • func (c *RecordCollection) List() []*databroker.Record
  • func (c *RecordCollection) Put(record *databroker.Record)

Types

type Backend

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

A Backend stores data in-memory.

func New

func New(options ...Option) *Backend

New creates a new in-memory backend storage.

func (*Backend) Close

func (backend *Backend) Close() error

Close closes the in-memory store and erases any stored data.

func (*Backend) Get

func (backend *Backend) Get(_ context.Context, recordType, id string) (*databroker.Record, error)

Get gets a record from the in-memory store.

func (*Backend) GetOptions

func (backend *Backend) GetOptions(_ context.Context, recordType string) (*databroker.Options, error)

GetOptions returns the options for a type in the in-memory store.

func (*Backend) Lease

func (backend *Backend) Lease(_ context.Context, leaseName, leaseID string, ttl time.Duration) (bool, error)

Lease acquires or renews a lease.

func (*Backend) ListTypes

func (backend *Backend) ListTypes(_ context.Context) ([]string, error)

ListTypes lists the record types.

func (*Backend) Patch

func (backend *Backend) Patch(
	ctx context.Context, records []*databroker.Record, fields *fieldmaskpb.FieldMask,
) (serverVersion uint64, patchedRecords []*databroker.Record, err error)

Patch updates the specified fields of existing record(s).

func (*Backend) Put

func (backend *Backend) Put(ctx context.Context, records []*databroker.Record) (serverVersion uint64, err error)

Put puts a record into the in-memory store.

func (*Backend) SetOptions

func (backend *Backend) SetOptions(_ context.Context, recordType string, options *databroker.Options) error

SetOptions sets the options for a type in the in-memory store.

func (*Backend) Sync

func (backend *Backend) Sync(ctx context.Context, recordType string, serverVersion, recordVersion uint64) (storage.RecordStream, error)

Sync returns a record stream for any changes after recordVersion.

func (*Backend) SyncLatest

func (backend *Backend) SyncLatest(
	ctx context.Context,
	recordType string,
	expr storage.FilterExpression,
) (serverVersion, recordVersion uint64, stream storage.RecordStream, err error)

SyncLatest returns a record stream for all the records.

type Option

type Option func(cfg *config)

An Option customizes the in-memory backend.

func WithBTreeDegree

func WithBTreeDegree(degree int) Option

WithBTreeDegree sets the btree degree of the changes btree.

func WithExpiry

func WithExpiry(expiry time.Duration) Option

WithExpiry sets the expiry for changes.

type RecordCollection

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

A RecordCollection is a collection of records which supports lookup by (record id) as well as enforcing capacity by insertion order. The collection is *not* thread safe.

func NewRecordCollection

func NewRecordCollection() *RecordCollection

NewRecordCollection creates a new RecordCollection.

func (*RecordCollection) Delete

func (c *RecordCollection) Delete(recordID string)

Delete deletes a record from the collection.

func (*RecordCollection) Get

func (c *RecordCollection) Get(recordID string) *databroker.Record

Get gets a record from the collection.

func (*RecordCollection) Len

func (c *RecordCollection) Len() int

Len returns the length of the collection.

func (*RecordCollection) List

func (c *RecordCollection) List() []*databroker.Record

List lists all the records in the collection in insertion order.

func (*RecordCollection) Put

func (c *RecordCollection) Put(record *databroker.Record)

Put puts a record in the collection.