gibheer
/
bleve
0
0
Fork 0
Code

index: do not mention locking in DumpAll documentation 

The behaviour depends on the nature of the KVStore.
This commit is contained in:
Patrick Mezard 2015-11-13 17:01:18 +01:00
parent 97529b1925
commit 03b78deb5c
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
index.go
View File

@ -177,11 +177,9 @@ type Index interface {
// DumpAll returns a channel receiving all index rows as
// UpsideDownCouchRow, in lexicographic byte order. If the enumeration
// fails, an error is sent. The channel is closed once the enumeration
// completes or an error is encountered. A read transaction is maintained
// for the duration of the enumeration, preventing concurrent write
// operations to proceed. The caller must consume all channel entries until
// the channel is closed to ensure the transaction and other resources
// associated with the enumeration are released.
// completes or an error is encountered. The caller must consume all
// channel entries until the channel is closed to ensure the transaction
// and other resources associated with the enumeration are released.
//
// DumpAll exists for debugging and tooling purpose and may change in the
// future.