apache / apache/parquet-java

Fix parquet-cli's wrong or missing usage examples

Đang mở
#2,338 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Component: CLI Component: Parquet Priority: Minor Type: bug
Ngôn ngữ chính
Java
Star
3.1k
Fork
1.6k
Merge trung bình
3 ngày 12 giờ
Pull request đã merge (30 ngày)
33

Mô tả

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

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

Các entry point bị ảnh hưởng là phần output trợ giúp của to-avro, convert-csv và meta trong parquet-cli. Trước tiên, hãy chạy lệnh được hiển thị `java -cp ... org.apache.parquet.cli.Main help meta` và kiểm tra các định nghĩa trợ giúp tương ứng. Công việc được xem là hoàn tất khi các ví dụ chuyển đổi sử dụng các tùy chọn bắt buộc và tên tệp chính xác, còn meta hiển thị nội dung ví dụ; pull request #649 cho biết công việc đã được tiến hành.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
java
Lĩnh vực
cli, documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.