[Docs] Document the TypedAPI #2230 #2261
Open
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
…ers to work directly with POJOs. It includes examples for writing, reading, and performing lookups, as well as a note on performance considerations.
2 tasks
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.
This commit adds documentation for the new Typed API, which allows users to work directly with POJOs. It includes examples for writing, reading, and performing lookups, as well as a note on performance considerations.
Purpose
Linked issue: close #2230
The purpose of this change is to provide comprehensive documentation for the Typed API introduced in #1992. This API simplifies the developer experience by allowing users to interact with Fluss using POJOs (Plain Old Java Objects) rather than manually handling row and column indices, ensuring better type safety and code readability.
Brief change log
• New Documentation Page: Added website/docs/apis/java-typed-api.md covering the Typed API usage.
• Usage Examples: Included code snippets for:
◦ Defining POJOs with supported data types.
◦ Writing data using TypedAppendWriter and TypedUpsertWriter (including partial updates).
◦ Reading and scanning data using TypedLogScanner.
◦ Performing point lookups via TypedLookuper.
• Performance Notes: Added a section on the overhead of reflection/conversion vs. manual row handling and best practices for high-throughput scenarios.
• Updated Existing Docs: Updated website/docs/apis/java-client.md to link to the new Typed API page.
Tests
Documentation Build: Verified that the documentation renders correctly using the local Docusaurus build process.
Code Snippets: All Java code examples included in the documentation were cross-referenced with existing integration tests in fluss-client to ensure accuracy.
BEFORE
AFTER
NOW
API and Format
This PR is documentation only and does not change the existing API or storage format. It describes the public TypedAppendWriter, TypedUpsertWriter, TypedLogScanner, and TypedLookuper interfaces.
Documentation
Does this change introduce a new feature? No, it documents a feature previously added.
Is the documentation updated? Yes, this PR is specifically for documentation.