-
Notifications
You must be signed in to change notification settings - Fork 451
/
types.go
126 lines (101 loc) · 4.19 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package index
import (
"errors"
"regexp"
"github.com/m3db/m3/src/m3ninx/doc"
"github.com/m3db/m3/src/m3ninx/postings"
xerrors "github.com/m3db/m3x/errors"
vregex "github.com/couchbase/vellum/regexp"
)
// ErrDocNotFound is the error returned when there is no document for a given postings ID.
var ErrDocNotFound = errors.New("no document with given postings ID")
// Index is a collection of searchable documents.
type Index interface {
Writer
// Readers returns a set of readers representing a point-in-time snapshot of the index.
Readers() (Readers, error)
// Close closes the index and releases any internal resources.
Close() error
}
// Writer is used to insert documents into an index.
type Writer interface {
// Insert inserts the given document into the index and returns its ID. The document
// is guaranteed to be searchable once the Insert method returns.
Insert(d doc.Document) ([]byte, error)
// InsertBatch inserts a batch of metrics into the index. The documents are guaranteed
// to be searchable all at once when the Batch method returns. If the batch supports
// partial updates and any errors are encountered on individual documents then a
// BatchPartialError is returned.
InsertBatch(b Batch) error
}
// Readable provides a point-in-time accessor to the documents in an index.
type Readable interface {
DocRetriever
// MatchTerm returns a postings list over all documents which match the given term.
MatchTerm(field, term []byte) (postings.List, error)
// MatchRegexp returns a postings list over all documents which match the given
// regular expression.
MatchRegexp(field, regexp []byte, c CompiledRegex) (postings.List, error)
// MatchAll returns a postings list for all documents known to the Reader.
MatchAll() (postings.MutableList, error)
// Docs returns an iterator over the documents whose IDs are in the provided
// postings list.
Docs(pl postings.List) (doc.Iterator, error)
// AllDocs returns an iterator over the documents known to the Reader.
AllDocs() (IDDocIterator, error)
}
// CompiledRegex is a collection of regexp compiled structs to allow
// amortisation of regexp construction costs.
type CompiledRegex struct {
Simple *regexp.Regexp
FST *vregex.Regexp
}
// DocRetriever returns the document associated with a postings ID. It returns
// ErrDocNotFound if there is no document corresponding to the given postings ID.
type DocRetriever interface {
Doc(id postings.ID) (doc.Document, error)
}
// IDDocIterator is an extented documents Iterator which can also return the postings
// ID of the current document.
type IDDocIterator interface {
doc.Iterator
PostingsID() postings.ID
}
// Reader provides a point-in-time accessor to the documents in an index.
type Reader interface {
Readable
// Close closes the reader and releases any internal resources.
Close() error
}
// Readers is a slice of Reader.
type Readers []Reader
// Close closes all of the Readers in rs.
func (rs Readers) Close() error {
multiErr := xerrors.NewMultiError()
for _, r := range rs {
err := r.Close()
if err != nil {
multiErr = multiErr.Add(err)
}
}
return multiErr.FinalError()
}