Skip to content

docs(java): replace the Java API example that no longer compiles - #9635

Merged
myrrc merged 1 commit into
vortex-data:developfrom
jackylee-ch:java-api-docs-example
Aug 26, 2026
Merged

docs(java): replace the Java API example that no longer compiles#9635
myrrc merged 1 commit into
vortex-data:developfrom
jackylee-ch:java-api-docs-example

Conversation

@jackylee-ch

Copy link
Copy Markdown
Contributor

The only Java example on the docs site cannot compile: dev.vortex.api.File and
dev.vortex.api.Array were removed in #7527, and the page has not been touched since. Nothing in
it points at the API that replaced them.

Replaced with the read path that exists today — SessionDataSource.openscan
Partition.scanArrow — following the same loop the JNI tests use.

Tests

Compiled both snippets as a scratch class under vortex-jni/src/test: the published one fails with
five cannot find symbol errors for File and Array, the new one compiles. make -C docs html
succeeds under the repo's --fail-on-warning.

AI assistance

Written with agentic AI assistance; I compiled the replacement snippet before publishing it.

The example imported dev.vortex.api.File and dev.vortex.api.Array, both
removed in vortex-data#7527. The page predates that removal and offers no pointer to
the API that replaced them, so the first thing a JNI user copies fails to
compile.

Rewritten around the read path that exists today: Session, DataSource.open,
scan, and Partition.scanArrow, following the loop the vortex-jni tests use.

Signed-off-by: jackylee <qcsd2011@gmail.com>
@myrrc
myrrc enabled auto-merge (squash) August 26, 2026 11:44
@codspeed-hq

codspeed-hq Bot commented Aug 26, 2026

Copy link
Copy Markdown

Merging this PR will improve performance by 33.22%

⚠️ 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.

⚡ 3 improved benchmarks
✅ 2109 untouched benchmarks
⏩ 106 skipped benchmarks1
🗄️ 4 archived benchmarks run2

Performance Changes

Mode Benchmark BASE HEAD Efficiency
WallTime arrow_checked_add_u32_neon[16384] 20.4 µs 12.3 µs +65.35%
WallTime arrow_checked_add_u32_avx512[16384] 21.3 µs 17.6 µs +20.78%
Simulation take[duplicates/repeated/primitive/nonnull/chunks=16/indices=1000] 245 µs 207 µs +18.39%

Tip

Curious why performance improved? Comment @codspeedbot explain why performance improved on this PR, or directly use the CodSpeed MCP with your agent.


Comparing jackylee-ch:java-api-docs-example (961d17f) with develop (ee1ac25)

Open in CodSpeed

Footnotes

  1. 106 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.

  2. 4 benchmarks were run, but are now archived. If they were deleted in another branch, consider rebasing to remove them from the report. Instead if they were added back, click here to restore them.

@robert3005 robert3005 added the changelog/docs A docs change label Aug 26, 2026
@myrrc
myrrc merged commit b240a50 into vortex-data:develop Aug 26, 2026
99 of 100 checks passed
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