github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/storage/bootstrap/bootstrapper/fs/fs.go (about)

     1  // Copyright (c) 2016 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 fs implements file system bootstrapping.
    22  package fs
    23  
    24  import (
    25  	"fmt"
    26  
    27  	"github.com/m3db/m3/src/dbnode/storage/bootstrap"
    28  	"github.com/m3db/m3/src/dbnode/storage/bootstrap/bootstrapper"
    29  )
    30  
    31  const (
    32  	// FileSystemBootstrapperName is the name of th filesystem bootstrapper.
    33  	FileSystemBootstrapperName = "filesystem"
    34  )
    35  
    36  type fileSystemBootstrapperProvider struct {
    37  	opts Options
    38  	next bootstrap.BootstrapperProvider
    39  }
    40  
    41  // NewFileSystemBootstrapperProvider creates a new bootstrapper to bootstrap from on-disk files.
    42  func NewFileSystemBootstrapperProvider(
    43  	opts Options,
    44  	next bootstrap.BootstrapperProvider,
    45  ) (bootstrap.BootstrapperProvider, error) {
    46  	if err := opts.Validate(); err != nil {
    47  		return nil, fmt.Errorf("unable to validate fs options: %v", err)
    48  	}
    49  	return fileSystemBootstrapperProvider{
    50  		opts: opts,
    51  		next: next,
    52  	}, nil
    53  }
    54  
    55  func (p fileSystemBootstrapperProvider) Provide() (bootstrap.Bootstrapper, error) {
    56  	var (
    57  		b    = &fileSystemBootstrapper{}
    58  		next bootstrap.Bootstrapper
    59  	)
    60  	src, err := newFileSystemSource(p.opts)
    61  	if err != nil {
    62  		return nil, err
    63  	}
    64  
    65  	if p.next != nil {
    66  		next, err = p.next.Provide()
    67  		if err != nil {
    68  			return nil, err
    69  		}
    70  	}
    71  	return bootstrapper.NewBaseBootstrapper(b.String(),
    72  		src, p.opts.ResultOptions(), next)
    73  }
    74  
    75  func (p fileSystemBootstrapperProvider) String() string {
    76  	return FileSystemBootstrapperName
    77  }
    78  
    79  type fileSystemBootstrapper struct {
    80  	bootstrap.Bootstrapper
    81  }
    82  
    83  func (fsb *fileSystemBootstrapper) String() string {
    84  	return FileSystemBootstrapperName
    85  }