nodedb-columnar 0.4.0

Columnar segment format and memtable for NodeDB analytical storage
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
// SPDX-License-Identifier: Apache-2.0

//! Lossless backup/restore of the columnar `MutationEngine`.
//!
//! `export_snapshot` captures the full in-memory state (memtable columns,
//! PK index, delete bitmaps, counters, schema) plus caller-supplied flushed-
//! segment blobs into a single `ColumnarEngineSnapshot` that can be round-
//! tripped through MessagePack and passed to `from_snapshot` to reconstruct
//! an identical engine.
//!
//! The `DictEncoded.reverse` map is NOT serialised — it is deterministically
//! rebuilt from `dictionary` on restore.

use std::collections::HashMap;

use nodedb_types::columnar::ColumnarSchema;
use nodedb_types::surrogate::Surrogate;
use serde::{Deserialize, Serialize};
use zerompk::{FromMessagePack, ToMessagePack};

use crate::delete_bitmap::DeleteBitmap;
use crate::error::ColumnarError;
use crate::memtable::ColumnData;
use crate::pk_index::PkIndex;

use super::engine::MutationEngine;

/// Per-row cross-engine surrogates for flushed segments, parallel to the
/// flushed-segment blob Vec: outer index == segment index (segment_id ==
/// index + 1), inner Vec is per-row.
pub type FlushedSurrogateTable = Vec<Vec<Option<Surrogate>>>;

// ── Wire types ───────────────────────────────────────────────────────────────

/// A lossless projection of one `ColumnData` variant that survives a
/// MessagePack round-trip.
///
/// Every variant mirrors the corresponding `ColumnData` variant exactly,
/// except `DictEncoded` which drops the `reverse` map (rebuilt on import).
#[derive(Debug, Clone, Serialize, Deserialize, ToMessagePack, FromMessagePack)]
pub enum ColumnDataSnapshot {
    Int64 {
        values: Vec<i64>,
        valid: Option<Vec<bool>>,
    },
    Float64 {
        values: Vec<f64>,
        valid: Option<Vec<bool>>,
    },
    Bool {
        values: Vec<bool>,
        valid: Option<Vec<bool>>,
    },
    Timestamp {
        values: Vec<i64>,
        valid: Option<Vec<bool>>,
    },
    Decimal {
        values: Vec<[u8; 16]>,
        valid: Option<Vec<bool>>,
    },
    Uuid {
        values: Vec<[u8; 16]>,
        valid: Option<Vec<bool>>,
    },
    String {
        data: Vec<u8>,
        offsets: Vec<u32>,
        valid: Option<Vec<bool>>,
    },
    Bytes {
        data: Vec<u8>,
        offsets: Vec<u32>,
        valid: Option<Vec<bool>>,
    },
    Json {
        data: Vec<u8>,
        offsets: Vec<u32>,
        valid: Option<Vec<bool>>,
    },
    Geometry {
        data: Vec<u8>,
        offsets: Vec<u32>,
        valid: Option<Vec<bool>>,
    },
    Vector {
        data: Vec<f32>,
        dim: u32,
        valid: Option<Vec<bool>>,
    },
    /// Dictionary-encoded string column.
    ///
    /// `reverse` is NOT stored — it is rebuilt from `dictionary` on
    /// `from_snapshot`. The rebuild is O(n) in the dictionary size.
    DictEncoded {
        ids: Vec<u32>,
        dictionary: Vec<String>,
        valid: Option<Vec<bool>>,
    },
}

/// Complete serialisable snapshot of one `MutationEngine` instance.
///
/// Map-encoded (`#[msgpack(map)]`) so new fields can be added with
/// `#[msgpack(default)]` / `#[serde(default)]` and older snapshots
/// decode without a migration — new optional fields should carry
/// `#[msgpack(default)]` and `#[serde(default)]` and their type must
/// implement `Default`.
#[derive(Debug, Clone, Serialize, Deserialize, ToMessagePack, FromMessagePack)]
#[msgpack(map)]
pub struct ColumnarEngineSnapshot {
    /// Collection name.
    pub collection: String,
    /// Schema at export time.
    pub schema: ColumnarSchema,
    /// Projected memtable columns (parallel to `schema.columns`).
    pub memtable_columns: Vec<ColumnDataSnapshot>,
    /// Per-row surrogates (parallel to memtable rows).
    pub memtable_surrogates: Vec<Option<Surrogate>>,
    /// Serialised `PkIndex` bytes (via `PkIndex::to_bytes()`).
    pub pk_index_bytes: Vec<u8>,
    /// Serialised delete bitmaps for FLUSHED segments only.
    ///
    /// Excludes the entry keyed by `memtable_segment_id`; that is
    /// stored separately in `memtable_delete_bitmap_bytes`.
    pub delete_bitmaps: Vec<(u64, Vec<u8>)>,
    /// Serialised delete bitmap for the memtable's virtual segment,
    /// or empty bytes if no rows have been deleted from the memtable.
    pub memtable_delete_bitmap_bytes: Vec<u8>,
    /// Raw NDBS segment blobs for every flushed segment, in segment-ID
    /// order (index 0 == segment_id 1 by convention).
    pub flushed_segments: Vec<Vec<u8>>,
    /// Per-row cross-engine surrogates for each flushed segment, parallel to
    /// `flushed_segments` (outer index == segment index, segment_id == index+1;
    /// inner Vec is per-row). Empty when decoded from a pre-surrogate snapshot.
    #[msgpack(default)]
    #[serde(default)]
    pub flushed_surrogates: FlushedSurrogateTable,
    /// Next segment ID to be assigned on flush.
    pub next_segment_id: u64,
    /// Virtual segment ID currently used for memtable rows.
    pub memtable_segment_id: u64,
    /// Row counter within the current memtable (resets on flush).
    pub memtable_row_counter: u32,
}

// ── Export ────────────────────────────────────────────────────────────────────

impl MutationEngine {
    /// Export the full engine state as a lossless snapshot.
    ///
    /// `flushed_segments` must contain the raw NDBS blobs for every flushed
    /// segment, ordered by segment ID (index 0 == segment_id 1). The caller
    /// is responsible for reading the blobs from disk.
    ///
    /// `flushed_surrogates` carries the per-row cross-engine surrogates for
    /// each flushed segment, parallel to `flushed_segments` (outer index ==
    /// segment index). Pass `&[]` when no surrogate sidecar is available; the
    /// restored rows then read as `None`-surrogate.
    pub fn export_snapshot(
        &self,
        flushed_segments: &[Vec<u8>],
        flushed_surrogates: &[Vec<Option<Surrogate>>],
    ) -> Result<ColumnarEngineSnapshot, ColumnarError> {
        // Project each memtable column to its snapshot form.
        let memtable_columns = self
            .memtable
            .columns()
            .iter()
            .map(column_to_snapshot)
            .collect::<Vec<_>>();

        // Serialise the PK index.
        let pk_index_bytes = self.pk_index.to_bytes()?;

        // Partition delete bitmaps: separate the memtable's virtual segment
        // from flushed-segment bitmaps.
        let mut delete_bitmaps: Vec<(u64, Vec<u8>)> = Vec::new();
        let mut memtable_delete_bitmap_bytes = Vec::new();

        for (&seg_id, bitmap) in &self.delete_bitmaps {
            let bytes = bitmap.to_bytes()?;
            if seg_id == self.memtable_segment_id {
                memtable_delete_bitmap_bytes = bytes;
            } else {
                delete_bitmaps.push((seg_id, bytes));
            }
        }

        Ok(ColumnarEngineSnapshot {
            collection: self.collection.clone(),
            schema: self.schema.clone(),
            memtable_columns,
            memtable_surrogates: self.memtable_surrogates.clone(),
            pk_index_bytes,
            delete_bitmaps,
            memtable_delete_bitmap_bytes,
            flushed_segments: flushed_segments.to_vec(),
            flushed_surrogates: flushed_surrogates.to_vec(),
            next_segment_id: self.next_segment_id,
            memtable_segment_id: self.memtable_segment_id,
            memtable_row_counter: self.memtable_row_counter,
        })
    }

    /// Reconstruct a `MutationEngine` from a previously exported snapshot.
    ///
    /// Returns `(engine, flushed_segment_blobs, flushed_surrogates)`. The
    /// caller is responsible for writing the blobs back to the appropriate
    /// on-disk locations and for re-attaching the surrogate sidecar. The
    /// surrogate Vec is parallel to the blob Vec (outer index == segment
    /// index); it is empty when decoded from a pre-surrogate snapshot, in
    /// which case the caller treats every flushed row as `None`-surrogate.
    ///
    /// # Errors
    ///
    /// Returns `ColumnarError::SchemaMismatch` if the number of memtable
    /// columns in the snapshot does not match the schema column count.
    /// Returns `ColumnarError::Serialization` if the PK index or any delete
    /// bitmap bytes are corrupt.
    /// Returns `ColumnarError::Corruption` if a column snapshot variant does
    /// not match the expected variant shape (mismatched field counts etc.).
    pub fn from_snapshot(
        snap: ColumnarEngineSnapshot,
    ) -> Result<(MutationEngine, Vec<Vec<u8>>, FlushedSurrogateTable), ColumnarError> {
        let col_count = snap.schema.columns.len();
        if snap.memtable_columns.len() != col_count {
            return Err(ColumnarError::SchemaMismatch {
                expected: col_count,
                got: snap.memtable_columns.len(),
            });
        }

        // Rebuild PK index.
        let pk_index = PkIndex::from_bytes(&snap.pk_index_bytes)?;

        // Rebuild flushed-segment delete bitmaps.
        let mut delete_bitmaps: HashMap<u64, DeleteBitmap> = HashMap::new();
        for (seg_id, bytes) in snap.delete_bitmaps {
            let bm = DeleteBitmap::from_bytes(&bytes)?;
            delete_bitmaps.insert(seg_id, bm);
        }

        // Restore memtable delete bitmap under the virtual segment ID.
        if !snap.memtable_delete_bitmap_bytes.is_empty() {
            let bm = DeleteBitmap::from_bytes(&snap.memtable_delete_bitmap_bytes)?;
            delete_bitmaps.insert(snap.memtable_segment_id, bm);
        }

        // Rebuild column data from snapshots.
        let columns: Vec<ColumnData> = snap
            .memtable_columns
            .into_iter()
            .map(snapshot_to_column)
            .collect();

        // Rebuild pk_col_indices from schema (mirrors MutationEngine::new).
        let pk_col_indices: Vec<usize> = snap
            .schema
            .columns
            .iter()
            .enumerate()
            .filter(|(_, c)| c.primary_key)
            .map(|(i, _)| i)
            .collect();

        // Reconstruct the memtable from raw columns.
        let memtable = crate::memtable::ColumnarMemtable::from_raw_columns(
            &snap.schema,
            columns,
            snap.memtable_row_counter as usize,
        );

        let engine = MutationEngine {
            collection: snap.collection,
            schema: snap.schema,
            memtable,
            pk_index,
            delete_bitmaps,
            pk_col_indices,
            next_segment_id: snap.next_segment_id,
            memtable_segment_id: snap.memtable_segment_id,
            memtable_row_counter: snap.memtable_row_counter,
            memtable_surrogates: snap.memtable_surrogates,
        };

        Ok((engine, snap.flushed_segments, snap.flushed_surrogates))
    }
}

// ── Projection helpers ────────────────────────────────────────────────────────

/// Project a `ColumnData` into its serialisable `ColumnDataSnapshot` form.
fn column_to_snapshot(col: &ColumnData) -> ColumnDataSnapshot {
    match col {
        ColumnData::Int64 { values, valid } => ColumnDataSnapshot::Int64 {
            values: values.clone(),
            valid: valid.clone(),
        },
        ColumnData::Float64 { values, valid } => ColumnDataSnapshot::Float64 {
            values: values.clone(),
            valid: valid.clone(),
        },
        ColumnData::Bool { values, valid } => ColumnDataSnapshot::Bool {
            values: values.clone(),
            valid: valid.clone(),
        },
        ColumnData::Timestamp { values, valid } => ColumnDataSnapshot::Timestamp {
            values: values.clone(),
            valid: valid.clone(),
        },
        ColumnData::Decimal { values, valid } => ColumnDataSnapshot::Decimal {
            values: values.clone(),
            valid: valid.clone(),
        },
        ColumnData::Uuid { values, valid } => ColumnDataSnapshot::Uuid {
            values: values.clone(),
            valid: valid.clone(),
        },
        ColumnData::String {
            data,
            offsets,
            valid,
        } => ColumnDataSnapshot::String {
            data: data.clone(),
            offsets: offsets.clone(),
            valid: valid.clone(),
        },
        ColumnData::Bytes {
            data,
            offsets,
            valid,
        } => ColumnDataSnapshot::Bytes {
            data: data.clone(),
            offsets: offsets.clone(),
            valid: valid.clone(),
        },
        ColumnData::Json {
            data,
            offsets,
            valid,
        } => ColumnDataSnapshot::Json {
            data: data.clone(),
            offsets: offsets.clone(),
            valid: valid.clone(),
        },
        ColumnData::Geometry {
            data,
            offsets,
            valid,
        } => ColumnDataSnapshot::Geometry {
            data: data.clone(),
            offsets: offsets.clone(),
            valid: valid.clone(),
        },
        ColumnData::Vector { data, dim, valid } => ColumnDataSnapshot::Vector {
            data: data.clone(),
            dim: *dim,
            valid: valid.clone(),
        },
        ColumnData::DictEncoded {
            ids,
            dictionary,
            valid,
            // `reverse` is intentionally dropped — rebuilt on import.
            ..
        } => ColumnDataSnapshot::DictEncoded {
            ids: ids.clone(),
            dictionary: dictionary.clone(),
            valid: valid.clone(),
        },
    }
}

/// Reconstruct a `ColumnData` from its `ColumnDataSnapshot`.
///
/// `DictEncoded.reverse` is rebuilt from `dictionary` (id == index).
fn snapshot_to_column(snap: ColumnDataSnapshot) -> ColumnData {
    match snap {
        ColumnDataSnapshot::Int64 { values, valid } => ColumnData::Int64 { values, valid },
        ColumnDataSnapshot::Float64 { values, valid } => ColumnData::Float64 { values, valid },
        ColumnDataSnapshot::Bool { values, valid } => ColumnData::Bool { values, valid },
        ColumnDataSnapshot::Timestamp { values, valid } => ColumnData::Timestamp { values, valid },
        ColumnDataSnapshot::Decimal { values, valid } => ColumnData::Decimal { values, valid },
        ColumnDataSnapshot::Uuid { values, valid } => ColumnData::Uuid { values, valid },
        ColumnDataSnapshot::String {
            data,
            offsets,
            valid,
        } => ColumnData::String {
            data,
            offsets,
            valid,
        },
        ColumnDataSnapshot::Bytes {
            data,
            offsets,
            valid,
        } => ColumnData::Bytes {
            data,
            offsets,
            valid,
        },
        ColumnDataSnapshot::Json {
            data,
            offsets,
            valid,
        } => ColumnData::Json {
            data,
            offsets,
            valid,
        },
        ColumnDataSnapshot::Geometry {
            data,
            offsets,
            valid,
        } => ColumnData::Geometry {
            data,
            offsets,
            valid,
        },
        ColumnDataSnapshot::Vector { data, dim, valid } => ColumnData::Vector { data, dim, valid },
        ColumnDataSnapshot::DictEncoded {
            ids,
            dictionary,
            valid,
        } => {
            // Rebuild reverse map: string → id (id == index in dictionary).
            let reverse: HashMap<String, u32> = dictionary
                .iter()
                .enumerate()
                .map(|(i, s)| (s.clone(), i as u32))
                .collect();
            ColumnData::DictEncoded {
                ids,
                dictionary,
                reverse,
                valid,
            }
        }
    }
}

// ── Unit tests ────────────────────────────────────────────────────────────────

#[cfg(test)]
mod tests {
    use nodedb_types::columnar::{ColumnDef, ColumnType, ColumnarSchema};
    use nodedb_types::value::Value;

    use super::*;

    fn simple_schema() -> ColumnarSchema {
        ColumnarSchema {
            columns: vec![
                ColumnDef::required("id", ColumnType::Int64).with_primary_key(),
                ColumnDef::required("name", ColumnType::String),
                ColumnDef::nullable("score", ColumnType::Float64),
            ],
            version: 1,
        }
    }

    fn insert_row(engine: &mut MutationEngine, id: i64, name: &str, score: Option<f64>) {
        let score_val = score.map(Value::Float).unwrap_or(Value::Null);
        engine
            .insert(&[Value::Integer(id), Value::String(name.into()), score_val])
            .expect("insert");
    }

    #[test]
    fn round_trip_memtable_rows() {
        let schema = simple_schema();
        let mut engine = MutationEngine::new("test_col".to_string(), schema);

        insert_row(&mut engine, 1, "Alice", Some(0.9));
        insert_row(&mut engine, 2, "Bob", None);
        insert_row(&mut engine, 3, "Carol", Some(0.5));

        // Export snapshot with no flushed segments.
        let snap = engine.export_snapshot(&[], &[]).expect("export");

        // Verify basic fields.
        assert_eq!(snap.collection, "test_col");
        assert_eq!(snap.memtable_row_counter, 3);
        assert_eq!(snap.next_segment_id, 1);
        assert_eq!(snap.memtable_segment_id, 0);
        assert_eq!(snap.flushed_segments.len(), 0);

        // Round-trip through MessagePack.
        let bytes = zerompk::to_msgpack_vec(&snap).expect("serialize");
        let snap2: ColumnarEngineSnapshot = zerompk::from_msgpack(&bytes).expect("deserialize");

        // Restore engine.
        let (restored, flushed, _) = MutationEngine::from_snapshot(snap2).expect("from_snapshot");
        assert!(flushed.is_empty());
        assert_eq!(restored.next_segment_id(), 1);
        assert_eq!(restored.memtable_segment_id(), 0);
        assert_eq!(restored.memtable_row_counter, 3);

        // PK index should have 3 entries.
        assert_eq!(restored.pk_index().len(), 3);

        // Scan rows — all 3 should be present.
        let rows: Vec<Vec<Value>> = restored.scan_memtable_rows().collect();
        assert_eq!(rows.len(), 3);
        assert_eq!(rows[0][0], Value::Integer(1));
        assert_eq!(rows[1][1], Value::String("Bob".into()));
        assert_eq!(rows[2][2], Value::Float(0.5));
    }

    #[test]
    fn round_trip_with_tombstone() {
        let schema = simple_schema();
        let mut engine = MutationEngine::new("tombstone_test".to_string(), schema);

        insert_row(&mut engine, 10, "Xena", Some(1.0));
        insert_row(&mut engine, 20, "Yara", Some(2.0));

        // Delete row 20 by re-inserting with the same PK (upsert tombstone).
        // Actually mark it deleted directly via the memtable delete bitmap.
        engine
            .delete_bitmap_mut(engine.memtable_segment_id)
            .mark_deleted(1); // row index 1 == id=20

        let snap = engine.export_snapshot(&[], &[]).expect("export");

        // The memtable bitmap bytes must be non-empty.
        assert!(!snap.memtable_delete_bitmap_bytes.is_empty());

        let bytes = zerompk::to_msgpack_vec(&snap).expect("serialize");
        let snap2: ColumnarEngineSnapshot = zerompk::from_msgpack(&bytes).expect("deserialize");
        let (restored, _, _) = MutationEngine::from_snapshot(snap2).expect("from_snapshot");

        // scan_memtable_rows skips deleted row 1 (id=20).
        let rows: Vec<Vec<Value>> = restored.scan_memtable_rows().collect();
        assert_eq!(rows.len(), 1);
        assert_eq!(rows[0][0], Value::Integer(10));

        // Delete bitmap must still be present.
        assert!(
            restored
                .delete_bitmap(restored.memtable_segment_id())
                .is_some_and(|bm| bm.is_deleted(1))
        );
    }

    #[test]
    fn round_trip_flushed_segment_blob() {
        let schema = simple_schema();
        let engine = MutationEngine::new("flushed_test".to_string(), schema);

        // Simulate a pre-existing flushed segment as an opaque blob.
        let fake_blob: Vec<u8> = vec![0x4E, 0x44, 0x42, 0x53, 0x01, 0x02, 0x03]; // "NDBS" + junk

        let snap = engine
            .export_snapshot(std::slice::from_ref(&fake_blob), &[])
            .expect("export");
        assert_eq!(snap.flushed_segments.len(), 1);

        let bytes = zerompk::to_msgpack_vec(&snap).expect("serialize");
        let snap2: ColumnarEngineSnapshot = zerompk::from_msgpack(&bytes).expect("deserialize");
        let (_, flushed, _) = MutationEngine::from_snapshot(snap2).expect("from_snapshot");

        assert_eq!(flushed.len(), 1);
        assert_eq!(flushed[0], fake_blob);
    }

    #[test]
    fn schema_mismatch_rejected() {
        let schema = simple_schema();
        let engine = MutationEngine::new("mismatch".to_string(), schema);
        let mut snap = engine.export_snapshot(&[], &[]).expect("export");

        // Corrupt the snapshot: add an extra spurious column snapshot.
        snap.memtable_columns.push(ColumnDataSnapshot::Int64 {
            values: vec![],
            valid: None,
        });

        let result = MutationEngine::from_snapshot(snap);
        assert!(
            matches!(
                result,
                Err(ColumnarError::SchemaMismatch {
                    expected: 3,
                    got: 4
                })
            ),
            "expected SchemaMismatch error on extra column",
        );
    }

    #[test]
    fn pk_index_survives_round_trip() {
        let schema = simple_schema();
        let mut engine = MutationEngine::new("pk_test".to_string(), schema);

        for i in 0..5i64 {
            insert_row(&mut engine, i, &format!("u{i}"), None);
        }

        let snap = engine.export_snapshot(&[], &[]).expect("export");
        let bytes = zerompk::to_msgpack_vec(&snap).expect("serialize");
        let snap2: ColumnarEngineSnapshot = zerompk::from_msgpack(&bytes).expect("deserialize");
        let (restored, _, _) = MutationEngine::from_snapshot(snap2).expect("from_snapshot");

        assert_eq!(restored.pk_index().len(), 5);
        for i in 0..5i64 {
            let pk = crate::pk_index::encode_pk(&Value::Integer(i));
            assert!(restored.pk_index().contains(&pk), "missing pk {i}");
        }
    }

    #[test]
    fn counters_preserved() {
        let schema = simple_schema();
        let mut engine = MutationEngine::new("counters".to_string(), schema);

        insert_row(&mut engine, 99, "Z", Some(2.5));

        // Simulate having allocated several segment IDs already.
        engine.next_segment_id = 7;
        engine.memtable_segment_id = 6;

        let snap = engine.export_snapshot(&[], &[]).expect("export");
        let bytes = zerompk::to_msgpack_vec(&snap).expect("serialize");
        let snap2: ColumnarEngineSnapshot = zerompk::from_msgpack(&bytes).expect("deserialize");
        let (restored, _, _) = MutationEngine::from_snapshot(snap2).expect("from_snapshot");

        assert_eq!(restored.next_segment_id, 7);
        assert_eq!(restored.memtable_segment_id, 6);
        assert_eq!(restored.memtable_row_counter, 1);
    }

    #[test]
    fn flushed_surrogates_survive_round_trip() {
        let schema = simple_schema();
        let engine = MutationEngine::new("surr_test".to_string(), schema);

        // Two flushed segments, each with a per-row surrogate sidecar.
        let blob0: Vec<u8> = vec![0x4E, 0x44, 0x42, 0x53, 0xAA];
        let blob1: Vec<u8> = vec![0x4E, 0x44, 0x42, 0x53, 0xBB];
        let surrogates: FlushedSurrogateTable = vec![
            vec![Some(Surrogate::new(10)), None, Some(Surrogate::new(12))],
            vec![Some(Surrogate::new(20))],
        ];

        let snap = engine
            .export_snapshot(&[blob0.clone(), blob1.clone()], &surrogates)
            .expect("export");
        assert_eq!(snap.flushed_segments.len(), 2);
        assert_eq!(snap.flushed_surrogates.len(), 2);

        let bytes = zerompk::to_msgpack_vec(&snap).expect("serialize");
        let snap2: ColumnarEngineSnapshot = zerompk::from_msgpack(&bytes).expect("deserialize");
        let (_, flushed, flushed_surrogates) =
            MutationEngine::from_snapshot(snap2).expect("from_snapshot");

        assert_eq!(flushed, vec![blob0, blob1]);
        assert_eq!(flushed_surrogates, surrogates);
    }

    #[test]
    fn missing_flushed_surrogates_decode_empty() {
        // Backward-compat: a snapshot encoded WITHOUT the `flushed_surrogates`
        // field (e.g. a pre-surrogate snapshot) must decode into an empty
        // surrogate sidecar via `#[msgpack(default)]` / `#[serde(default)]`,
        // even when it carries non-empty flushed segments.
        let schema = simple_schema();
        let engine = MutationEngine::new("compat_test".to_string(), schema);

        let blob: Vec<u8> = vec![0x4E, 0x44, 0x42, 0x53, 0x01];

        // Export WITH a segment but WITHOUT any surrogate sidecar, then clear
        // the surrogate field to mimic an old-shape encoding that lacks it.
        let mut snap = engine
            .export_snapshot(std::slice::from_ref(&blob), &[])
            .expect("export");
        snap.flushed_surrogates.clear();

        let bytes = zerompk::to_msgpack_vec(&snap).expect("serialize");
        let snap2: ColumnarEngineSnapshot = zerompk::from_msgpack(&bytes).expect("deserialize");

        // Field defaults to empty; segments still present (no equal-length req).
        assert!(snap2.flushed_surrogates.is_empty());
        assert_eq!(snap2.flushed_segments.len(), 1);

        let (_, flushed, flushed_surrogates) =
            MutationEngine::from_snapshot(snap2).expect("from_snapshot");
        assert_eq!(flushed.len(), 1);
        assert!(flushed_surrogates.is_empty());
    }
}