github.com/m3db/m3@v1.5.0/src/query/graphite/common/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 common
    22  
    23  import (
    24  	"github.com/m3db/m3/src/query/graphite/context"
    25  	"github.com/m3db/m3/src/query/graphite/storage"
    26  )
    27  
    28  // QueryEngine is the generic engine interface.
    29  type QueryEngine interface {
    30  
    31  	// FetchByQuery retrieves one or more time series based on a query.
    32  	FetchByQuery(
    33  		ctx context.Context,
    34  		query string,
    35  		options storage.FetchOptions,
    36  	) (*storage.FetchResult, error)
    37  
    38  	// Storage returns the engine's storage object.
    39  	Storage() storage.Storage
    40  }
    41  
    42  // The Engine for running queries
    43  type Engine struct {
    44  	storage storage.Storage
    45  }
    46  
    47  // NewEngine creates a new query engine
    48  func NewEngine(storage storage.Storage) *Engine {
    49  	return &Engine{
    50  		storage: storage,
    51  	}
    52  }
    53  
    54  func (e *Engine) FetchByQuery(
    55  	ctx context.Context,
    56  	query string,
    57  	options storage.FetchOptions,
    58  ) (*storage.FetchResult, error) {
    59  	return e.storage.FetchByQuery(ctx, query, options)
    60  }
    61  
    62  func (e *Engine) Storage() storage.Storage {
    63  	return e.storage
    64  }