apache / apache/parquet-java

Fix parquet-cli's wrong or missing usage examples

Aperta
#2,338 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Component: CLI Component: Parquet Priority: Minor Type: bug
Lingua principale
Java
Stelle
3.1k
Fork
1.6k
Merge medio
3g 12h
PR unite (30g)
33

Descrizione

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

I punti di ingresso interessati sono l'output della guida di to-avro, convert-csv e meta di parquet-cli. Inizia eseguendo il comando mostrato `java -cp ... org.apache.parquet.cli.Main help meta` e ispeziona le definizioni della guida corrispondenti. Il lavoro è completo quando gli esempi di conversione usano le opzioni richieste e i nomi di file corretti, mentre meta visualizza contenuti di esempio; pull request #649 indica che il lavoro è già in corso.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
cli, documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.