fs

Documentation

Index

• Constants
• 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"
)

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

	// SetBoostrapDataNumProcessors sets the number of processors for CPU-bound
	// work for bootstrapping data file sets.
	SetBoostrapDataNumProcessors(value int) Options

	// BoostrapDataNumProcessors returns the number of processors for CPU-bound
	// work for bootstrapping data file sets.
	BoostrapDataNumProcessors() int

	// SetBoostrapIndexNumProcessors sets the number of processors for CPU-bound
	// work for bootstrapping data file sets.
	SetBoostrapIndexNumProcessors(value int) Options

	// BoostrapIndexNumProcessors returns the number of processors for CPU-bound
	// work for bootstrapping data file sets.
	BoostrapIndexNumProcessors() int

	// SetDatabaseBlockRetrieverManager sets the block retriever manager to
	// use when bootstrapping retrievable blocks instead of blocks
	// containing data.
	// If you don't wish to bootstrap retrievable blocks instead of
	// blocks containing data then do not set this manager.
	// You can opt into which namespace you wish to have this enabled for
	// by returning nil instead of a result when creating a new block retriever
	// for a namespace from the manager.
	SetDatabaseBlockRetrieverManager(
		value block.DatabaseBlockRetrieverManager,
	) Options

	// NewBlockRetrieverFn returns the new block retriever constructor to
	// use when bootstrapping retrievable blocks instead of blocks
	// containing data.
	DatabaseBlockRetrieverManager() block.DatabaseBlockRetrieverManager

	// 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
}

Options represents the options for bootstrapping from the filesystem.

func NewOptions

func NewOptions() Options

NewOptions creates new bootstrap options