github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/namespace/kvadmin/types.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 kvadmin
    22  
    23  import (
    24  	nsproto "github.com/m3db/m3/src/dbnode/generated/proto/namespace"
    25  )
    26  
    27  type NamespaceMetadataAdminService interface {
    28  	// GetAll gets namespace options for all namespaces.
    29  	GetAll() (*nsproto.Registry, error)
    30  
    31  	// Get gets option for the specified namespace.
    32  	Get(name string) (*nsproto.NamespaceOptions, error)
    33  
    34  	// Add adds a new namespace and set its options.
    35  	Add(name string, options *nsproto.NamespaceOptions) error
    36  
    37  	// Set sets the options for the specified namespace.
    38  	Set(name string, options *nsproto.NamespaceOptions) error
    39  
    40  	// Delete deletes the specified namespace.
    41  	Delete(name string) error
    42  
    43  	// DeploySchema deploys a new version schema to the specified namespace.
    44  	// An opaque string (deployID) is returned if successful.
    45  	// Application developer is to include the deployID in their m3db client configuration
    46  	// when they upgrade their application to use the new schema version.
    47  	DeploySchema(name, protoFileName, msgName string, protos map[string]string) (string, error)
    48  
    49  	// ResetSchema reset schema for the specified namespace.
    50  	ResetSchema(name string) error
    51  }