[CARBONDATA-3066]add documentation for writtenBy and getVersionDetails APIs in SDK #2888
Conversation
docs/sdk-guide.md
Outdated
| @@ -124,7 +124,7 @@ public class TestSdkAvro { | |||
| try { | |||
| CarbonWriter writer = CarbonWriter.builder() | |||
| .outputPath(path) | |||
| .withAvroInput(new org.apache.avro.Schema.Parser().parse(avroSchema)).build(); | |||
| .withAvroInput(new org.apache.avro.Schema.Parser().parse(avroSchema))..writtenBy("SDK").build(); | |||
There was a problem hiding this comment.
two ..
Please remove one
| /** | ||
| * To support writing the ApplicationName which is writing the carbondata file | ||
| * @param application name which is writing the carbondata files | ||
| * @return CarbonWriterBuilder |
There was a problem hiding this comment.
mention that it is mandatory method to call
There was a problem hiding this comment.
why is this mandatory? Why not use 'anonymous' instead?
There was a problem hiding this comment.
this is mandatory because SDK can be used by different application, one application can write and other can read this, so we store this info, during load case we take from spark application name, SDK needs to provide this
| /** | ||
| * This method return the version details in formatted string by reading from carbondata file | ||
| * @param dataFilePath complete path including carbondata file name | ||
| * @return string with information of who has written this file in which carbondata project version |
There was a problem hiding this comment.
can mention one example string in the header
|
Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/1197/ |
|
Build Failed with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/1414/ |
|
Build Success with Spark 2.3.1, Please check CI http://136.243.101.176:8080/job/carbondataprbuilder2.3/9461/ |
|
Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/1227/ |
|
Build Success with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/1442/ |
|
Build Success with Spark 2.3.1, Please check CI http://136.243.101.176:8080/job/carbondataprbuilder2.3/9491/ |
|
LGTM |
1 similar comment
|
LGTM |
…s APIs in SDK This PR adds the documentation for new APIs added in SDK builder API- writtenBy() reader API- getVersionDetails() This closes #2888
This PR adds the documentation for new APIs added in SDK
builder API- writtenBy()
reader API- getVersionDetails()
Be sure to do all of the following checklist to help us incorporate
your contribution quickly and easily:
Any interfaces changed?
Any backward compatibility impacted?
Document update required?
Testing done
Please provide details on
- Whether new unit test cases have been added or why no new tests are required?
- How it is tested? Please attach test report.
- Is it a performance related change? Please attach the performance test report.
- Any additional information to help reviewers in testing this change.
For large changes, please consider breaking it into sub-tasks under an umbrella JIRA.