README.md

id	arangodb
title	ArangoDB

A ArangoDB storage driver using arangodb/go-driver and arangodb/go-driver.

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 driver.Client, config ...Config) *Storage
func NewFromConnectionWithContext(ctx context.Context, client driver.Client, config ...Config) *Storage
func (s *Storage) GetWithContext(ctx context.Context, key string) ([]byte, error)
func (s *Storage) Get(key string) ([]byte, error)
func (s *Storage) SetWithContext(ctx context.Context, key string, val []byte, exp time.Duration) error
func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) DeleteWithContext(ctx context.Context, key string) error
func (s *Storage) Delete(key string) error
func (s *Storage) ResetWithContext(ctx context.Context) error
func (s *Storage) Reset() error
func (s *Storage) Close() error
func (s *Storage) Conn() driver.Client

Note: Expirations are stored with a one-second granularity and rounded up, so an entry is never dropped before its expiration but may outlive it by up to a second.

Installation

ArangoDB is tested on the 2 last (1.14/1.15) 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 arangodb implementation:

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

Examples

Import the storage package.

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

You can use the following possibilities to create a storage:

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

// Initialize custom config
store := arangodb.New(arangodb.Config{
	Host:       "http://127.0.0.1",
	Port:       8529,
	Database:   "fiber",
	Collection: "fiber_storage",
	Reset:      false,
	GCInterval: 10 * time.Second,
})

Config

type Config struct {
	// Host name where the DB is hosted
	//
	// Optional. Default is "http://127.0.0.1"
	Host string

	// Port where the DB is listening on
	//
	// Optional. Default is 8529
	Port int

	// Server username
	//
	// Optional. Default is ""
	Username string

	// Server password
	//
	// Optional. Default is ""
	Password string

	// Database name
	//
	// Optional. Default is "fiber"
	Database string

	// Collection name
	//
	// Optional. Default is "fiber_storage"
	Collection string

	// Reset clears any existing keys in existing collection
	//
	// Optional. Default is false
	Reset bool
	// Time before deleting expired keys
	//
	// Optional. Default is 10 * time.Second
	GCInterval time.Duration
}

Default Config

Used only for optional fields

var ConfigDefault = Config{
	Host:       "http://127.0.0.1",
	Port:       8529,
	Database:   "fiber",
	Collection: "fiber_storage",
	Reset:      false,
	GCInterval: 10 * time.Second,
}

Using an Existing ArangoDB Connection

If your application already holds a driver.Client, you can build the storage on it instead of creating a second one. Only the Database, Collection, Reset and GCInterval options are read; the endpoint and credentials come from the client, and connection fields left over in the config (Host, Port, Username, Password) are ignored.

Close on a storage built this way stops the garbage collector; ArangoDB's driver has no connection to close, so the client keeps working.

import (
    "github.com/arangodb/go-driver"
    "github.com/arangodb/go-driver/http"
    "github.com/gofiber/storage/arangodb/v2"
)

func main() {
    conn, err := http.NewConnection(http.ConnectionConfig{
        Endpoints: []string{"http://127.0.0.1:8529"},
    })
    if err != nil {
        panic(err)
    }

    client, err := driver.NewClient(driver.ClientConfig{
        Connection:     conn,
        Authentication: driver.BasicAuthentication("root", "password"),
    })
    if err != nil {
        panic(err)
    }

    store := arangodb.NewFromConnection(client, arangodb.Config{
        Database:   "fiber",
        Collection: "fiber_storage",
    })
    defer store.Close()
}