GH-2914: Add documentation for the Java library #3275
Conversation
|
cc @wgtmac @shangxinli could you please review thanks! |
| private static void writeSalesData(String filename, MessageType schema) throws IOException { | ||
| Path file = new Path(filename); | ||
|
|
||
| try (ParquetWriter<Group> writer = ExampleParquetWriter.builder(file) |
There was a problem hiding this comment.
I am just hesitant to use ExampleParquetWriter as examples which is not for production purpose. Adding an example module also incurs more maintenance burden so I don't think this is a good idea TBH.
There was a problem hiding this comment.
I see, we can remove the sub-module and just produce it as reference only example, it should also be able to resolve the documentation concerns raised in the issue, wdyt?
There was a problem hiding this comment.
removed the dependency from ExampleParquetWriter and removed the pom to eliminate maintenance overhead
|
Gentle reminder cc @wgtmac @ggershinsky thanks! |
|
TBH, I don't think adding some random examples would really help users because they are pretty similar to what's already in the unit test. What in my mind is something like https://arrow.apache.org/cookbook/ which requires a lot of effort to craft examples and maintain them to be in sync. Today LLMs are smart enough to produce code like this (I believe this PR is exactly doing this, right?). |
Thanks cookbook is a great idea, I would like to implement it for Parquet java, let me add support in another change. I came up with the examples in this to allow beginners to understand basic examples, I myself faced issues a while back when onboarding to Parquet. |
|
cc @wgtmac @Fokko @gszadovszky @shangxinli just wanted to get a sense of the community thoughts on a cookbook as a follow up to this PR. I think having better documentation to parquet will help users adopt the project faster and in general would be a good ecosystem addition to the project. If you are open to this I'd like to add support and maintain it in the future. thanks for the suggestion @wgtmac |
|
Have created an issue to track this story thanks! Would be really great if folks can review and add suggestions/feedback thanks! #3284 |
2 participants
examplesfor different usecases in the future.