docs(java): replace the Java API example that no longer compiles - #9635
Open
jackylee-ch wants to merge 1 commit into
Open
docs(java): replace the Java API example that no longer compiles#9635jackylee-ch wants to merge 1 commit into
jackylee-ch wants to merge 1 commit into
Conversation
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>
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
1 participant
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.
The only Java example on the docs site cannot compile:
dev.vortex.api.Fileanddev.vortex.api.Arraywere removed in #7527, and the page has not been touched since. Nothing init points at the API that replaced them.
Replaced with the read path that exists today —
Session→DataSource.open→scan→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 withfive
cannot find symbolerrors forFileandArray, the new one compiles.make -C docs htmlsucceeds under the repo's
--fail-on-warning.AI assistance
Written with agentic AI assistance; I compiled the replacement snippet before publishing it.