Consolidate ClickBench setup documentation for DataFusion#20016
Open
kosiew wants to merge 1 commit intoapache:mainfrom
Open
Consolidate ClickBench setup documentation for DataFusion#20016kosiew wants to merge 1 commit intoapache:mainfrom
kosiew wants to merge 1 commit intoapache:mainfrom
Conversation
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.
Which issue does this PR close?
Rationale for this change
ClickBench setup requirements for DataFusion were scattered across multiple places (benchmark code constants, sqllogictest files, and brief README notes). This made it easy for users to miss critical configuration steps—especially
binary_as_stringfor binary columns and theEventDateUInt16 → DATE transformation—leading to confusing failures or incorrect results.This PR, a follow up PR for #19881 , consolidates the setup knowledge into a single, copy‑pasteable section in
benchmarks/README.md, and adds cross-references from the code/test locations back to that canonical documentation.What changes are included in this PR?
Added a new “Running ClickBench on DataFusion” section to
benchmarks/README.mdthat documents:binary_as_stringwhen registering the ClickBench Parquet file.EventDatemust be transformed from UInt16 (days since epoch) to a SQLDATE, including a clear explanation of the failure mode when not transformed../bench.sh.Added a pointer comment in
benchmarks/src/clickbench.rs(near theHITS_VIEW_DDL/ view DDL) directing readers to the README section as the source of truth.Added a pointer comment in
datafusion/sqllogictest/test_files/clickbench.sltdirecting readers to the README section for full setup details.Are these changes tested?
Yes (documentation-aligned coverage):
The
clickbench.sltfile continues to create thehitsview using the documentedEventDatecasting pattern.The ClickBench benchmark runner in
benchmarks/src/clickbench.rscontinues to apply the same view DDL and can be exercised via:./bench.sh data clickbench./bench.sh run clickbenchNo new automated tests were added because the change is primarily documentation plus comments, and behavior is already validated through existing benchmark and sqllogictest workflows.
Are there any user-facing changes?
Yes: improved user-facing documentation.
benchmarks/README.mdnow includes a consolidated, canonical ClickBench-on-DataFusion setup guide with rationale and a complete example.LLM-generated code disclosure
This PR includes LLM-generated code and comments. All LLM-generated content has been manually reviewed and tested.