Skip to content

DOC-6767 added Go scan/buffer API page#3534

Merged
andy-stark-redis merged 1 commit into
mainfrom
DOC-6767-go-redis-page-for-zero-copy-buffer-hash-and-list-returns
Jun 22, 2026
Merged

DOC-6767 added Go scan/buffer API page#3534
andy-stark-redis merged 1 commit into
mainfrom
DOC-6767-go-redis-page-for-zero-copy-buffer-hash-and-list-returns

Conversation

@andy-stark-redis

@andy-stark-redis andy-stark-redis commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

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() with redis struct tags on HGETALL / HMGET, ScanSlice() on list commands like LRANGE, and SetFromBuffer() / GetToBuffer() (v9.21.0+), including notes on ZeroCopyStringCmd, no automatic retries on buffer reads, TTL behavior for SetFromBuffer(), and handling buffer too small errors.

A runnable go_scan_buffer example test (scan_buffer_examples_test.go) backs the embedded clients-example steps used throughout the page.

Reviewed by Cursor Bugbot for commit ef2512c. Bugbot is set up for automated code reviews on this repo. Configure here.

@andy-stark-redis andy-stark-redis requested a review from a team June 22, 2026 12:45
@andy-stark-redis andy-stark-redis self-assigned this Jun 22, 2026
@andy-stark-redis andy-stark-redis added the clients Client library docs label Jun 22, 2026
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

DOC-6767

@jit-ci

jit-ci Bot commented Jun 22, 2026

Copy link
Copy Markdown

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

@dwdougherty dwdougherty left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@andy-stark-redis

Copy link
Copy Markdown
Contributor Author

Thanks again @dwdougherty - should be the last one for today :-)

@andy-stark-redis andy-stark-redis merged commit 62ec138 into main Jun 22, 2026
75 of 76 checks passed
@andy-stark-redis andy-stark-redis deleted the DOC-6767-go-redis-page-for-zero-copy-buffer-hash-and-list-returns branch June 22, 2026 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clients Client library docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants