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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
use futures::{stream, stream::StreamExt};
use object_store::ObjectStore;
use parking_lot::RwLock;
use serde::de::DeserializeOwned;
use serde::{Deserialize, Serialize};
use std::collections::{BTreeMap, BTreeSet};
use std::sync::{
Arc,
atomic::{AtomicBool, Ordering},
};
use std::{
fmt::Debug,
time::{Duration, Instant},
};
use tokio_util::sync::CancellationToken;
use crate::{
collection::{Collection, CollectionConfig},
error::DBError,
schema::*,
storage::{Storage, StorageConfig, StorageStats},
unix_ms,
};
/// Main database structure that manages collections and storage.
///
/// AndaDB provides a high-level interface for creating, opening, and managing
/// collections of documents. It handles persistence through an object store
/// and maintains metadata about the database and its collections.
#[derive(Clone)]
pub struct AndaDB {
inner: Arc<InnerDB>,
}
struct InnerDB {
/// Database name
name: String,
/// Underlying object storage implementation
object_store: Arc<dyn ObjectStore>,
/// Storage layer for database operations
storage: Storage,
/// Database metadata protected by a read-write lock
metadata: RwLock<DBMetadata>,
/// Map of collection names to collection instances
collections: RwLock<BTreeMap<String, Arc<Collection>>>,
/// Flag indicating whether the database is in read-only mode
read_only: AtomicBool,
/// Set of collection names being dropped
dropping_collections: RwLock<BTreeSet<String>>,
}
/// Database configuration parameters.
///
/// Contains settings that define the database's behavior and properties.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DBConfig {
/// Database name
pub name: String,
/// Database description
pub description: String,
/// Storage configuration settings
pub storage: StorageConfig,
/// Optional opaque bytes as lock for the database
pub lock: Option<ByteBufB64>,
}
impl Default for DBConfig {
fn default() -> Self {
Self {
name: "anda_db".to_string(),
description: "Anda DB".to_string(),
storage: StorageConfig::default(),
lock: None,
}
}
}
/// Database metadata.
///
/// Contains the database configuration and a set of collection names
/// that belong to this database.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DBMetadata {
/// Database configuration
pub config: DBConfig,
/// Set of collection names in this database
pub collections: BTreeSet<String>,
/// User-defined lightweight extension data persisted with database metadata.
#[serde(default)]
pub extensions: BTreeMap<String, FieldValue>,
}
impl Debug for AndaDB {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "AndaDB({})", self.inner.name)
}
}
impl AndaDB {
/// Path where database metadata is stored
const METADATA_PATH: &'static str = "db_meta.cbor";
/// Returns aggregated storage I/O statistics across the database and all
/// currently open collections.
pub fn stats(&self) -> StorageStats {
let mut stats = self.inner.storage.stats();
for collection in self.inner.collections.read().values() {
stats.merge(&collection.storage_stats());
}
stats
}
/// Creates a new database with the given configuration.
///
/// This method initializes a new database with the specified configuration
/// and object store. It validates the database name, connects to storage,
/// and creates the initial metadata.
///
/// # Arguments
/// * `object_store` - The object store implementation to use for persistence
/// * `config` - The database configuration
///
/// # Returns
/// A Result containing either the new AndaDB instance or an error
pub async fn create(
object_store: Arc<dyn ObjectStore>,
config: DBConfig,
) -> Result<Self, DBError> {
validate_field_name(config.name.as_str())?;
let storage = Storage::connect(
config.name.clone(),
object_store.clone(),
config.storage.clone(),
)
.await?;
let metadata = DBMetadata {
config,
collections: BTreeSet::new(),
extensions: BTreeMap::new(),
};
match storage.create(Self::METADATA_PATH, &metadata).await {
Ok(_) => {
// DB created successfully, and store storage metadata
storage.store_metadata(0, unix_ms()).await?;
}
Err(err) => return Err(err),
}
Ok(Self {
inner: Arc::new(InnerDB {
name: metadata.config.name.clone(),
object_store,
storage,
metadata: RwLock::new(metadata),
collections: RwLock::new(BTreeMap::new()),
read_only: AtomicBool::new(false),
dropping_collections: RwLock::new(BTreeSet::new()),
}),
})
}
/// Connects to an existing database or creates a new one if it doesn't exist.
///
/// This method attempts to connect to an existing database with the given
/// configuration. If the database doesn't exist, it creates a new one.
///
/// # Arguments
/// * `object_store` - The object store implementation to use for persistence
/// * `config` - The database configuration
///
/// # Returns
/// A Result containing either the AndaDB instance or an error
pub async fn connect(
object_store: Arc<dyn ObjectStore>,
config: DBConfig,
) -> Result<Self, DBError> {
validate_field_name(config.name.as_str())?;
let storage = Storage::connect(
config.name.clone(),
object_store.clone(),
config.storage.clone(),
)
.await?;
match storage.fetch::<DBMetadata>(Self::METADATA_PATH).await {
Ok((metadata, _)) => {
let set_lock = match (&metadata.config.lock, config.lock) {
(None, Some(lock)) => Some(lock),
(Some(existing_lock), lock) => {
if lock.as_ref() != Some(existing_lock) {
return Err(DBError::Storage {
name: config.name.clone(),
source: "Database lock mismatch".into(),
});
}
None
}
_ => None,
};
let this = Self {
inner: Arc::new(InnerDB {
name: metadata.config.name.clone(),
object_store,
storage,
metadata: RwLock::new(metadata),
collections: RwLock::new(BTreeMap::new()),
read_only: AtomicBool::new(false),
dropping_collections: RwLock::new(BTreeSet::new()),
}),
};
if let Some(lock) = set_lock {
this.set_lock(lock).await?;
}
Ok(this)
}
Err(DBError::NotFound { .. }) => {
let metadata = DBMetadata {
config,
collections: BTreeSet::new(),
extensions: BTreeMap::new(),
};
match storage.create(Self::METADATA_PATH, &metadata).await {
Ok(_) => {
// DB created successfully, and store storage metadata
storage.store_metadata(0, unix_ms()).await?;
}
Err(err) => return Err(err),
}
Ok(Self {
inner: Arc::new(InnerDB {
name: metadata.config.name.clone(),
object_store,
storage,
metadata: RwLock::new(metadata),
collections: RwLock::new(BTreeMap::new()),
read_only: AtomicBool::new(false),
dropping_collections: RwLock::new(BTreeSet::new()),
}),
})
}
Err(err) => Err(err),
}
}
/// Connects to an existing database with the given configuration.
/// This method fails if the database doesn't exist.
pub async fn open(
object_store: Arc<dyn ObjectStore>,
config: DBConfig,
) -> Result<Self, DBError> {
validate_field_name(config.name.as_str())?;
let storage = Storage::connect(
config.name.clone(),
object_store.clone(),
config.storage.clone(),
)
.await?;
match storage.fetch::<DBMetadata>(Self::METADATA_PATH).await {
Ok((metadata, _)) => {
let set_lock = match (&metadata.config.lock, config.lock) {
(None, Some(lock)) => Some(lock),
(Some(existing_lock), lock) => {
if lock.as_ref() != Some(existing_lock) {
return Err(DBError::Storage {
name: config.name.clone(),
source: "Database lock mismatch".into(),
});
}
None
}
_ => None,
};
let this = Self {
inner: Arc::new(InnerDB {
name: metadata.config.name.clone(),
object_store,
storage,
metadata: RwLock::new(metadata),
collections: RwLock::new(BTreeMap::new()),
read_only: AtomicBool::new(false),
dropping_collections: RwLock::new(BTreeSet::new()),
}),
};
if let Some(lock) = set_lock {
this.set_lock(lock).await?;
}
Ok(this)
}
Err(err) => Err(err),
}
}
/// Returns the name of the database.
pub fn name(&self) -> &str {
&self.inner.name
}
/// Returns a clone of the database metadata.
pub fn metadata(&self) -> DBMetadata {
self.inner.metadata.read().clone()
}
/// Sets the database to read-only mode.
///
/// When in read-only mode, operations that modify the database will fail.
/// This setting is propagated to all collections in the database.
///
/// # Arguments
/// * `read_only` - Whether to enable read-only mode
pub fn set_read_only(&self, read_only: bool) {
self.inner.read_only.store(read_only, Ordering::Release);
log::warn!(
action = "AndaDB::set_read_only",
database = self.inner.name;
"Database is set to read-only: {read_only}"
);
for collection in self.inner.collections.read().values() {
collection.set_read_only(read_only);
}
}
/// Closes the database, ensuring all data is flushed to storage.
///
/// This method sets the database to read-only mode, closes all collections,
/// and flushes any pending changes to storage.
///
/// # Returns
/// A Result indicating success or an error
pub async fn close(&self) -> Result<(), DBError> {
self.set_read_only(true);
let collections = self
.inner
.collections
.read()
.values()
.cloned()
.collect::<Vec<_>>();
let results: Vec<Result<(), DBError>> = stream::iter(collections.into_iter())
.map(|collection| async move { collection.close().await })
.buffer_unordered(8) // 限制最多 8 个并发
.collect()
.await;
// Log per-collection failures but continue closing the database to flush
// metadata for the remaining successful collections, then surface the
// first error so callers can react.
let mut first_err: Option<DBError> = None;
for r in results {
if let Err(err) = r {
log::error!(
action = "AndaDB::close",
database = self.inner.name;
"Collection close failed: {err:?}",
);
if first_err.is_none() {
first_err = Some(err);
}
}
}
let start = Instant::now();
match self.flush_metadata(unix_ms()).await {
Ok(_) => {
let elapsed = start.elapsed();
log::warn!(
action = "AndaDB::close",
database = self.inner.name,
elapsed = elapsed.as_millis();
"Database closed successfully in {elapsed:?}",
);
}
Err(err) => {
let elapsed = start.elapsed();
log::error!(
action = "AndaDB::close",
database = self.inner.name,
elapsed = elapsed.as_millis();
"Failed to close database: {err:?}",
);
return Err(err);
}
}
if let Some(err) = first_err {
return Err(err);
}
Ok(())
}
/// Flushes the database, ensuring all data is written to storage.
pub async fn flush(&self) -> Result<(), DBError> {
let collections = self
.inner
.collections
.read()
.values()
.cloned()
.collect::<Vec<_>>();
let results: Vec<Result<bool, DBError>> = stream::iter(collections.into_iter())
.map(|collection| async move { collection.flush(unix_ms()).await })
.buffer_unordered(8) // 限制最多 8 个并发
.collect()
.await;
let mut first_err: Option<DBError> = None;
for r in results {
if let Err(err) = r {
log::error!(
action = "AndaDB::flush",
database = self.inner.name;
"Collection flush failed: {err:?}",
);
if first_err.is_none() {
first_err = Some(err);
}
}
}
self.flush_metadata(unix_ms()).await?;
if let Some(err) = first_err {
return Err(err);
}
Ok(())
}
/// Automatically flushes the database at regular intervals.
///
/// This method runs in a loop, waiting for the specified interval
/// before flushing the database. When the cancellation token is triggered,
/// the loop will exit and the database will be closed.
///
/// # Arguments
/// * `cancel_token` - A cancellation token to stop the loop
/// * `interval` - The time interval between flushes
///
pub async fn auto_flush(&self, cancel_token: CancellationToken, interval: Duration) {
loop {
tokio::select! {
_ = cancel_token.cancelled() => {
let _ = self.close().await;
return;
}
_ = tokio::time::sleep(interval) => {}
};
let start = Instant::now();
match self.flush().await {
Ok(_) => {
let elapsed = start.elapsed();
log::warn!(
action = "AndaDB::auto_flush",
database = self.inner.name,
elapsed = elapsed.as_millis();
"Database flushed successfully in {elapsed:?}",
);
}
Err(err) => {
let elapsed = start.elapsed();
log::error!(
action = "AndaDB::auto_flush",
database = self.inner.name,
elapsed = elapsed.as_millis();
"Failed to flush database: {err:?}",
);
}
}
}
}
/// Creates a new collection in the database.
///
/// This method creates a new collection with the given schema and configuration.
/// It also executes the provided function on the collection before finalizing creation.
///
/// # Arguments
/// * `schema` - The schema defining the structure of documents in the collection
/// * `config` - The collection configuration
/// * `f` - A function to execute on the collection during creation
///
/// # Returns
/// A Result containing either the new Collection or an error
pub async fn create_collection<F>(
&self,
schema: Schema,
config: CollectionConfig,
f: F,
) -> Result<Arc<Collection>, DBError>
where
F: AsyncFnOnce(&mut Collection) -> Result<(), DBError>,
{
if self.inner.read_only.load(Ordering::Relaxed) {
return Err(DBError::Generic {
name: self.inner.name.clone(),
source: "database is read-only".into(),
});
}
{
if self.inner.collections.read().contains_key(&config.name) {
return Err(DBError::AlreadyExists {
name: config.name,
path: self.inner.name.clone(),
source: "collection already exists".into(),
_id: 0,
});
}
}
{
if self
.inner
.dropping_collections
.read()
.contains(&config.name)
{
return Err(DBError::AlreadyExists {
name: config.name,
path: self.inner.name.clone(),
source: "collection is being dropped".to_string().into(),
_id: 0,
});
}
}
let start = Instant::now();
// self.metadata.collections will check it exists again in Collection::create
let mut collection = Collection::create(self.clone(), schema, config).await?;
f(&mut collection).await?;
let collection = Arc::new(collection);
{
let mut collections = self.inner.collections.write();
collections.insert(collection.name().to_string(), collection.clone());
self.inner
.metadata
.write()
.collections
.insert(collection.name().to_string());
}
let now = unix_ms();
collection.flush(now).await?;
self.flush_metadata(now).await?;
let elapsed = start.elapsed();
log::warn!(
action = "AndaDB::create_collection",
database = self.inner.name,
collection = collection.name(),
elapsed = elapsed.as_millis();
"Create a collection successfully in {elapsed:?}",
);
Ok(collection)
}
/// Opens an existing collection or creates a new one if it doesn't exist.
///
/// This method attempts to open an existing collection with the given name.
/// If the collection doesn't exist, it creates a new one with the provided
/// schema and configuration.
///
/// When opening an existing collection, the method compares the provided
/// schema's version with the stored schema's version. If the provided schema
/// has a higher version, the collection's schema will be upgraded automatically
/// before executing the callback `f`.
///
/// # Arguments
/// * `schema` - The schema to use for creating or upgrading the collection
/// * `config` - The collection configuration
/// * `f` - A function to execute on the collection during opening/creation
///
/// # Returns
/// A Result containing either the Collection or an error
pub async fn open_or_create_collection<F>(
&self,
schema: Schema,
config: CollectionConfig,
f: F,
) -> Result<Arc<Collection>, DBError>
where
F: AsyncFnOnce(&mut Collection) -> Result<(), DBError>,
{
if self.inner.read_only.load(Ordering::Relaxed) {
return Err(DBError::Generic {
name: self.inner.name.clone(),
source: "database is read-only".into(),
});
}
{
if let Some(collection) = self.inner.collections.read().get(&config.name) {
return Ok(collection.clone());
}
}
{
if self
.inner
.dropping_collections
.read()
.contains(&config.name)
{
return Err(DBError::AlreadyExists {
name: config.name,
path: self.inner.name.clone(),
source: "collection is being dropped".to_string().into(),
_id: 0,
});
}
}
{
if !self
.inner
.metadata
.read()
.collections
.contains(&config.name)
{
return self.create_collection(schema, config, f).await;
}
}
self.open_collection_with_schema(config.name, Some(schema), f)
.await
}
/// Opens an existing collection.
///
/// This method attempts to open an existing collection with the given name.
/// It fails if the collection doesn't exist.
///
/// # Arguments
/// * `name` - The name of the collection to open
/// * `f` - A function to execute on the collection during opening
///
/// # Returns
/// A Result containing either the Collection or an error
pub async fn open_collection<F>(&self, name: String, f: F) -> Result<Arc<Collection>, DBError>
where
F: AsyncFnOnce(&mut Collection) -> Result<(), DBError>,
{
self.open_collection_with_schema(name, None, f).await
}
/// Opens an existing collection, upgrading its schema if the provided schema
/// has a higher version than the stored one.
async fn open_collection_with_schema<F>(
&self,
name: String,
schema: Option<Schema>,
f: F,
) -> Result<Arc<Collection>, DBError>
where
F: AsyncFnOnce(&mut Collection) -> Result<(), DBError>,
{
{
if let Some(collection) = self.inner.collections.read().get(&name) {
return Ok(collection.clone());
}
}
{
if self.inner.dropping_collections.read().contains(&name) {
return Err(DBError::AlreadyExists {
name,
path: self.inner.name.clone(),
source: "collection is being dropped".to_string().into(),
_id: 0,
});
}
}
{
if !self.inner.metadata.read().collections.contains(&name) {
return Err(DBError::NotFound {
name,
path: self.inner.name.clone(),
source: "collection not found".into(),
_id: 0,
});
}
}
let collection = Collection::open(self.clone(), name, schema, f).await?;
let collection = Arc::new(collection);
{
let mut collections = self.inner.collections.write();
collections.insert(collection.name().to_string(), collection.clone());
}
let now = unix_ms();
collection.flush(now).await?;
Ok(collection)
}
pub async fn delete_collection(&self, name: &str) -> Result<(), DBError> {
if self.inner.read_only.load(Ordering::Relaxed) {
return Err(DBError::Generic {
name: self.inner.name.clone(),
source: "database is read-only".into(),
});
}
// 更新元数据并持久化
{
if !self.inner.metadata.write().collections.remove(name) {
return Ok(());
}
self.inner
.dropping_collections
.write()
.insert(name.to_string());
}
self.flush_metadata(unix_ms()).await?;
// Take any in-memory handle; if not loaded, lazily open it so we can
// safely drop on-disk data instead of orphaning storage objects.
let col = { self.inner.collections.write().remove(name) };
let drop_result = match col {
Some(col) => col.drop_data().await,
None => {
match crate::collection::Collection::open(
self.clone(),
name.to_string(),
None,
async |_| Ok(()),
)
.await
{
Ok(col) => col.drop_data().await,
// If metadata files are already gone, treat as success.
Err(DBError::NotFound { .. }) => Ok(()),
Err(err) => Err(err),
}
}
};
self.inner.dropping_collections.write().remove(name);
if let Err(err) = drop_result {
log::error!(
action = "AndaDB::delete_collection",
database = self.inner.name,
collection = name;
"Failed to drop collection data: {err:?}",
);
return Err(err);
}
Ok(())
}
async fn set_lock(&self, lock: ByteBufB64) -> Result<(), DBError> {
{
self.inner.metadata.write().config.lock = Some(lock);
}
let metadata = self.metadata();
self.inner
.storage
.put(Self::METADATA_PATH, &metadata, None)
.await?;
Ok(())
}
/// Flushes database metadata to storage.
///
/// This method writes the current database metadata to storage and
/// updates the storage metadata with the current timestamp.
///
/// # Arguments
/// * `now_ms` - The current timestamp in milliseconds
///
/// # Returns
/// A Result indicating success or an error
pub async fn flush_metadata(&self, now_ms: u64) -> Result<(), DBError> {
let metadata = self.metadata();
self.inner
.storage
.put(Self::METADATA_PATH, &metadata, None)
.await?;
self.inner.storage.store_metadata(0, now_ms).await?;
Ok(())
}
/// Gets the value of a user-defined extension key.
pub fn get_extension(&self, key: &str) -> Option<FieldValue> {
self.inner.metadata.read().extensions.get(key).cloned()
}
/// Gets the value of a user-defined extension key and deserializes it to the specified type.
pub fn get_extension_as<T>(&self, key: &str) -> Option<T>
where
T: DeserializeOwned,
{
self.get_extension(key)
.and_then(|v| v.clone().deserialized().ok())
}
/// Sets a user-defined extension key-value pair.
/// The change is persisted on the next `flush()` or `flush_metadata()`.
/// The extensions should not be large, as they are stored in the same object as database metadata which size is expected to be small (<= 1MB) and loaded frequently.
pub fn set_extension(&self, key: String, value: FieldValue) {
self.inner.metadata.write().extensions.insert(key, value);
}
/// Sets a user-defined extension key-value pair by serializing the value from a generic type.
/// The change is persisted on the next `flush()` or `flush_metadata()`.
pub fn set_extension_from<T>(&self, key: String, value: T)
where
T: Serialize,
{
if let Ok(value) = FieldValue::serialized(&value, None) {
self.set_extension(key, value);
}
}
/// Updates a user-defined extension using a functional approach.
///
/// This method retrieves the current value for the given key (if any) and computes
/// a new value using the provided function. If the function returns `None`,
/// no change is made to the extensions.
///
/// # Arguments
/// * `key` - The name of the extension key to update.
/// * `f` - An update function that takes `Option<&FieldValue>` and returns `Option<FieldValue>`.
///
/// # Returns
/// Returns the previous value `Option<FieldValue>` if a change was made.
///
/// # Notes
/// The change is persisted to storage on the next `flush()` call.
pub fn set_extension_with<F>(&self, key: String, f: F) -> Option<FieldValue>
where
F: FnOnce(Option<&FieldValue>) -> Option<FieldValue>,
{
let mut meta = self.inner.metadata.write();
let old_value = meta.extensions.get(&key);
let new_value = f(old_value);
if let Some(value) = new_value {
meta.extensions.insert(key, value)
} else {
None
}
}
/// Updates a user-defined extension by deserializing the current value, applying a function, and serializing the new value.
pub fn set_extension_from_with<F, T>(&self, key: String, f: F) -> Option<T>
where
F: FnOnce(Option<T>) -> Option<T>,
T: Serialize + DeserializeOwned,
{
let mut meta = self.inner.metadata.write();
let old_value = meta.extensions.get(&key);
let new_value = f(old_value.and_then(|v| v.clone().deserialized().ok()));
if let Some(value) = new_value
&& let Ok(value) = FieldValue::serialized(&value, None)
{
let old = meta.extensions.insert(key, value);
return old.and_then(|v| v.deserialized().ok());
}
None
}
/// Sets a user-defined extension key-value pair and immediately persists the change.
/// The extensions should not be large, as they are stored in the same object as database metadata which size is expected to be small (<= 1MB) and loaded frequently.
pub async fn save_extension(&self, key: String, value: FieldValue) -> Result<(), DBError> {
{
self.inner.metadata.write().extensions.insert(key, value);
}
self.flush_metadata(unix_ms()).await
}
/// Sets a user-defined extension key-value pair by serializing the value from a generic type and immediately persists the change.
pub async fn save_extension_from<T>(&self, key: String, value: &T) -> Result<(), DBError>
where
T: Serialize,
{
let field_value = FieldValue::serialized(value, None)?;
self.save_extension(key, field_value).await
}
/// Removes a user-defined extension key and immediately persists the change.
/// Returns the previous value if the key existed.
pub async fn remove_extension(&self, key: &str) -> Result<Option<FieldValue>, DBError> {
let old = { self.inner.metadata.write().extensions.remove(key) };
if old.is_some() {
self.flush_metadata(unix_ms()).await?;
}
Ok(old)
}
/// Provides access to the entire extensions map for advanced use cases.
pub fn extensions_with<F, R>(&self, f: F) -> R
where
F: FnOnce(&BTreeMap<String, FieldValue>) -> R,
{
f(&self.inner.metadata.read().extensions)
}
/// Returns a clone of the object store.
///
/// This method is used internally by collections to access the object store.
pub fn object_store(&self) -> Arc<dyn ObjectStore> {
self.inner.object_store.clone()
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::schema::{ByteBufB64, Fe, FieldValue, Ft, Schema};
use object_store::memory::InMemory;
#[tokio::test]
async fn test_database_creation() {
let object_store = Arc::new(InMemory::new());
let config = DBConfig::default();
let db = AndaDB::create(object_store, config).await.unwrap();
assert_eq!(db.name(), "anda_db");
assert!(db.metadata().collections.is_empty());
}
#[tokio::test]
async fn test_database_connection() {
let object_store = Arc::new(InMemory::new());
let config = DBConfig {
name: "test_db".to_string(),
description: "Test Database".to_string(),
storage: StorageConfig::default(),
lock: None,
};
// First create the database
{
let _db = AndaDB::create(object_store.clone(), config.clone())
.await
.unwrap();
}
// Then connect to it
let db = AndaDB::connect(object_store, config).await.unwrap();
assert_eq!(db.name(), "test_db");
}
#[tokio::test]
async fn test_database_open() {
let object_store = Arc::new(InMemory::new());
let config = DBConfig {
name: "test_open_db".to_string(),
description: "Test Open Database".to_string(),
storage: StorageConfig::default(),
lock: None,
};
// open 不存在的数据库应返回 NotFound
let err = AndaDB::open(object_store.clone(), config.clone())
.await
.unwrap_err();
match err {
DBError::NotFound { .. } => {}
_ => panic!("Expected NotFound when opening a non-existent database"),
}
// 创建后应可以正常 open
let _db = AndaDB::create(object_store.clone(), config.clone())
.await
.unwrap();
let db = AndaDB::open(object_store, config).await.unwrap();
assert_eq!(db.name(), "test_open_db");
}
#[tokio::test]
async fn test_database_open_lock_mismatch() {
let object_store = Arc::new(InMemory::new());
let create_config = DBConfig {
name: "test_open_lock_db".to_string(),
description: "Test Open Lock Database".to_string(),
storage: StorageConfig::default(),
lock: Some(ByteBufB64(vec![1, 2, 3])),
};
// 先创建带锁的数据库
let _db = AndaDB::create(object_store.clone(), create_config)
.await
.unwrap();
// 使用不匹配的 lock 打开应失败
let open_config = DBConfig {
name: "test_open_lock_db".to_string(),
description: "Test Open Lock Database".to_string(),
storage: StorageConfig::default(),
lock: Some(ByteBufB64(vec![9, 9, 9])),
};
let err = AndaDB::open(object_store, open_config).await.unwrap_err();
match err {
DBError::Storage { .. } => {}
_ => panic!("Expected Storage error for lock mismatch"),
}
}
#[tokio::test]
async fn test_database_open_with_matching_lock() {
let object_store = Arc::new(InMemory::new());
let lock = ByteBufB64(vec![7, 8, 9]);
let create_config = DBConfig {
name: "test_open_match_lock_db".to_string(),
description: "Test Open Match Lock Database".to_string(),
storage: StorageConfig::default(),
lock: Some(lock.clone()),
};
// 先创建带锁数据库
let _db = AndaDB::create(object_store.clone(), create_config)
.await
.unwrap();
// 使用相同 lock 打开应成功
let open_config = DBConfig {
name: "test_open_match_lock_db".to_string(),
description: "Test Open Match Lock Database".to_string(),
storage: StorageConfig::default(),
lock: Some(lock),
};
let db = AndaDB::open(object_store, open_config).await.unwrap();
assert_eq!(db.name(), "test_open_match_lock_db");
}
#[tokio::test]
async fn test_create_collection() {
let object_store = Arc::new(InMemory::new());
let config = DBConfig::default();
let db = AndaDB::create(object_store, config).await.unwrap();
let mut schema = Schema::builder();
schema
.add_field(Fe::new("name".to_string(), Ft::Text).unwrap())
.unwrap();
let schema = schema.build().unwrap();
let collection_config = CollectionConfig {
name: "test_collection".to_string(),
description: "Test Collection".to_string(),
};
let collection = db
.create_collection(schema.clone(), collection_config.clone(), async |_| Ok(()))
.await
.unwrap();
assert_eq!(collection.name(), "test_collection");
assert!(db.metadata().collections.contains("test_collection"));
}
#[tokio::test]
async fn test_open_collection() {
let object_store = Arc::new(InMemory::new());
let config = DBConfig::default();
let db = AndaDB::create(object_store, config).await.unwrap();
let mut schema = Schema::builder();
schema
.add_field(Fe::new("name".to_string(), Ft::Text).unwrap())
.unwrap();
let schema = schema.build().unwrap();
let collection_config = CollectionConfig {
name: "test_collection".to_string(),
description: "Test Collection".to_string(),
};
// Create collection first
db.create_collection(schema.clone(), collection_config.clone(), async |_| Ok(()))
.await
.unwrap();
// Then open it
let collection = db
.open_collection("test_collection".to_string(), async |_| Ok(()))
.await
.unwrap();
assert_eq!(collection.name(), "test_collection");
}
#[tokio::test]
async fn test_open_or_create_collection() {
let object_store = Arc::new(InMemory::new());
let config = DBConfig::default();
let db = AndaDB::create(object_store, config).await.unwrap();
let mut schema = Schema::builder();
schema
.add_field(Fe::new("name".to_string(), Ft::Text).unwrap())
.unwrap();
let schema = schema.build().unwrap();
let collection_config = CollectionConfig {
name: "test_collection".to_string(),
description: "Test Collection".to_string(),
};
// First call should create the collection
let collection1 = db
.open_or_create_collection(schema.clone(), collection_config.clone(), async |_| Ok(()))
.await
.unwrap();
assert_eq!(collection1.name(), "test_collection");
// Second call should open the existing collection
let collection2 = db
.open_or_create_collection(schema.clone(), collection_config.clone(), async |_| Ok(()))
.await
.unwrap();
assert_eq!(collection2.name(), "test_collection");
}
#[tokio::test]
async fn test_read_only_mode() {
let object_store = Arc::new(InMemory::new());
let config = DBConfig::default();
let db = AndaDB::create(object_store, config).await.unwrap();
let mut schema = Schema::builder();
schema
.add_field(Fe::new("name".to_string(), Ft::Text).unwrap())
.unwrap();
let schema = schema.build().unwrap();
// Create collection while DB is writable
let collection_config = CollectionConfig {
name: "test_collection".to_string(),
description: "Test Collection".to_string(),
};
let _collection = db
.create_collection(schema.clone(), collection_config.clone(), async |_| Ok(()))
.await
.unwrap();
// Set database to read-only
db.set_read_only(true);
// Attempt to create another collection should fail
let collection_config2 = CollectionConfig {
name: "test_collection2".to_string(),
description: "Test Collection 2".to_string(),
};
let result = db
.create_collection(schema, collection_config2, async |_| Ok(()))
.await;
assert!(result.is_err());
match result {
Err(DBError::Generic { .. }) => (),
_ => panic!("Expected Generic error due to read-only mode"),
}
}
#[tokio::test]
async fn test_database_close() {
let object_store = Arc::new(InMemory::new());
let config = DBConfig::default();
let db = AndaDB::create(object_store, config).await.unwrap();
let mut schema = Schema::builder();
schema
.add_field(Fe::new("name".to_string(), Ft::Text).unwrap())
.unwrap();
let schema = schema.build().unwrap();
let collection_config = CollectionConfig {
name: "test_collection".to_string(),
description: "Test Collection".to_string(),
};
db.create_collection(schema, collection_config, async |_| Ok(()))
.await
.unwrap();
// Close the database
db.close().await.unwrap();
// Database should be in read-only mode after closing
assert!(db.inner.read_only.load(Ordering::Relaxed));
}
#[tokio::test]
async fn test_delete_collection() {
let object_store = Arc::new(InMemory::new());
let config = DBConfig::default();
let db = AndaDB::create(object_store, config).await.unwrap();
// 构建 schema
let mut schema_builder = Schema::builder();
schema_builder
.add_field(Fe::new("name".to_string(), Ft::Text).unwrap())
.unwrap();
let schema = schema_builder.build().unwrap();
let collection_config = CollectionConfig {
name: "test_collection".to_string(),
description: "Test Collection".to_string(),
};
// 创建集合
db.create_collection(schema.clone(), collection_config.clone(), async |_| Ok(()))
.await
.unwrap();
assert!(db.metadata().collections.contains("test_collection"));
// 删除集合
db.delete_collection("test_collection").await.unwrap();
assert!(!db.metadata().collections.contains("test_collection"));
// 再次打开应返回 NotFound
let res = db
.open_collection("test_collection".to_string(), async |_| Ok(()))
.await;
match res {
Err(DBError::NotFound { .. }) => {}
_ => panic!("expected NotFound after delete_collection"),
}
// 可以重新创建同名集合
db.create_collection(schema, collection_config, async |_| Ok(()))
.await
.unwrap();
assert!(db.metadata().collections.contains("test_collection"));
}
#[tokio::test]
async fn test_db_extension_get_set_remove() {
let object_store = Arc::new(InMemory::new());
let config = DBConfig::default();
let db = AndaDB::create(object_store, config).await.unwrap();
// 初始状态:无扩展数据
assert!(db.get_extension("key1").is_none());
assert!(db.metadata().extensions.is_empty());
// set_extension:设置后可以 get 到
db.set_extension("key1".into(), FieldValue::Text("hello".into()));
assert_eq!(
db.get_extension("key1"),
Some(FieldValue::Text("hello".into()))
);
// 支持不同类型
db.set_extension("count".into(), FieldValue::U64(42));
db.set_extension("flag".into(), FieldValue::Bool(true));
assert_eq!(db.get_extension("count"), Some(FieldValue::U64(42)));
assert_eq!(db.get_extension("flag"), Some(FieldValue::Bool(true)));
// 覆盖已有 key
db.set_extension("key1".into(), FieldValue::I64(-1));
assert_eq!(db.get_extension("key1"), Some(FieldValue::I64(-1)));
// metadata() 中也能看到 extensions
let meta = db.metadata();
assert_eq!(meta.extensions.len(), 3);
assert_eq!(meta.extensions.get("key1"), Some(&FieldValue::I64(-1)));
// remove_extension:移除存在的 key
let old = db.remove_extension("count").await.unwrap();
assert_eq!(old, Some(FieldValue::U64(42)));
assert!(db.get_extension("count").is_none());
// remove_extension:移除不存在的 key 返回 None
let old = db.remove_extension("nonexistent").await.unwrap();
assert!(old.is_none());
db.close().await.unwrap();
}
#[tokio::test]
async fn test_db_extension_save_and_persist() {
let object_store = Arc::new(InMemory::new());
let config = DBConfig::default();
// 创建数据库并 save_extension
{
let db = AndaDB::create(object_store.clone(), config.clone())
.await
.unwrap();
db.save_extension("persist_key".into(), FieldValue::Text("persisted".into()))
.await
.unwrap();
assert_eq!(
db.get_extension("persist_key"),
Some(FieldValue::Text("persisted".into()))
);
}
// 重新 connect,验证扩展数据仍然存在
let db = AndaDB::connect(object_store, config).await.unwrap();
assert_eq!(
db.get_extension("persist_key"),
Some(FieldValue::Text("persisted".into()))
);
db.close().await.unwrap();
}
#[tokio::test]
async fn test_db_extension_flush_persist() {
let object_store = Arc::new(InMemory::new());
let config = DBConfig::default();
// 创建数据库,set_extension + flush
{
let db = AndaDB::create(object_store.clone(), config.clone())
.await
.unwrap();
db.set_extension("lazy_key".into(), FieldValue::Bytes(vec![1, 2, 3]));
db.flush().await.unwrap();
}
// 重新 connect,验证扩展数据仍然存在
let db = AndaDB::connect(object_store, config).await.unwrap();
assert_eq!(
db.get_extension("lazy_key"),
Some(FieldValue::Bytes(vec![1, 2, 3]))
);
db.close().await.unwrap();
}
#[tokio::test]
async fn test_db_set_extension_with() {
let object_store = Arc::new(InMemory::new());
let config = DBConfig::default();
let db = AndaDB::create(object_store, config).await.unwrap();
let key = "test_key".to_string();
// 1. Initial state: None
let old = db.set_extension_with(key.clone(), |val| {
assert!(val.is_none());
Some(FieldValue::U64(100))
});
assert!(old.is_none());
assert_eq!(db.get_extension(&key), Some(FieldValue::U64(100)));
// 2. Update existing value: 100 -> 200
let old = db.set_extension_with(key.clone(), |val| {
if let Some(FieldValue::U64(v)) = val {
return Some(FieldValue::U64(v + 100));
}
None
});
assert_eq!(old, Some(FieldValue::U64(100)));
assert_eq!(db.get_extension(&key), Some(FieldValue::U64(200)));
// 3. Return None: No change
let old = db.set_extension_with(key.clone(), |_| None);
assert!(old.is_none());
assert_eq!(db.get_extension(&key), Some(FieldValue::U64(200)));
db.close().await.unwrap();
}
}