mirror of
https://github.com/gofiber/storage.git
synced 2025-12-19 00:38:24 +08:00
120 lines
3.0 KiB
Markdown
120 lines
3.0 KiB
Markdown
---
|
|
id: aerospike
|
|
title: Aerospike
|
|
---
|
|
|
|
|
|
[](https://gofiber.io/discord)
|
|
|
|
|
|
An Aerospike client driver using `aerospike/aerospike-client-go` and [aerospike/aerospike-client-go](https://github.com/aerospike/aerospike-client-go).
|
|
|
|
**Note: Requires Go 1.23 and above**
|
|
|
|
### Table of Contents
|
|
|
|
- [Signatures](#signatures)
|
|
- [Installation](#installation)
|
|
- [Examples](#examples)
|
|
- [Config](#config)
|
|
- [Default Config](#default-config)
|
|
|
|
### Signatures
|
|
|
|
```go
|
|
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() driver.Client
|
|
func (s *Storage) GetSchemaInfo() *SchemaInfo
|
|
```
|
|
|
|
### Installation
|
|
|
|
Aerospike is tested on the 2 last [Go versions](https://golang.org/dl/) with support for modules. So make sure to initialize one first if you didn't do that yet:
|
|
|
|
```bash
|
|
go mod init github.com/<user>/<repo>
|
|
```
|
|
|
|
And then install the aerospike implementation:
|
|
|
|
```bash
|
|
go get github.com/gofiber/storage/aerospike
|
|
```
|
|
|
|
### Examples
|
|
|
|
Import the storage package.
|
|
|
|
```go
|
|
import "github.com/gofiber/storage/aerospike"
|
|
```
|
|
|
|
You can use the following possibilities to create a storage:
|
|
|
|
```go
|
|
// Initialize default config
|
|
store := aerospike.New()
|
|
|
|
// Initialize custom config
|
|
store := aerospike.New(aerospike.Config{
|
|
Hosts: []*aerospike.Host{aerospike.NewHost("localhost", 3000)},
|
|
Namespace: "test", // Default namespace
|
|
SetName: "fiber",
|
|
Reset: false,
|
|
Expiration: 1 * time.Hour,
|
|
SchemaVersion: 1,
|
|
SchemaDescription: "Default Fiber storage schema",
|
|
ForceSchemaUpdate: false,
|
|
})
|
|
```
|
|
|
|
### Config
|
|
|
|
```go
|
|
type Config struct {
|
|
// Hosts is a list of Aerospike server hosts
|
|
Hosts []*aerospike.Host
|
|
|
|
// Namespace is the Aerospike namespace
|
|
Namespace string
|
|
|
|
// Set is the Aerospike set
|
|
SetName string
|
|
|
|
// Reset clears any existing keys in existing Set
|
|
Reset bool
|
|
|
|
// Expiration is the default expiration time of entries
|
|
Expiration time.Duration
|
|
|
|
// SchemaVersion indicates the schema version to use
|
|
SchemaVersion int
|
|
|
|
// SchemaDescription provides additional info about the schema
|
|
SchemaDescription string
|
|
|
|
// ForceSchemaUpdate forces schema update even if version matches
|
|
ForceSchemaUpdate bool
|
|
}
|
|
```
|
|
|
|
### Default Config
|
|
Used only for optional fields
|
|
```go
|
|
var ConfigDefault = Config{
|
|
Hosts: []*aerospike.Host{aerospike.NewHost("localhost", 3000)},
|
|
Namespace: "test", // Default namespace
|
|
SetName: "fiber",
|
|
Reset: false,
|
|
Expiration: 1 * time.Hour,
|
|
SchemaVersion: 1,
|
|
SchemaDescription: "Default Fiber storage schema",
|
|
ForceSchemaUpdate: false,
|
|
}
|
|
```
|