Skip to content

docs(vx): state which inspection commands support --json #9638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jackylee-ch wants to merge 1 commit into
base: develop
Choose a base branch
from
+4 −1
Open

docs(vx): state which inspection commands support --json #9638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/getting-started/query.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ vx segments yellow_tripdata_2024-01.vortex
vx inspect yellow_tripdata_2024-01.vortex
```

All inspection commands support `--json` for machine-readable output.
`vx inspect` and `vx tree layout` take `--json` for machine-readable output; `vx segments` always
emits JSON.

## Standalone SQL

Expand Down
2 changes: 2 additions & 0 deletions vortex-tui/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ A small, helpful CLI tool for exploring and analyzing Vortex files.
* `tree`: Print the encoding tree of a Vortex file
* `inspect`: Inspect Vortex file footer and metadata
* `convert`: Convert a Parquet file to a Vortex file
* `query`: Run a SQL query against a Vortex file and print JSON
* `segments`: Print the segment layout of a Vortex file as JSON

## Examples

Expand Down