blobx

Documentation

Index

• Variables
• type AccountConfig
• type AccountConn
  • func NewAccount(config *AccountConfig) (*AccountConn, error)
  • func (a *AccountConn) AppendBlob(ctx context.Context, container string, reader io.Reader, blobName string) error
  • func (a *AccountConn) BlobBytes(ctx context.Context, container string, blob string) ([]byte, error)
  • func (a *AccountConn) BlobReader(ctx context.Context, container string, blob string) (io.ReadCloser, error)
  • func (a *AccountConn) GetBlobSASURI(ctx context.Context, container string, blobName string, opts SASOptions) (string, error)
  • func (a *AccountConn) GetContainerSASURI(ctx context.Context, container string, opts SASOptions) (string, error)
  • func (a *AccountConn) ListBlobs(ctx context.Context, container string, prefix string) ([]string, error)
  • func (a *AccountConn) ListBlobsByPattern(ctx context.Context, container string, pattern string) ([]string, error)
  • func (a *AccountConn) NewContainer(containerName string) (*ContainerConn, error)
  • func (a *AccountConn) TruncateBlob(ctx context.Context, container string, reader io.Reader, blobName string) error
• type BlobStorage
  • func New(confs []*AccountConfig) (*BlobStorage, error)
  • func (bs *BlobStorage) AppendBlob(ctx context.Context, account string, container string, reader io.Reader, ...) error
  • func (bs *BlobStorage) BlobBytes(ctx context.Context, account string, container string, blob string) ([]byte, error)
  • func (bs *BlobStorage) BlobReader(ctx context.Context, account string, container string, blob string) (io.ReadCloser, error)
  • func (bs *BlobStorage) GetBlobSASURI(ctx context.Context, account string, container string, blobName string, ...) (string, error)
  • func (bs *BlobStorage) GetContainerSASURI(ctx context.Context, account string, container string, opts SASOptions) (string, error)
  • func (bs *BlobStorage) ListBlobs(ctx context.Context, account string, container string, prefix string) ([]string, error)
  • func (bs *BlobStorage) ListBlobsByPattern(ctx context.Context, account string, container string, pattern string) ([]string, error)
  • func (bs *BlobStorage) TruncateBlob(ctx context.Context, account string, container string, reader io.Reader, ...) error
• type ContainerConfig
• type ContainerConn
  • func NewAccountContainerConn(conf ContainerConfig) (*ContainerConn, error)
  • func NewContainerConn(storage storage.BlobStorageClient, containerName string) (*ContainerConn, error)
  • func (c *ContainerConn) AppendBlob(ctx context.Context, reader io.Reader, blobName string) error
  • func (c *ContainerConn) BlobBytes(ctx context.Context, blob string) ([]byte, error)
  • func (c *ContainerConn) BlobReader(ctx context.Context, blobName string) (io.ReadCloser, error)
  • func (c *ContainerConn) GetBlobSASURI(ctx context.Context, blobName string, opts SASOptions) (string, error)
  • func (c *ContainerConn) GetContainerSASURI(ctx context.Context, opts SASOptions) (string, error)
  • func (c *ContainerConn) ListBlobs(ctx context.Context, prefix string) ([]string, error)
  • func (c *ContainerConn) ListBlobsByPattern(ctx context.Context, pattern string) ([]string, error)
  • func (c *ContainerConn) TruncateBlob(ctx context.Context, reader io.Reader, blobName string) error
• type SASOptions

Variables

var (
	ErrUnknownStorageAccount = errors.New("unknown storage account")
	ErrUploadFailed          = errors.New("blob upload failed")
)

Types

type AccountConfig

type AccountConfig struct {
	Name string `validate:"required,min=2"`
	Key  string `validate:"required,min=2"`
}

type AccountConn

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

func NewAccount

func NewAccount(config *AccountConfig) (*AccountConn, error)

NewAccount returns an Azure implementation of a Storage account

func (*AccountConn) AppendBlob

func (a *AccountConn) AppendBlob(ctx context.Context, container string, reader io.Reader, blobName string) error

func (*AccountConn) BlobBytes

func (a *AccountConn) BlobBytes(ctx context.Context, container string, blob string) ([]byte, error)

func (*AccountConn) BlobReader

func (a *AccountConn) BlobReader(ctx context.Context, container string, blob string) (io.ReadCloser, error)

func (*AccountConn) GetBlobSASURI

func (a *AccountConn) GetBlobSASURI(ctx context.Context, container string, blobName string, opts SASOptions) (string, error)

func (*AccountConn) GetContainerSASURI

func (a *AccountConn) GetContainerSASURI(ctx context.Context, container string, opts SASOptions) (string, error)

func (*AccountConn) ListBlobs

func (a *AccountConn) ListBlobs(ctx context.Context, container string, prefix string) ([]string, error)

func (*AccountConn) ListBlobsByPattern

func (a *AccountConn) ListBlobsByPattern(ctx context.Context, container string, pattern string) ([]string, error)

func (*AccountConn) NewContainer

func (a *AccountConn) NewContainer(containerName string) (*ContainerConn, error)

Get the connection to a container in the storage account.

func (*AccountConn) TruncateBlob

func (a *AccountConn) TruncateBlob(ctx context.Context, container string, reader io.Reader, blobName string) error

type BlobStorage

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

func New

func New(confs []*AccountConfig) (*BlobStorage, error)

A collection of storage accounts Send in confs for all blob storage accounts you want to connect to

func (*BlobStorage) AppendBlob

func (bs *BlobStorage) AppendBlob(ctx context.Context, account string, container string, reader io.Reader, blobName string) error

func (*BlobStorage) BlobBytes

func (bs *BlobStorage) BlobBytes(ctx context.Context, account string, container string, blob string) ([]byte, error)

func (*BlobStorage) BlobReader

func (bs *BlobStorage) BlobReader(ctx context.Context, account string, container string, blob string) (io.ReadCloser, error)

func (*BlobStorage) GetBlobSASURI

func (bs *BlobStorage) GetBlobSASURI(ctx context.Context, account string, container string, blobName string, opts SASOptions) (string, error)

func (*BlobStorage) GetContainerSASURI

func (bs *BlobStorage) GetContainerSASURI(ctx context.Context, account string, container string, opts SASOptions) (string, error)

func (*BlobStorage) ListBlobs

func (bs *BlobStorage) ListBlobs(ctx context.Context, account string, container string, prefix string) ([]string, error)

func (*BlobStorage) ListBlobsByPattern

func (bs *BlobStorage) ListBlobsByPattern(ctx context.Context, account string, container string, pattern string) ([]string, error)

func (*BlobStorage) TruncateBlob

func (bs *BlobStorage) TruncateBlob(ctx context.Context, account string, container string, reader io.Reader, blobName string) error

type ContainerConfig

type ContainerConfig struct {
	AccountName   string `validate:"required,min=2"`
	AccountKey    string `validate:"required,min=2"`
	ContainerName string `validate:"required,min=2"`
}

type ContainerConn

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

func NewAccountContainerConn

func NewAccountContainerConn(conf ContainerConfig) (*ContainerConn, error)

Get a connection to a container in an azure storage account. Use this func if you don't have a connection to an Azure account already.

func NewContainerConn

func NewContainerConn(storage storage.BlobStorageClient, containerName string) (*ContainerConn, error)

Get a connection to a container in an azure storage account. Use this func if you already have a connection to an Azure storage account.

func (*ContainerConn) AppendBlob

func (c *ContainerConn) AppendBlob(ctx context.Context, reader io.Reader, blobName string) error

func (*ContainerConn) BlobBytes

func (c *ContainerConn) BlobBytes(ctx context.Context, blob string) ([]byte, error)

func (*ContainerConn) BlobReader

func (c *ContainerConn) BlobReader(ctx context.Context, blobName string) (io.ReadCloser, error)

func (*ContainerConn) GetBlobSASURI

func (c *ContainerConn) GetBlobSASURI(ctx context.Context, blobName string, opts SASOptions) (string, error)

func (*ContainerConn) GetContainerSASURI

func (c *ContainerConn) GetContainerSASURI(ctx context.Context, opts SASOptions) (string, error)

func (*ContainerConn) ListBlobs

func (c *ContainerConn) ListBlobs(ctx context.Context, prefix string) ([]string, error)

func (*ContainerConn) ListBlobsByPattern

func (c *ContainerConn) ListBlobsByPattern(ctx context.Context, pattern string) ([]string, error)

func (*ContainerConn) TruncateBlob

func (c *ContainerConn) TruncateBlob(ctx context.Context, reader io.Reader, blobName string) error

type SASOptions

type SASOptions struct {
	ValidFrom    time.Time
	ValidTo      time.Time
	ReadAccess   bool
	AddAccess    bool
	CreateAccess bool
	WriteAccess  bool
	DeleteAccess bool
	ListAccess   bool
}