mirror of
https://github.com/gofiber/storage.git
synced 2025-09-26 20:41:45 +08:00
3732138a82
Some checks failed
Benchmark / changes (push) Has been cancelled
Golangci-Lint Check / changes (push) Has been cancelled
Release Drafter (All) / changes (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 S3 / Tests (1.23.x) (push) Has been cancelled
Tests S3 / Tests (1.24.x) (push) Has been cancelled
Benchmark / compare (push) Has been cancelled
Golangci-Lint Check / lint (push) Has been cancelled
Release Drafter (All) / release-drafter (push) Has been cancelled
chore(deps): bump the aws-modules group across 2 directories with 7 updates
title, description, sidebar_position
| title | description | sidebar_position |
|---|---|---|
| 👋 Welcome | 📦 Premade storage drivers for 🚀 Fiber. | 1 |
Premade storage drivers that implement the Storage interface, designed to be used with various Fiber middlewares.
Note: All storages are tested with the latest two Go version. Older Go versions may also work, but are not guaranteed to be supported.
// Storage interface for communicating with different database/key-value
// providers. Visit https://github.com/gofiber/storage for more info.
type Storage interface {
// GetWithContext gets the value for the given key with a context.
// `nil, nil` is returned when the key does not exist
GetWithContext(ctx context.Context, key string) ([]byte, error)
// Get gets the value for the given key.
// `nil, nil` is returned when the key does not exist
Get(key string) ([]byte, error)
// SetWithContext stores the given value for the given key
// with an expiration value, 0 means no expiration.
SetWithContext(ctx context.Context, key string, val []byte, exp time.Duration) error
// Set stores the given value for the given key along
// with an expiration value, 0 means no expiration.
// Empty key or value will be ignored without an error.
Set(key string, val []byte, exp time.Duration) error
// DeleteWithContext deletes the value for the given key with a context.
// It returns no error if the storage does not contain the key,
DeleteWithContext(ctx context.Context, key string) error
// Delete deletes the value for the given key.
// It returns no error if the storage does not contain the key,
Delete(key string) error
// ResetWithContext resets the storage and deletes all keys with a context.
ResetWithContext(ctx context.Context) error
// Reset resets the storage and delete all keys.
Reset() error
// Close closes the storage and will stop any running garbage
// collectors and open connections.
Close() error
}
