[PARQUET-1597] Fix parquet-cli's wrong or missing usage examples

• Type: Bug
• Status: Patch Available
• Priority: Minor
• Resolution: Unresolved
• Component/s: parquet-cli
• Labels: pull-request-available
• Assignee: Kengo Seki
• Reporter: Kengo Seki
• Created: 13/Jun/19 03:53
• Updated: 23/Jun/24 03:31

Description

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".

  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

2. The above is the same for convert-csv.

  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

3. The meta command has an "Examples:" heading but lacks its content.

$ 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:

Issue Links

• links to: GitHub Pull Request #649