repo

Documentation

Overview

Package repo implements content-addressable Repository on top of BLOB storage.

Index

• Constants
• Variables
• func Connect(ctx context.Context, configFile string, st storage.Storage, password string, ...) error
• func Disconnect(configFile string) error
• func Initialize(ctx context.Context, st storage.Storage, opt *NewRepositoryOptions, ...) error
• func RecoverFormatBlock(ctx context.Context, st storage.Storage, filename string, optionalLength int64) ([]byte, error)
• func SetCachingConfig(ctx context.Context, configFile string, opt block.CachingOptions) error
• type ConnectOptions
• type LocalConfig
  • func (lc *LocalConfig) Load(r io.Reader) error
  • func (lc *LocalConfig) Save(w io.Writer) error
• type NewRepositoryOptions
• type Options
• type Repository
  • func Open(ctx context.Context, configFile string, password string, options *Options) (rep *Repository, err error)
  • func OpenWithConfig(ctx context.Context, st storage.Storage, lc *LocalConfig, password string, ...) (*Repository, error)
  • func (r *Repository) Close(ctx context.Context) error
  • func (r *Repository) Flush(ctx context.Context) error
  • func (r *Repository) Refresh(ctx context.Context) error
  • func (r *Repository) RefreshPeriodically(ctx context.Context, interval time.Duration)
  • func (r *Repository) Upgrade(ctx context.Context) error

Constants

const FormatBlockID = "kopia.repository"

FormatBlockID is the identifier of a storage block that describes repository format.

Variables

var (
	BuildInfo    = "unknown"
	BuildVersion = "v0-unofficial"
)

BuildInfo is the build information of Kopia.

Functions

func Connect

func Connect(ctx context.Context, configFile string, st storage.Storage, password string, opt ConnectOptions) error

Connect connects to the repository in the specified storage and persists the configuration and credentials in the file provided.

func Disconnect

func Disconnect(configFile string) error

Disconnect removes the specified configuration file and any local cache directories.

func Initialize

func Initialize(ctx context.Context, st storage.Storage, opt *NewRepositoryOptions, password string) error

Initialize creates initial repository data structures in the specified storage with given credentials.

func RecoverFormatBlock

func RecoverFormatBlock(ctx context.Context, st storage.Storage, filename string, optionalLength int64) ([]byte, error)

RecoverFormatBlock attempts to recover format block replica from the specified file. The format block can be either the prefix or a suffix of the given file. optionally the length can be provided (if known) to speed up recovery.

func SetCachingConfig

func SetCachingConfig(ctx context.Context, configFile string, opt block.CachingOptions) error

SetCachingConfig changes caching configuration for a given repository config file.

Types

type ConnectOptions

type ConnectOptions struct {
	block.CachingOptions
}

ConnectOptions specifies options when persisting configuration to connect to a repository.

type LocalConfig

type LocalConfig struct {
	Storage storage.ConnectionInfo `json:"storage"`
	Caching block.CachingOptions   `json:"caching"`
}

LocalConfig is a configuration of Kopia stored in a configuration file.

func (*LocalConfig) Load

func (lc *LocalConfig) Load(r io.Reader) error

Load reads local configuration from the specified reader.

func (*LocalConfig) Save

func (lc *LocalConfig) Save(w io.Writer) error

Save writes the configuration to the specified writer.

type NewRepositoryOptions

type NewRepositoryOptions struct {
	UniqueID     []byte // force the use of particular unique ID
	BlockFormat  block.FormattingOptions
	DisableHMAC  bool
	ObjectFormat object.Format // object format
}

NewRepositoryOptions specifies options that apply to newly created repositories. All fields are optional, when not provided, reasonable defaults will be used.

type Options

type Options struct {
	TraceStorage         func(f string, args ...interface{}) // Logs all storage access using provided Printf-style function
	ObjectManagerOptions object.ManagerOptions
}

Options provides configuration parameters for connection to a repository.

type Repository

type Repository struct {
	Blocks    *block.Manager
	Objects   *object.Manager
	Storage   storage.Storage
	Manifests *manifest.Manager
	UniqueID  []byte

	ConfigFile     string
	CacheDirectory string
	// contains filtered or unexported fields
}

Repository represents storage where both content-addressable and user-addressable data is kept.

func Open

func Open(ctx context.Context, configFile string, password string, options *Options) (rep *Repository, err error)

Open opens a Repository specified in the configuration file.

func OpenWithConfig

func OpenWithConfig(ctx context.Context, st storage.Storage, lc *LocalConfig, password string, options *Options, caching block.CachingOptions) (*Repository, error)

OpenWithConfig opens the repository with a given configuration, avoiding the need for a config file.

func (*Repository) Close

func (r *Repository) Close(ctx context.Context) error

Close closes the repository and releases all resources.

func (*Repository) Flush

func (r *Repository) Flush(ctx context.Context) error

Flush waits for all in-flight writes to complete.

func (*Repository) Refresh

func (r *Repository) Refresh(ctx context.Context) error

Refresh periodically makes external changes visible to repository.

func (*Repository) RefreshPeriodically

func (r *Repository) RefreshPeriodically(ctx context.Context, interval time.Duration)

RefreshPeriodically periodically refreshes the repository to reflect the changes made by other hosts.

func (*Repository) Upgrade

func (r *Repository) Upgrade(ctx context.Context) error

Upgrade upgrades repository data structures to the latest version.