[GitHub] carbondata pull request #2888: [CARBONDATA-3066]add documentation for writte...

[qiuchenjian-2]

GitHub user akashrn5 opened a pull request:

    https://github.com/apache/carbondata/pull/2888

    [CARBONDATA-3066]add documentation for writtenBy and getVersionDetails APIs in SDK

    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.
   


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/akashrn5/incubator-carbondata sdk_doc

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/carbondata/pull/2888.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #2888
   
----
commit cf6b6ebe4b8f05695d8beea79ec677a6ce500044
Author: akashrn5 <akashnilugal@...>
Date:   2018-10-31T14:43:02Z

    add documentation for writtenBy and getVersionDetails APIs in SDK

----


---

[qiuchenjian-2]

Github user sgururajshetty commented on a diff in the pull request:

    https://github.com/apache/carbondata/pull/2888#discussion_r229732059
 
    --- Diff: docs/sdk-guide.md ---
    @@ -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();
    --- End diff --
   
    two ..
    Please remove one


---

[qiuchenjian-2]

Github user ajantha-bhat commented on a diff in the pull request:

    https://github.com/apache/carbondata/pull/2888#discussion_r229733094
 
    --- Diff: docs/sdk-guide.md ---
    @@ -429,6 +429,15 @@ public CarbonWriterBuilder withAvroInput(org.apache.avro.Schema avroSchema);
     public CarbonWriterBuilder withJsonInput(Schema carbonSchema);
     ```
     
    +```
    +/**
    +* To support writing the ApplicationName which is writing the carbondata file
    +* @param application name which is writing the carbondata files
    +* @return CarbonWriterBuilder
    --- End diff --
   
    mention that it is mandatory method to call


---

[qiuchenjian-2]

Github user ajantha-bhat commented on a diff in the pull request:

    https://github.com/apache/carbondata/pull/2888#discussion_r229733657
 
    --- Diff: docs/sdk-guide.md ---
    @@ -686,6 +695,16 @@ Find example code at [CarbonReaderExample](https://github.com/apache/carbondata/
       public static Schema readSchemaInIndexFile(String indexFilePath);
     ```
     
    +```
    +  /**
    +   * 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
    --- End diff --
   
    can mention one example in the header


---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2888
 
    Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/1197/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2888
 
    Build Failed with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/1414/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2888
 
    Build Success with Spark 2.3.1, Please check CI http://136.243.101.176:8080/job/carbondataprbuilder2.3/9461/



---

[qiuchenjian-2]

Github user xuchuanyin commented on a diff in the pull request:

    https://github.com/apache/carbondata/pull/2888#discussion_r230247864
 
    --- Diff: docs/sdk-guide.md ---
    @@ -429,6 +429,15 @@ public CarbonWriterBuilder withAvroInput(org.apache.avro.Schema avroSchema);
     public CarbonWriterBuilder withJsonInput(Schema carbonSchema);
     ```
     
    +```
    +/**
    +* To support writing the ApplicationName which is writing the carbondata file
    +* @param application name which is writing the carbondata files
    +* @return CarbonWriterBuilder
    --- End diff --
   
    why is this mandatory? Why not use 'anonymous' instead?


---

[qiuchenjian-2]

Github user akashrn5 commented on a diff in the pull request:

    https://github.com/apache/carbondata/pull/2888#discussion_r230270097
 
    --- Diff: docs/sdk-guide.md ---
    @@ -686,6 +695,16 @@ Find example code at [CarbonReaderExample](https://github.com/apache/carbondata/
       public static Schema readSchemaInIndexFile(String indexFilePath);
     ```
     
    +```
    +  /**
    +   * 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
    --- End diff --
   
    done


---

[qiuchenjian-2]

Github user akashrn5 commented on a diff in the pull request:

    https://github.com/apache/carbondata/pull/2888#discussion_r230270106
 
    --- Diff: docs/sdk-guide.md ---
    @@ -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();
    --- End diff --
   
    done


---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2888
 
    Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/1227/



---

[qiuchenjian-2]

Github user akashrn5 commented on a diff in the pull request:

    https://github.com/apache/carbondata/pull/2888#discussion_r230272135
 
    --- Diff: docs/sdk-guide.md ---
    @@ -429,6 +429,15 @@ public CarbonWriterBuilder withAvroInput(org.apache.avro.Schema avroSchema);
     public CarbonWriterBuilder withJsonInput(Schema carbonSchema);
     ```
     
    +```
    +/**
    +* To support writing the ApplicationName which is writing the carbondata file
    +* @param application name which is writing the carbondata files
    +* @return CarbonWriterBuilder
    --- End diff --
   
    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


---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2888
 
    Build Success with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/1442/



---

[qiuchenjian-2]

Github user CarbonDataQA commented on the issue:

    https://github.com/apache/carbondata/pull/2888
 
    Build Success with Spark 2.3.1, Please check CI http://136.243.101.176:8080/job/carbondataprbuilder2.3/9491/



---

[qiuchenjian-2]

Github user ajantha-bhat commented on the issue:

    https://github.com/apache/carbondata/pull/2888
 
    LGTM


---

[qiuchenjian-2]

Github user manishgupta88 commented on the issue:

    https://github.com/apache/carbondata/pull/2888
 
    LGTM


---

[qiuchenjian-2]

Github user asfgit closed the pull request at:

    https://github.com/apache/carbondata/pull/2888


---