docs: explain Redis 8 concurrent search visibility - #706
Closed
mikemikimike wants to merge 1 commit into
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Document the temporary search visibility window that Redis 8.8+ can introduce under concurrent write and query load.
Changes
load()followed byquery()example and clarified that this is indexing latency, not data loss.--search-workers 0option for workloads that require foreground indexing, including its performance trade-off.Validation
uv run sphinx-build -b html docs docs/_build/html --keep-going— passed.uv run black --check redisvl tests— passed (249 files unchanged).uv run isort --check-only redisvl tests --profile black— passed.uv run mypy redisvl— passed.git diff --check— passed.The strict documentation build with
-Wstill reports two pre-existing cross-reference warnings indocs/user_guide/how_to_guides/mcp.mdandmcp_authentication.md; the normal build completes successfully.Compatibility
Documentation-only change. No RedisVL runtime behavior is modified.
Fixes #662.
Note
Low Risk
Documentation-only change; no runtime or API behavior is modified.
Overview
Adds a Search Visibility Under Concurrent Writes section to the Search & Indexing concepts doc, complementing existing Redis 8.8+ notes in
queries.mdabout background workers.The new text explains that on Redis 8.8+, RediSearch’s default multithreaded worker pool can leave freshly written documents temporarily invisible to an immediate
query()afterload()—indexing latency, not data loss. It warns ingestion pipelines and read-after-write checks that query the index right after writes, and points operators to the Redis server flag--search-workers 0when foreground indexing is required, with the performance trade-off noted.Reviewed by Cursor Bugbot for commit 3a5e070. Bugbot is set up for automated code reviews on this repo. Configure here.