run
Execute a build artifact and write results in your chosen format.
Loads the build, resolves its data sources, executes the expression on the recorded backend, and writes the result as csv, json (NDJSON), parquet, or arrow.
Usage
xorq run BUILD_PATH [OPTIONS]Arguments
BUILD_PATH—Path to the build directory produced byxorq build.
Options
| Option | Default | Description |
|---|---|---|
--cache-dir |
$XORQ_CACHE_DIR or ~/.cache/xorq |
Directory for parquet cache files. |
-o, --output-path |
/dev/null (discard) |
Path to write output. Use ‘-’ for stdout. |
-f, --format |
parquet |
Output format. |
--limit |
unlimited | Maximum number of rows to output. |
-p, --params |
none | Override an expression parameter as key=value (repeatable, for example –params threshold=0.5). |
Examples
# Write results as parquet (the default format)
xorq run builds/f02d28198715 -o results.parquet
# Stream CSV to stdout and pipe onward
xorq run builds/f02d28198715 -o - -f csv | head -10
# Sample 100 rows with a parameter override
xorq run builds/f02d28198715 --limit 100 -p threshold=0.5 -o sample.parquetSee also
build—produce the build artifact this command executesuv run—same semantics, inside a uv-managed environmentrun-cached—same semantics, with a parquet cache wrapper