github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/persist/schema/version_checker.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 schema
    22  
    23  // VersionChecker centralizes logic for checking if a major, minor version combo supports
    24  // specific functionality
    25  type VersionChecker struct {
    26  	majorVersion int
    27  	minorVersion int
    28  }
    29  
    30  // NewVersionChecker creates a new VersionChecker
    31  func NewVersionChecker(majorVersion int, minorVersion int) VersionChecker {
    32  	return VersionChecker{
    33  		majorVersion: majorVersion,
    34  		minorVersion: minorVersion,
    35  	}
    36  }
    37  
    38  // IndexEntryValidationEnabled checks the version to determine if
    39  // fileset files of the specified version allow for doing checksum validation
    40  // on individual index entries
    41  func (v *VersionChecker) IndexEntryValidationEnabled() bool {
    42  	return v.majorVersion >= 2 || v.majorVersion == 1 && v.minorVersion >= 1
    43  }