restore

Documentation

Overview

Package restore manages restoring filesystem snapshots.

Index

• type FilesystemOutput
  • func (o *FilesystemOutput) BeginDirectory(ctx context.Context, relativePath string, e fs.Directory) error
  • func (o *FilesystemOutput) Close(ctx context.Context) error
  • func (o *FilesystemOutput) CreateSymlink(ctx context.Context, relativePath string, e fs.Symlink) error
  • func (o *FilesystemOutput) FinishDirectory(ctx context.Context, relativePath string, e fs.Directory) error
  • func (o *FilesystemOutput) WriteFile(ctx context.Context, relativePath string, f fs.File) error
• type Output
• type Stats
  • func Root(ctx context.Context, rep repo.Repository, output Output, oid object.ID) (Stats, error)
  • func Snapshot(ctx context.Context, rep repo.Repository, output Output, snapID manifest.ID) (Stats, error)
• type TarOutput
  • func NewTarOutput(w io.WriteCloser) *TarOutput
  • func (o *TarOutput) BeginDirectory(ctx context.Context, relativePath string, d fs.Directory) error
  • func (o *TarOutput) Close(ctx context.Context) error
  • func (o *TarOutput) CreateSymlink(ctx context.Context, relativePath string, l fs.Symlink) error
  • func (o *TarOutput) FinishDirectory(ctx context.Context, relativePath string, e fs.Directory) error
  • func (o *TarOutput) WriteFile(ctx context.Context, relativePath string, f fs.File) error
• type ZipOutput
  • func NewZipOutput(w io.WriteCloser, method uint16) *ZipOutput
  • func (o *ZipOutput) BeginDirectory(ctx context.Context, relativePath string, e fs.Directory) error
  • func (o *ZipOutput) Close(ctx context.Context) error
  • func (o *ZipOutput) CreateSymlink(ctx context.Context, relativePath string, e fs.Symlink) error
  • func (o *ZipOutput) FinishDirectory(ctx context.Context, relativePath string, e fs.Directory) error
  • func (o *ZipOutput) WriteFile(ctx context.Context, relativePath string, f fs.File) error

Types

type FilesystemOutput

type FilesystemOutput struct {
	// TargetPath for restore.
	TargetPath string

	// If a directory already exists, overwrite the directory.
	OverwriteDirectories bool

	// Indicate whether or not to overwrite existing files. When set to false,
	// the copier does not modify already existing files and returns an error
	// instead.
	OverwriteFiles bool
}

FilesystemOutput contains the options for outputting a file system tree.

func (*FilesystemOutput) BeginDirectory

func (o *FilesystemOutput) BeginDirectory(ctx context.Context, relativePath string, e fs.Directory) error

BeginDirectory implements restore.Output interface.

func (*FilesystemOutput) Close

func (o *FilesystemOutput) Close(ctx context.Context) error

Close implements restore.Output interface.

func (*FilesystemOutput) CreateSymlink

func (o *FilesystemOutput) CreateSymlink(ctx context.Context, relativePath string, e fs.Symlink) error

CreateSymlink implements restore.Output interface.

func (*FilesystemOutput) FinishDirectory

func (o *FilesystemOutput) FinishDirectory(ctx context.Context, relativePath string, e fs.Directory) error

FinishDirectory implements restore.Output interface.

func (*FilesystemOutput) WriteFile

func (o *FilesystemOutput) WriteFile(ctx context.Context, relativePath string, f fs.File) error

WriteFile implements restore.Output interface.

type Output

type Output interface {
	BeginDirectory(ctx context.Context, relativePath string, e fs.Directory) error
	FinishDirectory(ctx context.Context, relativePath string, e fs.Directory) error
	WriteFile(ctx context.Context, relativePath string, e fs.File) error
	CreateSymlink(ctx context.Context, relativePath string, e fs.Symlink) error
	Close(ctx context.Context) error
}

Output encapsulates output for restore operation.

type Stats

type Stats struct {
	TotalFileSize int64
	FileCount     int32
	DirCount      int32
	SymlinkCount  int32
}

Stats represents restore statistics.

func Root

func Root(ctx context.Context, rep repo.Repository, output Output, oid object.ID) (Stats, error)

Root walks a snapshot root with given object ID and restores it to the provided output.

func Snapshot

func Snapshot(ctx context.Context, rep repo.Repository, output Output, snapID manifest.ID) (Stats, error)

Snapshot walks a snapshot root with given snapshot ID and restores it to the provided output.

type TarOutput

type TarOutput struct {
	// contains filtered or unexported fields
}

TarOutput contains the options for outputting a file system tree to a tar or .tar.gz file.

func NewTarOutput

func NewTarOutput(w io.WriteCloser) *TarOutput

NewTarOutput creates new tar writer output.

func (*TarOutput) BeginDirectory

func (o *TarOutput) BeginDirectory(ctx context.Context, relativePath string, d fs.Directory) error

BeginDirectory implements restore.Output interface.

func (*TarOutput) Close

func (o *TarOutput) Close(ctx context.Context) error

Close implements restore.Output interface.

func (*TarOutput) CreateSymlink

func (o *TarOutput) CreateSymlink(ctx context.Context, relativePath string, l fs.Symlink) error

CreateSymlink implements restore.Output interface.

func (*TarOutput) FinishDirectory

func (o *TarOutput) FinishDirectory(ctx context.Context, relativePath string, e fs.Directory) error

FinishDirectory implements restore.Output interface.

func (*TarOutput) WriteFile

func (o *TarOutput) WriteFile(ctx context.Context, relativePath string, f fs.File) error

WriteFile implements restore.Output interface.

type ZipOutput

type ZipOutput struct {
	// contains filtered or unexported fields
}

ZipOutput contains the options for outputting a file system tree to a zip file.

func NewZipOutput

func NewZipOutput(w io.WriteCloser, method uint16) *ZipOutput

NewZipOutput creates new zip writer output.

func (*ZipOutput) BeginDirectory

func (o *ZipOutput) BeginDirectory(ctx context.Context, relativePath string, e fs.Directory) error

BeginDirectory implements restore.Output interface.

func (*ZipOutput) Close

func (o *ZipOutput) Close(ctx context.Context) error

Close implements restore.Output interface.

func (*ZipOutput) CreateSymlink

func (o *ZipOutput) CreateSymlink(ctx context.Context, relativePath string, e fs.Symlink) error

CreateSymlink implements restore.Output interface.

func (*ZipOutput) FinishDirectory

func (o *ZipOutput) FinishDirectory(ctx context.Context, relativePath string, e fs.Directory) error

FinishDirectory implements restore.Output interface.

func (*ZipOutput) WriteFile

func (o *ZipOutput) WriteFile(ctx context.Context, relativePath string, f fs.File) error

WriteFile implements restore.Output interface.