remote

Documentation

Overview

Package remote implements S3-compatible object stores (AWS S3, MinIO, Cloudflare R2, Backblaze B2) using DVC's content-addressed key layout.

Index

• type S3
  • func NewS3(r repo.Remote) (*S3, error)
  • func (s *S3) Delete(ctx context.Context, oid string) error
  • func (s *S3) EnsureBucket(ctx context.Context) error
  • func (s *S3) Get(ctx context.Context, oid, localPath string) error
  • func (s *S3) Has(ctx context.Context, oid string) (bool, error)
  • func (s *S3) ListOIDs(ctx context.Context) (map[string]struct{}, error)
  • func (s *S3) Put(ctx context.Context, oid, localPath string) error
  • func (s *S3) Reachable(ctx context.Context) error

Types

type S3

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

S3 is an S3-compatible remote.

func NewS3

func NewS3(r repo.Remote) (*S3, error)

NewS3 builds an S3 store from a remote config.

func (*S3) Delete

func (s *S3) Delete(ctx context.Context, oid string) error

func (*S3) EnsureBucket

func (s *S3) EnsureBucket(ctx context.Context) error

EnsureBucket creates the bucket if it does not exist (used in tests / first push to a fresh MinIO).

func (*S3) Get

func (s *S3) Get(ctx context.Context, oid, localPath string) error

func (*S3) Has

func (s *S3) Has(ctx context.Context, oid string) (bool, error)

func (*S3) ListOIDs

func (s *S3) ListOIDs(ctx context.Context) (map[string]struct{}, error)

func (*S3) Put

func (s *S3) Put(ctx context.Context, oid, localPath string) error

func (*S3) Reachable

func (s *S3) Reachable(ctx context.Context) error

Reachable verifies connectivity and authentication by listing one object under the prefix. A non-nil error means the remote is unreachable or the credentials are invalid (used by `lode doctor`).