github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/namespace/metadata.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 namespace
    22  
    23  import (
    24  	"errors"
    25  	"fmt"
    26  
    27  	"github.com/m3db/m3/src/x/checked"
    28  	"github.com/m3db/m3/src/x/ident"
    29  )
    30  
    31  var (
    32  	errIDNotSet   = errors.New("namespace ID is not set")
    33  	errOptsNotSet = errors.New("namespace options are not set")
    34  )
    35  
    36  type metadata struct {
    37  	id   ident.ID
    38  	opts Options
    39  }
    40  
    41  // NewMetadata creates a new namespace metadata
    42  func NewMetadata(id ident.ID, opts Options) (Metadata, error) {
    43  	if id == nil || id.String() == "" {
    44  		return nil, errIDNotSet
    45  	}
    46  
    47  	if opts == nil {
    48  		return nil, errOptsNotSet
    49  	}
    50  
    51  	if err := opts.Validate(); err != nil {
    52  		return nil, fmt.Errorf("unable to validate options: %v", err)
    53  
    54  	}
    55  
    56  	copiedID := checked.NewBytes(append([]byte(nil), id.Bytes()...), nil)
    57  	return &metadata{
    58  		id:   ident.BinaryID(copiedID),
    59  		opts: opts,
    60  	}, nil
    61  }
    62  
    63  func (m *metadata) ID() ident.ID {
    64  	return m.id
    65  }
    66  
    67  func (m *metadata) Options() Options {
    68  	return m.opts
    69  }
    70  
    71  func (m *metadata) Equal(value Metadata) bool {
    72  	return m.id.Equal(value.ID()) && m.Options().Equal(value.Options())
    73  }
    74  
    75  // ForceColdWritesEnabledForMetadatas forces cold writes to be enabled for all ns.
    76  func ForceColdWritesEnabledForMetadatas(metadatas []Metadata) []Metadata {
    77  	mds := make([]Metadata, 0, len(metadatas))
    78  	for _, md := range metadatas {
    79  		mds = append(mds, &metadata{
    80  			id:   md.ID(),
    81  			opts: md.Options().SetColdWritesEnabled(true),
    82  		})
    83  	}
    84  	return mds
    85  }