github.com/m3db/m3@v1.5.0/src/dbnode/persist/fs/migration/options.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 migration
    22  
    23  import (
    24  	"fmt"
    25  	"math"
    26  	"runtime"
    27  )
    28  
    29  // defaultMigrationConcurrency is the default number of concurrent workers to perform migrations.
    30  var defaultMigrationConcurrency = int(math.Ceil(float64(runtime.GOMAXPROCS(0)) / 2))
    31  
    32  type options struct {
    33  	targetMigrationVersion MigrationVersion
    34  	concurrency            int
    35  }
    36  
    37  // NewOptions creates new migration options.
    38  func NewOptions() Options {
    39  	return &options{
    40  		concurrency: defaultMigrationConcurrency,
    41  	}
    42  }
    43  
    44  func (o *options) Validate() error {
    45  	if err := ValidateMigrationVersion(o.targetMigrationVersion); err != nil {
    46  		return err
    47  	}
    48  	if o.concurrency < 1 {
    49  		return fmt.Errorf("concurrency value %d must be >= 1", o.concurrency)
    50  	}
    51  	return nil
    52  }
    53  
    54  func (o *options) SetTargetMigrationVersion(value MigrationVersion) Options {
    55  	opts := *o
    56  	opts.targetMigrationVersion = value
    57  	return &opts
    58  }
    59  
    60  func (o *options) TargetMigrationVersion() MigrationVersion {
    61  	return o.targetMigrationVersion
    62  }
    63  
    64  func (o *options) SetConcurrency(value int) Options {
    65  	opts := *o
    66  	opts.concurrency = value
    67  	return &opts
    68  }
    69  
    70  func (o *options) Concurrency() int {
    71  	return o.concurrency
    72  }