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

     1  // Copyright (c) 2018 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  	"time"
    25  )
    26  
    27  var (
    28  	// defaultIndexEnabled disables indexing by default.
    29  	defaultIndexEnabled = false
    30  
    31  	// defaultIndexBlockSize is the default block size for index blocks.
    32  	defaultIndexBlockSize = 2 * time.Hour
    33  )
    34  
    35  type indexOpts struct {
    36  	enabled   bool
    37  	blockSize time.Duration
    38  }
    39  
    40  // NewIndexOptions returns a new IndexOptions.
    41  func NewIndexOptions() IndexOptions {
    42  	return &indexOpts{
    43  		enabled:   defaultIndexEnabled,
    44  		blockSize: defaultIndexBlockSize,
    45  	}
    46  }
    47  
    48  func (i *indexOpts) Equal(value IndexOptions) bool {
    49  	return i.Enabled() == value.Enabled() &&
    50  		i.BlockSize() == value.BlockSize()
    51  }
    52  
    53  func (i *indexOpts) SetEnabled(value bool) IndexOptions {
    54  	io := *i
    55  	io.enabled = value
    56  	return &io
    57  }
    58  
    59  func (i *indexOpts) Enabled() bool {
    60  	return i.enabled
    61  }
    62  
    63  func (i *indexOpts) SetBlockSize(value time.Duration) IndexOptions {
    64  	io := *i
    65  	io.blockSize = value
    66  	return &io
    67  }
    68  
    69  func (i *indexOpts) BlockSize() time.Duration {
    70  	return i.blockSize
    71  }