github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/namespace/staging.go (about)

     1  // Copyright (c) 2020  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  	"fmt"
    25  
    26  	nsproto "github.com/m3db/m3/src/dbnode/generated/proto/namespace"
    27  )
    28  
    29  // StagingState is the state associated with a namespace's
    30  // availability for reads and writes.
    31  type StagingState struct {
    32  	status StagingStatus
    33  }
    34  
    35  // Status returns the StagingStatus for a namespace.
    36  func (s StagingState) Status() StagingStatus {
    37  	return s.status
    38  }
    39  
    40  // Validate validates the StagingState object.
    41  func (s StagingState) Validate() error {
    42  	var validStatus bool
    43  	for _, status := range validStagingStatuses {
    44  		if status == s.Status() {
    45  			validStatus = true
    46  			break
    47  		}
    48  	}
    49  	if !validStatus {
    50  		return fmt.Errorf("staging state status %v is invalid", s.Status())
    51  	}
    52  
    53  	return nil
    54  }
    55  
    56  // NewStagingState creates a new StagingState.
    57  func NewStagingState(status nsproto.StagingStatus) (StagingState, error) {
    58  	switch status {
    59  	case nsproto.StagingStatus_UNKNOWN:
    60  		return StagingState{status: UnknownStagingStatus}, nil
    61  	case nsproto.StagingStatus_INITIALIZING:
    62  		return StagingState{status: InitializingStagingStatus}, nil
    63  	case nsproto.StagingStatus_READY:
    64  		return StagingState{status: ReadyStagingStatus}, nil
    65  	}
    66  	return StagingState{}, fmt.Errorf("invalid namespace status: %v", status)
    67  }
    68  
    69  func (s StagingStatus) String() string {
    70  	switch s {
    71  	case ReadyStagingStatus:
    72  		return "ready"
    73  	case InitializingStagingStatus:
    74  		return "initializing"
    75  	default:
    76  		return "unknown"
    77  	}
    78  }