mirror of
https://github.com/gofiber/storage.git
synced 2025-12-19 00:38:24 +08:00
Some checks failed
Release Drafter (All) / changes (push) Has been cancelled
Sync docs / sync-docs (push) Has been cancelled
Tests ArangoDB / Tests (1.19.x) (push) Has been cancelled
Tests ArangoDB / Tests (1.20.x) (push) Has been cancelled
Tests ArangoDB / Tests (1.21.x) (push) Has been cancelled
Tests Azure Blob / Tests (1.19.x) (push) Has been cancelled
Tests Azure Blob / Tests (1.20.x) (push) Has been cancelled
Tests Azure Blob / Tests (1.21.x) (push) Has been cancelled
Tests Badger / Tests (1.19.x) (push) Has been cancelled
Tests Badger / Tests (1.20.x) (push) Has been cancelled
Tests Badger / Tests (1.21.x) (push) Has been cancelled
Tests Bbolt / Tests (1.19.x) (push) Has been cancelled
Tests Bbolt / Tests (1.20.x) (push) Has been cancelled
Tests Bbolt / Tests (1.21.x) (push) Has been cancelled
Tests Clickhouse / Tests (1.22.x) (push) Has been cancelled
Tests Clickhouse / Tests (1.23.x) (push) Has been cancelled
Tests Clickhouse / Tests (1.24.x) (push) Has been cancelled
Tests CloudflareKV / Tests (1.21.x) (push) Has been cancelled
Tests CloudflareKV / Tests (1.22.x) (push) Has been cancelled
Tests Coherence / Tests (1.19.x) (push) Has been cancelled
Tests Coherence / Tests (1.20.x) (push) Has been cancelled
Tests Coherence / Tests (1.21.x) (push) Has been cancelled
Tests Coherence / Tests (1.22.x) (push) Has been cancelled
Tests Couchbase / Tests (1.22.x) (push) Has been cancelled
Tests Couchbase / Tests (1.23.x) (push) Has been cancelled
Tests Couchbase / Tests (1.24.x) (push) Has been cancelled
Tests DynamoDB / Tests (1.22.x) (push) Has been cancelled
Tests DynamoDB / Tests (1.23.x) (push) Has been cancelled
Tests DynamoDB / Tests (1.24.x) (push) Has been cancelled
Tests Etcd / Tests (1.19.x) (push) Has been cancelled
Tests Etcd / Tests (1.20.x) (push) Has been cancelled
Tests Etcd / Tests (1.21.x) (push) Has been cancelled
Tests LevelDB / Tests (1.23.x) (push) Has been cancelled
Tests LevelDB / Tests (1.24.x) (push) Has been cancelled
Tests Memcache / Tests (1.19.x) (push) Has been cancelled
Tests Memcache / Tests (1.20.x) (push) Has been cancelled
Tests Memcache / Tests (1.21.x) (push) Has been cancelled
Tests Local Storage / Tests (1.19.x) (push) Has been cancelled
Tests Local Storage / Tests (1.20.x) (push) Has been cancelled
Tests Local Storage / Tests (1.21.x) (push) Has been cancelled
Tests Minio / Tests (1.22.x) (push) Has been cancelled
Tests Minio / Tests (1.23.x) (push) Has been cancelled
Tests Minio / Tests (1.24.x) (push) Has been cancelled
Tests Local Storage / Tests (1.22.x) (push) Has been cancelled
Tests Mongodb / Tests (1.22.x) (push) Has been cancelled
Tests Mongodb / Tests (1.23.x) (push) Has been cancelled
Tests Mongodb / Tests (1.24.x) (push) Has been cancelled
Tests MSSQL / Tests (1.19.x) (push) Has been cancelled
Tests MSSQL / Tests (1.20.x) (push) Has been cancelled
Tests MSSQL / Tests (1.21.x) (push) Has been cancelled
Tests MySQL / Tests (1.22.x) (push) Has been cancelled
Tests MySQL / Tests (1.23.x) (push) Has been cancelled
Tests MySQL / Tests (1.24.x) (push) Has been cancelled
Tests Nats Driver / Tests (1.22.x) (push) Has been cancelled
Tests Nats Driver / Tests (1.23.x) (push) Has been cancelled
Tests Nats Driver / Tests (1.24.x) (push) Has been cancelled
Tests Neo4j / Tests (1.23.x) (push) Has been cancelled
Tests pebble / Tests (1.19.x) (push) Has been cancelled
Tests pebble / Tests (1.20.x) (push) Has been cancelled
Tests pebble / Tests (1.21.x) (push) Has been cancelled
Tests Postgres / Tests (1.22.x) (push) Has been cancelled
Tests Postgres / Tests (1.23.x) (push) Has been cancelled
Tests Postgres / Tests (1.24.x) (push) Has been cancelled
Tests Redis / Tests (1.19.x, 6.x) (push) Has been cancelled
Tests Redis / Tests (1.19.x, 7.x) (push) Has been cancelled
Tests Redis / Tests (1.20.x, 6.x) (push) Has been cancelled
Tests Redis / Tests (1.20.x, 7.x) (push) Has been cancelled
Tests Redis / Tests (1.21.x, 6.x) (push) Has been cancelled
Tests Redis / Tests (1.21.x, 7.x) (push) Has been cancelled
Tests Ristretto / Tests (1.19.x) (push) Has been cancelled
Tests Ristretto / Tests (1.20.x) (push) Has been cancelled
Tests Ristretto / Tests (1.21.x) (push) Has been cancelled
Tests Rueidis / Tests (1.20.x, 6.x) (push) Has been cancelled
Tests Rueidis / Tests (1.20.x, 7.x) (push) Has been cancelled
Tests Rueidis / Tests (1.21.x, 6.x) (push) Has been cancelled
Tests Rueidis / Tests (1.21.x, 7.x) (push) Has been cancelled
Tests S3 / Tests (1.21.x) (push) Has been cancelled
Tests S3 / Tests (1.22.x) (push) Has been cancelled
Tests S3 / Tests (1.23.x) (push) Has been cancelled
Tests ScyllaDb / Tests (1.20.x) (push) Has been cancelled
Tests ScyllaDb / Tests (1.21.x) (push) Has been cancelled
Tests Sqlite3 / Tests (1.19.x) (push) Has been cancelled
Tests Sqlite3 / Tests (1.20.x) (push) Has been cancelled
Tests Sqlite3 / Tests (1.21.x) (push) Has been cancelled
Tests Valkey / Tests (1.23.x, 7.x) (push) Has been cancelled
Tests Valkey / Tests (1.23.x, 8.x) (push) Has been cancelled
Release Drafter (All) / release-drafter (push) Has been cancelled
81 lines
2.0 KiB
Markdown
81 lines
2.0 KiB
Markdown
---
|
|
id: memcache
|
|
title: Memcache
|
|
---
|
|
|
|

|
|
[](https://gofiber.io/discord)
|
|

|
|
|
|
A Memcache storage driver using [`bradfitz/gomemcache`](https://github.com/bradfitz/gomemcache).
|
|
|
|
**Note: Requires Go 1.19 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() *mc.Client
|
|
```
|
|
|
|
### Installation
|
|
Memory 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 memory implementation:
|
|
```bash
|
|
go get github.com/gofiber/storage/memory/v2
|
|
```
|
|
|
|
### Examples
|
|
Import the storage package.
|
|
```go
|
|
import "github.com/gofiber/storage/memcache"
|
|
```
|
|
|
|
You can use the following possibilities to create a storage:
|
|
```go
|
|
// Initialize default config
|
|
store := memcache.New()
|
|
|
|
// Initialize custom config
|
|
store := memcache.New(memcache.Config{
|
|
Servers: "localhost:11211",
|
|
})
|
|
```
|
|
|
|
### Config
|
|
```go
|
|
type Config struct {
|
|
// Server list divided by ,
|
|
// i.e. server1:11211, server2:11212
|
|
//
|
|
// Optional. Default is "127.0.0.1:11211"
|
|
Servers string
|
|
|
|
// Reset clears any existing keys in existing Table
|
|
//
|
|
// Optional. Default is false
|
|
Reset bool
|
|
}
|
|
```
|
|
|
|
### Default Config
|
|
```go
|
|
var ConfigDefault = Config{
|
|
Servers: "127.0.0.1:11211",
|
|
}
|
|
```
|