Fix parquet-cli's wrong or missing usage examples
- Lenguaje dominante
- Java
- Estrellas
- 3.1k
- Forks
- 1.6k
- Merge medio
- 3 d 12 h
- PR fusionados (30 d)
- 33
Descripción
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.*
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Línea de trabajo
Los puntos de entrada afectados son la salida de ayuda de to-avro, convert-csv y meta de parquet-cli. Empieza ejecutando el comando mostrado `java -cp ... org.apache.parquet.cli.Main help meta` e inspecciona las definiciones de ayuda correspondientes. Se considera terminado cuando los ejemplos de conversión usan las opciones requeridas y los nombres de archivo correctos, mientras que meta muestra contenido de ejemplo; pull request #649 indica que el trabajo ya está en marcha.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java
- Área
- cli, documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100