Couchbase

A Couchbase storage driver using couchbase/gocb.

Table of Contents

• Signatures
• Installation
• Examples
• Config
• Default Config

Signatures

func New(config ...Config) Storage
func NewFromConnection(cluster *gocb.Cluster, 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() *gocb.Cluster

Installation

Couchbase 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 Couchbase implementation:

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

Examples

Import the storage package.

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

You can use the following possibilities to create a storage:

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

// Initialize Couchbase storage with custom config
store := couchbase.New(couchbase.Config{
	Host:      "127.0.0.1:8091",
	Username:  "",
	Password:  "",
	Bucket:  0,
	ConnectionTimeout: 3* time.Second,
	KVTimeout: 1* time.Second,
})

Config

type Config struct {
    // The application username to Connect to the Couchbase cluster
    Username string
    // The application password to Connect to the Couchbase cluster
    Password string
    // The connection string for the Couchbase cluster
    Host string
    // The name of the bucket to Connect to
    Bucket string
    // The timeout for connecting to the Couchbase cluster
    ConnectionTimeout time.Duration
    // The timeout for performing operations on the Couchbase cluster
    KVTimeout time.Duration
}

Default Config

// ConfigDefault is the default config
var ConfigDefault = Config{
    Host:              "127.0.0.1:8091",
    Username:          "admin",
    Password:          "123456",
    Bucket:            "fiber_storage",
    ConnectionTimeout: 3 * time.Second,
    KVTimeout:         1 * time.Second,
}

Using an Existing Couchbase Connection

If your application already holds a *gocb.Cluster, you can build the storage on it instead of connecting a second time. Only the Bucket option is read; the connection settings come from the cluster. Values are read and written with a legacy transcoder passed per operation, so a cluster left on gocb's default JSON transcoder still stores raw bytes.

The cluster stays yours to close: Close on a storage built this way leaves it open, so the rest of your application keeps working. The storage itself is closed: any operation on it afterwards returns ErrClosed.

import (
    "github.com/couchbase/gocb/v2"
    "github.com/gofiber/storage/couchbase/v2"
)

func main() {
    cluster, err := gocb.Connect("127.0.0.1", gocb.ClusterOptions{
        Authenticator: gocb.PasswordAuthenticator{
            Username: "user",
            Password: "password",
        },
    })
    if err != nil {
        panic(err)
    }
    defer cluster.Close(nil)

    store := couchbase.NewFromConnection(cluster, couchbase.Config{
        Bucket: "fiber_storage",
    })
    defer store.Close()
}