Skip to content

Commit

Permalink
docs: update mermaid
Browse files Browse the repository at this point in the history
  • Loading branch information
evenyag committed Mar 27, 2024
1 parent ed48d0c commit 16c2f8f
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions src/mito2/src/read/scan_region.rs
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ impl Scanner {
}
}

// TODO(yingwen): Update mermaid
#[cfg_attr(doc, aquamarine::aquamarine)]
/// Helper to scans a region by [ScanRequest].
///
Expand All @@ -104,15 +103,23 @@ impl Scanner {
/// class Scanner {
/// <<enumeration>>
/// SeqScan
/// UnorderedScan
/// +scan() SendableRecordBatchStream
/// }
/// class SeqScan {
/// -ScanInput input
/// +build() SendableRecordBatchStream
/// }
/// class UnorderedScan {
/// -ScanInput input
/// +build() SendableRecordBatchStream
/// }
/// class ScanInput {
/// -ProjectionMapper mapper
/// -Option~TimeRange~ time_range
/// -Option~Predicate~ predicate
/// -Vec~MemtableRef~ memtables
/// -Vec~FileHandle~ files
/// +build() SendableRecordBatchStream
/// }
/// class ProjectionMapper {
/// ~output_schema() SchemaRef
Expand All @@ -121,9 +128,13 @@ impl Scanner {
/// ScanRegion -- Scanner
/// ScanRegion o-- ScanRequest
/// Scanner o-- SeqScan
/// Scanner o-- UnorderedScan
/// SeqScan o-- ScanInput
/// UnorderedScan o-- ScanInput
/// Scanner -- SendableRecordBatchStream
/// SeqScan o-- ProjectionMapper
/// ScanInput o-- ProjectionMapper
/// SeqScan -- SendableRecordBatchStream
/// UnorderedScan -- SendableRecordBatchStream
/// ```
pub(crate) struct ScanRegion {
/// Version of the region at scan.
Expand Down

0 comments on commit 16c2f8f

Please sign in to comment.