github.com/m3db/m3@v1.5.0/src/cluster/client/client.go (about)

     1  // Copyright (c) 2016 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 client
    22  
    23  import (
    24  	"github.com/m3db/m3/src/cluster/kv"
    25  	"github.com/m3db/m3/src/cluster/services"
    26  )
    27  
    28  // Client is the base interface into the cluster management system, providing
    29  // access to cluster services.
    30  type Client interface {
    31  	// Services returns access to the set of services.
    32  	Services(opts services.OverrideOptions) (services.Services, error)
    33  
    34  	// KV returns access to the distributed configuration store.
    35  	// To be deprecated.
    36  	KV() (kv.Store, error)
    37  
    38  	// Txn returns access to the transaction store.
    39  	// To be deprecated.
    40  	Txn() (kv.TxnStore, error)
    41  
    42  	// Store returns access to the distributed configuration store with a namespace.
    43  	Store(opts kv.OverrideOptions) (kv.Store, error)
    44  
    45  	// TxnStore returns access to the transaction store with a namespace.
    46  	TxnStore(opts kv.OverrideOptions) (kv.TxnStore, error)
    47  }