TripleCamera opened a new issue, #795: URL: https://github.com/apache/tsfile/issues/795
The Java examples are poorly documented. The only page mentioning the examples is the [QuickStart](https://tsfile.apache.org/zh/UserGuide/latest/QuickStart/QuickStart.html) tutorial. I encountered a few questions while studying the examples: First, how to run the examples? I cloned the repository and built the Java packages, but can't figure out how to run the examples. Copilot gave me the following command: ``` $ ./mvnw -f java/examples/pom.xml -DskipTests exec:java -Dexec.mainClass=org.apache.tsfile.XXX ``` Is this correct? Second, what are the functions of each example? The only two examples mentioned by QuickStart are `org.apache.tsfile.v4.WriteTabletWithITsFileWriter` (for writing TsFiles) and `org.apache.tsfile.v4.ITsFileReaderAndITsFileWriter` (for reading and writing TsFiles), and it seems that the former one is just a subset of the latter one. Besides, both of them are prefixed with `v4`. This is confusing because TsFile Java only has v1 and v2. What does v4 stand for? Does that mean that examples outside the `v4` package are outdated? Finally, I stumbled upon the [TsFile API](https://tsfile.apache.org/zh/stage/QuickStart.html) page, which is an orphan page. I noticed that it is under the "stage" directory, is it a "staging" page? Will it be published one day? Above all, could you please provide more docs for the Java examples? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
