mito2/
lib.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
// Copyright 2023 Greptime Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! # Mito
//!
//! Mito is the a region engine to store timeseries data.

#![feature(let_chains)]
#![feature(assert_matches)]

#[cfg(any(test, feature = "test"))]
#[cfg_attr(feature = "test", allow(unused))]
pub mod test_util;

pub mod access_layer;
pub mod cache;
pub mod compaction;
pub mod config;
pub mod engine;
pub mod error;
pub mod flush;
pub mod manifest;
pub mod memtable;
mod metrics;
pub mod read;
pub mod region;
mod region_write_ctx;
pub mod request;
pub mod row_converter;
pub mod schedule;
pub mod sst;
mod time_provider;
pub mod wal;
mod worker;

#[cfg_attr(doc, aquamarine::aquamarine)]
/// # Mito developer document
///
/// ## Engine
///
/// Engine hierarchy:
///
/// ```mermaid
/// classDiagram
/// class MitoEngine {
///     -WorkerGroup workers
/// }
/// class MitoRegion {
///     +VersionControlRef version_control
///     -RegionId region_id
///     -String manifest_dir
///     -AtomicI64 last_flush_millis
///     +region_id() RegionId
///     +scan() ChunkReaderImpl
/// }
/// class RegionMap {
///     -HashMap<RegionId, MitoRegionRef> regions
/// }
/// class ChunkReaderImpl
///
/// class WorkerGroup {
///     -Vec~RegionWorker~ workers
/// }
/// class RegionWorker {
///     -RegionMap regions
///     -Sender sender
///     -JoinHandle handle
/// }
/// class RegionWorkerThread~LogStore~ {
///     -RegionMap regions
///     -Receiver receiver
///     -Wal~LogStore~ wal
///     -ObjectStore object_store
///     -MemtableBuilderRef memtable_builder
///     -FlushSchedulerRef~LogStore~ flush_scheduler
///     -FlushStrategy flush_strategy
///     -CompactionSchedulerRef~LogStore~ compaction_scheduler
///     -FilePurgerRef file_purger
/// }
/// class Wal~LogStore~ {
///     -LogStore log_store
/// }
/// class MitoConfig
///
/// MitoEngine o-- MitoConfig
/// MitoEngine o-- MitoRegion
/// MitoEngine o-- WorkerGroup
/// MitoRegion o-- VersionControl
/// MitoRegion -- ChunkReaderImpl
/// WorkerGroup o-- RegionWorker
/// RegionWorker o-- RegionMap
/// RegionWorker -- RegionWorkerThread~LogStore~
/// RegionWorkerThread~LogStore~ o-- RegionMap
/// RegionWorkerThread~LogStore~ o-- Wal~LogStore~
/// ```
///
/// ## Metadata
///
/// Metadata hierarchy:
///
/// ```mermaid
/// classDiagram
/// class VersionControl {
///     -CowCell~Version~ version
///     -AtomicU64 committed_sequence
/// }
/// class Version {
///     -RegionMetadataRef metadata
///     -MemtableVersionRef memtables
///     -SstVersionRef ssts
///     -SequenceNumber flushed_sequence
///     -ManifestVersion manifest_version
/// }
/// class MemtableVersion {
///     -MemtableRef mutable
///     -Vec~MemtableRef~ immutables
///     +mutable_memtable() MemtableRef
///     +immutable_memtables() &[MemtableRef]
///     +freeze_mutable(MemtableRef new_mutable) MemtableVersion
/// }
/// class SstVersion {
///     -LevelMetaVec levels
///     -AccessLayerRef sst_layer
///     -FilePurgerRef file_purger
///     -Option~i64~ compaction_time_window
/// }
/// class LevelMeta {
///     -Level level
///     -HashMap<FileId, FileHandle> files
/// }
/// class FileHandle {
///     -FileMeta meta
///     -bool compacting
///     -AtomicBool deleted
///     -AccessLayerRef sst_layer
///     -FilePurgerRef file_purger
/// }
/// class FileMeta {
///     +RegionId region_id
///     +FileId file_id
///     +Option<Timestamp, Timestamp> time_range
///     +Level level
///     +u64 file_size
/// }
/// VersionControl o-- Version
/// Version o-- RegionMetadata
/// Version o-- MemtableVersion
/// Version o-- SstVersion
/// SstVersion o-- LevelMeta
/// LevelMeta o-- FileHandle
/// FileHandle o-- FileMeta
/// class RegionMetadata
/// ```
///
/// ## Region workers
///
/// The engine handles DMLs and DDLs in dedicated [workers](crate::worker::WorkerGroup).
///
/// ## Region manifest
///
/// The [RegionManifestManager](crate::manifest::manager::RegionManifestManager) manages metadata of the engine.
///
mod docs {}