DOC-6843 Add redis-rb (Ruby) Query Engine docs: queryjson by andy-stark-redis · Pull Request #3641 · redis/docs

andy-stark-redis · 2026-07-15T09:03:46Z

Adds Ruby (redis-rb) coverage for the Query Engine (RediSearch / FT.*).

What's here

Page: content/develop/clients/ruby/queryjson.md — a new "Index and query documents" page for Ruby, covering index creation, search, field projection, and aggregation over both JSON and hash documents.
Example: local_examples/client-specific/ruby/home_json.rb — the ruby_home_json example set backing the page.
Command mappings: redis_rb signatures across the FT.* command-api-mapping files (data/command-api-mapping.json regenerated via build/merge-command-api-mapping.sh).

Notes for reviewers

Requires redis-rb v6.0.0 or later (noted on the page).
redis-rb's Search::Index strips the index key prefix from returned document IDs — doc.id is the logical id (3), not the full key (user:3) as redis-py returns. The page and example call this out so the output comments don't look like errors.
FT.CREATE/SEARCH/AGGREGATE/DROPINDEX carry both the high-level (create_index/search/aggregate/drop) and low-level (ft_*) signatures; the rest carry ft_* only. FT.EXPLAINCLI and FT._LIST are omitted (redis-rb has no method for them).
The page embeds the ruby_home_json set; data/examples.json is git-ignored/generated, so the Ruby tab appears when CI regenerates it (not in this diff).
Builds on the JSON docs (DOC-6842 Add redis-rb (Ruby) JSON docs #3629), since the page indexes JSON documents.

Verification

home_json.rb runs green against the released redis-rb 6.0.0 gem (published 2026-07-31) on Redis 8.8 with the search module — exit 0, all asserts pass. RESP3-as-default changed no return shapes.

… command mappings Preemptive, parked docs for redis-rb's Query Engine (RediSearch), which merged upstream in redis-rb #1356 but is not yet in a released gem — the latest is v5.4.1 from July 2025, which predates it. Adds the "Index and query documents" page for Ruby, a run-verified example set, and redis_rb signatures across the FT.* command-api-mapping files. Builds on the parked JSON docs (DOC-6842), since the index-documents page indexes JSON documents. Three non-obvious things for whoever edits these next. First, the page embeds the ruby_home_json set, not the query_ft/query_em/etc sets — those back the search-and-query tutorial pages, a different area, so adding Ruby there is a separate job. Second, redis-rb's Search::Index strips the index key prefix from returned document ids, so the client reports the logical id ("3") rather than the full key ("user:3") as redis-py does; the page and example call this out so the output comments aren't mistaken for errors. Third, the example's outputs and REMOVE-block asserts are not guesses — the file was run against the local redis-rb fork (master, PR #1356) on Redis 8.8 and passed all steps, so the only real risk is the upstream API changing before the gem ships. For the mappings, FT.CREATE/SEARCH/AGGREGATE/DROPINDEX carry both the high-level (create_index/search/aggregate/drop) and the low-level ft_* signature, because the fork ships that two-layer API deliberately; the rest carry just the ft_* method. FT.EXPLAINCLI and FT._LIST are omitted — redis-rb has no method for them. Learned: redis-rb Index strips the key prefix from doc ids; queryjson embeds the *_home_json set not the query_* tutorial sets; outputs run-verified against the fork, not guessed Constraint: regenerate data/command-api-mapping.json with build/merge-command-api-mapping.sh after editing per-command files — never hand-edit the merged file, and run the script with the sandbox off (its mktemp hits the blocked system temp dir) Directive: parked — do not merge until redis-rb ships the Query Engine in a released gem; vecsearch.md and Ruby snippets in the search-and-query tutorial pages are deferred follow-ups Recheck: next redis-rb gem release (Query Engine is master-only via PR #1356) Gaps: verified against fork master on Redis 8.8, not a released gem — re-run the example and add a "requires redis-rb vX.Y+" note at pickup Ticket: DOC-6843 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

The Query Engine support this page documents isn't in a released gem yet, so warn readers the API is subject to change until pickup. Ticket: DOC-6843 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

github-actions · 2026-07-15T09:04:01Z

DOC-6843

github-actions · 2026-07-15T09:04:03Z

Staging links:
https://redis.io/docs/staging/DOC-6843-redis-rb-query-engine-docs/develop/clients/ruby/queryjson/

Renamed the parked-PR thaw skill from `/pickup` to `/unpark` — directory, frontmatter, title, and prose — to free the `/pickup` name for another skill where it fits better; `park`/`unpark` also reads as a cleaner verb pair. Updated the two files that reference it, `/park` and the shared `_shared/park-manifest.md` contract, so the pairing stays consistent. The three parked PRs that instructed `/pickup <n>` (#3611, #3641, #3652) were updated out-of-band so no stale invocation survives. Approved by dwdougherty; Cursor Bugbot clean. Directive: Two "pickup" strings are left un-renamed on purpose — the historical .claude/state/assess-comments.coverage.md audit log (it records the skill's old name as it was at the time; renaming falsifies history) and the "Trigger to pick up:" manifest field name in park-manifest.md (a header field, not the skill name). Don't "fix" them in a follow-up grep-and-replace. Ticket: DOC-6876 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

…eleased) redis-rb 6.0.0 shipped the Query Engine (search module) to rubygems.org on 2026-07-31; home_json.rb re-verified green against the released gem on Redis 8.8. Remove the 'not yet in a released gem' banner and add a v6.0.0+ note. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

github-actions · 2026-07-31T09:16:11Z

🧠 Redis Memory

Found 5 related items from repository history:

Memory updated at 0f169cd

…ry-engine-docs

andy-stark-redis · 2026-07-31T09:55:53Z

Unpark reflection (predicted vs actual) — 2026-07-31

redis-rb 6.0.0 shipped the Query Engine (search/ module) to rubygems.org on 2026-07-31, later than v5.4.1. Trigger fired.

Predicted at park (MEDIUM confidence): possible FT.* signature / return-shape drift between fork master (71706ec) and release.
Actual: drift was additive and non-breaking — 71706ec...v6.0.0 touches only two module files: SearchResult gained an optional RESP3-only warnings attr (warnings: [] default), and a new ft_aliaslist method (FT.ALIASLIST, Redis 8.10+). Neither affects total / documents / Document#[] / doc.id / prefix-stripping — the surface this page and its FT.* mappings document is unchanged.
Runtime re-verify: home_json.rb ran green against the released 6.0.0 gem on Redis 8.8 (search) — exit 0, all REMOVE-block asserts. RESP3-as-default changed nothing.
Reconciliation: removed the preview banner; added a "requires redis-rb v6.0.0 or later" note.

Not done (deliberately): a redis_rb mapping for the new FT.ALIASLIST — new-server-command mappings are another writer's remit. Branch merged up to date with main (110 commits, no conflicts, command-api-mapping.json still valid JSON). hugo --gc exits 0; the only queryjson-related warning is the expected local Example not found "ruby_home_json" (examples.json is git-ignored, regenerated by build/local_examples.py in CI). Ready for /finalize.

github-actions · 2026-07-31T09:56:20Z

🧠 Redis Memory

Found 5 related items from repository history:

PR — DOC-6842 Add redis-rb (Ruby) JSON docs [PARKED]

DOC-6842 — redis-rb (Ruby) JSON docs
PR — DOC-6854 Add redis-rb (Ruby) vector search docs: vecsearch page + ruby_home_query_vec [PARKED]

Preemptive docs for redis-rb's Query Engine vector search: a new "Index and query vectors" page for Ruby (`content/develop/clients/ruby/
PR — DOC-6829 Add preemptive Spring Data Redis JSON docs [PARKED]

Summary
PR — DEV/OP: docs for Redis 8.10

This is the final PR for Redis Open Source 8.10. Each individual commit has been reviewed by PM and peers; it just needs a rubber stamp so I
Commit — DOC-6909 Fix the remaining pre-existing broken links surfaced by the hook

DOC-6909 Fix the remaining pre-existing broken links surfaced by the hook

Memory updated at e874faf

dwdougherty

LGTM.

andy-stark-redis and others added 2 commits July 14, 2026 15:39

andy-stark-redis added do not merge yet parked PR speculatively added based on pre-release info. Check validity when release goes ahead. labels Jul 15, 2026

andy-stark-redis self-assigned this Jul 15, 2026

This was referenced Jul 17, 2026

DOC-6854 Add redis-rb (Ruby) vector search docs: vecsearch page + ruby_home_query_vec #3652

Merged

DOC-6876 Rename /pickup skill to /unpark #3693

Merged

andy-stark-redis requested a review from a team July 31, 2026 09:22

andy-stark-redis added clients Client library docs and removed do not merge yet parked PR speculatively added based on pre-release info. Check validity when release goes ahead. labels Jul 31, 2026

github-actions Bot mentioned this pull request Jul 31, 2026

DOC-6842 Add redis-rb (Ruby) JSON docs #3629

Merged

Merge remote-tracking branch 'origin/main' into DOC-6843-redis-rb-que…

e874faf

…ry-engine-docs

andy-stark-redis changed the title ~~DOC-6843 Add redis-rb (Ruby) Query Engine docs: queryjson [PARKED]~~ DOC-6843 Add redis-rb (Ruby) Query Engine docs: queryjson Jul 31, 2026

dwdougherty approved these changes Jul 31, 2026

View reviewed changes

andy-stark-redis merged commit 8ab2e40 into main Jul 31, 2026
85 of 86 checks passed

andy-stark-redis deleted the DOC-6843-redis-rb-query-engine-docs branch July 31, 2026 15:56

This was referenced Aug 3, 2026

DOC-6924 Remove AI-docs differentiator claim from Redis vs MongoDB #3743

Open

DOC-6832 Add go-redis automatic pipelining page #3621

Open

DOC-6831 Document go-redis client-side caching #3613

Open

Navigation Menu

Uh oh!

DOC-6843 Add redis-rb (Ruby) Query Engine docs: queryjson - #3641

DOC-6843 Add redis-rb (Ruby) Query Engine docs: queryjson#3641
andy-stark-redis merged 4 commits into
mainfrom
DOC-6843-redis-rb-query-engine-docs

andy-stark-redis commented Jul 15, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jul 15, 2026 •

edited by atlassian Bot

Loading

Uh oh!

github-actions Bot commented Jul 15, 2026

Uh oh!

github-actions Bot commented Jul 31, 2026

Uh oh!

andy-stark-redis commented Jul 31, 2026

Uh oh!

github-actions Bot commented Jul 31, 2026

DOC-6842 — redis-rb (Ruby) JSON docs

Summary

Uh oh!

dwdougherty left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

andy-stark-redis commented Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What's here

Notes for reviewers

Verification

Uh oh!

github-actions Bot commented Jul 15, 2026 • edited by atlassian Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 15, 2026

Uh oh!

github-actions Bot commented Jul 31, 2026

🧠 Redis Memory

Uh oh!

andy-stark-redis commented Jul 31, 2026

Uh oh!

github-actions Bot commented Jul 31, 2026

🧠 Redis Memory

DOC-6842 — redis-rb (Ruby) JSON docs

Summary

Uh oh!

dwdougherty left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

andy-stark-redis commented Jul 15, 2026 •

edited

Loading

github-actions Bot commented Jul 15, 2026 •

edited by atlassian Bot

Loading