Documentation
¶
Overview ¶
Package pebble provides a configurable Pebble database backend for use with IPFS Cluster.
Index ¶
- Constants
- Variables
- func Cleanup(cfg *Config) error
- func New(cfg *Config) (ds.Datastore, error)
- type Config
- func (cfg *Config) ApplyEnvVars() error
- func (cfg *Config) ConfigKey() string
- func (cfg *Config) Default() error
- func (cfg *Config) GetFolder() string
- func (cfg *Config) LoadJSON(raw []byte) error
- func (cfg *Config) ToDisplayJSON() ([]byte, error)
- func (cfg *Config) ToJSON() (raw []byte, err error)
- func (cfg *Config) Validate() error
Constants ¶
View Source
const (
DefaultSubFolder = "pebble"
)
Default values for Pebble Config
Variables ¶
View Source
var ( // DefaultPebbleOptions for convenience. DefaultPebbleOptions pebble.Options )
Functions ¶
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
PebbleOptions pebble.Options
}
Config is used to initialize a Pebble datastore. It implements the ComponentConfig interface.
func (*Config) ApplyEnvVars ¶
ApplyEnvVars fills in any Config fields found as environment variables.
func (*Config) ConfigKey ¶
ConfigKey returns a human-friendly identifier for this type of Datastore.
func (*Config) LoadJSON ¶
LoadJSON reads the fields of this Config from a JSON byteslice as generated by ToJSON.
func (*Config) ToDisplayJSON ¶
ToDisplayJSON returns JSON config as a string.
Source Files
Click to show internal directories.
Click to hide internal directories.