rapiddb 0.1.32

A reasonably fast configurable embedded key-value sensor database
Documentation 
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273

/// IDatabase trait abstracts the underlying Database implementation
///
/// ## Examples
/// ```no_run
/// use crate::rapiddb::traits::IDatabase;
///
/// let db = std::sync::Arc::new(
///   std::sync::RwLock::new(
///     rapiddb::db::MMAVDatabase::new()
///   )
/// );
///
/// let value = b"{\"key\": \"value\"}";
/// db.write().unwrap().post("test-0", value);
/// assert_eq!(db.write().unwrap().get_latest("test-0"), value);
/// ```
#[async_trait::async_trait]
pub trait IAsyncDatabase: Send + Sync {
  /// Checks if the sensor with `id` exists in the Database
  ///
  /// ## Examples
  /// ```no_run
  /// use crate::rapiddb::traits::IDatabase;
  ///
  /// let db = std::sync::Arc::new(
  ///   std::sync::RwLock::new(
  ///     rapiddb::db::MMAVDatabase::new()
  ///   )
  /// );
  ///
  /// let id = "test-0";
  ///
  /// if db.read().unwrap().contains(id) {
  ///     println!("{id} exists in the Database");
  /// }
  /// ```
  async fn contains(&self, id: &str) -> bool;

  /// Get the record with `rec_id` from the sensor with `id` in the
  /// Database
  ///
  /// May load data from disk, if it is not in-memory,
  /// as such it is mutable, even though a get normaly
  /// is immutable.
  ///
  /// ## Examples
  /// ```no_run
  /// use crate::rapiddb::traits::IDatabase;
  ///
  /// let db = std::sync::Arc::new(
  ///   std::sync::RwLock::new(
  ///     rapiddb::db::MMAVDatabase::new()
  ///   )
  /// );
  ///
  /// db.write().unwrap().get("test-0", 0);
  /// ```
  async fn get(&mut self, id: &str, rec_id: usize) -> Vec<u8>;

  /// Post a record with `value` to the sensor with `id` in the Database
  ///
  /// ## Examples
  /// ```no_run
  /// use crate::rapiddb::traits::IDatabase;
  ///
  /// let db = std::sync::Arc::new(
  ///   std::sync::RwLock::new(
  ///     rapiddb::db::MMAVDatabase::new()
  ///   )
  /// );
  ///
  /// db.write().unwrap().post(
  ///   "test-0",
  ///   b"{\"key\": \"value\"}"
  /// );
  /// ```
  async fn post(&mut self, id: &str, value: &[u8]);

  /// Get metadata from the sensor with `id` in the Database
  ///
  /// ## Examples
  /// ```no_run
  /// use crate::rapiddb::traits::IDatabase;
  ///
  /// let db = std::sync::Arc::new(
  ///   std::sync::RwLock::new(
  ///     rapiddb::db::MMAVDatabase::new()
  ///   )
  /// );
  ///
  /// db.write().unwrap().get_meta("test-0");
  /// ```
  async fn get_meta(&mut self, id: &str) -> Vec<u8>;

  /// Post metadata with `value` to the sensor with `id` in the Database
  ///
  /// ## Examples
  /// ```no_run
  /// use crate::rapiddb::traits::IDatabase;
  ///
  /// let db = std::sync::Arc::new(
  ///   std::sync::RwLock::new(
  ///     rapiddb::db::MMAVDatabase::new()
  ///   )
  /// );
  ///
  /// db.write().unwrap().post_meta(
  ///   "test-0",
  ///   b"{\"key\": \"value\"}".to_vec()
  /// );
  /// ```
  async fn post_meta(&mut self, id: &str, value: Vec<u8>);

  /// Get aggregates from the sensor with `id` in the Database
  ///
  /// ## Examples
  /// ```no_run
  /// use crate::rapiddb::traits::IDatabase;
  ///
  /// let db = std::sync::Arc::new(
  ///   std::sync::RwLock::new(
  ///     rapiddb::db::MMAVDatabase::new()
  ///   )
  /// );
  ///
  /// db.read().unwrap().get_aggregates("test-0");
  /// ```
  async fn get_aggregates(&self, id: &str) -> Vec<u8>;

  /// Get the latest record from the sensor with `id` in the Database
  ///
  /// ## Examples
  /// ```no_run
  /// use crate::rapiddb::traits::IDatabase;
  ///
  /// let db = std::sync::Arc::new(
  ///   std::sync::RwLock::new(
  ///     rapiddb::db::MMAVDatabase::new()
  ///   )
  /// );
  ///
  /// db.write().unwrap().get_latest("test-0");
  /// ```
  // fn get_latest(&mut self, id: &str) -> Vec<u8>;
  async fn get_latest(&mut self, id: &str) -> Vec<u8>;

  /// Get the latest `limit` number of records from the sensor with `id`
  /// in the Database
  ///
  /// May load data from disk, if it is not in-memory,
  /// as such it is mutable, even though a get latest limit normaly is
  /// immutable.
  ///
  /// ## Examples
  /// ```no_run
  /// use crate::rapiddb::traits::IDatabase;
  ///
  /// let db = std::sync::Arc::new(
  ///   std::sync::RwLock::new(
  ///     rapiddb::db::MMAVDatabase::new()
  ///   )
  /// );
  ///
  /// db.write().unwrap().get_latest_with_limit("test-0", 10);
  /// ```
  async fn get_latest_with_limit(
    &mut self,
    id: &str,
    limit: usize,
  ) -> Vec<Vec<u8>>;

  /// Get a range from `start` to `end` of records from the sensor with
  /// `id` in the Database
  ///
  /// May load data from disk, if it is not in-memory,
  /// as such it is mutable, even though a range scan normaly is
  /// immutable.
  ///
  /// ## Examples
  /// ```no_run
  /// use crate::rapiddb::traits::IDatabase;
  ///
  /// let db = std::sync::Arc::new(
  ///   std::sync::RwLock::new(
  ///     rapiddb::db::MMAVDatabase::new()
  ///   )
  /// );
  ///
  /// db.write().unwrap().get_range("test-0", 0, 10);
  /// ```
  async fn get_range(
    &mut self,
    id: &str,
    start: usize,
    end: usize,
  ) -> Vec<Vec<u8>>;

  /// Get metadata from all sensors in the Database
  ///
  /// ## Examples
  /// ```no_run
  /// use crate::rapiddb::traits::IDatabase;
  ///
  /// let db = std::sync::Arc::new(
  ///   std::sync::RwLock::new(
  ///     rapiddb::db::MMAVDatabase::new()
  ///   )
  /// );
  ///
  /// db.write().unwrap().get_all_meta();
  /// ```
  async fn get_all_meta(&mut self) -> std::collections::HashMap<&str, Vec<u8>>;

  /// Get aggregates from all sensors in the Database
  ///
  /// ## Examples
  /// ```no_run
  /// use crate::rapiddb::traits::IDatabase;
  ///
  /// let db = std::sync::Arc::new(
  ///   std::sync::RwLock::new(
  ///     rapiddb::db::MMAVDatabase::new()
  ///   )
  /// );
  ///
  /// db.read().unwrap().get_all_aggregates();
  /// ```
  async fn get_all_aggregates(
    &self,
  ) -> std::collections::HashMap<&str, Vec<u8>>;

  /// Get the latest record from all sensors in the Database
  ///
  /// ## Examples
  /// ```no_run
  /// use crate::rapiddb::traits::IDatabase;
  ///
  /// let db = std::sync::Arc::new(
  ///   std::sync::RwLock::new(
  ///     rapiddb::db::MMAVDatabase::new()
  ///   )
  /// );
  ///
  /// db.write().unwrap().get_all_latest();
  /// ```
  async fn get_all_latest(
    &mut self,
  ) -> std::collections::HashMap<&str, Vec<u8>>;

  /// Get the latest `limit` number of records from all sensors in the
  /// Database
  ///
  /// May load data from disk, if it is not in-memory,
  /// as such it is mutable, even though a get latest limit normaly is
  /// immutable.
  ///
  /// ## Examples
  /// ```no_run
  /// use crate::rapiddb::traits::IDatabase;
  ///
  /// let db = std::sync::Arc::new(
  ///   std::sync::RwLock::new(
  ///     rapiddb::db::MMAVDatabase::new()
  ///   )
  /// );
  ///
  /// db.write().unwrap().get_all_latest_with_limit(10);
  /// ```
  async fn get_all_latest_with_limit(
    &mut self,
    limit: usize,
  ) -> std::collections::HashMap<&str, Vec<Vec<u8>>>;
}