storage

Documentation

Overview

Package storage provide generic interface to interact with storage backend.

Index

• type Backend
  • func NewEncryptedBackend(secret []byte, underlying Backend) (Backend, error)

Types

type Backend

type Backend interface {
	// Put is used to insert or update a record.
	Put(ctx context.Context, id string, data *anypb.Any) error

	// Get is used to retrieve a record.
	Get(ctx context.Context, id string) (*databroker.Record, error)

	// GetAll is used to retrieve all the records.
	GetAll(ctx context.Context) ([]*databroker.Record, error)

	// List is used to retrieve all the records since a version.
	List(ctx context.Context, sinceVersion string) ([]*databroker.Record, error)

	// Delete is used to mark a record as deleted.
	Delete(ctx context.Context, id string) error

	// ClearDeleted is used clear marked delete records.
	ClearDeleted(ctx context.Context, cutoff time.Time)

	// Watch returns a channel to the caller. The channel is used to notify
	// about changes that happen in storage. When ctx is finished, Watch will close
	// the channel.
	Watch(ctx context.Context) chan struct{}
}

Backend is the interface required for a storage backend.

func NewEncryptedBackend

func NewEncryptedBackend(secret []byte, underlying Backend) (Backend, error)

NewEncryptedBackend creates a new encrypted backend.