badger

package

v0.11.0-rc6 Latest Latest Go to latest Published: Aug 13, 2019 License: Apache-2.0, MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ipfs/ipfs-cluster

Documentation ¶

Overview ¶

Package badger provides a configurable BadgerDB go-datastore for use with IPFS Cluster.

Index ¶

Constants
Variables
func Cleanup(cfg *Config) error
func New(cfg *Config) (ds.Datastore, error)
type Config

Constants ¶

View Source

const (
	DefaultSubFolder = "badger"
)

Default values for badger Config

Variables ¶

View Source

var (
	// DefaultBadgerOptions has to be a var because badger.DefaultOptions is.
	DefaultBadgerOptions badger.Options
)

Functions ¶

func Cleanup ¶

func Cleanup(cfg *Config) error

Cleanup deletes the badger datastore.

func New ¶

func New(cfg *Config) (ds.Datastore, error)

New returns a BadgerDB datastore configured with the given configuration.

Types ¶

type Config ¶

type Config struct {
	config.Saver

	// The folder for this datastore. Non-absolute paths are relative to
	// the base configuration folder.
	Folder string

	BadgerOptions badger.Options
}

Config is used to initialize a BadgerDB datastore. It implements the ComponentConfig interface.

func (*Config) ApplyEnvVars ¶

func (cfg *Config) ApplyEnvVars() error

ApplyEnvVars fills in any Config fields found as environment variables.

func (*Config) ConfigKey ¶

func (cfg *Config) ConfigKey() string

ConfigKey returns a human-friendly identifier for this type of Datastore.

func (*Config) Default ¶

func (cfg *Config) Default() error

Default initializes this Config with sensible values.

func (*Config) GetFolder ¶

func (cfg *Config) GetFolder() string

GetFolder returns the BadgerDB folder.

func (*Config) LoadJSON ¶

func (cfg *Config) LoadJSON(raw []byte) error

LoadJSON reads the fields of this Config from a JSON byteslice as generated by ToJSON.

func (*Config) ToJSON ¶

func (cfg *Config) ToJSON() (raw []byte, err error)

ToJSON generates a JSON-formatted human-friendly representation of this Config.

func (*Config) Validate ¶

func (cfg *Config) Validate() error

Validate checks that the fields of this Config have working values, at least in appearance.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL