storage/coherence/README.md

Coherence

A Coherence storage driver using https://github.com/oracle/coherence-go-client.

Table of Contents

• Signatures
• Installation
• Examples
• Config
• Default Config

Signatures

func New(config ...Config) (*Storage, error)
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() *Session

Installation

Coherence is supported on Go versions 1.19 and above:

Install the coherence implementation:

go get github.com/gofiber/storage/coherence

Before running or testing this implementation, you must ensure a Coherence cluster is available. For local development, we recommend using the Coherence CE Docker image; it contains everything necessary for the client to operate correctly.

To start a Coherence cluster using Docker, issue the following:

docker run -d -p 1408:1408 ghcr.io/oracle/coherencestore-ce:22.06.5

See the documentation here on connection options when creating a Coherence session.

Examples

Import the storage package.

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

You can use the following possibilities to create a storage:

// Initialize default config, to connect to localhost:1408 using plain text
store, err := coherence.New()

// Initialize custom config to connect to a different host/port and use plaintext.
store, err := coherence.New(coherence.Config{
    Address: "my-host:myport",
    UseSSL: false,
})

Note: If you create two stores using coherence.New() they will effectivity be idential. If you wish to have two separate stores, then you can use:

store1, err := coherence.New(Config{SessionScope: "scope1"})
store2, err := coherence.New(Config{SessionScope: "scope2"})

### Config
```go
// Config defines configuration options for Coherence connection.
type Config struct {
    // Address to connect to, defaults to "localhost:1408"
    Address string

    // UseSSL specified if to use SSL or plain text, defaults to false
    UseSSL bool

    // SessionTimeout is the default session timeout to connect to Coherence, defaults to 30s
    SessionTimeout time.Duration

    // SessionScope defines a scope allowing for multiple storage sessions
    SessionScope string
}

Default Config

var ConfigDefault = Config{
    Address:        "localhost:1408",
    UseSSL:         false,
    SessionTimeout: time.Duration(30) * time.Millisecond,
    SessionScope:   defaultScopeName,
}