Skip to main content

reddb_server/storage/unified/
entity.rs

1//! Unified Entity Model
2//!
3//! Provides a single entity type that can represent table rows, graph nodes,
4//! graph edges, or vectors with seamless interoperability.
5
6use std::collections::HashMap;
7use std::fmt;
8use std::sync::Arc;
9
10use crate::storage::schema::Value;
11
12/// The first entity-id handed to user-inserted data. Ids `1..FIRST_USER_ENTITY_ID`
13/// are reserved for the internal collection-descriptor and config-default entities
14/// the engine seeds at boot, so the first user-inserted `rid` is a STABLE,
15/// documented value regardless of how many config defaults a build ships.
16///
17/// Before this floor existed the offset drifted upward by one for every config
18/// default added (101 → 114 over time), silently breaking the documented
19/// file-format invariant (#1369). The boot sequence bumps the allocator up to
20/// this floor after seeding internals; it only ever raises the counter, so a
21/// database that already holds user data is untouched. Mirrors
22/// `FIRST_USER_LABEL_ID` in the graph label registry.
23pub const FIRST_USER_ENTITY_ID: u64 = 1024;
24
25/// Unique identifier for any entity in the unified storage
26#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
27pub struct EntityId(pub u64);
28
29impl EntityId {
30    /// Create a new entity ID
31    pub fn new(id: u64) -> Self {
32        Self(id)
33    }
34
35    /// Get the raw ID value
36    pub fn raw(&self) -> u64 {
37        self.0
38    }
39}
40
41impl fmt::Display for EntityId {
42    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
43        write!(f, "e{}", self.0)
44    }
45}
46
47impl From<u64> for EntityId {
48    fn from(id: u64) -> Self {
49        Self(id)
50    }
51}
52
53/// The kind of entity (what storage type it belongs to)
54#[derive(Debug, Clone, PartialEq, Eq, Hash)]
55pub enum EntityKind {
56    /// A row in a structured table (hot path — kept inline for cache performance)
57    TableRow { table: Arc<str>, row_id: u64 },
58    /// A node in the graph (boxed — saves ~56 bytes per entity for table rows)
59    GraphNode(Box<GraphNodeKind>),
60    /// An edge in the graph (boxed)
61    GraphEdge(Box<GraphEdgeKind>),
62    /// A vector in a collection
63    Vector { collection: String },
64    /// A time-series data point (boxed)
65    TimeSeriesPoint(Box<TimeSeriesPointKind>),
66    /// A queue message
67    QueueMessage { queue: String, position: u64 },
68}
69
70#[derive(Debug, Clone, PartialEq, Eq, Hash)]
71pub struct GraphNodeKind {
72    pub label: String,
73    pub node_type: String,
74}
75
76#[derive(Debug, Clone, PartialEq, Eq, Hash)]
77pub struct GraphEdgeKind {
78    pub label: String,
79    pub from_node: String,
80    pub to_node: String,
81    pub weight: u32,
82}
83
84#[derive(Debug, Clone, PartialEq, Eq, Hash)]
85pub struct TimeSeriesPointKind {
86    pub series: String,
87    pub metric: String,
88}
89
90impl EntityKind {
91    /// Get the storage type as a string
92    pub fn storage_type(&self) -> &'static str {
93        match self {
94            Self::TableRow { .. } => "table",
95            Self::GraphNode(_) => "graph_node",
96            Self::GraphEdge(_) => "graph_edge",
97            Self::Vector { .. } => "vector",
98            Self::TimeSeriesPoint(_) => "timeseries",
99            Self::QueueMessage { .. } => "queue",
100        }
101    }
102
103    /// Get the collection/table name
104    pub fn collection(&self) -> &str {
105        match self {
106            Self::TableRow { table, .. } => table,
107            Self::GraphNode(n) => &n.label,
108            Self::GraphEdge(e) => &e.label,
109            Self::Vector { collection } => collection,
110            Self::TimeSeriesPoint(ts) => &ts.series,
111            Self::QueueMessage { queue, .. } => queue,
112        }
113    }
114}
115
116/// The actual data content of an entity
117#[derive(Debug, Clone)]
118pub enum EntityData {
119    /// Table row data
120    Row(RowData),
121    /// Graph node data
122    Node(NodeData),
123    /// Graph edge data
124    Edge(EdgeData),
125    /// Vector data
126    Vector(VectorData),
127    /// Time-series data point
128    TimeSeries(TimeSeriesData),
129    /// Queue message data
130    QueueMessage(QueueMessageData),
131}
132
133impl EntityData {
134    /// Check if this is row data
135    pub fn is_row(&self) -> bool {
136        matches!(self, Self::Row(_))
137    }
138
139    /// Check if this is node data
140    pub fn is_node(&self) -> bool {
141        matches!(self, Self::Node(_))
142    }
143
144    /// Check if this is edge data
145    pub fn is_edge(&self) -> bool {
146        matches!(self, Self::Edge(_))
147    }
148
149    /// Check if this is vector data
150    pub fn is_vector(&self) -> bool {
151        matches!(self, Self::Vector(_))
152    }
153
154    /// Get as row data
155    pub fn as_row(&self) -> Option<&RowData> {
156        match self {
157            Self::Row(r) => Some(r),
158            _ => None,
159        }
160    }
161
162    /// Get as node data
163    pub fn as_node(&self) -> Option<&NodeData> {
164        match self {
165            Self::Node(n) => Some(n),
166            _ => None,
167        }
168    }
169
170    /// Get as edge data
171    pub fn as_edge(&self) -> Option<&EdgeData> {
172        match self {
173            Self::Edge(e) => Some(e),
174            _ => None,
175        }
176    }
177
178    /// Get as vector data
179    pub fn as_vector(&self) -> Option<&VectorData> {
180        match self {
181            Self::Vector(v) => Some(v),
182            _ => None,
183        }
184    }
185}
186
187/// Data for a table row
188#[derive(Debug, Clone)]
189pub struct RowData {
190    /// Column values in schema order
191    pub columns: Vec<Value>,
192    /// Named column access (optional, for convenience)
193    pub named: Option<HashMap<String, Value>>,
194    /// Shared column schema: column names in order (maps index → name).
195    /// When set, `columns` holds the values and `named` is None.
196    /// This saves ~60% memory vs per-row HashMap.
197    pub schema: Option<std::sync::Arc<Vec<String>>>,
198}
199
200impl RowData {
201    /// Create new row data from column values
202    pub fn new(columns: Vec<Value>) -> Self {
203        Self {
204            columns,
205            named: None,
206            schema: None,
207        }
208    }
209
210    /// Create row data with named columns
211    pub fn with_names(columns: Vec<Value>, names: Vec<String>) -> Self {
212        let named: HashMap<String, Value> =
213            names.into_iter().zip(columns.iter().cloned()).collect();
214        Self {
215            columns,
216            named: Some(named),
217            schema: None,
218        }
219    }
220
221    /// Get a named field value — checks named HashMap first, then schema+columns.
222    pub fn get_field(&self, name: &str) -> Option<&Value> {
223        // Fast path: named HashMap
224        if let Some(ref named) = self.named {
225            return named.get(name);
226        }
227        // Columnar path: use schema to find index
228        if let Some(ref schema) = self.schema {
229            if let Some(idx) = schema.iter().position(|s| s == name) {
230                return self.columns.get(idx);
231            }
232        }
233        None
234    }
235
236    /// Iterate over all (name, value) pairs — works for both named and columnar.
237    pub fn iter_fields(&self) -> Box<dyn Iterator<Item = (&str, &Value)> + '_> {
238        if let Some(ref named) = self.named {
239            Box::new(named.iter().map(|(k, v)| (k.as_str(), v)))
240        } else if let Some(ref schema) = self.schema {
241            Box::new(
242                schema
243                    .iter()
244                    .zip(self.columns.iter())
245                    .map(|(k, v)| (k.as_str(), v)),
246            )
247        } else {
248            Box::new(std::iter::empty())
249        }
250    }
251
252    /// Get column by index
253    pub fn get(&self, index: usize) -> Option<&Value> {
254        self.columns.get(index)
255    }
256
257    /// Get column by name
258    pub fn get_by_name(&self, name: &str) -> Option<&Value> {
259        self.named.as_ref()?.get(name)
260    }
261
262    /// Number of columns
263    pub fn len(&self) -> usize {
264        self.columns.len()
265    }
266
267    /// Check if empty
268    pub fn is_empty(&self) -> bool {
269        self.columns.is_empty()
270    }
271}
272
273/// Data for a graph node
274#[derive(Debug, Clone)]
275pub struct NodeData {
276    /// Node properties
277    pub properties: HashMap<String, Value>,
278}
279
280impl NodeData {
281    /// Create new node data
282    pub fn new() -> Self {
283        Self {
284            properties: HashMap::new(),
285        }
286    }
287
288    /// Create with properties
289    pub fn with_properties(properties: HashMap<String, Value>) -> Self {
290        Self { properties }
291    }
292
293    /// Set a property
294    pub fn set(&mut self, key: impl Into<String>, value: Value) {
295        self.properties.insert(key.into(), value);
296    }
297
298    /// Get a property
299    pub fn get(&self, key: &str) -> Option<&Value> {
300        self.properties.get(key)
301    }
302
303    /// Check if property exists
304    pub fn has(&self, key: &str) -> bool {
305        self.properties.contains_key(key)
306    }
307}
308
309impl Default for NodeData {
310    fn default() -> Self {
311        Self::new()
312    }
313}
314
315/// Data for a graph edge
316#[derive(Debug, Clone)]
317pub struct EdgeData {
318    /// Edge properties
319    pub properties: HashMap<String, Value>,
320    /// Edge weight (for weighted graphs)
321    pub weight: f32,
322}
323
324impl EdgeData {
325    /// Create new edge data
326    pub fn new(weight: f32) -> Self {
327        Self {
328            properties: HashMap::new(),
329            weight,
330        }
331    }
332
333    /// Create with properties
334    pub fn with_properties(weight: f32, properties: HashMap<String, Value>) -> Self {
335        Self { properties, weight }
336    }
337
338    /// Set a property
339    pub fn set(&mut self, key: impl Into<String>, value: Value) {
340        self.properties.insert(key.into(), value);
341    }
342
343    /// Get a property
344    pub fn get(&self, key: &str) -> Option<&Value> {
345        self.properties.get(key)
346    }
347}
348
349impl Default for EdgeData {
350    fn default() -> Self {
351        Self::new(1.0)
352    }
353}
354
355/// Data for a vector
356#[derive(Debug, Clone)]
357pub struct VectorData {
358    /// Dense vector (primary embedding)
359    pub dense: Vec<f32>,
360    /// Optional sparse vector
361    pub sparse: Option<SparseVector>,
362    /// Original content (if applicable)
363    pub content: Option<String>,
364}
365
366impl VectorData {
367    /// Create new vector data from dense vector
368    pub fn new(dense: Vec<f32>) -> Self {
369        Self {
370            dense,
371            sparse: None,
372            content: None,
373        }
374    }
375
376    /// Create with sparse vector
377    pub fn with_sparse(dense: Vec<f32>, sparse: SparseVector) -> Self {
378        Self {
379            dense,
380            sparse: Some(sparse),
381            content: None,
382        }
383    }
384
385    /// Set content
386    pub fn with_content(mut self, content: impl Into<String>) -> Self {
387        self.content = Some(content.into());
388        self
389    }
390
391    /// Get dimension
392    pub fn dimension(&self) -> usize {
393        self.dense.len()
394    }
395
396    /// Check if has sparse component
397    pub fn is_hybrid(&self) -> bool {
398        self.sparse.is_some()
399    }
400}
401
402/// Time-series data point
403#[derive(Debug, Clone)]
404pub struct TimeSeriesData {
405    /// Metric name (e.g., "cpu.idle")
406    pub metric: String,
407    /// Interned `(metric, canonical tags)` id for native time-series points.
408    pub series_id: Option<u64>,
409    /// Timestamp in nanoseconds since epoch
410    pub timestamp_ns: u64,
411    /// Metric value
412    pub value: f64,
413    /// Legacy/read-through dimensional tags (e.g., {"host": "srv1"}).
414    pub tags: std::collections::HashMap<String, String>,
415}
416
417/// Queue message data
418#[derive(Debug, Clone)]
419pub struct QueueMessageData {
420    /// Message payload
421    pub payload: Value,
422    /// Optional priority (higher = more urgent)
423    pub priority: Option<i32>,
424    /// Enqueue timestamp (nanoseconds)
425    pub enqueued_at_ns: u64,
426    /// Number of delivery attempts
427    pub attempts: u32,
428    /// Maximum delivery attempts before DLQ
429    pub max_attempts: u32,
430    /// Whether the message has been acknowledged
431    pub acked: bool,
432}
433
434/// Sparse vector representation
435#[derive(Debug, Clone)]
436pub struct SparseVector {
437    /// Indices of non-zero elements
438    pub indices: Vec<u32>,
439    /// Values at those indices
440    pub values: Vec<f32>,
441    /// Total dimension (may be larger than indices.len())
442    pub dimension: usize,
443}
444
445impl SparseVector {
446    /// Create new sparse vector
447    pub fn new(indices: Vec<u32>, values: Vec<f32>, dimension: usize) -> Self {
448        debug_assert_eq!(indices.len(), values.len());
449        Self {
450            indices,
451            values,
452            dimension,
453        }
454    }
455
456    /// Number of non-zero elements
457    pub fn nnz(&self) -> usize {
458        self.indices.len()
459    }
460
461    /// Sparsity ratio
462    pub fn sparsity(&self) -> f32 {
463        if self.dimension == 0 {
464            1.0
465        } else {
466            1.0 - (self.nnz() as f32 / self.dimension as f32)
467        }
468    }
469
470    /// Get value at index (0 if not present)
471    pub fn get(&self, index: u32) -> f32 {
472        self.indices
473            .iter()
474            .position(|&i| i == index)
475            .map(|pos| self.values[pos])
476            .unwrap_or(0.0)
477    }
478}
479
480/// A slot for embedding a specific aspect of an entity
481#[derive(Debug, Clone)]
482pub struct EmbeddingSlot {
483    /// Slot name (e.g., "content", "summary", "title", "code")
484    pub name: String,
485    /// The embedding vector
486    pub vector: Vec<f32>,
487    /// Model used to generate embedding
488    pub model: String,
489    /// Vector dimension
490    pub dimension: usize,
491    /// Generation timestamp
492    pub generated_at: u64,
493}
494
495fn current_unix_secs() -> u64 {
496    std::time::SystemTime::now()
497        .duration_since(std::time::UNIX_EPOCH)
498        .unwrap_or_default()
499        .as_secs()
500}
501
502impl EmbeddingSlot {
503    /// Create a new embedding slot
504    pub fn new(name: impl Into<String>, vector: Vec<f32>, model: impl Into<String>) -> Self {
505        let dimension = vector.len();
506        Self {
507            name: name.into(),
508            vector,
509            model: model.into(),
510            dimension,
511            generated_at: current_unix_secs(),
512        }
513    }
514}
515
516/// A unified entity that can represent any storage type
517#[derive(Debug, Clone)]
518pub struct UnifiedEntity {
519    /// Unique entity identifier
520    pub id: EntityId,
521    /// Stable user-visible identity shared by all physical versions.
522    ///
523    /// `None` is the legacy encoding and resolves to `id`.
524    logical_id: Option<EntityId>,
525    /// What kind of entity this is
526    pub kind: EntityKind,
527    /// Creation timestamp
528    pub created_at: u64,
529    /// Last update timestamp
530    pub updated_at: u64,
531    /// The actual data content
532    pub data: EntityData,
533    /// Sequence ID for ordering/versioning
534    pub sequence_id: u64,
535    /// Field-name bloom filter (u64, zero-allocation).
536    ///
537    /// Each bit encodes one possible mid-character value: for field name `n`
538    /// the bit position is `n.as_bytes()[n.len()/2] & 63`. OR of all user
539    /// field names present in this entity. Cleared for schema-based bulk rows
540    /// (all rows share the same schema so bloom is segment-level).
541    ///
542    /// The compiled filter computes `required_bloom` from predicate field names
543    /// at compile time. If `entity.field_bloom & required_bloom != required_bloom`,
544    /// the entity cannot match and is skipped before any HashMap probe.
545    pub field_bloom: u64,
546    /// MVCC creation transaction ID (Phase 2.3 PG parity).
547    ///
548    /// `0` means "pre-MVCC" / auto-commit — visible to every snapshot. When
549    /// a BEGIN-wrapped INSERT runs, it stamps `xmin` with the transaction's
550    /// snapshot id so other concurrent transactions only see the row after
551    /// the writer commits (snapshot isolation semantics).
552    ///
553    /// Visibility rule: `xmin <= snapshot.xid && (xmax == 0 || xmax > snapshot.xid)`.
554    pub xmin: u64,
555    /// MVCC deletion transaction ID (Phase 2.3 PG parity).
556    ///
557    /// `0` means "live". Set to the deleting transaction's snapshot id on
558    /// DELETE/UPDATE (row is kept until VACUUM reclaims it). Snapshots with
559    /// `xid < xmax` still see the row; newer snapshots skip it.
560    pub xmax: u64,
561    /// Optional auxiliary data (embeddings, cross-refs).
562    /// None for most table rows — saves 40 bytes/entity.
563    aux: Option<Box<EntityAux>>,
564}
565
566/// Auxiliary entity data — only allocated when needed.
567#[derive(Debug, Clone, Default)]
568pub struct EntityAux {
569    /// Embedding slots (for multi-vector support)
570    pub embeddings: Vec<EmbeddingSlot>,
571    /// Cross-references to other entities
572    pub cross_refs: Vec<CrossRef>,
573}
574
575impl UnifiedEntity {
576    /// Access embeddings (returns empty slice if no aux data).
577    pub fn embeddings(&self) -> &[EmbeddingSlot] {
578        self.aux
579            .as_ref()
580            .map(|a| a.embeddings.as_slice())
581            .unwrap_or(&[])
582    }
583
584    /// Access cross-references (returns empty slice if no aux data).
585    pub fn cross_refs(&self) -> &[CrossRef] {
586        self.aux
587            .as_ref()
588            .map(|a| a.cross_refs.as_slice())
589            .unwrap_or(&[])
590    }
591
592    /// Get mutable embeddings (allocates aux if needed).
593    pub fn embeddings_mut(&mut self) -> &mut Vec<EmbeddingSlot> {
594        &mut self.aux.get_or_insert_with(Default::default).embeddings
595    }
596
597    /// Get mutable cross-refs (allocates aux if needed).
598    pub fn cross_refs_mut(&mut self) -> &mut Vec<CrossRef> {
599        &mut self.aux.get_or_insert_with(Default::default).cross_refs
600    }
601
602    /// Check if entity has any auxiliary data.
603    pub fn has_aux(&self) -> bool {
604        self.aux.is_some()
605    }
606}
607
608/// Compute one bit of a field-name bloom filter.
609///
610/// Uses the mid-character trick from MongoDB's `FieldNameBloomFilter.h`:
611/// the bit position is the mid-byte value clamped to 0..63. Zero-allocation,
612/// ~1.5% false-positive rate for ≤5 distinct field names.
613#[inline]
614pub fn field_name_bloom(name: &str) -> u64 {
615    let b = name.as_bytes();
616    if b.is_empty() {
617        return 0;
618    }
619    1u64 << (b[b.len() / 2] & 63)
620}
621
622/// Compute the combined field-name bloom for all user-level fields in `data`.
623/// Returns 0 for schema-based rows (all rows share the same schema, so the
624/// per-entity bloom would be identical — caller uses a segment-level bloom).
625pub fn compute_entity_field_bloom(data: &EntityData) -> u64 {
626    match data {
627        EntityData::Row(row) => {
628            if row.schema.is_some() {
629                // Schema path: bloom is identical for every row in this table.
630                // Don't store per-entity — use segment-level bloom instead.
631                return 0;
632            }
633            if let Some(named) = &row.named {
634                let mut bloom = named.keys().fold(0u64, |acc, k| acc | field_name_bloom(k));
635                // Single-source documents no longer materialise promoted
636                // columns, so the body's top-level keys are the only place a
637                // `WHERE`/projection field lives. Fold them into the bloom so
638                // the field-bloom gate doesn't reject a row before the body
639                // read fallback ever runs. Inert for non-document rows (no
640                // binary-container `body` field) — `container_field_names`
641                // self-gates on the RDOC magic.
642                if let Some(Value::Json(bytes)) = named.get("body") {
643                    if let Some(names) = crate::document_body::container_field_names(bytes) {
644                        for name in names {
645                            bloom |= field_name_bloom(&name);
646                        }
647                    }
648                }
649                bloom
650            } else {
651                0
652            }
653        }
654        EntityData::Node(node) => node
655            .properties
656            .keys()
657            .fold(0u64, |acc, k| acc | field_name_bloom(k)),
658        EntityData::Edge(edge) => edge
659            .properties
660            .keys()
661            .fold(0u64, |acc, k| acc | field_name_bloom(k)),
662        // Vectors, time-series, queue: no user-named fields worth blooming.
663        _ => 0,
664    }
665}
666
667impl UnifiedEntity {
668    /// Create a new unified entity
669    pub fn new(id: EntityId, kind: EntityKind, data: EntityData) -> Self {
670        let now = current_unix_secs();
671        let field_bloom = compute_entity_field_bloom(&data);
672
673        Self {
674            id,
675            logical_id: None,
676            kind,
677            created_at: now,
678            updated_at: now,
679            data,
680            sequence_id: 0,
681            field_bloom,
682            // Pre-MVCC default: xmin/xmax = 0 means visible to every snapshot.
683            // Transactional writers stamp real snapshot IDs after allocation.
684            xmin: 0,
685            xmax: 0,
686            aux: None,
687        }
688    }
689
690    /// MVCC visibility check (Phase 2.3 PG parity).
691    ///
692    /// Returns `true` when this tuple is visible under the provided
693    /// snapshot xid. Pre-MVCC rows (`xmin == 0`, `xmax == 0`) are visible
694    /// to every snapshot — preserves full compatibility with existing
695    /// data inserted before the MVCC headers existed.
696    ///
697    /// Snapshot isolation rule:
698    ///   - `xmin == 0 || xmin <= snapshot_xid`  (creator committed before snapshot)
699    ///   - `xmax == 0 || xmax > snapshot_xid`   (deleter committed after snapshot)
700    #[inline]
701    pub fn is_visible(&self, snapshot_xid: u64) -> bool {
702        if self.xmin != 0 && self.xmin > snapshot_xid {
703            return false;
704        }
705        if self.xmax != 0 && self.xmax <= snapshot_xid {
706            return false;
707        }
708        true
709    }
710
711    /// Stamp `xmin` (creation transaction ID). Called by the runtime on
712    /// INSERT inside an active transaction.
713    #[inline]
714    pub fn set_xmin(&mut self, xid: u64) {
715        self.xmin = xid;
716    }
717
718    /// Stamp `xmax` (deletion transaction ID). Called by the runtime on
719    /// DELETE/UPDATE inside an active transaction — the tuple survives
720    /// until VACUUM reclaims it.
721    #[inline]
722    pub fn set_xmax(&mut self, xid: u64) {
723        self.xmax = xid;
724    }
725
726    /// Stable user-visible identity. Legacy rows without an explicit
727    /// logical id map to their physical entity id.
728    #[inline]
729    pub fn logical_id(&self) -> EntityId {
730        self.logical_id.unwrap_or(self.id)
731    }
732
733    /// Returns true when the entity carries an explicit logical id on disk.
734    #[inline]
735    pub fn has_explicit_logical_id(&self) -> bool {
736        self.logical_id.is_some()
737    }
738
739    /// Set the stable user-visible identity for this physical version.
740    #[inline]
741    pub fn set_logical_id(&mut self, logical_id: EntityId) {
742        self.logical_id = Some(logical_id);
743    }
744
745    /// Ensure entities written by the current engine carry explicit
746    /// logical identity. Table rows + documents (Phase 1/2) and graph
747    /// nodes/edges (Phase 3) participate in the multi-model MVCC
748    /// versioning rollout and so need a stable logical id for
749    /// version-chain selection. Stamping the logical id is inert for
750    /// non-versioned collections: history only accrues through
751    /// `install_versioned_table_row_update`, which is gated on the
752    /// collection `versioned` flag, so a stamped-but-never-superseded
753    /// entity keeps `logical_id == id` and behaves exactly as before.
754    /// Vectors are intentionally excluded pending their read-path follow
755    /// up (no snapshot-honoring `VECTOR SEARCH`).
756    #[inline]
757    pub(crate) fn ensure_table_logical_id(&mut self) {
758        if self.logical_id.is_none()
759            && matches!(
760                self.kind,
761                EntityKind::TableRow { .. } | EntityKind::GraphNode(_) | EntityKind::GraphEdge(_)
762            )
763        {
764            self.logical_id = Some(self.id);
765        }
766    }
767
768    /// Create a table row entity
769    pub fn table_row(
770        id: EntityId,
771        table: impl Into<Arc<str>>,
772        row_id: u64,
773        columns: Vec<Value>,
774    ) -> Self {
775        Self::new(
776            id,
777            EntityKind::TableRow {
778                table: table.into(),
779                row_id,
780            },
781            EntityData::Row(RowData::new(columns)),
782        )
783    }
784
785    /// Create a graph node entity
786    pub fn graph_node(
787        id: EntityId,
788        label: impl Into<String>,
789        node_type: impl Into<String>,
790        properties: HashMap<String, Value>,
791    ) -> Self {
792        Self::new(
793            id,
794            EntityKind::GraphNode(Box::new(GraphNodeKind {
795                label: label.into(),
796                node_type: node_type.into(),
797            })),
798            EntityData::Node(NodeData::with_properties(properties)),
799        )
800    }
801
802    /// Create a graph edge entity
803    pub fn graph_edge(
804        id: EntityId,
805        label: impl Into<String>,
806        from: impl Into<String>,
807        to: impl Into<String>,
808        weight: f32,
809        properties: HashMap<String, Value>,
810    ) -> Self {
811        Self::new(
812            id,
813            EntityKind::GraphEdge(Box::new(GraphEdgeKind {
814                label: label.into(),
815                from_node: from.into(),
816                to_node: to.into(),
817                weight: (weight * 1000.0) as u32,
818            })),
819            EntityData::Edge(EdgeData::with_properties(weight, properties)),
820        )
821    }
822
823    /// Create a vector entity
824    pub fn vector(id: EntityId, collection: impl Into<String>, vector: Vec<f32>) -> Self {
825        Self::new(
826            id,
827            EntityKind::Vector {
828                collection: collection.into(),
829            },
830            EntityData::Vector(VectorData::new(vector)),
831        )
832    }
833
834    /// Add an embedding to this entity
835    pub fn add_embedding(&mut self, slot: EmbeddingSlot) {
836        self.embeddings_mut().push(slot);
837        self.touch();
838    }
839
840    /// Add a cross-reference
841    pub fn add_cross_ref(&mut self, cross_ref: CrossRef) {
842        self.cross_refs_mut().push(cross_ref);
843        self.touch();
844    }
845
846    /// Get embedding by slot name
847    pub fn get_embedding(&self, name: &str) -> Option<&EmbeddingSlot> {
848        self.embeddings().iter().find(|e| e.name == name)
849    }
850
851    /// Update timestamp
852    fn touch(&mut self) {
853        self.updated_at = current_unix_secs();
854    }
855
856    /// Check if entity is stale (not updated in given seconds)
857    pub fn is_stale(&self, max_age_secs: u64) -> bool {
858        let now = current_unix_secs();
859        now.saturating_sub(self.updated_at) > max_age_secs
860    }
861}
862
863/// A cross-reference between entities
864#[derive(Debug, Clone, PartialEq)]
865pub struct CrossRef {
866    /// Source entity ID (the entity that holds this reference)
867    pub source: EntityId,
868    /// Target entity ID
869    pub target: EntityId,
870    /// Target collection name
871    pub target_collection: String,
872    /// Type of reference
873    pub ref_type: RefType,
874    /// Reference weight/strength (0.0-1.0)
875    pub weight: f32,
876    /// When this reference was created
877    pub created_at: u64,
878}
879
880impl CrossRef {
881    /// Create a new cross-reference
882    pub fn new(
883        source: EntityId,
884        target: EntityId,
885        target_collection: impl Into<String>,
886        ref_type: RefType,
887    ) -> Self {
888        Self {
889            source,
890            target,
891            target_collection: target_collection.into(),
892            ref_type,
893            weight: 1.0,
894            created_at: current_unix_secs(),
895        }
896    }
897
898    /// Create with weight
899    pub fn with_weight(
900        source: EntityId,
901        target: EntityId,
902        target_collection: impl Into<String>,
903        ref_type: RefType,
904        weight: f32,
905    ) -> Self {
906        let mut cr = Self::new(source, target, target_collection, ref_type);
907        cr.weight = weight;
908        cr
909    }
910}
911
912/// Types of cross-references between entities
913#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
914pub enum RefType {
915    // Table ↔ Graph
916    RowToNode, // Table row represents a graph node
917    RowToEdge, // Table row represents a graph edge
918    NodeToRow, // Node links back to source row
919
920    // Table ↔ Vector
921    RowToVector, // Table row has embeddings
922    VectorToRow, // Vector search → source row
923
924    // Graph ↔ Vector
925    NodeToVector, // Node has embeddings
926    EdgeToVector, // Edge has embeddings
927    VectorToNode, // Vector search → source node
928
929    // Semantic links (discovered)
930    SimilarTo,   // Discovered by vector similarity
931    RelatedTo,   // Domain-specific relationship
932    DerivesFrom, // Data lineage
933    Mentions,    // Text mentions another entity
934    Contains,    // Structural containment
935    DependsOn,   // Dependency relationship
936}
937
938impl RefType {
939    /// Get the inverse reference type (for bidirectional tracking)
940    pub fn inverse(&self) -> Option<Self> {
941        match self {
942            Self::RowToNode => Some(Self::NodeToRow),
943            Self::NodeToRow => Some(Self::RowToNode),
944            Self::RowToVector => Some(Self::VectorToRow),
945            Self::VectorToRow => Some(Self::RowToVector),
946            Self::NodeToVector => Some(Self::VectorToNode),
947            Self::VectorToNode => Some(Self::NodeToVector),
948            Self::SimilarTo => Some(Self::SimilarTo), // Symmetric
949            Self::RelatedTo => Some(Self::RelatedTo), // Symmetric
950            _ => None,                                // One-directional references
951        }
952    }
953
954    /// Check if this is a symmetric reference type
955    pub fn is_symmetric(&self) -> bool {
956        matches!(self, Self::SimilarTo | Self::RelatedTo)
957    }
958
959    /// Convert RefType to byte for binary serialization
960    pub fn to_byte(&self) -> u8 {
961        match self {
962            Self::RowToNode => 0,
963            Self::RowToEdge => 1,
964            Self::NodeToRow => 2,
965            Self::RowToVector => 3,
966            Self::VectorToRow => 4,
967            Self::NodeToVector => 5,
968            Self::EdgeToVector => 6,
969            Self::VectorToNode => 7,
970            Self::SimilarTo => 8,
971            Self::RelatedTo => 9,
972            Self::DerivesFrom => 10,
973            Self::Mentions => 11,
974            Self::Contains => 12,
975            Self::DependsOn => 13,
976        }
977    }
978
979    /// Create RefType from byte (binary deserialization)
980    pub fn from_byte(byte: u8) -> Self {
981        match byte {
982            0 => Self::RowToNode,
983            1 => Self::RowToEdge,
984            2 => Self::NodeToRow,
985            3 => Self::RowToVector,
986            4 => Self::VectorToRow,
987            5 => Self::NodeToVector,
988            6 => Self::EdgeToVector,
989            7 => Self::VectorToNode,
990            8 => Self::SimilarTo,
991            9 => Self::RelatedTo,
992            10 => Self::DerivesFrom,
993            11 => Self::Mentions,
994            12 => Self::Contains,
995            13 => Self::DependsOn,
996            _ => Self::RelatedTo, // Default fallback
997        }
998    }
999}
1000
1001/// Convert Vec<Value> to RowData
1002impl From<Vec<Value>> for RowData {
1003    fn from(columns: Vec<Value>) -> Self {
1004        RowData::new(columns)
1005    }
1006}
1007
1008/// Convert HashMap to NodeData
1009impl From<HashMap<String, Value>> for NodeData {
1010    fn from(properties: HashMap<String, Value>) -> Self {
1011        NodeData::with_properties(properties)
1012    }
1013}
1014
1015/// Convert dense vector to VectorData
1016impl From<Vec<f32>> for VectorData {
1017    fn from(dense: Vec<f32>) -> Self {
1018        VectorData::new(dense)
1019    }
1020}
1021
1022/// Convert tuple (dense, sparse) to VectorData
1023impl From<(Vec<f32>, SparseVector)> for VectorData {
1024    fn from((dense, sparse): (Vec<f32>, SparseVector)) -> Self {
1025        VectorData::with_sparse(dense, sparse)
1026    }
1027}
1028
1029// Helper trait for uniform entity creation
1030impl UnifiedEntity {
1031    /// Create a graph node entity from properties map
1032    pub fn from_properties(
1033        id: EntityId,
1034        label: impl Into<String>,
1035        node_type: impl Into<String>,
1036        properties: impl IntoIterator<Item = (impl Into<String>, Value)>,
1037    ) -> Self {
1038        let props: HashMap<String, Value> =
1039            properties.into_iter().map(|(k, v)| (k.into(), v)).collect();
1040        Self::graph_node(id, label, node_type, props)
1041    }
1042
1043    /// Convert entity to row data if applicable
1044    pub fn into_row(self) -> Option<RowData> {
1045        match self.data {
1046            EntityData::Row(r) => Some(r),
1047            _ => None,
1048        }
1049    }
1050
1051    /// Convert entity to node data if applicable
1052    pub fn into_node(self) -> Option<NodeData> {
1053        match self.data {
1054            EntityData::Node(n) => Some(n),
1055            _ => None,
1056        }
1057    }
1058
1059    /// Convert entity to edge data if applicable
1060    pub fn into_edge(self) -> Option<EdgeData> {
1061        match self.data {
1062            EntityData::Edge(e) => Some(e),
1063            _ => None,
1064        }
1065    }
1066
1067    /// Convert entity to vector data if applicable
1068    pub fn into_vector(self) -> Option<VectorData> {
1069        match self.data {
1070            EntityData::Vector(v) => Some(v),
1071            _ => None,
1072        }
1073    }
1074}
1075
1076#[cfg(test)]
1077mod tests {
1078    use super::*;
1079
1080    #[test]
1081    fn test_entity_creation() {
1082        let id = EntityId::new(1);
1083        let entity = UnifiedEntity::table_row(
1084            id,
1085            "users",
1086            100,
1087            vec![Value::text("alice".to_string()), Value::Integer(25)],
1088        );
1089
1090        assert!(entity.data.is_row());
1091        assert_eq!(entity.kind.storage_type(), "table");
1092        assert_eq!(entity.kind.collection(), "users");
1093    }
1094
1095    #[test]
1096    fn test_cross_refs() {
1097        let id1 = EntityId::new(1);
1098        let id2 = EntityId::new(2);
1099
1100        let cross_ref = CrossRef::new(id1, id2, "nodes", RefType::RowToNode);
1101        assert_eq!(cross_ref.source, id1);
1102        assert_eq!(cross_ref.target, id2);
1103        assert_eq!(cross_ref.ref_type.inverse(), Some(RefType::NodeToRow));
1104    }
1105
1106    #[test]
1107    fn test_sparse_vector() {
1108        let sparse = SparseVector::new(vec![0, 5, 10], vec![1.0, 2.0, 3.0], 100);
1109
1110        assert_eq!(sparse.nnz(), 3);
1111        assert_eq!(sparse.get(5), 2.0);
1112        assert_eq!(sparse.get(3), 0.0);
1113        assert!(sparse.sparsity() > 0.9);
1114    }
1115
1116    #[test]
1117    fn test_embedding_slots() {
1118        let mut entity = UnifiedEntity::table_row(
1119            EntityId::new(1),
1120            "documents",
1121            1,
1122            vec![Value::text("Hello world".to_string())],
1123        );
1124
1125        entity.add_embedding(EmbeddingSlot::new(
1126            "content",
1127            vec![0.1, 0.2, 0.3],
1128            "text-embedding-3-small",
1129        ));
1130
1131        assert_eq!(entity.embeddings().len(), 1);
1132        assert!(entity.get_embedding("content").is_some());
1133        assert!(entity.get_embedding("summary").is_none());
1134    }
1135}