Skip to content
Get Started

barca plan

The document includes plan_version: 1, independent of the package and database versions. Consumers of saved plans should reject unsupported versions.

barca plan [file.py|dir/ ...]

Parse the source files and print the execution plan as JSON, without running anything. The pool size matches execution: a positive BARCA_POOL_SIZE, else [execution] pool_size, else the available cores, or the capacity when it is smaller; pool_size and pool_source say which. Experimental: the layout follows the planner and may change between releases. Each phase’s reason is {"type": "initial"} or {"type": "fan_in", "node_id": "..."}. Planning reads no state, so plan takes no --env and does not say what is cached; use --dry-run or barca status for that. Its options are --partition (plan only the selected keys, as barca get takes it) and --json / --pretty.

$ barca plan pipeline.py
{
"plan_version": 1,
"total_steps": 3,
"pool_size": 16,
"pool_source": "cores",
"capacity": 16,
"capacity_source": "pool size",
"weights": {},
"phases": [
{
"reason": {
"type": "initial"
},
"streams": [
{
"stream_id": "p0-w0",
"steps": [
"pipeline.py:orders",
"pipeline.py:total",
"pipeline.py:notify"
]
}
]
}
],
"warnings": []
}

All commands · Output format · Errors and exit codes