Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[CARBONDATA-3095] Optimize the documentation of SDK/CSDK #2915

Closed
wants to merge 2 commits into from
Closed

[CARBONDATA-3095] Optimize the documentation of SDK/CSDK #2915

wants to merge 2 commits into from

Conversation

xubo245
Copy link
Contributor

@xubo245 xubo245 commented Nov 13, 2018 •
edited

Optimize the documentation of SDK/CSDK.

1.correct one error: after split(int maxSplits) of sdk-guide.md, the format has problem because less `
2.add doc
3.move the order of doc

Be sure to do all of the following checklist to help us incorporate
your contribution quickly and easily:

  • Any interfaces changed?
    No
  • Any backward compatibility impacted?
    No
  • Document update required?
    Yes
  • Testing done
    No need
  • For large changes, please consider breaking it into sub-tasks under an umbrella JIRA.
    Jira-2951

@CarbonDataQA
Copy link

Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/1380/

@CarbonDataQA
Copy link

Build Success with Spark 2.3.1, Please check CI http://136.243.101.176:8080/job/carbondataprbuilder2.3/9638/

@CarbonDataQA
Copy link

Build Success with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/1590/

@xubo245
Copy link
Contributor Author

xubo245 commented Nov 14, 2018

@KanakaKumar @jackylk @ajantha-bhat please review it.

@xubo245
Copy link
Contributor Author

xubo245 commented Nov 19, 2018

@KanakaKumar @jackylk @QiangCai @ajantha-bhat Please review it.

KanakaKumar
KanakaKumar reviewed Nov 22, 2018
View reviewed changes
docs/sdk-guide.md Outdated
@@ -684,6 +713,17 @@ Find example code at [CarbonReaderExample](https://github.com/apache/carbondata/
public CarbonReaderBuilder withHadoopConf(Configuration conf);
```

```
/**
* configure hadoop configuration with key value
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to "Updates the hadoop configuration with the given key value"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, done

KanakaKumar
KanakaKumar reviewed Nov 22, 2018
View reviewed changes
docs/sdk-guide.md Outdated
@@ -674,6 +693,16 @@ Find example code at [CarbonReaderExample](https://github.com/apache/carbondata/
public CarbonReaderBuilder filter(Expression filterExpression);
```

```
/**
* set read batch size before build
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sets the batch size of records to read

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, done

@xubo245
Copy link
Contributor Author

xubo245 commented Nov 22, 2018

@KanakaKumar Updated

@CarbonDataQA
Copy link

Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/1513/

@CarbonDataQA
Copy link

Build Success with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/1723/

@CarbonDataQA
Copy link

Build Success with Spark 2.3.1, Please check CI http://136.243.101.176:8080/job/carbondataprbuilder2.3/9771/

@xubo245
Copy link
Contributor Author

xubo245 commented Nov 23, 2018

@KanakaKumar @kunal642 @ajantha-bhat CI pass, please check it.

@KanakaKumar
Copy link
Contributor

LGTM

sraghunandan
sraghunandan reviewed Nov 28, 2018
View reviewed changes
docs/sdk-guide.md Outdated
@@ -709,37 +749,7 @@ Find example code at [CarbonReaderExample](https://github.com/apache/carbondata/
public <T> CarbonReader<T> build();
```
### Class org.apache.carbondata.sdk.file.CarbonSchemaReader
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is better to mark as deprecated and remove in next version

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, done

docs/sdk-guide.md
@@ -478,6 +489,16 @@ public CarbonWriter build() throws IOException, InvalidLoadOptionException;
```

### Class org.apache.carbondata.sdk.file.CarbonWriter

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why we changed the order?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because it should builder, build, and then colse when user use the API, so it's better that the doc should keep the same order

@CarbonDataQA
Copy link

Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/1576/

@CarbonDataQA
Copy link

Build Success with Spark 2.3.1, Please check CI http://136.243.101.176:8080/job/carbondataprbuilder2.3/9835/

@CarbonDataQA
Copy link

Build Failed with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/1788/

@xubo245
Copy link
Contributor Author

xubo245 commented Nov 29, 2018

retest this please

@CarbonDataQA
Copy link

Build Success with Spark 2.1.0, Please check CI http://136.243.101.176:8080/job/ApacheCarbonPRBuilder2.1/1581/

@CarbonDataQA
Copy link

Build Success with Spark 2.3.1, Please check CI http://136.243.101.176:8080/job/carbondataprbuilder2.3/9840/

@CarbonDataQA
Copy link

Build Success with Spark 2.2.1, Please check CI http://95.216.28.178:8080/job/ApacheCarbonPRBuilder1/1793/

@xubo245
Copy link
Contributor Author

xubo245 commented Nov 30, 2018

@sraghunandan @KanakaKumar @kunal642 CI pass, please check it.

@sraghunandan
Copy link
Contributor

Lgtm

@asfgit asfgit closed this in c55279c Nov 30, 2018
asfgit pushed a commit that referenced this pull request Nov 30, 2018
@xubo245 @ravipesala
[CARBONDATA-3095] Optimize the documentation of SDK/CSDK
9c149d7 
Optimize the documentation of SDK/CSDK.

1.correct one error: after split(int maxSplits) of sdk-guide.md, the format has problem because less `
2.add doc
3.move the order of doc

This closes #2915
qiuchenjian pushed a commit to qiuchenjian/carbondata that referenced this pull request Jun 14, 2019
@xubo245 @qiuchenjian
[CARBONDATA-3095] Optimize the documentation of SDK/CSDK
b3d4f65 
Optimize the documentation of SDK/CSDK.

1.correct one error: after split(int maxSplits) of sdk-guide.md, the format has problem because less `
2.add doc
3.move the order of doc

This closes apache#2915
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sraghunandan sraghunandan sraghunandan left review comments

@KanakaKumar KanakaKumar KanakaKumar left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@xubo245 @CarbonDataQA @KanakaKumar @sraghunandan