serve-unbound

Serve an unbound expression as an Arrow Flight endpoint.

Replaces a selected node of the built expression with an unbound table and serves the result; clients stream record batches to the endpoint to drive the computation. If neither --to-unbind-hash nor --to-unbind-tag is supplied, the node is inferred from graph analysis; supply one for determinism.

Usage

xorq serve-unbound BUILD_PATH [OPTIONS]

Arguments

  • BUILD_PATH—Path to the build directory produced by xorq build.

Options

Option Default Description
--to-unbind-hash inferred Hash of the node to unbind.
--to-unbind-tag inferred Tag of the node to unbind (alternative to –to-unbind-hash).
--typ none Type of the node to unbind.
--host localhost Host to bind the Flight server.
--port random Port to bind the Flight server.
--prometheus-port off Port to expose Prometheus metrics.
--cache-dir $XORQ_CACHE_DIR or ~/.cache/xorq Directory for parquet cache files.

Examples

# Serve with an explicit node hash
xorq serve-unbound builds/7061dd65ff3c --host 0.0.0.0 --port 8001 --to-unbind-hash b2370a29c19df8e1e639c63252dacd0e
# Select the node to unbind by tag
xorq serve-unbound builds/7061dd65ff3c --to-unbind-tag source_input

See also

  • run-unbound—run the same unbound expression once over Arrow IPC instead of serving it
  • catalog serve-unbound—serve a catalog entry instead of a build directory