github.com/m3db/m3@v1.5.0/src/query/graphite/native/engine.go (about)

     1  // Copyright (c) 2019 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package native
    22  
    23  import (
    24  	"github.com/m3db/m3/src/query/graphite/context"
    25  	"github.com/m3db/m3/src/query/graphite/storage"
    26  )
    27  
    28  // The Engine for running queries.
    29  type Engine struct {
    30  	storage     storage.Storage
    31  	compileOpts CompileOptions
    32  }
    33  
    34  // NewEngine creates a new query engine.
    35  func NewEngine(store storage.Storage, compileOpts CompileOptions) *Engine {
    36  	// TODO: take pooling details from config
    37  	// (https://github.com/m3db/m3/issues/2092)
    38  	return &Engine{
    39  		storage:     store,
    40  		compileOpts: compileOpts,
    41  	}
    42  }
    43  
    44  // FetchByQuery retrieves one or more time series based on a query.
    45  func (e *Engine) FetchByQuery(
    46  	ctx context.Context,
    47  	query string,
    48  	options storage.FetchOptions,
    49  ) (*storage.FetchResult, error) {
    50  	return e.storage.FetchByQuery(ctx, query, options)
    51  }
    52  
    53  // Compile compiles an expression from an expression string
    54  func (e *Engine) Compile(s string) (Expression, error) {
    55  	return Compile(s, e.compileOpts)
    56  }
    57  
    58  // Storage returns the engine's storage object
    59  func (e *Engine) Storage() storage.Storage {
    60  	return e.storage
    61  }