Skip to content

docs(vortex-layout): mark the bloom filter aggregate as unstable - #9753

Open
connortsui20 wants to merge 1 commit into
developfrom
claude/aggregate-fn-unstable-comment-j95028
Open

docs(vortex-layout): mark the bloom filter aggregate as unstable#9753
connortsui20 wants to merge 1 commit into
developfrom
claude/aggregate-fn-unstable-comment-j95028

Conversation

@connortsui20

@connortsui20 connortsui20 commented Sep 3, 2026

Copy link
Copy Markdown
Member

Summary

The bloom filter aggregate from #9398 does not have a settled wire format. The hash function, the block layout, and the salt order can all still change, and no edition declares vortex.bloom_filter.sbbf, so nothing must write bloom partials into a file yet.

Changes

Adds a Stability section to the BloomFilter doc comment saying that the aggregate is unstable and that vortex.bloom_filter.sbbf partials must not be persisted. Comment only, no behavior change.

The SBBF hash function, block layout, and salt order can still change,
and no edition declares `vortex.bloom_filter.sbbf`. Say so on the type so
nobody persists bloom partials into a file.

Signed-off-by: Connor Tsui <connor.tsui20@gmail.com>

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019yqkmRmsfqAzRj1KXh8HZU
@connortsui20 connortsui20 added the changelog/docs A docs change label Sep 3, 2026
@connortsui20
connortsui20 enabled auto-merge (squash) September 3, 2026 15:27
@codspeed-hq

codspeed-hq Bot commented Sep 3, 2026

Copy link
Copy Markdown

Merging this PR will degrade performance by 4.01%

⚠️ Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

⚠️ Different runtime environments detected

Some benchmarks with significant performance changes were compared across different runtime environments,
which may affect the accuracy of the results.

Open the report in CodSpeed to investigate

⚡ 1 improved benchmark
❌ 1 regressed benchmark
✅ 2179 untouched benchmarks
⏩ 206 skipped benchmarks1

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Mode Benchmark BASE HEAD Efficiency
Simulation random_i8[0.5] 67.2 µs 90.7 µs -25.91%
Simulation random_i16[0.8] 92.1 µs 74.1 µs +24.36%

Tip

Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.


Comparing claude/aggregate-fn-unstable-comment-j95028 (5a1b2c0) with develop (dab1684)

Open in CodSpeed

Footnotes

  1. 206 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@robert3005

Copy link
Copy Markdown
Contributor

Things not in editions cannot be persisted anyway. The editions are the reference of what’s persistable. Happy with the docs fwiw just letting you know there’s layers to safety now

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

Labels

changelog/docs A docs change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants