1use super::*;
2use crate::storage::unified::metadata::{MetadataFilter, MetadataValue};
3
4impl RedDB {
5 pub fn is_replica_role(&self) -> bool {
6 matches!(
7 self.options.replication.role,
8 crate::replication::ReplicationRole::Replica { .. }
9 )
10 }
11
12 pub fn enforce_retention_policy(&self) -> Result<(), Box<dyn std::error::Error>> {
13 if self.options.read_only || self.is_replica_role() {
14 return Ok(());
15 }
16
17 if self.options.mode == StorageMode::Persistent {
20 let Some(path) = self.path() else {
21 return Ok(());
22 };
23
24 let Ok(mut metadata) = self.load_or_bootstrap_physical_metadata(true) else {
25 return Ok(());
26 };
27
28 self.prune_export_registry(&mut metadata.exports);
29 metadata.save_for_data_path(path)?;
30 }
31
32 let _ = self.sweep_ttl_expired_entities()?;
33
34 Ok(())
35 }
36
37 pub(crate) fn ttl_expired_entities_now(
38 &self,
39 ) -> Result<Vec<(String, EntityId)>, Box<dyn std::error::Error>> {
40 self.ttl_expired_entities_at(current_unix_ms())
41 }
42
43 pub fn replica_allows_entity_at_read(
44 &self,
45 collection: &str,
46 entity: &crate::storage::UnifiedEntity,
47 ) -> bool {
48 if !self.is_replica_role() {
49 return true;
50 }
51 !self.entity_expired_at(collection, entity, current_unix_ms())
52 }
53
54 fn sweep_ttl_expired_entities(&self) -> Result<usize, Box<dyn std::error::Error>> {
55 let to_delete = self.ttl_expired_entities_now()?;
56
57 let mut deleted = 0usize;
58 for (collection, id) in to_delete {
59 match self.store.delete(&collection, id) {
60 Ok(true) => deleted = deleted.saturating_add(1),
61 Ok(false) => {}
62 Err(err) => {
63 return Err(format!(
64 "failed deleting expired entity {id} from collection '{collection}': {err:?}"
65 )
66 .into());
67 }
68 }
69 }
70
71 Ok(deleted)
72 }
73
74 fn ttl_expired_entities_at(
75 &self,
76 now_ms: u64,
77 ) -> Result<Vec<(String, EntityId)>, Box<dyn std::error::Error>> {
78 let mut to_delete = Vec::<(String, EntityId)>::new();
79
80 let mut absolute_expired = self.expired_entities_by_expires_at(now_ms)?;
81 to_delete.append(&mut absolute_expired);
82
83 let mut relative_expired = self.expired_entities_by_ttl(now_ms)?;
84 to_delete.append(&mut relative_expired);
85
86 to_delete.sort_unstable();
87 to_delete.dedup();
88
89 Ok(to_delete)
90 }
91
92 fn entity_expired_at(
93 &self,
94 collection: &str,
95 entity: &crate::storage::UnifiedEntity,
96 now_ms: u64,
97 ) -> bool {
98 let Some(metadata) = self.store.get_metadata(collection, entity.id) else {
99 return false;
100 };
101
102 if metadata
103 .get("_expires_at")
104 .and_then(Self::metadata_u64)
105 .is_some_and(|expires_at_ms| expires_at_ms <= now_ms)
106 {
107 return true;
108 }
109
110 let ttl_ms = metadata.get("_ttl_ms").and_then(Self::metadata_u64);
111 let ttl_secs = if ttl_ms.is_none() {
112 metadata.get("_ttl").and_then(|value| {
113 Self::metadata_u64(value).and_then(|value_secs| value_secs.checked_mul(1000))
114 })
115 } else {
116 None
117 };
118
119 let Some(ttl_ms) = ttl_ms.or(ttl_secs) else {
120 return false;
121 };
122 entity
123 .created_at
124 .saturating_mul(1000)
125 .saturating_add(ttl_ms)
126 <= now_ms
127 }
128
129 fn expired_entities_by_expires_at(
130 &self,
131 now_ms: u64,
132 ) -> Result<Vec<(String, EntityId)>, Box<dyn std::error::Error>> {
133 let mut ids = self.store.filter_metadata_all(&[(
134 "_expires_at".to_string(),
135 MetadataFilter::Le(MetadataValue::Timestamp(now_ms)),
136 )]);
137
138 if let Ok(now_ms_i64) = i64::try_from(now_ms) {
139 ids.extend(self.store.filter_metadata_all(&[(
140 "_expires_at".to_string(),
141 MetadataFilter::Le(MetadataValue::Int(now_ms_i64)),
142 )]));
143 }
144
145 let now_ms_f64 = now_ms as f64;
146 if now_ms_f64.is_finite() {
147 ids.extend(self.store.filter_metadata_all(&[(
148 "_expires_at".to_string(),
149 MetadataFilter::Le(MetadataValue::Float(now_ms_f64)),
150 )]));
151 }
152
153 Ok(ids)
154 }
155
156 fn expired_entities_by_ttl(
157 &self,
158 now_ms: u64,
159 ) -> Result<Vec<(String, EntityId)>, Box<dyn std::error::Error>> {
160 let mut candidates = Vec::<(String, EntityId)>::new();
161
162 let ttl_ms_candidates = self
163 .store
164 .filter_metadata_all(&[("_ttl_ms".to_string(), MetadataFilter::IsNotNull)]);
165 candidates.extend(ttl_ms_candidates);
166
167 let ttl_candidates = self
168 .store
169 .filter_metadata_all(&[("_ttl".to_string(), MetadataFilter::IsNotNull)]);
170 candidates.extend(ttl_candidates);
171
172 if candidates.is_empty() {
173 return Ok(Vec::new());
174 }
175
176 candidates.sort_unstable();
177 candidates.dedup();
178
179 let mut expired = Vec::<(String, EntityId)>::new();
180 for (collection, entity_id) in candidates {
181 let Some(entity) = self.store.get(&collection, entity_id) else {
182 continue;
183 };
184
185 let Some(metadata) = self.store.get_metadata(&collection, entity_id) else {
186 continue;
187 };
188
189 let ttl_ms = metadata.get("_ttl_ms").and_then(Self::metadata_u64);
190 let ttl_secs = if ttl_ms.is_none() {
191 metadata.get("_ttl").and_then(|value| {
192 Self::metadata_u64(value).and_then(|value_secs| value_secs.checked_mul(1000))
193 })
194 } else {
195 None
196 };
197
198 let Some(ttl_ms) = ttl_ms.or(ttl_secs) else {
199 continue;
200 };
201
202 let created_at_ms = entity.created_at.saturating_mul(1000);
203 let expiry_ms = created_at_ms.saturating_add(ttl_ms);
204 if expiry_ms <= now_ms {
205 expired.push((collection, entity_id));
206 }
207 }
208
209 Ok(expired)
210 }
211
212 fn metadata_u64(value: &MetadataValue) -> Option<u64> {
213 match value {
214 MetadataValue::Int(v) if *v >= 0 => Some(*v as u64),
215 MetadataValue::Timestamp(v) => Some(*v),
216 MetadataValue::Float(v) => {
217 if !v.is_finite() || !v.is_sign_positive() || v.fract().abs() >= f64::EPSILON {
218 return None;
219 }
220 if *v > u64::MAX as f64 {
221 return None;
222 }
223 Some(v.trunc() as u64)
224 }
225 MetadataValue::String(v) => v.parse::<u64>().ok(),
226 _ => None,
227 }
228 }
229
230 pub fn node(&self, collection: impl Into<String>, label: impl Into<String>) -> NodeBuilder {
243 NodeBuilder::new(
244 self.store.clone(),
245 self.preprocessors.clone(),
246 collection,
247 label,
248 )
249 }
250
251 pub fn edge(&self, collection: impl Into<String>, label: impl Into<String>) -> EdgeBuilder {
263 EdgeBuilder::new(
264 self.store.clone(),
265 self.preprocessors.clone(),
266 collection,
267 label,
268 )
269 }
270
271 pub fn vector(&self, collection: impl Into<String>) -> VectorBuilder {
282 VectorBuilder::new(self.store.clone(), self.preprocessors.clone(), collection)
283 }
284
285 pub fn row(&self, table: impl Into<String>, columns: Vec<(&str, Value)>) -> RowBuilder {
296 RowBuilder::new(
297 self.store.clone(),
298 self.preprocessors.clone(),
299 table,
300 columns,
301 )
302 }
303
304 pub fn doc(&self, collection: impl Into<String>) -> DocumentBuilder {
318 DocumentBuilder::new(self.store.clone(), self.preprocessors.clone(), collection)
319 }
320
321 pub fn kv(
332 &self,
333 collection: impl Into<String>,
334 key: impl Into<String>,
335 value: Value,
336 ) -> KvBuilder {
337 KvBuilder::new(
338 self.store.clone(),
339 self.preprocessors.clone(),
340 collection,
341 key,
342 value,
343 )
344 }
345
346 pub fn get_kv(&self, collection: &str, key: &str) -> Option<(Value, EntityId)> {
350 let manager = self.store.get_collection(collection)?;
351 let entities = manager.query_all(|_| true);
352 for entity in entities {
353 if let EntityData::Row(ref row) = entity.data {
354 if let Some(ref named) = row.named {
355 if let Some(Value::Text(ref k)) = named.get("key") {
356 if &**k == key {
357 let value = named.get("value").cloned().unwrap_or(Value::Null);
358 return Some((value, entity.id));
359 }
360 }
361 }
362 }
363 }
364 None
365 }
366
367 pub fn delete_kv(
369 &self,
370 collection: &str,
371 key: &str,
372 ) -> Result<bool, super::super::error::DevXError> {
373 let Some((_, id)) = self.get_kv(collection, key) else {
374 return Ok(false);
375 };
376 self.store
377 .delete(collection, id)
378 .map_err(|err| super::super::error::DevXError::Storage(format!("{err:?}")))?;
379 Ok(true)
380 }
381
382 pub(crate) fn with_initialized_metadata(self) -> Result<Self, Box<dyn std::error::Error>> {
383 if self.options.mode == StorageMode::Persistent {
384 match self.load_or_bootstrap_physical_metadata(false) {
386 Ok(metadata) => {
387 crate::reserved_fields::validate_physical_metadata_contracts(&metadata)
388 .map_err(|err| err.to_string())?;
389 }
390 Err(error)
391 if error
392 .downcast_ref::<std::io::Error>()
393 .is_some_and(crate::physical::is_collection_contract_decode_error) =>
394 {
395 return Err(error)
396 }
397 Err(_) => {}
398 }
399 }
403 self.load_collection_ttl_defaults_from_metadata();
404 if self.options.storage_profile.deploy_profile == crate::storage::DeployProfile::Embedded
411 && self.options.storage_profile.packaging
412 == crate::storage::StoragePackaging::SingleFile
413 {
414 self.seed_contract_cache_from_store_aux()?;
415 }
416 self.load_hypertables_from_metadata();
420 Ok(self)
424 }
425
426 pub(crate) fn persist_metadata(&self) -> Result<(), Box<dyn std::error::Error>> {
427 if self.options.mode != StorageMode::Persistent || self.options.read_only {
428 return Ok(());
429 }
430 if self.options.storage_profile.deploy_profile == crate::storage::DeployProfile::Embedded
431 && self.options.storage_profile.packaging
432 == crate::storage::StoragePackaging::SingleFile
433 {
434 return Ok(());
435 }
436 let Some(path) = self.path() else {
437 return Ok(());
438 };
439
440 let previous = self.load_or_bootstrap_physical_metadata(false).ok();
441 let collection_roots = self.physical_collection_roots();
442 let indexes = self
443 .native_physical_state()
444 .map(|state| self.physical_index_state_from_native_state(&state, previous.as_ref()))
445 .unwrap_or_else(|| self.physical_index_state());
446 let mut metadata = PhysicalMetadataFile::from_state(
447 self.options.clone(),
448 self.catalog_snapshot(),
449 collection_roots,
450 indexes,
451 previous.as_ref(),
452 );
453 metadata.collection_ttl_defaults_ms = self.collection_ttl_defaults_snapshot();
454 metadata.hypertables = self.hypertable_registry_snapshot();
458 metadata.save_for_data_path(path)?;
459 self.persist_native_physical_header(&metadata)?;
460 Ok(())
461 }
462
463 fn bootstrap_metadata_from_native_state(&self) -> Result<bool, Box<dyn std::error::Error>> {
464 if self.options.mode != StorageMode::Persistent || self.options.read_only {
465 return Ok(false);
466 }
467 let Some(path) = self.path() else {
468 return Ok(false);
469 };
470 let Some(native_state) = self.native_physical_state() else {
471 return Ok(false);
472 };
473 if !Self::native_state_is_bootstrap_complete(&native_state) {
474 return Ok(false);
475 }
476
477 let previous = PhysicalMetadataFile::load_for_data_path(path).ok();
478 let metadata = self.metadata_from_native_state(&native_state, previous.as_ref());
479 metadata.save_for_data_path(path)?;
480 self.persist_native_physical_header(&metadata)?;
481 Ok(true)
482 }
483
484 pub fn rebuild_physical_metadata_from_native_state(
487 &self,
488 ) -> Result<bool, Box<dyn std::error::Error>> {
489 self.bootstrap_metadata_from_native_state()
490 }
491
492 pub(crate) fn native_state_is_bootstrap_complete(native_state: &NativePhysicalState) -> bool {
493 let registry_complete = native_state.registry.as_ref().map(|registry| {
494 registry.collections_complete
495 && registry.indexes_complete
496 && registry.graph_projections_complete
497 && registry.analytics_jobs_complete
498 && registry.vector_artifacts_complete
499 });
500 let recovery_complete = native_state
501 .recovery
502 .as_ref()
503 .map(|recovery| recovery.snapshots_complete && recovery.exports_complete);
504 let catalog_complete = native_state
505 .catalog
506 .as_ref()
507 .map(|catalog| catalog.collections_complete);
508
509 registry_complete == Some(true)
510 && recovery_complete == Some(true)
511 && catalog_complete == Some(true)
512 }
513
514 pub(crate) fn load_or_bootstrap_physical_metadata(
515 &self,
516 persist_bootstrapped: bool,
517 ) -> Result<PhysicalMetadataFile, Box<dyn std::error::Error>> {
518 if self.options.mode != StorageMode::Persistent {
519 return Err("physical metadata requires persistent mode".into());
520 }
521 let Some(path) = self.path() else {
522 return Err("database path is not available".into());
523 };
524 let native_state = self.native_physical_state();
525
526 match PhysicalMetadataFile::load_for_data_path(path) {
527 Ok(metadata) => {
528 if let Some(native_state) = native_state.as_ref() {
529 let inspection = Self::inspect_native_header_against_metadata(
530 native_state.header,
531 &metadata,
532 );
533 if Self::repair_policy_for_inspection(&inspection)
534 == NativeHeaderRepairPolicy::NativeAheadOfMetadata
535 {
536 let bootstrapped =
537 self.metadata_from_native_state(native_state, Some(&metadata));
538 if persist_bootstrapped && !self.options.read_only {
539 bootstrapped.save_for_data_path(path)?;
540 self.persist_native_physical_header(&bootstrapped)?;
541 }
542 return Ok(bootstrapped);
543 }
544 }
545 Ok(metadata)
546 }
547 Err(err) => {
548 if crate::physical::is_collection_contract_decode_error(&err) {
549 return Err(err.into());
550 }
551 let Some(native_state) = native_state else {
552 return Err(err.into());
553 };
554 let is_fresh_empty = native_state.header.sequence == 0
570 && native_state.registry.is_none()
571 && native_state.catalog.is_none()
572 && native_state.recovery.is_none();
573 if !is_fresh_empty && !Self::native_state_is_bootstrap_complete(&native_state) {
574 return Err(err.into());
575 }
576 let metadata = self.metadata_from_native_state(&native_state, None);
577 if persist_bootstrapped && !self.options.read_only {
578 metadata.save_for_data_path(path)?;
579 self.persist_native_physical_header(&metadata)?;
580 }
581 Ok(metadata)
582 }
583 }
584 }
585
586 pub(crate) fn physical_metadata_preference(&self) -> Option<&'static str> {
587 let path = self.path()?;
588 let native_state = self.native_physical_state();
589 let metadata = PhysicalMetadataFile::load_for_data_path(path).ok();
590
591 match (metadata, native_state) {
592 (Some(metadata), Some(native_state)) => {
593 let inspection =
594 Self::inspect_native_header_against_metadata(native_state.header, &metadata);
595 match Self::repair_policy_for_inspection(&inspection) {
596 NativeHeaderRepairPolicy::InSync => Some("sidecar_current"),
597 NativeHeaderRepairPolicy::RepairNativeFromMetadata => Some("sidecar_current"),
598 NativeHeaderRepairPolicy::NativeAheadOfMetadata => Some("native_ahead"),
599 }
600 }
601 (Some(_), None) => Some("sidecar_only"),
602 (None, Some(_)) => Some("sidecar_missing_native_available"),
603 (None, None) => Some("sidecar_missing_no_native"),
604 }
605 }
606
607 fn metadata_from_native_state(
608 &self,
609 native_state: &NativePhysicalState,
610 previous: Option<&PhysicalMetadataFile>,
611 ) -> PhysicalMetadataFile {
612 let now = SystemTime::now()
613 .duration_since(UNIX_EPOCH)
614 .unwrap_or_default()
615 .as_millis();
616 let catalog = self.catalog_snapshot();
617 let catalog_name = catalog.name.clone();
618 let catalog_total_entities = catalog.total_entities;
619 let catalog_total_collections = catalog.total_collections;
620 let indexes = self.physical_index_state();
621
622 let mut manifest =
623 crate::api::SchemaManifest::now(self.options.clone(), catalog.total_collections);
624 manifest.updated_at_unix_ms = now;
625
626 let manifest_events = native_state
627 .manifest
628 .as_ref()
629 .map(|summary| {
630 summary
631 .recent_events
632 .iter()
633 .map(|event| crate::physical::ManifestEvent {
634 collection: event.collection.clone(),
635 object_key: event.object_key.clone(),
636 kind: match event.kind.as_str() {
637 "insert" => crate::physical::ManifestEventKind::Insert,
638 "update" => crate::physical::ManifestEventKind::Update,
639 "remove" => crate::physical::ManifestEventKind::Remove,
640 _ => crate::physical::ManifestEventKind::Checkpoint,
641 },
642 block: crate::physical::BlockReference {
643 index: event.block_index,
644 checksum: event.block_checksum,
645 },
646 snapshot_min: event.snapshot_min,
647 snapshot_max: event.snapshot_max,
648 })
649 .collect()
650 })
651 .unwrap_or_default();
652
653 let graph_projections = native_state
654 .registry
655 .as_ref()
656 .and_then(|registry| {
657 registry.graph_projections_complete.then(|| {
658 registry
659 .graph_projections
660 .iter()
661 .map(|projection| crate::physical::PhysicalGraphProjection {
662 name: projection.name.clone(),
663 created_at_unix_ms: projection.created_at_unix_ms,
664 updated_at_unix_ms: projection.updated_at_unix_ms,
665 state: "materialized".to_string(),
666 source: projection.source.clone(),
667 node_labels: projection.node_labels.clone(),
668 node_types: projection.node_types.clone(),
669 edge_labels: projection.edge_labels.clone(),
670 last_materialized_sequence: projection.last_materialized_sequence,
671 })
672 .collect()
673 })
674 })
675 .or_else(|| previous.map(|metadata| metadata.graph_projections.clone()))
676 .unwrap_or_default();
677
678 let analytics_jobs = native_state
679 .registry
680 .as_ref()
681 .and_then(|registry| {
682 registry.analytics_jobs_complete.then(|| {
683 registry
684 .analytics_jobs
685 .iter()
686 .map(|job| crate::physical::PhysicalAnalyticsJob {
687 id: job.id.clone(),
688 kind: job.kind.clone(),
689 state: job.state.clone(),
690 projection: job.projection.clone(),
691 created_at_unix_ms: job.created_at_unix_ms,
692 updated_at_unix_ms: job.updated_at_unix_ms,
693 last_run_sequence: job.last_run_sequence,
694 metadata: job.metadata.clone(),
695 })
696 .collect()
697 })
698 })
699 .or_else(|| previous.map(|metadata| metadata.analytics_jobs.clone()))
700 .unwrap_or_default();
701
702 let exports = native_state
703 .recovery
704 .as_ref()
705 .and_then(|recovery| {
706 recovery.exports_complete.then(|| {
707 recovery
708 .exports
709 .iter()
710 .map(|export| crate::physical::ExportDescriptor {
711 name: export.name.clone(),
712 created_at_unix_ms: export.created_at_unix_ms,
713 snapshot_id: export.snapshot_id,
714 superblock_sequence: export.superblock_sequence,
715 data_path: self
716 .path()
717 .map(|path| {
718 crate::physical::PhysicalMetadataFile::export_data_path_for(
719 path,
720 &export.name,
721 )
722 .display()
723 .to_string()
724 })
725 .unwrap_or_default(),
726 metadata_path: self
727 .path()
728 .map(|path| {
729 let export_data_path =
730 crate::physical::PhysicalMetadataFile::export_data_path_for(
731 path,
732 &export.name,
733 );
734 crate::physical::PhysicalMetadataFile::metadata_path_for(
735 &export_data_path,
736 )
737 .display()
738 .to_string()
739 })
740 .unwrap_or_default(),
741 collection_count: export.collection_count as usize,
742 total_entities: export.total_entities as usize,
743 })
744 .collect()
745 })
746 })
747 .or_else(|| previous.map(|metadata| metadata.exports.clone()))
748 .unwrap_or_default();
749
750 let snapshots = native_state
751 .recovery
752 .as_ref()
753 .and_then(|recovery| {
754 recovery.snapshots_complete.then(|| {
755 recovery
756 .snapshots
757 .iter()
758 .map(|snapshot| crate::physical::SnapshotDescriptor {
759 snapshot_id: snapshot.snapshot_id,
760 created_at_unix_ms: snapshot.created_at_unix_ms,
761 superblock_sequence: snapshot.superblock_sequence,
762 collection_count: snapshot.collection_count as usize,
763 total_entities: snapshot.total_entities as usize,
764 })
765 .collect()
766 })
767 })
768 .or_else(|| previous.map(|metadata| metadata.snapshots.clone()))
769 .unwrap_or_else(|| {
770 vec![crate::physical::SnapshotDescriptor {
771 snapshot_id: native_state.header.sequence,
772 created_at_unix_ms: now,
773 superblock_sequence: native_state.header.sequence,
774 collection_count: catalog_total_collections,
775 total_entities: catalog_total_entities,
776 }]
777 });
778
779 let catalog_stats = native_state
780 .catalog
781 .as_ref()
782 .and_then(|native_catalog| {
783 native_catalog.collections_complete.then(|| {
784 native_catalog
785 .collections
786 .iter()
787 .map(|collection| {
788 (
789 collection.name.clone(),
790 crate::api::CollectionStats {
791 entities: collection.entities as usize,
792 cross_refs: collection.cross_refs as usize,
793 segments: collection.segments as usize,
794 },
795 )
796 })
797 .collect::<BTreeMap<_, _>>()
798 })
799 })
800 .or_else(|| previous.map(|metadata| metadata.catalog.stats_by_collection.clone()))
801 .unwrap_or_else(|| catalog.stats_by_collection.clone());
802
803 PhysicalMetadataFile {
804 protocol_version: crate::physical::PHYSICAL_METADATA_PROTOCOL_VERSION.to_string(),
805 generated_at_unix_ms: now,
806 last_loaded_from: Some("native_bootstrap".to_string()),
807 last_healed_at_unix_ms: Some(now),
808 manifest,
809 catalog: crate::api::CatalogSnapshot {
810 name: catalog_name,
811 total_entities: native_state
812 .catalog
813 .as_ref()
814 .map(|summary| summary.total_entities as usize)
815 .unwrap_or(catalog_total_entities),
816 total_collections: native_state
817 .catalog
818 .as_ref()
819 .map(|summary| summary.collection_count as usize)
820 .unwrap_or(catalog_total_collections),
821 stats_by_collection: catalog_stats,
822 updated_at: SystemTime::now(),
823 },
824 manifest_events,
825 collection_ttl_defaults_ms: previous
826 .map(|metadata| metadata.collection_ttl_defaults_ms.clone())
827 .unwrap_or_default(),
828 collection_contracts: previous
829 .map(|metadata| metadata.collection_contracts.clone())
830 .unwrap_or_default(),
831 hypertables: previous
832 .map(|metadata| metadata.hypertables.clone())
833 .unwrap_or_default(),
834 tree_definitions: previous
835 .map(|metadata| metadata.tree_definitions.clone())
836 .unwrap_or_default(),
837 indexes,
838 graph_projections,
839 analytics_jobs,
840 exports,
841 superblock: crate::physical::SuperblockHeader {
842 format_version: native_state.header.format_version,
843 sequence: native_state.header.sequence,
844 copies: crate::physical::DEFAULT_SUPERBLOCK_COPIES,
845 manifest: crate::physical::ManifestPointers {
846 oldest: crate::physical::BlockReference {
847 index: native_state.header.manifest_oldest_root,
848 checksum: 0,
849 },
850 newest: crate::physical::BlockReference {
851 index: native_state.header.manifest_root,
852 checksum: 0,
853 },
854 },
855 free_set: crate::physical::BlockReference {
856 index: native_state.header.free_set_root,
857 checksum: 0,
858 },
859 collection_roots: native_state.collection_roots.clone(),
860 },
861 snapshots,
862 }
863 }
864
865 pub(crate) fn reconcile_index_states_with_native_artifacts(
866 &self,
867 mut indexes: Vec<PhysicalIndexState>,
868 ) -> Vec<PhysicalIndexState> {
869 let native_artifacts = self
870 .native_physical_state()
871 .and_then(|state| state.registry)
872 .map(|registry| registry.vector_artifacts)
873 .unwrap_or_default();
874 for index in &mut indexes {
875 let Some(collection) = index.collection.as_deref() else {
876 continue;
877 };
878 let Some(artifact_kind) = Self::native_artifact_kind_for_index(index.kind) else {
879 continue;
880 };
881 let Some(artifact) = native_artifacts.iter().find(|artifact| {
882 artifact.collection == collection && artifact.artifact_kind == artifact_kind
883 }) else {
884 index.build_state = "metadata-only".to_string();
885 continue;
886 };
887 index.entries = artifact.vector_count as usize;
888 index.estimated_memory_bytes = artifact.serialized_bytes;
889 index.backend = format!("{}+native-artifact", index_backend_name(index.kind));
890 index.artifact_kind = Some(artifact.artifact_kind.clone());
891 index.artifact_checksum = Some(artifact.checksum);
892 index.build_state = "artifact-published".to_string();
893 if let Some(pages) = self.native_vector_artifact_pages() {
894 index.artifact_root_page = pages
895 .into_iter()
896 .find(|page| {
897 page.collection == artifact.collection
898 && page.artifact_kind == artifact.artifact_kind
899 })
900 .map(|page| page.root_page);
901 }
902 }
903 indexes
904 }
905
906 pub(crate) fn warmup_native_vector_artifact_for_index(
907 &self,
908 index: &PhysicalIndexState,
909 ) -> Result<(), String> {
910 let Some(collection) = index.collection.as_deref() else {
911 return Ok(());
912 };
913 let Some(artifact_kind) = Self::native_artifact_kind_for_index(index.kind) else {
914 return Ok(());
915 };
916 self.warmup_native_vector_artifact(collection, Some(artifact_kind))?;
917 Ok(())
918 }
919
920 pub(crate) fn apply_runtime_native_artifact_to_index_state(
921 &self,
922 index: &mut PhysicalIndexState,
923 ) -> Result<(), String> {
924 let Some(collection) = index.collection.as_deref() else {
925 return Ok(());
926 };
927 let Some(artifact_kind) = Self::native_artifact_kind_for_index(index.kind) else {
928 return Ok(());
929 };
930 let artifact = self.inspect_native_vector_artifact(collection, Some(artifact_kind))?;
931 index.entries = artifact
932 .graph_edge_count
933 .or(artifact.text_posting_count)
934 .unwrap_or(artifact.node_count) as usize;
935 index.estimated_memory_bytes = artifact.byte_len;
936 index.backend = format!("{}+native-artifact", index_backend_name(index.kind));
937 index.artifact_kind = Some(artifact.artifact_kind.clone());
938 index.artifact_checksum = Some(artifact.checksum);
939 index.build_state = "ready".to_string();
940 index.artifact_root_page = self
941 .native_vector_artifact_pages()
942 .and_then(|pages| {
943 pages.into_iter().find(|page| {
944 page.collection == artifact.collection
945 && page.artifact_kind == artifact.artifact_kind
946 })
947 })
948 .map(|page| page.root_page);
949 Ok(())
950 }
951
952 pub(crate) fn physical_index_state_from_native_state(
953 &self,
954 native_state: &NativePhysicalState,
955 previous: Option<&PhysicalMetadataFile>,
956 ) -> Vec<PhysicalIndexState> {
957 let mut fresh = self.physical_index_state();
958 let Some(registry) = native_state.registry.as_ref() else {
959 if let Some(previous) = previous {
960 for index in &previous.indexes {
961 if !fresh.iter().any(|candidate| candidate.name == index.name) {
962 fresh.push(index.clone());
963 }
964 }
965 }
966 return fresh;
967 };
968
969 for index in &mut fresh {
970 if let Some(native) = registry
971 .indexes
972 .iter()
973 .find(|candidate| candidate.name == index.name)
974 {
975 index.enabled = native.enabled;
976 index.last_refresh_ms = native.last_refresh_ms;
977 index.backend = native.backend.clone();
978 index.entries = native.entries as usize;
979 index.estimated_memory_bytes = native.estimated_memory_bytes;
980 if index.artifact_kind.is_none() {
981 index.artifact_kind = Self::native_artifact_kind_for_index(index.kind)
982 .map(|value| value.to_string());
983 }
984 if index.build_state == "catalog-derived" {
985 index.build_state = "registry-loaded".to_string();
986 }
987 }
988 }
989
990 for native in ®istry.indexes {
991 if fresh.iter().any(|index| index.name == native.name) {
992 continue;
993 }
994 let Some(kind) = Self::index_kind_from_str(&native.kind) else {
995 continue;
996 };
997 fresh.push(PhysicalIndexState {
998 name: native.name.clone(),
999 kind,
1000 collection: native.collection.clone(),
1001 enabled: native.enabled,
1002 entries: native.entries as usize,
1003 estimated_memory_bytes: native.estimated_memory_bytes,
1004 last_refresh_ms: native.last_refresh_ms,
1005 backend: native.backend.clone(),
1006 artifact_kind: Self::native_artifact_kind_for_index(kind)
1007 .map(|value| value.to_string()),
1008 artifact_root_page: None,
1009 artifact_checksum: None,
1010 build_state: "registry-loaded".to_string(),
1011 });
1012 }
1013
1014 if !registry.indexes_complete {
1015 if let Some(previous) = previous {
1016 for index in &previous.indexes {
1017 if !fresh.iter().any(|candidate| candidate.name == index.name) {
1018 fresh.push(index.clone());
1019 }
1020 }
1021 }
1022 }
1023
1024 fresh
1025 }
1026
1027 pub(crate) fn graph_projections_from_native_state(
1028 &self,
1029 native_state: &NativePhysicalState,
1030 ) -> Vec<PhysicalGraphProjection> {
1031 native_state
1032 .registry
1033 .as_ref()
1034 .map(|registry| {
1035 registry
1036 .graph_projections
1037 .iter()
1038 .map(|projection| PhysicalGraphProjection {
1039 name: projection.name.clone(),
1040 created_at_unix_ms: projection.created_at_unix_ms,
1041 updated_at_unix_ms: projection.updated_at_unix_ms,
1042 state: "materialized".to_string(),
1043 source: projection.source.clone(),
1044 node_labels: projection.node_labels.clone(),
1045 node_types: projection.node_types.clone(),
1046 edge_labels: projection.edge_labels.clone(),
1047 last_materialized_sequence: projection.last_materialized_sequence,
1048 })
1049 .collect()
1050 })
1051 .unwrap_or_default()
1052 }
1053
1054 pub(crate) fn analytics_jobs_from_native_state(
1055 &self,
1056 native_state: &NativePhysicalState,
1057 ) -> Vec<PhysicalAnalyticsJob> {
1058 native_state
1059 .registry
1060 .as_ref()
1061 .map(|registry| {
1062 registry
1063 .analytics_jobs
1064 .iter()
1065 .map(|job| PhysicalAnalyticsJob {
1066 id: job.id.clone(),
1067 kind: job.kind.clone(),
1068 state: job.state.clone(),
1069 projection: job.projection.clone(),
1070 created_at_unix_ms: job.created_at_unix_ms,
1071 updated_at_unix_ms: job.updated_at_unix_ms,
1072 last_run_sequence: job.last_run_sequence,
1073 metadata: job.metadata.clone(),
1074 })
1075 .collect()
1076 })
1077 .unwrap_or_default()
1078 }
1079
1080 pub(crate) fn exports_from_native_state(
1081 &self,
1082 native_state: &NativePhysicalState,
1083 ) -> Vec<ExportDescriptor> {
1084 native_state
1085 .recovery
1086 .as_ref()
1087 .map(|recovery| {
1088 recovery
1089 .exports
1090 .iter()
1091 .map(|export| ExportDescriptor {
1092 name: export.name.clone(),
1093 created_at_unix_ms: export.created_at_unix_ms,
1094 snapshot_id: export.snapshot_id,
1095 superblock_sequence: export.superblock_sequence,
1096 data_path: self
1097 .path()
1098 .map(|path| {
1099 crate::physical::PhysicalMetadataFile::export_data_path_for(
1100 path,
1101 &export.name,
1102 )
1103 .display()
1104 .to_string()
1105 })
1106 .unwrap_or_default(),
1107 metadata_path: self
1108 .path()
1109 .map(|path| {
1110 let export_data_path =
1111 crate::physical::PhysicalMetadataFile::export_data_path_for(
1112 path,
1113 &export.name,
1114 );
1115 crate::physical::PhysicalMetadataFile::metadata_path_for(
1116 &export_data_path,
1117 )
1118 .display()
1119 .to_string()
1120 })
1121 .unwrap_or_default(),
1122 collection_count: export.collection_count as usize,
1123 total_entities: export.total_entities as usize,
1124 })
1125 .collect()
1126 })
1127 .unwrap_or_default()
1128 }
1129
1130 pub(crate) fn snapshots_from_native_state(
1131 &self,
1132 native_state: &NativePhysicalState,
1133 ) -> Vec<crate::physical::SnapshotDescriptor> {
1134 let snapshots: Vec<_> = native_state
1135 .recovery
1136 .as_ref()
1137 .map(|recovery| {
1138 recovery
1139 .snapshots
1140 .iter()
1141 .map(|snapshot| crate::physical::SnapshotDescriptor {
1142 snapshot_id: snapshot.snapshot_id,
1143 created_at_unix_ms: snapshot.created_at_unix_ms,
1144 superblock_sequence: snapshot.superblock_sequence,
1145 collection_count: snapshot.collection_count as usize,
1146 total_entities: snapshot.total_entities as usize,
1147 })
1148 .collect()
1149 })
1150 .unwrap_or_default();
1151 if !snapshots.is_empty() {
1152 return snapshots;
1153 }
1154
1155 let now = SystemTime::now()
1156 .duration_since(UNIX_EPOCH)
1157 .unwrap_or_default()
1158 .as_millis();
1159 let (collection_count, total_entities) = native_state
1160 .catalog
1161 .as_ref()
1162 .map(|catalog| {
1163 (
1164 catalog.collection_count as usize,
1165 catalog.total_entities as usize,
1166 )
1167 })
1168 .unwrap_or_else(|| {
1169 let catalog = self.catalog_snapshot();
1170 (catalog.total_collections, catalog.total_entities)
1171 });
1172
1173 vec![crate::physical::SnapshotDescriptor {
1174 snapshot_id: native_state.header.sequence,
1175 created_at_unix_ms: now,
1176 superblock_sequence: native_state.header.sequence,
1177 collection_count,
1178 total_entities,
1179 }]
1180 }
1181
1182 fn index_kind_from_str(value: &str) -> Option<crate::index::IndexKind> {
1183 match value {
1184 "btree" => Some(crate::index::IndexKind::BTree),
1185 "vector.hnsw" => Some(crate::index::IndexKind::VectorHnsw),
1186 "vector.inverted" => Some(crate::index::IndexKind::VectorInverted),
1187 "vector.turbo" => Some(crate::index::IndexKind::VectorTurbo),
1188 "graph.adjacency" => Some(crate::index::IndexKind::GraphAdjacency),
1189 "text.fulltext" => Some(crate::index::IndexKind::FullText),
1190 "document.pathvalue" => Some(crate::index::IndexKind::DocumentPathValue),
1191 "search.hybrid" => Some(crate::index::IndexKind::HybridSearch),
1192 _ => None,
1193 }
1194 }
1195
1196 pub(crate) fn native_artifact_kind_for_index(kind: IndexKind) -> Option<&'static str> {
1197 match kind {
1198 IndexKind::VectorHnsw => Some("hnsw"),
1199 IndexKind::VectorInverted => Some("ivf"),
1200 IndexKind::VectorTurbo => Some("turboquant"),
1201 IndexKind::GraphAdjacency => Some("graph.adjacency"),
1202 IndexKind::FullText => Some("text.fulltext"),
1203 IndexKind::DocumentPathValue => Some("document.pathvalue"),
1204 _ => None,
1205 }
1206 }
1207
1208 fn index_is_declared(&self, name: &str) -> bool {
1209 self.physical_metadata()
1210 .map(|metadata| metadata.indexes.iter().any(|index| index.name == name))
1211 .unwrap_or(false)
1212 }
1213
1214 pub(crate) fn graph_projection_is_declared(&self, name: &str) -> bool {
1215 self.physical_metadata()
1216 .map(|metadata| {
1217 metadata
1218 .graph_projections
1219 .iter()
1220 .any(|projection| projection.name == name)
1221 })
1222 .unwrap_or(false)
1223 }
1224
1225 pub(crate) fn graph_projection_is_operational(&self, name: &str) -> bool {
1226 self.operational_graph_projections()
1227 .into_iter()
1228 .any(|projection| projection.name == name && projection.state == "materialized")
1229 }
1230
1231 pub(crate) fn analytics_job_id(kind: &str, projection: Option<&str>) -> String {
1232 match projection {
1233 Some(projection) => format!("{kind}::{projection}"),
1234 None => format!("{kind}::global"),
1235 }
1236 }
1237
1238 pub(crate) fn update_physical_metadata<T, F>(
1239 &self,
1240 mutator: F,
1241 ) -> Result<T, Box<dyn std::error::Error>>
1242 where
1243 F: FnOnce(&mut PhysicalMetadataFile) -> T,
1244 {
1245 if self.options.mode != StorageMode::Persistent {
1246 return Err("physical metadata operations require persistent mode".into());
1247 }
1248 if self.options.read_only {
1249 return Err("physical metadata operations are not allowed in read-only mode".into());
1250 }
1251 let Some(path) = self.path() else {
1252 return Err("database path is not available".into());
1253 };
1254
1255 let mut metadata = self.load_or_bootstrap_physical_metadata(true)?;
1256
1257 if metadata.indexes.is_empty() {
1258 metadata.indexes = self.physical_index_state();
1259 }
1260 metadata.superblock.collection_roots = self.physical_collection_roots();
1261
1262 let result = mutator(&mut metadata);
1263 metadata.save_for_data_path(path)?;
1264 self.persist_native_physical_header(&metadata)?;
1265 Ok(result)
1266 }
1267
1268 pub(crate) fn persist_native_physical_header(
1269 &self,
1270 metadata: &PhysicalMetadataFile,
1271 ) -> Result<(), Box<dyn std::error::Error>> {
1272 if !self.paged_mode {
1273 return Ok(());
1274 }
1275
1276 let existing_page = self
1277 .store
1278 .physical_file_header()
1279 .map(|header| header.collection_roots_page)
1280 .filter(|page| *page != 0);
1281 let existing_registry_page = self
1282 .store
1283 .physical_file_header()
1284 .map(|header| header.registry_page)
1285 .filter(|page| *page != 0);
1286 let existing_recovery_page = self
1287 .store
1288 .physical_file_header()
1289 .map(|header| header.recovery_page)
1290 .filter(|page| *page != 0);
1291 let existing_catalog_page = self
1292 .store
1293 .physical_file_header()
1294 .map(|header| header.catalog_page)
1295 .filter(|page| *page != 0);
1296 let existing_metadata_state_page = self
1297 .store
1298 .physical_file_header()
1299 .map(|header| header.metadata_state_page)
1300 .filter(|page| *page != 0);
1301 let existing_vector_artifact_page = self
1302 .store
1303 .physical_file_header()
1304 .map(|header| header.vector_artifact_page)
1305 .filter(|page| *page != 0);
1306 let existing_manifest_page = self
1307 .store
1308 .physical_file_header()
1309 .map(|header| header.manifest_page)
1310 .filter(|page| *page != 0);
1311 let (manifest_page, manifest_checksum) = self.store.write_native_manifest_summary(
1312 metadata.superblock.sequence,
1313 &metadata.manifest_events,
1314 existing_manifest_page,
1315 )?;
1316 let (collection_roots_page, collection_roots_checksum) = self
1317 .store
1318 .write_native_collection_roots(&metadata.superblock.collection_roots, existing_page)?;
1319 let registry_summary = self.native_registry_summary_from_metadata(metadata);
1320 let (registry_page, registry_checksum) = self
1321 .store
1322 .write_native_registry_summary(®istry_summary, existing_registry_page)?;
1323 let recovery_summary = Self::native_recovery_summary_from_metadata(metadata);
1324 let (recovery_page, recovery_checksum) = self
1325 .store
1326 .write_native_recovery_summary(&recovery_summary, existing_recovery_page)?;
1327 let catalog_summary = Self::native_catalog_summary_from_metadata(metadata);
1328 let (catalog_page, catalog_checksum) = self
1329 .store
1330 .write_native_catalog_summary(&catalog_summary, existing_catalog_page)?;
1331 let metadata_state_summary = Self::native_metadata_state_summary_from_metadata(metadata);
1332 let (metadata_state_page, metadata_state_checksum) =
1333 self.store.write_native_metadata_state_summary(
1334 &metadata_state_summary,
1335 existing_metadata_state_page,
1336 )?;
1337 let vector_artifact_records = self.native_vector_artifact_records();
1338 let vector_artifact_payloads = vector_artifact_records
1339 .iter()
1340 .map(|(summary, bytes)| {
1341 (
1342 summary.collection.clone(),
1343 summary.artifact_kind.clone(),
1344 bytes.clone(),
1345 )
1346 })
1347 .collect::<Vec<_>>();
1348 let (vector_artifact_page, vector_artifact_checksum, _vector_artifact_pages) =
1349 self.store.write_native_vector_artifact_store(
1350 &vector_artifact_payloads,
1351 existing_vector_artifact_page,
1352 )?;
1353 let mut header = Self::native_header_from_metadata(metadata);
1354 header.manifest_page = manifest_page;
1355 header.manifest_checksum = manifest_checksum;
1356 header.collection_roots_page = collection_roots_page;
1357 header.collection_roots_checksum = collection_roots_checksum;
1358 header.registry_page = registry_page;
1359 header.registry_checksum = registry_checksum;
1360 header.recovery_page = recovery_page;
1361 header.recovery_checksum = recovery_checksum;
1362 header.catalog_page = catalog_page;
1363 header.catalog_checksum = catalog_checksum;
1364 header.metadata_state_page = metadata_state_page;
1365 header.metadata_state_checksum = metadata_state_checksum;
1366 header.vector_artifact_page = vector_artifact_page;
1367 header.vector_artifact_checksum = vector_artifact_checksum;
1368 self.store.update_physical_file_header(header)?;
1369 self.store.persist()?;
1370 Ok(())
1371 }
1372
1373 pub(crate) fn native_header_from_metadata(
1374 metadata: &PhysicalMetadataFile,
1375 ) -> PhysicalFileHeader {
1376 PhysicalFileHeader {
1377 format_version: metadata.superblock.format_version,
1378 sequence: metadata.superblock.sequence,
1379 manifest_oldest_root: metadata.superblock.manifest.oldest.index,
1380 manifest_root: metadata.superblock.manifest.newest.index,
1381 free_set_root: metadata.superblock.free_set.index,
1382 manifest_page: 0,
1383 manifest_checksum: 0,
1384 collection_roots_page: 0,
1385 collection_roots_checksum: 0,
1386 collection_root_count: metadata.superblock.collection_roots.len() as u32,
1387 snapshot_count: metadata.snapshots.len() as u32,
1388 index_count: metadata.indexes.len() as u32,
1389 catalog_collection_count: metadata.catalog.total_collections as u32,
1390 catalog_total_entities: metadata.catalog.total_entities as u64,
1391 export_count: metadata.exports.len() as u32,
1392 graph_projection_count: metadata.graph_projections.len() as u32,
1393 analytics_job_count: metadata.analytics_jobs.len() as u32,
1394 manifest_event_count: metadata.manifest_events.len() as u32,
1395 registry_page: 0,
1396 registry_checksum: 0,
1397 recovery_page: 0,
1398 recovery_checksum: 0,
1399 catalog_page: 0,
1400 catalog_checksum: 0,
1401 metadata_state_page: 0,
1402 metadata_state_checksum: 0,
1403 vector_artifact_page: 0,
1404 vector_artifact_checksum: 0,
1405 }
1406 }
1407}
1408
1409fn current_unix_ms() -> u64 {
1410 SystemTime::now()
1411 .duration_since(UNIX_EPOCH)
1412 .unwrap_or_default()
1413 .as_millis()
1414 .min(u128::from(u64::MAX)) as u64
1415}