[docs] Add RoaringBitmap SQL functions to aggregation documentation - #3823
Open
pbanakar wants to merge 1 commit into
Open
[docs] Add RoaringBitmap SQL functions to aggregation documentation#3823pbanakar wants to merge 1 commit into
pbanakar wants to merge 1 commit into
Conversation
Contributor
Author
|
@polyzos @platinumhamburg Could you please take a look at this PR? |
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.
Purpose
Linked issue: Part of #3289
Adds user-facing documentation for the 12 RoaringBitmap SQL functions introduced by FIP-37 (PRs #3319, #3398, #3492, #3777). The functions are now registered natively in FlussCatalog and available after
USE CATALOG fluss_catalogwithout anyCREATE TEMPORARY FUNCTIONstatement.Brief change log
Modified
website/docs/table-design/merge-engines/aggregation.md:Added a new
## RoaringBitmap SQL Functionssection afterrbm64, covering all 12 functions across two subsections:Aggregate functions:
rb_build_agg,rb_or_agg,rb_and_agg,rb_xor_aggScalar functions:
rb_cardinality,rb_build,rb_contains,rb_to_array,rb_or,rb_and,rb_xor,rb_andnotEach function entry includes signature, behavior, null semantics, and a Flink SQL example. Functions without a server-side counterpart (
rb_and_agg,rb_xor_agg) include a note about compaction behavior. A note distinguishes these Flink-side SQL functions from the storage-levelrbm32/rbm64aggregators already documented in the file.Closes with an end-to-end example covering table creation, ingestion with
rb_build_agg, point query withrb_cardinality, and roll-up query withrb_or_agg, with a reference to the Real-Time UV Deduplication blog post for a full Docker-based tutorial.Tests
Manually verified by starting the website locally , The SQL examples have been verified against the implemented functions in PRs #3319, #3398, #3492, and #3777.
API and Format
This change does not affect any API or storage format. Documentation only.
Documentation
Yes, this PR adds the user-facing reference documentation for FIP-37 bitmap SQL functions, completing the documentation commitment made in PRs #3319, #3398, #3492, and #3777.