storex

package
v0.2.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 25, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package storex provides a storage interface for communicating with different database/key-value

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type StorageWithConn

type StorageWithConn[T any] interface {
	// Conn returns a connection to the storage.
	Conn() T
}

StorageWithConn interface for communicating with different database/key-value providers that require a connection.

type Store

type Store 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
}

Store interface for communicating with different database/key-value providers.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL