azureblob

README

---

id: azureblob title: Azure Blob

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

NOTE: Go 1.18 or later is required. Source: link

Table of Contents

• Signatures
• Installation
• Examples
• Config
• Default Config

Signatures

func New(config ...Config) Storage
func (s *Storage) Get(key string) ([]byte, error)
func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) Delete(key string) error
func (s *Storage) Reset() 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

Examples

Import the storage package.

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

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,
}

Documentation

Index

• Variables
• type Config
• type Credentials
• type Storage
  • func New(config ...Config) *Storage
  • func (s *Storage) Close() error
  • func (s *Storage) Conn() *azblob.Client
  • func (s *Storage) Delete(key string) error
  • func (s *Storage) Get(key string) ([]byte, error)
  • func (s *Storage) Reset() error
  • func (s *Storage) Set(key string, val []byte, exp time.Duration) error

Variables

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

ConfigDefault is the default config

Types

type 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
}

Config defines the config for storage.

type Credentials

type Credentials struct {
	Account string
	Key     string
}

Credentials are the azure storage account access keys

type Storage

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

Storage interface that is implemented by storage providers

func New

func New(config ...Config) *Storage

New creates a new storage

func (*Storage) Close

func (s *Storage) Close() error

Close the storage connextion

func (*Storage) Conn

func (s *Storage) Conn() *azblob.Client

Conn returns storage client

func (*Storage) Delete

func (s *Storage) Delete(key string) error

Delete entry by key

func (*Storage) Get

func (s *Storage) Get(key string) ([]byte, error)

Get value by key

func (*Storage) Reset

func (s *Storage) Reset() error

Reset all entries

func (*Storage) Set

func (s *Storage) Set(key string, val []byte, exp time.Duration) error

Set key with value