github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/namespace/options.go

// Copyright (c) 2016 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package namespace

import (
	"errors"

	"github.com/m3db/m3/src/dbnode/retention"
)

const (
	// Namespace requires bootstrapping by default.
	defaultBootstrapEnabled = true

	// Namespace requires flushing by default.
	defaultFlushEnabled = true

	// Namespace requires snapshotting disabled by default.
	defaultSnapshotEnabled = true

	// Namespace writes go to commit logs by default.
	defaultWritesToCommitLog = true

	// Namespace requires fileset/snapshot cleanup by default.
	defaultCleanupEnabled = true

	// Namespace requires repair disabled by default.
	defaultRepairEnabled = false

	// Namespace with cold writes disabled by default.
	defaultColdWritesEnabled = false

	// Namespace does not cache retrieved blocks by default since this is only
	// useful specifically for usage patterns tending towards heavy historical reads.
	defaultCacheBlocksOnRetrieve = false
)

var (
	errIndexBlockSizePositive                       = errors.New("index block size must positive")
	errIndexBlockSizeTooLarge                       = errors.New("index block size needs to be <= namespace retention period")
	errIndexBlockSizeMustBeAMultipleOfDataBlockSize = errors.New("index block size must be a multiple of data block size")
	errNamespaceRuntimeOptionsNotSet                = errors.New("namespace runtime options is not set")
	errAggregationOptionsNotSet                     = errors.New("aggregation options is not set")
)

type options struct {
	bootstrapEnabled      bool
	flushEnabled          bool
	snapshotEnabled       bool
	writesToCommitLog     bool
	cleanupEnabled        bool
	repairEnabled         bool
	coldWritesEnabled     bool
	cacheBlocksOnRetrieve bool
	retentionOpts         retention.Options
	indexOpts             IndexOptions
	schemaHis             SchemaHistory
	runtimeOpts           RuntimeOptions
	extendedOpts          ExtendedOptions
	aggregationOpts       AggregationOptions
	stagingState          StagingState
}

// NewSchemaHistory returns an empty schema history.
func NewSchemaHistory() SchemaHistory {
	return emptySchemaHistory()
}

// NewOptions creates a new namespace options
func NewOptions() Options {
	return &options{
		bootstrapEnabled:      defaultBootstrapEnabled,
		flushEnabled:          defaultFlushEnabled,
		snapshotEnabled:       defaultSnapshotEnabled,
		writesToCommitLog:     defaultWritesToCommitLog,
		cleanupEnabled:        defaultCleanupEnabled,
		repairEnabled:         defaultRepairEnabled,
		coldWritesEnabled:     defaultColdWritesEnabled,
		cacheBlocksOnRetrieve: defaultCacheBlocksOnRetrieve,
		retentionOpts:         retention.NewOptions(),
		indexOpts:             NewIndexOptions(),
		schemaHis:             NewSchemaHistory(),
		runtimeOpts:           NewRuntimeOptions(),
		aggregationOpts:       NewAggregationOptions(),
	}
}

func (o *options) Validate() error {
	if err := o.retentionOpts.Validate(); err != nil {
		return err
	}

	if o.extendedOpts != nil {
		if err := o.extendedOpts.Validate(); err != nil {
			return err
		}
	}

	if err := o.stagingState.Validate(); err != nil {
		return err
	}

	if !o.indexOpts.Enabled() {
		return nil
	}
	var (
		retention       = o.retentionOpts.RetentionPeriod()
		futureRetention = o.retentionOpts.FutureRetentionPeriod()
		dataBlockSize   = o.retentionOpts.BlockSize()
		indexBlockSize  = o.indexOpts.BlockSize()
	)
	if indexBlockSize <= 0 {
		return errIndexBlockSizePositive
	}
	if retention < indexBlockSize || (futureRetention != 0 && futureRetention < indexBlockSize) {
		return errIndexBlockSizeTooLarge
	}
	if indexBlockSize%dataBlockSize != 0 {
		return errIndexBlockSizeMustBeAMultipleOfDataBlockSize
	}
	if o.runtimeOpts == nil {
		return errNamespaceRuntimeOptionsNotSet
	}
	if o.aggregationOpts == nil {
		return errAggregationOptionsNotSet
	}

	return nil
}

func (o *options) Equal(value Options) bool {
	return o.bootstrapEnabled == value.BootstrapEnabled() &&
		o.flushEnabled == value.FlushEnabled() &&
		o.writesToCommitLog == value.WritesToCommitLog() &&
		o.snapshotEnabled == value.SnapshotEnabled() &&
		o.cleanupEnabled == value.CleanupEnabled() &&
		o.repairEnabled == value.RepairEnabled() &&
		o.coldWritesEnabled == value.ColdWritesEnabled() &&
		o.cacheBlocksOnRetrieve == value.CacheBlocksOnRetrieve() &&
		o.retentionOpts.Equal(value.RetentionOptions()) &&
		o.indexOpts.Equal(value.IndexOptions()) &&
		o.schemaHis.Equal(value.SchemaHistory()) &&
		o.runtimeOpts.Equal(value.RuntimeOptions()) &&
		o.aggregationOpts.Equal(value.AggregationOptions()) &&
		o.stagingState == value.StagingState()
}

func (o *options) SetBootstrapEnabled(value bool) Options {
	opts := *o
	opts.bootstrapEnabled = value
	return &opts
}

func (o *options) BootstrapEnabled() bool {
	return o.bootstrapEnabled
}

func (o *options) SetFlushEnabled(value bool) Options {
	opts := *o
	opts.flushEnabled = value
	return &opts
}

func (o *options) FlushEnabled() bool {
	return o.flushEnabled
}

func (o *options) SetSnapshotEnabled(value bool) Options {
	opts := *o
	opts.snapshotEnabled = value
	return &opts
}

func (o *options) SnapshotEnabled() bool {
	return o.snapshotEnabled
}

func (o *options) SetWritesToCommitLog(value bool) Options {
	opts := *o
	opts.writesToCommitLog = value
	return &opts
}

func (o *options) WritesToCommitLog() bool {
	return o.writesToCommitLog
}

func (o *options) SetCleanupEnabled(value bool) Options {
	opts := *o
	opts.cleanupEnabled = value
	return &opts
}

func (o *options) CleanupEnabled() bool {
	return o.cleanupEnabled
}

func (o *options) SetRepairEnabled(value bool) Options {
	opts := *o
	opts.repairEnabled = value
	return &opts
}

func (o *options) RepairEnabled() bool {
	return o.repairEnabled
}

func (o *options) SetColdWritesEnabled(value bool) Options {
	opts := *o
	opts.coldWritesEnabled = value
	return &opts
}

func (o *options) ColdWritesEnabled() bool {
	return o.coldWritesEnabled
}

func (o *options) SetCacheBlocksOnRetrieve(value bool) Options {
	opts := *o
	opts.cacheBlocksOnRetrieve = value
	return &opts
}

func (o *options) CacheBlocksOnRetrieve() bool {
	return o.cacheBlocksOnRetrieve
}

func (o *options) SetRetentionOptions(value retention.Options) Options {
	opts := *o
	opts.retentionOpts = value
	return &opts
}

func (o *options) RetentionOptions() retention.Options {
	return o.retentionOpts
}

func (o *options) SetIndexOptions(value IndexOptions) Options {
	opts := *o
	opts.indexOpts = value
	return &opts
}

func (o *options) IndexOptions() IndexOptions {
	return o.indexOpts
}

func (o *options) SetSchemaHistory(value SchemaHistory) Options {
	opts := *o
	opts.schemaHis = value
	return &opts
}

func (o *options) SchemaHistory() SchemaHistory {
	return o.schemaHis
}

func (o *options) SetRuntimeOptions(value RuntimeOptions) Options {
	opts := *o
	opts.runtimeOpts = value
	return &opts
}

func (o *options) RuntimeOptions() RuntimeOptions {
	return o.runtimeOpts
}

func (o *options) SetExtendedOptions(value ExtendedOptions) Options {
	opts := *o
	opts.extendedOpts = value
	return &opts
}

func (o *options) ExtendedOptions() ExtendedOptions {
	return o.extendedOpts
}

func (o *options) SetAggregationOptions(value AggregationOptions) Options {
	opts := *o
	opts.aggregationOpts = value
	return &opts
}

func (o *options) AggregationOptions() AggregationOptions {
	return o.aggregationOpts
}

func (o *options) SetStagingState(value StagingState) Options {
	opts := *o
	opts.stagingState = value
	return &opts
}

func (o *options) StagingState() StagingState {
	return o.stagingState
}