DOC-6767 added Go scan/buffer API page#3534
Merged
andy-stark-redis merged 1 commit intoJun 22, 2026
Merged
Conversation
|
|
Contributor
Contributor
🛡️ Jit Security Scan Results✅ No security findings were detected in this PR
Security scan by Jit
|
Contributor
Author
|
Thanks again @dwdougherty - should be the last one for today :-) |
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.
Note
Low Risk
Documentation and example tests only; no production code or runtime behavior changes.
Overview
Adds a new Go client doc page Handle command results efficiently (
scan-buffer.md) that explains mapping Redis results into Go types and using caller-owned buffers for large strings.The page covers
Scan()withredisstruct tags onHGETALL/HMGET,ScanSlice()on list commands likeLRANGE, andSetFromBuffer()/GetToBuffer()(v9.21.0+), including notes onZeroCopyStringCmd, no automatic retries on buffer reads, TTL behavior forSetFromBuffer(), and handlingbuffer too smallerrors.A runnable
go_scan_bufferexample test (scan_buffer_examples_test.go) backs the embeddedclients-examplesteps used throughout the page.Reviewed by Cursor Bugbot for commit ef2512c. Bugbot is set up for automated code reviews on this repo. Configure here.