Repository¶
Dataclass entity storage with versioning, soft delete, audit, and history.
Define an Entity¶
from dataclasses import dataclass
from redis_kit import BaseModel
@dataclass
class AppConfig(BaseModel):
name: str = ""
value: str = ""
env: str = "production"
BaseModel provides the following fields: id, version, created_at, updated_at, deleted, deleted_at.
CRUD Operations¶
from redis_kit import Repository
repo = Repository(conn.sync_client, AppConfig, prefix="config")
# Create — auto ID, version=1, created_at
config = repo.save(AppConfig(name="max_retries", value="3"))
# Read
found = repo.find(config.id)
# Update — auto version increment, updated_at
found.value = "5"
updated = repo.save(found) # version 1 → 2
# List all
all_configs = repo.find_all()
Optimistic Locking¶
stale = repo.find(config.id) # version=2
updated.value = "10"
repo.save(updated) # version 2 → 3
stale.value = "20"
repo.save(stale) # OptimisticLockError! (expected 2, actual 3)
Soft Delete¶
repo.delete(config.id) # deleted=True, version+1
repo.find(config.id) # None
repo.find_including_deleted(config.id) # Still accessible
restored = repo.restore(config.id) # Recovered, version+1
repo.hard_delete(config.id) # Permanently removed
Both delete() and restore() use optimistic locking for atomicity, automatically incrementing version and updating updated_at.
Version History¶
history = repo.get_history(config.id) # previous states from save(), delete(), and restore()
for version in history:
print(f"v{version.version}: {version.value}")