/
types.go
102 lines (92 loc) · 3.47 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
// 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 m3
import (
"context"
"github.com/m3db/m3/src/dbnode/client"
"github.com/m3db/m3/src/dbnode/encoding"
genericstorage "github.com/m3db/m3/src/query/storage"
"github.com/m3db/m3/src/x/ident"
)
// Cleanup is a cleanup function to be called after resources are freed
type Cleanup func() error
func noop() error {
return nil
}
// Storage provides an interface for reading and writing to the tsdb
type Storage interface {
genericstorage.Storage
Querier
}
// Querier handles queries against an M3 instance.
type Querier interface {
// FetchCompressed fetches timeseries data based on a query
FetchCompressed(
ctx context.Context,
query *genericstorage.FetchQuery,
options *genericstorage.FetchOptions,
) (encoding.SeriesIterators, Cleanup, error)
// SearchCompressed fetches matching tags based on a query
SearchCompressed(
ctx context.Context,
query *genericstorage.FetchQuery,
options *genericstorage.FetchOptions,
) ([]MultiTagResult, Cleanup, error)
}
// MultiFetchResult is a deduping accumalator for series iterators
// that allows merging using a given strategy.
type MultiFetchResult interface {
// Add adds series iterators with corresponding attributes to the accumulator.
Add(
attrs genericstorage.Attributes,
iterators encoding.SeriesIterators,
err error,
)
// FinalResult returns a series iterators object containing
// deduplicated series values.
FinalResult() (encoding.SeriesIterators, error)
// FinalResultWithAttrs returns a series iterators object containing
// deduplicated series values, attributes corresponding to these iterators,
// and any errors encountered.
FinalResultWithAttrs() (
encoding.SeriesIterators, []genericstorage.Attributes, error)
// Close releases all resources held by this accumulator.
Close() error
}
// MultiFetchTagsResult is a deduping accumalator for tag iterators
type MultiFetchTagsResult interface {
// Add adds tagged ID iterators to the accumulator
Add(
newIterator client.TaggedIDsIterator,
err error,
)
// FinalResult returns a deduped list of tag iterators with
// corresponding series ids
FinalResult() ([]MultiTagResult, error)
// Close releases all resources held by this accumulator
Close() error
}
// MultiTagResult represents a tag iterator with its string ID
type MultiTagResult struct {
// ID is the series ID
ID ident.ID
// Iter is the tag iterator for the series
Iter ident.TagIterator
}