From 5a1b2c0c634555ecc8af0c80523d78c8e6460082 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 3 Sep 2026 14:59:59 +0000 Subject: [PATCH] docs(vortex-layout): mark the bloom filter aggregate as unstable 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 Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_019yqkmRmsfqAzRj1KXh8HZU --- .../src/layouts/zoned/aggregates/bloom_filter/mod.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/vortex-layout/src/layouts/zoned/aggregates/bloom_filter/mod.rs b/vortex-layout/src/layouts/zoned/aggregates/bloom_filter/mod.rs index 38c718b2f43..a5abad8007a 100644 --- a/vortex-layout/src/layouts/zoned/aggregates/bloom_filter/mod.rs +++ b/vortex-layout/src/layouts/zoned/aggregates/bloom_filter/mod.rs @@ -258,6 +258,12 @@ impl Display for BloomOptions { /// ### Notice /// /// Only valid (non-null) scalar values are stored in the filter. +/// +/// ### Stability +/// +/// This aggregate is unstable. The hash function, the block layout, and the salt order can still +/// change without a file format version bump. Do not persist `vortex.bloom_filter.sbbf` partials +/// in a Vortex file. #[derive(Clone, Debug)] pub struct BloomFilter;