s3

Documentation

Index

• func Create(cfg Config) (restic.Backend, error)
• func Open(cfg Config) (restic.Backend, error)
• func ParseConfig(s string) (interface{}, error)
• type Backend
  • func (be *Backend) Close() error
  • func (be *Backend) Delete(ctx context.Context) error
  • func (be *Backend) IsNotExist(err error) bool
  • func (be *Backend) Join(p ...string) string
  • func (be *Backend) List(ctx context.Context, t restic.FileType) <-chan string
  • func (be *Backend) Load(ctx context.Context, h restic.Handle, length int, offset int64) (io.ReadCloser, error)
  • func (be *Backend) Location() string
  • func (be *Backend) Path() string
  • func (be *Backend) ReadDir(dir string) (list []os.FileInfo, err error)
  • func (be *Backend) Remove(ctx context.Context, h restic.Handle) error
  • func (be *Backend) Rename(h restic.Handle, l backend.Layout) error
  • func (be *Backend) Save(ctx context.Context, h restic.Handle, rd io.Reader) (err error)
  • func (be *Backend) Stat(ctx context.Context, h restic.Handle) (bi restic.FileInfo, err error)
  • func (be *Backend) Test(ctx context.Context, h restic.Handle) (bool, error)
• type Config
  • func NewConfig() Config

Functions

func Create

func Create(cfg Config) (restic.Backend, error)

Create opens the S3 backend at bucket and region and creates the bucket if it does not exist yet.

func Open

func Open(cfg Config) (restic.Backend, error)

Open opens the S3 backend at bucket and region. The bucket is created if it does not exist yet.

func ParseConfig

func ParseConfig(s string) (interface{}, error)

ParseConfig parses the string s and extracts the s3 config. The two supported configuration formats are s3://host/bucketname/prefix and s3:host:bucketname/prefix. The host can also be a valid s3 region name. If no prefix is given the prefix "restic" will be used.

Types

type Backend

type Backend struct {
	backend.Layout
	// contains filtered or unexported fields
}

Backend stores data on an S3 endpoint.

func (*Backend) Close

func (be *Backend) Close() error

Close does nothing

func (*Backend) Delete

func (be *Backend) Delete(ctx context.Context) error

Delete removes all restic keys in the bucket. It will not remove the bucket itself.

func (*Backend) IsNotExist

func (be *Backend) IsNotExist(err error) bool

IsNotExist returns true if the error is caused by a not existing file.

func (*Backend) Join

func (be *Backend) Join(p ...string) string

Join combines path components with slashes.

func (*Backend) List

func (be *Backend) List(ctx context.Context, t restic.FileType) <-chan string

List returns a channel that yields all names of blobs of type t. A goroutine is started for this. If the channel done is closed, sending stops.

func (*Backend) Load

func (be *Backend) Load(ctx context.Context, h restic.Handle, length int, offset int64) (io.ReadCloser, error)

Load returns a reader that yields the contents of the file at h at the given offset. If length is nonzero, only a portion of the file is returned. rd must be closed after use.

func (*Backend) Location

func (be *Backend) Location() string

Location returns this backend's location (the bucket name).

func (*Backend) Path

func (be *Backend) Path() string

Path returns the path in the bucket that is used for this backend.

func (*Backend) ReadDir

func (be *Backend) ReadDir(dir string) (list []os.FileInfo, err error)

ReadDir returns the entries for a directory.

func (*Backend) Remove

func (be *Backend) Remove(ctx context.Context, h restic.Handle) error

Remove removes the blob with the given name and type.

func (*Backend) Rename

func (be *Backend) Rename(h restic.Handle, l backend.Layout) error

Rename moves a file based on the new layout l.

func (*Backend) Save

func (be *Backend) Save(ctx context.Context, h restic.Handle, rd io.Reader) (err error)

Save stores data in the backend at the handle.

func (*Backend) Stat

func (be *Backend) Stat(ctx context.Context, h restic.Handle) (bi restic.FileInfo, err error)

Stat returns information about a blob.

func (*Backend) Test

func (be *Backend) Test(ctx context.Context, h restic.Handle) (bool, error)

Test returns true if a blob of the given type and name exists in the backend.

type Config

type Config struct {
	Endpoint      string
	UseHTTP       bool
	KeyID, Secret string
	Bucket        string
	Prefix        string
	Layout        string `option:"layout" help:"use this backend layout (default: auto-detect)"`

	Connections uint `option:"connections" help:"set a limit for the number of concurrent connections (default: 5)"`
	MaxRetries  uint `option:"retries" help:"set the number of retries attempted"`
}

Config contains all configuration necessary to connect to an s3 compatible server.

func NewConfig

func NewConfig() Config

NewConfig returns a new Config with the default values filled in.