CatCommand (Apache Parquet Command-line 1.13.1 API)

java.lang.Object
- org.apache.parquet.cli.BaseCommand
- - org.apache.parquet.cli.commands.CatCommand

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, Command
```
public class CatCommand
extends BaseCommand
```

- Field Summary
  - Fields inherited from class org.apache.parquet.cli.BaseCommand
    console
- Constructor Summary
  
  Constructors
  Constructor Description
  
  CatCommand(org.slf4j.Logger console, long defaultNumRecords)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  List<String> getExamples()
  Returns a list of example uses.
  
  int run()
  Runs this Command.
  - Methods inherited from class org.apache.parquet.cli.BaseCommand
    create, createWithChecksum, createWithNoOverwrite, defaultFS, getAvroSchema, getConf, loaderFor, loaderForJars, loaderForPaths, open, openDataFile, openSeekable, output, qualifiedPath, qualifiedURI, setConf
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CatCommand
```
public CatCommand(org.slf4j.Logger console,
                  long defaultNumRecords)
```
- Method Detail
  - run
```
public int run()
        throws IOException
```
    Description copied from interface: Command
    
    Runs this Command.
    
    Returns:
    
    a return code for the process, 0 indicates success.
    
    Throws:
    
    IOException - if there is an error while running the command
  - getExamples
```
public List<String> getExamples()
```
    Description copied from interface: Command
    
    Returns a list of example uses. Lines starting with '#' will not have the executable name added when formatting.
    
    Returns:
    
    a list of String examples