storage

Documentation

Overview

Package storage implements the storage backend.

Index

• Constants
• Variables
• func New(ctx context.Context, dataDir string, namespace common.Namespace, ...) (api.Backend, error)
• type Option
  • func WithConsensus(consensus consensus.Backend) Option
  • func WithRuntime(runtime registry.RuntimeDescriptorProvider) Option

Constants

const (
	// CfgBackend configures the storage backend flag.
	CfgBackend = "storage.backend"

	// CfgLRUSlots configures the LRU apply lock slots.
	CfgLRUSlots = "storage.root_cache.apply_lock_lru_slots"

	// CfgMaxCacheSize configures the maximum in-memory cache size.
	CfgMaxCacheSize = "storage.max_cache_size"
)

Variables

var Flags = flag.NewFlagSet("", flag.ContinueOnError)

Flags has the configuration flags.

Functions

func New

func New(
	ctx context.Context,
	dataDir string,
	namespace common.Namespace,
	identity *identity.Identity,
	opts ...Option,
) (api.Backend, error)

New constructs a new Backend based on the configuration flags.

Types

type Option

type Option func(o *options)

Option is a storage configuration option.

func WithConsensus

func WithConsensus(consensus consensus.Backend) Option

WithConsensus configures the consensus backend to use with storage backends which require access to the consensus layer. In case this option is not specified using such backends will fail.

func WithRuntime

func WithRuntime(runtime registry.RuntimeDescriptorProvider) Option

WithRuntime configures the runtime to use for looking up storage parameters. In case this option is not specified default safe values will be used.