Skip to content

Document native Roaring bitmaps - #3715

Draft
aviggiano wants to merge 2 commits into
redis:mainfrom
aviggiano:agent/roaring-bitmap-docs
Draft

Document native Roaring bitmaps#3715
aviggiano wants to merge 2 commits into
redis:mainfrom
aviggiano:agent/roaring-bitmap-docs

Conversation

@aviggiano

@aviggiano aviggiano commented Jul 28, 2026

Copy link
Copy Markdown

Summary

  • document how to enable and use native Roaring-compressed bitmaps
  • explain conversion rules, string-command compatibility, memory tradeoffs, and BITOP behavior
  • document persistence and replication requirements
  • add the native bitmap return value to the TYPE command reference

Why

The native Roaring bitmap feature in redis/redis#15331 adds an opt-in representation with an important compatibility boundary: bitmap commands work transparently, while generic string commands do not operate on native bitmap values. Users need that behavior and the rollout requirements documented before enabling the feature.

User impact

Users can evaluate whether Roaring compression fits their workload, enable it safely, understand when existing strings convert, and upgrade replicas and persistence consumers before rollout.

Validation

  • git diff --check
  • Hugo 0.143.0 rendered both changed pages
  • inspected the rendered example, warning, headings, anchor, and internal links

@CLAassistant

CLAassistant commented Jul 28, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@dwdougherty

dwdougherty commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

Hi @aviggiano. Thank you for this PR. Which Redis Open Source release will contain this new feature? I know it's not in 8.10, because it's just about closed. Is it for 8.12?

Your PR target needs to be a release-specific feature branch, not main. Once you answer the above, I will create the appropriate branch and then you can edit your PR.

Also, this repo does not allow slashes (/) in branch names.

@dwdougherty dwdougherty self-assigned this Jul 28, 2026
@dwdougherty dwdougherty added oss Redis Open Source dev labels Jul 28, 2026
@aviggiano

Copy link
Copy Markdown
Author

Thanks, it's still unclear which release this will be targeted

I'll sync with @sundb and will update the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dev oss Redis Open Source

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants