featrue: Include go-ds-pebble as built-in plugin #10367
+152
−2
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -51,6 +51,17 @@ Uses [badger](https://github.com/dgraph-io/badger) as a key value store. | |
| } | ||
| ``` | ||
|
|
||
| ## pebbleds | ||
|
|
||
| Uses [pebble](https://github.com/cockroachdb/pebble) as a key value store | ||
|
|
||
| ```json | ||
| { | ||
| "type": "pebbleds", | ||
| "path": "<location of pebble inside repo>" | ||
| } | ||
| ``` | ||
|
Comment on lines
+54
to
+63
There was a problem hiding this comment. @hsanjuan I know pebble is used by default in IPFS Cluster, and there is a lot of custom configuration in https://github.com/ipfs-cluster/ipfs-cluster/blob/v1.0.8/datastore/pebble/config.go#L25-L70 Two questions:
There was a problem hiding this comment. @lidel it makes sense to expose them, to be honest. Why not? I would expose them explicitally like cluster does. It is the only way to adjust things to usage, unlike the current badger-datastore defaults. For implicit defaults, you need to look into what Kubo does. Kubo has its own block-cache, etc. so might as well disable/reduce pebble's cache, for example. Also need to adapt levels and granularity to the average 256K default block size. |
||
|
|
||
| ## mount | ||
|
|
||
| Allows specified datastores to handle keys prefixed with a given path. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| package pebbleds | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "path/filepath" | ||
|
|
||
| "github.com/cockroachdb/pebble" | ||
| "github.com/ipfs/kubo/plugin" | ||
| "github.com/ipfs/kubo/repo" | ||
| "github.com/ipfs/kubo/repo/fsrepo" | ||
|
|
||
| pebbleds "github.com/ipfs/go-ds-pebble" | ||
| ) | ||
|
|
||
| var Plugins = []plugin.Plugin{ | ||
| &pebbledsPlugin{}, | ||
| } | ||
|
|
||
| type pebbledsPlugin struct{} | ||
|
|
||
| var _ plugin.PluginDatastore = (*pebbledsPlugin)(nil) | ||
|
|
||
| func (*pebbledsPlugin) Name() string { | ||
| return "ds-pebble" | ||
| } | ||
|
|
||
| func (*pebbledsPlugin) Version() string { | ||
| return "" | ||
| } | ||
|
|
||
| func (*pebbledsPlugin) Init(_ *plugin.Environment) error { | ||
| return nil | ||
| } | ||
|
|
||
| func (*pebbledsPlugin) DatastoreTypeName() string { | ||
| return "pebbleds" | ||
| } | ||
|
|
||
| type datastoreConfig struct { | ||
| path string | ||
| } | ||
|
|
||
| func (*pebbledsPlugin) 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") | ||
| } | ||
|
|
||
| return &c, nil | ||
| } | ||
| } | ||
|
|
||
| func (c *datastoreConfig) DiskSpec() fsrepo.DiskSpec { | ||
| return map[string]interface{}{ | ||
| "type": "pebbleds", | ||
| "path": c.path, | ||
| } | ||
| } | ||
|
|
||
| func (c *datastoreConfig) Create(path string) (repo.Datastore, error) { | ||
| p := c.path | ||
| if !filepath.IsAbs(p) { | ||
| p = filepath.Join(path, p) | ||
| } | ||
| return pebbleds.NewDatastore(p, &pebble.Options{}) | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.