mirror of
https://github.com/gofiber/storage.git
synced 2025-12-19 00:38:24 +08:00
115 lines
2.6 KiB
Markdown
115 lines
2.6 KiB
Markdown
---
|
|
id: cloudflarekv
|
|
title: Cloudflare KV
|
|
---
|
|
|
|
|
|
[](https://gofiber.io/discord)
|
|
|
|
|
|
A Cloudflare KV storage driver using [cloudflare/cloudflare-go](https://github.com/cloudflare/cloudflare-go).
|
|
|
|
### 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) 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() *cloudflare.API
|
|
```
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
go mod init github.com/<user>/<repo>
|
|
```
|
|
|
|
And then install the Cloudflare KV implementation:
|
|
|
|
```bash
|
|
go get github.com/gofiber/storage/cloudflarekv
|
|
```
|
|
|
|
### Examples
|
|
|
|
Import the storage package.
|
|
|
|
```go
|
|
import "github.com/gofiber/storage/cloudflarekv"
|
|
```
|
|
|
|
You can use the following methods to create storage. The Key must be an API Token generated with at least `Account.Workers KV Storage` permission. Check the [Create API Token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/) documentation to generate one.
|
|
|
|
```go
|
|
// Initialize default config
|
|
store := cloudflarekv.New()
|
|
|
|
store := cloudflarekv.New(cloudflarekv.Config{
|
|
Key: "",
|
|
Email: "",
|
|
AccountID: "fiber",
|
|
NamespaceID: "fiber",
|
|
Reset: false,
|
|
})
|
|
|
|
```
|
|
|
|
### Config
|
|
|
|
```go
|
|
type Config struct {
|
|
|
|
// Cloudflare Auth Token
|
|
//
|
|
// Optional. Default is ""
|
|
Key string
|
|
|
|
// Cloudflare Email
|
|
//
|
|
// Optional. Default is ""
|
|
Email string
|
|
|
|
// Account id
|
|
//
|
|
// Optional. Default is "fiber"
|
|
AccountID string
|
|
|
|
// Namespace id
|
|
//
|
|
// Optional. Default is "fiber"
|
|
NamespaceID string
|
|
|
|
// Reset clears any existing keys in existing Table
|
|
//
|
|
// Optional. Default is false
|
|
Reset bool
|
|
}
|
|
```
|
|
|
|
### Default Config
|
|
|
|
```go
|
|
var ConfigDefault = Config{
|
|
Key: "",
|
|
Email: "",
|
|
AccountID: "fiber",
|
|
NamespaceID: "fiber",
|
|
Reset: false,
|
|
}
|
|
```
|