fs

Documentation

Overview

Package fs implements file system bootstrapping.

Index

• Constants
• Variables
• func NewFileSystemBootstrapperProvider(opts Options, next bootstrap.BootstrapperProvider) (bootstrap.BootstrapperProvider, error)
• type Options
  • func NewOptions() Options

Constants

const (
	// FileSystemBootstrapperName is the name of th filesystem bootstrapper.
	FileSystemBootstrapperName = "filesystem"
)

Variables

var (

	// DefaultIndexSegmentConcurrency defines the default index segment building concurrency.
	DefaultIndexSegmentConcurrency = int(math.Min(2, float64(goruntime.GOMAXPROCS(0))))
)

Functions

func NewFileSystemBootstrapperProvider

func NewFileSystemBootstrapperProvider(
	opts Options,
	next bootstrap.BootstrapperProvider,
) (bootstrap.BootstrapperProvider, error)

NewFileSystemBootstrapperProvider creates a new bootstrapper to bootstrap from on-disk files.

Types

type Options

type Options interface {
	// Validate validates the options are correct
	Validate() error

	// SetInstrumentOptions sets the instrumentation options
	SetInstrumentOptions(value instrument.Options) Options

	// InstrumentOptions returns the instrumentation options
	InstrumentOptions() instrument.Options

	// SetResultOptions sets the instrumentation options.
	SetResultOptions(value result.Options) Options

	// ResultOptions returns the instrumentation options.
	ResultOptions() result.Options

	// SetFilesystemOptions sets the filesystem options.
	SetFilesystemOptions(value fs.Options) Options

	// FilesystemOptions returns the filesystem options.
	FilesystemOptions() fs.Options

	// SetPersistManager sets the persistence manager used to flush blocks
	// when performing a bootstrap run with persistence enabled.
	SetPersistManager(value persist.Manager) Options

	// PersistManager returns the persistence manager used to flush blocks
	// when performing a bootstrap run with persistence enabled.
	PersistManager() persist.Manager

	// SetIndexClaimsManager sets the index claims manager.
	SetIndexClaimsManager(value fs.IndexClaimsManager) Options

	// IndexClaimsManager returns the index claims manager. It's used to manage
	// concurrent claims for volume indices per ns and block start.
	IndexClaimsManager() fs.IndexClaimsManager

	// SetCompactor sets the compactor used to compact segment builders into segments.
	SetCompactor(value *compaction.Compactor) Options

	// Compactor returns the compactor used to compact segment builders into segments.
	Compactor() *compaction.Compactor

	// SetIndexSegmentConcurrency sets the concurrency for
	// building index segments.
	SetIndexSegmentConcurrency(value int) Options

	// IndexSegmentConcurrency returns the concurrency for
	// building index segments.
	IndexSegmentConcurrency() int

	// SetIndexSegmentsVerify sets the value for whether to verify bootstrapped
	// index segments.
	SetIndexSegmentsVerify(value bool) Options

	// IndexSegmentsVerify returns the value for whether to verify bootstrapped
	// index segments.
	IndexSegmentsVerify() bool

	// SetRuntimeOptionsManager sets the runtime options manager.
	SetRuntimeOptionsManager(value runtime.OptionsManager) Options

	// RuntimeOptionsManager returns the runtime options manager.
	RuntimeOptionsManager() runtime.OptionsManager

	// SetIdentifierPool sets the identifier pool.
	SetIdentifierPool(value ident.Pool) Options

	// IdentifierPool returns the identifier pool.
	IdentifierPool() ident.Pool

	// SetIndexOptions set the indexing options.
	SetIndexOptions(value index.Options) Options

	// IndexOptions returns the indexing options.
	IndexOptions() index.Options

	// SetMigrationOptions sets the migration options.
	SetMigrationOptions(value migration.Options) Options

	// MigrationOptions gets the migration options.
	MigrationOptions() migration.Options

	// SetStorageOptions sets storage options.
	SetStorageOptions(value storage.Options) Options

	// StorageOptions gets the storage options.
	StorageOptions() storage.Options
}

Options represents the options for bootstrapping from the filesystem.

func NewOptions

func NewOptions() Options

NewOptions creates new bootstrap options