azure

Documentation

Index

• func NewFactory() location.Factory
• type Backend
  • func Create(ctx context.Context, cfg Config, rt http.RoundTripper) (*Backend, error)
  • func Open(_ context.Context, cfg Config, rt http.RoundTripper) (*Backend, error)
  • func (be *Backend) Close() error
  • func (be *Backend) Connections() uint
  • func (be *Backend) Delete(ctx context.Context) error
  • func (be *Backend) HasAtomicReplace() bool
  • func (be *Backend) Hasher() hash.Hash
  • func (be *Backend) IsNotExist(err error) bool
  • func (be *Backend) IsPermanentError(err error) bool
  • func (be *Backend) Join(p ...string) string
  • func (be *Backend) List(ctx context.Context, t backend.FileType, fn func(backend.FileInfo) error) error
  • func (be *Backend) Load(ctx context.Context, h backend.Handle, length int, offset int64, ...) error
  • func (be *Backend) Path() string
  • func (be *Backend) Remove(ctx context.Context, h backend.Handle) error
  • func (be *Backend) Save(ctx context.Context, h backend.Handle, rd backend.RewindReader) error
  • func (be *Backend) SetListMaxItems(i int)
  • func (be *Backend) Stat(ctx context.Context, h backend.Handle) (backend.FileInfo, error)
• type Config
  • func NewConfig() Config
  • func ParseConfig(s string) (*Config, error)
  • func (cfg *Config) ApplyEnvironment(prefix string)

Functions

func NewFactory

func NewFactory() location.Factory

Types

type Backend

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

Backend stores data on an azure endpoint.

func Create

func Create(ctx context.Context, cfg Config, rt http.RoundTripper) (*Backend, error)

Create opens the Azure backend at specified container and creates the container if it does not exist yet.

func Open

func Open(_ context.Context, cfg Config, rt http.RoundTripper) (*Backend, error)

Open opens the Azure backend at specified container.

func (*Backend) Close

func (be *Backend) Close() error

Close does nothing

func (*Backend) Connections

func (be *Backend) Connections() uint

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) HasAtomicReplace

func (be *Backend) HasAtomicReplace() bool

HasAtomicReplace returns whether Save() can atomically replace files

func (*Backend) Hasher

func (be *Backend) Hasher() hash.Hash

Hasher may return a hash function for calculating a content hash for the backend

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) IsPermanentError

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

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 backend.FileType, fn func(backend.FileInfo) error) error

List runs fn for each file in the backend which has the type t. When an error occurs (or fn returns an error), List stops and returns it.

func (*Backend) Load

func (be *Backend) Load(ctx context.Context, h backend.Handle, length int, offset int64, fn func(rd io.Reader) error) error

Load runs fn with a reader that yields the contents of the file at h at the given offset.

func (*Backend) Path

func (be *Backend) Path() string

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

func (*Backend) Remove

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

Remove removes the blob with the given name and type.

func (*Backend) Save

func (be *Backend) Save(ctx context.Context, h backend.Handle, rd backend.RewindReader) error

Save stores data in the backend at the handle.

func (*Backend) SetListMaxItems

func (be *Backend) SetListMaxItems(i int)

SetListMaxItems sets the number of list items to load per request.

func (*Backend) Stat

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

Stat returns information about a blob.

type Config

type Config struct {
	AccountName        string
	AccountSAS         options.SecretString
	AccountKey         options.SecretString
	ForceCliCredential bool
	EndpointSuffix     string
	Container          string
	Prefix             string

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

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

func NewConfig

func NewConfig() Config

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

func ParseConfig

func ParseConfig(s string) (*Config, error)

ParseConfig parses the string s and extracts the azure config. The configuration format is azure:containerName:/[prefix].

func (*Config) ApplyEnvironment

func (cfg *Config) ApplyEnvironment(prefix string)

ApplyEnvironment saves values from the environment to the config.