apache / apache/parquet-java

Fix parquet-cli's wrong or missing usage examples

オープン
#2,338 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
Component: CLI Component: Parquet Priority: Minor Type: bug
主要言語
Java
スター
3.1k
フォーク
1.6k
平均マージ
3日 12時間
マージ済み PR(30日)
33

説明

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

```Java

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.

```Java

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

$ java -cp 'target/*:target/dependency/*' org.apache.parquet.cli.Main help meta

Usage: parquet [general options] meta [command options]

Description:

Print a Parquet file's metadata

Examples:

```

**Reporter**: [Kengo Seki](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=sekikn) / @sekikn
**Assignee**: [Kengo Seki](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=sekikn) / @sekikn
#### PRs and other links:
- [GitHub Pull Request #649](https://github.com/apache/parquet-mr/pull/649)

**Note**: *This issue was originally created as [PARQUET-1597](https://issues.apache.org/jira/browse/PARQUET-1597). Please see the [migration documentation](https://issues.apache.org/jira/browse/PARQUET-2502) for further details.*

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

影響を受けるエントリポイントは、parquet-cli の to-avro、convert-csv、および meta のヘルプ出力です。まず、示されている `java -cp ... org.apache.parquet.cli.Main help meta` コマンドを実行し、対応するヘルプ定義を確認してください。変換例が必須オプションと正しいファイル名を使用し、meta がサンプルコンテンツを表示すれば完了です。pull request #649 は、作業がすでに進行中であることを示しています。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java
領域
cli, documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。