Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

kv

package module

Go to main page

Versions in this module

v0

v0.5.0

Aug 19, 2026

Changes in this version

type Client

+ func (c *Client) AcquireLock(ctx context.Context, key, token string, ttl time.Duration) (bool, error)

+ func (c *Client) ReleaseLock(ctx context.Context, key, token string) error

type Options

+ TLS *tls.Config

v0.4.0

Aug 14, 2026

Changes in this version

type SessionBackend

+ func (b *SessionBackend) DeleteSubject(ctx context.Context, tenant, subjectID, keepID string) error

v0.3.0

Aug 6, 2026

v0.2.1

Aug 4, 2026

v0.2.0

Aug 2, 2026

v0.1.0

Jul 31, 2026

Changes in this version

+ var ErrLocked = errors.New("kv: the lock is held")

+ var ErrNoTTL = errTTL

+ var ErrNoTenant = errors.New("kv: the operation needs a tenant, and the Grant carries none")

+ var ErrNotFound = errors.New("kv: not found")

+ type Cache struct

+ func NewCache(c *Client, namespace string) *Cache

+ func (c *Cache) Forget(ctx context.Context, g security.Grant, id string) error

+ func (c *Cache) Get(ctx context.Context, g security.Grant, id string, v any) error

+ func (c *Cache) Put(ctx context.Context, g security.Grant, id string, v any, ttl time.Duration) error

+ func (c *Cache) Remember(ctx context.Context, g security.Grant, id string, ttl time.Duration, v any, ...) error

+ type Client struct

+ func Connect(opts Options) *Client

+ func (c *Client) Close() error

+ func (c *Client) Ping(ctx context.Context) error

+ type Limiter struct

+ func NewLimiter(c *Client) *Limiter

+ func (l *Limiter) Allow(key string, limit int, window time.Duration) (remaining int, retryAfter time.Duration, ok bool)

+ type Lock struct

+ func (l *Lock) Unlock(ctx context.Context) error

+ type Locker struct

+ func NewLocker(c *Client) *Locker

+ func (l *Locker) Acquire(ctx context.Context, name string, ttl time.Duration) (*Lock, error)

+ func (l *Locker) Run(ctx context.Context, name string, ttl time.Duration, ...) error

+ type Module struct

+ func NewModule(c *Client) *Module

+ func (*Module) Name() string

+ func (*Module) Routes(*httpx.Router)

+ func (m *Module) Close(context.Context) error

+ func (m *Module) Health(ctx context.Context) error

+ type Options struct

+ Address string

+ Database int

+ DialTimeout time.Duration

+ Password string

+ Prefix string

+ ReadTimeout time.Duration

+ type SessionBackend struct

+ func NewSessionBackend(c *Client) *SessionBackend

+ func (b *SessionBackend) Delete(ctx context.Context, id string) error

+ func (b *SessionBackend) Get(ctx context.Context, id string) (security.Subject, error)

+ func (b *SessionBackend) Put(ctx context.Context, id string, s security.Subject, ttl time.Duration) error