-
-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
coreapi: dag: Batching interface #5340
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,21 +4,38 @@ import ( | |
"context" | ||
"io" | ||
|
||
options "github.com/ipfs/go-ipfs/core/coreapi/interface/options" | ||
"github.com/ipfs/go-ipfs/core/coreapi/interface/options" | ||
|
||
ipld "gx/ipfs/QmZtNq8dArGfnpCZfx2pUNY7UcjGhVp5qqwQ4hH6mpTMRQ/go-ipld-format" | ||
) | ||
|
||
// DagAPI specifies the interface to IPLD | ||
type DagAPI interface { | ||
// DagOps groups operations that can be batched together | ||
type DagOps interface { | ||
// Put inserts data using specified format and input encoding. | ||
// Unless used with WithCodec or WithHash, the defaults "dag-cbor" and | ||
// "sha256" are used. | ||
Put(ctx context.Context, src io.Reader, opts ...options.DagPutOption) (ResolvedPath, error) | ||
} | ||
|
||
// DagBatch is the batching version of DagAPI. All implementations of DagBatch | ||
// should be threadsafe | ||
type DagBatch interface { | ||
DagOps | ||
|
||
// Commit commits nodes to the datastore and announces them to the network | ||
Commit(ctx context.Context) error | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note: need this context for go-ipfs-api implementation (batch will hold a connection and stream files to |
||
} | ||
|
||
// DagAPI specifies the interface to IPLD | ||
type DagAPI interface { | ||
DagOps | ||
|
||
// Get attempts to resolve and get the node specified by the path | ||
Get(ctx context.Context, path Path) (ipld.Node, error) | ||
|
||
// Tree returns list of paths within a node specified by the path. | ||
Tree(ctx context.Context, path Path, opts ...options.DagTreeOption) ([]Path, error) | ||
|
||
// Batch creates new DagBatch | ||
Batch(ctx context.Context) DagBatch | ||
} |
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.
We will probably also have
Delete
on this interface, right?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.
Well, there isn't
dag rm
so I didn't add it here. But yes, that would be the place for that (will be in Block API, but that's for a separate PR)