Azure Blob

Azure Blob storage is Microsoft's object storage solution for the cloud.

Table of Contents

• Signatures
• Installation
• Examples
• Config
• Default Config

Signatures

func New(config ...Config) Storage
func NewWithContext(ctx context.Context, config ...Config) *Storage
func NewFromConnection(client *azblob.Client, config ...Config) *Storage
func NewFromConnectionWithContext(ctx context.Context, client *azblob.Client, config ...Config) *Storage
func (s *Storage) Get(key string) ([]byte, error)
func (s *Storage) GetWithContext(ctx context.Context, key string) ([]byte, error)
func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) SetWithContext(ctx context.Context, key string, val []byte, exp time.Duration) error
func (s *Storage) Delete(key string) error
func (s *Storage) DeleteWithContext(ctx context.Context, key string) error
func (s *Storage) Reset() error
func (s *Storage) ResetWithContext(ctx context.Context) error
func (s *Storage) Close() error
func (s *Storage) Conn() *azblob.Client

Installation

Azure blob storage driver is tested on the 2 last Go versions with support for modules. So make sure to initialize one first if you didn't do that yet:

go mod init github.com/<user>/<repo>

And then install the azure blob implementation:

go get github.com/gofiber/storage/azureblob/v2

Examples

Import the storage package.

import "github.com/gofiber/storage/azureblob/v2"

You can use the following possibilities to create a storage:

// Initialize default config
store := azureblob.New()

// Initialize custom config
store := azureblob.New(azureblob.Config{
    Account:   "test",
    Container: "test",
    Credentials: Credentials{
        Account: "test",
        Key:     "YXp1cml0ZWtleQo=",
    },
})

Config

type Config struct {
    // Storage account name.
    Account string
    // Container name.
    Container string
    // Storage endpoint.
    // Optional. Default: "https://STORAGEACCOUNTNAME.blob.core.windows.net"
    Endpoint string
    // Request timeout.
    // Optional. Default is 0 (no timeout)
    RequestTimeout time.Duration
    // Reset clears any existing keys in existing container.
    // Optional. Default is false
    Reset bool
    // Credentials overrides AWS access key and AWS secret access key. Not recommended.
    // Optional. Default is Credentials{}
    Credentials Credentials
    // The maximum number of times requests that encounter retryable failures should be attempted.
    // Optional. Default is 3
    MaxAttempts int
}

Default Config

var ConfigDefault = Config{
    Account:        "",
    Container:      "",
    Endpoint:       "",
    RequestTimeout: 0,
    Reset:          false,
    MaxAttempts:    3,
}

Using an Existing Azure Blob Client

If your application already holds an *azblob.Client, you can build the storage on it instead of creating a second one. Only the Container, RequestTimeout and Reset options are read; the endpoint and credentials come from the client.

The client stays yours to manage: Close on a storage built this way is a no-op, so the rest of your application keeps working.

import (
    "github.com/Azure/azure-sdk-for-go/sdk/storage/azblob"
    "github.com/gofiber/storage/azureblob/v2"
)

func main() {
    cred, err := azblob.NewSharedKeyCredential("account", "key")
    if err != nil {
        panic(err)
    }

    client, err := azblob.NewClientWithSharedKeyCredential("https://account.blob.core.windows.net/", cred, nil)
    if err != nil {
        panic(err)
    }

    store := azureblob.NewFromConnection(client, azureblob.Config{
        Container: "fiber",
    })
    defer store.Close()
}