Add TTLMiddleware for automatic document expiration (#599) #600
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces TTLMiddleware, a new middleware for TinyDB that enables automatic expiration of documents based on TTL (time-to-live) semantics. Documents can specify expiration using either:
_ttl: number of seconds before expiration from insertion time,
_expires_at: explicit Unix timestamp indicating expiration.
Key features include:
Expired documents are automatically excluded from query results, ensuring they appear as if removed.
A purge_expired() method that allows manual cleanup of expired documents from the storage.
Complete test coverage verifying correct filtering, purging, and TTL behavior.
Documentation additions in usage.rst outlining how to use the TTL middleware with code examples and notes on caching.
This feature addresses issue #599 to enable native document TTL support within TinyDB.
All tests pass locally with pytest including coverage measurements.