1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright The Infino Authors
//! `Supertable` + `SupertableReader` — the in-memory handle.
//!
//! `Supertable::create(opts).expect("create")` returns a clone-shared handle holding
//! an empty initial manifest behind `ArcSwap<ManifestSnapshot>`.
//! `Supertable::reader()` does `ArcSwap::load_full` once and pins
//! the resulting `Arc<ManifestSnapshot>` for the reader's lifetime, so a
//! reader captured before a commit keeps seeing pre-commit state
//! even after the writer has swapped in a new manifest.
//!
//! `SupertableInner.writer_outstanding: AtomicBool` is the
//! single-writer slot — the writer flips it true on acquisition
//! and (via `Drop`) flips it false on release.
use std::{
collections::{HashMap, HashSet},
fmt,
future::Future,
sync::{Arc, Mutex, OnceLock, Weak, atomic::AtomicBool},
time::{Duration, Instant},
};
use arc_swap::ArcSwap;
use arrow_schema::SchemaRef;
use chrono::Utc;
use datafusion::{execution::context::SessionContext, logical_expr::LogicalPlan};
use tokio::runtime::Runtime;
use tracing::{debug, warn};
use super::{
error::{BuildError, CommitError, OpenError},
hidden_deleted::{self, HiddenDeletedError},
manifest::{
ManifestSnapshot,
list::{CellRoutingParams, PartitionStrategy},
},
options::SupertableOptions,
};
use crate::{
config,
runtime_bridge::{bridge_on_runtime, bridge_sync_to_async, shared_io_runtime},
runtime_metrics::op_stats::{self, OpStatsCollector},
storage::{PrefixedStorageProvider, StorageError},
superfile::{
builder::VectorConfig,
vector::{kmeans::kmeans, rerank_codec::RerankCodec},
},
supertable::{
ManifestLoadError, SuperfileUri, SupertableStats,
manifest::commit::{PointerProbe, probe_pointer, read_pointer},
options::Consistency,
query::{
scalar_cache::DecodedScalarCache,
sql::{SqlSchemas, build_sql_schemas},
},
reader_cache::disk::{DiskCacheError, skip_background_fill},
stats::process_rss_bytes,
tombstones::{SidecarCache, TombstoneSeqView, cache::DEFAULT_SEAL_TTL},
utils::idgen::IdGenerator,
wal::{
WalStore, gc,
lease::DEFAULT_LEASE_DURATION,
recovery::{RecoveryError, RecoveryReport, scan_and_recover},
},
},
};
/// Top-level handle. Cheap to clone (one `Arc::clone`); all clones
/// share the same `SupertableInner`. Hand a clone to each thread
/// that wants to read or to acquire the writer.
#[derive(Clone)]
pub struct Supertable {
inner: Arc<SupertableInner>,
}
/// Internal shared state. Every `Supertable` clone holds one Arc
/// pointing at the same `SupertableInner`. The writer module
/// reaches in to mutate `manifest` (via `ArcSwap::store`) on
/// commit and to manipulate `writer_outstanding` for the
/// single-writer slot enforcement.
pub(super) struct SupertableInner {
/// Schema, FTS columns, vector columns, tokenizer, thread
/// pools, superfile store, commit threshold. Immutable for
/// the supertable's lifetime; shared via Arc so readers,
/// the writer, and rayon shard workers all see the same
/// instances without copying.
pub(super) options: Arc<SupertableOptions>,
/// The current point-in-time view of which superfiles exist.
/// Each commit publishes a new ManifestSnapshot via ArcSwap::store;
/// readers do ArcSwap::load_full at construction to pin a
/// snapshot for the duration of their queries.
pub(super) manifest: ArcSwap<ManifestSnapshot>,
/// Single-writer slot: the writer flips this true on
/// acquisition (via compare-exchange) and (via Drop) flips
/// it false on release. Atomic flag, not a lock — never
/// blocks; never starves; the slot simply rejects a second
/// concurrent `Supertable::writer()` call until the first
/// writer is dropped.
pub(super) writer_outstanding: AtomicBool,
/// Single-compaction slot. Same acquire/release pattern as
/// `writer_outstanding`. Prevents concurrent `compact()` calls
/// within the same process from racing on seals and manifest
/// writes. Cross-process coordination happens at the sidecar-seal
/// level.
pub(super) compaction_outstanding: AtomicBool,
/// Generator for the supertable-injected `_id` column.
/// Each `append()` locks the mutex once, mints
/// `batch.num_rows()` ids, and unlocks. The
/// writer-slot lock already serializes `append()` per
/// supertable handle, so this mutex is uncontended in
/// practice; it's present only because ferroid's
/// `BasicSnowflakeGenerator` is `!Sync` by design (it
/// uses interior-mutable `Cell`). One generator per
/// supertable, constructed fresh on `create()` /
/// `open()` with a 40-bit random worker_id.
pub(super) id_generator: Mutex<IdGenerator>,
/// Cached `SessionContext` for `query_sql`, keyed on the
/// manifest `Arc` it was built against. Building one is
/// ~1.5 ms (default optimizer rules + 3 TVF re-registrations
/// + provider register), so reusing it across queries on the
/// same snapshot is a large speedup for warm BM25 / vector
/// SQL where the kernel itself runs in microseconds.
///
/// Invalidation is automatic: every commit publishes a new
/// `Arc<ManifestSnapshot>` via `manifest.store(...)`, so on the next
/// `query_sql` the `Arc::ptr_eq` check fails and the cache
/// is rebuilt against the fresh snapshot.
pub(super) sql_session_cache: Mutex<Option<(Arc<ManifestSnapshot>, SessionContext)>>,
/// Deterministic scalar SQL logical plans keyed by statement text and
/// manifest identity. Physical plans are intentionally rebuilt so fresh
/// tombstone overlays and query-stable functions retain their semantics.
pub(super) sql_logical_plan_cache:
Mutex<Option<(Arc<ManifestSnapshot>, HashMap<String, LogicalPlan>)>>,
/// Bounded decoded-row cache shared by all readers of this immutable
/// supertable handle.
pub(super) decoded_scalar_cache: DecodedScalarCache,
/// Per-process reader-side cache of per-superfile tombstone
/// bitmaps. `Some` when storage is attached (the cache
/// fetches sidecars from `superfiles/<id>.tombstones`);
/// `None` for in-memory-only supertables where no sidecars
/// can exist. Query paths read through this cache before
/// returning per-superfile hits; writers invalidate cached
/// entries after each successful sidecar CAS-PUT.
pub(super) tombstone_cache: Option<Arc<SidecarCache>>,
/// Fresh `supertable_handle_id` minted at handle
/// construction. Used as the `lease.owner` identifier on
/// every WAL this process drives. Not the OS PID — we need
/// uniqueness across restarts on the same PID AND across
/// multiple handles within one process (a process that
/// opens five supertables holds five distinct ids). Minted
/// via `IdGenerator::next_id()` once at create / open.
pub(super) handle_id: crate::supertable::wal::state_doc::SupertableHandleId,
/// Hidden sibling supertable storing vectors only, partitioned by
/// global centroids so unfiltered search can route by nearest cell.
pub(super) vector_index_table: Option<Arc<Supertable>>,
/// Set once at open when the hidden vector index is **configured and
/// materialized** (its storage pointer exists) but fails to load/open — i.e.
/// present-but-broken, distinct from never-configured or not-yet-drained
/// (both leave `vector_index_table = None` with this unset). Vector search
/// errors on a broken index rather than silently brute-scanning the user
/// table; a genuinely absent index still falls back. Unset for the hidden
/// table's own inner (no nested index).
pub(super) hidden_index_open_error: std::sync::OnceLock<String>,
/// Last time the read path checked the storage manifest pointer
/// for freshness, under [`Consistency::BoundedStaleness`]. `None`
/// until the first check (so the first query always refreshes).
/// Unused for [`Consistency::Strong`] (always checks) and
/// [`Consistency::Snapshot`] (never checks).
pub(super) last_pointer_check: Mutex<Option<Instant>>,
/// Etag of the manifest pointer from this handle's last storage
/// probe. Powers the conditional (`If-None-Match`) freshness
/// probe in [`Supertable::refresh`]: an unchanged pointer answers
/// as a bodyless 304 instead of a full read. `None` until the
/// first probe, and stale right after this process's own commits
/// (which rewrite the pointer without capturing its new etag) —
/// the next probe then takes the full-read path and re-seeds it.
pub(super) last_pointer_etag: Mutex<Option<String>>,
/// Set once this handle's pointer is seen deleted — its table was dropped
/// and purged elsewhere. Latched: the handle can only be discarded, and
/// `Connection::open_table` checks this before serving it from cache.
pub(super) pointer_vanished: OnceLock<()>,
/// Cached SQL schemas, built once from the immutable `options` (lock-free
/// lazy init). A pure function of the schema, so no snapshot invalidation
/// (unlike `sql_session_cache`). See [`SqlSchemas`].
pub(super) sql_schemas: OnceLock<Arc<SqlSchemas>>,
/// Decoded hidden deleted-`_id` set, cached per hidden manifest version.
/// The set is a deliberate duplicate of the user-table tombstones, carried
/// INLINE in the hidden manifest so hidden vector search drops deleted rows
/// from resident bytes instead of GETting the user table's tombstones on
/// every query. Caching only adds the `SidecarCache`-style discipline on
/// top: decode the inline bytes once per manifest version, not once per
/// query. Keyed by `manifest_id`, which bumps on every deleted-id stamp.
pub(super) hidden_deleted_cache: Mutex<Option<(u64, Arc<Vec<i128>>)>>,
}
impl SupertableInner {
/// Runtime driving the sync API's async kernels when the caller
/// isn't already on a tokio runtime. Process-wide — see
/// [`shared_query_runtime`].
pub(super) fn query_runtime(&self) -> Arc<Runtime> {
shared_io_runtime()
}
/// Latch the purged observation when a commit's pointer fence finds the
/// pointer gone, so this handle reads as dead to
/// [`Supertable::pointer_vanished`] no matter which path noticed first.
///
/// The read path's freshness probe is otherwise the only writer of that
/// latch, which leaves a handle that has only ever *written* permanently
/// stuck: the commit refuses correctly, but nothing marks the handle, so
/// the catalog keeps serving it from cache and every later commit fences
/// against a location a re-create has already replaced. Non-vanish errors
/// are left alone — contention and storage faults are recoverable, and
/// this latch never clears.
pub(super) fn note_commit_error(&self, err: &CommitError) {
if matches!(err, CommitError::PointerVanished) {
let _ = self.pointer_vanished.set(());
}
}
/// The table's cached SQL schemas, built once from the immutable options.
/// Cheap `Arc` clone on every call after the first.
pub(super) fn sql_schemas(&self) -> Arc<SqlSchemas> {
Arc::clone(
self.sql_schemas
.get_or_init(|| Arc::new(build_sql_schemas(&self.options))),
)
}
/// Push the current manifest's tombstone-seq view into the
/// sidecar cache. Called wherever a newer manifest is swapped
/// into `self.manifest` (refresh, commit, mutation stamp) so the
/// cache's freshness authority tracks the snapshot readers pin.
/// No-op when the cache's view is already at (or past) the
/// current manifest — the common every-query case, kept clone-free.
pub(crate) fn reconcile_tombstone_seqs(&self) {
let Some(cache) = self.tombstone_cache.as_ref() else {
return;
};
let manifest = self.manifest.load();
if manifest.manifest_id <= cache.view_manifest_id() {
return;
}
cache.reconcile(tombstone_seq_view(&manifest));
}
/// Re-read the manifest pointer from storage and advance this supertable's in-memory state to
/// whatever it now names.
///
/// The pointer is probed with the last etag this handle saw, so an unchanged pointer answers
/// without a body. When it has advanced, the new manifest list is loaded, the parts that did
/// not change are inherited from the current `ManifestSnapshot` by content hash, only the
/// newly-referenced parts are fetched, and the resulting `ManifestSnapshot` is swapped in.
/// A `SupertableReader` built before the swap keeps the snapshot it pinned and never sees it.
///
/// Three outcomes:
///
/// - i) `Ok(true)` when a newer manifest was loaded and swapped in.
/// - ii) `Ok(false)` when there was nothing newer to load, either because the pointer had not
/// moved or because this process's own commit already put that version in memory.
/// - iii) `Err(PointerVanished)` when the pointer is gone, which also latches
/// `pointer_vanished` on this handle.
///
/// Lives on the inner because the deferred storage reclaim holds only an `Arc<SupertableInner>`
/// and still has to resolve the committed manifest when it fires.
/// [`Supertable::refresh`] is the handle-level spelling of the same call.
pub(super) async fn refresh(&self) -> Result<bool, ManifestLoadError> {
let storage = self
.options
.storage
.as_ref()
// With no storage attached there is no pointer to refresh against. The read path stops
// before this (`pointer_refresh_due` is false without storage), so only a direct caller
// ever sees the error.
.ok_or(ManifestLoadError::NoLoaderAttached)?
.clone();
// Probing with the last-seen etag keeps the steady-state cost of a freshness check at one
// roundtrip: an unchanged pointer answers as a bodyless 304, with nothing to transfer or
// parse.
let prev_etag = self
.last_pointer_etag
.lock()
.expect("last_pointer_etag mutex poisoned")
.clone();
let probe = probe_pointer(storage.as_ref(), prev_etag.as_deref()).await?;
let (pointer, meta) = match probe {
// An absent pointer means the table was dropped and purged, never that it has not been
// committed yet: this handle exists, and every path that builds one over storage
// already has a pointer by then, since `open` fails with `PointerNotFound` without one
// and `create` publishes an empty manifest first.
PointerProbe::Absent => {
let _ = self.pointer_vanished.set(());
return Err(ManifestLoadError::PointerVanished);
}
PointerProbe::NotModified => return Ok(false),
PointerProbe::Read(pointer, meta) => (pointer, meta),
};
// The etag is recorded only once this pointer version has actually been accounted for,
// meaning after a successful load or when the in-memory state already covers it. Recording
// it before the load would leave the etag ahead of the snapshot whenever the load fails,
// say because a manifest is not yet visible to this process, and the next conditional probe
// would then answer `NotModified` and never retry. That pins the handle to the pre-commit
// manifest and serves its rows as empty, for good.
let current = self.manifest.load_full();
let manifest = match ManifestSnapshot::load_with_pointer(
Some(current),
storage,
None,
pointer,
)
.await
{
Ok(manifest) => manifest,
// The pointer moved but the in-memory state already covers that version, which is what
// this process's own commit leaves behind. Nothing newer to load, so record the etag
// and let the next probe be a cheap 304.
Err(ManifestLoadError::AlreadyLoaded) => {
*self
.last_pointer_etag
.lock()
.expect("last_pointer_etag mutex poisoned") = meta.etag.clone();
return Ok(false);
}
// Leaving the etag unchanged on a failed load is what makes the next probe read the
// pointer again and retry, instead of short-circuiting to a 304.
Err(err) => return Err(err),
};
self.manifest.store(manifest);
self.reconcile_tombstone_seqs();
*self
.last_pointer_etag
.lock()
.expect("last_pointer_etag mutex poisoned") = meta.etag.clone();
debug!(
manifest_id = self.manifest.load().manifest_id,
"refreshed manifest"
);
Ok(true)
}
}
impl Supertable {
// Interim options-based constructor — not on the curated public surface
// (the catalog `create_table` supersedes it). `pub` under `test-helpers`
// so tests/benches reach it directly; `pub(crate)` otherwise, where the
// catalog `Connection` calls it internally.
test_visible! {
/// Create-or-open from validated options.
///
/// Behaviour:
///
/// - **No storage attached** → fresh in-memory handle, no
/// I/O. Empty manifest; recovery is a no-op.
/// - **Storage attached, no pointer file** → fresh
/// storage-backed handle. Empty manifest; recovery sweep
/// runs in case prior peer processes left stray WALs.
/// - **Storage attached, pointer file present** →
/// transparently delegates to [`Supertable::open`]. Loads
/// the existing manifest list + parts and runs the
/// recovery sweep. This closes the "create silently
/// shadows existing committed state" footgun.
///
/// Sync API. Internally bridges to async I/O for the
/// pointer probe + the open delegation via the same
/// `Handle::try_current() + block_in_place` pattern the
/// rest of the supertable's sync paths use. Works from
/// sync `#[test]` contexts and from multi-thread
/// `#[tokio::test]` contexts. In-memory creates avoid the
/// open-time sweep bridge entirely because no WAL/GC I/O can
/// exist without attached storage.
fn create(options: SupertableOptions) -> Result<Self, OpenError> {
bridge_sync_to_async(Self::create_async(options))
}
}
// Interim options-based open — internal counterpart of `create`; the
// catalog `Connection` calls it internally, tests/benches reach it via
// `test-helpers`.
test_visible! {
/// Open a persisted supertable.
///
/// Reads the pointer file at
/// `<root>/_supertable/current` via the storage provider
/// attached on `options`, parses the manifest list, and
/// eager-fetches every manifest part in parallel (the default;
/// `options.eager_load_threshold_parts` below the part count opts
/// into lazy loading). Open therefore scales with manifest size,
/// and queries on the returned handle pay no serial manifest GETs.
/// The returned `Supertable` is ready to serve queries from the
/// snapshot at the pointer's `manifest_id`.
///
/// A genuinely absent pointer is a [`ManifestLoadError::PointerNotFound`]
/// error, not an empty table: `create` persists the initial pointer, so
/// a registered table always has one, and a missing pointer is the
/// open-or-create trigger (or a lost pointer) — surfaced, never masked
/// as a silently-empty table.
///
/// Errors:
/// - [`OpenError::ManifestLoadError`] for manifest load failures,
/// including a missing pointer (`PointerNotFound`), parse, corruption,
/// or fetch.
/// - [`OpenError::Build`] if `options.storage` is `None`
/// (open requires a storage backend).
/// - [`OpenError::Storage`], [`OpenError::ManifestListParse`],
/// [`OpenError::ContentHashMismatch`],
/// [`OpenError::ManifestPartLoad`] for fetch / parse
/// failures.
///
/// Sync public API. Internally bridges to the async storage I/O
/// via the same `Handle::try_current() + block_in_place` pattern
/// as the rest of the supertable's sync surface.
fn open(options: SupertableOptions) -> Result<Self, OpenError> {
bridge_on_runtime(Self::open_async(options), &shared_io_runtime())
}
}
/// Async open kernel. Sync [`Supertable::open`] bridges here.
pub(crate) async fn open_async(options: SupertableOptions) -> Result<Self, OpenError> {
let storage = options
.storage
.as_ref()
.ok_or_else(|| {
OpenError::Build(BuildError::Store(
"Supertable::open requires options.storage; \
attach via .with_storage(...) before calling open"
.into(),
))
})?
.clone();
let options_arc = Arc::new(options);
let manifest = ManifestSnapshot::load(None, storage, Some(options_arc.clone())).await?;
// Resolve the hidden vector index into one of three states:
// * Present — configured, materialized, opened → `Some(handle)`.
// * Absent — not configured, or configured but no pointer yet
// (pre-first-drain) → `None`, no error. Queries fall back
// to the user table (its rows are the source of truth).
// * Broken — configured and materialized (pointer exists) but the
// manifest/table won't load/open → `None` + an error.
// Vector queries surface the error instead of silently
// brute-scanning the user table.
let (vector_index_table, hidden_index_broken) = if let Some(hidden_opts) =
build_vector_index_options(options_arc.as_ref(), Some(manifest.as_ref()), None)
{
let hidden_storage = hidden_opts.storage.clone().ok_or_else(|| {
OpenError::Build(BuildError::Store(
"VectorIndexSuperTable requires options.storage".into(),
))
})?;
match read_pointer(&*hidden_storage).await {
Ok(Some(_)) => {
let hidden_arc = Arc::new(hidden_opts);
match ManifestSnapshot::load(None, hidden_storage, Some(hidden_arc.clone()))
.await
{
Ok(hidden_manifest) => {
match open_table_async(hidden_arc, hidden_manifest, None).await {
Ok(t) => (Some(Arc::new(t)), None),
Err(e) => {
warn!(
"supertable: hidden vector-index table failed to open: {e}"
);
(None, Some(e.to_string()))
}
}
}
Err(e) => {
warn!("supertable: hidden vector-index manifest failed to load: {e}");
(None, Some(e.to_string()))
}
}
}
// A consumer-memory-mode handle must not bootstrap-create the
// sibling: its user summaries hydrate stripped, so the grid
// can't be trained here and the create would durably stamp a
// default (non-VectorCell) partition strategy. Absent is
// correct — queries fall back to the user fan until a writer
// handle materializes the index.
Ok(None) if options_arc.summary_centroids_from_superfiles => (None, None),
Ok(None) => match create_table_async(hidden_opts, None, None).await {
Ok(table) => (Some(Arc::new(table)), None),
Err(e) => {
// Surface a genuine bootstrap failure as Broken (carry the
// error) rather than Absent, matching the sibling arms —
// otherwise a storage fault silently degrades to full scan.
warn!("supertable: hidden vector-index bootstrap-create failed: {e}");
(None, Some(e.to_string()))
}
},
Err(e) => {
warn!("supertable: hidden vector-index pointer unreadable: {e}");
(None, Some(e.to_string()))
}
}
} else {
(None, None)
};
let handle = open_table_async(options_arc, manifest, vector_index_table).await?;
if let Some(err) = hidden_index_broken {
let _ = handle.inner.hidden_index_open_error.set(err);
}
// The manifests are loaded now, so the attached disk cache can be
// sized against the real footprint (user + hidden index) instead
// of whatever fixed default it was constructed with.
handle.reconcile_cache_budget();
debug!(
manifest_id = handle.inner.manifest.load().manifest_id,
"opened supertable"
);
Ok(handle)
}
/// Async create kernel. Sync [`Supertable::create`] bridges here.
pub(crate) async fn create_async(options: SupertableOptions) -> Result<Self, OpenError> {
if let Some(storage) = options.storage.as_ref() {
let probe = Arc::clone(storage);
match read_pointer(&*probe).await {
Ok(Some(_pointer)) => return Self::open_async(options).await,
Ok(None) => {}
Err(e) => {
return Err(OpenError::Storage(StorageError::Permanent {
uri: "_supertable/current".into(),
source: Box::new(std::io::Error::other(format!("{e}"))),
}));
}
}
}
let vector_index_storage_prefix = if options.vector_columns.is_empty() {
None
} else {
Some(generate_vector_index_storage_prefix())
};
let vector_index_table = if let Some(ref prefix) = vector_index_storage_prefix {
if let Some(hidden_opts) =
build_vector_index_options(&options, None, Some(prefix.as_str()))
{
Some(Arc::new(
create_table_async(hidden_opts, None, Some(prefix.clone())).await?,
))
} else {
None
}
} else {
None
};
create_table_async(options, vector_index_table, vector_index_storage_prefix).await
}
/// Re-read the manifest pointer from storage and advance this supertable to whatever it names.
/// See [`SupertableInner::refresh`] for the mechanism and the three outcomes.
///
/// Not a public verb, despite the name. Freshness is engine-driven through
/// [`Supertable::ensure_fresh`] on the read path and governed by
/// [`crate::supertable::options::Consistency`]; this is the call underneath that drives the
/// pointer re-check.
pub(crate) async fn refresh(&self) -> Result<bool, ManifestLoadError> {
self.inner.refresh().await
}
/// Current manifest's id, without pinning a reader. Useful for
/// observability + tests that want to assert "a commit
/// happened" without holding a snapshot.
#[cfg(any(test, feature = "test-helpers"))]
pub fn manifest_id(&self) -> u64 {
self.inner.manifest.load().manifest_id
}
test_visible! {
/// Pinned reader. Captures the current manifest at construction
/// and holds it for its lifetime. New commits don't affect a
/// live reader; closing + reopening picks up later commits.
///
/// Applies the read-consistency policy ([`Supertable::ensure_fresh`])
/// before pinning, so the reader observes the freshest manifest
/// the configured
/// [`Consistency`](crate::supertable::options::Consistency) allows.
/// No-op for an in-memory supertable and under `Snapshot`.
///
/// Fails with [`ManifestLoadError::PointerVanished`] once the freshness
/// check above finds this handle's table dropped and purged. Pinning past
/// that point serves rows of a table that no longer exists: the snapshot
/// still names the deleted superfiles, and a warm disk cache answers from
/// bytes the purge removed, so the reads succeed silently for as long as
/// the handle is held. Callers that resolve by name recover on their next
/// lookup; one holding this handle has nothing to re-resolve, so refusing
/// is the only correct answer.
fn reader(&self) -> Result<SupertableReader, ManifestLoadError> {
self.ensure_fresh()?;
if self.pointer_vanished() {
return Err(ManifestLoadError::PointerVanished);
}
Ok(self.pinned_reader())
}
}
test_visible! {
/// Pin the current in-memory manifest without a storage freshness check.
/// Hidden vector queries use this for slow-state residency while their
/// fast delete/watermark refresh runs concurrently with data I/O.
///
/// Consults the caller's [`with_op_stats`] scope — valid only on the
/// thread that opened the scope, which the public search entry points
/// (reader mint on the caller's thread) satisfy. Mid-query mints run
/// on runtime threads where the scope's thread-local is invisible, so
/// they go through [`Self::pinned_reader_with`] and inherit the outer
/// reader's collector instead.
fn pinned_reader(&self) -> SupertableReader {
self.pinned_reader_with(op_stats::current())
}
}
/// [`Self::pinned_reader`] with an explicitly supplied per-query
/// collector — the mint for readers created *mid-query* (the hidden
/// vector-index legs), which must inherit the driving reader's
/// collector rather than consult a thread-local that runtime threads
/// never see.
pub(crate) fn pinned_reader_with(
&self,
op_stats: Option<Arc<OpStatsCollector>>,
) -> SupertableReader {
SupertableReader {
manifest: self.inner.manifest.load_full(),
tombstone_cache: self.inner.tombstone_cache.clone(),
inner: Arc::clone(&self.inner),
op_stats,
}
}
test_visible! {
fn vector_index_table(&self) -> Option<&Arc<Supertable>> {
self.inner.vector_index_table.as_ref()
}
}
test_visible! {
/// Hidden vector-index storage prefix recorded on the user manifest.
/// Exposed only to tests/benches that explicitly administer derived state.
fn vector_index_storage_prefix(&self) -> Option<String> {
self.inner
.manifest
.load()
.vector_index_storage_prefix()
.map(str::to_owned)
}
}
/// Decide whether this handle's consistency policy requires a pointer read
/// now. Bounded-staleness callers share the timestamp so concurrent query
/// paths cannot stampede storage.
fn pointer_refresh_due(&self) -> bool {
if self.inner.options.storage.is_none() {
return false;
}
match self.inner.options.read_consistency {
Consistency::Snapshot => false,
Consistency::Strong => true,
Consistency::BoundedStaleness(window) => {
// Decide whether a check is due under the lock, stamp
// "now" optimistically so concurrent queries don't all
// stampede the pointer, then release the lock before I/O.
{
let mut last = self
.inner
.last_pointer_check
.lock()
.expect("last_pointer_check mutex poisoned");
let due = last.map(|t| t.elapsed() >= window).unwrap_or(true);
if due {
*last = Some(Instant::now());
}
due
}
}
}
}
/// Async form used when freshness is one branch of a query I/O wave.
/// Best-effort: a failed pointer read leaves the current snapshot in place.
pub(crate) async fn ensure_fresh_async(&self) {
if self.pointer_refresh_due() {
let _ = self.refresh().await;
}
}
/// Engine-driven read-path freshness. Applies
/// `options.read_consistency` ([`crate::supertable::options::Consistency`]):
/// re-checks the storage manifest pointer and advances the
/// in-memory snapshot when a newer `manifest_id` is published, so
/// the next [`Supertable::reader`] sees committed data without the
/// application ever calling refresh by hand.
///
/// Called at the head of every public query method. No-op for an
/// in-memory supertable (no storage pointer) and for
/// [`Consistency::Snapshot`](crate::supertable::options::Consistency::Snapshot).
///
/// Failure handling is governed by the consistency level. Under
/// [`Consistency::Strong`](crate::supertable::options::Consistency::Strong)
/// a failed pointer re-check is surfaced as an error: Strong promises a
/// fresh manifest on every query, so if that check can't complete the
/// caller must be told rather than silently served a pinned older
/// snapshot — which, for a handle pinned before a commit it hasn't yet
/// observed, would return that commit's rows as an empty result. Under
/// [`Consistency::BoundedStaleness`](crate::supertable::options::Consistency::BoundedStaleness)
/// and `Snapshot`, staleness is acceptable by contract, so a failed probe
/// leaves the current snapshot in place and only logs.
pub(crate) fn ensure_fresh(&self) -> Result<(), ManifestLoadError> {
if !self.pointer_refresh_due() {
return Ok(());
}
if let Err(e) = bridge_on_runtime(self.refresh(), &self.query_runtime()) {
if self.inner.options.read_consistency == Consistency::Strong {
return Err(e);
}
debug!(error = %e, "manifest refresh failed; serving current snapshot");
}
Ok(())
}
/// Force the in-memory snapshot to the latest committed manifest,
/// regardless of `read_consistency`, surfacing a failed pointer probe as
/// an error (like [`Consistency::Strong`]) rather than serving the current
/// snapshot.
///
/// This is the freshness a *mutation* resolves its target set against.
/// [`ensure_fresh`](Self::ensure_fresh) honors `read_consistency`, so under
/// [`Consistency::BoundedStaleness`] it may leave the snapshot behind a
/// peer's commit. Resolving an update/delete predicate against such a
/// snapshot would miss a row committed after it and silently drop that
/// row's tombstone — a lost delete, or an update that leaves the old
/// version live beside the new one. The target set must instead agree with
/// the manifest the commit will CAS onto, so mutations always resolve
/// against the latest, independent of the read policy. Bounded staleness is
/// a read-latency contract for queries; it must never cause a write to lose
/// data.
pub(crate) fn ensure_fresh_strong(&self) -> Result<(), ManifestLoadError> {
if self.inner.options.storage.is_none() {
return Ok(());
}
bridge_on_runtime(self.refresh(), &self.query_runtime())?;
Ok(())
}
/// A reader pinned to the latest committed manifest (force-refreshed via
/// [`ensure_fresh_strong`](Self::ensure_fresh_strong)), for resolving a
/// mutation's target set. Unlike [`reader`](Self::reader) this ignores
/// `read_consistency` — see `ensure_fresh_strong` for why mutations must
/// resolve against the latest manifest.
pub(crate) fn reader_strong(&self) -> Result<SupertableReader, ManifestLoadError> {
self.ensure_fresh_strong()?;
if self.pointer_vanished() {
return Err(ManifestLoadError::PointerVanished);
}
Ok(self.pinned_reader())
}
/// Whether this handle's table was dropped and purged elsewhere, seen as
/// its pointer disappearing during a freshness check. [`Self::ensure_fresh`]
/// swallows errors by design, so this latch is how that fact escapes.
pub(crate) fn pointer_vanished(&self) -> bool {
self.inner.pointer_vanished.get().is_some()
}
test_visible! {
/// Per-supertable configuration (schema, FTS / vector columns,
/// tokenizer). Immutable for the supertable's lifetime.
fn options(&self) -> &Arc<SupertableOptions> {
&self.inner.options
}
}
/// The user-facing Arrow schema — the columns the caller supplied.
/// The auto-injected `_id` is not part of this schema.
///
/// ```
/// # use std::sync::Arc;
/// # use infino::arrow_schema::{DataType, Field, Schema};
/// # use infino::{connect, IndexSpec};
/// # let db = connect("memory://")?;
/// # let schema = Arc::new(Schema::new(vec![Field::new("body", DataType::LargeUtf8, false)]));
/// # let posts = db.create_table("posts", schema, IndexSpec::new().fts("body"))?;
/// assert_eq!(posts.schema().field(0).name(), "body");
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn schema(&self) -> SchemaRef {
self.inner.options.user_schema()
}
/// Cached per-table SQL schemas (scan view + scalar schema).
pub(crate) fn sql_schemas(&self) -> Arc<SqlSchemas> {
self.inner.sql_schemas()
}
/// Sync→async bridge for the public query surface. Mirrors the
/// runtime handling in [`Supertable::query_sql`]: when a caller is
/// already on a `multi_thread` runtime, reuse it via
/// `block_in_place`; otherwise drive the future on the lazily-built
/// `query_runtime`. Lets `vector_search` / `bm25_search` /
/// `bm25_search_prefix` present a sync public API over the async
/// `SupertableReader` kernels without spinning a throwaway runtime
/// per call.
pub(crate) fn block_on_query<F: Future>(&self, fut: F) -> F::Output {
bridge_on_runtime(fut, &self.query_runtime())
}
/// Route undrained user superfiles into the hidden per-cell index. Not part
/// of the public API — [`Supertable::optimize`] calls this before compact;
/// tests and benches may invoke it directly via
/// [`Supertable::drain_vectors_to_cells_sync`].
pub(crate) fn drain_hidden_vector_cells_sync(&self) -> Result<(), BuildError> {
let Some(hidden) = self.inner.vector_index_table.as_ref() else {
return Ok(());
};
bridge_on_runtime(
super::writer::drain_user_superfiles_to_hidden_cells(
Arc::clone(&self.inner),
Arc::clone(&hidden.inner),
),
&self.query_runtime(),
)?;
// The drain writes the hidden per-cell index — roughly a second
// copy of the vector payload — so the cache budget floor moves.
self.reconcile_cache_budget();
Ok(())
}
/// Total on-storage bytes of the committed superfiles across the user
/// table and the hidden vector-index table.
///
/// Loads every lazy manifest part first (user + hidden index) so cold
/// handles do not under-report. Prefer this for billing / Grafana scrapes;
/// the resident-only footprint helper used for cache-budget reconcile can
/// still under-count unloaded parts by design.
#[cfg(any(test, feature = "test-helpers", feature = "metering"))]
pub fn storage_bytes(&self) -> Result<u64, OpenError> {
let user = self.loaded_storage_footprint_bytes()?;
let hidden = match self.inner.vector_index_table.as_ref() {
Some(h) => h.loaded_storage_footprint_bytes()?,
None => 0,
};
Ok(user.saturating_add(hidden))
}
/// Sum `subsection_offsets.total_size` after loading all manifest parts.
#[cfg(any(test, feature = "test-helpers", feature = "metering"))]
fn loaded_storage_footprint_bytes(&self) -> Result<u64, OpenError> {
let manifest = self.inner.manifest.load_full();
let entries = self
.block_on_query(manifest.get_all_superfiles_loaded())
.map_err(OpenError::ManifestLoadError)?;
Ok(entries
.iter()
.filter_map(|entry| entry.subsection_offsets.as_ref())
.fold(0u64, |acc, offsets| acc.saturating_add(offsets.total_size)))
}
/// Total on-storage bytes of the committed superfiles across the user
/// table and the hidden vector-index table, from the currently loaded
/// manifest views (lazy, not-yet-loaded manifest parts contribute 0 —
/// the reconcile below is raise-only, so an undercount is safe).
pub(crate) fn on_storage_footprint_bytes(&self) -> u64 {
let table_bytes = |inner: &SupertableInner| -> u64 {
inner
.manifest
.load_full()
.superfiles
.iter()
.filter_map(|e| e.subsection_offsets.as_ref())
.map(|o| o.total_size)
.sum()
};
let user = table_bytes(&self.inner);
let hidden = self
.inner
.vector_index_table
.as_ref()
.map(|h| table_bytes(&h.inner))
.unwrap_or(0);
user.saturating_add(hidden)
}
/// Reconcile the attached disk cache's budget with the table's current
/// on-storage footprint (user + hidden index + headroom). Called after
/// open — once the manifests are loaded — and again after the drain
/// grows the hidden index. Raise-only for engine-managed (auto-sized)
/// budgets; an explicit budget is never changed, but gets a one-shot
/// warning when the footprint exceeds it (steady-state reads would
/// churn the cache).
pub(crate) fn reconcile_cache_budget(&self) {
let Some(cache) = self.inner.options.disk_cache.as_ref() else {
return;
};
let footprint = self.on_storage_footprint_bytes();
if footprint == 0 {
return;
}
let floor = footprint.saturating_add(footprint / CACHE_BUDGET_HEADROOM_DIVISOR);
cache.reconcile_budget_floor(floor, footprint);
}
#[cfg(any(test, feature = "test-helpers"))]
test_visible! {
/// No-staging drain: build the hidden per-cell index by routing + splicing
/// the **user** superfiles' local clusters into cells (multi-cluster
/// fragments — inner pruning preserved). Called on the user-facing table
/// (it owns the hidden `vector_index_table`); benches invoke it between the
/// pre-drain and post-drain search phases.
fn drain_vectors_to_cells_sync(&self) -> Result<(), BuildError> {
self.drain_hidden_vector_cells_sync()
}
}
#[cfg(any(test, feature = "test-helpers"))]
test_visible! {
/// Split the busiest populated hidden cell (modality trigger off, so any
/// cell with ≥ 2 live rows splits). Crash-test entry: the split fns are
/// `pub(in crate::supertable)` and the production trigger needs a cell
/// past the 500k `cell_split_doc_cap` — this reaches the batched split
/// commit from an integration test without that volume. Returns whether
/// a split committed.
fn split_busiest_hidden_cell_sync(&self) -> Result<bool, BuildError> {
let Some(hidden) = self.inner.vector_index_table.as_ref() else {
return Ok(false);
};
let manifest = hidden.inner.manifest.load_full();
if !matches!(
manifest.get_partition_strategy(),
PartitionStrategy::VectorCell { .. }
) {
return Ok(false);
}
// Physical postings, not grid counts: stamped counts can lag or
// fold in bootstrap-era routing, and a splittable cell needs real
// rows behind it.
let (scan_counts, _parents) = bridge_on_runtime(
super::writer::scan_cell_parents(&hidden.inner, &manifest, None),
&self.query_runtime(),
)?;
let busiest = scan_counts
.iter()
.filter(|&(_, &n)| n > 0)
.max_by_key(|&(_, &n)| n)
.map(|(&cell, _)| cell);
let Some(cell) = busiest else {
return Ok(false);
};
let outcome = bridge_on_runtime(
super::writer::split_overflow_cell(Arc::clone(&hidden.inner), cell, 0.0),
&self.query_runtime(),
)?;
Ok(outcome.is_some())
}
}
#[cfg(any(test, feature = "test-helpers"))]
test_visible! {
/// Bulk-repack every populated hidden cell (modality trigger off, so
/// any cell with ≥ 2 live rows splits). Crash-test entry to the
/// write-once repack path ([`split_repack_bulk`] is
/// `pub(in crate::supertable)` and the production trigger needs most of
/// the grid split-eligible). Returns how many cells committed a split.
fn repack_all_hidden_cells_sync(&self) -> Result<usize, BuildError> {
let Some(hidden) = self.inner.vector_index_table.as_ref() else {
return Ok(0);
};
let manifest = hidden.inner.manifest.load_full();
if !matches!(
manifest.get_partition_strategy(),
PartitionStrategy::VectorCell { .. }
) {
return Ok(0);
}
// Candidates from the same physical scan that builds the parent
// index — grid counts can name cells with no live postings.
let (scan_counts, parents_by_cell) = bridge_on_runtime(
super::writer::scan_cell_parents(&hidden.inner, &manifest, None),
&self.query_runtime(),
)?;
let mut candidates: Vec<(u32, u64)> = scan_counts
.iter()
.filter(|&(_, &n)| n > 0)
.map(|(&cell, &n)| (cell, n))
.collect();
candidates.sort_unstable_by_key(|&(cell, _)| cell);
if candidates.is_empty() {
return Ok(0);
}
let outcome = bridge_on_runtime(
super::writer::split_repack_bulk(
&hidden.inner,
&manifest,
candidates,
0.0,
&parents_by_cell,
),
&self.query_runtime(),
)?;
Ok(outcome
.per_cell
.iter()
.filter(|(_, result)| result.is_some())
.count())
}
}
/// Block until the disk cache has settled every background fill the
/// caller's own queries kicked off, or `timeout` elapses.
///
/// Scoped to in-flight work only: superfiles never opened, and opens
/// that don't spawn fills (vector), are not waited on — so a query on
/// a small working set settles fast regardless of table size.
/// Registering this waiter lets pending fills proceed even if another
/// handle still holds a lazy reader.
#[cfg(any(test, feature = "test-helpers"))]
pub fn wait_until_warm(&self, timeout: Duration) -> Result<(), DiskCacheError> {
let Some(cache) = self.inner.options.disk_cache.as_ref() else {
return Ok(());
};
if skip_background_fill() {
return Ok(());
}
let cache = Arc::clone(cache);
self.block_on_query(async move { cache.wait_until_fills_settled(timeout).await })
}
/// This handle's lease-owner id. Stamped on every WAL the
/// handle's recovery sweep / commit pipeline acquires.
/// Minted once at handle construction via `IdGenerator`;
/// distinct from every other handle in the process
/// (different `worker_id`) and from every prior process
/// (different `ms` timestamp). Test-only accessor — production
/// code reads `inner.handle_id` directly.
#[cfg(test)]
pub(crate) fn handle_id(&self) -> crate::supertable::wal::state_doc::SupertableHandleId {
self.inner.handle_id
}
/// Construct a [`Supertable`] handle wrapping an existing
/// `SupertableInner` arc. Internal-only: used by the writer
/// to hand a `Supertable` to the WAL pipeline functions
/// without re-running the full create-or-open flow. Skips
/// the open-time recovery sweep on purpose — the inner has
/// already been initialized.
pub(super) fn from_inner(inner: Arc<SupertableInner>) -> Self {
Self { inner }
}
/// Operator hatch: run one WAL recovery sweep against this
/// supertable's storage prefix. Useful for long-lived
/// handles that want bounded recovery latency without
/// restarting the process, and for integration tests that
/// pre-seed half-finished WALs and verify the sweep
/// completes them.
///
/// Returns `Ok(report)` with the per-outcome counts on
/// success; `Err(NoStorageAttached)` for in-memory-only
/// supertables (no WALs can exist there).
/// Not public API: WAL recovery is engine-driven — it runs
/// automatically on [`Supertable::open`]. This manual hook is a
/// crate internal used only by in-crate unit tests that pre-seed
/// half-finished WALs and assert the sweep completes them.
pub(crate) async fn run_recovery_sweep_once(&self) -> Result<RecoveryReport, RecoveryError> {
scan_and_recover(self, self.inner.handle_id, DEFAULT_LEASE_DURATION).await
}
/// Run one GC sweep over this supertable's `wal/mutations/` prefix.
/// Reaps `Complete` WALs older than the wal-grace window + orphan
/// `.arrow` sidecars older than the sidecar-grace window. Runs at
/// `Supertable::open`/`create` and again on every `optimize()` call.
/// Not public API: exposed only as a manual hook for in-crate tests
/// that need custom grace windows via `wal::gc::run_sweep` directly.
pub(crate) async fn run_gc_sweep_once(&self) -> Result<gc::GcReport, gc::GcError> {
gc::run_sweep(
self,
Utc::now(),
gc::DEFAULT_WAL_GRACE,
gc::DEFAULT_SIDECAR_GRACE,
)
.await
}
/// Sync-bridged version of [`run_gc_sweep_once`], for callers (like
/// [`Supertable::optimize`]) that aren't already inside an async
/// context.
pub(crate) fn run_gc_sweep_once_blocking(&self) -> Result<gc::GcReport, gc::GcError> {
bridge_on_runtime(self.run_gc_sweep_once(), &self.inner.query_runtime())
}
/// Observability snapshot of the supertable's load.
/// Cheap to call: one RSS syscall + an `ArcSwap::load` + a couple of
/// length reads on the in-memory manifest. See
/// [`crate::supertable::SupertableStats`] for the field-level contract.
#[cfg(any(test, feature = "test-helpers"))]
pub fn stats(&self) -> SupertableStats {
let manifest = self.inner.manifest.load();
let n_manifest_parts = manifest.get_num_parts();
let cache = self.inner.options.disk_cache.as_ref();
let mmap_resident_bytes = cache.map(|c| c.current_mmap_size_bytes());
// One `cache.stats()` call covers four fields. Cache
// counters are atomic loads, so the snapshot is
// self-consistent for each counter but not coherent
// across counters under heavy concurrent activity —
// adequate for observability.
let cache_snapshot = cache.map(|c| c.stats());
SupertableStats {
manifest_id: manifest.get_manifest_id(),
n_superfiles: manifest.get_all_superfiles().len(),
n_manifest_parts,
n_manifest_parts_loaded: manifest.get_num_parts_loaded(),
process_rss_bytes: process_rss_bytes(),
mmap_resident_bytes,
memory_budget_bytes: self.inner.options.memory_budget_bytes,
n_cold_fetches: cache_snapshot.as_ref().map(|s| s.n_cold_fetches),
n_cache_evictions: cache_snapshot.as_ref().map(|s| s.n_evictions),
n_cache_madvise_calls: cache_snapshot.as_ref().map(|s| s.n_madvise_calls),
n_cache_entries: cache_snapshot.as_ref().map(|s| s.n_entries),
}
}
#[cfg(any(test, feature = "test-helpers"))]
test_visible! {
/// Force-open every user + hidden vector superfile reader on the
/// pinned snapshot — the cold-open phase before a timed search.
/// Hidden IVF superfiles use their prefixed storage provider.
fn open_all_superfiles(&self) {
let reader = self.reader().expect("reader");
let manifest = reader.manifest();
let store = manifest.options.store.clone();
let disk_cache = manifest.options.disk_cache.clone();
let user_storage = manifest
.options
.storage
.clone()
.expect("open_all_superfiles: user table needs storage");
let mut targets: Vec<(
crate::supertable::manifest::SuperfileUri,
Option<crate::supertable::manifest::SubsectionOffsets>,
std::sync::Arc<dyn crate::storage::StorageProvider>,
)> = manifest
.superfiles
.iter()
.map(|e| {
(
e.uri,
e.subsection_offsets.clone(),
std::sync::Arc::clone(&user_storage),
)
})
.collect();
if let Some(hidden) = self.inner.vector_index_table.as_ref() {
let hidden_manifest = hidden.inner.manifest.load_full();
let hidden_storage = hidden_manifest
.options
.storage
.clone()
.expect("open_all_superfiles: hidden vector index needs storage");
for entry in hidden_manifest.superfiles.iter() {
targets.push((
entry.uri,
entry.subsection_offsets.clone(),
std::sync::Arc::clone(&hidden_storage),
));
}
}
self.block_on_query(async move {
let handles: Vec<_> = targets
.into_iter()
.map(|(uri, offsets, storage)| {
let store = store.clone();
let disk_cache = disk_cache.clone();
tokio::spawn(async move {
crate::supertable::query::superfile_reader::superfile_reader(
&store,
disk_cache.as_ref(),
Some(&storage),
&uri,
offsets.as_ref(),
true,
)
.await
})
})
.collect();
for h in handles {
h.await
.expect("open_all_superfiles: join superfile open task")
.expect("open_all_superfiles: open superfile readers");
}
Ok::<(), crate::supertable::reader_cache::disk::DiskCacheError>(())
})
.expect("open_all_superfiles");
}
}
#[cfg(any(test, feature = "test-helpers"))]
test_visible! {
/// Diagnostic: for every packed hidden cell, the stable `_id`s stored in
/// it (merged across shard superfiles, sorted by cell id). `None` when
/// there is no hidden table or a hidden blob has no packed cells. Used by
/// tests/benches to audit drain assignment against the global cell grid.
fn hidden_cell_stable_id_sets(&self) -> Option<Vec<(u32, Vec<i128>)>> {
let hidden = self.inner.vector_index_table.as_ref()?;
let hidden_manifest = hidden.inner.manifest.load_full();
let store = hidden_manifest.options.store.clone();
let disk_cache = hidden_manifest.options.disk_cache.clone();
let storage = hidden_manifest.options.storage.clone()?;
let targets: Vec<_> = hidden_manifest
.superfiles
.iter()
.map(|e| (e.uri, e.subsection_offsets.clone()))
.collect();
let merged = self
.block_on_query(async move {
let mut by_cell: HashMap<u32, Vec<i128>> = HashMap::new();
for (uri, offsets) in targets {
let reader = crate::supertable::query::superfile_reader::superfile_reader(
&store,
disk_cache.as_ref(),
Some(&storage),
&uri,
offsets.as_ref(),
true,
)
.await
.map_err(|e| e.to_string())?;
let Some(vec_reader) = reader.vec() else {
continue;
};
let Some(cells) = vec_reader
.packed_cell_stable_ids_async()
.await
.map_err(|e| e.to_string())?
else {
continue;
};
for (cell_id, ids) in cells {
by_cell.entry(cell_id).or_default().extend(ids);
}
}
Ok::<_, String>(by_cell)
})
.ok()?;
let mut out: Vec<(u32, Vec<i128>)> = merged.into_iter().collect();
out.sort_unstable_by_key(|(cell, _)| *cell);
Some(out)
}
}
#[cfg(any(test, feature = "test-helpers"))]
test_visible! {
/// Diagnostic: `(total_hidden_superfiles, max_superfiles_in_one_cell)` for
/// the hidden vector-index table, or `None` when there is no hidden table.
/// Used by benches to observe how compacted the hidden cell index is.
fn hidden_vector_superfile_stats(&self) -> Option<(usize, usize)> {
let hidden = self.inner.vector_index_table.as_ref()?;
let reader = hidden.reader().expect("reader");
let manifest = reader.manifest();
// Parts are table-level size buckets; per-cell identity lives on each
// superfile entry's partition key.
let mut by_cell: HashMap<Vec<u8>, usize> = HashMap::new();
let flat_superfiles = manifest.get_all_superfiles();
for entry in flat_superfiles {
*by_cell.entry(entry.partition_key.clone()).or_default() += 1;
}
let total = flat_superfiles.len();
if total == 0 {
return Some((0, 0));
}
let max_per_cell = by_cell.values().copied().max().unwrap_or(0);
Some((total, max_per_cell))
}
}
/// Internal accessor used by the writer module. Not part of
/// the public API.
pub(super) fn inner(&self) -> &Arc<SupertableInner> {
&self.inner
}
/// SQL Runtime accessor, exposed within the crate for the
/// `query::sql` module's `block_on`. Lazy: first call
/// allocates a single-worker tokio Runtime cached on
/// `SupertableInner`; subsequent calls clone the `Arc`.
pub(crate) fn query_runtime(&self) -> Arc<Runtime> {
self.inner.query_runtime()
}
/// Crate-internal accessor for the cached `SessionContext`
/// keyed on the manifest `Arc`. Used by `query_sql` to
/// reuse the registered provider + TVFs across queries on
/// the same snapshot.
pub(crate) fn sql_session_cache(
&self,
) -> &Mutex<Option<(Arc<ManifestSnapshot>, SessionContext)>> {
&self.inner.sql_session_cache
}
/// Diagnostic-only: returns the cached `SessionContext`
/// (building it on miss), bypassing the run-and-collect
/// path. Lets benchmarks decompose `query_sql` cost into
/// `ctx.sql()` (parse + analyze + logical/physical plan)
/// vs `DataFrame::collect()` (execute) to find where the
/// remaining dispatch time goes after the cache hit.
#[doc(hidden)]
#[cfg(any(test, feature = "test-helpers"))]
pub fn __debug_cached_session(&self) -> SessionContext {
// Reuses the same fast path as `query_sql` — see the
// doc-comment on `sql_session_cache` for invalidation.
self.reader()
.expect("reader")
.query_sql("SELECT 1 WHERE 1=0")
.ok();
let guard = self
.sql_session_cache()
.lock()
.expect("sql_session_cache mutex poisoned");
guard
.as_ref()
.map(|(_, ctx)| ctx.clone())
.expect("session cache must be populated after warm-up call")
}
}
/// Install the eviction-pinning policy on the attached
/// `DiskCacheStore`. Called from [`Supertable::create`] and
/// [`Supertable::open`] right after the `Arc<SupertableInner>`
/// is built; before the supertable is exposed to any
/// concurrent user.
///
/// Policy: **pin nothing.** The cache is a bounded LRU and must
/// be free to evict any superfile to stay under its budget — an
/// index larger than the cache budget has to be able to
/// stream/evict through it. (Previously this pinned the entire
/// live manifest, which made the index *required* to fit inside
/// the budget: once the cache filled, every entry was pinned,
/// eviction found "no eligible victims", and the next admit
/// hard-failed with `BudgetExceeded`.)
///
/// Pinning the live index was never needed for in-flight
/// correctness: a query holds an `Arc<SuperfileReader>` over an
/// mmap, and the cache can evict + unlink the backing file while
/// that mapping stays valid (POSIX keeps the inode alive until
/// the last reference drops). So eviction during a read is
/// already safe without pinning.
///
/// Left as a function (rather than inlined) so a future
/// genuinely-in-flight pin set (URIs a query is actively
/// holding) can be wired here if a workload ever needs it —
/// but that is a *bounded* set, never the whole manifest.
/// Cell count for the **user** table's grid, trained at the first commit —
/// used to cell-pack user superfiles and route the pre-drain query. The
/// per-table option wins when set; otherwise `vector.user_cell_count`
/// from the YAML config (no env override).
pub(crate) fn user_vector_cell_count(options: &SupertableOptions) -> usize {
options
.user_cell_count
.unwrap_or_else(|| config::global().vector.user_cell_count)
.max(1)
}
/// Cell count for the **hidden** vector index: `global_vector_index.grid` is
/// trained at this count and the drain reads it verbatim; post-drain routing
/// runs at this granularity. The per-table option wins when set; otherwise
/// `vector.hidden_cell_count` from the YAML config (no env override).
pub(crate) fn hidden_vector_cell_count(options: &SupertableOptions) -> usize {
options
.hidden_cell_count
.unwrap_or_else(|| config::global().vector.hidden_cell_count)
.max(1)
}
/// Reserved VectorCell partition id for the hidden index's "incoming" append
/// region. Each hidden commit writes one IVF superfile under this sentinel
/// partition holding that whole batch (all cells mixed, unsorted). Queries
/// always scan the incoming superfiles in addition to the nprobe-routed cell
/// superfiles; background OPANN maintenance later routes incoming into the
/// per-cell IVF superfiles and deletes it. `u32::MAX` is out of the
/// valid cell range `0..n_cent`, so it never collides with a real cell.
pub(crate) const INCOMING_VECTOR_CELL: u32 = u32::MAX;
/// Lloyd iterations when folding per-superfile cluster centroids into the
/// global cell grid at open/create time.
pub(crate) const GLOBAL_VECTOR_KMEANS_ITERS: usize = 8;
/// Fixed PRNG seed for global centroid training.
pub(crate) const GLOBAL_VECTOR_KMEANS_SEED: u64 = 0x51ED_2A11;
/// Headroom an engine-managed (auto-sized) cache budget keeps over the
/// table's on-storage footprint, in divisor form (`footprint +
/// footprint / this`). Slack for in-flight cold-fetch reservations while
/// the full working set stays resident.
const CACHE_BUDGET_HEADROOM_DIVISOR: u64 = 10;
/// Aggressive compaction profile for the hidden vector-index table: keep
/// ~one compact packed shard object per partition key instead of many
/// small delta files.
pub(crate) fn hidden_vector_index_compaction_settings() -> crate::config::CompactionSettings {
let cfg = crate::config::global();
let vector = &cfg.vector;
crate::config::CompactionSettings {
target_superfile_size_mb: vector.compaction_target_mb,
// The hidden index keeps no byte floor of its own: it derives
// `min_fill_percent` from the user table's `compaction` settings so the
// floor lives in one place. The fragment-count trigger below dominates
// it here (a cell merges on any two shards regardless of the floor).
min_fill_percent: cfg.compaction.min_fill_percent,
min_superfiles_for_merge: vector.compaction_min_superfiles_for_merge,
max_memory_mb: vector.compaction_max_memory_mb,
..Default::default()
}
}
/// Open-time bootstrap only: derive initial global centroids from an
/// existing user-table IVF summary. Hidden commits use
/// [`super::opann`] MVCC maintenance — never call this per commit.
pub(crate) fn train_global_centroids(
user_opts: &SupertableOptions,
manifest: &super::manifest::ManifestSnapshot,
n_cells: usize,
) -> Option<super::manifest::ClusterCentroids> {
let vc = user_opts.vector_columns.first()?;
let mut all_centroids = Vec::new();
let mut dim = 0usize;
for entry in manifest.superfiles.iter() {
let Some(vs) = entry.vector_summary.get(&vc.column) else {
continue;
};
for cell in &vs.cells {
let clusters = &cell.clusters;
// Stripped summaries (read-only consumer memory mode) carry no
// fp32 to train from; grid bootstrap is a writer-side concern.
if clusters.is_empty() || !clusters.vectors_resident() {
continue;
}
dim = clusters.dim as usize;
for c in 0..clusters.n_cent as usize {
if clusters.counts[c] == 0 {
continue;
}
all_centroids.extend_from_slice(clusters.centroid(c));
}
}
}
if all_centroids.is_empty() || dim == 0 {
return None;
}
let n_src = all_centroids.len() / dim;
let n = n_cells.min(n_src).max(1);
let centroids = kmeans(
&all_centroids,
dim,
n,
GLOBAL_VECTOR_KMEANS_ITERS,
GLOBAL_VECTOR_KMEANS_SEED,
);
Some(super::manifest::ClusterCentroids::from_fp32(
n as u32,
dim as u32,
¢roids,
vec![1u32; n],
))
}
pub(crate) fn legacy_vector_index_storage_prefix() -> &'static str {
super::manifest::DEFAULT_VECTOR_INDEX_PREFIX
}
fn generate_vector_index_storage_prefix() -> String {
format!("_infino_{}_vector_index", uuid::Uuid::new_v4())
}
fn resolve_vector_index_storage_prefix(
user_opts: &SupertableOptions,
user_manifest: Option<&super::manifest::ManifestSnapshot>,
create_prefix: Option<&str>,
) -> Option<String> {
if user_opts.vector_columns.is_empty() {
return None;
}
if let Some(prefix) = create_prefix {
return Some(prefix.to_string());
}
if let Some(manifest) = user_manifest
&& let Some(prefix) = manifest.vector_index_storage_prefix()
{
return Some(prefix.to_string());
}
Some(legacy_vector_index_storage_prefix().to_string())
}
fn build_vector_index_options(
user_opts: &SupertableOptions,
user_manifest: Option<&super::manifest::ManifestSnapshot>,
create_prefix: Option<&str>,
) -> Option<SupertableOptions> {
let storage_prefix =
resolve_vector_index_storage_prefix(user_opts, user_manifest, create_prefix)?;
let storage = user_opts.storage.as_ref()?;
let sub_storage: Arc<dyn crate::storage::StorageProvider> = Arc::new(
PrefixedStorageProvider::new(Arc::clone(storage), storage_prefix.as_str()),
);
let mut fields: Vec<arrow_schema::FieldRef> = Vec::new();
for vc in &user_opts.vector_columns {
let item_field = Arc::new(arrow_schema::Field::new(
"item",
arrow_schema::DataType::Float32,
true,
));
fields.push(Arc::new(arrow_schema::Field::new(
&vc.column,
arrow_schema::DataType::FixedSizeList(item_field, vc.dim as i32),
false,
)));
}
let hidden_schema = Arc::new(arrow_schema::Schema::new(fields));
// Hidden maintenance reads IVF-mergeable rows without fp32
// reconstruction. Preserve any IVF-mergeable user codec (the residual
// family and the single-plane Sq16); other user codecs retain the existing
// local-residual hidden representation.
let hidden_vector_columns: Vec<VectorConfig> = user_opts
.vector_columns
.iter()
.map(|vc| VectorConfig {
rerank_codec: if vc.rerank_codec.is_ivf_mergeable() {
vc.rerank_codec
} else {
RerankCodec::Sq8Residual
},
..vc.clone()
})
.collect();
let mut hidden_opts = SupertableOptions::new(
hidden_schema,
vec![],
hidden_vector_columns,
user_opts.tokenizer.clone(),
)
.ok()?;
hidden_opts = hidden_opts
.with_storage(Arc::clone(&sub_storage))
.with_vector_layout(crate::superfile::vector::layout::VectorLayout::Ivf)
.with_reader_pool(Arc::clone(&user_opts.reader_pool))
.with_writer_pool(Arc::clone(&user_opts.writer_pool))
.with_read_consistency(user_opts.read_consistency);
hidden_opts.connection_memory_budget = Arc::clone(&user_opts.connection_memory_budget);
// Hidden-manifest summaries hydrate stripped unconditionally (the fp32
// wire home is the slow-CAS centroid section), so the consumer memory
// mode has nothing left to gate there. Keep it off on the derived
// options: the flag marks a handle read-only, and hidden maintenance
// (drain, split, compaction) must stay writable regardless of how the
// user handle was opened.
hidden_opts.summary_centroids_from_superfiles = false;
// Per-table cell-count overrides ride along too: the hidden handle's
// paths resolve counts through its own options.
hidden_opts.user_cell_count = user_opts.user_cell_count;
hidden_opts.hidden_cell_count = user_opts.hidden_cell_count;
if let Some(cache) = user_opts.disk_cache.as_ref() {
hidden_opts = hidden_opts.with_disk_cache(Arc::clone(cache));
}
if let Some(manifest) = user_manifest
&& let Some(clusters) =
train_global_centroids(user_opts, manifest, hidden_vector_cell_count(user_opts))
{
hidden_opts = hidden_opts.with_partition_strategy(
crate::supertable::manifest::list::PartitionStrategy::VectorCell {
column: user_opts.vector_columns[0].column.clone(),
clusters,
routing: CellRoutingParams::default(),
},
);
}
Some(hidden_opts)
}
/// Build one supertable handle. Leaf — never creates a hidden sibling.
async fn build_handle(
options: Arc<SupertableOptions>,
manifest: Arc<ManifestSnapshot>,
vector_index_table: Option<Arc<Supertable>>,
) -> Result<Supertable, OpenError> {
let tombstone_cache = build_tombstone_cache(&options, &manifest);
let id_generator = crate::supertable::utils::idgen::IdGenerator::new();
let handle_id = crate::supertable::wal::state_doc::SupertableHandleId(id_generator.next_id());
let inner = Arc::new(SupertableInner {
options,
manifest: ArcSwap::new(manifest),
writer_outstanding: AtomicBool::new(false),
compaction_outstanding: AtomicBool::new(false),
id_generator: Mutex::new(id_generator),
sql_session_cache: Mutex::new(None),
sql_logical_plan_cache: Mutex::new(None),
decoded_scalar_cache: DecodedScalarCache::default(),
tombstone_cache,
handle_id,
vector_index_table,
hidden_index_open_error: std::sync::OnceLock::new(),
last_pointer_check: Mutex::new(None),
last_pointer_etag: Mutex::new(None),
pointer_vanished: OnceLock::new(),
hidden_deleted_cache: Mutex::new(None),
sql_schemas: OnceLock::new(),
});
install_disk_cache_pinning(&inner);
let st = Supertable { inner };
if st.inner.options.storage.is_some() {
// Best-effort: a sweep failure here doesn't fail handle
// construction; the next sweep gets another shot.
if let Err(e) = st.run_recovery_sweep_once().await {
warn!(error = %e, "open-time recovery sweep failed (best-effort)");
}
if let Err(e) = st.run_gc_sweep_once().await {
warn!(error = %e, "open-time gc sweep failed (best-effort)");
}
}
Ok(st)
}
/// Create one supertable handle (empty manifest). Leaf — never creates a sibling.
async fn create_table_async(
options: SupertableOptions,
vector_index_table: Option<Arc<Supertable>>,
vector_index_storage_prefix: Option<String>,
) -> Result<Supertable, OpenError> {
let options = Arc::new(options);
// A durable create *persists* the initial empty manifest — its list plus
// the pointer at `manifest_id 0` — so the freshly created table is
// openable right away: before any append, after a reopen, and from
// another process (`open` requires a pointer). This doesn't shift the id
// sequence: the first append still commits `manifest_id 1`. An in-memory
// table keeps the lighter in-process-only empty snapshot.
let (manifest, vector_index_table) = if let Some(storage) = options.storage.clone() {
let materialized = Arc::new(
ManifestSnapshot::materialized_empty_with_vector_index_prefix(
options.clone(),
vector_index_storage_prefix,
),
);
// `expected_prev_etag = None` is the initial-commit shape: no prior
// pointer to fence on.
match materialized.write(storage.as_ref(), None, &[]).await {
Ok(()) => (materialized, vector_index_table),
// Lost the initial-pointer race to a concurrent creator on the
// same storage: adopt their committed manifest rather than
// failing — `create` is create-or-open, and a pointer that
// appeared between the caller's probe and this write is the same
// as "pointer already present". Drop the loser's pre-built
// hidden handle (it used a freshly generated prefix the durable
// manifest does not track) and reopen against the winner's
// stamped prefix.
Err(CommitError::WriteContentionExhausted) => {
let adopted = ManifestSnapshot::load(None, storage, Some(options.clone())).await?;
let reconciled =
reconcile_vector_index_table_to_manifest(options.as_ref(), &adopted).await?;
(adopted, reconciled)
}
Err(e) => return Err(e.into()),
}
} else {
(
Arc::new(ManifestSnapshot::empty_with_vector_index_prefix(
options.clone(),
vector_index_storage_prefix,
)),
vector_index_table,
)
};
build_handle(options, manifest, vector_index_table).await
}
/// After a lost create-race, open (or bootstrap) the hidden vector-index
/// table at the prefix stamped in `adopted` — never keep the loser's
/// process-local UUID prefix.
async fn reconcile_vector_index_table_to_manifest(
user_opts: &SupertableOptions,
adopted: &ManifestSnapshot,
) -> Result<Option<Arc<Supertable>>, OpenError> {
let Some(hidden_opts) = build_vector_index_options(user_opts, Some(adopted), None) else {
return Ok(None);
};
let hidden_storage = hidden_opts.storage.clone().ok_or_else(|| {
OpenError::Build(BuildError::Store(
"VectorIndexSuperTable requires options.storage".into(),
))
})?;
match read_pointer(&*hidden_storage).await {
Ok(Some(_)) => {
let hidden_arc = Arc::new(hidden_opts);
let hidden_manifest =
ManifestSnapshot::load(None, hidden_storage, Some(hidden_arc.clone())).await?;
Ok(Some(Arc::new(
open_table_async(hidden_arc, hidden_manifest, None).await?,
)))
}
Ok(None) => {
// Leaf create at the winner's already-prefixed storage — do not
// recurse through `create_table_async` (that path reconciles
// again and would form an infinitely sized future).
let hidden_arc = Arc::new(hidden_opts);
let manifest = if let Some(storage) = hidden_arc.storage.clone() {
let materialized = Arc::new(
ManifestSnapshot::materialized_empty_with_vector_index_prefix(
Arc::clone(&hidden_arc),
None,
),
);
match materialized.write(storage.as_ref(), None, &[]).await {
Ok(()) => materialized,
Err(CommitError::WriteContentionExhausted) => {
ManifestSnapshot::load(None, storage, Some(Arc::clone(&hidden_arc))).await?
}
Err(e) => return Err(e.into()),
}
} else {
Arc::new(ManifestSnapshot::empty_with_vector_index_prefix(
Arc::clone(&hidden_arc),
None,
))
};
Ok(Some(Arc::new(
build_handle(hidden_arc, manifest, None).await?,
)))
}
Err(e) => Err(OpenError::Storage(StorageError::Permanent {
uri: "_supertable/current".into(),
source: Box::new(std::io::Error::other(format!("{e}"))),
})),
}
}
/// Open one supertable handle from a loaded manifest. Leaf — never creates a sibling.
async fn open_table_async(
options: Arc<SupertableOptions>,
manifest: Arc<ManifestSnapshot>,
vector_index_table: Option<Arc<Supertable>>,
) -> Result<Supertable, OpenError> {
build_handle(options, manifest, vector_index_table).await
}
fn install_disk_cache_pinning(inner: &Arc<SupertableInner>) {
let cache = match inner.options.disk_cache.as_ref() {
Some(c) => c,
None => return,
};
let pinned_fn: Arc<dyn Fn() -> HashSet<SuperfileUri> + Send + Sync> = Arc::new(HashSet::new);
cache.set_pinned_fn(pinned_fn);
}
/// Build the tombstone-sidecar cache when storage is attached.
/// Returns `None` for in-memory-only supertables — no sidecars
/// can exist there, so the query paths skip the filter hook
/// entirely. The cache is born with the seq view of `manifest`
/// (the snapshot the handle opens with), so it is authoritative
/// from the first query.
fn build_tombstone_cache(
options: &Arc<SupertableOptions>,
manifest: &ManifestSnapshot,
) -> Option<Arc<SidecarCache>> {
let storage = options.storage.as_ref()?.clone();
let wal_store = WalStore::new(storage);
Some(Arc::new(SidecarCache::new(
wal_store,
DEFAULT_SEAL_TTL,
tombstone_seq_view(manifest),
)))
}
/// The tombstone-seq view of `manifest`, in the shape the sidecar
/// cache validates against. An in-process-only manifest (no
/// persisted list) has no sidecars, so its view is empty.
fn tombstone_seq_view(manifest: &ManifestSnapshot) -> Arc<TombstoneSeqView> {
Arc::new(TombstoneSeqView {
manifest_id: manifest.manifest_id,
seqs: manifest.get_tombstone_seqs().cloned().unwrap_or_default(),
})
}
impl fmt::Debug for Supertable {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let m = self.inner.manifest.load();
f.debug_struct("Supertable")
.field("manifest_id", &m.manifest_id)
.field("n_superfiles", &m.superfiles.len())
.field("id_column", &self.inner.options.id_column)
.finish()
}
}
/// Snapshot-pinned reader. Captures `Arc<ManifestSnapshot>` at construction
/// and holds it through query lifetime — new commits to the parent
/// `Supertable` don't affect this reader's view. The public read
/// methods (`bm25_search`, `bm25_search_prefix`, `vector_search`,
/// `hybrid_search`, `query_sql`) live on this handle; each drives its async kernel to
/// completion via the sync→async bridge ([`SupertableReader::block_on`]),
/// mirroring the way [`SupertableWriter`](crate::supertable::SupertableWriter)
/// drives `commit`.
#[derive(Clone)]
pub struct SupertableReader {
manifest: Arc<ManifestSnapshot>,
/// Per-process tombstone-bitmap cache shared with the parent
/// `Supertable`. Query paths read through this before
/// returning per-superfile hits so tombstoned rows never
/// reach callers. `None` for in-memory-only supertables.
pub(crate) tombstone_cache: Option<Arc<SidecarCache>>,
/// Shared inner state, held only so the reader's sync read
/// methods can drive their async kernels on the supertable's
/// `query_runtime` — the same `Arc<SupertableInner>` the writer
/// holds. One `Arc::clone` per `reader()`; keeping it alive also
/// keeps the runtime alive for the reader's lifetime, so a reader
/// captured before its parent `Supertable` drops can still query.
inner: Arc<SupertableInner>,
/// Per-query work collector, picked up from the caller's active
/// [`with_op_stats`](crate::runtime_metrics::op_stats::with_op_stats)
/// scope at mint time. `None` (the default) makes every counter
/// flush a no-op branch. Query kernels clone the `Arc` into their
/// fan-out bodies; the thread-local is never consulted past mint.
pub(crate) op_stats: Option<Arc<OpStatsCollector>>,
}
/// A non-owning handle to a pinned reader snapshot, held by the SQL
/// search TVFs that live inside a cached `SessionContext`.
///
/// Caching the `SessionContext` on `SupertableInner` while its TVFs
/// held a strong `Arc<SupertableReader>` formed a reference cycle
/// (`SupertableInner` → cached `SessionContext` → TVF →
/// `Arc<SupertableReader>` → `SupertableInner`), which leaked the
/// entire consumer on every reopen. `WeakReader` breaks it: it holds a
/// `Weak<SupertableInner>` plus the pinned `Arc<ManifestSnapshot>` (a manifest
/// never points back at the inner, so it adds no cycle) and rebuilds
/// the strong reader on demand. The upgrade always succeeds while a
/// query is executing, because the live consumer keeps the inner alive.
#[derive(Clone)]
pub(crate) struct WeakReader {
inner: Weak<SupertableInner>,
manifest: Arc<ManifestSnapshot>,
tombstone_cache: Option<Arc<SidecarCache>>,
/// Per-query work collector carried through the weak round-trip. Safe
/// because TVF exec plans are built per query; state that outlives a
/// query (the cached SQL `SessionContext`) is constructed under
/// [`op_stats::suppressed`] and from a detached reader, so no
/// long-lived `WeakReader` ever holds a scope's collector.
op_stats: Option<Arc<OpStatsCollector>>,
}
impl fmt::Debug for WeakReader {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("WeakReader").finish_non_exhaustive()
}
}
impl WeakReader {
/// Capture a reader's snapshot without keeping its inner alive.
pub(crate) fn from_reader(reader: &SupertableReader) -> Self {
Self {
inner: Arc::downgrade(reader.inner_arc()),
manifest: Arc::clone(reader.manifest()),
tombstone_cache: reader.tombstone_cache.clone(),
op_stats: reader.op_stats.clone(),
}
}
/// Reconstruct the strong pinned reader, or `None` if the owning
/// consumer has already been dropped.
pub(crate) fn upgrade(&self) -> Option<Arc<SupertableReader>> {
let inner = self.inner.upgrade()?;
Some(Arc::new(SupertableReader::from_inner_pinned(
inner,
Arc::clone(&self.manifest),
self.tombstone_cache.clone(),
self.op_stats.clone(),
)))
}
}
impl SupertableReader {
/// ManifestSnapshot id pinned at construction. Useful for asserting
/// reader-vs-writer visibility ordering in tests.
pub fn manifest_id(&self) -> u64 {
self.manifest.manifest_id
}
/// Sync→async bridge for this reader's public query surface.
/// Reuses an ambient `multi_thread` runtime via `block_in_place`
/// when present, otherwise drives on the supertable's lazily-built
/// `query_runtime`. Same bridge the writer's `commit` uses.
pub(crate) fn block_on<F: Future>(&self, fut: F) -> F::Output {
bridge_on_runtime(fut, &self.inner.query_runtime())
}
/// Number of superfiles visible to this reader.
pub fn n_superfiles(&self) -> usize {
self.manifest.superfiles.len()
}
#[cfg(any(test, feature = "test-helpers"))]
test_visible! {
/// Load every lazy manifest part and return `(superfiles, index bytes)`.
/// Benchmarks use this to size a cache when reopening a retained table.
fn load_superfile_storage_stats(&self) -> Result<(usize, u64), ManifestLoadError> {
let entries = self.block_on(self.manifest.get_all_superfiles_loaded())?;
let total_index_bytes = entries
.iter()
.filter_map(|entry| entry.subsection_offsets.as_ref())
.map(|offsets| offsets.total_size)
.sum();
Ok((entries.len(), total_index_bytes))
}
}
/// Total documents across all superfiles visible to this reader.
pub fn n_docs_total(&self) -> u64 {
self.manifest.n_docs_total()
}
/// Pinned manifest. Exposed for query-side machinery
/// (skip helpers, fan-out, etc.) to read the superfile list
/// + summaries directly.
pub fn manifest(&self) -> &Arc<ManifestSnapshot> {
&self.manifest
}
pub(crate) fn decoded_scalar_cache(&self) -> &DecodedScalarCache {
&self.inner.decoded_scalar_cache
}
/// The shared `Arc<SupertableInner>` backing this reader. Used to
/// build a [`WeakReader`] that retains the snapshot without an
/// owning cycle through a cached `SessionContext`. Module-private:
/// `SupertableInner` is module-private, and the only caller is
/// [`WeakReader::from_reader`] in this file.
fn inner_arc(&self) -> &Arc<SupertableInner> {
&self.inner
}
/// Rebuild a pinned reader from its parts. Pairs with
/// [`WeakReader::upgrade`]: the SQL search TVFs cache a weak inner
/// plus the pinned manifest, then reconstruct the strong reader at
/// `call()` time (the consumer is always alive while a query runs).
/// Module-private (takes the module-private `SupertableInner`); the
/// only caller is [`WeakReader::upgrade`] in this file.
fn from_inner_pinned(
inner: Arc<SupertableInner>,
manifest: Arc<ManifestSnapshot>,
tombstone_cache: Option<Arc<SidecarCache>>,
op_stats: Option<Arc<OpStatsCollector>>,
) -> Self {
Self {
manifest,
tombstone_cache,
inner,
op_stats,
}
}
/// Per-supertable configuration for this reader's snapshot.
pub(crate) fn options(&self) -> &Arc<SupertableOptions> {
&self.inner.options
}
/// Cached per-table SQL schemas (scan view + scalar schema).
pub(crate) fn sql_schemas(&self) -> Arc<SqlSchemas> {
self.inner.sql_schemas()
}
/// Cached `SessionContext` keyed on the manifest `Arc`, reused by
/// [`SupertableReader::query_sql`] across queries on this snapshot.
pub(crate) fn sql_session_cache(
&self,
) -> &Mutex<Option<(Arc<ManifestSnapshot>, SessionContext)>> {
&self.inner.sql_session_cache
}
/// Cached deterministic scalar SQL plans for this reader's manifest.
pub(crate) fn sql_logical_plan_cache(
&self,
) -> &Mutex<Option<(Arc<ManifestSnapshot>, HashMap<String, LogicalPlan>)>> {
&self.inner.sql_logical_plan_cache
}
pub(crate) fn vector_index_table(&self) -> Option<&Arc<Supertable>> {
self.inner.vector_index_table.as_ref()
}
/// `Some(reason)` when a **configured and materialized** hidden vector index
/// failed to load/open at table-open (present-but-broken). `None` when the
/// index is present (usable) or genuinely absent. Vector search uses this to
/// fail loud on a broken index instead of falling back to a user-table scan.
pub(crate) fn hidden_index_open_error(&self) -> Option<&str> {
self.inner.hidden_index_open_error.get().map(String::as_str)
}
/// Decoded hidden deleted-`_id` set for this reader's pinned manifest,
/// cached per manifest version so the inline bytes are decoded once per
/// version rather than once per query (the `SidecarCache` discipline).
///
/// The set itself is a deliberate duplicate of the user-table tombstones,
/// carried inline in the hidden manifest: hidden vector search drops
/// deleted rows from these resident bytes instead of GETting the user
/// table's per-superfile tombstones on every query.
pub(crate) fn hidden_deleted_ids(&self) -> Result<Arc<Vec<i128>>, HiddenDeletedError> {
let version = self.manifest.get_manifest_id();
{
let guard = self
.inner
.hidden_deleted_cache
.lock()
.expect("hidden deleted-set cache mutex poisoned");
if let Some((cached_version, ids)) = guard.as_ref()
&& *cached_version == version
{
return Ok(Arc::clone(ids));
}
}
let ids = hidden_deleted::deleted_user_ids(&self.manifest)?;
*self
.inner
.hidden_deleted_cache
.lock()
.expect("hidden deleted-set cache mutex poisoned") = Some((version, Arc::clone(&ids)));
Ok(ids)
}
}
impl fmt::Debug for SupertableReader {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("SupertableReader")
.field("manifest_id", &self.manifest.manifest_id)
.field("n_superfiles", &self.manifest.superfiles.len())
.finish()
}
}
#[cfg(test)]
mod tests {
use std::{
collections::{HashMap, HashSet},
ops::Range,
sync::{
Arc,
atomic::{AtomicBool, Ordering},
},
time::Duration,
};
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray, RecordBatch};
use arrow_schema::{DataType, Field, Schema};
use async_trait::async_trait;
use bytes::Bytes;
use object_store::MultipartUpload;
use tempfile::TempDir;
use uuid::Uuid;
use super::*;
use crate::{
config::OptimizeOptions,
storage::{LocalFsStorageProvider, ObjectMeta, StorageError, StorageProvider},
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, layout::VectorLayout, rerank_codec::RerankCodec},
},
supertable::{
manifest::{
SuperfileEntry, SuperfileUri,
commit::{POINTER_PATH, get_current_manifest_etag},
list::PartitionStrategy,
},
opann::MODALITY_MIN_CELL_DOCS,
options::Consistency,
query::dispatch::open_reader,
},
test_helpers::default_tokenizer,
};
fn rerank_payloads_by_stable_id(table: &Supertable) -> HashMap<i128, Vec<u8>> {
let table_reader = table.reader().expect("reader");
let manifest = table_reader.manifest();
let entries = bridge_sync_to_async(manifest.get_all_superfiles_loaded())
.expect("load superfile entries");
let mut payloads = HashMap::new();
for entry in entries {
let reader = bridge_sync_to_async(open_reader(
&manifest.options.store,
manifest.options.disk_cache.as_ref(),
manifest.options.storage.as_ref(),
&entry,
true,
))
.expect("open superfile");
let vector = reader.vec().expect("vector reader");
let rows = bridge_sync_to_async(vector.materialized_index_rows_async("emb"))
.expect("materialized residual rows");
for row in rows {
let mut bytes = row.encoded.codes;
bytes.extend_from_slice(&row.encoded.residuals);
if let Some(previous) = payloads.insert(row.stable_id, bytes.clone()) {
assert_eq!(previous, bytes, "replica payload changed");
}
}
}
payloads
}
fn schema() -> Arc<Schema> {
Arc::new(Schema::new(vec![Field::new(
"title",
DataType::LargeUtf8,
false,
)]))
}
fn opts() -> SupertableOptions {
let tk = default_tokenizer();
SupertableOptions::new(
schema(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![],
Some(tk),
)
.expect("valid options")
}
fn entry(n_docs: u64) -> Arc<SuperfileEntry> {
let id = Uuid::new_v4();
Arc::new(SuperfileEntry {
birth_version: 0,
superfile_id: id,
uri: SuperfileUri(id),
n_docs,
id_min: 0,
id_max: n_docs.saturating_sub(1) as i128,
scalar_stats: HashMap::new(),
fts_summary: HashMap::new(),
vector_summary: HashMap::new(),
partition_key: Vec::new(),
partition_hint: None,
vector_layout: crate::superfile::vector::layout::VectorLayout::Ivf,
subsection_offsets: None,
})
}
/// Test-only helper: publish a successor manifest by appending
/// superfiles and ArcSwap'ing the result into place. Equivalent
/// to what the writer will do at commit time, exposed here so
/// the manifest-swap behavior can be exercised in tests
/// without depending on writer machinery.
fn publish_appended(st: &Supertable, entries: Vec<Arc<SuperfileEntry>>) {
let old = st.inner.manifest.load();
let new = old.with_appended(entries);
st.inner.manifest.store(Arc::new(new));
}
#[test]
fn create_returns_handle_with_empty_initial_manifest() {
let st = Supertable::create(opts()).expect("create");
assert_eq!(st.manifest_id(), 0);
let r = st.reader().expect("reader");
assert_eq!(r.manifest_id(), 0);
assert_eq!(r.n_superfiles(), 0);
assert_eq!(r.n_docs_total(), 0);
}
#[test]
fn supertable_clone_shares_inner_state() {
let st1 = Supertable::create(opts()).expect("create");
let st2 = st1.clone();
// Same Arc<SupertableInner> behind both clones — verify
// by mutating through one and observing through the other.
publish_appended(&st1, vec![entry(50)]);
assert_eq!(st2.manifest_id(), 1);
}
#[test]
fn options_accessor_returns_arc_to_validated_options() {
let st = Supertable::create(opts()).expect("create");
let opts_arc = st.options();
assert_eq!(opts_arc.id_column, "_id");
assert_eq!(opts_arc.fts_columns.len(), 1);
}
#[test]
fn reader_pins_manifest_across_subsequent_commits() {
// The load-bearing reader-isolation invariant: a reader
// captured before a commit must keep seeing the pre-commit
// manifest, even after the writer has ArcSwap::store'd a
// new one.
let st = Supertable::create(opts()).expect("create");
// Pin reader at manifest_id = 0.
let pinned = st.reader().expect("reader");
assert_eq!(pinned.manifest_id(), 0);
assert_eq!(pinned.n_superfiles(), 0);
// Publish 2 superfiles → manifest_id = 1.
publish_appended(&st, vec![entry(10), entry(20)]);
assert_eq!(st.manifest_id(), 1);
// Pinned reader still sees the OLD manifest.
assert_eq!(pinned.manifest_id(), 0);
assert_eq!(pinned.n_superfiles(), 0);
// Fresh reader sees the NEW manifest.
let fresh = st.reader().expect("reader");
assert_eq!(fresh.manifest_id(), 1);
assert_eq!(fresh.n_superfiles(), 2);
assert_eq!(fresh.n_docs_total(), 30);
}
#[test]
fn manifest_immutability_property() {
// Property: every successor manifest is structurally
// independent of its predecessors. After several commits,
// each prior reader's pinned manifest reports its
// construction-time state, not the latest.
let st = Supertable::create(opts()).expect("create");
let r0 = st.reader().expect("reader");
publish_appended(&st, vec![entry(1)]);
let r1 = st.reader().expect("reader");
publish_appended(&st, vec![entry(2)]);
let r2 = st.reader().expect("reader");
publish_appended(&st, vec![entry(3)]);
let r3 = st.reader().expect("reader");
// Each reader's manifest_id matches the one published at
// its capture time.
assert_eq!(r0.manifest_id(), 0);
assert_eq!(r1.manifest_id(), 1);
assert_eq!(r2.manifest_id(), 2);
assert_eq!(r3.manifest_id(), 3);
// Superfile counts are monotonic across capture times.
assert_eq!(r0.n_superfiles(), 0);
assert_eq!(r1.n_superfiles(), 1);
assert_eq!(r2.n_superfiles(), 2);
assert_eq!(r3.n_superfiles(), 3);
// Doc counts add up correctly per pinned snapshot.
assert_eq!(r0.n_docs_total(), 0);
assert_eq!(r1.n_docs_total(), 1);
assert_eq!(r2.n_docs_total(), 1 + 2);
assert_eq!(r3.n_docs_total(), 1 + 2 + 3);
}
#[test]
fn reader_manifest_arc_outlives_supertable_drop() {
// The reader's pinned Arc<ManifestSnapshot> must keep the manifest
// alive even after the parent Supertable is dropped. This
// is the "snapshot pinned past the supertable's lifetime"
// guarantee — the underlying superfiles stay reachable.
let r = {
let st = Supertable::create(opts()).expect("create");
publish_appended(&st, vec![entry(5)]);
st.reader().expect("reader")
// st dropped here; reader survives.
};
assert_eq!(r.manifest_id(), 1);
assert_eq!(r.n_superfiles(), 1);
assert_eq!(r.n_docs_total(), 5);
}
#[test]
fn many_concurrent_readers_share_one_manifest() {
// Two readers issued at the same point should pin the SAME
// Arc<ManifestSnapshot>. The Arc-share is what makes "thousands of
// concurrent readers" cheap: one allocation, N+1 ref count.
let st = Supertable::create(opts()).expect("create");
publish_appended(&st, vec![entry(7)]);
let r1 = st.reader().expect("reader");
let r2 = st.reader().expect("reader");
assert!(Arc::ptr_eq(r1.manifest(), r2.manifest()));
}
#[test]
fn debug_format_doesnt_explode() {
let st = Supertable::create(opts()).expect("create");
let s = format!("{:?}", st);
assert!(s.contains("Supertable"));
let r = st.reader().expect("reader");
let s = format!("{:?}", r);
assert!(s.contains("SupertableReader"));
}
#[test]
fn schema_returns_user_schema_without_injected_id() {
let st = Supertable::create(opts()).expect("create");
let sch = st.schema();
// The user-facing schema is exactly the column the test fixture
// declared — the auto-injected `_id` is not part of it.
assert_eq!(sch.fields().len(), 1);
assert_eq!(sch.field(0).name(), "title");
}
#[test]
fn manifest_accessor_matches_reader_manifest_id() {
let st = Supertable::create(opts()).expect("create");
assert_eq!(st.manifest_id(), 0);
publish_appended(&st, vec![entry(3)]);
// The handle-level `manifest_id` advances with the swap, and a
// fresh reader pins the same value.
assert_eq!(st.manifest_id(), 1);
assert_eq!(st.reader().expect("reader").manifest_id(), 1);
}
#[test]
fn handle_id_is_stable_for_a_handle_and_distinct_across_handles() {
let st1 = Supertable::create(opts()).expect("create");
let st2 = Supertable::create(opts()).expect("create");
// Stable within one handle (and its clones).
assert_eq!(st1.handle_id(), st1.clone().handle_id());
// Distinct across independently-created handles.
assert_ne!(st1.handle_id(), st2.handle_id());
}
#[test]
fn query_runtime_is_process_shared() {
let st1 = Supertable::create(opts()).expect("create");
let st2 = Supertable::create(opts()).expect("create");
// Every handle sees the one process-level query runtime — repeated
// calls and independent handles never build extra tokio workers.
assert!(Arc::ptr_eq(&st1.query_runtime(), &st1.query_runtime()));
assert!(Arc::ptr_eq(&st1.query_runtime(), &st2.query_runtime()));
}
#[test]
fn block_on_query_drives_a_future_to_completion() {
let st = Supertable::create(opts()).expect("create");
let out = st.block_on_query(async { 7_u32 + 35 });
assert_eq!(out, 42);
}
#[test]
fn stats_reports_in_memory_snapshot() {
let st = Supertable::create(opts()).expect("create");
publish_appended(&st, vec![entry(10), entry(20)]);
let s = st.stats();
assert_eq!(s.manifest_id, 1);
assert_eq!(s.n_superfiles, 2);
// In-memory supertable has no manifest list / disk cache.
assert_eq!(s.n_manifest_parts, 0);
assert_eq!(s.mmap_resident_bytes, None);
assert_eq!(s.n_cold_fetches, None);
}
#[test]
fn wait_until_warm_is_noop_without_disk_cache() {
let st = Supertable::create(opts()).expect("create");
// No disk cache attached → returns Ok immediately.
st.wait_until_warm(Duration::from_millis(1))
.expect("warm no-op");
}
#[test]
fn debug_cached_session_populates_the_session_cache() {
let st = Supertable::create(opts()).expect("create");
// Building the diagnostic session forces a SessionContext to be
// built and cached on the inner.
let _ctx = st.__debug_cached_session();
let guard = st
.sql_session_cache()
.lock()
.expect("sql_session_cache mutex");
assert!(guard.is_some(), "session cache populated after warm-up");
}
#[test]
fn weak_reader_round_trips_and_debug() {
let st = Supertable::create(opts()).expect("create");
publish_appended(&st, vec![entry(4)]);
let reader = st.reader().expect("reader");
let weak = WeakReader::from_reader(&reader);
// Debug is non-exhaustive but must not explode.
assert!(format!("{weak:?}").contains("WeakReader"));
// While the parent + reader are alive, upgrade succeeds and
// observes the same pinned snapshot.
let upgraded = weak.upgrade().expect("upgrade while inner alive");
assert_eq!(upgraded.manifest_id(), reader.manifest_id());
assert_eq!(upgraded.n_superfiles(), 1);
}
#[test]
fn weak_reader_upgrade_fails_after_inner_dropped() {
let weak = {
let st = Supertable::create(opts()).expect("create");
let reader = st.reader().expect("reader");
let weak = WeakReader::from_reader(&reader);
drop(reader);
drop(st);
weak
};
// The owning inner is gone, so upgrade yields None.
assert!(weak.upgrade().is_none());
}
#[test]
fn reader_options_match_handle_options() {
let st = Supertable::create(opts()).expect("create");
let r = st.reader().expect("reader");
// The reader's options accessor reaches the same validated
// options the handle exposes.
assert_eq!(r.options().id_column, st.options().id_column);
assert_eq!(r.options().fts_columns.len(), 1);
}
#[test]
fn vector_search_works_after_commit_and_drain() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::superfile::{
builder::{FtsConfig, VectorConfig},
reader::VectorSearchOptions,
vector::{distance::Metric, rerank_codec::RerankCodec},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let make_options = || {
SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8FixedResidual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
.with_writer_pool(Arc::clone(&pool))
};
let st = Supertable::create(make_options()).expect("create");
assert!(
st.reader().expect("reader").vector_index_table().is_some(),
"vector columns + storage must create hidden index sibling"
);
let titles = LargeStringArray::from(vec!["a", "b", "c"]);
let flat = Float32Array::from(vec![1.0f32; 3 * dim]);
let fsl = FixedSizeListArray::new(item_field, dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
assert!(st.reader().expect("reader").n_superfiles() > 0);
let user_payloads = rerank_payloads_by_stable_id(&st);
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
assert_eq!(
hidden.options().vector_columns[0].rerank_codec,
RerankCodec::Sq8FixedResidual,
"hidden table must inherit the fixed residual codec"
);
// Phase B: the commit does NOT dual-write into the hidden table. It only
// bootstraps the global cell grid into the hidden manifest; the cell
// superfiles are drained from the user superfiles on demand.
assert_eq!(
hidden.reader().expect("reader").n_superfiles(),
0,
"commit must not dual-write into the hidden table"
);
assert!(
st.reader()
.expect("reader")
.manifest()
.get_global_vector_index()
.is_some_and(|g| g.grid.n_cent > 0 && g.grid.dim > 0),
"commit must bootstrap the global cell grid into the user manifest"
);
// The finer user-side grid is trained exactly when the two counts
// differ; with the default single grid (`user_cell_count` ==
// `hidden_cell_count`) it stays `None` and the user side falls back
// to `grid` via `into_user_grid`.
let user_grid_trained = st
.reader()
.expect("reader")
.manifest()
.get_global_vector_index()
.is_some_and(|g| {
g.user_grid
.as_ref()
.is_some_and(|u| u.n_cent > 0 && u.dim > 0)
});
assert_eq!(
user_grid_trained,
user_vector_cell_count(st.options()) != hidden_vector_cell_count(st.options()),
"user-side grid must be trained exactly when the cell counts differ"
);
assert_eq!(
st.reader().expect("reader").manifest().superfiles[0].vector_layout,
VectorLayout::MultiCellIvf,
"grid commit must emit packed user MultiCellIvf superfiles"
);
let mut q = vec![0.0f32; dim];
q[0] = 1.0;
// Pre-drain: with empty cells the query falls back to the user superfiles.
let hits = st
.reader()
.expect("reader")
.vector_hits("emb", &q, 3, VectorSearchOptions::new(), None)
.expect("vector search");
assert!(
!hits.is_empty(),
"pre-drain search must fall back to the user superfiles"
);
// Reopen before drain: the user flat view is lazy/empty and its
// superfile entries live in manifest parts. Drain must hydrate those
// authoritative parts rather than treating the table as empty.
drop(w);
drop(hidden);
drop(st);
let st = Supertable::open(make_options()).expect("reopen before drain");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index after reopen")
.clone();
// Drain the parts-backed user superfiles into hidden cells; the query
// is now served by the hidden cell index.
st.drain_vectors_to_cells_sync().expect("drain to cells");
let hidden_payloads = rerank_payloads_by_stable_id(&hidden);
assert_eq!(
hidden_payloads, user_payloads,
"fixed residual payloads must survive default k-means drain"
);
assert!(
hidden.reader().expect("reader").n_superfiles() > 0,
"drain must populate the hidden cell index"
);
let hits2 = st
.reader()
.expect("reader")
.vector_hits("emb", &q, 3, VectorSearchOptions::new(), None)
.expect("post-drain vector search");
assert!(
!hits2.is_empty(),
"post-drain search must hit the hidden cells"
);
let user_uris: HashSet<_> = st
.reader()
.expect("reader")
.manifest()
.superfiles
.iter()
.map(|entry| entry.uri)
.collect();
let in_process_drained = hidden
.reader()
.expect("reader")
.manifest()
.get_drained_ranges();
assert!(
st.reader()
.expect("reader")
.manifest()
.superfiles
.iter()
.all(|entry| in_process_drained.contains(entry.birth_version)),
"drain must cover every in-process user birth version"
);
// A fresh consumer must recover the same drained watermark. Otherwise
// the tiered query misclassifies fully-drained user files as deltas and
// reads both user and hidden vector data.
drop(hidden);
drop(st);
let reopened = Supertable::open(make_options()).expect("reopen after drain");
let reopened_hidden = reopened
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index after drained reopen")
.clone();
let reopened_drained = reopened_hidden
.reader()
.expect("reader")
.manifest()
.get_drained_ranges();
assert!(
reopened
.reader()
.expect("reader")
.manifest()
.superfiles
.iter()
.all(|entry| reopened_drained.contains(entry.birth_version)),
"cold reopen must retain every drained user birth version"
);
let cold_hits = reopened
.reader()
.expect("reader")
.vector_hits("emb", &q, 3, VectorSearchOptions::new(), None)
.expect("cold post-drain vector search");
assert!(
cold_hits
.iter()
.all(|hit| !user_uris.contains(&hit.superfile)),
"cold post-drain search must not read user superfiles"
);
reopened.append(&batch).expect("append fixed delta");
reopened
.drain_vectors_to_cells_sync()
.expect("drain fixed delta");
let hidden = reopened
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden after second drain")
.clone();
let before_compaction = rerank_payloads_by_stable_id(&hidden);
reopened
.optimize(&OptimizeOptions::default())
.expect("compact fixed hidden index");
let after_compaction = rerank_payloads_by_stable_id(&hidden);
assert_eq!(
after_compaction, before_compaction,
"fixed residual payloads must survive compaction"
);
}
/// The per-table cell-count overrides win over the YAML config; the
/// `.max(1)` floor still applies. No assertion on the config-backed
/// default value itself — the test environment's YAML may override it.
#[test]
fn vector_cell_count_options_override_config() {
let schema = Arc::new(Schema::new(vec![Field::new(
"text",
DataType::LargeUtf8,
false,
)]));
let base = SupertableOptions::new(schema, vec![], vec![], None).expect("options");
let overridden = base.with_vector_cell_counts(7, 9);
assert_eq!(user_vector_cell_count(&overridden), 7);
assert_eq!(hidden_vector_cell_count(&overridden), 9);
let floored = overridden.with_vector_cell_counts(0, 0);
assert_eq!(user_vector_cell_count(&floored), 1);
assert_eq!(hidden_vector_cell_count(&floored), 1);
}
/// Read-only consumer memory mode (`summary_centroids_from_superfiles`):
/// after a drain, a consumer reopened with the mode on must (a) hold
/// the hidden summaries without resident fp32 centroids and (b) return
/// exactly the hits of a mode-off consumer — the deferred admit rescore
/// reads centroid regions from the superfiles through the reader cache.
#[test]
fn stripped_summary_consumer_matches_resident_hits() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
superfile::{
builder::{FtsConfig, VectorConfig},
reader::VectorSearchOptions,
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::query::SuperfileHit,
};
// Rows across the planted one-hot directions (three per direction
// at dim=16), so each cosine cluster has a few members.
const N_DOCS: usize = 48;
// Top-k compared across the two consumer modes.
const TOP_K: usize = 5;
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let make_options = |from_superfiles: bool| {
SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8FixedResidual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
.with_writer_pool(Arc::clone(&pool))
.with_summary_centroids_from_superfiles(from_superfiles)
};
// One-hot planted directions (i % dim) — separable cosine clusters.
let st = Supertable::create(make_options(false)).expect("create");
let titles =
LargeStringArray::from((0..N_DOCS).map(|i| format!("doc {i}")).collect::<Vec<_>>());
let mut flat = Vec::with_capacity(N_DOCS * dim);
for i in 0..N_DOCS {
for d in 0..dim {
flat.push(if d == i % dim { 1.0f32 } else { 0.0 });
}
}
let fsl = FixedSizeListArray::new(
item_field.clone(),
dim as i32,
Arc::new(Float32Array::from(flat)),
None,
);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
drop(w);
let mut q = vec![0.0f32; dim];
q[0] = 1.0;
q[1] = 0.05;
let ids = |hits: &[SuperfileHit]| {
hits.iter()
.map(|h| (h.superfile, h.local_doc_id, h.stable_id))
.collect::<Vec<_>>()
};
// Pre-drain: the user wave serves the query, and a mode-on consumer
// hydrates the user manifest from routing parts (no fp32 download) —
// the deferred rescore reads user superfile centroid regions.
let pre_baseline = Supertable::open(make_options(false)).expect("pre-drain mode-off");
let pre_base_hits = pre_baseline
.reader()
.expect("reader")
.vector_hits("emb", &q, TOP_K, VectorSearchOptions::new(), None)
.expect("pre-drain baseline hits");
assert!(!pre_base_hits.is_empty(), "pre-drain baseline returns hits");
drop(pre_baseline);
let pre_stripped = Supertable::open(make_options(true)).expect("pre-drain mode-on");
let pre_stripped_reader = pre_stripped.reader().expect("reader");
let user_manifest = pre_stripped_reader.manifest();
let user_part_entries = user_manifest.get_all_list_entries();
assert!(
!user_part_entries.is_empty(),
"pre-drain user manifest must carry parts (routing hydration under test)"
);
assert!(
user_part_entries
.iter()
.all(|entry| entry.routing.is_some()),
"commits must stamp a routing sibling on every user part"
);
// Routing-part decode must have dropped the user fp32 — otherwise
// the parity check below never exercises the full-part rescore.
let saw_stripped_user_cell = user_manifest.superfiles.iter().any(|entry| {
entry.vector_summary.values().any(|vs| {
vs.cells
.iter()
.any(|cell| cell.clusters.n_cent > 0 && !cell.clusters.vectors_resident())
})
});
assert!(
saw_stripped_user_cell,
"mode-on consumer must hydrate stripped user summaries from routing parts"
);
let pre_stripped_hits = pre_stripped
.reader()
.expect("reader")
.vector_hits("emb", &q, TOP_K, VectorSearchOptions::new(), None)
.expect("pre-drain stripped hits");
assert_eq!(
ids(&pre_stripped_hits),
ids(&pre_base_hits),
"pre-drain: routing-part hydration must reproduce resident hits"
);
drop(pre_stripped);
st.drain_vectors_to_cells_sync().expect("drain to cells");
drop(st);
let baseline = Supertable::open(make_options(false)).expect("reopen mode-off");
let base_hits = baseline
.reader()
.expect("reader")
.vector_hits("emb", &q, TOP_K, VectorSearchOptions::new(), None)
.expect("baseline hits");
assert!(!base_hits.is_empty(), "baseline must return hits");
drop(baseline);
let stripped = Supertable::open(make_options(true)).expect("reopen mode-on");
let hidden = stripped
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
let hidden_reader = hidden.reader().expect("reader");
let hidden_manifest = hidden_reader.manifest();
assert!(
hidden_manifest.slow_vector_state_blob().is_some(),
"drain must publish the slow-state ref (routing-shaped blob)"
);
assert!(
hidden_manifest.slow_vector_state_centroids_blob().is_some(),
"drain must publish the centroid-section ref — exact rescores read it"
);
let mut saw_stripped_summary = false;
for entry in hidden_manifest.superfiles.iter() {
for vs in entry.vector_summary.values() {
for cell in &vs.cells {
if cell.clusters.n_cent > 0 {
assert!(
!cell.clusters.vectors_resident(),
"hidden summary fp32 must be dropped in mode-on consumers"
);
saw_stripped_summary = true;
}
}
}
}
assert!(
saw_stripped_summary,
"drained hidden manifest must carry cell summaries"
);
let stripped_hits = stripped
.reader()
.expect("reader")
.vector_hits("emb", &q, TOP_K, VectorSearchOptions::new(), None)
.expect("stripped-mode hits");
assert_eq!(
ids(&stripped_hits),
ids(&base_hits),
"deferred rescore must reproduce the resident-mode hit set"
);
for (a, b) in stripped_hits.iter().zip(&base_hits) {
assert!(
(a.score - b.score).abs() <= 1e-5 * (1.0 + b.score.abs()),
"scores must agree: {} vs {}",
a.score,
b.score
);
}
}
/// Plan contract: splice-mode drain is a separate identity path. Routing
/// keeps each local cluster verbatim (no re-kmeans); fixed residual
/// payloads must match the user-side bytes by stable `_id`.
#[test]
fn splice_drain_preserves_fixed_residual_payloads() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
config::DrainConsolidate,
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8FixedResidual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool)
.with_drain_consolidate(DrainConsolidate::Splice)
.with_drain_batch_superfiles(-1);
let st = Supertable::create(options).expect("create");
let titles = LargeStringArray::from(vec!["a", "b", "c", "d"]);
// Distinct axis-aligned vectors so local clusters are non-trivial.
let mut flat_vals = vec![0.0f32; 4 * dim];
for (row, axis) in [0usize, 1, 2, 3].into_iter().enumerate() {
flat_vals[row * dim + axis] = 1.0;
}
let flat = Float32Array::from(flat_vals);
let fsl = FixedSizeListArray::new(item_field, dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema,
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
drop(w);
let user_payloads = rerank_payloads_by_stable_id(&st);
assert!(!user_payloads.is_empty(), "user rows must have payloads");
st.drain_vectors_to_cells_sync().expect("splice drain");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
assert!(
hidden.reader().expect("reader").n_superfiles() > 0,
"splice drain must populate hidden cells"
);
let hidden_payloads = rerank_payloads_by_stable_id(&hidden);
assert_eq!(
hidden_payloads, user_payloads,
"fixed residual payloads must survive splice drain byte-for-byte"
);
}
/// A Kmeans-consolidate drain re-clusters the user rows through
/// `materialized_ivf_rows_in_doc_order`; every doc's stable id must survive
/// into the hidden index. Payloads may be re-quantized under the new
/// centroids, so compare the id set rather than bytes.
#[test]
fn kmeans_drain_preserves_all_stable_ids() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
config::DrainConsolidate,
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool)
.with_drain_consolidate(DrainConsolidate::Kmeans)
.with_drain_batch_superfiles(-1);
let st = Supertable::create(options).expect("create");
let titles = LargeStringArray::from(vec!["a", "b", "c", "d"]);
let mut flat_vals = vec![0.0f32; 4 * dim];
for (row, axis) in [0usize, 1, 2, 3].into_iter().enumerate() {
flat_vals[row * dim + axis] = 1.0;
}
let flat = Float32Array::from(flat_vals);
let fsl = FixedSizeListArray::new(item_field, dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema,
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
drop(w);
let user_payloads = rerank_payloads_by_stable_id(&st);
assert_eq!(user_payloads.len(), 4, "four user rows before drain");
st.drain_vectors_to_cells_sync().expect("kmeans drain");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
assert!(
hidden.reader().expect("reader").n_superfiles() > 0,
"kmeans drain must populate hidden cells"
);
let hidden_payloads = rerank_payloads_by_stable_id(&hidden);
let mut user_ids: Vec<i128> = user_payloads.keys().copied().collect();
let mut hidden_ids: Vec<i128> = hidden_payloads.keys().copied().collect();
user_ids.sort_unstable();
hidden_ids.sort_unstable();
assert_eq!(
hidden_ids, user_ids,
"kmeans drain preserves every doc's stable id"
);
}
/// The default k-means drain over an Sq8Residual index materializes user
/// rows in doc order (the `materialized_ivf_rows_in_doc_order` path, which
/// only runs for a residual codec) and populates the hidden cell index.
#[test]
fn kmeans_drain_over_residual_index_materializes_and_populates_cells() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
// Sq8Residual (not Fixed) + default consolidate (k-means) is the combo
// that routes the drain through materialized_ivf_rows_in_doc_order.
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
let titles = LargeStringArray::from(vec!["a", "b", "c", "d"]);
let mut flat = vec![0.0f32; 4 * dim];
for row in 0..4 {
flat[row * dim + row] = 1.0;
}
let fsl = FixedSizeListArray::new(
item_field,
dim as i32,
Arc::new(Float32Array::from(flat)),
None,
);
let batch = arrow_array::RecordBatch::try_new(
schema,
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
drop(w);
st.drain_vectors_to_cells_sync()
.expect("k-means residual drain");
// The residual-materialized rows landed in the hidden cell index.
let (total, max_per_cell) = st
.hidden_vector_superfile_stats()
.expect("hidden stats after drain");
assert!(total > 0, "k-means drain must populate hidden cells");
assert!(
max_per_cell > 0 && max_per_cell <= total,
"max-per-cell {max_per_cell} in 1..={total}",
);
}
/// A top-k vector query blended between two axis clusters must return all
/// `k` results once the drain has split those axes into separate hidden
/// cells. Under default routing (no caller nprobe) the coarse cell cutoff
/// widened only by score-slack — probing the single nearest cell and
/// returning `k/2`; it must instead probe enough cells to fill `k`.
#[test]
fn blended_vector_search_fills_topk_across_hidden_cells() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::superfile::{
builder::{FtsConfig, VectorConfig},
reader::VectorSearchOptions,
vector::{distance::Metric, rerank_codec::RerankCodec},
};
const DIM: usize = 16;
const AXES: usize = 5;
const ROWS: usize = 60; // AXES clusters, ROWS / AXES = 12 rows each
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), DIM as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim: DIM,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8FixedResidual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
.with_writer_pool(pool);
// Row i is a one-hot vector on axis `i % AXES`, so the drain lands each
// axis in its own hidden cell.
let titles = LargeStringArray::from((0..ROWS).map(|i| format!("r{i}")).collect::<Vec<_>>());
let mut flat = vec![0.0f32; ROWS * DIM];
for i in 0..ROWS {
flat[i * DIM + (i % AXES)] = 1.0;
}
let fsl = FixedSizeListArray::new(
item_field,
DIM as i32,
Arc::new(Float32Array::from(flat)),
None,
);
let batch = arrow_array::RecordBatch::try_new(
schema,
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let st = Supertable::create(options).expect("create");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
drop(w);
st.drain_vectors_to_cells_sync().expect("drain to cells");
// Query blended between axis 0 (weight 1.0) and axis 1 (weight 0.5): the
// top `k` spans both axes' rows, which the drain split across two cells.
let k = 2 * (ROWS / AXES); // 24
let mut q = vec![0.0f32; DIM];
q[0] = 1.0;
q[1] = 0.5;
let hits = st
.reader()
.expect("reader")
.vector_hits("emb", &q, k, VectorSearchOptions::new(), None)
.expect("vector search");
assert_eq!(
hits.len(),
k,
"blended top-k must span both hidden cells, got {}",
hits.len()
);
}
/// After a splice drain into the hidden vector index, the reader's derived-
/// state accessors report a live hidden index: a storage prefix is stamped,
/// the hidden-superfile stats are non-empty, the user superfiles carry real
/// index bytes, and the disk cache warms without timing out.
#[test]
fn drained_reader_reports_hidden_index_and_warms() {
use std::{sync::Arc, time::Duration};
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
config::DrainConsolidate,
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
},
test_helpers::default_disk_cache,
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let storage_dir = TempDir::new().expect("storage tempdir");
let cache_dir = TempDir::new().expect("cache tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(storage_dir.path()).expect("provider"));
let disk_cache = default_disk_cache(Arc::clone(&storage), cache_dir.path());
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8FixedResidual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
.with_writer_pool(pool)
.with_disk_cache(Arc::clone(&disk_cache))
.with_drain_consolidate(DrainConsolidate::Splice)
.with_drain_batch_superfiles(-1);
let st = Supertable::create(options).expect("create");
let titles = LargeStringArray::from(vec!["a", "b", "c", "d"]);
let mut flat_vals = vec![0.0f32; 4 * dim];
for (row, axis) in [0usize, 1, 2, 3].into_iter().enumerate() {
flat_vals[row * dim + axis] = 1.0;
}
let flat = Float32Array::from(flat_vals);
let fsl = FixedSizeListArray::new(item_field, dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema,
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
drop(w);
st.drain_vectors_to_cells_sync().expect("splice drain");
// A hidden index now exists → a storage prefix is stamped on the
// user manifest.
let prefix = st
.vector_index_storage_prefix()
.expect("hidden vector index prefix present after drain");
assert!(!prefix.is_empty(), "storage prefix must be non-empty");
// The hidden table carries at least one cell superfile, and the
// busiest cell holds at least one.
let (total, max_per_cell) = st
.hidden_vector_superfile_stats()
.expect("hidden vector stats present after drain");
assert!(
total > 0,
"drain must populate hidden superfiles, got {total}"
);
assert!(
max_per_cell > 0 && max_per_cell <= total,
"max-per-cell {max_per_cell} must be in 1..={total}"
);
// The user superfiles load and report real per-superfile index bytes.
let (n_superfiles, index_bytes) = st
.reader()
.expect("reader")
.load_superfile_storage_stats()
.expect("load superfile storage stats");
assert!(n_superfiles > 0, "user table has committed superfiles");
assert!(
index_bytes > 0,
"committed vector superfiles carry index bytes"
);
// The disk cache warms within the timeout.
st.wait_until_warm(Duration::from_secs(5))
.expect("disk cache warms without timing out");
}
/// An engine-managed (auto-sized) cache budget must be raised at open
/// to the table's real on-storage footprint — user superfiles plus the
/// hidden vector index — while an explicit budget is never changed.
#[test]
fn open_reconciles_auto_sized_cache_budget_with_footprint() {
use arrow_array::{Array, FixedSizeListArray, Float32Array};
use crate::{
superfile::{
builder::VectorConfig,
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::reader_cache::{DiskCacheConfig, DiskCacheStore},
};
/// Deliberately smaller than any committed superfile, so an
/// unreconciled budget is distinguishable from a raised one.
const TINY_BUDGET_BYTES: u64 = 4;
let dim = 16usize;
let n_rows = 64usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let vec_schema = Arc::new(Schema::new(vec![Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
)]));
let storage_dir = TempDir::new().expect("storage tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(storage_dir.path()).expect("provider"));
let make_options = || {
SupertableOptions::new(
vec_schema.clone(),
vec![],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
None,
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
};
// Producer: commit vectors and drain them into the hidden index so
// the on-storage footprint spans both tables.
{
let producer = Supertable::create(make_options()).expect("create");
let mut flat = Vec::<f32>::with_capacity(n_rows * dim);
for i in 0..n_rows {
for d in 0..dim {
flat.push(if d == i % dim { 1.0 } else { 0.0 });
}
}
let fsl = FixedSizeListArray::new(
item_field,
dim as i32,
Arc::new(Float32Array::from(flat)),
None,
);
let batch = arrow_array::RecordBatch::try_new(
vec_schema.clone(),
vec![Arc::new(fsl) as Arc<dyn Array>],
)
.expect("batch");
let mut w = producer.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
producer.drain_vectors_to_cells_sync().expect("drain");
}
// Auto-sized consumer: a tiny engine-managed budget must be raised
// to at least the footprint by the open-time reconcile.
let auto_cache_dir = TempDir::new().expect("cache tempdir");
let auto_cache = DiskCacheStore::new_unpinned(
Arc::clone(&storage),
DiskCacheConfig {
cache_root: auto_cache_dir.path().to_path_buf(),
disk_budget_bytes: TINY_BUDGET_BYTES,
mmap_cold_threshold_secs: 0,
mmap_sweep_interval_secs: 0,
..Default::default()
},
)
.expect("auto cache");
auto_cache.mark_budget_auto_sized();
let st = Supertable::open(make_options().with_disk_cache(Arc::clone(&auto_cache)))
.expect("open with auto-sized cache");
let footprint = st.on_storage_footprint_bytes();
assert!(footprint > 0, "committed + drained table has a footprint");
assert!(
auto_cache.disk_budget_bytes() >= footprint,
"auto-sized budget {} must cover the footprint {footprint}",
auto_cache.disk_budget_bytes(),
);
drop(st);
// Explicit-budget consumer: the same open leaves the budget alone.
let explicit_cache_dir = TempDir::new().expect("cache tempdir");
let explicit_cache = DiskCacheStore::new_unpinned(
Arc::clone(&storage),
DiskCacheConfig {
cache_root: explicit_cache_dir.path().to_path_buf(),
disk_budget_bytes: TINY_BUDGET_BYTES,
mmap_cold_threshold_secs: 0,
mmap_sweep_interval_secs: 0,
..Default::default()
},
)
.expect("explicit cache");
let st = Supertable::open(make_options().with_disk_cache(Arc::clone(&explicit_cache)))
.expect("open with explicit cache");
assert_eq!(
explicit_cache.disk_budget_bytes(),
TINY_BUDGET_BYTES,
"explicit budgets are warned about, never changed"
);
drop(st);
}
/// Cold reopen with lazy manifest parts must not under-report the
/// billing footprint. `on_storage_footprint_bytes` reads only the
/// resident flat view (safe for raise-only cache reconcile);
/// `storage_bytes` forces every part to load first so meters see the
/// full user + hidden index footprint.
#[test]
fn storage_bytes_loads_lazy_parts_on_cold_reopen() {
use arrow_array::{Array, FixedSizeListArray, Float32Array};
use crate::superfile::{
builder::VectorConfig,
vector::{distance::Metric, rerank_codec::RerankCodec},
};
let dim = 16usize;
let n_rows = 32usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let vec_schema = Arc::new(Schema::new(vec![Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
)]));
let storage_dir = TempDir::new().expect("storage tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(storage_dir.path()).expect("provider"));
// Threshold 0 ⇒ open never eager-loads parts; threshold 1 byte ⇒
// every commit spills into a real manifest part (not an inline flat
// view). Together they reproduce the cold undercount that billing
// must not see.
let make_options = || {
SupertableOptions::new(
vec_schema.clone(),
vec![],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
None,
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
.with_eager_load_threshold(0)
.with_part_size_threshold_bytes(1)
};
let warm_bytes = {
let producer = Supertable::create(make_options()).expect("create");
let mut flat = Vec::<f32>::with_capacity(n_rows * dim);
for i in 0..n_rows {
for d in 0..dim {
flat.push(if d == i % dim { 1.0 } else { 0.0 });
}
}
let fsl = FixedSizeListArray::new(
item_field,
dim as i32,
Arc::new(Float32Array::from(flat)),
None,
);
let batch = arrow_array::RecordBatch::try_new(
vec_schema.clone(),
vec![Arc::new(fsl) as Arc<dyn Array>],
)
.expect("batch");
let mut w = producer.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
producer.drain_vectors_to_cells_sync().expect("drain");
assert!(
producer
.reader()
.expect("reader")
.vector_index_table()
.is_some(),
"drain must leave a hidden vector-index table"
);
producer.storage_bytes().expect("warm storage_bytes")
};
assert!(warm_bytes > 0, "committed + drained table has a footprint");
let cold = Supertable::open(make_options()).expect("cold reopen");
let resident = cold.on_storage_footprint_bytes();
let loaded = cold.storage_bytes().expect("cold storage_bytes");
assert!(
resident < loaded,
"resident flat view undercounts lazy parts ({resident} vs loaded {loaded})"
);
assert_eq!(
loaded, warm_bytes,
"cold storage_bytes must match the warm footprint (user + hidden)"
);
}
/// The hidden IVF superfiles must be made *resident* in the
/// disk cache by a vector query, and a warm re-query must serve from
/// that resident mmap without re-fetching from storage.
///
/// Regression guard: the hidden-index read path used to `get_range`
/// straight from object storage, bypassing the cache entirely — so the
/// hidden superfiles were never resident and every (incl. warm) vector
/// query paid an object-store round-trip. The fix routes the read
/// through `reader_synchronous_with_storage`, cold-fetching through the
/// hidden table's *prefixed* storage (the shared cache is keyed to the
/// user storage and can't resolve the hidden prefix on its own).
#[test]
fn hidden_ivf_superfiles_become_resident_in_cache() {
use std::{collections::HashSet, sync::Arc};
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
superfile::{
builder::{FtsConfig, VectorConfig},
reader::VectorSearchOptions,
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::reader_cache::{ColdFetchMode, DiskCacheConfig, DiskCacheStore, LruPolicy},
};
let dim = 16usize;
// A few hundred vectors across several cells. Hidden IVF
// superfiles are never inlined into the manifest open_blob, so the
// query reads each probed cell's vec blob from storage through the
// disk cache regardless of size.
let n_rows = 512usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let storage_dir = TempDir::new().expect("storage tempdir");
let cache_dir = TempDir::new().expect("cache tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(storage_dir.path()).expect("provider"));
let make_options = || {
SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
};
// ---- Producer: create + commit, then drop. The producer's own
// post-commit cache pre-population is irrelevant here — we test a
// *fresh* consumer process (cold cache), as on a real deployment.
{
let producer =
Supertable::create(make_options().with_writer_pool(pool)).expect("create");
// Diverse vectors so the hidden IVF index has real content.
let titles =
LargeStringArray::from((0..n_rows).map(|i| format!("doc {i}")).collect::<Vec<_>>());
let mut flat = Vec::<f32>::with_capacity(n_rows * dim);
for i in 0..n_rows {
for d in 0..dim {
flat.push(if d == i % dim { 1.0 } else { 0.0 });
}
}
let fsl = FixedSizeListArray::new(
item_field,
dim as i32,
Arc::new(Float32Array::from(flat)),
None,
);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = producer.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
// Phase B: drain the user superfiles into the hidden cells (no
// dual-write), so the consumer below has real cell superfiles to
// make resident.
producer
.drain_vectors_to_cells_sync()
.expect("drain user superfiles into hidden cells");
}
// ---- Consumer: open fresh with a brand-new empty disk cache,
// keyed (as in production) to the *user* storage. The hidden index
// lives behind a prefixed provider over the same storage and shares
// this cache instance.
let cfg = DiskCacheConfig {
cache_root: cache_dir.path().to_path_buf(),
disk_budget_bytes: 1 << 30,
cold_fetch_mode: ColdFetchMode::HybridWithPrefetch,
cold_fetch_streams: 4,
cold_fetch_chunk_bytes: 1 << 20,
mmap_cold_threshold_secs: 0,
mmap_sweep_interval_secs: 0,
eviction: Box::new(LruPolicy::new()),
verify_crc_on_open: true,
..Default::default()
};
let pinned_fn: Arc<dyn Fn() -> HashSet<SuperfileUri> + Send + Sync> =
Arc::new(HashSet::new);
let cache = DiskCacheStore::new(Arc::clone(&storage), cfg, pinned_fn).expect("cache");
let st =
Supertable::open(make_options().with_disk_cache(Arc::clone(&cache))).expect("open");
// Collect the hidden IVF superfile URIs.
let reader = st.reader().expect("reader");
let hidden = reader.vector_index_table().expect("hidden index");
let hidden_uris: Vec<SuperfileUri> = hidden
.reader()
.expect("reader")
.manifest()
.superfiles
.iter()
.map(|e| e.uri)
.collect();
assert!(
!hidden_uris.is_empty(),
"hidden IVF index must have superfiles after commit"
);
// Cold: none of the hidden superfiles are resident yet.
for uri in &hidden_uris {
assert!(
!cache.is_cached(uri),
"hidden superfile {uri:?} unexpectedly resident before any query"
);
}
// First vector query routes through the hidden IVF index.
let mut q = vec![0.0f32; dim];
q[0] = 1.0;
let hits = st
.reader()
.expect("reader")
.vector_hits("emb", &q, 5, VectorSearchOptions::new(), None)
.expect("vector search");
assert!(!hits.is_empty(), "search should find committed vectors");
// Every probed hidden IVF superfile must now be resident
// (mmap-backed), proving the read went through the disk cache via
// the hidden prefixed storage — not a bare object-store get_range.
let resident: Vec<&SuperfileUri> =
hidden_uris.iter().filter(|u| cache.is_cached(u)).collect();
assert!(
!resident.is_empty(),
"vector query must make at least one hidden IVF superfile \
resident in the cache; none of {hidden_uris:?} are cached"
);
for uri in &resident {
assert!(
cache.is_cached(uri),
"resident hidden IVF superfile {uri:?} must be in disk cache"
);
}
// Warm re-query: the resident superfiles serve locally — no new
// cold-fetch. This is the warm-latency regression guard.
let cold_before = cache.stats().n_cold_fetches;
let hits2 = st
.reader()
.expect("reader")
.vector_hits("emb", &q, 5, VectorSearchOptions::new(), None)
.expect("warm vector search");
assert!(!hits2.is_empty());
let cold_after = cache.stats().n_cold_fetches;
assert_eq!(
cold_before, cold_after,
"warm vector query must hit the resident cache; cold-fetches grew \
from {cold_before} to {cold_after}"
);
}
/// Build a vector-only supertable, append `commits` batches of
/// `rows_per_commit` unit vectors (draining into hidden cells after each
/// commit when `drain_each`), then reopen a fresh consumer whose disk
/// cache is in lazy-foreground mode — the exact reader state a query
/// fan-out leaves behind, which compaction must still read eagerly.
/// Returns the temp dirs (kept alive by the caller) and the consumer.
fn vector_consumer_with_lazy_cache(
dim: usize,
rows_per_commit: usize,
commits: usize,
drain_each: bool,
) -> (TempDir, TempDir, Supertable) {
use arrow_array::{Array, FixedSizeListArray, Float32Array};
use crate::{
superfile::{
builder::VectorConfig,
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::reader_cache::{ColdFetchMode, DiskCacheConfig, DiskCacheStore, LruPolicy},
};
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
)]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let storage_dir = TempDir::new().expect("storage tempdir");
let cache_dir = TempDir::new().expect("cache tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(storage_dir.path()).expect("provider"));
let make_options = || {
SupertableOptions::new(
schema.clone(),
vec![],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
None,
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
.with_writer_pool(Arc::clone(&pool))
};
{
let producer = Supertable::create(make_options()).expect("create");
for _ in 0..commits {
let flat = vec![1.0f32; rows_per_commit * dim];
let fsl = FixedSizeListArray::new(
item_field.clone(),
dim as i32,
Arc::new(Float32Array::from(flat)),
None,
);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![Arc::new(fsl) as Arc<dyn Array>],
)
.expect("batch");
let mut w = producer.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
if drain_each {
producer.drain_vectors_to_cells_sync().expect("drain");
}
}
}
let cfg = DiskCacheConfig {
cache_root: cache_dir.path().to_path_buf(),
disk_budget_bytes: 1 << 30,
cold_fetch_mode: ColdFetchMode::LazyForegroundWithBackgroundFill,
cold_fetch_streams: 4,
cold_fetch_chunk_bytes: 1 << 20,
mmap_cold_threshold_secs: 0,
mmap_sweep_interval_secs: 0,
eviction: Box::new(LruPolicy::new()),
verify_crc_on_open: true,
..Default::default()
};
let pinned_fn: Arc<dyn Fn() -> std::collections::HashSet<SuperfileUri> + Send + Sync> =
Arc::new(std::collections::HashSet::new);
let cache = DiskCacheStore::new(Arc::clone(&storage), cfg, pinned_fn).expect("cache");
let consumer =
Supertable::open(make_options().with_disk_cache(Arc::clone(&cache))).expect("open");
(storage_dir, cache_dir, consumer)
}
const COMPACTION_TEST_SETTINGS: crate::config::CompactionSettings =
crate::config::CompactionSettings {
target_superfile_size_mb: 1,
min_fill_percent: 1,
min_superfiles_for_merge: 2,
max_memory_mb: 64,
stale_seal_timeout_ms: crate::config::DEFAULT_STALE_SEAL_TIMEOUT_MS,
};
/// Regression guard for optimize/compaction on the hidden vector index:
/// after lazy hidden-index reads, hidden compaction must still open every
/// input as an eager reader and merge without `RecordBatch` read failures.
#[test]
fn hidden_compaction_succeeds_after_lazy_hidden_reads() {
use crate::superfile::reader::VectorSearchOptions;
const DIM: usize = 16;
let (_storage_dir, _cache_dir, consumer) =
vector_consumer_with_lazy_cache(DIM, 5_000, 3, true);
let hidden = consumer
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
let mut per_cell: HashMap<Vec<u8>, usize> = HashMap::new();
for entry in &hidden.reader().expect("reader").manifest().superfiles {
*per_cell.entry(entry.partition_key.clone()).or_insert(0) += 1;
}
assert!(
per_cell.values().copied().max().unwrap_or(0) >= 2,
"expected >=2 hidden superfiles in at least one cell"
);
// Populate hidden readers through the lazy query path before compaction.
let query = vec![1.0f32; DIM];
let hits = consumer
.reader()
.expect("reader")
.vector_hits("emb", &query, 10, VectorSearchOptions::new(), None)
.expect("vector search");
assert!(!hits.is_empty(), "hidden index should return vector hits");
hidden
.compact(&COMPACTION_TEST_SETTINGS)
.expect("hidden compaction should succeed after lazy reads");
}
/// Regression guard for user-table compaction after pre-drain lazy reads.
/// The pre-drain vector query path opens user superfiles lazily through the
/// disk cache; subsequent compaction must still read full record batches.
#[test]
fn user_compaction_succeeds_after_pre_drain_lazy_reads() {
use crate::superfile::reader::VectorSearchOptions;
const DIM: usize = 1024;
let (_storage_dir, _cache_dir, consumer) =
vector_consumer_with_lazy_cache(DIM, 512, 4, false);
// Pre-drain query path: user superfiles are read lazily.
let query = vec![1.0f32; DIM];
let hits = consumer
.reader()
.expect("reader")
.vector_hits("emb", &query, 10, VectorSearchOptions::new(), None)
.expect("vector search");
assert!(!hits.is_empty(), "pre-drain user search should return hits");
consumer
.compact(&COMPACTION_TEST_SETTINGS)
.expect("user compaction should succeed after lazy pre-drain reads");
}
/// SQL-shaped tables (multi-column FTS + Sq8 vector) must survive
/// `optimize()` after lazy disk-cache reads — the same path the SQL
/// supertable bench takes (pre-compact warm/cold → optimize).
#[test]
fn sql_shaped_optimize_after_lazy_reads() {
use arrow_array::{
Array, FixedSizeListArray, Float32Array, Int64Array, LargeStringArray, RecordBatch,
};
use crate::{
superfile::{
builder::VectorConfig,
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::reader_cache::{ColdFetchMode, DiskCacheConfig, DiskCacheStore, LruPolicy},
};
const DIM: usize = 16;
const ROWS: usize = 64;
const COMMITS: usize = 4;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new("bucket", DataType::LargeUtf8, false),
Field::new("key", DataType::LargeUtf8, false),
Field::new("category", DataType::LargeUtf8, false),
Field::new("rating", DataType::Int64, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), DIM as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let storage_dir = TempDir::new().expect("storage tempdir");
let cache_dir = TempDir::new().expect("cache tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(storage_dir.path()).expect("provider"));
let make_options = || {
SupertableOptions::new(
schema.clone(),
vec![
FtsConfig {
column: "title".into(),
positions: false,
},
FtsConfig {
column: "bucket".into(),
positions: false,
},
FtsConfig {
column: "key".into(),
positions: false,
},
FtsConfig {
column: "category".into(),
positions: false,
},
],
vec![VectorConfig {
column: "emb".into(),
dim: DIM,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(default_tokenizer()),
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
.with_writer_pool(Arc::clone(&pool))
};
{
let producer = Supertable::create(make_options()).expect("create");
for c in 0..COMMITS {
let titles: Vec<String> = (0..ROWS).map(|i| format!("doc {c} {i}")).collect();
let buckets: Vec<String> = (0..ROWS).map(|i| format!("b{}", i % 10)).collect();
let keys: Vec<String> = (0..ROWS).map(|i| format!("k{c}_{i}")).collect();
let cats: Vec<String> = (0..ROWS)
.map(|i| if i % 2 == 0 { "cat" } else { "dog" }.to_string())
.collect();
let ratings: Vec<i64> = (0..ROWS).map(|i| i as i64).collect();
let flat = vec![1.0f32; ROWS * DIM];
let fsl = FixedSizeListArray::new(
item_field.clone(),
DIM as i32,
Arc::new(Float32Array::from(flat)),
None,
);
let batch = RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(LargeStringArray::from(
titles.iter().map(String::as_str).collect::<Vec<_>>(),
)) as Arc<dyn Array>,
Arc::new(LargeStringArray::from(
buckets.iter().map(String::as_str).collect::<Vec<_>>(),
)) as Arc<dyn Array>,
Arc::new(LargeStringArray::from(
keys.iter().map(String::as_str).collect::<Vec<_>>(),
)) as Arc<dyn Array>,
Arc::new(LargeStringArray::from(
cats.iter().map(String::as_str).collect::<Vec<_>>(),
)) as Arc<dyn Array>,
Arc::new(Int64Array::from(ratings)) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = producer.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
}
}
let cfg = DiskCacheConfig {
cache_root: cache_dir.path().to_path_buf(),
disk_budget_bytes: 1 << 30,
cold_fetch_mode: ColdFetchMode::LazyForegroundWithBackgroundFill,
cold_fetch_streams: 4,
cold_fetch_chunk_bytes: 1 << 20,
mmap_cold_threshold_secs: 0,
mmap_sweep_interval_secs: 0,
eviction: Box::new(LruPolicy::new()),
verify_crc_on_open: true,
..Default::default()
};
let pinned_fn: Arc<dyn Fn() -> HashSet<SuperfileUri> + Send + Sync> =
Arc::new(HashSet::new);
let cache = DiskCacheStore::new(Arc::clone(&storage), cfg, pinned_fn).expect("cache");
let consumer =
Supertable::open(make_options().with_disk_cache(Arc::clone(&cache))).expect("open");
// Exercise the lazy FTS path before optimize (mirrors the SQL bench's
// pre-compact warm/cold queries against a disk-cache consumer).
use crate::superfile::fts::reader::{Bm25Stats, BoolMode};
let hits = consumer
.bm25_search(
"title",
"doc",
5,
BoolMode::Or,
Bm25Stats::PerSuperfile,
None,
)
.expect("bm25 pre-optimize");
assert!(!hits.is_empty(), "pre-optimize FTS should return hits");
consumer
.optimize(&OptimizeOptions::compact(COMPACTION_TEST_SETTINGS))
.expect("sql-shaped optimize after lazy reads");
let hits_after = consumer
.bm25_search(
"title",
"doc",
5,
BoolMode::Or,
Bm25Stats::PerSuperfile,
None,
)
.expect("bm25 post-optimize");
assert!(
!hits_after.is_empty(),
"FTS must remain searchable after Sq8+FTS optimize"
);
}
/// Each drain APPENDS packed shard object(s) to the hidden manifest (no
/// removals — the user superfiles stay as the durable source). Draining
/// across successive commits accumulates multiple files under the same
/// partition key, which compaction later collapses.
#[test]
fn drain_appends_multiple_files_per_cell() {
use std::{collections::HashMap, sync::Arc};
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
for commit in 0..2 {
let titles = LargeStringArray::from(vec![format!("doc-{commit}")]);
let flat = Float32Array::from(vec![1.0f32; dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
// Phase B: drain after each commit; each drain appends packed shard files.
st.drain_vectors_to_cells_sync().expect("drain to cells");
}
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden vector index")
.clone();
let hidden_reader = hidden.reader().expect("reader");
let hidden_manifest = hidden_reader.manifest();
let mut by_cell = HashMap::<Vec<u8>, usize>::new();
for entry in hidden_manifest.superfiles.iter() {
*by_cell.entry(entry.partition_key.clone()).or_default() += 1;
}
let max_visible = by_cell.values().copied().max().unwrap_or(0);
assert!(
max_visible >= 2,
"each drain should append a packed shard file, got {max_visible}"
);
}
/// After a drain, `open_all_superfiles` force-opens every user + hidden
/// reader without error, and `hidden_cell_stable_id_sets` audits the drained
/// cells — the sum of per-cell stable ids equals the ingested doc count.
#[test]
fn open_all_superfiles_and_hidden_stable_id_audit() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
const N: usize = 6;
let titles = LargeStringArray::from((0..N).map(|i| format!("doc-{i}")).collect::<Vec<_>>());
let flat = Float32Array::from(vec![1.0f32; N * dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
drop(w);
st.drain_vectors_to_cells_sync().expect("drain");
// Cold-open every reader (user + hidden); must not error.
st.open_all_superfiles();
// Audit: the drained cells' inline stable ids cover every doc.
let sets = st
.hidden_cell_stable_id_sets()
.expect("post-drain hidden cells expose stable-id sets");
let total: usize = sets.iter().map(|(_, ids)| ids.len()).sum();
assert_eq!(
total, N,
"every drained doc carries a stable id in some cell"
);
}
/// Splitting a cell whose packed shard also holds *other* cells must leave
/// those neighbours in place: the parent superfile is not removed, only its
/// split cell is marked superseded. Ingest two vector directions (→ two
/// cells in one shard), split the busiest, and confirm the parent survives
/// with the split cell superseded while the neighbour keeps its docs.
#[test]
fn split_overflow_cell_supersedes_parent_keeps_neighbour() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::{manifest::list::PartitionStrategy, writer::split_overflow_cell},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
// 8 rows at e_0 and 8 at e_1 → two distinct cells packed in one shard.
const N: usize = 16;
let titles = LargeStringArray::from((0..N).map(|i| format!("doc-{i}")).collect::<Vec<_>>());
let mut flat = vec![0.0f32; N * dim];
for r in 0..N {
flat[r * dim + usize::from(r >= N / 2)] = 1.0; // first half e_0, second half e_1
}
let fsl = FixedSizeListArray::new(
item_field.clone(),
dim as i32,
Arc::new(Float32Array::from(flat)),
None,
);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
st.drain_vectors_to_cells_sync().expect("drain to cells");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
// Two populated cells (the two directions). Split the busiest; the
// other populated cell is the neighbour whose count must survive.
let (busiest, neighbour, neighbour_count, n_cent_before) = match hidden
.reader()
.expect("reader")
.manifest()
.get_partition_strategy()
{
PartitionStrategy::VectorCell { clusters, .. } => {
let mut populated: Vec<u32> = (0..clusters.n_cent)
.filter(|&c| clusters.counts[c as usize] > 0)
.collect();
assert!(
populated.len() >= 2,
"two directions must drain into two cells, got {:?}",
clusters.counts
);
populated.sort_by_key(|&c| std::cmp::Reverse(clusters.counts[c as usize]));
let busiest = populated[0];
let neighbour = populated[1];
(
busiest,
neighbour,
clusters.counts[neighbour as usize],
clusters.n_cent,
)
}
other => panic!("hidden must be VectorCell after drain, got {other:?}"),
};
let superfiles_before: usize = hidden.reader().expect("reader").manifest().superfiles.len();
hidden
.block_on_query(split_overflow_cell(hidden.inner().clone(), busiest, 0.0))
.expect("split");
// The split grows the grid by one sub-cell; the neighbour cell keeps its
// docs because its parent superfile is left in place (not republished).
let reader = hidden.reader().expect("reader");
let manifest = reader.manifest();
match manifest.get_partition_strategy() {
PartitionStrategy::VectorCell { clusters, .. } => {
assert_eq!(
clusters.n_cent,
n_cent_before + 1,
"split adds one sub-cell"
);
assert_eq!(
clusters.counts[neighbour as usize], neighbour_count,
"the neighbour cell keeps its docs"
);
}
other => panic!("still VectorCell, got {other:?}"),
}
// The parent that held the busiest cell is NOT removed (it still holds
// the neighbour cell live); its busiest-cell blocks are marked
// superseded so reads, counts, and merges skip them. The two child
// superfiles are appended on top, so the superfile count only grows.
let superseded = manifest
.get_superseded_cells()
.expect("persisted list carries a superseded map");
let parent_superseded = manifest.superfiles.iter().any(|e| {
superseded
.get(&e.superfile_id)
.is_some_and(|cells| cells.contains(&busiest))
});
assert!(
parent_superseded,
"the parent superfile survives with the split cell marked superseded"
);
assert!(
manifest.superfiles.len() > superfiles_before,
"child superfiles are appended, none removed"
);
}
/// One BATCHED commit splits BOTH populated cells
/// (`split_overflow_cell_batch`): the hidden manifest advances exactly
/// one id (one OCC publish for the whole batch), the grid grows by every
/// split's appended children, each parent's split cell is superseded,
/// and per-cell doc counts are conserved into that split's children.
#[test]
fn split_overflow_cell_batch_commits_once_and_conserves_docs() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::{
manifest::list::PartitionStrategy,
writer::{scan_cell_parents, split_overflow_cell_batch},
},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
// 8 rows at e_0 and 8 at e_1 → two distinct populated cells.
const N: usize = 16;
let titles = LargeStringArray::from((0..N).map(|i| format!("doc-{i}")).collect::<Vec<_>>());
let mut flat = vec![0.0f32; N * dim];
for r in 0..N {
flat[r * dim + usize::from(r >= N / 2)] = 1.0;
}
let fsl = FixedSizeListArray::new(
item_field.clone(),
dim as i32,
Arc::new(Float32Array::from(flat)),
None,
);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
st.drain_vectors_to_cells_sync().expect("drain to cells");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
let manifest_before = Arc::clone(hidden.reader().expect("reader").manifest());
let n_cent_before = match manifest_before.get_partition_strategy() {
PartitionStrategy::VectorCell { clusters, .. } => clusters.n_cent,
other => panic!("hidden must be VectorCell after drain, got {other:?}"),
};
let manifest_id_before = manifest_before.manifest_id;
let superfiles_before = manifest_before.superfiles.len();
let inner = hidden.inner().clone();
// Physical per-cell postings — the baseline the split pass selects
// and extracts from (the GRID's stamped counts also fold in the
// bootstrap commit's routing, so they can exceed the postings).
let (scan_counts, parents_by_cell) = hidden
.block_on_query(scan_cell_parents(&inner, &manifest_before, None))
.expect("cell index scan");
let mut populated: Vec<u32> = scan_counts
.iter()
.filter(|&(_, &n)| n > 0)
.map(|(&cell, _)| cell)
.collect();
populated.sort_unstable();
assert!(
populated.len() >= 2,
"two directions must drain into two cells, got {scan_counts:?}"
);
let outcome = hidden
.block_on_query(split_overflow_cell_batch(
&inner,
&manifest_before,
&populated,
0.0,
&parents_by_cell,
))
.expect("batched split");
// Every batch cell split (no defensive no-ops on planted data), and
// each split's children conserve the parent's indexed doc count.
assert_eq!(outcome.per_cell.len(), populated.len());
let mut appended_total = 0u32;
for (cell, result) in &outcome.per_cell {
let children = result
.as_ref()
.unwrap_or_else(|| panic!("cell {cell} must split, not no-op"));
assert!(children.len() >= 2, "a split has at least two children");
assert_eq!(children[0].0, *cell, "child 0 reuses the parent id");
appended_total += children.len() as u32 - 1;
let child_sum: u64 = children.iter().map(|(_, n)| *n).sum();
assert_eq!(
child_sum,
scan_counts.get(cell).copied().unwrap_or(0),
"children of cell {cell} conserve its physical postings"
);
}
let reader = hidden.reader().expect("reader");
let manifest = reader.manifest();
// Membership publishes ONCE; the batch's upload pin is its own
// etag-CAS stamp, so the id advances by two.
assert_eq!(
manifest.manifest_id,
manifest_id_before + 2,
"one upload-pin stamp + ONE membership commit"
);
match manifest.get_partition_strategy() {
PartitionStrategy::VectorCell { clusters, .. } => {
assert_eq!(
clusters.n_cent,
n_cent_before + appended_total,
"grid grows by every split's appended children"
);
// The batch's count stamp landed AFTER the grid fold: every
// child id is in range and carries its routed count.
for (cell, result) in &outcome.per_cell {
for (child, docs) in result.as_ref().expect("split") {
assert!(*child < clusters.n_cent, "child id in folded grid");
assert_eq!(
u64::from(clusters.counts[*child as usize]),
*docs,
"cell {cell} child {child} count stamped"
);
}
}
}
other => panic!("still VectorCell, got {other:?}"),
}
let superseded = manifest
.get_superseded_cells()
.expect("persisted list carries a superseded map");
for cell in &populated {
let parent_superseded = manifest.superfiles.iter().any(|e| {
superseded
.get(&e.superfile_id)
.is_some_and(|cells| cells.contains(cell))
});
assert!(
parent_superseded,
"cell {cell}'s parent survives with the cell marked superseded"
);
}
assert!(
manifest.superfiles.len() > superfiles_before,
"child superfiles are appended, none removed"
);
}
/// The bulk repack (`split_repack_bulk`) splits BOTH populated cells and
/// lands every child in ONE packed shard superfile (1-thread writer pool
/// ⇒ shard_count 1): one commit, write-once output, docs conserved,
/// parents superseded, and the slow-CAS upload pin cleared by the
/// publish.
#[test]
fn split_repack_bulk_lands_children_in_packed_shards() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::{
manifest::list::PartitionStrategy,
slow_vector_state,
writer::{scan_cell_parents, split_repack_bulk},
},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
const N: usize = 16;
let titles = LargeStringArray::from((0..N).map(|i| format!("doc-{i}")).collect::<Vec<_>>());
let mut flat = vec![0.0f32; N * dim];
for r in 0..N {
flat[r * dim + usize::from(r >= N / 2)] = 1.0;
}
let fsl = FixedSizeListArray::new(
item_field.clone(),
dim as i32,
Arc::new(Float32Array::from(flat)),
None,
);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
st.drain_vectors_to_cells_sync().expect("drain to cells");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
let manifest_before = Arc::clone(hidden.reader().expect("reader").manifest());
let n_cent_before = match manifest_before.get_partition_strategy() {
PartitionStrategy::VectorCell { clusters, .. } => clusters.n_cent,
other => panic!("hidden must be VectorCell after drain, got {other:?}"),
};
let manifest_id_before = manifest_before.manifest_id;
let superfiles_before = manifest_before.superfiles.len();
let inner = hidden.inner().clone();
let (scan_counts, parents_by_cell) = hidden
.block_on_query(scan_cell_parents(&inner, &manifest_before, None))
.expect("cell index scan");
let mut candidates: Vec<(u32, u64)> = scan_counts
.iter()
.filter(|&(_, &n)| n > 0)
.map(|(&cell, &n)| (cell, n))
.collect();
candidates.sort_unstable();
assert!(
candidates.len() >= 2,
"two directions must drain into two cells, got {scan_counts:?}"
);
let outcome = hidden
.block_on_query(split_repack_bulk(
&inner,
&manifest_before,
candidates.clone(),
0.0,
&parents_by_cell,
))
.expect("bulk repack");
let mut appended_total = 0u32;
for (cell, result) in &outcome.per_cell {
let children = result
.as_ref()
.unwrap_or_else(|| panic!("cell {cell} must split, not no-op"));
assert!(children.len() >= 2, "a split has at least two children");
assert_eq!(children[0].0, *cell, "child 0 reuses the parent id");
appended_total += children.len() as u32 - 1;
let child_sum: u64 = children.iter().map(|(_, n)| *n).sum();
let expected = candidates
.iter()
.find(|(c, _)| c == cell)
.map(|(_, n)| *n)
.unwrap_or(0);
assert_eq!(
child_sum, expected,
"children of cell {cell} conserve its physical postings"
);
}
let reader = hidden.reader().expect("reader");
let manifest = reader.manifest();
// Membership publishes ONCE; the single shard's slow-CAS upload pin
// is its own etag-CAS list+pointer stamp (the drain's per-shard
// checkpoint behavior), so the id advances by shards + 1.
assert_eq!(
manifest.manifest_id,
manifest_id_before + 2,
"one pin stamp (single shard) + ONE membership commit"
);
assert_eq!(
manifest.superfiles.len(),
superfiles_before + 1,
"every child lands in ONE packed shard superfile (shard_count 1) — write-once output"
);
match manifest.get_partition_strategy() {
PartitionStrategy::VectorCell { clusters, .. } => {
assert_eq!(
clusters.n_cent,
n_cent_before + appended_total,
"grid grows by every split's appended children"
);
}
other => panic!("still VectorCell, got {other:?}"),
}
let superseded = manifest
.get_superseded_cells()
.expect("persisted list carries a superseded map");
for (cell, _) in &candidates {
let parent_superseded = manifest.superfiles.iter().any(|e| {
superseded
.get(&e.superfile_id)
.is_some_and(|cells| cells.contains(cell))
});
assert!(
parent_superseded,
"cell {cell}'s parent survives with the cell marked superseded"
);
}
// The publish's own slow-state restamp carries no pending state:
// the upload pin is cleared atomically with the commit. The blob
// URI is relative to the HIDDEN table's prefixed provider, so load
// through it — not the user-root provider.
let (uri, hash) = manifest
.slow_vector_state_blob()
.expect("hidden manifest carries a slow-state ref");
let hidden_storage = inner
.options
.storage
.clone()
.expect("hidden table has storage");
let state = hidden
.block_on_query(slow_vector_state::load_full_state(
hidden_storage.as_ref(),
uri,
&hash,
))
.expect("slow state loads");
assert!(
state.pending_drain.is_none(),
"the repack's upload pin is cleared by the publish"
);
}
/// Storage wrapper for split failure-path tests: delegates to LocalFS
/// but fails superfile-data PUTs once armed, so a split's upload phase
/// errors after its pin stamp has landed.
#[derive(Debug)]
struct FailingDataPutStorage {
inner: crate::storage::LocalFsStorageProvider,
fail_data_puts: std::sync::atomic::AtomicBool,
}
impl FailingDataPutStorage {
fn arm(&self) {
self.fail_data_puts
.store(true, std::sync::atomic::Ordering::SeqCst);
}
}
#[async_trait::async_trait]
impl StorageProvider for FailingDataPutStorage {
async fn head(
&self,
uri: &str,
) -> Result<crate::storage::ObjectMeta, crate::storage::StorageError> {
self.inner.head(uri).await
}
async fn get(
&self,
uri: &str,
) -> Result<(bytes::Bytes, crate::storage::ObjectMeta), crate::storage::StorageError>
{
self.inner.get(uri).await
}
async fn get_range(
&self,
uri: &str,
range: std::ops::Range<u64>,
) -> Result<bytes::Bytes, crate::storage::StorageError> {
self.inner.get_range(uri, range).await
}
async fn put_atomic(
&self,
uri: &str,
bytes: bytes::Bytes,
) -> Result<Option<String>, crate::storage::StorageError> {
if self
.fail_data_puts
.load(std::sync::atomic::Ordering::SeqCst)
&& uri.contains("data/")
{
return Err(crate::storage::StorageError::NotFound {
uri: format!("injected data PUT failure: {uri}"),
});
}
self.inner.put_atomic(uri, bytes).await
}
async fn put_if_match(
&self,
uri: &str,
bytes: bytes::Bytes,
expected_etag: Option<&str>,
) -> Result<Option<String>, crate::storage::StorageError> {
self.inner.put_if_match(uri, bytes, expected_etag).await
}
async fn put_multipart(
&self,
uri: &str,
) -> Result<Box<dyn object_store::MultipartUpload>, crate::storage::StorageError> {
self.inner.put_multipart(uri).await
}
async fn delete(&self, uri: &str) -> Result<(), crate::storage::StorageError> {
self.inner.delete(uri).await
}
}
/// A publish that fails AFTER the pre-upload pin stamp must release the
/// pin on the way out — otherwise an idle table keeps the aborted
/// output in gc's live set forever.
#[test]
fn failed_split_publish_releases_upload_pin() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::{slow_vector_state, writer::split_overflow_cell},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let failing = Arc::new(FailingDataPutStorage {
inner: LocalFsStorageProvider::new(dir.path()).expect("provider"),
fail_data_puts: std::sync::atomic::AtomicBool::new(false),
});
let storage: Arc<dyn StorageProvider> = Arc::clone(&failing) as Arc<dyn StorageProvider>;
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
const N: usize = 16;
let titles = LargeStringArray::from((0..N).map(|i| format!("doc-{i}")).collect::<Vec<_>>());
let mut flat = vec![0.0f32; N * dim];
for r in 0..N {
flat[r * dim + usize::from(r >= N / 2)] = 1.0;
}
let fsl = FixedSizeListArray::new(
item_field.clone(),
dim as i32,
Arc::new(Float32Array::from(flat)),
None,
);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
st.drain_vectors_to_cells_sync().expect("drain to cells");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
let superfiles_before = hidden.reader().expect("reader").manifest().superfiles.len();
// Child uploads fail from here on; the pin stamp and its unpin go
// to non-data prefixes and still succeed.
failing.arm();
let busiest = 0u32; // any populated cell works; 0 always exists
let result =
hidden.block_on_query(split_overflow_cell(hidden.inner().clone(), busiest, 0.0));
// Cell 0 may be unpopulated (defensive no-op) on some grids; make
// the test deterministic by trying every cell until one attempts a
// publish and fails.
let mut publish_failed = result.is_err();
if !publish_failed {
let n_cent = match hidden
.reader()
.expect("reader")
.manifest()
.get_partition_strategy()
{
crate::supertable::manifest::list::PartitionStrategy::VectorCell {
clusters,
..
} => clusters.n_cent,
_ => 0,
};
for cell in 1..n_cent {
if hidden
.block_on_query(split_overflow_cell(hidden.inner().clone(), cell, 0.0))
.is_err()
{
publish_failed = true;
break;
}
}
}
assert!(publish_failed, "injected data-PUT failure must surface");
let reader = hidden.reader().expect("reader");
let manifest = reader.manifest();
assert_eq!(
manifest.superfiles.len(),
superfiles_before,
"no membership published by the failed split"
);
// The pin was released on the failure path: pending state is clear.
let (uri, hash) = manifest
.slow_vector_state_blob()
.expect("hidden manifest carries a slow-state ref");
let hidden_storage = hidden
.inner()
.options
.storage
.clone()
.expect("hidden table has storage");
let state = hidden
.block_on_query(slow_vector_state::load_full_state(
hidden_storage.as_ref(),
uri,
&hash,
))
.expect("slow state loads");
assert!(
state.pending_drain.is_none(),
"the failed publish released its upload pin"
);
}
/// A stale repack upload pin in the slow-CAS pending state must not
/// brick the drain: the checkpoint loader recognizes the foreign schema
/// and ignores it (pre-fix this failed with a checkpoint decode error).
#[test]
fn drain_tolerates_foreign_repack_pin() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::{
slow_vector_state::PendingDrainState,
writer::{REPACK_CHECKPOINT_SCHEMA, stamp_slow_vector_state},
},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
const N: usize = 4;
let titles = LargeStringArray::from((0..N).map(|i| format!("doc-{i}")).collect::<Vec<_>>());
let flat = Float32Array::from(vec![1.0f32; N * dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
// Plant a foreign (repack-schema) pin, as an aborted repack would
// leave behind.
let hidden = st.vector_index_table().expect("hidden index").clone();
let metadata = serde_json::to_vec(&serde_json::json!({
"schema": REPACK_CHECKPOINT_SCHEMA
}))
.expect("pin metadata");
hidden
.block_on_query(stamp_slow_vector_state(
hidden.inner(),
Some(PendingDrainState {
metadata,
entries: Vec::new(),
}),
))
.expect("plant foreign pin");
// The drain must ignore the pin and proceed (its own checkpoint
// stamp then supersedes it, releasing any pinned orphans).
st.drain_vectors_to_cells_sync()
.expect("drain proceeds past a foreign repack pin");
}
/// The reverse direction of the pin/checkpoint coexistence: a split
/// whose pin stamp finds a stale DRAIN checkpoint in the pending slot
/// replaces it (with a warning) and proceeds — inside optimize the
/// drain phase precedes the split pass, so a surviving drain pin is
/// unconsumable by construction.
#[test]
fn split_pin_replaces_stale_drain_checkpoint() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::{
manifest::list::PartitionStrategy,
slow_vector_state::PendingDrainState,
writer::{DRAIN_CHECKPOINT_SCHEMA, split_overflow_cell, stamp_slow_vector_state},
},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
const N: usize = 6;
let titles = LargeStringArray::from((0..N).map(|i| format!("doc-{i}")).collect::<Vec<_>>());
let flat = Float32Array::from(vec![1.0f32; N * dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
st.drain_vectors_to_cells_sync().expect("drain to cells");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
// Plant a stale DRAIN-schema checkpoint, as a crashed drain would
// leave behind if the next drain had nothing to resume.
let metadata = serde_json::to_vec(&serde_json::json!({
"schema": DRAIN_CHECKPOINT_SCHEMA
}))
.expect("pin metadata");
hidden
.block_on_query(stamp_slow_vector_state(
hidden.inner(),
Some(PendingDrainState {
metadata,
entries: Vec::new(),
}),
))
.expect("plant stale drain checkpoint");
let split_cell = match hidden
.reader()
.expect("reader")
.manifest()
.get_partition_strategy()
{
PartitionStrategy::VectorCell { clusters, .. } => (0..clusters.n_cent)
.max_by_key(|&c| clusters.counts.get(c as usize).copied().unwrap_or(0))
.expect("cell"),
other => panic!("not VectorCell: {other:?}"),
};
let outcome = hidden
.block_on_query(split_overflow_cell(hidden.inner().clone(), split_cell, 0.0))
.expect("split proceeds over the stale drain checkpoint");
assert!(outcome.is_some(), "split must commit");
}
/// Directly exercises the over-cap cell split (`split_overflow_cell`). The
/// normal `optimize` path only reaches it once a cell passes the 500k
/// `cell_split_doc_cap`; calling the inner routine on a drained cell covers
/// the extract → split → rebuild → atomic-swap chain without that volume. The
/// split must add a sub-cell to the grid and lose no doc.
#[test]
fn split_overflow_cell_grows_grid_and_preserves_docs() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
superfile::{
builder::{FtsConfig, VectorConfig},
reader::VectorSearchOptions,
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::{manifest::list::PartitionStrategy, writer::split_overflow_cell},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
// Identical embeddings route every doc into one global cell; drain them
// into the hidden per-cell index so a single real cell holds all N.
const N: usize = 6;
let titles = LargeStringArray::from((0..N).map(|i| format!("doc-{i}")).collect::<Vec<_>>());
let flat = Float32Array::from(vec![1.0f32; N * dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
st.drain_vectors_to_cells_sync().expect("drain to cells");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
// The most-populated cell in the hidden grid holds all N docs.
let (split_cell, n_cent_before, docs_in_cell) = match hidden
.reader()
.expect("reader")
.manifest()
.get_partition_strategy()
{
PartitionStrategy::VectorCell { clusters, .. } => {
let cell = (0..clusters.n_cent)
.max_by_key(|&c| clusters.counts.get(c as usize).copied().unwrap_or(0))
.expect("at least one cell");
(cell, clusters.n_cent, clusters.counts[cell as usize])
}
other => panic!("hidden index must be VectorCell after drain, got {other:?}"),
};
assert!(docs_in_cell >= 2, "the split cell needs at least two docs");
// Sanity: the drained docs are retrievable before the split.
let q = vec![1.0f32; dim];
let hits_before = st
.reader()
.expect("reader")
.vector_hits("emb", &q, N, VectorSearchOptions::new(), None)
.expect("pre-split search");
assert!(!hits_before.is_empty(), "docs retrievable before split");
// Split the over-cap cell directly (bypasses the 500k cap gate).
let split_outcome = hidden
.block_on_query(split_overflow_cell(hidden.inner().clone(), split_cell, 0.0))
.expect("split");
assert!(
split_outcome.is_some(),
"live rows present, split must commit"
);
// The grid gained a sub-cell, and the two sub-cells together account for
// exactly the live docs (`split_cell` keeps its id; the new cell is
// appended at the old `n_cent`). Routing-independent — it reads the
// counts the split re-derives from the actual live rows, which also
// corrects the pre-split grid count (that count can lag the true total).
match hidden
.reader()
.expect("reader")
.manifest()
.get_partition_strategy()
{
PartitionStrategy::VectorCell { clusters, .. } => {
assert_eq!(
clusters.n_cent,
n_cent_before + 1,
"split inserts one sub-centroid into the grid"
);
let kept = clusters.counts[split_cell as usize];
let moved = clusters.counts[n_cent_before as usize];
assert_eq!(
kept + moved,
N as u32,
"the two sub-cells must account for every live doc"
);
}
other => panic!("still VectorCell after split, got {other:?}"),
}
}
/// A committed cell split ALONE — without the pass-final in-process
/// `refresh_slow_vector_state` that production maintenance tacks onto the
/// end of the hidden pass — must leave every doc retrievable, both
/// in-process and after a reopen from storage. The split's own commit
/// (`try_commit_attempt` step 2b) publishes the slow-state blob + centroid
/// section for the post-split membership; if that publication disagrees
/// with what the refresh composes, a crash between the split commit and
/// the refresh leaves the table durably under-serving (0 hits from every
/// cell, including cells the split never touched) with no recovery path —
/// reopen re-hydrates the broken state and a post-reopen `optimize`
/// republishes it unchanged. Two populated cells are required to expose
/// the mismatch.
#[test]
fn split_commit_without_refresh_keeps_docs_retrievable() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
superfile::{
builder::{FtsConfig, VectorConfig},
reader::VectorSearchOptions,
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::{manifest::list::PartitionStrategy, writer::split_overflow_cell},
};
/// Docs planted per orthogonal direction (two directions → the two
/// populated cells the repro needs).
const ROWS_PER_DIRECTION: usize = 8;
/// Total planted docs.
const N_TOTAL: usize = 2 * ROWS_PER_DIRECTION;
/// Probe width covering every cell before and after the split.
const SPLIT_NPROBE: usize = 64;
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let dir = TempDir::new().expect("tempdir");
let make_options = || {
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool)
};
let st = Supertable::create(make_options()).expect("create");
// Two orthogonal directions, ROWS_PER_DIRECTION docs each, in ONE
// commit so the grid trains on both and the drain populates two cells.
let titles =
LargeStringArray::from((0..N_TOTAL).map(|i| format!("doc-{i}")).collect::<Vec<_>>());
let mut vectors = vec![0.0f32; N_TOTAL * dim];
for i in 0..N_TOTAL {
vectors[i * dim + i / ROWS_PER_DIRECTION] = 1.0;
}
let flat = Float32Array::from(vectors);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
st.drain_vectors_to_cells_sync().expect("drain to cells");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
// Exhaustive-width retrieval per planted direction: with k = N_TOTAL
// and every cell probed, each query must surface every live doc, so
// the count reads as true retrievability rather than ranking.
let live_hit_count = |table: &Supertable, direction: usize| {
let mut q = vec![0.0f32; dim];
q[direction] = 1.0;
table
.reader()
.expect("reader")
.vector_hits(
"emb",
&q,
N_TOTAL,
VectorSearchOptions::new().with_nprobe(SPLIT_NPROBE),
None,
)
.expect("vector search")
.len()
};
for direction in 0..2 {
assert_eq!(
live_hit_count(&st, direction),
N_TOTAL,
"all docs resolve before the split (direction {direction})"
);
}
let split_cell = match hidden
.reader()
.expect("reader")
.manifest()
.get_partition_strategy()
{
PartitionStrategy::VectorCell { clusters, .. } => (0..clusters.n_cent)
.max_by_key(|&c| clusters.counts.get(c as usize).copied().unwrap_or(0))
.expect("a populated cell"),
other => panic!("hidden must be VectorCell after drain, got {other:?}"),
};
hidden
.block_on_query(split_overflow_cell(hidden.inner().clone(), split_cell, 0.0))
.expect("split")
.expect("live rows present, split commits");
// Deliberately NO refresh_slow_vector_state here: the split commit's
// own slow-state publication is the durable state a crash right after
// the commit leaves behind, and it must serve on its own.
for direction in 0..2 {
assert_eq!(
live_hit_count(&st, direction),
N_TOTAL,
"all docs resolve after the split commit alone (direction {direction})"
);
}
// The same durable state must serve a fresh process: reopen from
// storage and retrieve every doc again.
drop(hidden);
drop(st);
let reopened = Supertable::open(make_options()).expect("reopen");
for direction in 0..2 {
assert_eq!(
live_hit_count(&reopened, direction),
N_TOTAL,
"all docs resolve after reopen from post-split state (direction {direction})"
);
}
}
/// Regression for the stale-probe-law path: (1) a clean drain stamps
/// BOTH laws — probe width and fine depth — into the manifest routing
/// (fine depth is what a flat `fine_nprobe_floor` regressed at 10M:
/// post-drain 0.982 at floor 4 vs 0.996 at 8); (2) after a geometry
/// change (cell split), `recalibrate_probe_laws` re-measures from
/// stored bytes and restamps: width REPLACEs (fresh full-table
/// measurement is authoritative, must be able to narrow), fine depth
/// and rerank MAX-MERGE (never shallowed below a certified stamp),
/// and a point the fresh sample cannot support keeps its previous
/// value under both rules.
#[test]
fn drain_stamps_both_laws_and_recalibration_restamps_after_split() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::{
manifest::list::PartitionStrategy,
writer::{
CommitListMetadata, persist_commit_async, recalibrate_probe_laws,
split_overflow_cell,
},
},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
// Identical embeddings route every doc into one global cell, so the
// drain calibrates over one populated cell and the later split has a
// cell to cut.
const N: usize = 6;
let titles = LargeStringArray::from((0..N).map(|i| format!("doc-{i}")).collect::<Vec<_>>());
let flat = Float32Array::from(vec![1.0f32; N * dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
st.drain_vectors_to_cells_sync().expect("drain to cells");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
// (1) The clean drain stamped both laws. Six identical rows support
// the k=1 and k=10 points (5 non-self candidates each), so both laws
// must be nonzero there; the fine depth comes from the post-pack
// shard observation.
let read_strategy = |hidden: &Supertable| match hidden
.reader()
.expect("reader")
.manifest()
.get_partition_strategy()
{
PartitionStrategy::VectorCell {
clusters,
column,
routing,
} => (clusters, column, routing),
other => panic!("hidden index must be VectorCell, got {other:?}"),
};
let (_, _, routing) = read_strategy(&hidden);
assert!(
routing.width_for_k[0] > 0,
"drain must stamp the width law, got {:?}",
routing.width_for_k
);
assert!(
routing.fine_for_k[0] > 0,
"drain must stamp the fine-depth law, got {:?}",
routing.fine_for_k
);
assert!(
routing.rerank_for_k[0] > 0,
"drain must stamp the rerank law, got {:?}",
routing.rerank_for_k
);
// Split the populated cell: the stamped law now describes a grid
// that no longer exists (the split swap ports routing verbatim).
let (clusters, _, _) = read_strategy(&hidden);
let split_cell = (0..clusters.n_cent)
.max_by_key(|&c| clusters.counts.get(c as usize).copied().unwrap_or(0))
.expect("at least one cell");
hidden
.block_on_query(split_overflow_cell(hidden.inner().clone(), split_cell, 0.0))
.expect("split")
.expect("live rows present, split must commit");
// Plant a stale law as an old-geometry stamp would carry: an
// over-wide width, a deeper-than-measurable fine point at k=1, and
// no rerank. Six rows cannot support k=100/1000, so the fresh
// measurement is 0 there and those planted points must survive the
// restamp; the deep fine point must survive too (fine max-merges —
// a fresh sample must never shallow a certified depth), while the
// over-wide width must be REPLACED by the fresh measurement.
const STALE_WIDTH: u32 = 33;
const STALE_FINE: u32 = 9;
let (clusters, column, mut planted) = read_strategy(&hidden);
planted.width_for_k = [STALE_WIDTH; 4];
planted.fine_for_k = [STALE_FINE, 0, 0, 0];
planted.rerank_for_k = [0; 4];
let list_metadata = CommitListMetadata {
partition_strategy: Some(PartitionStrategy::VectorCell {
column,
clusters,
routing: planted,
}),
drained_ranges: None,
global_vector_index: None,
superseded_cells_additions: None,
};
let no_removals = Vec::new();
// The hidden table's own scoped provider — its pointer file, not the
// user table's, is the CAS target.
let hidden_storage = hidden
.inner()
.options
.storage
.clone()
.expect("hidden table has storage");
let planted_manifest = hidden
.block_on_query(persist_commit_async(
hidden.inner(),
hidden_storage,
Vec::new(),
&no_removals,
Vec::new(),
Vec::new(),
list_metadata,
))
.expect("plant stale law");
hidden.inner().manifest.store(Arc::new(planted_manifest));
// (2) Recalibration re-measures both laws over the post-split grid
// from stored bytes and stamps the difference.
let stamped = hidden
.block_on_query(recalibrate_probe_laws(hidden.inner()))
.expect("recalibrate");
assert!(stamped, "a stale law over a changed grid must restamp");
let (clusters, _, routing) = read_strategy(&hidden);
assert!(
routing.width_for_k[0] >= 1 && routing.width_for_k[0] <= clusters.n_cent,
"k=1 width re-measured within the live grid, got {:?}",
routing.width_for_k
);
assert!(
routing.width_for_k[0] < STALE_WIDTH,
"measured points replace the stale value, got {:?}",
routing.width_for_k
);
// The distinguishing max-merge check: the fresh sample DOES measure
// fine depth at k=1 (a 1-2 on this tiny grid), so a REPLACE rule
// would stamp that shallow value — only max-merge keeps the deeper
// certified 9. (Fresh stamping from zero is evidenced by the rerank
// law below; end-to-end fine restamping by the recall-guard test in
// `query::vector::tests`.)
assert_eq!(
routing.fine_for_k[0], STALE_FINE,
"fine depth max-merges: recalibration must never shallow a \
stamp a previous measurement certified, got {:?}",
routing.fine_for_k
);
assert!(
routing.rerank_for_k[0] > 0,
"recalibration must stamp the rerank law, got {:?}",
routing.rerank_for_k
);
assert_eq!(
routing.width_for_k[3], STALE_WIDTH,
"a point the sample cannot support keeps its previous value"
);
}
/// Recalibration over a heavily tombstoned table, twice. (1) The query
/// sampler lays its strides over PHYSICAL (tombstone-inclusive) counts
/// but loads live-only rows — regression for the biased-sample review
/// finding: the old clamp collapsed every tail pick onto the last live
/// row, so a 10-live-of-50 cell filled the sample with one
/// neighborhood. With most rows deleted the pass must still measure
/// and stamp usable laws from the spread live sample. (2) Immediately
/// recalibrating again re-measures identical laws against an unchanged
/// grid and must return `false` — no empty stamp commit.
#[test]
fn recalibration_samples_live_rows_and_is_idempotent() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use datafusion::prelude::{col, lit};
use crate::{
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::{
manifest::list::PartitionStrategy,
writer::{CommitListMetadata, persist_commit_async, recalibrate_probe_laws},
},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
// 48 identical embeddings (one populated cell); most rows carry the
// doomed title so the delete leaves the cell heavily tombstoned:
// 8 live of 48 physical.
const N: usize = 48;
const N_LIVE: usize = 8;
let titles = LargeStringArray::from(
(0..N)
.map(|i| {
if i < N_LIVE {
format!("keep-{i}")
} else {
"dropme".to_string()
}
})
.collect::<Vec<_>>(),
);
let flat = Float32Array::from(vec![1.0f32; N * dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
drop(w);
st.drain_vectors_to_cells_sync().expect("drain to cells");
let stats = st.delete(col("title").eq(lit("dropme"))).expect("delete");
assert_eq!(
stats.n_tombstoned() as usize,
N - N_LIVE,
"delete must tombstone the doomed rows"
);
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
// Plant an over-wide stale width so the first pass has a measurable
// change to stamp regardless of what the drain calibrated.
const STALE_WIDTH: u32 = 33;
let strategy = hidden
.reader()
.expect("hidden reader")
.manifest()
.get_partition_strategy();
let PartitionStrategy::VectorCell {
clusters,
column,
routing: mut planted,
} = strategy
else {
panic!("hidden index must be VectorCell");
};
planted.width_for_k = [STALE_WIDTH; 4];
let list_metadata = CommitListMetadata {
partition_strategy: Some(PartitionStrategy::VectorCell {
column,
clusters,
routing: planted,
}),
drained_ranges: None,
global_vector_index: None,
superseded_cells_additions: None,
};
let no_removals = Vec::new();
let hidden_storage = hidden
.inner()
.options
.storage
.clone()
.expect("hidden table has storage");
let planted_manifest = hidden
.block_on_query(persist_commit_async(
hidden.inner(),
hidden_storage,
Vec::new(),
&no_removals,
Vec::new(),
Vec::new(),
list_metadata,
))
.expect("plant stale law");
hidden.inner().manifest.store(Arc::new(planted_manifest));
// (1) Heavily tombstoned recalibration measures from the live rows.
let stamped = hidden
.block_on_query(recalibrate_probe_laws(hidden.inner()))
.expect("recalibrate over tombstones");
assert!(stamped, "the planted stale width must restamp");
let strategy = hidden
.reader()
.expect("hidden reader")
.manifest()
.get_partition_strategy();
let PartitionStrategy::VectorCell { routing, .. } = strategy else {
panic!("hidden index must stay VectorCell");
};
assert!(
routing.width_for_k[0] >= 1 && routing.width_for_k[0] < STALE_WIDTH,
"live-sample measurement replaces the stale width, got {:?}",
routing.width_for_k
);
// (2) Nothing changed since — the repeat pass must decline to stamp.
let restamped = hidden
.block_on_query(recalibrate_probe_laws(hidden.inner()))
.expect("repeat recalibrate");
assert!(
!restamped,
"an unchanged grid re-measures identical laws — no empty stamp commit"
);
// (3) A never-calibrated grid is left alone: zero the width law and
// recalibration must decline — the drain gate is the calibration
// entry point; this pass only refreshes an existing law.
let strategy = hidden
.reader()
.expect("hidden reader")
.manifest()
.get_partition_strategy();
let PartitionStrategy::VectorCell {
clusters,
column,
routing: mut zeroed,
} = strategy
else {
panic!("hidden index must stay VectorCell");
};
zeroed.width_for_k = [0; 4];
let zero_metadata = CommitListMetadata {
partition_strategy: Some(PartitionStrategy::VectorCell {
column,
clusters,
routing: zeroed,
}),
drained_ranges: None,
global_vector_index: None,
superseded_cells_additions: None,
};
let zero_manifest = hidden
.block_on_query(persist_commit_async(
hidden.inner(),
hidden
.inner()
.options
.storage
.clone()
.expect("hidden table has storage"),
Vec::new(),
&no_removals,
Vec::new(),
Vec::new(),
zero_metadata,
))
.expect("plant zero law");
hidden.inner().manifest.store(Arc::new(zero_manifest));
let stamped = hidden
.block_on_query(recalibrate_probe_laws(hidden.inner()))
.expect("recalibrate on an uncalibrated grid is a clean no-op");
assert!(
!stamped,
"an all-zero width law must not trigger calibration"
);
}
/// The cleared-law repair, end to end through the PUBLIC `optimize()`:
/// a table whose stamped width outgrew the rerank calibration pool
/// serves the constant `rerank_mult` forever if nothing reshapes it
/// (the reshape-only trigger never fires — the measured vdbb state).
/// Optimize must now detect the lag, recalibrate with a
/// geometry-sized pool, and stamp a served rerank law.
#[test]
fn optimize_repairs_a_rerank_law_cleared_beyond_its_pool() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
config::OptimizeOptions,
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::{
manifest::list::PartitionStrategy,
opann,
writer::{CommitListMetadata, persist_commit_async},
},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(Arc::clone(&storage))
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
const N: usize = 6;
let titles = LargeStringArray::from((0..N).map(|i| format!("doc-{i}")).collect::<Vec<_>>());
let flat = Float32Array::from(vec![1.0f32; N * dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
drop(w);
st.drain_vectors_to_cells_sync().expect("drain to cells");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
let read_routing = |hidden: &Supertable| match hidden
.reader()
.expect("hidden reader")
.manifest()
.get_partition_strategy()
{
PartitionStrategy::VectorCell { routing, .. } => routing,
other => panic!("hidden index must be VectorCell, got {other:?}"),
};
// Plant the cleared-law shape at THIS fixture's scale: a width
// past the recorded pool with rerank zeroed, and a recorded pool
// below what the grid affords — the same repairable signature as
// the measured 1M state (widths 79-104 over a 64 pool on a
// 256-cell grid), shrunk so the fixture stays small. No reshape
// follows, so only the lag trigger can repair it.
const STALE_WIDE: u32 = 5;
/// Recorded pool planted BELOW the grid's achievable pool.
const PLANTED_POOL: u32 = 2;
let strategy = hidden
.reader()
.expect("hidden reader")
.manifest()
.get_partition_strategy();
let PartitionStrategy::VectorCell {
clusters,
column,
routing: mut planted,
} = strategy
else {
panic!("hidden index must be VectorCell");
};
planted.width_for_k = [STALE_WIDE, 0, 0, 0];
planted.rerank_for_k = [0; 4];
planted.rerank_pool_cells = [PLANTED_POOL; 4];
let list_metadata = CommitListMetadata {
partition_strategy: Some(PartitionStrategy::VectorCell {
column,
clusters,
routing: planted,
}),
drained_ranges: None,
global_vector_index: None,
superseded_cells_additions: None,
};
let no_removals = Vec::new();
let hidden_storage = hidden
.inner()
.options
.storage
.clone()
.expect("hidden table has storage");
let planted_manifest = hidden
.block_on_query(persist_commit_async(
hidden.inner(),
hidden_storage,
Vec::new(),
&no_removals,
Vec::new(),
Vec::new(),
list_metadata,
))
.expect("plant cleared law");
hidden.inner().manifest.store(Arc::new(planted_manifest));
let achievable = |hidden: &Supertable| {
let strategy = hidden
.reader()
.expect("hidden reader")
.manifest()
.get_partition_strategy();
let PartitionStrategy::VectorCell { clusters, .. } = strategy else {
panic!("hidden index must be VectorCell");
};
opann::rerank_pool_hint(&read_routing(hidden).width_for_k, clusters.n_cent as usize)
as u32
};
assert!(
read_routing(&hidden).rerank_law_lags_pool(achievable(&hidden)),
"the planted state must read as lagging"
);
st.optimize(&OptimizeOptions::default()).expect("optimize");
let repaired = read_routing(&hidden);
assert!(
!repaired.rerank_law_lags_pool(achievable(&hidden)),
"optimize must repair the cleared law, got {repaired:?}"
);
assert!(
repaired.rerank_for_k[0] > 0,
"the repaired law serves a measured budget at a supported k, got {:?}",
repaired.rerank_for_k
);
assert!(
repaired.width_for_k[0] < STALE_WIDE,
"recalibration replaced the stale width, got {:?}",
repaired.width_for_k
);
}
/// End-to-end reclaim loop: a cell split appends its children and marks the
/// parent cell superseded (no removal); a later merge drops those superseded
/// blocks and reclaims the parent. Every doc must resolve exactly once at
/// each stage — no loss (children carry them) and no resurrection (the merge
/// must not carry the superseded parent copy alongside the children).
#[test]
fn split_then_merge_reclaims_superseded_without_resurrection() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
superfile::{
builder::{FtsConfig, VectorConfig},
reader::VectorSearchOptions,
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::{
manifest::list::PartitionStrategy,
writer::{refresh_slow_vector_state, split_overflow_cell},
},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
// Identical embeddings route every doc into one global cell.
const N: usize = 6;
let titles = LargeStringArray::from((0..N).map(|i| format!("doc-{i}")).collect::<Vec<_>>());
let flat = Float32Array::from(vec![1.0f32; N * dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
st.drain_vectors_to_cells_sync().expect("drain to cells");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
// Query top-2N: only N docs exist, so exactly N hits is both "no loss"
// and "no duplicate". Reused after split and after merge.
let q = vec![1.0f32; dim];
// Exhaustive probe (every cell) so the count measures true
// retrievability — conservation — not nprobe routing. A split or merge
// that silently drops rows or leaves them unroutable shows up as != N.
const EXHAUSTIVE_NPROBE: usize = 1 << 12;
let live_hit_count = || {
st.reader()
.expect("reader")
.vector_hits(
"emb",
&q,
2 * N,
VectorSearchOptions::new().with_nprobe(EXHAUSTIVE_NPROBE),
None,
)
.expect("vector search")
.len()
};
assert_eq!(live_hit_count(), N, "all docs resolve before the split");
let split_cell = match hidden
.reader()
.expect("reader")
.manifest()
.get_partition_strategy()
{
PartitionStrategy::VectorCell { clusters, .. } => (0..clusters.n_cent)
.max_by_key(|&c| clusters.counts.get(c as usize).copied().unwrap_or(0))
.expect("a populated cell"),
other => panic!("hidden must be VectorCell after drain, got {other:?}"),
};
hidden
.block_on_query(split_overflow_cell(hidden.inner().clone(), split_cell, 0.0))
.expect("split")
.expect("live rows present, split commits");
// Publish the post-split slow state so the query path sees the new grid
// + child superfiles — production does this at the end of `compact`.
let hinner = hidden.inner().clone();
hidden
.block_on_query(refresh_slow_vector_state(&hinner))
.expect("refresh slow state after split");
// After the split the parent still holds the (now superseded) cell, yet
// the children carry the live rows — so the doc count is unchanged.
assert_eq!(live_hit_count(), N, "all docs resolve after the split");
{
let reader = hidden.reader().expect("reader");
let manifest = reader.manifest();
assert!(
manifest
.get_superseded_cells()
.is_some_and(|m| m.values().any(|cells| cells.contains(&split_cell))),
"the split cell is marked superseded on its parent"
);
}
// Merge the hidden index: the superseded parent blocks are dropped and
// the parent superfile is reclaimed.
hidden
.compact(&hidden_vector_index_compaction_settings())
.expect("hidden merge");
let reader = hidden.reader().expect("reader");
let manifest = reader.manifest();
// Conservation: exactly N live physical docs remain — no loss (children
// carried them) and no resurrection (the superseded parent copy was not
// carried into the merged output; that would read as 2N).
let live_docs: u64 = manifest.get_all_superfiles().iter().map(|e| e.n_docs).sum();
assert_eq!(
live_docs, N as u64,
"post-merge physical docs equal N — no loss, no resurrection"
);
assert!(
manifest.get_superseded_cells().is_none_or(|m| m.is_empty()),
"the reclaimed parent's superseded marker is dropped by the merge"
);
// Exhaustive retrieval must still return exactly N after the merge —
// catches a merge that silently drops rows or leaves them unroutable
// (half-recall), which a `> 0` check would miss.
assert_eq!(
live_hit_count(),
N,
"all docs retrievable after the merge — no loss, no half-recall"
);
}
/// Regression: `optimize` must run the hidden cell-split phase on a handle
/// built at table CREATE time, in the same process, with no reopen. The
/// split gate in `compact_one_table` once keyed on the handle's options —
/// but a create-era hidden handle has no user manifest to train a grid
/// from, so its options never carry a VectorCell strategy (only the first
/// drain locks it into the manifest), and the options-keyed gate silently
/// skipped every split until the table was reopened elsewhere. This pins
/// the manifest-keyed gate through the public `optimize()` entry.
#[test]
fn optimize_runs_split_phase_on_create_era_handle() {
// The 500k `cell_split_doc_cap` is out of unit-test reach and config is
// process-global, so the fixture leans on the default modality trigger
// instead: a cell holding >= MODALITY_MIN_CELL_DOCS rows in MORE than
// the whole-mode grouping factor (4 modes, `opann::cell_split_plan`)
// of well-separated modes splits under `optimize`.
const DIM: usize = 16;
/// One-hot modes e_0..e_7 — more than the 4-modes-per-cell grouping
/// stop, so the modality plan must split the cell.
const MODES: usize = 8;
const DOCS_PER_MODE: usize = 64;
const N: usize = MODES * DOCS_PER_MODE;
assert!(
N as u64 >= MODALITY_MIN_CELL_DOCS,
"fixture must reach the modality trigger's minimum cell size"
);
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), DIM as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim: DIM,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool)
// A single hidden cell: every mode drains into cell 0, making it the
// one over-populated multimodal cell the split phase must act on.
.with_vector_cell_counts(1, 1);
// The handle under test comes from CREATE and is never reopened.
let st = Supertable::create(options).expect("create");
let titles = LargeStringArray::from((0..N).map(|i| format!("doc-{i}")).collect::<Vec<_>>());
let mut flat = vec![0.0f32; N * DIM];
for r in 0..N {
let mode = r / DOCS_PER_MODE;
flat[r * DIM + mode] = 1.0;
// Tiny deterministic jitter on a component no mode occupies keeps
// within-mode variance non-zero (no 0/0 Ashman-D corner) while the
// modes stay maximally separated.
flat[r * DIM + MODES + mode] = ((r % 5) as f32 - 2.0) * 1e-3;
}
let fsl = FixedSizeListArray::new(
item_field,
DIM as i32,
Arc::new(Float32Array::from(flat)),
None,
);
let batch = RecordBatch::try_new(
schema,
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
st.drain_vectors_to_cells_sync().expect("drain to cells");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
match hidden
.reader()
.expect("reader")
.manifest()
.get_partition_strategy()
{
PartitionStrategy::VectorCell { clusters, .. } => {
assert_eq!(clusters.n_cent, 1, "single-cell grid before optimize");
// Grid counts are maintenance bookkeeping (they tally the
// incoming region as well as the drained cells), so only the
// populated/empty distinction is asserted here.
assert!(clusters.counts[0] > 0, "the one cell is populated");
}
other => panic!("hidden must be VectorCell after drain, got {other:?}"),
}
st.optimize(&OptimizeOptions::default()).expect("optimize");
// No reopen: the same create-era handles observe the split. The grid
// must have grown past one cell (doc preservation across a split is
// pinned by the dedicated `split_overflow_cell_*` tests).
let reader = hidden.reader().expect("reader");
match reader.manifest().get_partition_strategy() {
PartitionStrategy::VectorCell { clusters, .. } => {
assert!(
clusters.n_cent > 1,
"optimize on a create-era handle must run the split phase; \
grid stayed at {} cell(s)",
clusters.n_cent
);
}
other => panic!("hidden stays VectorCell after optimize, got {other:?}"),
}
}
/// With writer_pool=N>1 and multiple touched cells, drain publishes at most
/// N packed shard objects and stamps partition_hint = shard_id (cell % N).
#[test]
fn drain_packs_cells_into_at_most_writer_pool_shards() {
use std::{collections::HashSet, sync::Arc};
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, layout::VectorLayout, rerank_codec::RerankCodec},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
const POOL: usize = 2;
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(POOL)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
// Train the initial grid from distinct directions in ONE commit. Using
// one row per commit would train the immutable grid from the first
// single row, leaving every centroid identical and failing to exercise
// multi-cell shard packing.
let titles =
LargeStringArray::from((0..8usize).map(|i| format!("doc{i}")).collect::<Vec<_>>());
let mut vectors = vec![0.0f32; 8 * dim];
for i in 0..8usize {
vectors[i * dim + (i % dim)] = 1.0;
}
let flat = Float32Array::from(vectors);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
st.drain_vectors_to_cells_sync().expect("drain");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden")
.clone();
assert_eq!(
hidden.options().writer_pool.current_num_threads(),
POOL,
"hidden drain must inherit the user table's configured writer pool"
);
let hidden_reader = hidden.reader().expect("reader");
let manifest = hidden_reader.manifest();
let n_objects = manifest.superfiles.len();
assert_eq!(
n_objects, POOL,
"five populated cells span both cell % {POOL} worker shards"
);
let mut hints = HashSet::new();
for entry in manifest.superfiles.iter() {
assert_eq!(entry.vector_layout, VectorLayout::MultiCellIvf);
let hint = entry.partition_hint.expect("shard partition_hint");
assert!(
(hint as usize) < POOL,
"partition_hint={hint} must be a shard id in 0..{POOL}"
);
hints.insert(hint);
// Each packed object should open with a non-empty cell directory.
assert!(
!entry
.vector_summary
.get("emb")
.map(|v| v.cells.iter().all(|cell| cell.clusters.is_empty()))
.unwrap_or(true),
"packed shard missing cluster summary"
);
}
assert_eq!(
hints.len(),
n_objects,
"each shard object has a distinct hint"
);
}
/// Bounded-batch drain: `drain_batch_superfiles` is a memory bound and must
/// never change the published layout. One drain over N user superfiles
/// publishes ≤ writer_pool packed shard objects (here pool=1 ⇒ one shard),
/// whether the budget forces N batches (`1`) or a single merge (`-1`).
#[test]
fn bounded_drain_batches_by_superfile_count() {
use std::{collections::HashMap, sync::Arc};
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let make = |batch_sf: i64| {
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool)
.with_drain_batch_superfiles(batch_sf);
let st = Supertable::create(options).expect("create");
// Three commits → three user superfiles (identical vectors → one cell).
for commit in 0..3 {
let titles = LargeStringArray::from(vec![format!("doc-{commit}")]);
let flat = Float32Array::from(vec![1.0f32; dim]);
let fsl =
FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
}
// ONE drain call — the batching happens inside it.
st.drain_vectors_to_cells_sync().expect("drain");
// Hand the TempDir back: it owns the storage root, and dropping it
// here would delete the table out from under the returned handle.
(st, dir)
};
let max_files_per_cell = |st: &Supertable| -> usize {
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
let reader = hidden.reader().expect("reader");
let manifest = reader.manifest();
let mut by_cell = HashMap::<Vec<u8>, usize>::new();
for entry in manifest.superfiles.iter() {
*by_cell.entry(entry.partition_key.clone()).or_default() += 1;
}
by_cell.values().copied().max().unwrap_or(0)
};
// batch=1: 3 user superfiles -> 3 memory batches, but still one packed
// shard object (writer_pool=1 ⇒ N=1; identical vectors ⇒ one cell).
let (st1, _dir) = make(1);
assert_eq!(
max_files_per_cell(&st1),
1,
"batch=1 over 3 user superfiles must still publish one packed shard"
);
// batch=-1 (unbounded): all 3 in one merge -> identical layout.
let (st_unb, _dir) = make(-1);
assert_eq!(
max_files_per_cell(&st_unb),
1,
"unbounded drain must merge all user superfiles into one packed shard"
);
// batch=0: drain skipped → hidden index stays empty.
let (st0, _dir) = make(0);
assert_eq!(
st0.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.reader()
.expect("reader")
.n_superfiles(),
0,
"batch=0 must skip the drain"
);
}
/// The drain batch budget is a memory bound (how many user superfiles are
/// materialized at once) and must not change the published layout.
#[test]
fn drain_batch_budget_never_changes_cell_layout() {
use std::{collections::HashMap, sync::Arc};
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let mut options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
options.drain_batch_superfiles = 1;
let st = Supertable::create(options).expect("create");
const N_COMMITS: usize = 3;
for commit in 0..N_COMMITS {
let titles = LargeStringArray::from(vec![format!("doc-{commit}")]);
let flat = Float32Array::from(vec![1.0f32; dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
}
st.drain_vectors_to_cells_sync().expect("drain");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
let reader = hidden.reader().expect("reader");
let manifest = reader.manifest();
let mut per_cell = HashMap::<Vec<u8>, usize>::new();
let mut total_rows = 0u64;
for e in manifest.superfiles.iter() {
*per_cell.entry(e.partition_key.clone()).or_default() += 1;
total_rows += e.n_docs;
}
let max_per_cell = per_cell.values().copied().max().unwrap_or(0);
assert_eq!(
max_per_cell, 1,
"one drain run must publish one packed shard object (got {max_per_cell})"
);
assert_eq!(
total_rows, N_COMMITS as u64,
"every drained row lands exactly once"
);
let fine_clusters: u32 = manifest
.superfiles
.iter()
.flat_map(|entry| {
entry
.vector_summary
.get("emb")
.into_iter()
.flat_map(|summary| summary.cells.iter())
})
.map(|cell| cell.clusters.n_cent)
.sum();
assert_eq!(
fine_clusters, 1,
"three one-row source batches must form one complete-cell fine IVF, not three batch fragments"
);
assert!(
!manifest.get_drained_ranges().is_empty(),
"single publish must advance drained watermark"
);
st.drain_vectors_to_cells_sync().expect("re-drain no-op");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
let n_after = hidden.reader().expect("reader").manifest().superfiles.len();
assert_eq!(
n_after,
per_cell.len(),
"no-op re-drain must not append shard files"
);
}
/// Residency under churn — the manifest-split invariant, end to end.
/// Drain publishes the slow-CAS entry blob and stamps its ref; a USER
/// DELETE (which records hidden deleted-ids and bumps the HIDDEN
/// pointer — the linked-manifest churn path) must preserve the ref and
/// the resident entries (same `Arc`s). Only the next drain (membership
/// change) replaces the blob and swaps the entries.
#[test]
fn hidden_slow_state_survives_user_delete_churn() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use datafusion::prelude::{col, lit};
use crate::superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
let append_one = |title: &str| {
let titles = LargeStringArray::from(vec![title.to_owned()]);
let flat = Float32Array::from(vec![1.0f32; dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
};
append_one("alpha");
append_one("beta");
st.drain_vectors_to_cells_sync().expect("drain");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden vector index")
.clone();
let manifest_a = Arc::clone(hidden.reader().expect("reader").manifest());
let (uri_a, _) = manifest_a
.slow_vector_state_blob()
.expect("drain must publish + stamp the slow-CAS ref");
let uri_a = uri_a.to_owned();
assert!(!manifest_a.superfiles.is_empty());
// Churn: a USER delete records hidden deleted-ids — list-only churn
// on the HIDDEN manifest (linked manifests). Ref + entries survive.
let stats = st.delete(col("title").eq(lit("alpha"))).expect("delete");
assert_eq!(stats.n_tombstoned(), 1, "delete must tombstone one row");
let manifest_b = Arc::clone(hidden.reader().expect("reader").manifest());
assert!(
manifest_b.get_manifest_id() > manifest_a.get_manifest_id(),
"user delete must bump the hidden manifest (deleted-ids stamp)"
);
assert!(
manifest_b.deleted_user_ids_inline().is_some(),
"delete must stamp hidden deleted ids inline"
);
let (uri_b, _) = manifest_b
.slow_vector_state_blob()
.expect("delete churn must PRESERVE the slow-CAS ref");
assert_eq!(uri_b, uri_a, "ref unchanged by list-only churn");
assert_eq!(manifest_b.superfiles.len(), manifest_a.superfiles.len());
for (b, a) in manifest_b
.superfiles
.iter()
.zip(manifest_a.superfiles.iter())
{
assert!(
Arc::ptr_eq(b, a),
"residency: the entries must be the SAME Arcs across delete churn"
);
}
// Membership change: another commit + drain republishes the blob —
// the ONLY invalidation the slow state accepts.
append_one("gamma");
st.drain_vectors_to_cells_sync().expect("second drain");
let manifest_c = Arc::clone(hidden.reader().expect("reader").manifest());
let (uri_c, _) = manifest_c
.slow_vector_state_blob()
.expect("drain must restamp the ref");
assert_ne!(uri_c, uri_a, "new membership ⇒ new content-addressed blob");
}
/// The hidden deleted-`_id` set is decoded from the resident inline
/// manifest bytes ONCE per manifest version and cached on the handle:
/// repeated reads on the same version return the same `Arc` (no
/// re-decode), and a user delete that bumps the hidden manifest
/// re-decodes the updated set. This is the only discipline the
/// GET-free inline set needs.
#[test]
fn hidden_deleted_ids_decoded_once_per_manifest_version() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use datafusion::prelude::{col, lit};
use crate::superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
let append_one = |title: &str| {
let titles = LargeStringArray::from(vec![title.to_owned()]);
let flat = Float32Array::from(vec![1.0f32; dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
};
append_one("alpha");
append_one("beta");
st.drain_vectors_to_cells_sync().expect("drain");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden vector index")
.clone();
// No deletes yet: the resident set is empty, and two reads on the
// same manifest version return the SAME cached `Arc` (decoded once).
let empty_a = hidden
.reader()
.expect("reader")
.hidden_deleted_ids()
.expect("decode");
let empty_b = hidden
.reader()
.expect("reader")
.hidden_deleted_ids()
.expect("cached");
assert!(empty_a.is_empty(), "no deletes ⇒ empty resident set");
assert!(
Arc::ptr_eq(&empty_a, &empty_b),
"same manifest version must reuse the decoded set (no per-query decode)"
);
// A user delete bumps the hidden manifest and stamps the id inline.
let stats = st.delete(col("title").eq(lit("alpha"))).expect("delete");
assert_eq!(stats.n_tombstoned(), 1, "delete tombstones one row");
// New manifest version ⇒ re-decode the updated set; then cached again.
let ids_a = hidden
.reader()
.expect("reader")
.hidden_deleted_ids()
.expect("decode after delete");
let ids_b = hidden
.reader()
.expect("reader")
.hidden_deleted_ids()
.expect("cached after delete");
assert_eq!(ids_a.len(), 1, "one deleted id resident after delete");
assert!(
Arc::ptr_eq(&ids_a, &ids_b),
"post-delete version must also reuse its decoded set"
);
assert!(
!Arc::ptr_eq(&empty_a, &ids_a),
"a manifest bump must re-decode the updated set, not serve the stale one"
);
}
/// Every drain-built hidden cell superfile must carry a usable
/// `vector_summary` (summary centroid + non-empty per-cluster centroids,
/// correct dim). An entry without one would silently degrade cluster
/// selection — the fan-out hard-errors on it now, so the build path must
/// never produce such an entry.
#[test]
fn drain_built_entries_carry_vector_summaries() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
// Distinct directions so the drain builds more than one cell.
for i in 0..8usize {
let titles = LargeStringArray::from(vec![format!("doc{i}")]);
let mut v = vec![0.0f32; dim];
v[i % dim] = 1.0;
let flat = Float32Array::from(v);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
}
st.drain_vectors_to_cells_sync().expect("drain");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden vector index")
.clone();
let manifest = Arc::clone(hidden.reader().expect("reader").manifest());
assert!(!manifest.superfiles.is_empty(), "drain built cell files");
for entry in manifest.superfiles.iter() {
let vs = entry.vector_summary.get("emb").unwrap_or_else(|| {
panic!(
"drain-built hidden superfile {} has NO vector_summary",
entry.superfile_id
)
});
assert_eq!(vs.centroid.len(), dim, "summary centroid dim");
assert!(
vs.cells.iter().any(|cell| !cell.clusters.is_empty()),
"drain-built hidden superfile {} has EMPTY cluster centroids",
entry.superfile_id
);
assert!(
vs.cells
.iter()
.all(|cell| cell.clusters.dim as usize == dim),
"cluster centroid dim"
);
}
}
/// Raw pointer object ceiling for the thin-pointer assertions: three
/// short text lines (id, list URI, hash) — generously bounded.
const MAX_POINTER_OBJECT_BYTES: usize = 512;
/// Storage contract of the fast/slow split, end to end:
/// (1) once the drainer stamps the slow-CAS ref, the pointer object is
/// TINY — no payload rides the hot-CAS write;
/// (2) `optimize` (whose membership `update`s clear the ref) ends
/// re-stamped with a durable, non-empty blob — the state a
/// post-maintenance footprint reads;
/// (3) a fresh process open hydrates the flat view FROM the blob —
/// proven by deleting every hidden manifest part first, so nothing
/// else can serve the entries.
#[test]
fn slow_state_thin_pointer_and_blob_serves_fresh_open() {
use std::sync::Arc;
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
config::OptimizeOptions,
superfile::{
builder::{FtsConfig, VectorConfig},
reader::VectorSearchOptions,
vector::{distance::Metric, rerank_codec::RerankCodec},
},
supertable::manifest::commit::{MANIFEST_PARTS_DIR, POINTER_PATH},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let make_options = || {
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(Arc::clone(&pool))
};
let st = Supertable::create(make_options()).expect("create");
let append_one = |title: &str| {
let titles = LargeStringArray::from(vec![title.to_owned()]);
let flat = Float32Array::from(vec![1.0f32; dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
};
append_one("alpha");
append_one("beta");
st.drain_vectors_to_cells_sync().expect("drain");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden vector index")
.clone();
let hidden_storage = hidden
.reader()
.expect("reader")
.manifest()
.options
.storage
.clone()
.expect("hidden storage");
// (1) Ref stamped ⇒ pointer tiny (raw object bytes bounded — no
// payload of any kind rides the hot-CAS write), blob durable and
// non-empty.
let (uri_a, _) = hidden
.reader()
.expect("reader")
.manifest()
.slow_vector_state_blob()
.map(|(u, h)| (u.to_owned(), h))
.expect("drain must stamp the slow-CAS ref");
let (ptr_bytes, _) = hidden
.block_on_query(hidden_storage.get(POINTER_PATH))
.expect("read pointer object");
assert!(
ptr_bytes.len() <= MAX_POINTER_OBJECT_BYTES,
"pointer object must stay tiny (id + list uri + hash); got {} bytes",
ptr_bytes.len()
);
let (blob, _) = hidden
.block_on_query(hidden_storage.get(&uri_a))
.expect("slow blob durable");
assert!(!blob.is_empty(), "slow blob carries the entry payload");
// (2) optimize (drain no-op + compaction membership updates clear the
// ref) must END re-stamped, thin-pointered, with a durable blob.
st.optimize(&OptimizeOptions::default()).expect("optimize");
let manifest_after = Arc::clone(hidden.reader().expect("reader").manifest());
let (uri_b, _) = manifest_after
.slow_vector_state_blob()
.map(|(u, h)| (u.to_owned(), h))
.expect("optimize must end with the ref re-stamped");
let (blob_b, _) = hidden
.block_on_query(hidden_storage.get(&uri_b))
.expect("slow blob durable after optimize");
assert!(!blob_b.is_empty());
let (ptr_bytes_b, _) = hidden
.block_on_query(hidden_storage.get(POINTER_PATH))
.expect("read pointer object");
assert!(
ptr_bytes_b.len() <= MAX_POINTER_OBJECT_BYTES,
"post-optimize pointer must stay tiny; got {} bytes",
ptr_bytes_b.len()
);
let n_entries = manifest_after.superfiles.len();
assert!(n_entries > 0, "hidden flat view populated");
// (3) Hidden membership never writes manifest parts. Fresh open must
// hydrate exclusively from the slow blob.
let parts = hidden
.block_on_query(hidden_storage.list_with_prefix(MANIFEST_PARTS_DIR))
.expect("list hidden parts");
assert!(
parts.is_empty(),
"hidden table must not write manifest parts"
);
drop(hidden);
drop(st);
let st2 = Supertable::open(make_options()).expect("reopen");
let hidden2 = st2
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden vector index on reopen")
.clone();
assert_eq!(
hidden2
.reader()
.expect("reader")
.manifest()
.superfiles
.len(),
n_entries,
"fresh open hydrated the flat view from the blob (parts deleted)"
);
let mut q = vec![0.0f32; dim];
q[0] = 1.0;
let hits = st2
.reader()
.expect("reader")
.vector_hits("emb", &q, 2, VectorSearchOptions::new(), None)
.expect("vector search on blob-hydrated manifest");
assert!(!hits.is_empty(), "search serves from the hydrated view");
}
/// Incremental drain: each drain consumes only user commits not already in
/// the hidden manifest's `drained_ranges`, and a drain with no new commits
/// is a no-op (no re-drive, no duplicate cells). The distinguishing signal
/// is the *third* drain: with incrementality it adds nothing; without it,
/// it would re-drain everything and append another per-cell file.
#[test]
fn incremental_drain_skips_already_drained_commits() {
use std::{collections::HashMap, sync::Arc};
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, rerank_codec::RerankCodec},
};
let dim = 16usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
let commit = |tag: &str| {
let titles = LargeStringArray::from(vec![format!("doc-{tag}")]);
let flat = Float32Array::from(vec![1.0f32; dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
};
let cell_files = || -> usize {
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
let reader = hidden.reader().expect("reader");
let manifest = reader.manifest();
let mut by_cell = HashMap::<Vec<u8>, usize>::new();
for e in manifest.superfiles.iter() {
*by_cell.entry(e.partition_key.clone()).or_default() += 1;
}
by_cell.values().copied().max().unwrap_or(0)
};
// Commit A, drain → one cell file; the commit's version is now drained.
commit("a");
st.drain_vectors_to_cells_sync().expect("drain 1");
assert_eq!(cell_files(), 1, "first drain populates the cell");
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
assert!(
!hidden
.reader()
.expect("reader")
.manifest()
.get_drained_ranges()
.is_empty(),
"drain must record progress in drained_ranges"
);
// Commit B, drain → only B is new, so exactly one more cell file.
commit("b");
st.drain_vectors_to_cells_sync().expect("drain 2");
assert_eq!(cell_files(), 2, "second drain consumes only the new commit");
// No new commit: the third drain is a NO-OP (incrementality).
st.drain_vectors_to_cells_sync().expect("drain 3 (no-op)");
assert_eq!(
cell_files(),
2,
"drain with nothing new must not re-drive already-drained commits"
);
// Watermark stays a single genesis-anchored interval (contiguous commits).
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden index")
.clone();
assert_eq!(
hidden
.reader()
.expect("reader")
.manifest()
.get_drained_ranges()
.intervals()
.len(),
1,
"contiguous commits must leave drained_ranges as one interval"
);
}
#[test]
fn hidden_ivf_compaction_collapses_per_cell() {
use std::{collections::HashMap, sync::Arc};
use arrow_array::{Array, FixedSizeListArray, Float32Array, LargeStringArray};
use arrow_schema::{DataType, Field, Schema};
use crate::{
config::CompactionSettings,
superfile::{
builder::{FtsConfig, VectorConfig},
vector::{distance::Metric, layout::VectorLayout, rerank_codec::RerankCodec},
},
};
let dim = 128usize;
let item_field = Arc::new(Field::new("item", DataType::Float32, true));
let schema = Arc::new(Schema::new(vec![
Field::new("title", DataType::LargeUtf8, false),
Field::new(
"emb",
DataType::FixedSizeList(item_field.clone(), dim as i32),
false,
),
]));
let pool = Arc::new(
rayon::ThreadPoolBuilder::new()
.num_threads(1)
.build()
.expect("pool"),
);
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = SupertableOptions::new(
schema.clone(),
vec![FtsConfig {
column: "title".into(),
positions: false,
}],
vec![VectorConfig {
column: "emb".into(),
dim,
rot_seed: 7,
metric: Metric::Cosine,
rerank_codec: RerankCodec::Sq8Residual,
provided_centroids: None,
}],
Some(crate::test_helpers::default_tokenizer()),
)
.expect("valid options")
.with_storage(storage)
.with_writer_pool(pool);
let st = Supertable::create(options).expect("create");
let rows_per_commit = 8usize;
for commit in 0..3 {
let titles = LargeStringArray::from(
(0..rows_per_commit)
.map(|row| format!("doc-{commit}-{row}"))
.collect::<Vec<_>>(),
);
let flat = Float32Array::from(vec![1.0f32; rows_per_commit * dim]);
let fsl = FixedSizeListArray::new(item_field.clone(), dim as i32, Arc::new(flat), None);
let batch = arrow_array::RecordBatch::try_new(
schema.clone(),
vec![
Arc::new(titles) as Arc<dyn Array>,
Arc::new(fsl) as Arc<dyn Array>,
],
)
.expect("batch");
let mut w = st.writer().expect("writer");
w.append(&batch).expect("append");
w.commit().expect("commit");
// Phase B: drain after each commit; each drain appends a file per
// cell, accumulating the per-cell superfiles compaction collapses.
st.drain_vectors_to_cells_sync().expect("drain to cells");
}
let hidden = st
.reader()
.expect("reader")
.vector_index_table()
.expect("hidden vector index")
.clone();
let count_by_shard = |manifest: &crate::supertable::manifest::ManifestSnapshot| -> usize {
let mut by_shard = HashMap::<Vec<u8>, usize>::new();
for entry in manifest.superfiles.iter() {
if entry.vector_layout != VectorLayout::MultiCellIvf
&& entry.vector_layout != VectorLayout::Ivf
{
continue;
}
*by_shard.entry(entry.partition_key.clone()).or_default() += 1;
}
by_shard.values().copied().max().unwrap_or(0)
};
let before = count_by_shard(hidden.reader().expect("reader").manifest());
assert!(
before >= 2,
"need multiple drained packed shards before compaction, got {before}"
);
let cfg = CompactionSettings {
target_superfile_size_mb: 1,
min_fill_percent: 1,
..CompactionSettings::default()
};
hidden.compact(&cfg).expect("hidden compact");
let after_reader = hidden.reader().expect("reader");
let after_manifest = after_reader.manifest();
let after = count_by_shard(after_manifest);
assert!(
after < before,
"compaction should collapse packed shards: before={before} after={after}"
);
for entry in &after_manifest.superfiles {
assert!(
entry.vector_layout == VectorLayout::MultiCellIvf
|| entry.vector_layout == VectorLayout::Ivf,
"unexpected layout {:?}",
entry.vector_layout
);
assert!(
entry
.subsection_offsets
.as_ref()
.and_then(|o| o.vec)
.is_some(),
"compacted hidden entry {:?} missing vec subsection",
entry.uri
);
}
let hits = st
.reader()
.expect("reader")
.vector_hits(
"emb",
&vec![1.0f32; dim],
3,
crate::superfile::reader::VectorSearchOptions::new(),
None,
)
.expect("vector search after hidden compaction");
assert!(
!hits.is_empty(),
"vector search should still work after hidden compaction"
);
}
#[test]
fn ensure_fresh_under_strong_consistency_refreshes_against_storage() {
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = opts()
.with_storage(storage)
.with_read_consistency(Consistency::Strong);
let st = Supertable::create(options).expect("create storage-backed handle");
let r = st.reader().expect("reader");
assert_eq!(r.n_superfiles(), 0);
// A direct refresh likewise reports no newer manifest.
let advanced = bridge_sync_to_async(st.refresh()).expect("refresh against empty store");
assert!(!advanced, "no commit yet ⇒ refresh finds nothing newer");
}
/// A [`StorageProvider`] that fails the manifest-pointer probe on demand and
/// delegates everything else. Models a transient object-store read error
/// landing on exactly the per-query freshness check, so a test can pin down
/// how the read path reacts to it.
#[derive(Debug)]
struct FailPointerProbe {
inner: Arc<dyn StorageProvider>,
fail: AtomicBool,
}
impl FailPointerProbe {
fn new(inner: Arc<dyn StorageProvider>) -> Arc<Self> {
Arc::new(Self {
inner,
fail: AtomicBool::new(false),
})
}
fn set_failing(&self, failing: bool) {
self.fail.store(failing, Ordering::SeqCst);
}
fn should_fail(&self, uri: &str) -> bool {
self.fail.load(Ordering::SeqCst) && uri.ends_with(POINTER_PATH)
}
fn injected(uri: &str) -> StorageError {
StorageError::TransientExhausted {
uri: uri.to_string(),
source: "injected pointer-probe fault".into(),
}
}
}
#[async_trait]
impl StorageProvider for FailPointerProbe {
async fn head(&self, uri: &str) -> Result<ObjectMeta, StorageError> {
self.inner.head(uri).await
}
async fn get(&self, uri: &str) -> Result<(Bytes, ObjectMeta), StorageError> {
if self.should_fail(uri) {
return Err(Self::injected(uri));
}
self.inner.get(uri).await
}
async fn get_if_none_match(
&self,
uri: &str,
etag: &str,
) -> Result<Option<(Bytes, ObjectMeta)>, StorageError> {
if self.should_fail(uri) {
return Err(Self::injected(uri));
}
self.inner.get_if_none_match(uri, etag).await
}
async fn get_range(&self, uri: &str, range: Range<u64>) -> Result<Bytes, StorageError> {
self.inner.get_range(uri, range).await
}
async fn tail(&self, uri: &str, len: u64) -> Result<(Bytes, u64), StorageError> {
self.inner.tail(uri, len).await
}
async fn put_atomic(
&self,
uri: &str,
bytes: Bytes,
) -> Result<Option<String>, StorageError> {
self.inner.put_atomic(uri, bytes).await
}
async fn put_if_match(
&self,
uri: &str,
bytes: Bytes,
expected_etag: Option<&str>,
) -> Result<Option<String>, StorageError> {
self.inner.put_if_match(uri, bytes, expected_etag).await
}
async fn put_multipart(&self, uri: &str) -> Result<Box<dyn MultipartUpload>, StorageError> {
self.inner.put_multipart(uri).await
}
async fn delete(&self, uri: &str) -> Result<(), StorageError> {
self.inner.delete(uri).await
}
async fn list_with_prefix_metadata(
&self,
prefix: &str,
) -> Result<Vec<(String, ObjectMeta)>, StorageError> {
self.inner.list_with_prefix_metadata(prefix).await
}
}
fn title_batch(titles: &[&str]) -> RecordBatch {
use arrow_array::LargeStringArray;
RecordBatch::try_new(
schema(),
vec![Arc::new(LargeStringArray::from(titles.to_vec()))],
)
.expect("title batch")
}
fn bm25_title_hits(table: &Supertable, query: &str) -> usize {
use crate::superfile::fts::reader::{Bm25Stats, BoolMode};
table
.bm25_search(
"title",
query,
10,
BoolMode::Or,
Bm25Stats::PerSuperfile,
None,
)
.expect("bm25 search")
.iter()
.map(|b| b.num_rows())
.sum()
}
/// Regression: under `Strong`, a read whose per-query pointer re-check fails
/// must error rather than silently serve a snapshot pinned before a commit
/// it hasn't observed — which would return that commit's rows as an empty
/// result. Mirrors one handle pinned at an older manifest while another
/// writer commits, then hitting a transient object-store error on its next
/// refresh probe.
#[test]
fn strong_read_fails_closed_when_the_pointer_probe_fails() {
let dir = TempDir::new().expect("tempdir");
let inner: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
// A separate writer commits v1.
let producer = Supertable::create(opts().with_storage(Arc::clone(&inner))).expect("create");
let mut w = producer.writer().expect("writer");
w.append(&title_batch(&["initial"])).expect("append v1");
w.commit().expect("commit v1");
drop(w);
// The consumer reads the same table through the fault wrapper, Strong.
let fault = FailPointerProbe::new(Arc::clone(&inner));
let consumer = Supertable::open(
opts()
.with_storage(Arc::clone(&fault) as Arc<dyn StorageProvider>)
.with_read_consistency(Consistency::Strong),
)
.expect("open");
// A first read pins v1 and captures its pointer etag.
assert_eq!(bm25_title_hits(&consumer, "initial"), 1, "sees v1");
// The producer commits v2 with a row the consumer hasn't observed.
let mut w = producer.writer().expect("writer");
w.append(&title_batch(&["added"])).expect("append v2");
w.commit().expect("commit v2");
drop(w);
// The consumer's next Strong read has its pointer probe fail. It must
// NOT serve the pinned v1 snapshot (which misses "added"); it must
// surface the failure so the caller can retry rather than receive
// stale data.
fault.set_failing(true);
let err = consumer
.reader()
.expect_err("a Strong read must fail closed when its refresh cannot complete");
assert!(
matches!(err, ManifestLoadError::Storage(_)),
"expected a storage error from the failed probe, got {err:?}"
);
// Once the probe recovers, the same read refreshes to v2 and sees it —
// the failure was transient, not a poisoned handle.
fault.set_failing(false);
assert_eq!(
bm25_title_hits(&consumer, "added"),
1,
"recovers to v2 after the probe heals"
);
}
/// A [`StorageProvider`] that fails to read the manifest *list* on demand
/// while letting the pointer probe through — models the pointer advancing
/// before its manifest is readable by this process, so the failure lands
/// inside `load_with_pointer`, after the pointer re-check succeeded.
#[derive(Debug)]
struct FailManifestGet {
inner: Arc<dyn StorageProvider>,
fail: AtomicBool,
}
impl FailManifestGet {
fn new(inner: Arc<dyn StorageProvider>) -> Arc<Self> {
Arc::new(Self {
inner,
fail: AtomicBool::new(false),
})
}
fn set_failing(&self, failing: bool) {
self.fail.store(failing, Ordering::SeqCst);
}
// The manifest list is `manifest/manifest-NNNNNN.json`; the pointer
// (`_supertable/current`) and parts (`manifest_parts/part-…`) don't
// contain `manifest-`, so only the list read is faulted.
fn should_fail(&self, uri: &str) -> bool {
self.fail.load(Ordering::SeqCst) && uri.contains("manifest-")
}
fn injected(uri: &str) -> StorageError {
StorageError::TransientExhausted {
uri: uri.to_string(),
source: "injected manifest-list fault".into(),
}
}
}
#[async_trait]
impl StorageProvider for FailManifestGet {
async fn head(&self, uri: &str) -> Result<ObjectMeta, StorageError> {
self.inner.head(uri).await
}
async fn get(&self, uri: &str) -> Result<(Bytes, ObjectMeta), StorageError> {
if self.should_fail(uri) {
return Err(Self::injected(uri));
}
self.inner.get(uri).await
}
async fn get_if_none_match(
&self,
uri: &str,
etag: &str,
) -> Result<Option<(Bytes, ObjectMeta)>, StorageError> {
self.inner.get_if_none_match(uri, etag).await
}
async fn get_range(&self, uri: &str, range: Range<u64>) -> Result<Bytes, StorageError> {
self.inner.get_range(uri, range).await
}
async fn tail(&self, uri: &str, len: u64) -> Result<(Bytes, u64), StorageError> {
self.inner.tail(uri, len).await
}
async fn put_atomic(
&self,
uri: &str,
bytes: Bytes,
) -> Result<Option<String>, StorageError> {
self.inner.put_atomic(uri, bytes).await
}
async fn put_if_match(
&self,
uri: &str,
bytes: Bytes,
expected_etag: Option<&str>,
) -> Result<Option<String>, StorageError> {
self.inner.put_if_match(uri, bytes, expected_etag).await
}
async fn put_multipart(&self, uri: &str) -> Result<Box<dyn MultipartUpload>, StorageError> {
self.inner.put_multipart(uri).await
}
async fn delete(&self, uri: &str) -> Result<(), StorageError> {
self.inner.delete(uri).await
}
async fn list_with_prefix_metadata(
&self,
prefix: &str,
) -> Result<Vec<(String, ObjectMeta)>, StorageError> {
self.inner.list_with_prefix_metadata(prefix).await
}
}
/// Regression: a refresh whose pointer probe *succeeds* but whose manifest
/// load *fails* must not advance the last-seen pointer etag. If it did, the
/// next conditional probe would answer `NotModified` and never retry the
/// load — pinning the handle to the pre-commit manifest and serving its rows
/// as empty even after the load could succeed.
#[test]
fn strong_read_recovers_after_a_manifest_load_failure() {
let dir = TempDir::new().expect("tempdir");
let inner: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
// A writer commits v1.
let producer = Supertable::create(opts().with_storage(Arc::clone(&inner))).expect("create");
let mut w = producer.writer().expect("writer");
w.append(&title_batch(&["initial"])).expect("append v1");
w.commit().expect("commit v1");
drop(w);
// The consumer reads through the manifest-fault wrapper, Strong.
let fault = FailManifestGet::new(Arc::clone(&inner));
let consumer = Supertable::open(
opts()
.with_storage(Arc::clone(&fault) as Arc<dyn StorageProvider>)
.with_read_consistency(Consistency::Strong),
)
.expect("open");
// First read pins v1 and captures its pointer etag.
assert_eq!(bm25_title_hits(&consumer, "initial"), 1, "sees v1");
// The producer commits v2.
let mut w = producer.writer().expect("writer");
w.append(&title_batch(&["added"])).expect("append v2");
w.commit().expect("commit v2");
drop(w);
// The consumer's next Strong read reaches the new pointer but its
// manifest load fails — it must surface the error, not silently pin.
fault.set_failing(true);
let err = consumer
.reader()
.expect_err("a Strong read must fail closed when the manifest load fails");
assert!(
matches!(err, ManifestLoadError::Storage(_)),
"expected a storage error from the failed load, got {err:?}"
);
// Once the load heals, the same read must refresh to v2 — i.e. the failed
// load did NOT poison the pointer etag into a permanent `NotModified`.
fault.set_failing(false);
assert_eq!(
bm25_title_hits(&consumer, "added"),
1,
"recovers to v2 after a transient manifest-load failure"
);
}
/// The mirror under `BoundedStaleness`: a failed probe is tolerated by
/// contract, so the read still succeeds, serving the last good snapshot.
/// Confirms the fail-closed change is scoped to `Strong` and did not turn
/// best-effort freshness into a hard failure.
#[test]
fn bounded_staleness_read_tolerates_a_failing_pointer_probe() {
let dir = TempDir::new().expect("tempdir");
let inner: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let producer = Supertable::create(opts().with_storage(Arc::clone(&inner))).expect("create");
let mut w = producer.writer().expect("writer");
w.append(&title_batch(&["initial"])).expect("append");
w.commit().expect("commit");
drop(w);
// Window 0 ⇒ every query re-checks the pointer, just like Strong — the
// only difference under test is how a failed check is handled.
let fault = FailPointerProbe::new(Arc::clone(&inner));
let consumer = Supertable::open(
opts()
.with_storage(Arc::clone(&fault) as Arc<dyn StorageProvider>)
.with_read_consistency(Consistency::BoundedStaleness(Duration::from_secs(0))),
)
.expect("open");
assert_eq!(bm25_title_hits(&consumer, "initial"), 1);
// With the probe failing, the bounded-staleness read still succeeds:
// staleness is acceptable, so it serves the pinned snapshot.
fault.set_failing(true);
assert_eq!(
bm25_title_hits(&consumer, "initial"),
1,
"bounded staleness serves the last good snapshot when the probe fails"
);
}
/// Regression: a mutation must resolve its target set against the latest
/// committed manifest even under `BoundedStaleness`, where a plain read
/// would serve a snapshot behind a peer's commit. Resolving the predicate
/// against such a snapshot would miss the peer-committed row and silently
/// drop its tombstone — a lost delete, or (for update) the old version left
/// live beside its replacement.
#[test]
fn a_mutation_resolves_its_target_against_a_peers_commit_under_bounded_staleness() {
use datafusion::prelude::{col, lit};
let dir = TempDir::new().expect("tempdir");
let inner: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
// Producer creates the table and commits one row.
let producer = Supertable::create(opts().with_storage(Arc::clone(&inner))).expect("create");
let mut w = producer.writer().expect("writer");
w.append(&title_batch(&["keep"])).expect("append keep");
w.commit().expect("commit keep");
drop(w);
// Consumer opens under BoundedStaleness with a window long enough that a
// plain read never re-probes for the rest of the test.
let consumer = Supertable::open(
opts()
.with_storage(Arc::clone(&inner))
.with_read_consistency(Consistency::BoundedStaleness(Duration::from_secs(3600))),
)
.expect("open");
// One read pins the snapshot and stamps the pointer-check timestamp, so
// the window is now open — a later plain read would serve this snapshot.
assert_eq!(
bm25_title_hits(&consumer, "keep"),
1,
"sees the initial row"
);
// Producer commits a second row the consumer has NOT yet observed.
let mut w = producer.writer().expect("writer");
w.append(&title_batch(&["target"])).expect("append target");
w.commit().expect("commit target");
drop(w);
// The consumer deletes "target" while still inside its staleness window.
// A plain reader would resolve against the pre-commit snapshot and match
// zero rows; the mutation path force-refreshes, so it sees the peer's
// commit and tombstones the row.
let stats = consumer
.delete(col("title").eq(lit("target")))
.expect("delete");
assert_eq!(
stats.n_tombstoned(),
1,
"the delete must resolve against the peer's commit and tombstone the row"
);
// The row is gone for a fresh reader, and the untouched row survives.
let verifier = Supertable::open(
opts()
.with_storage(Arc::clone(&inner))
.with_read_consistency(Consistency::Strong),
)
.expect("open verifier");
assert_eq!(
bm25_title_hits(&verifier, "target"),
0,
"target was deleted"
);
assert_eq!(bm25_title_hits(&verifier, "keep"), 1, "keep survives");
}
/// The update-path companion to the delete regression above. An update
/// resolves a 1:1 target set the same way, so under bounded staleness a stale
/// resolve would fail to see a row a peer committed after the handle's last
/// read — matching zero rows and failing the cardinality check — rather than
/// replacing it. With the target resolved against the latest manifest, the
/// update matches and swaps the row.
#[test]
fn an_update_resolves_its_target_against_a_peers_commit_under_bounded_staleness() {
use datafusion::prelude::{col, lit};
let dir = TempDir::new().expect("tempdir");
let inner: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
// Producer creates the table and commits a baseline row.
let producer = Supertable::create(opts().with_storage(Arc::clone(&inner))).expect("create");
let mut w = producer.writer().expect("writer");
w.append(&title_batch(&["keep"])).expect("append keep");
w.commit().expect("commit keep");
drop(w);
// Consumer opens under BoundedStaleness with a window long enough that a
// plain read never re-probes for the rest of the test.
let consumer = Supertable::open(
opts()
.with_storage(Arc::clone(&inner))
.with_read_consistency(Consistency::BoundedStaleness(Duration::from_secs(3600))),
)
.expect("open");
// One read pins the snapshot and opens the window.
assert_eq!(
bm25_title_hits(&consumer, "keep"),
1,
"sees the initial row"
);
// Producer commits the update target the consumer has NOT yet observed.
let mut w = producer.writer().expect("writer");
w.append(&title_batch(&["stale-target"]))
.expect("append target");
w.commit().expect("commit target");
drop(w);
// The consumer updates "stale-target" → "fresh-value" while still inside
// its staleness window. A plain reader would resolve against the
// pre-commit snapshot, match zero rows, and fail the 1:1 cardinality
// check; the mutation path force-refreshes and matches the row.
let stats = consumer
.update(
col("title").eq(lit("stale-target")),
&title_batch(&["fresh-value"]),
)
.expect("update");
assert_eq!(
stats.matched(),
1,
"the update must resolve against the peer's commit and match the target row"
);
// A fresh reader sees the replacement, the old version gone, and the
// untouched row intact — no pre-update version left live beside it.
let verifier = Supertable::open(
opts()
.with_storage(Arc::clone(&inner))
.with_read_consistency(Consistency::Strong),
)
.expect("open verifier");
assert_eq!(
bm25_title_hits(&verifier, "fresh-value"),
1,
"replacement is present"
);
assert_eq!(
bm25_title_hits(&verifier, "stale-target"),
0,
"old version was tombstoned"
);
assert_eq!(bm25_title_hits(&verifier, "keep"), 1, "keep survives");
}
/// The typed shape of a deleted pointer on the read path, pinned at the
/// layer that produces it. Both the error and the latch matter: callers
/// above match the variant, and the catalog keys handle eviction on the
/// latch, so a refactor that reclassified either would break recovery
/// while every end-to-end assertion still passed.
#[test]
fn refresh_reports_pointer_vanished_once_the_pointer_is_deleted() {
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = opts()
.with_storage(Arc::clone(&storage))
.with_read_consistency(Consistency::Strong);
let st = Supertable::create(options).expect("create storage-backed handle");
assert!(!st.pointer_vanished(), "a live table has its pointer");
// Exactly what a purge leaves behind for a handle that stays open.
bridge_sync_to_async(storage.delete(POINTER_PATH)).expect("delete pointer");
let err = bridge_sync_to_async(st.refresh()).expect_err("refresh must refuse");
assert!(
matches!(err, ManifestLoadError::PointerVanished),
"expected PointerVanished, got {err:?}"
);
assert!(
st.pointer_vanished(),
"the observation must latch, so the catalog can evict this handle"
);
// And it stays refused rather than being a one-shot side effect of the
// probe that discovered it.
for attempt in 0..2 {
let err = st.reader().expect_err("reader must refuse");
assert!(
matches!(err, ManifestLoadError::PointerVanished),
"attempt {attempt}: expected PointerVanished, got {err:?}"
);
}
}
/// The same condition on the commit path. `Ok(None)` here would read as
/// "initial commit" and republish a pointer from this handle's stale
/// manifest, so the variant — not just the failure — is the contract.
#[test]
fn get_current_manifest_etag_refuses_a_deleted_pointer() {
let dir = TempDir::new().expect("tempdir");
let storage: Arc<dyn StorageProvider> =
Arc::new(LocalFsStorageProvider::new(dir.path()).expect("provider"));
let options = opts().with_storage(Arc::clone(&storage));
let st = Supertable::create(options).expect("create storage-backed handle");
// Capture the snapshot while the table is still whole: this is the
// stale state a commit would otherwise republish from.
let manifest = Arc::clone(st.reader().expect("reader").manifest());
let etag = bridge_sync_to_async(get_current_manifest_etag(&storage, Arc::clone(&manifest)))
.expect("a live pointer yields its etag");
assert!(etag.is_some(), "localfs reports etags");
bridge_sync_to_async(storage.delete(POINTER_PATH)).expect("delete pointer");
let err = bridge_sync_to_async(get_current_manifest_etag(&storage, manifest))
.expect_err("an absent pointer must not read as an initial commit");
assert!(
matches!(err, CommitError::PointerVanished),
"expected PointerVanished, got {err:?}"
);
}
}