storage

Documentation

Index

• func ActivateMockedError()
• func DeactivateMockedError()
• func Initialize(cfg *Config)
• func Shutdown()
• type Config
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Storage
  • func Instance() Storage
• type StorageType

Functions

func ActivateMockedError

func ActivateMockedError()

ActivateMockedError forces the return of ErrMockedError from current storage manager. This method should only be used for testing purposes.

func DeactivateMockedError

func DeactivateMockedError()

DeactivateMockedError disables mocked storage error from a previous activation. This method should only be used for testing purposes.

func Initialize

func Initialize(cfg *Config)

Initialize initializes storage sub system.

func Shutdown

func Shutdown()

Shutdown shuts down storage sub system. This method should be used only for testing purposes.

Types

type Config

type Config struct {
	Type     StorageType
	MySQL    *sql.Config
	BadgerDB *badgerdb.Config
}

Config represents an storage manager configuration.

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML satisfies Unmarshaler interface.

type Storage

type Storage interface {

	// Shutdown shuts down storage sub system.
	Shutdown()
	// contains filtered or unexported methods
}

Storage represents an entity storage interface.

func Instance

func Instance() Storage

Instance returns global storage sub system.

type StorageType

type StorageType int

StorageType represents a storage manager type.

const (
	// MySQL represents a MySQL storage type.
	MySQL StorageType = iota

	// BadgerDB represents a BadgerDB storage type.
	BadgerDB

	// Memory represents a in-memstorage storage type.
	Memory
)