Next Previous Up Contents
Next: Examples
Up: parqlook: Presents information about a parquet file
Previous: parqlook: Presents information about a parquet file

### B.11.1 Usage

The usage of `parqlook` is

       stilts <stilts-flags> parqlook
                                      items=[schema|keyvalue|blocks|chunks|votable|keyvaluefull, ...] | default
                                      [in=]<filename>

If you don't have the `stilts` script installed, write "`java -jar stilts.jar`" instead of "`stilts`" - see Section 3. The available `<stilts-flags>` are listed in Section 2.1. For programmatic invocation, the Task class for this command is `uk.ac.starlink.ttools.task.ParquetTool`.

Parameter values are assigned on the command line as explained in Section 2.3. They are as follows:

`in = <filename>` (String)
  Name of the parquet file to examine.
`items = [schema|keyvalue|blocks|chunks|votable|keyvaluefull, ...] | default` (MetaItem[])
  Selects which items of metadata about the parquet file to display. The value is a comma-separated list, containing zero or more of the following:
  - `schema`: displays the parquet schema
  - `keyvalue`: displays the parquet per-table key-value metadata pairs in a compact format; long or multi-line values are summarised
  - `blocks`: displays information about the parquet data blocks
  - `chunks`: displays information about the column chunks in the parquet file
  - `votable`: displays the VOTable document providing additional metadata according to the VOParquet convention
  - `keyvaluefull`: displays the full content of parquet per-table key-value metadata pairs
  If the value is the special token "`default`" then all the items above except for "`keyvaluefull`" will be output. If the value is blank then none of these will be output. Either way, informational reports will still be written as requested.

  The text is written to standard output. If there are multiple items to display, they are indented and presented under headings. In the case that there is only one however, it is output without adornment.

  [Default: `default`]

Next Previous Up Contents
Next: Examples
Up: parqlook: Presents information about a parquet file
Previous: parqlook: Presents information about a parquet file

STILTS - Starlink Tables Infrastructure Library Tool Set
Starlink User Note256
STILTS web page: http://www.starlink.ac.uk/stilts/
Author email: m.b.taylor@bristol.ac.uk
Mailing list: topcat-user@jiscmail.ac.uk