types

package

v1.1.3 Latest Latest Go to latest Published: Sep 22, 2025 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/anasamu/go-micro-libs

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type BatchOperation
type BatchOperationType
type CacheConfig
type CacheError
- func (e *CacheError) Error() string
type CacheEvent
type CacheEventType
type CacheFeature
type CacheItem
type CacheStats
type ConnectionInfo
type ConnectionStatus
type ProviderInfo

Constants ¶

View Source

const (
	ErrCodeNotFound        = "NOT_FOUND"
	ErrCodeInvalidKey      = "INVALID_KEY"
	ErrCodeInvalidValue    = "INVALID_VALUE"
	ErrCodeExpired         = "EXPIRED"
	ErrCodeConnection      = "CONNECTION_ERROR"
	ErrCodeTimeout         = "TIMEOUT"
	ErrCodeQuota           = "QUOTA_EXCEEDED"
	ErrCodeSerialization   = "SERIALIZATION_ERROR"
	ErrCodeDeserialization = "DESERIALIZATION_ERROR"
)

Common cache error codes

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BatchOperation ¶

type BatchOperation struct {
	Type  BatchOperationType `json:"type"`
	Key   string             `json:"key"`
	Value interface{}        `json:"value,omitempty"`
	TTL   time.Duration      `json:"ttl,omitempty"`
	Tags  []string           `json:"tags,omitempty"`
}

BatchOperation represents a batch cache operation

type BatchOperationType ¶

type BatchOperationType string

BatchOperationType represents the type of batch operation

const (
	BatchSet    BatchOperationType = "set"
	BatchGet    BatchOperationType = "get"
	BatchDelete BatchOperationType = "delete"
)

type CacheConfig ¶

type CacheConfig struct {
	DefaultTTL    time.Duration `json:"default_ttl"`
	MaxKeyLength  int           `json:"max_key_length"`
	MaxValueSize  int64         `json:"max_value_size"`
	Compression   bool          `json:"compression"`
	Serialization string        `json:"serialization"` // json, msgpack, protobuf
	KeyPrefix     string        `json:"key_prefix"`
	Namespace     string        `json:"namespace"`
}

CacheConfig holds general cache configuration

type CacheError ¶

type CacheError struct {
	Code    string `json:"code"`
	Message string `json:"message"`
	Key     string `json:"key,omitempty"`
}

CacheError represents a cache-specific error

func (*CacheError) Error ¶

func (e *CacheError) Error() string

type CacheEvent ¶

type CacheEvent struct {
	Type      CacheEventType `json:"type"`
	Key       string         `json:"key"`
	Value     interface{}    `json:"value,omitempty"`
	Timestamp time.Time      `json:"timestamp"`
	Provider  string         `json:"provider"`
}

CacheEvent represents a cache event

type CacheEventType ¶

type CacheEventType string

CacheEventType represents the type of cache event

const (
	EventSet    CacheEventType = "set"
	EventGet    CacheEventType = "get"
	EventDelete CacheEventType = "delete"
	EventExpire CacheEventType = "expire"
	EventFlush  CacheEventType = "flush"
)

type CacheFeature ¶

type CacheFeature string

CacheFeature represents a cache feature

const (
	// Basic features
	FeatureSet    CacheFeature = "set"
	FeatureGet    CacheFeature = "get"
	FeatureDelete CacheFeature = "delete"
	FeatureExists CacheFeature = "exists"
	FeatureFlush  CacheFeature = "flush"
	FeatureStats  CacheFeature = "stats"

	// Advanced features
	FeatureTags        CacheFeature = "tags"
	FeatureTTL         CacheFeature = "ttl"
	FeatureBatch       CacheFeature = "batch"
	FeaturePattern     CacheFeature = "pattern"
	FeaturePersistence CacheFeature = "persistence"
	FeatureClustering  CacheFeature = "clustering"
	FeaturePubSub      CacheFeature = "pubsub"
	FeatureLuaScripts  CacheFeature = "lua_scripts"
)

type CacheItem ¶

type CacheItem struct {
	Key        string                 `json:"key"`
	Value      interface{}            `json:"value"`
	Expiration time.Time              `json:"expiration"`
	CreatedAt  time.Time              `json:"created_at"`
	UpdatedAt  time.Time              `json:"updated_at"`
	Tags       []string               `json:"tags"`
	Metadata   map[string]interface{} `json:"metadata"`
}

CacheItem represents a cached item with metadata

type CacheStats ¶

type CacheStats struct {
	Hits       int64         `json:"hits"`
	Misses     int64         `json:"misses"`
	Keys       int64         `json:"keys"`
	Memory     int64         `json:"memory"`
	Uptime     time.Duration `json:"uptime"`
	LastUpdate time.Time     `json:"last_update"`
	Provider   string        `json:"provider"`
}

CacheStats represents cache statistics

type ConnectionInfo ¶

type ConnectionInfo struct {
	Host     string            `json:"host"`
	Port     int               `json:"port"`
	Database string            `json:"database"`
	Username string            `json:"username"`
	Status   ConnectionStatus  `json:"status"`
	Metadata map[string]string `json:"metadata"`
}

ConnectionInfo holds connection information for a cache provider

type ConnectionStatus ¶

type ConnectionStatus string

ConnectionStatus represents the connection status

const (
	StatusConnected    ConnectionStatus = "connected"
	StatusDisconnected ConnectionStatus = "disconnected"
	StatusConnecting   ConnectionStatus = "connecting"
	StatusError        ConnectionStatus = "error"
)

type ProviderInfo ¶

type ProviderInfo struct {
	Name              string          `json:"name"`
	SupportedFeatures []CacheFeature  `json:"supported_features"`
	ConnectionInfo    *ConnectionInfo `json:"connection_info"`
	IsConnected       bool            `json:"is_connected"`
}

ProviderInfo holds information about a cache provider

Source Files ¶

View all Source files

types.go

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