-
Notifications
You must be signed in to change notification settings - Fork 453
/
types.go
63 lines (52 loc) · 2.21 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
// Copyright (c) 2018 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 search
import (
"fmt"
"github.com/m3db/m3/src/m3ninx/doc"
"github.com/m3db/m3/src/m3ninx/generated/proto/querypb"
"github.com/m3db/m3/src/m3ninx/index"
"github.com/m3db/m3/src/m3ninx/postings"
)
// Executor is responsible for executing queries over a snapshot.
type Executor interface {
// Execute executes a query over the Executor's snapshot.
Execute(q Query) (doc.Iterator, error)
// Close closes the iterator.
Close() error
}
// Query is a search query for documents.
type Query interface {
fmt.Stringer
// Searcher returns a Searcher for executing the query.
Searcher() (Searcher, error)
// Equal reports whether two queries are equivalent.
Equal(q Query) bool
// ToProto returns the Protobuf query struct corresponding to this query.
ToProto() *querypb.Query
}
// Searcher executes a query against a given Reader. It returns the postings lists
// of the documents it matches for the given segment.
type Searcher interface {
// Search executes a configured query against the given Reader.
Search(index.Reader) (postings.List, error)
}
// Searchers is a slice of Searcher.
type Searchers []Searcher