[
https://issues.apache.org/jira/browse/PARQUET-1597?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16864685#comment-16864685
]
ASF GitHub Bot commented on PARQUET-1597:
-----------------------------------------
sekikn commented on pull request #649: PARQUET-1597: Fix parquet-cli's wrong or
missing usage examples
URL: https://github.com/apache/parquet-mr/pull/649
Make sure you have checked _all_ steps below.
### Jira
- [x] My PR addresses the following [Parquet
Jira](https://issues.apache.org/jira/browse/PARQUET/) issues and references
them in the PR title. For example, "PARQUET-1234: My Parquet PR"
- https://issues.apache.org/jira/browse/PARQUET-1597
- In case you are adding a dependency, check if the license complies with
the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
### Tests
- [x] My PR adds the following unit tests __OR__ does not need testing for
this extremely good reason:
No additional unit test, since it's just a message fix.
I confirmed that all of the existing unit tests passed. Also, I manually ran
all examples I fixed and all of them succeeded.
### Commits
- [x] My commits all reference Jira issues in their subject lines. In
addition, my commits follow the guidelines from "[How to write a good git
commit message](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Documentation
- [x] In case of new functionality, my PR adds documentation that describes
how to use it.
- All the public functions and the classes in the PR contain Javadoc that
explain what it does
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
> Fix parquet-cli's wrong or missing usage examples
> -------------------------------------------------
>
> Key: PARQUET-1597
> URL: https://issues.apache.org/jira/browse/PARQUET-1597
> Project: Parquet
> Issue Type: Bug
> Components: parquet-cli
> Reporter: Kengo Seki
> Priority: Minor
> Labels: pull-request-available
>
> 1. The following parquet-cli's {{to-avro}} usage examples fail due to the
> lack of {{-o}} options.
> In addition, "sample.parquet" in the second example should be
> "sample.avro".
> {code}
> Examples:
> # Create an Avro file from a Parquet file
> parquet to-avro sample.parquet sample.avro
> # Create an Avro file in HDFS from a local JSON file
> parquet to-avro path/to/sample.json hdfs:/user/me/sample.parquet
> # Create an Avro file from data in S3
> parquet to-avro s3:/data/path/sample.parquet sample.avro
> {code}
> 2. The above is the same for convert-csv.
> {code}
> Examples:
> # Create a Parquet file from a CSV file
> parquet convert-csv sample.csv sample.parquet --schema schema.avsc
> # Create a Parquet file in HDFS from local CSV
> parquet convert-csv path/to/sample.csv hdfs:/user/me/sample.parquet
> --schema schema.avsc
> # Create an Avro file from CSV data in S3
> parquet convert-csv s3:/data/path/sample.csv sample.avro --format avro
> --schema s3:/schemas/schema.avsc
> {code}
> 3. The meta command has an "Examples:" heading but lacks its content.
> {code}
> $ java -cp 'target/*:target/dependency/*' org.apache.parquet.cli.Main help
> meta
> Usage: parquet [general options] meta <parquet path> [command options]
> Description:
> Print a Parquet file's metadata
> Examples:
> {code}
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
