docs: expand README limitations and fix stale docs#287
Merged
Conversation
Add missing limitation sections to README: no phrase queries (with subquery workaround), no expression indexing (generated column workaround), no built-in faceted search (WHERE/GROUP BY examples), insert/update performance status, and no background compaction. Also fixes: - CHANGELOG: incorrect "LZ4 compression" → delta encoding + bitpacking - CLAUDE.md: stale parallel build description (old page pool → BufFile architecture) and remove obsolete pool-exhaustion limitation
CREATE INDEX always produces a single segment, so bm25_force_merge() is not needed after index builds. It is useful after sustained incremental inserts where repeated memtable spills create multiple segments.
- Fix incorrect "CREATE INDEX always produces a single segment" claim (serial builds can produce multiple segments) - Add COALESCE to generated column example to handle NULLs - Add ORDER BY + score alias to phrase query outer query - Fix faceted search comment to note B-tree index is assumed - Update stale source comments: remove page pool reference in segment.c, fix force_merge docstrings in build.c and merge.h - Simplify CLAUDE.md parallel build step 5
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
1 participant
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
Testing
Documentation-only changes. Verified SQL examples match existing patterns in the README.