opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-06-24 22:38:27 +08:00
Code Issues Projects Releases Wiki Activity

coreapi: dag: Missing batch docs

Browse Source 
License: MIT
Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
This commit is contained in:
Łukasz Magiera
2018-08-03 18:19:45 +02:00
parent 9f22058d95
commit d6ee9555d0
3 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
core/coreapi/dag.go
View File

@ -67,10 +67,14 @@ func (api *DagAPI) Tree(ctx context.Context, p coreiface.Path, opts ...caopts.Da
return out, nil return out, nil
} }
// Batch creates new DagBatch
func (api *DagAPI) Batch(ctx context.Context) coreiface.DagBatch { func (api *DagAPI) Batch(ctx context.Context) coreiface.DagBatch {
return &dagBatch{api: api} return &dagBatch{api: api}
} }
// Put inserts data using specified format and input encoding. Unless used with
// `WithCodes` or `WithHash`, the defaults "dag-cbor" and "sha256" are used.
// Returns the path of the inserted data.
func (b *dagBatch) Put(ctx context.Context, src io.Reader, opts ...caopts.DagPutOption) (coreiface.ResolvedPath, error) { func (b *dagBatch) Put(ctx context.Context, src io.Reader, opts ...caopts.DagPutOption) (coreiface.ResolvedPath, error) {
nd, err := getNode(src, opts...) nd, err := getNode(src, opts...)
if err != nil { if err != nil {
@ -84,6 +88,7 @@ func (b *dagBatch) Put(ctx context.Context, src io.Reader, opts ...caopts.DagPut
return coreiface.IpldPath(nd.Cid()), nil return coreiface.IpldPath(nd.Cid()), nil
} }
// Commit commits nodes to the datastore and announces them to the network
func (b *dagBatch) Commit(ctx context.Context) error { func (b *dagBatch) Commit(ctx context.Context) error {
b.lk.Lock() b.lk.Lock()
defer b.lk.Unlock() defer b.lk.Unlock()

2
core/coreapi/interface/dag.go
View File

@ -22,6 +22,7 @@ type DagOps interface {
type DagBatch interface { type DagBatch interface {
DagOps DagOps
// Commit commits nodes to the datastore and announces them to the network
Commit(ctx context.Context) error Commit(ctx context.Context) error
} }
@ -35,5 +36,6 @@ type DagAPI interface {
// Tree returns list of paths within a node specified by the path. // Tree returns list of paths within a node specified by the path.
Tree(ctx context.Context, path Path, opts ...options.DagTreeOption) ([]Path, error) Tree(ctx context.Context, path Path, opts ...options.DagTreeOption) ([]Path, error)
// Batch creates new DagBatch
Batch(ctx context.Context) DagBatch Batch(ctx context.Context) DagBatch
} }