mirror of
https://github.com/ipfs/kubo.git
synced 2026-03-10 10:47:51 +08:00
4f4dac9564
align kubo with unified golang ci linter from IPDX and rules used in boxo and other go packages addressed lint rules: - ST1000: added package comments - ST1020, ST1021, ST1022: fixed function/method comments - QF1001: applied De Morgan's law - QF1003: converted if-else chains to tagged switches - QF1004: replaced strings.Replace with strings.ReplaceAll - QF1008: simplified embedded struct field selectors - unconvert: removed unnecessary type conversions - usestdlibvars: used stdlib constants instead of literals disabled errcheck linter in .golangci.yml
130 lines
2.8 KiB
Go
130 lines
2.8 KiB
Go
// Package badgerds provides a BadgerDB datastore plugin.
|
|
package badgerds
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"github.com/ipfs/kubo/plugin"
|
|
"github.com/ipfs/kubo/repo"
|
|
"github.com/ipfs/kubo/repo/fsrepo"
|
|
|
|
humanize "github.com/dustin/go-humanize"
|
|
badgerds "github.com/ipfs/go-ds-badger"
|
|
)
|
|
|
|
// Plugins is exported list of plugins that will be loaded.
|
|
var Plugins = []plugin.Plugin{
|
|
&badgerdsPlugin{},
|
|
}
|
|
|
|
type badgerdsPlugin struct{}
|
|
|
|
var _ plugin.PluginDatastore = (*badgerdsPlugin)(nil)
|
|
|
|
func (*badgerdsPlugin) Name() string {
|
|
return "ds-badgerds"
|
|
}
|
|
|
|
func (*badgerdsPlugin) Version() string {
|
|
return "0.1.0"
|
|
}
|
|
|
|
func (*badgerdsPlugin) Init(_ *plugin.Environment) error {
|
|
return nil
|
|
}
|
|
|
|
func (*badgerdsPlugin) DatastoreTypeName() string {
|
|
return "badgerds"
|
|
}
|
|
|
|
type datastoreConfig struct {
|
|
path string
|
|
syncWrites bool
|
|
truncate bool
|
|
|
|
vlogFileSize int64
|
|
}
|
|
|
|
// BadgerdsDatastoreConfig returns a configuration stub for a badger datastore
|
|
// from the given parameters.
|
|
func (*badgerdsPlugin) DatastoreConfigParser() fsrepo.ConfigFromMap {
|
|
return func(params map[string]interface{}) (fsrepo.DatastoreConfig, error) {
|
|
var c datastoreConfig
|
|
var ok bool
|
|
|
|
c.path, ok = params["path"].(string)
|
|
if !ok {
|
|
return nil, fmt.Errorf("'path' field is missing or not string")
|
|
}
|
|
|
|
sw, ok := params["syncWrites"]
|
|
if !ok {
|
|
c.syncWrites = false
|
|
} else {
|
|
if swb, ok := sw.(bool); ok {
|
|
c.syncWrites = swb
|
|
} else {
|
|
return nil, fmt.Errorf("'syncWrites' field was not a boolean")
|
|
}
|
|
}
|
|
|
|
truncate, ok := params["truncate"]
|
|
if !ok {
|
|
c.truncate = true
|
|
} else {
|
|
if truncate, ok := truncate.(bool); ok {
|
|
c.truncate = truncate
|
|
} else {
|
|
return nil, fmt.Errorf("'truncate' field was not a boolean")
|
|
}
|
|
}
|
|
|
|
vls, ok := params["vlogFileSize"]
|
|
if !ok {
|
|
// default to 1GiB
|
|
c.vlogFileSize = badgerds.DefaultOptions.ValueLogFileSize
|
|
} else {
|
|
if vlogSize, ok := vls.(string); ok {
|
|
s, err := humanize.ParseBytes(vlogSize)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
c.vlogFileSize = int64(s)
|
|
} else {
|
|
return nil, fmt.Errorf("'vlogFileSize' field was not a string")
|
|
}
|
|
}
|
|
|
|
return &c, nil
|
|
}
|
|
}
|
|
|
|
func (c *datastoreConfig) DiskSpec() fsrepo.DiskSpec {
|
|
return map[string]interface{}{
|
|
"type": "badgerds",
|
|
"path": c.path,
|
|
}
|
|
}
|
|
|
|
func (c *datastoreConfig) Create(path string) (repo.Datastore, error) {
|
|
fmt.Fprintln(os.Stderr, "⚠️ badgerds is based on badger 1.x, which has known bugs and is no longer supported by the upstream team. Please switch to a newer datastore such as pebbleds or flatfs.")
|
|
p := c.path
|
|
if !filepath.IsAbs(p) {
|
|
p = filepath.Join(path, p)
|
|
}
|
|
|
|
err := os.MkdirAll(p, 0o755)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
defopts := badgerds.DefaultOptions
|
|
defopts.SyncWrites = c.syncWrites
|
|
defopts.Truncate = c.truncate
|
|
defopts.ValueLogFileSize = c.vlogFileSize
|
|
|
|
return badgerds.NewDatastore(p, &defopts)
|
|
}
|