/
storage.go
106 lines (95 loc) · 3.26 KB
/
storage.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
// Copyright (c) 2019 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 storage
import (
"sync"
"time"
"github.com/m3db/m3/src/query/block"
"github.com/m3db/m3/src/query/graphite/context"
"github.com/m3db/m3/src/query/graphite/ts"
)
// FetchOptions provides context to a fetch expression.
type FetchOptions struct {
// StartTime is the start time for the fetch.
StartTime time.Time
// EndTime is the end time for the fetch.
EndTime time.Time
// DataOptions are the options for the fetch.
DataOptions
}
// DataOptions provide data context.
type DataOptions struct {
// Timeout determines a custom timeout for the context. If set to 0, uses
// the default timeout.
Timeout time.Duration
// Limit is the limit for number of datapoints to retrieve.
Limit int
}
// Storage provides an interface for retrieving timeseries values or names
// based upon a query or path.
type Storage interface {
// FetchByQuery fetches timeseries data based on a query.
FetchByQuery(
ctx context.Context, query string, opts FetchOptions,
) (*FetchResult, error)
}
// FetchResult provides a fetch result and meta information.
type FetchResult struct {
// SeriesList is the aggregated list of results across all underlying storage
// calls.
SeriesList []*ts.Series
// Metadata contains any additional metadata indicating information about
// series execution.
Metadata block.ResultMetadata
}
// Close will return the fetch result to the pool.
func (fr *FetchResult) Close() error {
fr.SeriesList = nil
fr.Metadata = block.NewResultMetadata()
fetchResultPool.Put(fr)
return nil
}
// Reset will wipe out existing fetch result data.
func (fr *FetchResult) Reset() {
fr.SeriesList = nil
fr.Metadata = block.NewResultMetadata()
}
var (
fetchResultPool = &sync.Pool{
New: func() interface{} {
return &FetchResult{
Metadata: block.NewResultMetadata(),
}
},
}
)
// NewFetchResult is a convenience method for creating a FetchResult.
func NewFetchResult(
ctx context.Context,
seriesList []*ts.Series,
resultMeta block.ResultMetadata,
) *FetchResult {
fetchResult := fetchResultPool.Get().(*FetchResult)
fetchResult.Reset()
fetchResult.SeriesList = seriesList
fetchResult.Metadata = resultMeta
ctx.RegisterCloser(fetchResult)
return fetchResult
}