Skip to main content

reddb_server/runtime/
impl_physical.rs

1use super::*;
2
3#[derive(Debug, Clone)]
4struct MetricsRetentionRollupPolicy {
5    target: String,
6    aggregation: String,
7    bucket_ns: u64,
8}
9
10#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
11struct MetricsRollupKey {
12    metric: String,
13    bucket_ns: u64,
14    tags: Vec<(String, String)>,
15}
16
17#[derive(Debug, Clone)]
18struct MetricsRollupAccumulator {
19    count: u64,
20    sum: f64,
21    min: f64,
22    max: f64,
23}
24
25impl MetricsRollupAccumulator {
26    fn new(value: f64) -> Self {
27        Self {
28            count: 1,
29            sum: value,
30            min: value,
31            max: value,
32        }
33    }
34
35    fn push(&mut self, value: f64) {
36        self.count = self.count.saturating_add(1);
37        self.sum += value;
38        self.min = self.min.min(value);
39        self.max = self.max.max(value);
40    }
41
42    fn value(&self, aggregation: &str) -> f64 {
43        match aggregation {
44            "sum" => self.sum,
45            "min" => self.min,
46            "max" => self.max,
47            "count" => self.count as f64,
48            _ => self.sum / self.count.max(1) as f64,
49        }
50    }
51}
52
53fn metrics_rollup_policies_for_retention(
54    contract: &crate::physical::CollectionContract,
55) -> Vec<MetricsRetentionRollupPolicy> {
56    contract
57        .metrics_rollup_policies
58        .iter()
59        .filter_map(|spec| {
60            let parsed = crate::storage::timeseries::retention::DownsamplePolicy::parse(spec)?;
61            if parsed.source != "raw"
62                || !matches!(
63                    parsed.aggregation.as_str(),
64                    "avg" | "sum" | "min" | "max" | "count"
65                )
66            {
67                return None;
68            }
69            Some(MetricsRetentionRollupPolicy {
70                target: parsed.target,
71                aggregation: parsed.aggregation,
72                bucket_ns: parsed.bucket_ns,
73            })
74        })
75        .collect()
76}
77
78fn metrics_rollup_collection_for_retention(raw_collection: &str, target: &str) -> String {
79    let sanitized = target
80        .chars()
81        .map(|ch| {
82            if ch.is_ascii_alphanumeric() || ch == '_' {
83                ch
84            } else {
85                '_'
86            }
87        })
88        .collect::<String>();
89    format!("red_metrics_rollup_{raw_collection}_{sanitized}")
90}
91
92impl RedDBRuntime {
93    pub fn create_export(&self, name: impl Into<String>) -> RedDBResult<ExportDescriptor> {
94        self.inner
95            .db
96            .create_named_export(name)
97            .map_err(|err| RedDBError::Internal(err.to_string()))
98    }
99
100    pub fn graph_projections(&self) -> RedDBResult<Vec<PhysicalGraphProjection>> {
101        Ok(self.inner.db.declared_graph_projections())
102    }
103
104    pub fn operational_graph_projections(&self) -> Vec<PhysicalGraphProjection> {
105        self.inner.db.operational_graph_projections()
106    }
107
108    pub fn graph_projection_named(&self, name: &str) -> RedDBResult<RuntimeGraphProjection> {
109        let status = self
110            .graph_projection_statuses()
111            .into_iter()
112            .find(|status| status.name == name)
113            .ok_or_else(|| RedDBError::NotFound(name.to_string()))?;
114        if !status.declared {
115            return Err(RedDBError::Catalog(format!(
116                "graph projection '{name}' is not declared"
117            )));
118        }
119        if !status.operational {
120            return Err(RedDBError::Catalog(format!(
121                "graph projection '{name}' is declared but not operationally materialized"
122            )));
123        }
124        if status.lifecycle_state == "stale" {
125            return Err(RedDBError::Catalog(format!(
126                "graph projection '{name}' is stale and must be rematerialized before use"
127            )));
128        }
129        let projection = self
130            .operational_graph_projections()
131            .into_iter()
132            .find(|projection| projection.name == name)
133            .ok_or_else(|| RedDBError::NotFound(name.to_string()))?;
134        Ok(RuntimeGraphProjection {
135            node_labels: (!projection.node_labels.is_empty()).then_some(projection.node_labels),
136            node_types: (!projection.node_types.is_empty()).then_some(projection.node_types),
137            edge_labels: (!projection.edge_labels.is_empty()).then_some(projection.edge_labels),
138        })
139    }
140
141    pub fn save_graph_projection(
142        &self,
143        name: impl Into<String>,
144        projection: RuntimeGraphProjection,
145        source: Option<String>,
146    ) -> RedDBResult<PhysicalGraphProjection> {
147        self.inner
148            .db
149            .save_graph_projection(
150                name,
151                projection.node_labels.unwrap_or_default(),
152                projection.node_types.unwrap_or_default(),
153                projection.edge_labels.unwrap_or_default(),
154                source.unwrap_or_else(|| "runtime".to_string()),
155            )
156            .map_err(|err| RedDBError::Internal(err.to_string()))
157    }
158
159    pub fn materialize_graph_projection(&self, name: &str) -> RedDBResult<PhysicalGraphProjection> {
160        self.inner
161            .db
162            .materialize_graph_projection(name)
163            .map_err(|err| RedDBError::Internal(err.to_string()))?
164            .ok_or_else(|| RedDBError::NotFound(name.to_string()))
165    }
166
167    pub fn mark_graph_projection_materializing(
168        &self,
169        name: &str,
170    ) -> RedDBResult<PhysicalGraphProjection> {
171        self.inner
172            .db
173            .mark_graph_projection_materializing(name)
174            .map_err(|err| RedDBError::Internal(err.to_string()))?
175            .ok_or_else(|| RedDBError::NotFound(name.to_string()))
176    }
177
178    pub fn fail_graph_projection(&self, name: &str) -> RedDBResult<PhysicalGraphProjection> {
179        self.inner
180            .db
181            .fail_graph_projection(name)
182            .map_err(|err| RedDBError::Internal(err.to_string()))?
183            .ok_or_else(|| RedDBError::NotFound(name.to_string()))
184    }
185
186    pub fn mark_graph_projection_stale(&self, name: &str) -> RedDBResult<PhysicalGraphProjection> {
187        self.inner
188            .db
189            .mark_graph_projection_stale(name)
190            .map_err(|err| RedDBError::Internal(err.to_string()))?
191            .ok_or_else(|| RedDBError::NotFound(name.to_string()))
192    }
193
194    pub fn analytics_jobs(&self) -> RedDBResult<Vec<PhysicalAnalyticsJob>> {
195        Ok(self.inner.db.declared_analytics_jobs())
196    }
197
198    pub fn operational_analytics_jobs(&self) -> Vec<PhysicalAnalyticsJob> {
199        self.inner.db.operational_analytics_jobs()
200    }
201
202    pub fn save_analytics_job(
203        &self,
204        kind: impl Into<String>,
205        projection_name: Option<String>,
206        metadata: std::collections::BTreeMap<String, String>,
207    ) -> RedDBResult<PhysicalAnalyticsJob> {
208        self.inner
209            .db
210            .save_analytics_job(kind, projection_name, metadata)
211            .map_err(|err| RedDBError::Internal(err.to_string()))
212    }
213
214    pub fn start_analytics_job(
215        &self,
216        kind: impl Into<String>,
217        projection_name: Option<String>,
218        metadata: std::collections::BTreeMap<String, String>,
219    ) -> RedDBResult<PhysicalAnalyticsJob> {
220        if let Some(projection_name) = projection_name.as_deref() {
221            let status = self
222                .graph_projection_statuses()
223                .into_iter()
224                .find(|status| status.name == projection_name)
225                .ok_or_else(|| RedDBError::NotFound(projection_name.to_string()))?;
226            if !status.declared {
227                return Err(RedDBError::Catalog(format!(
228                    "graph projection '{projection_name}' is not declared"
229                )));
230            }
231            if !status.operational {
232                return Err(RedDBError::Catalog(format!(
233                    "graph projection '{projection_name}' is declared but not operationally materialized"
234                )));
235            }
236            if status.lifecycle_state == "stale" {
237                return Err(RedDBError::Catalog(format!(
238                    "graph projection '{projection_name}' is stale and must be rematerialized before analytics jobs can start against it"
239                )));
240            }
241        }
242        self.inner
243            .db
244            .start_analytics_job(kind, projection_name, metadata)
245            .map_err(|err| RedDBError::Internal(err.to_string()))
246    }
247
248    pub fn queue_analytics_job(
249        &self,
250        kind: impl Into<String>,
251        projection_name: Option<String>,
252        metadata: std::collections::BTreeMap<String, String>,
253    ) -> RedDBResult<PhysicalAnalyticsJob> {
254        if let Some(projection_name) = projection_name.as_deref() {
255            let status = self
256                .graph_projection_statuses()
257                .into_iter()
258                .find(|status| status.name == projection_name)
259                .ok_or_else(|| RedDBError::NotFound(projection_name.to_string()))?;
260            if !status.declared {
261                return Err(RedDBError::Catalog(format!(
262                    "graph projection '{projection_name}' is not declared"
263                )));
264            }
265            if !status.operational {
266                return Err(RedDBError::Catalog(format!(
267                    "graph projection '{projection_name}' is declared but not operationally materialized"
268                )));
269            }
270            if status.lifecycle_state == "stale" {
271                return Err(RedDBError::Catalog(format!(
272                    "graph projection '{projection_name}' is stale and must be rematerialized before analytics jobs can be queued against it"
273                )));
274            }
275        }
276        self.inner
277            .db
278            .queue_analytics_job(kind, projection_name, metadata)
279            .map_err(|err| RedDBError::Internal(err.to_string()))
280    }
281
282    pub fn fail_analytics_job(
283        &self,
284        kind: impl Into<String>,
285        projection_name: Option<String>,
286        metadata: std::collections::BTreeMap<String, String>,
287    ) -> RedDBResult<PhysicalAnalyticsJob> {
288        self.inner
289            .db
290            .fail_analytics_job(kind, projection_name, metadata)
291            .map_err(|err| RedDBError::Internal(err.to_string()))
292    }
293
294    pub fn mark_analytics_job_stale(
295        &self,
296        kind: impl Into<String>,
297        projection_name: Option<String>,
298        metadata: std::collections::BTreeMap<String, String>,
299    ) -> RedDBResult<PhysicalAnalyticsJob> {
300        self.inner
301            .db
302            .mark_analytics_job_stale(kind, projection_name, metadata)
303            .map_err(|err| RedDBError::Internal(err.to_string()))
304    }
305
306    pub fn complete_analytics_job(
307        &self,
308        kind: impl Into<String>,
309        projection_name: Option<String>,
310        metadata: std::collections::BTreeMap<String, String>,
311    ) -> RedDBResult<PhysicalAnalyticsJob> {
312        self.inner
313            .db
314            .record_analytics_job(kind, projection_name, metadata)
315            .map_err(|err| RedDBError::Internal(err.to_string()))
316    }
317
318    pub fn record_analytics_job(
319        &self,
320        kind: impl Into<String>,
321        projection_name: Option<String>,
322        metadata: std::collections::BTreeMap<String, String>,
323    ) -> RedDBResult<PhysicalAnalyticsJob> {
324        if let Some(projection_name) = projection_name.as_deref() {
325            let status = self
326                .graph_projection_statuses()
327                .into_iter()
328                .find(|status| status.name == projection_name)
329                .ok_or_else(|| RedDBError::NotFound(projection_name.to_string()))?;
330            if !status.declared {
331                return Err(RedDBError::Catalog(format!(
332                    "graph projection '{projection_name}' is not declared"
333                )));
334            }
335            if !status.operational {
336                return Err(RedDBError::Catalog(format!(
337                    "graph projection '{projection_name}' is declared but not operationally materialized"
338                )));
339            }
340            if status.lifecycle_state == "stale" {
341                return Err(RedDBError::Catalog(format!(
342                    "graph projection '{projection_name}' is stale and must be rematerialized before analytics jobs can complete against it"
343                )));
344            }
345        }
346        self.inner
347            .db
348            .record_analytics_job(kind, projection_name, metadata)
349            .map_err(|err| RedDBError::Internal(err.to_string()))
350    }
351
352    pub fn resolve_graph_projection(
353        &self,
354        projection_name: Option<&str>,
355        inline: Option<RuntimeGraphProjection>,
356    ) -> RedDBResult<Option<RuntimeGraphProjection>> {
357        let named = match projection_name {
358            Some(name) => Some(self.graph_projection_named(name)?),
359            None => None,
360        };
361        Ok(merge_runtime_projection(named, inline))
362    }
363
364    pub fn apply_retention_policy(&self) -> RedDBResult<()> {
365        self.check_write(crate::runtime::write_gate::WriteKind::Maintenance)?;
366        self.sweep_retention_tick(usize::MAX);
367        let expired = self
368            .inner
369            .db
370            .ttl_expired_entities_now()
371            .map_err(|err| RedDBError::Internal(err.to_string()))?;
372        let store = self.inner.db.store();
373        for (collection, id) in expired {
374            let deleted = store
375                .delete(&collection, id)
376                .map_err(|err| RedDBError::Internal(err.to_string()))?;
377            if deleted {
378                store.context_index().remove_entity(id);
379                self.cdc_emit(
380                    crate::replication::cdc::ChangeOperation::Delete,
381                    &collection,
382                    id.raw(),
383                    "entity",
384                );
385            }
386        }
387        self.inner
388            .db
389            .enforce_retention_policy()
390            .map_err(|err| RedDBError::Internal(err.to_string()))?;
391        self.enforce_metrics_raw_retention()?;
392        self.invalidate_result_cache();
393        Ok(())
394    }
395
396    fn enforce_metrics_raw_retention(&self) -> RedDBResult<()> {
397        let now_ns = std::time::SystemTime::now()
398            .duration_since(std::time::UNIX_EPOCH)
399            .unwrap_or_default()
400            .as_nanos()
401            .min(u128::from(u64::MAX)) as u64;
402        let store = self.inner.db.store();
403
404        for contract in self
405            .inner
406            .db
407            .collection_contracts()
408            .into_iter()
409            .filter(|contract| contract.declared_model == crate::catalog::CollectionModel::Metrics)
410        {
411            let Some(raw_retention_ms) = contract.metrics_raw_retention_ms else {
412                continue;
413            };
414            let cutoff_ns = now_ns.saturating_sub(raw_retention_ms.saturating_mul(1_000_000));
415            let Some(manager) = store.get_collection(&contract.name) else {
416                continue;
417            };
418            let expired = manager.query_all(|entity| match &entity.data {
419                crate::storage::EntityData::TimeSeries(point) => point.timestamp_ns < cutoff_ns,
420                _ => false,
421            });
422            self.materialize_metrics_rollups_for_retention(&contract, &expired)?;
423            for entity in expired {
424                let deleted = store
425                    .delete(&contract.name, entity.id)
426                    .map_err(|err| RedDBError::Internal(err.to_string()))?;
427                if deleted {
428                    store.context_index().remove_entity(entity.id);
429                    self.cdc_emit(
430                        crate::replication::cdc::ChangeOperation::Delete,
431                        &contract.name,
432                        entity.id.raw(),
433                        "entity",
434                    );
435                }
436            }
437        }
438
439        Ok(())
440    }
441
442    fn materialize_metrics_rollups_for_retention(
443        &self,
444        contract: &crate::physical::CollectionContract,
445        raw_points: &[crate::storage::UnifiedEntity],
446    ) -> RedDBResult<()> {
447        if raw_points.is_empty() {
448            return Ok(());
449        }
450        let policies = metrics_rollup_policies_for_retention(contract);
451        if policies.is_empty() {
452            return Ok(());
453        }
454
455        let store = self.inner.db.store();
456        for policy in policies {
457            let rollup_collection =
458                metrics_rollup_collection_for_retention(&contract.name, &policy.target);
459            if store.get_collection(&rollup_collection).is_none() {
460                store
461                    .create_collection(&rollup_collection)
462                    .map_err(|err| RedDBError::Internal(err.to_string()))?;
463            }
464
465            let mut buckets = BTreeMap::<MetricsRollupKey, MetricsRollupAccumulator>::new();
466            for entity in raw_points {
467                let crate::storage::EntityData::TimeSeries(point) = &entity.data else {
468                    continue;
469                };
470                let bucket_ns = (point.timestamp_ns / policy.bucket_ns) * policy.bucket_ns;
471                let mut tags = point
472                    .tags
473                    .iter()
474                    .map(|(name, value)| (name.clone(), value.clone()))
475                    .collect::<Vec<_>>();
476                tags.sort();
477                let key = MetricsRollupKey {
478                    metric: point.metric.clone(),
479                    bucket_ns,
480                    tags,
481                };
482                buckets
483                    .entry(key)
484                    .and_modify(|acc| acc.push(point.value))
485                    .or_insert_with(|| MetricsRollupAccumulator::new(point.value));
486            }
487
488            for (key, accumulator) in buckets {
489                let tags = key.tags.into_iter().collect::<HashMap<_, _>>();
490                if let Some(manager) = store.get_collection(&rollup_collection) {
491                    for entity in manager.query_all(|entity| match &entity.data {
492                        crate::storage::EntityData::TimeSeries(point) => {
493                            point.metric == key.metric
494                                && point.timestamp_ns == key.bucket_ns
495                                && point.tags == tags
496                        }
497                        _ => false,
498                    }) {
499                        store
500                            .delete(&rollup_collection, entity.id)
501                            .map_err(|err| RedDBError::Internal(err.to_string()))?;
502                    }
503                }
504
505                let entity = crate::storage::UnifiedEntity::new(
506                    crate::storage::EntityId::new(0),
507                    crate::storage::EntityKind::TimeSeriesPoint(Box::new(
508                        crate::storage::TimeSeriesPointKind {
509                            series: rollup_collection.clone(),
510                            metric: key.metric.clone(),
511                        },
512                    )),
513                    crate::storage::EntityData::TimeSeries(crate::storage::TimeSeriesData {
514                        metric: key.metric,
515                        timestamp_ns: key.bucket_ns,
516                        value: accumulator.value(&policy.aggregation),
517                        tags,
518                        // Rollup outputs keep tags inline; they do not intern
519                        // through the series dictionary.
520                        series_id: None,
521                        fields: std::collections::HashMap::new(),
522                    }),
523                );
524                store
525                    .insert_auto(&rollup_collection, entity)
526                    .map_err(|err| RedDBError::Internal(err.to_string()))?;
527            }
528        }
529
530        Ok(())
531    }
532
533    pub fn indexes(&self) -> Vec<crate::PhysicalIndexState> {
534        self.inner.db.operational_indexes()
535    }
536
537    pub fn declared_indexes(&self) -> Vec<crate::PhysicalIndexState> {
538        self.inner.db.declared_indexes()
539    }
540
541    pub fn declared_indexes_for_collection(
542        &self,
543        collection: &str,
544    ) -> Vec<crate::PhysicalIndexState> {
545        self.inner
546            .db
547            .declared_indexes()
548            .into_iter()
549            .filter(|index| index.collection.as_deref() == Some(collection))
550            .collect()
551    }
552
553    pub fn index_statuses(&self) -> Vec<crate::catalog::CatalogIndexStatus> {
554        self.inner.db.index_statuses()
555    }
556
557    pub fn graph_projection_statuses(&self) -> Vec<crate::catalog::CatalogGraphProjectionStatus> {
558        self.inner
559            .db
560            .catalog_model_snapshot()
561            .graph_projection_statuses
562    }
563
564    pub fn analytics_job_statuses(&self) -> Vec<crate::catalog::CatalogAnalyticsJobStatus> {
565        self.inner
566            .db
567            .catalog_model_snapshot()
568            .analytics_job_statuses
569    }
570
571    pub fn indexes_for_collection(&self, collection: &str) -> Vec<crate::PhysicalIndexState> {
572        self.inner
573            .db
574            .operational_indexes()
575            .into_iter()
576            .filter(|index| index.collection.as_deref() == Some(collection))
577            .collect()
578    }
579
580    pub fn set_index_enabled(
581        &self,
582        name: &str,
583        enabled: bool,
584    ) -> RedDBResult<crate::PhysicalIndexState> {
585        self.check_write(crate::runtime::write_gate::WriteKind::Maintenance)?;
586        self.inner
587            .db
588            .set_index_enabled(name, enabled)
589            .map_err(|err| RedDBError::Internal(err.to_string()))?
590            .ok_or_else(|| RedDBError::NotFound(name.to_string()))
591    }
592
593    pub fn mark_index_building(&self, name: &str) -> RedDBResult<crate::PhysicalIndexState> {
594        self.inner
595            .db
596            .mark_index_building(name)
597            .map_err(|err| RedDBError::Internal(err.to_string()))?
598            .ok_or_else(|| RedDBError::NotFound(name.to_string()))
599    }
600
601    pub fn fail_index(&self, name: &str) -> RedDBResult<crate::PhysicalIndexState> {
602        self.inner
603            .db
604            .fail_index(name)
605            .map_err(|err| RedDBError::Internal(err.to_string()))?
606            .ok_or_else(|| RedDBError::NotFound(name.to_string()))
607    }
608
609    pub fn mark_index_stale(&self, name: &str) -> RedDBResult<crate::PhysicalIndexState> {
610        self.inner
611            .db
612            .mark_index_stale(name)
613            .map_err(|err| RedDBError::Internal(err.to_string()))?
614            .ok_or_else(|| RedDBError::NotFound(name.to_string()))
615    }
616
617    pub fn mark_index_ready(&self, name: &str) -> RedDBResult<crate::PhysicalIndexState> {
618        self.inner
619            .db
620            .mark_index_ready(name)
621            .map_err(|err| RedDBError::Internal(err.to_string()))?
622            .ok_or_else(|| RedDBError::NotFound(name.to_string()))
623    }
624
625    pub fn warmup_index_with_lifecycle(
626        &self,
627        name: &str,
628    ) -> RedDBResult<crate::PhysicalIndexState> {
629        self.mark_index_building(name)?;
630        match self.warmup_index(name) {
631            Ok(index) => Ok(index),
632            Err(err) => {
633                let _ = self.fail_index(name);
634                Err(err)
635            }
636        }
637    }
638
639    pub fn warmup_index(&self, name: &str) -> RedDBResult<crate::PhysicalIndexState> {
640        self.inner
641            .db
642            .warmup_index(name)
643            .map_err(|err| RedDBError::Internal(err.to_string()))?
644            .ok_or_else(|| RedDBError::NotFound(name.to_string()))
645    }
646
647    pub fn rebuild_indexes(
648        &self,
649        collection: Option<&str>,
650    ) -> RedDBResult<Vec<crate::PhysicalIndexState>> {
651        self.inner
652            .db
653            .rebuild_index_registry(collection)
654            .map_err(|err| RedDBError::Internal(err.to_string()))
655    }
656
657    pub fn rebuild_indexes_with_lifecycle(
658        &self,
659        collection: Option<&str>,
660    ) -> RedDBResult<Vec<crate::PhysicalIndexState>> {
661        let target_names: Vec<String> = match collection {
662            Some(collection) => self
663                .declared_indexes_for_collection(collection)
664                .into_iter()
665                .map(|index| index.name)
666                .collect(),
667            None => self
668                .declared_indexes()
669                .into_iter()
670                .map(|index| index.name)
671                .collect(),
672        };
673
674        let mut marked_building = Vec::new();
675        for name in target_names {
676            if self.mark_index_building(&name).is_ok() {
677                marked_building.push(name);
678            }
679        }
680
681        match self.rebuild_indexes(collection) {
682            Ok(indexes) => Ok(indexes),
683            Err(err) => {
684                for name in marked_building {
685                    let _ = self.fail_index(&name);
686                }
687                Err(err)
688            }
689        }
690    }
691}