Skip to content

docs: add FileStorage to adapter guide #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
enginerd-kr merged 1 commit into from
Apr 11, 2026
Merged

docs: add FileStorage to adapter guide #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/ADAPTER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,28 @@ class RedisAdapter(JobStorageAdapter):
return result
```

### File (JSON)

```python
from chronis.contrib.adapters.storage.file import FileStorage

# Default: creates chronis_jobs.json in current directory
storage = FileStorage()

# Custom path
storage = FileStorage(file_path="/var/data/my_jobs.json")

# Disable auto-creation (raises FileNotFoundError if file missing)
storage = FileStorage(file_path="jobs.json", auto_create=False)
```

Features:

- Single JSON file persistence with atomic writes (`os.replace`)
- Thread-safe via `threading.Lock` (single-process only)
- Auto-creates file and parent directories
- Suitable for local development where persistence across restarts is needed

## Lock Adapter Interface

Implement `LockAdapter` with these methods:
Expand Down Expand Up @@ -489,6 +511,7 @@ def test_storage_adapter():
### Storage Adapters

- **In-Memory**: [`chronis/adapters/storage/memory.py`](../chronis/adapters/storage/memory.py)
- **File (JSON)**: [`chronis/contrib/adapters/storage/file.py`](../chronis/contrib/adapters/storage/file.py)
- **PostgreSQL**: [`chronis/contrib/adapters/storage/postgres/adapter.py`](../chronis/contrib/adapters/storage/postgres/adapter.py)
- **Redis**: [`chronis/contrib/adapters/storage/redis.py`](../chronis/contrib/adapters/storage/redis.py)

Expand Down
Loading