Skip to content

Commit c9d1585

Browse files
author
Luke Osborne
committed
readyset-dataflow: Add docs comment for Domain
This adds a doc comment for the Domain struct, providing a simple description of a Domain. Change-Id: I0aa650bd430df3446b0b0aa751f216a8d746de75 Reviewed-on: https://gerrit.readyset.name/c/readyset/+/5269 Tested-by: Buildkite CI Reviewed-by: Aspen Smith <[email protected]>
1 parent ee45126 commit c9d1585

File tree

1 file changed

+5
-0
lines changed
  • readyset-dataflow/src/domain

1 file changed

+5
-0
lines changed

readyset-dataflow/src/domain/mod.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -577,6 +577,11 @@ impl RemappedKeys {
577577
}
578578
}
579579

580+
/// A [`Domain`] is a well-connected sub-graph of the overall dataflow graph, used as the unit
581+
/// of execution of the dataflow engine. The dataflow graph is split up into domains using
582+
/// [heuristics](../src/readyset_server/controller/migrate/assignment.rs.html)
583+
/// Domains are [scheduled](../src/readyset_server/controller/migrate/scheduling.rs.html)
584+
/// onto workers.
580585
pub struct Domain {
581586
index: DomainIndex,
582587
shard: Option<usize>,

0 commit comments

Comments
 (0)