pqrs is a command line tool for inspecting Parquet filespqrs roughly means "parquet-tools in rust"You can download release binaries here
For macOS users, pqrs is available as a homebrew tap.
shell
brew install manojkarthick/tap/pqrs
NOTE: For users upgrading from v0.2 or prior, note that the location of the pqrs homebrew tap has been updated.
To update to v0.2.1+, please uninstall using brew uninstall pqrs and use the above command to re-install.
pqrs is also available for installation from crates.io using cargo, the rust package manager.
shell
cargo install pqrs
Make sure you have rustc and cargo installed on your machine.
shell
git clone https://github.com/manojkarthick/pqrs.git
cargo build --release
./target/release/pqrs
The below snippet shows the available subcommands:
```shell ❯ pqrs --help pqrs 0.2.1 Manoj Karthick Apache Parquet command-line utility
USAGE: pqrs [FLAGS] [SUBCOMMAND]
FLAGS: -d, --debug Show debug output -h, --help Prints help information -V, --version Prints version information
SUBCOMMANDS: cat Prints the contents of Parquet file(s) head Prints the first n records of the Parquet file help Prints this message or the help of the given subcommand(s) merge Merge file(s) into another parquet file rowcount Prints the count of rows in Parquet file(s) sample Prints a random sample of records from the Parquet file schema Prints the schema of Parquet file(s) size Prints the size of Parquet file(s) ```
Prints the contents of the given files and folders. Recursively traverses and prints all the files if the input is a directory.
Supports json-like, json or CSV format. Use --json for JSON output, --csv for CSV output with column names in the first row, and --csv-data-only for CSV output without the column names row.
shell
❯ pqrs cat data/cities.parquet
{continent: "Europe", country: {name: "France", city: ["Paris", "Nice", "Marseilles", "Cannes"]}}
{continent: "Europe", country: {name: "Greece", city: ["Athens", "Piraeus", "Hania", "Heraklion", "Rethymnon", "Fira"]}}
{continent: "North America", country: {name: "Canada", city: ["Toronto", "Vancouver", "St. John's", "Saint John", "Montreal", "Halifax", "Winnipeg", "Calgary", "Saskatoon", "Ottawa", "Yellowknife"]}}
shell
❯ pqrs cat data/cities.parquet --json
{"continent":"Europe","country":{"name":"France","city":["Paris","Nice","Marseilles","Cannes"]}}
{"continent":"Europe","country":{"name":"Greece","city":["Athens","Piraeus","Hania","Heraklion","Rethymnon","Fira"]}}
{"continent":"North America","country":{"name":"Canada","city":["Toronto","Vancouver","St. John's","Saint John","Montreal","Halifax","Winnipeg","Calgary","Saskatoon","Ottawa","Yellowknife"]}}
shell
❯ pqrs cat data/simple.parquet --csv
foo,bar
1,2
10,20
shell
❯ pqrs cat data/simple.parquet --csv --no-header
1,2
10,20
NOTE: CSV format is not supported for files that contain Struct or Byte fields.
Prints the first N records of the parquet file. Use --records flag to set the number of records.
shell
❯ pqrs head data/cities.parquet --json --records 2
{"continent":"Europe","country":{"name":"France","city":["Paris","Nice","Marseilles","Cannes"]}}
{"continent":"Europe","country":{"name":"Greece","city":["Athens","Piraeus","Hania","Heraklion","Rethymnon","Fira"]}}
Merge two Parquet files by placing row groups (or blocks) from the two files one after the other.
Disclaimer: This does not combine the files to have optimized row groups, do not use it in production!
```shell ❯ pqrs merge --input data/pems-1.snappy.parquet data/pems-2.snappy.parquet --output data/pems-merged.snappy.parquet
❯ ls -al data total 408 drwxr-xr-x 6 manojkarthick staff 192 Feb 14 08:53 . drwxr-xr-x 20 manojkarthick staff 640 Feb 14 08:52 .. -rw-r--r-- 1 manojkarthick staff 866 Feb 8 19:50 cities.parquet -rw-r--r-- 1 manojkarthick staff 16468 Feb 8 19:50 pems-1.snappy.parquet -rw-r--r-- 1 manojkarthick staff 17342 Feb 8 19:50 pems-2.snappy.parquet -rw-r--r-- 1 manojkarthick staff 160950 Feb 14 08:53 pems-merged.snappy.parquet ```
Print the number of rows present in the parquet file.
shell
❯ pqrs row-count data/pems-1.snappy.parquet data/pems-2.snappy.parquet
File Name: data/pems-1.snappy.parquet: 2693 rows
File Name: data/pems-2.snappy.parquet: 2880 rows
Prints a random sample of records from the given parquet file.
shell
❯ pqrs sample data/pems-1.snappy.parquet --records 3
{timeperiod: "01/17/2016 07:01:27", flow1: 0, occupancy1: 0E0, speed1: 0E0, flow2: 0, occupancy2: 0E0, speed2: 0E0, flow3: 0, occupancy3: 0E0, speed3: 0E0, flow4: null, occupancy4: null, speed4: null, flow5: null, occupancy5: null, speed5: null, flow6: null, occupancy6: null, speed6: null, flow7: null, occupancy7: null, speed7: null, flow8: null, occupancy8: null, speed8: null}
{timeperiod: "01/17/2016 07:47:27", flow1: 0, occupancy1: 0E0, speed1: 0E0, flow2: 0, occupancy2: 0E0, speed2: 0E0, flow3: 0, occupancy3: 0E0, speed3: 0E0, flow4: null, occupancy4: null, speed4: null, flow5: null, occupancy5: null, speed5: null, flow6: null, occupancy6: null, speed6: null, flow7: null, occupancy7: null, speed7: null, flow8: null, occupancy8: null, speed8: null}
{timeperiod: "01/17/2016 09:44:27", flow1: 0, occupancy1: 0E0, speed1: 0E0, flow2: 0, occupancy2: 0E0, speed2: 0E0, flow3: 0, occupancy3: 0E0, speed3: 0E0, flow4: null, occupancy4: null, speed4: null, flow5: null, occupancy5: null, speed5: null, flow6: null, occupancy6: null, speed6: null, flow7: null, occupancy7: null, speed7: null, flow8: null, occupancy8: null, speed8: null}
Print the schema from the given parquet file. Use the --detailed flag to get more detailed stats.
```shell ❯ pqrs schema data/cities.parquet Metadata for file: data/cities.parquet
version: 1 num of rows: 3 created by: parquet-mr version 1.5.0-cdh5.7.0 (build ${buildNumber}) message hiveschema { OPTIONAL BYTEARRAY continent (UTF8); OPTIONAL group country { OPTIONAL BYTEARRAY name (UTF8); OPTIONAL group city (LIST) { REPEATED group bag { OPTIONAL BYTEARRAY array_element (UTF8); } } } } ```
```shell ❯ pqrs schema data/cities.parquet --detailed
num of row groups: 1 row groups:
total byte size: 466 num of rows: 3
num of columns: 3 columns:
column type: BYTEARRAY column path: "continent" encodings: BITPACKED PLAINDICTIONARY RLE file path: N/A file offset: 4 num of values: 3 total compressed size (in bytes): 93 total uncompressed size (in bytes): 93 data page offset: 4 index page offset: N/A dictionary page offset: N/A statistics: {min: [69, 117, 114, 111, 112, 101], max: [78, 111, 114, 116, 104, 32, 65, 109, 101, 114, 105, 99, 97], distinctcount: N/A, nullcount: 0, minmax_deprecated: true}
<....output clipped>
```
```shell ❯ pqrs schema --json data/cities.parquet {"version":1,"numrows":3,"createdby":"parquet-mr version 1.5.0-cdh5.7.0 (build ${buildNumber})","metadata":null,"columns":[{"optional":"true","physicaltype":"BYTEARRAY","name":"continent","path":"continent","convertedtype":"UTF8"},{"name":"name","convertedtype":"UTF8","path":"country.name","physicaltype":"BYTEARRAY","optional":"true"},{"optional":"true","name":"arrayelement","physicaltype":"BYTEARRAY","path":"country.city.bag.arrayelement","convertedtype":"UTF8"}],"message":"message hiveschema {\n OPTIONAL BYTEARRAY continent (UTF8);\n OPTIONAL group country {\n OPTIONAL BYTEARRAY name (UTF8);\n OPTIONAL group city (LIST) {\n REPEATED group bag {\n OPTIONAL BYTEARRAY arrayelement (UTF8);\n }\n }\n }\n}\n"}
```
Print the compressed/uncompressed size of the parquet file. Shows uncompressed size by default
```shell ❯ pqrs size data/pems-1.snappy.parquet --pretty Size in Bytes:
File Name: data/pems-1.snappy.parquet Uncompressed Size: 61 KiB ```
```shell ❯ pqrs size data/pems-1.snappy.parquet --pretty --compressed Size in Bytes:
File Name: data/pems-1.snappy.parquet Compressed Size: 12 KiB ```