Skip to content

Commit

Permalink
update readme and cli interface (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
noppaz authored Jan 21, 2024
1 parent 3970ff8 commit 7a7146f
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 2 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

A parquet file CLI explorer with TUI elements.

## Installation

Install from source with

```
go install
```

## Caveats

Column compressions LZO and LZ4 are not supported by collie due to the go parquet package not supporting them. See more [here](https://github.com/apache/arrow/blob/main/go/parquet/compress/compress.go).
3 changes: 2 additions & 1 deletion cmd/head.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ func init() {
var amount int
headCommand := &cobra.Command{
Use: "head",
Short: "Show N sample rows from row group zero",
Short: "Show N sample rows",
Long: "Prints a table of specified amount of rows starting from the first row group.",
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
filename := args[0]
Expand Down
1 change: 1 addition & 0 deletions cmd/less.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ func init() {
lessCommand := &cobra.Command{
Use: "less",
Short: "Scroll through N values from the file",
Long: "Enables file row exploration through a less-like interface to explore the file's rows.",
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
filename := args[0]
Expand Down
3 changes: 2 additions & 1 deletion cmd/meta.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ import (
func init() {
metaCmd := &cobra.Command{
Use: "meta",
Short: "Show file overall metadata",
Short: "Show file metadata",
Long: "Prints overall file statistics as well as the column metadata of the file.",
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
filename := args[0]
Expand Down
1 change: 1 addition & 0 deletions cmd/rowgroups.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ func init() {
rowGroupsCmd := &cobra.Command{
Use: "row-groups",
Short: "Show row group metadata",
Long: "Enables exploration of row group statistics through a pager interface.",
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
filename := args[0]
Expand Down

0 comments on commit 7a7146f

Please sign in to comment.