Merge pull request #267 from pmezard/doc-dump-methods
index: document DumpAll, DumpDoc and DumpFields methods
This commit is contained in:
commit
ab67b2f642
14
index.go
14
index.go
|
@ -174,8 +174,22 @@ type Index interface {
|
|||
FieldDictRange(field string, startTerm []byte, endTerm []byte) (index.FieldDict, error)
|
||||
FieldDictPrefix(field string, termPrefix []byte) (index.FieldDict, error)
|
||||
|
||||
// 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. 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.
|
||||
DumpAll() chan interface{}
|
||||
|
||||
// DumpDoc works like DumpAll but returns only StoredRows and
|
||||
// TermFrequencyRows related to a document.
|
||||
DumpDoc(id string) chan interface{}
|
||||
|
||||
// DumpFields works like DumpAll but returns only FieldRows.
|
||||
DumpFields() chan interface{}
|
||||
|
||||
Close() error
|
||||
|
|
Loading…
Reference in New Issue