Skip to content

Commit b92cee5

Browse files
authored
docs(vx): state which inspection commands support --json (#9638)
`query.md` said all inspection commands support `--json`. `vx segments` has no such flag (it always prints JSON) and `vx tree array` accepts it then prints a human tree, so a script trusting it breaks either way. Wiring `vx tree array` changes CLI output, so that is left for an issue. Also adds `query` and `segments` to the `vx` README, which listed four of six subcommands. ## Tests `make -C docs html` succeeds under `--fail-on-warning`, same warning count as develop. ## AI assistance Written with agentic AI assistance; I read each command's argument struct first. Signed-off-by: jackylee <qcsd2011@gmail.com>
1 parent 47fd3e8 commit b92cee5

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

docs/getting-started/query.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ vx segments yellow_tripdata_2024-01.vortex
5151
vx inspect yellow_tripdata_2024-01.vortex
5252
```
5353

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

5657
## Standalone SQL
5758

vortex-tui/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ A small, helpful CLI tool for exploring and analyzing Vortex files.
66
* `tree`: Print the encoding tree of a Vortex file
77
* `inspect`: Inspect Vortex file footer and metadata
88
* `convert`: Convert a Parquet file to a Vortex file
9+
* `query`: Run a SQL query against a Vortex file and print JSON
10+
* `segments`: Print the segment layout of a Vortex file as JSON
911

1012
## Examples
1113

0 commit comments

Comments
 (0)