Skip to content

Commit fc162ec

Browse files
zzylolclaude
andcommitted
docs: describe the flat DAG and physical export instead of the removed logical export
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01W7qG9aFyPij5uWsyAJCxDW
1 parent d10807c commit fc162ec

2 files changed

Lines changed: 4 additions & 5 deletions

File tree

‎crates/types/src/lib.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
//! - [`ir`] — the unified operator IR (#511): one operator DAG before and
44
//! after ASAP optimization ([`ir::OperatorNode`]), arranged by #511 section
55
//! ([`ir::operator`], [`ir::scalar`], [`ir::schema`], [`ir::properties`]),
6-
//! plus its passes (canonicalize, CSE, timing) and the wire export
7-
//! ([`ir::export`]). No execution logic lives in this crate (issue #190).
6+
//! plus its passes (canonicalize, CSE, timing), the flat DAG
7+
//! ([`ir::flat`]) and the physical export ([`ir::physical_export`]). No execution logic lives in this crate (issue #190).
88
//! - [`workload`] — planner inputs (#509): query and data workloads, the
99
//! lowered [`workload::parsed_workload`], and [`workload::resources`].
1010
//! - [`deployment`] — the deployment's capabilities, a planner input (#509)

‎docs/develop_docs/library-api.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -275,9 +275,8 @@ optional also does not guarantee every planning operation can succeed without it
275275
| Function/type | Purpose |
276276
| --- | --- |
277277
| `asap_types::ir::apply_materialization_timings(&root, &assignment, &mut TimingMemo::new())` | Write execution timing into every node from a `MaterializationAssignment` (default: all query time) and validate the data-state edges; `PlanOutput::execution_timed_dag()` applies the default to a planned workload |
278-
| `asap_types::ir::export::compile_logical_asap_dag(&root)` | Export a DAG as a `LogicalASAPDAG` for inspection; not a physical plan |
279-
| `LogicalASAPDAGDocument::new(dag)` and `.validate()` | Versioned envelope and explicit validation; constructing it alone does not validate |
280-
| `asap_types::ir::export::compile_physical_asap_dag(&timed_root)` | Export a timed DAG as the `PhysicalASAPDAG` a deployment binds; rejects an untimed node |
278+
| `asap_types::ir::flat::flatten(&roots)` | A DAG as a flat, serializable node list (`FlatDag`, children as node ids) for inspection; not a physical plan |
279+
| `asap_types::ir::physical_export::compile_physical_asap_dag(&timed_root)` | Export a timed DAG as the `PhysicalASAPDAG` a deployment binds; rejects an untimed node |
281280

282281
Choose the export matching your intended handoff, and preserve the selection
283282
report a downstream needs instead of exporting only a bare DAG. For public

0 commit comments

Comments
 (0)