storage

Documentation

Overview

Package storage provides factories for various application storage backends.

Index

• Constants
• Variables
• func NewRevocationStorage() revcache.RevCache
• func SetConnLimits(d db.LimitSetter, c DBConfig)
• type Backend
• type BeaconDB
  • func NewBeaconStorage(c DBConfig, ia addr.IA) (BeaconDB, error)
• type DBConfig
  • func SetID(cfg DBConfig, id string) *DBConfig
  • func (cfg *DBConfig) ConfigName() string
  • func (cfg *DBConfig) InitDefaults()
  • func (cfg *DBConfig) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)
  • func (cfg *DBConfig) Validate() error
  • func (cfg *DBConfig) WithDefault(path string) config.Defaulter
• type PathDB
  • func NewPathStorage(c DBConfig) (PathDB, error)
• type TrustDB
  • func NewTrustStorage(c DBConfig) (TrustDB, error)

Constants

const (
	// BackendSqlite indicates an sqlite backend.
	BackendSqlite Backend = "sqlite"
	// DefaultPath indicates the default connection string for a generic database.
	DefaultPath        = "/share/scion.db"
	DefaultTrustDBPath = "/share/data/%s.trust.db"
	DefaultPathDBPath  = "/share/cache/%s.path.db"
)

Variables

var (
	SampleBeaconDB = DBConfig{
		Connection: "/share/cache/%s.beacon.db",
	}
	SamplePathDB = DBConfig{
		Connection: DefaultPathDBPath,
	}
	SampleTrustDB = DBConfig{
		Connection: DefaultTrustDBPath,
	}
)

Default samples for various databases.

Functions

func NewRevocationStorage

func NewRevocationStorage() revcache.RevCache

func SetConnLimits

func SetConnLimits(d db.LimitSetter, c DBConfig)

SetConnLimits sets the maximum number of open and idle connections based on the configuration. Limits of 0 mean the Go default will be used.

Types

type Backend

type Backend string

Backend indicates the database backend type.

type BeaconDB

type BeaconDB interface {
	io.Closer
	beacon.DB
	beaconstorage.BeaconAPI
}

func NewBeaconStorage

func NewBeaconStorage(c DBConfig, ia addr.IA) (BeaconDB, error)

type DBConfig

type DBConfig struct {
	Connection   string `toml:"connection,omitempty"`
	MaxOpenConns int    `toml:"max_open_conns,omitempty"`
	MaxIdleConns int    `toml:"max_idle_conns,omitempty"`
}

DBConfig is the configuration for the connection to a database.

func SetID

func SetID(cfg DBConfig, id string) *DBConfig

SetID returns a clone of the configuration that has the ID set on the connection string.

func (*DBConfig) ConfigName

func (cfg *DBConfig) ConfigName() string

ConfigName is the key in the toml file.

func (*DBConfig) InitDefaults

func (cfg *DBConfig) InitDefaults()

func (*DBConfig) Sample

func (cfg *DBConfig) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)

Sample writes a config sample to the writer.

func (*DBConfig) Validate

func (cfg *DBConfig) Validate() error

func (*DBConfig) WithDefault

func (cfg *DBConfig) WithDefault(path string) config.Defaulter

type PathDB

type PathDB interface {
	io.Closer
	pathdb.DB
}

func NewPathStorage

func NewPathStorage(c DBConfig) (PathDB, error)

type TrustDB

type TrustDB interface {
	io.Closer
	trust.DB
	truststorage.TrustAPI
}

TrustDB extends the trust.DB interface with methods used outside of the trust package.

func NewTrustStorage

func NewTrustStorage(c DBConfig) (TrustDB, error)