Skip to main content

spg_storage/
lib.rs

1//! In-memory storage primitives.
2//!
3//! v0.3 is intentionally simple: a flat catalog of tables, each holding rows
4//! as `Vec<Value>` (positional, matching the table's `TableSchema`). No MVCC,
5//! no on-disk format — those land in later milestones.
6#![no_std]
7// v3.3.2 NEON path for l2_distance_sq (aarch64 only). Scoped allow:
8// `unsafe_code = "deny"` at workspace level stays in force for every
9// other crate.
10#![cfg_attr(target_arch = "aarch64", allow(unsafe_code))]
11
12extern crate alloc;
13
14pub mod bignum;
15pub mod bloom;
16mod codec;
17pub mod fts_simple;
18pub mod halfvec;
19pub mod jsonb_gin;
20mod nsw;
21pub mod persistent;
22pub mod persistent_btree;
23pub mod posting;
24pub mod quantize;
25pub mod row_header;
26pub mod row_locator;
27pub mod segment;
28pub mod snapshot;
29mod table;
30pub mod trgm;
31pub mod vacuum;
32
33pub use self::bloom::{BloomError, BloomFilter};
34// v7.31 monster tier-3 cut 3 — on-disk codec moved to `codec`; the
35// public dense-row surface keeps its `spg_storage::*` paths, and the
36// low-level write/read primitives stay crate-visible for the
37// `Catalog::serialize`/`deserialize` methods that remain in this file.
38pub(crate) use self::codec::*;
39pub use self::codec::{
40    decode_row_body_dense, decode_row_body_dense_pruned, encode_row_body_dense,
41    encode_row_body_dense_into, encode_row_body_dense_masked_into, row_body_encoded_len,
42};
43// v7.31 monster tier-3 cut 2 — HNSW algorithms moved to `nsw`; the
44// public vector-search surface keeps its `spg_storage::*` paths via
45// these re-exports, and `nsw_insert_at` stays crate-visible for the
46// `Table` insert paths in the `table` module.
47pub(crate) use self::nsw::nsw_insert_at;
48pub use self::nsw::{NswMetric, cosine_dot_norms_f32, inner_product_f32, nsw_index_on, nsw_query};
49pub use self::posting::PostingList;
50
51/// The list handed back for an absent key, so callers cannot tell an
52/// absent key from an empty posting list — the property the old
53/// `&[][..]` return had, kept.
54static EMPTY_POSTINGS: crate::posting::PostingList = crate::posting::PostingList::new();
55pub use self::row_locator::{RowLocator, RowLocatorError};
56pub use self::segment::{
57    BRIN_SIDECAR_MAGIC, BrinSummary, OwnedSegment, SEGMENT_COMPRESS_ALGO_LZSS,
58    SEGMENT_COMPRESS_ALGO_NONE, SEGMENT_MAGIC, SEGMENT_MAGIC_V2, SEGMENT_PAGE_BYTES, SegmentError,
59    SegmentMeta, SegmentReader, derive_brin_summaries, encode_segment, wrap_v2_envelope,
60    wrap_v2_envelope_with_brin,
61};
62
63use alloc::borrow::Cow;
64use alloc::boxed::Box;
65use alloc::collections::{BTreeMap, BTreeSet};
66use alloc::format;
67use alloc::string::{String, ToString};
68use alloc::sync::Arc;
69use alloc::vec::Vec;
70use core::fmt;
71
72use self::persistent::PersistentVec;
73use self::persistent_btree::PersistentBTreeMap;
74
75/// In-cell encoding for `DataType::Vector`. Mirrors
76/// `spg_sql::ast::VecEncoding` — kept here so storage stays
77/// dep-free of `spg-sql`. The engine bridges between the two
78/// at DDL-execution time.
79///
80/// `F32` is the pre-v6 default: each cell holds a raw `Vec<f32>`.
81/// `Sq8` (v6.0.1) stores `Sq8Vector { min, max, bytes: Vec<u8> }`
82/// per cell; 4× compression vs `F32` with recall@10 ≥ 0.95 on
83/// natural embeddings (Gaussian / unit-sphere corpora).
84/// `F16` (v6.0.3, DDL keyword `HALF`) stores each element as
85/// IEEE-754 binary16; 2× compression and bit-exact dequantise.
86#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
87pub enum VecEncoding {
88    #[default]
89    F32,
90    Sq8,
91    F16,
92}
93
94impl fmt::Display for VecEncoding {
95    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
96        match self {
97            Self::F32 => f.write_str("F32"),
98            Self::Sq8 => f.write_str("SQ8"),
99            Self::F16 => f.write_str("HALF"),
100        }
101    }
102}
103
104/// Runtime type tags. `Vector { dim, encoding }` / `Varchar(max)` /
105/// `Char(size)` are parameterised; the parameter travels with both
106/// the column schema and the on-wire serialised representation.
107#[derive(Debug, Clone, Copy, PartialEq, Eq)]
108pub enum DataType {
109    /// 16-bit signed. Backed by `Value::SmallInt(i16)`; arithmetic that
110    /// would overflow surfaces as a type error at INSERT time.
111    SmallInt,
112    Int,    // 32-bit signed
113    BigInt, // 64-bit signed
114    Float,  // f64 (PG double precision)
115    /// v7.38 (read01, T-float4) — `real` / `float4`: 32-bit IEEE float (PG
116    /// `real`). Backed by `Value::Real(f32)`; behaves like `Float` for most
117    /// dispatch but renders / stores at f32 precision.
118    Real,
119    Text,
120    /// `VARCHAR(n)` — same byte representation as `Text`, but INSERT
121    /// rejects values longer than `n` Unicode characters.
122    Varchar(u32),
123    /// `CHAR(n)` — same representation as `Text`, but INSERT right-pads
124    /// with U+0020 to exactly `n` Unicode characters (or rejects when
125    /// the input is already longer).
126    Char(u32),
127    Bool,
128    /// pgvector-style fixed-dimension vector. `encoding` selects
129    /// the in-cell representation (`F32` = pre-v6 raw f32 buffer;
130    /// `Sq8` = v6.0.1 8-bit scalar-quantised). The DDL grammar
131    /// surfaces encoding via the optional `USING <encoding>`
132    /// clause: `VECTOR(128) USING SQ8`.
133    Vector {
134        dim: u32,
135        encoding: VecEncoding,
136    },
137    /// `NUMERIC(precision, scale)` — exact fixed-point decimal stored as
138    /// a scaled `i128`. `precision` caps total decimal digits, `scale`
139    /// fixes digits after the decimal point. v1.12 supports up to
140    /// precision 38 (the i128-safe ceiling). `NUMERIC` and `NUMERIC(p)`
141    /// surface as `Numeric { precision: p, scale: 0 }`.
142    Numeric {
143        /// v7.39 (round 272) — widened from u8. PG's declared precision
144        /// runs to 1000; at u8 it could not even be spelled, and the
145        /// parser rejected anything past 38 (i128's width) outright.
146        precision: u16,
147        /// v7.39 (round 271) — widened alongside the value's scale.
148        /// v7.39 (round 273) — and signed: PG's DECLARED scale runs
149        /// -1000..=1000, where a negative one rounds to tens / hundreds.
150        /// A VALUE's display scale is always non-negative.
151        scale: i16,
152    },
153    /// `DATE` — calendar date with day precision, stored as `i32` days
154    /// since the Unix epoch (1970-01-01).
155    Date,
156    /// `TIMESTAMP` (a.k.a. `MySQL` `DATETIME`) — instant with microsecond
157    /// precision, stored as `i64` microseconds since the Unix epoch.
158    Timestamp,
159    /// v7.9.2 `TIMESTAMPTZ` — bit-identical to `Timestamp` on disk
160    /// (i64 microseconds, UTC by convention). Carried as a distinct
161    /// type tag so the PG-wire layer can advertise OID 1184 (PG's
162    /// `timestamp with time zone`) and `sqlx`/`pgx`/JDBC clients
163    /// decode into their TZ-aware datetime types. The internal
164    /// semantics are unchanged: SPG never stored per-row offsets,
165    /// and neither did PG — `TIMESTAMPTZ` in PG is also UTC i64.
166    Timestamptz,
167    /// v7.39 (round 291) — PG's `name`: the type its catalogs use for
168    /// identifiers. Text truncated to NAMEDATALEN-1 (63) bytes, with
169    /// its own type identity — `pg_typeof('abc'::name)` is `name`, and
170    /// `CREATE TABLE t (a name)` is legal SQL that SPG rejected.
171    Name,
172    /// v7.39 (round 640) — PG's `xid`: a transaction id. [`Value::Xid`]
173    /// has existed since round 512, so a `'5'::xid` literal already knew
174    /// what it was; this is the DECLARED half, which nothing had. Without
175    /// it `pg_typeof(NULL::xid)` answered `bigint`, `pg_type` could not
176    /// list oid 28 — leaving the 48 `pg_attribute` rows that describe
177    /// `xmin` / `xmax` pointing at a type no catalog carried — and
178    /// `CREATE TABLE t (a xid)` was refused as an unknown type.
179    ///
180    /// On disk it is the 8-byte body its BIGINT sibling writes, and it
181    /// reads back as a `Value::Xid`, so a stored column and a literal are
182    /// the same thing to everything downstream.
183    ///
184    /// What is NOT yet true of the identity: PG gives `xid` equality and
185    /// hashing and no ordering operator at all, so `min` / `max` /
186    /// `count(DISTINCT …)` / `<=` all error there and all answer here.
187    /// Measured, not assumed — and left for the operator surface rather
188    /// than claimed by this comment.
189    Xid,
190    /// v7.39 (round 640) — PG's `xid8`: the same transaction id, 64 bits
191    /// wide and monotonic. Unlike [`DataType::Xid`] it has no value of
192    /// its own; a cell is a `Value::BigInt` and only the declared type
193    /// witnesses it. That is enough for `pg_typeof`, the catalogs and
194    /// the wire OID, and not enough to refuse a bigint where PG refuses
195    /// one. `pg_current_xact_id()` returns this type on PG.
196    Xid8,
197    /// v7.39 (round 667) — PG's `oid`: an unsigned 32-bit object
198    /// identifier. Modelled exactly like [`DataType::Xid8`] above: it has
199    /// no value of its own, a cell is a `Value::BigInt`, and only the
200    /// declared type witnesses it.
201    ///
202    /// That deliberately buys less than a full value type. What it buys:
203    /// `CREATE TABLE t(o OID)` is accepted (it was rejected outright with
204    /// `type "oid" does not exist`, while the neighbouring `XID` worked),
205    /// `pg_typeof` answers `oid` rather than `bigint`, and the catalogs
206    /// report their own key columns honestly. What it does NOT buy is
207    /// refusing a bigint where PG refuses an oid — `sum(oid)` and
208    /// `avg(oid)` still answer here and error on PG, because at runtime
209    /// the cell is indistinguishable from a bigint. Round 664 tried to
210    /// close those two by name and withdrew: a guard keyed on the name
211    /// would have caught `sum(bigint)` with it.
212    ///
213    /// The cast itself was already right before this — `4294967296::oid`
214    /// and `'abc'::oid` produce PG's errors word for word, and `(-1)::oid`
215    /// wraps to 4294967295 as PG does. Only the resulting type was lost,
216    /// because `conversions.rs` mapped the target to `BigInt`.
217    Oid,
218    /// `INTERVAL` — calendar-aware span (months + microseconds). v2.11
219    /// supports INTERVAL only as a runtime intermediate (literals,
220    /// arithmetic results); on-disk encoding is rejected so this branch
221    /// can't appear in a `ColumnSchema`.
222    Interval,
223    /// v4.9: `JSON` — text-backed JSON document. We don't parse
224    /// the content (no path operators or jsonb functions yet) —
225    /// the column accepts any TEXT-compatible value and round-trips
226    /// it verbatim. PG OID 114 on the wire.
227    Json,
228    /// v7.9.0: `JSONB` — semantically identical to `Json` on
229    /// the storage side (same `Value::Json` cells, same
230    /// row codec), but advertised as PG OID 3802 on the wire
231    /// so `sqlx`-style clients that bind `jsonb` columns
232    /// decode correctly. mailrs migration blocker #3.
233    Jsonb,
234    /// v7.10.4: `BYTES` / `BYTEA` — variable-length raw binary.
235    /// Backed by `Value::Bytes(Vec<u8>)`. PG wire OID 17. Literal
236    /// forms accepted by parser/engine: PG hex form `'\xDEADBEEF'`
237    /// (case-insensitive hex pairs) and escape form
238    /// `'foo\\000bar'` (the latter decoded at coercion time when
239    /// the target column is BYTEA — TEXT columns leave the
240    /// backslash sequence verbatim).
241    Bytes,
242    /// v7.10.9: `TEXT[]` — single-dimension TEXT array. Elements
243    /// may be NULL (PG semantics). PG wire OID 1009. Literal
244    /// forms: `ARRAY['a', 'b', NULL]` and the PG external form
245    /// `'{a,b,NULL}'::TEXT[]`. Engine implements `= ANY(arr)`,
246    /// `<> ALL(arr)`, and 1-based indexing `arr[i]`. Catalog
247    /// FILE_VERSION 18+; older snapshots reject this DataType
248    /// (forward-only by design — TEXT[] columns aren't readable
249    /// on a pre-v7.10 binary).
250    TextArray,
251    /// v7.11.12: `INT[]` — single-dimension i32 array. PG wire
252    /// OID 1007 (_int4). Same `ARRAY[...]` / `'{1,2,3}'::INT[]`
253    /// literal surface as TEXT[]. Catalog FILE_VERSION 19+.
254    IntArray,
255    /// v7.11.12: `BIGINT[]` — single-dimension i64 array. PG
256    /// wire OID 1016 (_int8). Catalog FILE_VERSION 19+.
257    BigIntArray,
258    /// v7.39 (round 694) — `oid[]`. It exists for the reason
259    /// [`DataType::Oid`] does: mapping it onto `BigIntArray` answers
260    /// `pg_typeof('{1,2}'::oid[])` with `bigint[]`, which is the defect
261    /// round 667 closed for the scalar.
262    OidArray,
263    /// v7.37.5 β-P4 — `INTERVAL[]` — single-dimension array of
264    /// `IntervalSpan { months, days, micros }`. PG wire OID 1187
265    /// (`_interval`). Catalog tag 35 + per-cell body
266    /// `[u16 count][per elem: u8 null + (if non-null) 16-byte
267    /// interval body in LE PG-byte-equal field order]`.
268    /// FILE_VERSION 48+.
269    IntervalArray,
270    /// v7.37.5 γ — full PG array-of-scalar family. Catalog tags
271    /// 36..48; wire OIDs from PG `pg_type.dat`. Per-element body
272    /// uses the scalar's existing `write_value_body` shape.
273    /// FILE_VERSION 48+ (same window as β; no separate bump).
274    BoolArray, // PG `_bool`        OID 1000, tag 36
275    SmallIntArray,    // PG `_int2`        OID 1005, tag 37
276    FloatArray,       // PG `_float8`      OID 1022, tag 38
277    NumericArray,     // PG `_numeric`     OID 1231, tag 39
278    DateArray,        // PG `_date`        OID 1182, tag 40
279    TimestampArray,   // PG `_timestamp`   OID 1115, tag 41
280    TimestamptzArray, // PG `_timestamptz` OID 1185, tag 42
281    UuidArray,        // PG `_uuid`        OID 2951, tag 43
282    JsonArray,        // PG `_json`        OID 199,  tag 44
283    JsonbArray,       // PG `_jsonb`       OID 3807, tag 45
284    BytesArray,       // PG `_bytea`       OID 1001, tag 46
285    VarcharArray,     // PG `_varchar`     OID 1015, tag 47
286    CharArray,        // PG `_bpchar`      OID 1014, tag 48
287    /// v7.37.5 δ — PG 14+ multirange types. A multirange is an
288    /// ordered collection of non-overlapping ranges of the same
289    /// element kind (e.g. `int4multirange(int4range(1,5),
290    /// int4range(10,15))` → `{[1,5),[10,15)}`). The same DataType
291    /// variant covers all six builtin multiranges; `RangeKind`
292    /// pins the element type so encode/decode/display can route
293    /// off one switch (parallel to `Range(RangeKind)`).
294    /// Wire OIDs: int4multirange=4451, int8multirange=4537,
295    /// nummultirange=4536, tsmultirange=4533, tstzmultirange=4534,
296    /// datemultirange=4535. Catalog tag 49 + 1-byte RangeKind on
297    /// the dense type-tag side. FILE_VERSION 48+ (same window as
298    /// β/γ, no separate bump).
299    Multirange(RangeKind),
300    /// v7.37.5 ε — PG geometry scalar family. Mirrors PG's seven
301    /// builtin geometric types one-for-one. Body shapes (LE):
302    ///   Point   = 16 B fixed (f64 x + f64 y)            OID 600
303    ///   Lseg    = 32 B fixed (Point p1 + Point p2)      OID 601
304    ///   Path    = varlena ([u8 closed][u32 n][Point*n]) OID 602
305    ///   Box     = 32 B fixed (Point ur + Point ll)      OID 603
306    ///   Polygon = varlena ([u32 n][Point*n])            OID 604
307    ///   Line    = 24 B fixed (f64 a + f64 b + f64 c)    OID 628
308    ///   Circle  = 24 B fixed (Point center + f64 r)     OID 718
309    /// Catalog tags 50..56. FILE_VERSION 48+ (same window as β/γ/δ;
310    /// no separate bump). Geometric operators (`<->` / `@>` / `&&`
311    /// / `<<` / `>>` / `~=`) are a planner-integration follow-up,
312    /// parallel to the Range operator defer in e2e_pg_range.rs.
313    Point,
314    Lseg,
315    Path,
316    PgBox,
317    Polygon,
318    Line,
319    Circle,
320    /// v7.37.5 ζ-A — PG network address family. Body shapes (LE):
321    ///   Inet     = 18 B fixed (u8 family + u8 bits + 16 B addr)  OID 869
322    ///   Cidr     = 18 B fixed (same shape as Inet; CIDR rejects
323    ///                          host bits at parse / coerce)       OID 650
324    ///   Macaddr  = 6 B fixed                                      OID 829
325    ///   Macaddr8 = 8 B fixed (EUI-64)                             OID 774
326    /// Catalog tags 57-60. FILE_VERSION 48+. `family = 4` is IPv4
327    /// (uses the first 4 bytes of the 16-B addr slot, rest 0);
328    /// `family = 6` is IPv6 (full 16 B).
329    Inet,
330    Cidr,
331    Macaddr,
332    Macaddr8,
333    /// v7.39 (read01 pg_lsn.c) — PG `pg_lsn` (WAL location). 8 bytes,
334    /// rendered `%X/%X`. Catalog tag 66. OID 3220.
335    PgLsn,
336    /// v7.37.5 ζ-A — PG bit string. Body = `[u32 nbits][ceil(nbits/8) bytes]`,
337    /// big-endian within each byte (matches PG binary).
338    ///   Bit         OID 1560 (fixed-length, but SPG carries the
339    ///                         length per cell — column declaration
340    ///                         `BIT(n)` constrains at coerce time)
341    ///   BitVarying  OID 1562 (variable-length, declared as `VARBIT`)
342    /// Catalog tags 61-62.
343    /// v7.39 (round 281) — `BIT(n)`: a FIXED-length bit string. `0`
344    /// means the type was written without a typmod, which PG treats as
345    /// `bit(1)`. Column assignment requires the length to match
346    /// exactly; an explicit cast pads or truncates instead.
347    Bit(u32),
348    /// v7.39 (round 281) — `BIT VARYING(n)`: `n` is a MAXIMUM, and `0`
349    /// means unbounded (`varbit` with no typmod).
350    BitVarying(u32),
351    /// v7.37.5 ζ-A — PG `xml`. Body identical to TEXT (storage is
352    /// the verbatim XML string; no parse-time validation). Only
353    /// the wire OID (142) differs. Catalog tag 63.
354    Xml,
355    /// v7.37.5 ζ-A — PG `"char"` (the internal single-byte type,
356    /// distinct from `CHAR(n)` / `BPCHAR`). Body = 1 byte raw.
357    /// OID 18. Catalog tag 64.
358    Char1,
359    /// v7.37.5 ζ-A — `MONEY[]`. Body = `[u16 count][per elem: u8 null
360    /// + (non-null) i64 LE cents]`. OID 791. Catalog tag 65.
361    MoneyArray,
362    /// v7.12.0: PG `tsvector` — ordered, deduplicated set of
363    /// `(lexeme, positions, weight)` tuples. PG wire OID 3614.
364    /// Catalog FILE_VERSION 20+. Storage shape is row-codec
365    /// tag 22; the schema-agnostic `write_value` path emits tag
366    /// 18. Literal: `'foo:1 bar:2,3'::tsvector` (PG external
367    /// form). G-CRIT-3 entry — v7.12.0 only ships the type +
368    /// codec; matching `@@` lands in v7.12.2.
369    TsVector,
370    /// v7.12.0: PG `tsquery` — parse tree of lexemes joined by
371    /// `&` `|` `!` and phrase operators. PG wire OID 3615.
372    /// Catalog FILE_VERSION 20+.
373    TsQuery,
374    /// v7.17.0: PG `uuid` — 128-bit identifier stored as
375    /// `Value::Uuid([u8; 16])`. PG wire OID 2950. Canonical
376    /// text form is lowercase 8-4-4-4-12 hyphenated; input
377    /// also accepts uppercase, unhyphenated, and brace-wrapped
378    /// forms (`{xxxx…}`). Catalog FILE_VERSION 36+; tag 24 on
379    /// the dense type-tag side, tag 20 on the schema-agnostic
380    /// value side. The drop-in PG/MySQL surface for Django /
381    /// Rails / Hibernate "id UUID PRIMARY KEY DEFAULT
382    /// gen_random_uuid()" default-PK pattern.
383    Uuid,
384    /// v7.17.0 Phase 3.P0-32: PG `time` (without time zone) — i64
385    /// microseconds since 00:00:00. PG wire OID 1083. Display:
386    /// canonical zero-padded `HH:MM:SS` when fractional is zero,
387    /// `HH:MM:SS.ffffff` otherwise. Catalog FILE_VERSION 37+;
388    /// tag 25 on the dense type-tag side, tag 21 on the schema-
389    /// agnostic value side. The wall-clock-of-day half of PG's
390    /// date/time triplet (date / time / timestamp).
391    Time,
392    /// v7.17.0 Phase 3.P0-33: MySQL `YEAR` — u16 in range
393    /// 1901..=2155 plus the special zero-year sentinel 0. No
394    /// dedicated PG OID (advertised as INT4 / OID 23 on the wire
395    /// — psql renders integers, MySQL CLI renders 4-digit
396    /// zero-padded text). Display always 4 digits: `0000` for the
397    /// zero-year, `1985` / `2007` / etc otherwise. Catalog
398    /// FILE_VERSION 38+; tag 26 on the dense type-tag side, tag
399    /// 22 on the schema-agnostic value side.
400    Year,
401    /// v7.17.0 Phase 3.P0-34: PG `time with time zone` (TIMETZ) —
402    /// i64 microseconds since 00:00:00 in the local wall clock
403    /// PLUS i32 offset-from-UTC in seconds. PG wire OID 1266.
404    /// Display: `HH:MM:SS[.ffffff]±HH[:MM]` (PG `timetz_out`).
405    /// Range: offset in ±50400 seconds (±14 hours). Catalog
406    /// FILE_VERSION 39+; tag 27 on the dense type-tag side, tag
407    /// 23 on the schema-agnostic value side.
408    TimeTz,
409    /// v7.17.0 Phase 3.P0-35: PG `money` — i64 cents (locale-
410    /// independent storage). PG wire OID 790. Display: en_US
411    /// locale (`$N,NNN.CC`, negative → `-$1.23`). Input accepts
412    /// `$N.NN`, `$N,NNN.NN`, bare integer (treated as major
413    /// units), optional leading `-`. Range: full i64. Catalog
414    /// FILE_VERSION 40+; tag 28 on the dense type-tag side, tag
415    /// 24 on the schema-agnostic value side.
416    Money,
417    /// v7.17.0 Phase 3.P0-38: PG range type. The same DataType
418    /// variant covers all six builtin ranges (int4range,
419    /// int8range, numrange, tsrange, tstzrange, daterange) —
420    /// `RangeKind` pins the element type so encode / decode /
421    /// display can route off one switch. Catalog FILE_VERSION
422    /// 43+; tag 29 + a 1-byte RangeKind on the dense type-tag
423    /// side, tag 25 on the schema-agnostic value side.
424    Range(RangeKind),
425    /// v7.17.0 Phase 3.P0-39: PG `hstore` extension type — flat
426    /// `text => text` map with NULL value support. Catalog
427    /// FILE_VERSION 44+; tag 30 on the dense type-tag side, tag
428    /// 26 on the schema-agnostic value side. The contrib OID is
429    /// installation-dependent in real PG; SPG advertises it via
430    /// dynamic lookup, falling back to TEXT (OID 25) on the wire
431    /// when the installed `hstore` extension hasn't claimed an
432    /// OID yet.
433    Hstore,
434    /// v7.17.0 Phase 3.P0-40: PG `int[][]` — 2-dimensional INT
435    /// matrix. Storage: row-major Vec<Vec<Option<i32>>>. All
436    /// rows must share the same column count. Wire OID 1007
437    /// (same as INT[]; the dimension count travels in the data
438    /// header, not the OID). Catalog FILE_VERSION 45+; tag 31
439    /// on the dense type-tag side, tag 27 on the schema-agnostic
440    /// value side.
441    IntArray2D,
442    /// v7.17.0 Phase 3.P0-40: PG `bigint[][]` — 2-dimensional
443    /// BIGINT matrix. Storage / OID / tags mirror IntArray2D.
444    /// Tag 32 dense, tag 28 schema-agnostic.
445    BigIntArray2D,
446    /// v7.17.0 Phase 3.P0-40: PG `text[][]` — 2-dimensional TEXT
447    /// matrix. Storage: row-major Vec<Vec<Option<String>>>.
448    /// Tag 33 dense, tag 29 schema-agnostic.
449    TextArray2D,
450    /// v7.39 (read01 round 75) — `bool[][]`. BOOL is the ONE element type whose
451    /// ARRAY rendering differs from its scalar one (`t` vs `true`), so a
452    /// text-backed 2-D cannot be PG-faithful for it: rendering the whole array
453    /// wants `t`, and subscripting a cell to text wants `false`. Every other
454    /// element type renders the same either way, which is why this is the only
455    /// typed 2-D variant SPG needs.
456    BoolArray2D,
457}
458
459/// v7.17.0 Phase 3.P0-38 — pins the element type of a range value
460/// or column. Wire OIDs: Int4=3904, Int8=3926, Num=3906,
461/// Ts=3908, TsTz=3910, Date=3912.
462#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
463pub enum RangeKind {
464    Int4,
465    Int8,
466    Num,
467    Ts,
468    TsTz,
469    Date,
470}
471
472impl RangeKind {
473    pub const fn tag(self) -> u8 {
474        match self {
475            Self::Int4 => 0,
476            Self::Int8 => 1,
477            Self::Num => 2,
478            Self::Ts => 3,
479            Self::TsTz => 4,
480            Self::Date => 5,
481        }
482    }
483    pub const fn from_tag(t: u8) -> Option<Self> {
484        Some(match t {
485            0 => Self::Int4,
486            1 => Self::Int8,
487            2 => Self::Num,
488            3 => Self::Ts,
489            4 => Self::TsTz,
490            5 => Self::Date,
491            _ => return None,
492        })
493    }
494    pub const fn keyword(self) -> &'static str {
495        match self {
496            Self::Int4 => "INT4RANGE",
497            Self::Int8 => "INT8RANGE",
498            Self::Num => "NUMRANGE",
499            Self::Ts => "TSRANGE",
500            Self::TsTz => "TSTZRANGE",
501            Self::Date => "DATERANGE",
502        }
503    }
504}
505
506impl fmt::Display for DataType {
507    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
508        match self {
509            Self::SmallInt => f.write_str("SMALLINT"),
510            Self::Int => f.write_str("INT"),
511            Self::BigInt => f.write_str("BIGINT"),
512            Self::Xid => f.write_str("XID"),
513            Self::Xid8 => f.write_str("XID8"),
514            Self::Oid => f.write_str("OID"),
515            Self::OidArray => f.write_str("OID[]"),
516            Self::Float => f.write_str("FLOAT"),
517            Self::Real => f.write_str("REAL"),
518            Self::Text => f.write_str("TEXT"),
519            Self::Varchar(n) => write!(f, "VARCHAR({n})"),
520            Self::Char(n) => write!(f, "CHAR({n})"),
521            Self::Bool => f.write_str("BOOL"),
522            Self::Vector { dim, encoding } => match encoding {
523                VecEncoding::F32 => write!(f, "VECTOR({dim})"),
524                VecEncoding::Sq8 => write!(f, "VECTOR({dim}) USING SQ8"),
525                VecEncoding::F16 => write!(f, "VECTOR({dim}) USING HALF"),
526            },
527            Self::Numeric { precision, scale } => {
528                if *scale == 0 {
529                    write!(f, "NUMERIC({precision})")
530                } else {
531                    write!(f, "NUMERIC({precision}, {scale})")
532                }
533            }
534            Self::Date => f.write_str("DATE"),
535            Self::Timestamp => f.write_str("TIMESTAMP"),
536            Self::Timestamptz => f.write_str("TIMESTAMPTZ"),
537            Self::Name => f.write_str("NAME"),
538            Self::Interval => f.write_str("INTERVAL"),
539            Self::Json => f.write_str("JSON"),
540            Self::Jsonb => f.write_str("JSONB"),
541            Self::Bytes => f.write_str("BYTEA"),
542            Self::TextArray => f.write_str("TEXT[]"),
543            Self::IntArray => f.write_str("INT[]"),
544            Self::BigIntArray => f.write_str("BIGINT[]"),
545            Self::IntervalArray => f.write_str("INTERVAL[]"),
546            Self::BoolArray => f.write_str("BOOL[]"),
547            Self::SmallIntArray => f.write_str("SMALLINT[]"),
548            Self::FloatArray => f.write_str("FLOAT[]"),
549            Self::NumericArray => f.write_str("NUMERIC[]"),
550            Self::DateArray => f.write_str("DATE[]"),
551            Self::TimestampArray => f.write_str("TIMESTAMP[]"),
552            Self::TimestamptzArray => f.write_str("TIMESTAMPTZ[]"),
553            Self::UuidArray => f.write_str("UUID[]"),
554            Self::JsonArray => f.write_str("JSON[]"),
555            Self::JsonbArray => f.write_str("JSONB[]"),
556            Self::BytesArray => f.write_str("BYTEA[]"),
557            Self::VarcharArray => f.write_str("VARCHAR[]"),
558            Self::CharArray => f.write_str("CHAR[]"),
559            Self::Multirange(k) => f.write_str(match k {
560                RangeKind::Int4 => "INT4MULTIRANGE",
561                RangeKind::Int8 => "INT8MULTIRANGE",
562                RangeKind::Num => "NUMMULTIRANGE",
563                RangeKind::Ts => "TSMULTIRANGE",
564                RangeKind::TsTz => "TSTZMULTIRANGE",
565                RangeKind::Date => "DATEMULTIRANGE",
566            }),
567            Self::Point => f.write_str("POINT"),
568            Self::Lseg => f.write_str("LSEG"),
569            Self::Path => f.write_str("PATH"),
570            Self::PgBox => f.write_str("BOX"),
571            Self::Polygon => f.write_str("POLYGON"),
572            Self::Line => f.write_str("LINE"),
573            Self::Circle => f.write_str("CIRCLE"),
574            Self::Inet => f.write_str("INET"),
575            Self::Cidr => f.write_str("CIDR"),
576            Self::Macaddr => f.write_str("MACADDR"),
577            Self::Macaddr8 => f.write_str("MACADDR8"),
578            Self::PgLsn => f.write_str("PG_LSN"),
579            Self::Bit(0) => f.write_str("BIT"),
580            Self::Bit(n) => write!(f, "BIT({n})"),
581            Self::BitVarying(0) => f.write_str("VARBIT"),
582            Self::BitVarying(n) => write!(f, "VARBIT({n})"),
583            Self::Xml => f.write_str("XML"),
584            Self::Char1 => f.write_str("\"char\""),
585            Self::MoneyArray => f.write_str("MONEY[]"),
586            Self::TsVector => f.write_str("TSVECTOR"),
587            Self::TsQuery => f.write_str("TSQUERY"),
588            Self::Uuid => f.write_str("UUID"),
589            Self::Time => f.write_str("TIME"),
590            Self::Year => f.write_str("YEAR"),
591            Self::TimeTz => f.write_str("TIMETZ"),
592            Self::Money => f.write_str("MONEY"),
593            Self::Range(k) => f.write_str(k.keyword()),
594            Self::Hstore => f.write_str("HSTORE"),
595            Self::IntArray2D => f.write_str("INT[][]"),
596            Self::BigIntArray2D => f.write_str("BIGINT[][]"),
597            Self::TextArray2D => f.write_str("TEXT[][]"),
598            Self::BoolArray2D => f.write_str("BOOL[][]"),
599        }
600    }
601}
602
603/// v7.12.0 — one entry in a `Value::TsVector`. The lexeme is the
604/// (already-tokenised + stemmed in v7.12.1+) word; `positions` is
605/// a strictly-ascending list of 1-based positions; `weight` is the
606/// PG weight letter (A=3, B=2, C=1, D=0) — v7.12.0 defaults every
607/// lexeme to D, the v7.12.2 ranking path consumes the weight.
608#[derive(Debug, Clone, PartialEq, Eq)]
609pub struct TsLexeme {
610    pub word: String,
611    pub positions: Vec<u16>,
612    pub weight: u8,
613}
614
615/// v7.12.0 — parse tree for a PG `tsquery`. v7.12.0 ships the
616/// type + codec only; the `to_tsquery` / `plainto_tsquery` lexer
617/// lands in v7.12.1 and the `@@` evaluator in v7.12.2.
618#[derive(Debug, Clone, PartialEq, Eq)]
619pub enum TsQueryAst {
620    /// Single lexeme term. The `weight_mask` is the PG-style
621    /// bitmask of accepted weights (`A=1<<3`, `B=1<<2`, `C=1<<1`,
622    /// `D=1<<0`); `0` = any weight. v7.12.0 always sets it to 0.
623    Term {
624        word: String,
625        weight_mask: u8,
626    },
627    And(Box<TsQueryAst>, Box<TsQueryAst>),
628    Or(Box<TsQueryAst>, Box<TsQueryAst>),
629    Not(Box<TsQueryAst>),
630    /// `phrase <distance> phrase`. v7.12.0 only persists this; the
631    /// match semantics arrive in v7.12.2 alongside `@@`.
632    Phrase {
633        left: Box<TsQueryAst>,
634        right: Box<TsQueryAst>,
635        distance: u16,
636    },
637}
638
639/// A row-cell value, including SQL `NULL`. `Float` uses `f64`; NaN compares
640/// non-equal to itself (PG behaviour) — `PartialEq` is derived so callers
641/// must opt into NaN-aware comparison if they need stronger guarantees.
642///
643/// v7.37.42-arena Phase 1: parameterised on `'arena` so heap-bearing
644/// variants (Text/Json/Xml/Bytes/Vector/BitString.bytes) can borrow from
645/// a per-query bump arena (`Cow::Borrowed(&'arena ...)`). Persistent /
646/// catalog Values use `Value<'static>` (alias `ValueOwned`) with
647/// `Cow::Owned(...)`. Phase 1 keeps Range/Multirange recursive `Box<Value>`
648/// at `'static` (owned) — arena migration deferred to a later phase.
649/// Array-of-Option<String> variants (TextArray etc.) also stay owned in
650/// Phase 1; their nested shape is awkward for the simple Cow lift and the
651/// SCALARSQ hot path doesn't touch them.
652/// v7.38 (read01, T6) — the IEEE-style class of a NUMERIC value. `Finite` is the
653/// ordinary fixed-point case; the specials mirror PG's `'NaN'` / `'Infinity'` /
654/// `'-Infinity'`. Derived `PartialEq` gives `NaN == NaN` — correct for NUMERIC
655/// (unlike float's NaN ≠ NaN); the total order (`-Inf < finite < +Inf < NaN`)
656/// lives in the comparison paths, not in `Ord`.
657#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Hash)]
658pub enum NumericKind {
659    #[default]
660    Finite,
661    NaN,
662    PosInf,
663    NegInf,
664}
665
666#[derive(Debug, Clone, PartialEq)]
667#[non_exhaustive]
668pub enum Value<'arena> {
669    SmallInt(i16),
670    Int(i32),
671    BigInt(i64),
672    Float(f64),
673    /// v7.38 (read01, T-float4) — PG `real` (32-bit IEEE float).
674    Real(f32),
675    Text(Cow<'arena, str>),
676    Bool(bool),
677    Vector(Cow<'arena, [f32]>),
678    /// v6.0.1: 8-bit scalar-quantised vector cell. Lives in
679    /// columns declared `VECTOR(N) USING SQ8`. Layout per cell:
680    /// `Sq8Vector { min: f32, max: f32, bytes: Vec<u8> }` —
681    /// 4× compression vs `Vector(Vec<f32>)`. The wire layer
682    /// dequantises to `f32` on SELECT; INSERT path quantises
683    /// incoming `Vector(Vec<f32>)` cells into this variant.
684    Sq8Vector(crate::quantize::Sq8Vector),
685    /// v6.0.3: IEEE-754 binary16 vector cell. Lives in columns
686    /// declared `VECTOR(N) USING HALF`. Stores raw u16 LE bits
687    /// (2× compression vs `Vector(Vec<f32>)`). Wire / display
688    /// paths dequantise to f32 bit-exactly; INSERT path converts
689    /// incoming f32 vectors at the engine boundary.
690    HalfVector(crate::halfvec::HalfVector),
691    /// Exact fixed-point decimal. `scaled` holds the value as
692    /// `actual * 10^scale` so the storage type is always integral —
693    /// arithmetic never falls back to floating-point. v7.38 (read01, T6) —
694    /// `kind` classifies the value as finite (the common case, using
695    /// `scaled`/`scale`) or one of PG's NUMERIC specials (NaN / ±Infinity),
696    /// which ignore `scaled`/`scale` (canonicalized to 0).
697    Numeric {
698        scaled: i128,
699        /// v7.39 (round 271) — widened from u8. PG's numeric carries a
700        /// display scale up to 16383; at u8 a literal with 256 decimal
701        /// places could not be represented at all, and the conversion
702        /// aborted the query with an internal error.
703        scale: u16,
704        kind: NumericKind,
705    },
706    /// v7.38 (read01, T3) — an exact NUMERIC whose mantissa overflows `i128`
707    /// (PG's NUMERIC is unbounded). Boxed so the common finite case keeps its
708    /// small footprint; specials never take this form (they stay `Numeric`).
709    NumericBig(alloc::boxed::Box<crate::bignum::BigNumeric>),
710    /// Days since the Unix epoch (1970-01-01). Negative for earlier dates.
711    Date(i32),
712    /// Microseconds since the Unix epoch (1970-01-01T00:00:00Z).
713    Timestamp(i64),
714    /// Calendar span: `months` + `days` + `micros`. Three fields are
715    /// required for PG byte-equal: `'1 day'` ≠ `'24 hours'` (DST,
716    /// month-boundary, and the on-wire `pg_type` `interval` are all
717    /// `i64 micros + i32 days + i32 months`). v7.37.5 β widened from
718    /// `{months, micros}`; column storage lands in the same window.
719    Interval {
720        months: i32,
721        days: i32,
722        micros: i64,
723    },
724    /// v4.9 `JSON` — raw JSON text. No structural validation
725    /// happens at the storage layer; whatever the parser hands us
726    /// round-trips verbatim. Equality is byte-wise.
727    Json(Cow<'arena, str>),
728    /// v7.10.4 `BYTEA` — raw binary blob. Equality is byte-wise.
729    /// Layout matches `Text`'s length-prefixed shape (`[u32 LE
730    /// len][bytes]`) under tag 18; the engine accepts PG hex
731    /// literals (`'\xDEADBEEF'`) and escape literals at the
732    /// coercion boundary.
733    Bytes(Cow<'arena, [u8]>),
734    /// v7.10.9 `TEXT[]` — single-dimension TEXT array with
735    /// optional NULL elements. Equality is element-wise. PG's
736    /// NULL-element comparison semantics: NULL ≠ NULL inside
737    /// arrays under `=`, so `[NULL] != [NULL]` (the engine
738    /// honours this).
739    TextArray(Vec<Option<String>>),
740    /// v7.11.12 `INT[]` — single-dimension i32 array with optional
741    /// NULL elements. Codec mirrors TextArray with i32 LE per
742    /// element instead of length-prefixed UTF-8.
743    IntArray(Vec<Option<i32>>),
744    /// v7.11.12 `BIGINT[]` — single-dimension i64 array with optional
745    /// NULL elements.
746    BigIntArray(Vec<Option<i64>>),
747    /// v7.37.5 β-P4 `INTERVAL[]` — single-dimension array of
748    /// `IntervalSpan { months, days, micros }` with optional NULL
749    /// elements. PG external form quotes each non-NULL element
750    /// (`{"1 day","24:00:00",NULL}`) because interval text contains
751    /// spaces and colons. Storage codec follows the BigIntArray
752    /// shape with a 16-byte per-element body.
753    IntervalArray(Vec<Option<IntervalSpan>>),
754    /// v7.37.5 γ — single-dimension arrays of the remaining PG
755    /// scalar types. Each carries `Vec<Option<T>>` with the
756    /// scalar's natural Rust shape; element NULLs are first-class
757    /// (per PG: `{1,NULL,3}` is a 3-element array, not a 2-element
758    /// one). Codec follows the IntervalArray shape — `[u16 count]
759    /// [per elem: u8 null + (non-null) scalar body]`.
760    BoolArray(Vec<Option<bool>>),
761    SmallIntArray(Vec<Option<i16>>),
762    FloatArray(Vec<Option<f64>>),
763    /// PG `NUMERIC[]` — `(scaled: i128, scale: u16)` per element.
764    NumericArray(Vec<Option<(i128, u16)>>),
765    DateArray(Vec<Option<i32>>),
766    TimestampArray(Vec<Option<i64>>),
767    TimestamptzArray(Vec<Option<i64>>),
768    UuidArray(Vec<Option<[u8; 16]>>),
769    JsonArray(Vec<Option<String>>),
770    JsonbArray(Vec<Option<String>>),
771    BytesArray(Vec<Option<Vec<u8>>>),
772    VarcharArray(Vec<Option<String>>),
773    CharArray(Vec<Option<String>>),
774    /// v7.37.5 δ — PG 14+ multirange. `ranges` is a Vec of
775    /// non-overlapping bounds spans of the shared `kind`. PG's
776    /// canonical text form is `{[a,b),[c,d),...}` (comma-separated
777    /// ranges in braces; `{}` for the empty multirange). SPG's
778    /// constructor enforces no overlap/coalescing — for now the
779    /// engine trusts the caller (mirrors PG's `_construct_array`
780    /// pattern). Catalog tag 49 + 1-byte RangeKind on the dense
781    /// type-tag side; schema-less path is unreachable (multirange
782    /// is column-typed only).
783    Multirange {
784        kind: RangeKind,
785        ranges: Vec<RangeSpan>,
786    },
787    /// v7.37.5 ε — PG geometry scalars. Per-type Vec/struct shape;
788    /// codec body shape is described on the matching DataType
789    /// variant. PG canonical text forms:
790    ///   Point   `(x,y)`
791    ///   Lseg    `[(x1,y1),(x2,y2)]`
792    ///   Path    open `[(x,y),(x,y),...]` / closed `((x,y),(x,y),...)`
793    ///   Box     `(ux,uy),(lx,ly)` (PG normalises to upper-right + lower-left)
794    ///   Polygon `((x,y),(x,y),...)` (implicit closed)
795    ///   Line    `{a,b,c}` (Ax + By + C = 0)
796    ///   Circle  `<(x,y),r>`
797    Point(Point2D),
798    Lseg(Point2D, Point2D),
799    /// `closed = true` is `((p,p,...))`; `false` is `[(p,p,...)]`.
800    Path {
801        points: Vec<Point2D>,
802        closed: bool,
803    },
804    /// PG `box` — stored as `(upper_right, lower_left)` (PG's
805    /// normalised order). The engine accepts both endpoint
806    /// orderings at parse time and normalises here.
807    PgBox(Point2D, Point2D),
808    Polygon(Vec<Point2D>),
809    Line {
810        a: f64,
811        b: f64,
812        c: f64,
813    },
814    Circle {
815        center: Point2D,
816        radius: f64,
817    },
818    /// v7.37.5 ζ-A — PG `inet`. `family = 4` (IPv4) or `6` (IPv6).
819    /// `bits` is the netmask bit count (0..=32 for IPv4, 0..=128
820    /// for IPv6). `addr` is right-padded with zeros when family=4
821    /// (first 4 bytes are the address).
822    Inet {
823        family: u8,
824        bits: u8,
825        addr: [u8; 16],
826    },
827    /// v7.37.5 ζ-A — PG `cidr`. Same shape as Inet; CIDR's
828    /// invariant (host bits zero) is enforced at parse / coerce.
829    Cidr {
830        family: u8,
831        bits: u8,
832        addr: [u8; 16],
833    },
834    /// v7.37.5 ζ-A — PG `macaddr`. 6 bytes (XX:XX:XX:XX:XX:XX).
835    Macaddr([u8; 6]),
836    /// v7.37.5 ζ-A — PG `macaddr8`. 8 bytes (EUI-64).
837    Macaddr8([u8; 8]),
838    /// v7.39 (read01 pg_lsn.c) — PG `pg_lsn`, a 64-bit WAL location.
839    PgLsn(u64),
840    /// v7.39 (read01 ruleutils.c) — PG `regclass`: an OID-typed relation
841    /// reference that renders as the relation name. SPG carries BOTH
842    /// (the synthetic oid for catalog joins, the name for display) so
843    /// `conrelid = 't'::regclass` and `'t'::regclass::text` agree.
844    /// Eval-only (no column storage).
845    RegClass(i64, alloc::boxed::Box<str>),
846    /// v7.39 (round 342, V65) — PG `regproc`: an OID-typed FUNCTION
847    /// reference that renders as the function name. Same dual shape
848    /// [`Value::RegClass`] carries, and for the same reason: without the
849    /// oid half, `pg_proc.oid = 'f'::regproc` cannot join, and a callee
850    /// cannot tell `pg_get_functiondef('f'::regproc)` — which PG answers
851    /// — from `pg_get_functiondef('f')` — which PG rejects.
852    /// Eval-only (no column storage).
853    RegProc(i64, alloc::boxed::Box<str>),
854    /// v7.39 (round 648) — PG `regtype`: an OID-typed TYPE reference
855    /// that renders as the type name. The third of the shape
856    /// [`Value::RegClass`] and [`Value::RegProc`] carry, and the one
857    /// that was missing it: `::regtype` produced a plain `Value::Text`
858    /// holding the canonical name, so `'text'::regtype::oid` tried to
859    /// parse the NAME as a number and answered `invalid input syntax
860    /// for type oid: "text"` where PG answers 25. `pg_typeof` on one
861    /// said `text` rather than `regtype` for the same reason.
862    ///
863    /// Eval-only (no column storage).
864    RegType(i64, alloc::boxed::Box<str>),
865    /// v7.39 (round 512) — PG `xid` and `cid`, the transaction and command
866    /// ids the `xmin` / `xmax` / `cmin` / `cmax` system columns carry.
867    ///
868    /// Their own types rather than integers, because PG deliberately gives
869    /// them almost no operators: measured on PG18, `xmin + 1` is "operator
870    /// does not exist: xid + integer", `xmin > 0` likewise, `xmin::bigint`
871    /// is "cannot cast type xid to bigint", and there is no `max(xid)`.
872    /// Carrying them as BigInt would quietly allow all four.
873    ///
874    /// Eval-only (no column storage).
875    Xid(u32),
876    Cid(u32),
877    /// v7.39 (round 511) — PG `tid`, the physical row identity `ctid`
878    /// carries: a block number and a one-based offset inside it, rendered
879    /// `(block,offset)`.
880    ///
881    /// It is a real type rather than a two-field record because the idiom
882    /// that makes `ctid` worth having — `DELETE … WHERE ctid NOT IN (SELECT
883    /// min(ctid) … GROUP BY key)` — needs `min()` over it, and PG has no
884    /// `min(record)`. Ordering is by block then offset, so `(0,2) < (0,9) <
885    /// (0,10)`; a text form would order those `(0,10) < (0,2) < (0,9)` and
886    /// the dedup would keep the wrong row.
887    ///
888    /// Eval-only (no column storage).
889    Tid(u32, u32),
890    /// v7.37.5 ζ-A — PG `bit` / `bit varying`. `nbits` is the
891    /// actual bit count; `bytes` is the packed representation
892    /// (big-endian within each byte; final byte right-padded
893    /// with 0s if `nbits % 8 != 0`).
894    BitString {
895        nbits: u32,
896        bytes: Cow<'arena, [u8]>,
897    },
898    /// v7.37.5 ζ-A — PG `xml`. Stored verbatim as a string; no
899    /// parse-time validation (matches the SPG JSON convention).
900    Xml(Cow<'arena, str>),
901    /// v7.37.5 ζ-A — PG `"char"` (internal single-byte type,
902    /// distinct from CHAR(n)).
903    Char1(u8),
904    /// v7.38 (read01, T11) — PG `bpchar` / CHAR(n): blank-padded fixed-length
905    /// string. Stored space-padded to the declared width (as PG does + for wire
906    /// display); length / comparison / ::text / concat all ignore the trailing
907    /// blanks (handled at those sites).
908    BpChar(Cow<'arena, str>),
909    /// v7.37.5 ζ-A — PG `money[]`.
910    MoneyArray(Vec<Option<i64>>),
911    /// v7.12.0 `tsvector` — sorted-by-word, deduped lexeme set with
912    /// positions + weights. The engine enforces sort/dedup on
913    /// construction; consumers can rely on `lexemes.windows(2)`
914    /// being strictly ascending by `word`.
915    TsVector(Vec<TsLexeme>),
916    /// v7.12.0 `tsquery` — boolean / phrase parse tree over
917    /// lexemes. Engine builds via `to_tsquery` family.
918    TsQuery(TsQueryAst),
919    /// v7.17.0 `uuid` — 128-bit identifier. Stored as 16 bytes
920    /// (big-endian / network-byte order, same as RFC 4122).
921    /// Display normalises to canonical lowercase 8-4-4-4-12
922    /// hyphenated form. Equality is byte-wise.
923    Uuid([u8; 16]),
924    /// v7.17.0 Phase 3.P0-32 — PG `time` (without time zone) —
925    /// i64 microseconds since 00:00:00. Range 0..86_400_000_000.
926    /// Display: `HH:MM:SS` zero-padded, with optional `.ffffff`
927    /// suffix when fractional is non-zero.
928    Time(i64),
929    /// v7.17.0 Phase 3.P0-33 — MySQL `YEAR` — u16 in range
930    /// 1901..=2155 plus the special zero-year sentinel 0.
931    /// Display always 4 digits zero-padded (`0000` for the
932    /// sentinel; `1985`/`2007` otherwise).
933    Year(u16),
934    /// v7.17.0 Phase 3.P0-34 — PG `time with time zone` — i64
935    /// microseconds since 00:00:00 in the LOCAL wall clock PLUS
936    /// an i32 offset-from-UTC in seconds. PG preserves the
937    /// offset on output, so the wall-clock value is NOT shifted
938    /// to UTC at storage time. Offset range: ±50400 seconds
939    /// (±14 hours).
940    TimeTz {
941        us: i64,
942        offset_secs: i32,
943    },
944    /// v7.17.0 Phase 3.P0-35 — PG `money` — i64 cents
945    /// (locale-independent storage; the en_US locale renders on
946    /// display via `$N,NNN.CC`).
947    Money(i64),
948    /// v7.17.0 Phase 3.P0-39 — PG `hstore` value: flat
949    /// `text => text` map with NULL value support. Insertion
950    /// order preserved on input; duplicate keys take last-write-
951    /// wins at parse time.
952    Hstore(Vec<(String, Option<String>)>),
953    /// v7.17.0 Phase 3.P0-40 — 2D INT matrix (row-major).
954    IntArray2D(Vec<Vec<Option<i32>>>),
955    /// v7.17.0 Phase 3.P0-40 — 2D BIGINT matrix (row-major).
956    BigIntArray2D(Vec<Vec<Option<i64>>>),
957    /// v7.17.0 Phase 3.P0-40 — 2D TEXT matrix (row-major).
958    TextArray2D(Vec<Vec<Option<String>>>),
959    /// v7.39 (read01 round 75) — see `DataType::BoolArray2D`.
960    BoolArray2D(Vec<Vec<Option<bool>>>),
961    /// v7.17.0 Phase 3.P0-38 — PG range value. One shape covers
962    /// all six builtin range types; `kind` pins the element type
963    /// (must match the column's `DataType::Range(kind)`).
964    /// `lower` / `upper` are `None` for the unbounded sides;
965    /// `lower_inc` / `upper_inc` mirror the canonical PG
966    /// `[` / `(` / `]` / `)` bracket inclusivity. `empty=true`
967    /// supersedes all other fields (the empty range has no
968    /// bounds).
969    Range {
970        kind: RangeKind,
971        // v7.37.42-arena Phase 1: Range bounds stay owned ('static).
972        // Recursive arena lifetimes are awkward to migrate at this
973        // phase and the SCALARSQ hot path doesn't construct ranges.
974        lower: Option<alloc::boxed::Box<Value<'static>>>,
975        upper: Option<alloc::boxed::Box<Value<'static>>>,
976        lower_inc: bool,
977        upper_inc: bool,
978        empty: bool,
979    },
980    /// v7.38 (read01, T9) — a composite / record value (a `row(...)`
981    /// constructor or a whole-row reference). Fields are `(name, value)`; the
982    /// names are `f1..fN` for an anonymous `row(...)` or the source column
983    /// names for a table row. Transient — flows through row_to_json / to_json
984    /// and the composite text form `(a,b)`; not a storable column type here.
985    Composite(alloc::vec::Vec<(alloc::string::String, Value<'static>)>),
986    Null,
987}
988
989/// Owned `Value` — heap-bearing variants are `Cow::Owned`. Used everywhere
990/// a Value must outlive a query-scoped arena (catalog defaults, persistent
991/// storage, public APIs).
992pub type ValueOwned = Value<'static>;
993
994/// v7.37.5 ε — PG `point` building block. Shared by every other
995/// geometric type (lseg / path / box / polygon / circle all
996/// reduce to compositions of `Point2D`). Packed `{x: f64, y: f64}`,
997/// 16 B, on-disk LE field order matches the PG binary point
998/// format byte-for-byte (so a future binary BIND path lands
999/// without rearrangement).
1000#[derive(Debug, Clone, Copy, PartialEq)]
1001pub struct Point2D {
1002    pub x: f64,
1003    pub y: f64,
1004}
1005
1006/// v7.37.5 δ — single-range bounds without the kind tag. Used as
1007/// the element type of `Value::Multirange { kind, ranges }` so a
1008/// multirange carries one shared `RangeKind` plus N bounds-only
1009/// spans (saves 1 byte/elem vs duplicating the kind). The five
1010/// other fields mirror `Value::Range` exactly.
1011#[derive(Debug, Clone, PartialEq)]
1012pub struct RangeSpan {
1013    // v7.37.42-arena Phase 1: stays owned ('static) — same rationale as
1014    // Range bounds above.
1015    pub lower: Option<alloc::boxed::Box<Value<'static>>>,
1016    pub upper: Option<alloc::boxed::Box<Value<'static>>>,
1017    pub lower_inc: bool,
1018    pub upper_inc: bool,
1019    pub empty: bool,
1020}
1021
1022/// v7.37.5 β-P4 — element type for `Value::IntervalArray`. Mirrors
1023/// the `{months, days, micros}` shape of scalar `Value::Interval`,
1024/// broken out as a named struct so `IntervalArray`'s element type
1025/// is concrete (24 bytes, packed) instead of an enum-boxed Value.
1026/// All three dimensions are independent — `IntervalSpan { days: 1,
1027/// .. }` is distinct from `IntervalSpan { micros: 86_400_000_000,
1028/// .. }` per PG byte-equal.
1029#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1030pub struct IntervalSpan {
1031    pub months: i32,
1032    pub days: i32,
1033    pub micros: i64,
1034}
1035
1036impl<'arena> Value<'arena> {
1037    /// Type tag, or `None` for `NULL` (unknown at value level).
1038    pub fn data_type(&self) -> Option<DataType> {
1039        match self {
1040            Self::SmallInt(_) => Some(DataType::SmallInt),
1041            Self::Int(_) => Some(DataType::Int),
1042            Self::BigInt(_) => Some(DataType::BigInt),
1043            Self::Float(_) => Some(DataType::Float),
1044            Self::Real(_) => Some(DataType::Real),
1045            // `Text` covers both unbounded TEXT and bounded VARCHAR/CHAR
1046            // — the constraint lives on the column schema, not the value.
1047            Self::Text(_) => Some(DataType::Text),
1048            Self::Bool(_) => Some(DataType::Bool),
1049            Self::Vector(v) => Some(DataType::Vector {
1050                dim: u32::try_from(v.len()).expect("vector dim ≤ u32"),
1051                encoding: VecEncoding::F32,
1052            }),
1053            Self::Sq8Vector(q) => Some(DataType::Vector {
1054                dim: u32::try_from(q.bytes.len()).expect("vector dim ≤ u32"),
1055                encoding: VecEncoding::Sq8,
1056            }),
1057            Self::HalfVector(h) => Some(DataType::Vector {
1058                dim: u32::try_from(h.dim()).expect("vector dim ≤ u32"),
1059                encoding: VecEncoding::F16,
1060            }),
1061            // `Value::Numeric` doesn't carry its precision (the column
1062            // schema does); we surface precision=0 as "unknown" and let
1063            // the engine reconcile against the column type at coercion
1064            // time.
1065            // v7.39 (round 273) — a VALUE's display scale is unsigned and
1066            // never exceeds PG's 16383 ceiling, so it always fits the
1067            // signed declared-scale field this describes itself with.
1068            Self::Numeric { scale, .. } => Some(DataType::Numeric {
1069                precision: 0,
1070                scale: i16::try_from(*scale).unwrap_or(i16::MAX),
1071            }),
1072            Self::NumericBig(b) => Some(DataType::Numeric {
1073                precision: 0,
1074                scale: i16::try_from(b.scale()).unwrap_or(i16::MAX),
1075            }),
1076            Self::Date(_) => Some(DataType::Date),
1077            Self::Timestamp(_) => Some(DataType::Timestamp),
1078            Self::Interval { .. } => Some(DataType::Interval),
1079            Self::Json(_) => Some(DataType::Json),
1080            Self::Bytes(_) => Some(DataType::Bytes),
1081            Self::TextArray(_) => Some(DataType::TextArray),
1082            Self::IntArray(_) => Some(DataType::IntArray),
1083            Self::BigIntArray(_) => Some(DataType::BigIntArray),
1084            Self::IntervalArray(_) => Some(DataType::IntervalArray),
1085            Self::BoolArray(_) => Some(DataType::BoolArray),
1086            Self::SmallIntArray(_) => Some(DataType::SmallIntArray),
1087            Self::FloatArray(_) => Some(DataType::FloatArray),
1088            Self::NumericArray(_) => Some(DataType::NumericArray),
1089            Self::DateArray(_) => Some(DataType::DateArray),
1090            Self::TimestampArray(_) => Some(DataType::TimestampArray),
1091            Self::TimestamptzArray(_) => Some(DataType::TimestamptzArray),
1092            Self::UuidArray(_) => Some(DataType::UuidArray),
1093            Self::JsonArray(_) => Some(DataType::JsonArray),
1094            Self::JsonbArray(_) => Some(DataType::JsonbArray),
1095            Self::BytesArray(_) => Some(DataType::BytesArray),
1096            Self::VarcharArray(_) => Some(DataType::VarcharArray),
1097            Self::CharArray(_) => Some(DataType::CharArray),
1098            Self::Multirange { kind, .. } => Some(DataType::Multirange(*kind)),
1099            Self::Point(_) => Some(DataType::Point),
1100            Self::Lseg(_, _) => Some(DataType::Lseg),
1101            Self::Path { .. } => Some(DataType::Path),
1102            Self::PgBox(_, _) => Some(DataType::PgBox),
1103            Self::Polygon(_) => Some(DataType::Polygon),
1104            Self::Line { .. } => Some(DataType::Line),
1105            Self::Circle { .. } => Some(DataType::Circle),
1106            Self::Inet { .. } => Some(DataType::Inet),
1107            Self::Cidr { .. } => Some(DataType::Cidr),
1108            Self::Macaddr(_) => Some(DataType::Macaddr),
1109            Self::Macaddr8(_) => Some(DataType::Macaddr8),
1110            Self::PgLsn(_) => Some(DataType::PgLsn),
1111            // BitString could be either Bit or BitVarying; column
1112            // schema decides. Default to BitVarying when called
1113            // schema-less (rare; storage path is always
1114            // schema-aware so this only matters for diagnostics).
1115            Self::BitString { .. } => Some(DataType::BitVarying(0)),
1116            Self::Xml(_) => Some(DataType::Xml),
1117            Self::Char1(_) => Some(DataType::Char1),
1118            // BpChar reports its declared width from the padded length.
1119            Self::BpChar(s) => Some(DataType::Char(
1120                u32::try_from(s.chars().count()).unwrap_or(0),
1121            )),
1122            Self::MoneyArray(_) => Some(DataType::MoneyArray),
1123            Self::TsVector(_) => Some(DataType::TsVector),
1124            Self::TsQuery(_) => Some(DataType::TsQuery),
1125            Self::Uuid(_) => Some(DataType::Uuid),
1126            Self::Time(_) => Some(DataType::Time),
1127            Self::Year(_) => Some(DataType::Year),
1128            Self::TimeTz { .. } => Some(DataType::TimeTz),
1129            Self::Money(_) => Some(DataType::Money),
1130            Self::Range { kind, .. } => Some(DataType::Range(*kind)),
1131            Self::Hstore(_) => Some(DataType::Hstore),
1132            Self::IntArray2D(_) => Some(DataType::IntArray2D),
1133            Self::BigIntArray2D(_) => Some(DataType::BigIntArray2D),
1134            Self::TextArray2D(_) => Some(DataType::TextArray2D),
1135            Self::BoolArray2D(_) => Some(DataType::BoolArray2D),
1136            // v7.38 (read01, T9) — a transient composite/record has no storable
1137            // column DataType (it flows through row_to_json / to_json).
1138            Self::Composite(_) => None,
1139            // v7.39 (read01 ruleutils.c) — regclass is eval-only (dual
1140            // oid+name shape); no column storage type.
1141            // v7.39 (round 640) — `xid` became a column type, so its value
1142            // has a DataType to answer with. `cid` and `tid` are equally
1143            // legal column types on PG (measured: `CREATE TABLE t (a cid,
1144            // b tid)` is accepted), but SPG's grammar has no keyword for
1145            // them yet; they stay eval-only rather than half-declared.
1146            Self::Xid(_) => Some(DataType::Xid),
1147            Self::RegClass(..)
1148            | Self::RegProc(..)
1149            | Self::RegType(..)
1150            | Self::Tid(..)
1151            | Self::Cid(_) => None,
1152            Self::Null => None,
1153        }
1154    }
1155
1156    pub const fn is_null(&self) -> bool {
1157        matches!(self, Self::Null)
1158    }
1159
1160    /// v7.37.42-arena Phase 1: lift any `Value<'arena>` (possibly
1161    /// borrowing from a bump arena) into a fully-owned `Value<'static>`.
1162    /// Used at boundaries that must outlive the per-query arena
1163    /// (catalog write, public QueryResult emit, sqlx materialise).
1164    ///
1165    /// For the recursive Range/Multirange variants — bounds are already
1166    /// `Box<Value<'static>>` per Phase 1 design, so we just rebuild the
1167    /// outer enum at `'static`.
1168    pub fn into_owned(self) -> Value<'static> {
1169        match self {
1170            Value::SmallInt(n) => Value::SmallInt(n),
1171            Value::Int(n) => Value::Int(n),
1172            Value::BigInt(n) => Value::BigInt(n),
1173            Value::Float(f) => Value::Float(f),
1174            Value::Real(f) => Value::Real(f),
1175            Value::Text(s) => Value::Text(Cow::Owned(s.into_owned())),
1176            Value::Bool(b) => Value::Bool(b),
1177            Value::Vector(v) => Value::Vector(Cow::Owned(v.into_owned())),
1178            Value::Sq8Vector(q) => Value::Sq8Vector(q),
1179            Value::HalfVector(h) => Value::HalfVector(h),
1180            Value::Numeric {
1181                scaled,
1182                scale,
1183                kind,
1184            } => Value::Numeric {
1185                scaled,
1186                scale,
1187                kind,
1188            },
1189            Value::NumericBig(b) => Value::NumericBig(b),
1190            Value::Date(d) => Value::Date(d),
1191            Value::Timestamp(t) => Value::Timestamp(t),
1192            Value::Interval {
1193                months,
1194                days,
1195                micros,
1196            } => Value::Interval {
1197                months,
1198                days,
1199                micros,
1200            },
1201            Value::Json(s) => Value::Json(Cow::Owned(s.into_owned())),
1202            Value::Bytes(b) => Value::Bytes(Cow::Owned(b.into_owned())),
1203            Value::TextArray(v) => Value::TextArray(v),
1204            Value::IntArray(v) => Value::IntArray(v),
1205            Value::BigIntArray(v) => Value::BigIntArray(v),
1206            Value::IntervalArray(v) => Value::IntervalArray(v),
1207            Value::BoolArray(v) => Value::BoolArray(v),
1208            Value::SmallIntArray(v) => Value::SmallIntArray(v),
1209            Value::FloatArray(v) => Value::FloatArray(v),
1210            Value::NumericArray(v) => Value::NumericArray(v),
1211            Value::DateArray(v) => Value::DateArray(v),
1212            Value::TimestampArray(v) => Value::TimestampArray(v),
1213            Value::TimestamptzArray(v) => Value::TimestamptzArray(v),
1214            Value::UuidArray(v) => Value::UuidArray(v),
1215            Value::JsonArray(v) => Value::JsonArray(v),
1216            Value::JsonbArray(v) => Value::JsonbArray(v),
1217            Value::BytesArray(v) => Value::BytesArray(v),
1218            Value::VarcharArray(v) => Value::VarcharArray(v),
1219            Value::CharArray(v) => Value::CharArray(v),
1220            Value::Multirange { kind, ranges } => Value::Multirange { kind, ranges },
1221            // v7.38 (read01, T9) — Composite fields are already `Value<'static>`.
1222            Value::Composite(fields) => Value::Composite(fields),
1223            Value::RegClass(oid, name) => Value::RegClass(oid, name),
1224            Value::Tid(b, o) => Value::Tid(b, o),
1225            Value::Xid(x) => Value::Xid(x),
1226            Value::Cid(c) => Value::Cid(c),
1227            Value::RegProc(oid, name) => Value::RegProc(oid, name),
1228            Value::RegType(oid, name) => Value::RegType(oid, name),
1229            Value::Point(p) => Value::Point(p),
1230            Value::Lseg(a, b) => Value::Lseg(a, b),
1231            Value::Path { points, closed } => Value::Path { points, closed },
1232            Value::PgBox(a, b) => Value::PgBox(a, b),
1233            Value::Polygon(p) => Value::Polygon(p),
1234            Value::Line { a, b, c } => Value::Line { a, b, c },
1235            Value::Circle { center, radius } => Value::Circle { center, radius },
1236            Value::Inet { family, bits, addr } => Value::Inet { family, bits, addr },
1237            Value::Cidr { family, bits, addr } => Value::Cidr { family, bits, addr },
1238            Value::Macaddr(m) => Value::Macaddr(m),
1239            Value::Macaddr8(m) => Value::Macaddr8(m),
1240            Value::PgLsn(l) => Value::PgLsn(l),
1241            Value::BitString { nbits, bytes } => Value::BitString {
1242                nbits,
1243                bytes: Cow::Owned(bytes.into_owned()),
1244            },
1245            Value::Xml(s) => Value::Xml(Cow::Owned(s.into_owned())),
1246            Value::Char1(c) => Value::Char1(c),
1247            Value::BpChar(s) => Value::BpChar(Cow::Owned(s.into_owned())),
1248            Value::MoneyArray(v) => Value::MoneyArray(v),
1249            Value::TsVector(v) => Value::TsVector(v),
1250            Value::TsQuery(q) => Value::TsQuery(q),
1251            Value::Uuid(u) => Value::Uuid(u),
1252            Value::Time(t) => Value::Time(t),
1253            Value::Year(y) => Value::Year(y),
1254            Value::TimeTz { us, offset_secs } => Value::TimeTz { us, offset_secs },
1255            Value::Money(m) => Value::Money(m),
1256            Value::Range {
1257                kind,
1258                lower,
1259                upper,
1260                lower_inc,
1261                upper_inc,
1262                empty,
1263            } => Value::Range {
1264                kind,
1265                lower,
1266                upper,
1267                lower_inc,
1268                upper_inc,
1269                empty,
1270            },
1271            Value::Hstore(h) => Value::Hstore(h),
1272            Value::IntArray2D(a) => Value::IntArray2D(a),
1273            Value::BigIntArray2D(a) => Value::BigIntArray2D(a),
1274            Value::TextArray2D(a) => Value::TextArray2D(a),
1275            Value::BoolArray2D(a) => Value::BoolArray2D(a),
1276            Value::Null => Value::Null,
1277        }
1278    }
1279
1280    /// v7.37.42-arena Phase 4 — copy heap payloads into the supplied
1281    /// bump arena, yielding a `Value<'a>` whose Cow-variant payloads
1282    /// are arena-borrowed (or stay as small owned scalars for the
1283    /// `Copy`-able variants).
1284    ///
1285    /// Used at the catalog ↔ ephemeral boundary: a `ColumnSchema.default`
1286    /// is `Value<'static>` but INSERT-time eval may want it stamped into
1287    /// the per-statement arena alongside other arena-built scalars.
1288    ///
1289    /// Allocates only into the supplied arena; the input `&self` keeps
1290    /// its own storage. For `Copy`-able / nested-owned variants the
1291    /// implementation falls back to `clone()` (the nested heap blocks
1292    /// stay on the global allocator, which is fine — the boundary
1293    /// requirement is just "no aliasing of caller-owned strings").
1294    pub fn clone_into<'a>(&self, arena: &'a bumpalo::Bump) -> Value<'a> {
1295        match self {
1296            Value::Text(s) => Value::Text(Cow::Borrowed(arena.alloc_str(s))),
1297            Value::Json(s) => Value::Json(Cow::Borrowed(arena.alloc_str(s))),
1298            Value::Xml(s) => Value::Xml(Cow::Borrowed(arena.alloc_str(s))),
1299            Value::BpChar(s) => Value::BpChar(Cow::Borrowed(arena.alloc_str(s))),
1300            Value::Bytes(b) => {
1301                let slot = arena.alloc_slice_copy::<u8>(b);
1302                Value::Bytes(Cow::Borrowed(slot))
1303            }
1304            Value::Vector(v) => {
1305                let slot = arena.alloc_slice_copy::<f32>(v);
1306                Value::Vector(Cow::Borrowed(slot))
1307            }
1308            Value::BitString { nbits, bytes } => {
1309                let slot = arena.alloc_slice_copy::<u8>(bytes);
1310                Value::BitString {
1311                    nbits: *nbits,
1312                    bytes: Cow::Borrowed(slot),
1313                }
1314            }
1315            // Copy-able scalars + variants whose nested heap blocks are
1316            // `'static` regardless of `'arena` (TextArray, JsonArray,
1317            // Hstore, TsVector, Range bounds, …). Clone the heap block
1318            // via the standard `into_owned()` path then lift the
1319            // resulting `Value<'static>` to `Value<'a>` via the Cow
1320            // variance — `'static` covers any lifetime.
1321            other => other.clone().into_owned(),
1322        }
1323    }
1324}
1325
1326impl Value<'static> {
1327    /// v7.37.42-arena Phase 1 — owned-Text constructor. The variant now
1328    /// holds `Cow<'arena, str>`, so the previous `Value::Text(String)`
1329    /// shape no longer compiles directly. This helper preserves the
1330    /// historical ergonomics: `Value::text("foo")` or
1331    /// `Value::text(String::from("foo"))`.
1332    pub fn text<S: Into<String>>(s: S) -> Self {
1333        Value::Text(Cow::Owned(s.into()))
1334    }
1335
1336    /// v7.38 (read01, T6) — a finite NUMERIC from its fixed-point parts.
1337    pub const fn numeric(scaled: i128, scale: u16) -> Self {
1338        Value::Numeric {
1339            scaled,
1340            scale,
1341            kind: NumericKind::Finite,
1342        }
1343    }
1344
1345    /// v7.38 (read01, T6) — a special NUMERIC (NaN / ±Infinity). The fixed-point
1346    /// fields are canonicalized to 0 so equal specials compare byte-identical.
1347    pub const fn numeric_special(kind: NumericKind) -> Self {
1348        Value::Numeric {
1349            scaled: 0,
1350            scale: 0,
1351            kind,
1352        }
1353    }
1354
1355    /// v7.37.42-arena Phase 1 — owned-Json constructor (mirrors `text`).
1356    pub fn json<S: Into<String>>(s: S) -> Self {
1357        Value::Json(Cow::Owned(s.into()))
1358    }
1359
1360    /// v7.37.42-arena Phase 1 — owned-Xml constructor.
1361    pub fn xml<S: Into<String>>(s: S) -> Self {
1362        Value::Xml(Cow::Owned(s.into()))
1363    }
1364
1365    /// v7.37.42-arena Phase 1 — owned-Bytes constructor.
1366    pub fn bytes<B: Into<Vec<u8>>>(b: B) -> Self {
1367        Value::Bytes(Cow::Owned(b.into()))
1368    }
1369
1370    /// v7.37.42-arena Phase 1 — owned-Vector constructor.
1371    pub fn vector<V: Into<Vec<f32>>>(v: V) -> Self {
1372        Value::Vector(Cow::Owned(v.into()))
1373    }
1374
1375    /// v7.37.42-arena Phase 1 — owned-BitString constructor.
1376    pub fn bit_string<B: Into<Vec<u8>>>(nbits: u32, bytes: B) -> Self {
1377        Value::BitString {
1378            nbits,
1379            bytes: Cow::Owned(bytes.into()),
1380        }
1381    }
1382}
1383
1384/// One table row — values are positional and must match
1385/// `TableSchema.columns` in length and (modulo NULL) in `DataType`.
1386///
1387/// v7.37.42-arena Phase 1: parameterised on `'arena` so per-query rows
1388/// can borrow from a bump arena. The owned shape (`Row<'static>`, alias
1389/// `RowOwned`) is what catalog storage, public APIs, and tests use.
1390#[derive(Debug, Clone, PartialEq)]
1391pub struct Row<'arena> {
1392    pub values: Vec<Value<'arena>>,
1393}
1394
1395/// Owned `Row` — values are `Value<'static>`. Used everywhere a row must
1396/// outlive a query-scoped arena.
1397pub type RowOwned = Row<'static>;
1398
1399impl<'arena> Row<'arena> {
1400    pub const fn new(values: Vec<Value<'arena>>) -> Self {
1401        Self { values }
1402    }
1403
1404    pub fn len(&self) -> usize {
1405        self.values.len()
1406    }
1407
1408    pub fn is_empty(&self) -> bool {
1409        self.values.is_empty()
1410    }
1411}
1412
1413impl<'arena> Row<'arena> {
1414    /// v7.37.42-arena Phase 4 — copy every cell into the supplied bump
1415    /// arena, yielding a `Row<'a>` whose Cow-payloads are arena-borrowed.
1416    /// Boundary helper for catalog defaults → DML eval handoff and
1417    /// arena-local row scratch.
1418    pub fn clone_into<'a>(&self, arena: &'a bumpalo::Bump) -> Row<'a> {
1419        Row {
1420            values: self.values.iter().map(|v| v.clone_into(arena)).collect(),
1421        }
1422    }
1423
1424    /// v7.37.42-arena Phase 4 — lift this `Row<'arena>` to a fully-owned
1425    /// `Row<'static>` for catalog write / WAL serialisation. Equivalent
1426    /// to `Row::from_arena(self)` but consumes by value at any lifetime
1427    /// (callers can write `row.into_owned()` mirroring `Value::into_owned`).
1428    pub fn into_owned(self) -> Row<'static> {
1429        Row {
1430            values: self.values.into_iter().map(Value::into_owned).collect(),
1431        }
1432    }
1433}
1434
1435impl Row<'static> {
1436    /// v7.37.42-arena Phase 1 — lift any `Row<'arena>` (possibly arena-
1437    /// borrowed) into a fully-owned `Row<'static>`. Mirrors
1438    /// `Value::into_owned`.
1439    pub fn from_arena(row: Row<'_>) -> Self {
1440        Self {
1441            values: row.values.into_iter().map(Value::into_owned).collect(),
1442        }
1443    }
1444}
1445
1446/// Each bool is an independent, separately-persisted column attribute
1447/// (`nullable`, `auto_increment`, `is_unsigned`, `identity_always`) that the
1448/// catalog appendix reads and writes by name. Packing them into a bitflags
1449/// word would buy nothing and would put a decoding step between the on-disk
1450/// format and every reader of the schema.
1451#[allow(clippy::struct_excessive_bools)]
1452#[derive(Debug, Clone, PartialEq)]
1453pub struct ColumnSchema {
1454    pub name: String,
1455    pub ty: DataType,
1456    pub nullable: bool,
1457    /// Optional `DEFAULT` value, frozen at CREATE TABLE time. `None`
1458    /// means "no default" (so omitted columns become NULL, or error
1459    /// out when the column is NOT NULL). Literal defaults take this
1460    /// path.
1461    ///
1462    /// v7.37.42-arena Phase 1: explicitly `Value<'static>` — catalog
1463    /// defaults must outlive any per-query arena.
1464    pub default: Option<Value<'static>>,
1465    /// v7.9.21 — for DEFAULT expressions that need INSERT-time
1466    /// evaluation (e.g. `DEFAULT now()`, `DEFAULT CURRENT_TIMESTAMP`),
1467    /// the Display form of the expression. The engine re-parses
1468    /// it on each INSERT default-fill, evaluates against an empty
1469    /// row context, and coerces to the column type. mailrs G4.
1470    /// Persisted in catalog FILE_VERSION 15+; older catalogs
1471    /// deserialise with None.
1472    pub runtime_default: Option<String>,
1473    /// MySQL-style `AUTO_INCREMENT`. When set, an INSERT that leaves
1474    /// this column unbound (or sets it to NULL) gets the next integer
1475    /// computed from the column's current max + 1.
1476    /// v7.39 (round 676) — the collation NAME as written, when the column
1477    /// carried an explicit `COLLATE`.
1478    ///
1479    /// `spg_sql::Collation` cannot carry it: it is a two-variant MySQL enum
1480    /// and `from_collation_name` folds `C`, `POSIX`, `en_US` and `default`
1481    /// all into `Binary`. Without the name `pg_attribute.attcollation` can
1482    /// only ever report the type's default, which is what F36 records as
1483    /// "the declaration is taken and ignored".
1484    ///
1485    /// None means the column was written without a `COLLATE` clause and
1486    /// takes its type's collation. Persisted through the v88 appendix,
1487    /// which costs two bytes for a table that declares none.
1488    pub collation_name: Option<String>,
1489    pub auto_increment: bool,
1490    /// v7.17.0 Phase 1.4 — when the column is bound to a user-
1491    /// defined ENUM type (the parser saw an unknown type ident
1492    /// and the engine resolved it against `catalog.enum_types`),
1493    /// this carries the enum name so INSERT/UPDATE can validate
1494    /// the cell value against the enum's labels. `ty` is
1495    /// `DataType::Text` in that case. Persisted in catalog
1496    /// FILE_VERSION 29+; older catalogs deserialise with None.
1497    pub user_enum_type: Option<String>,
1498    /// v7.17.0 Phase 1.5 — when the column is bound to a user-
1499    /// defined DOMAIN (the parser saw an unknown type ident and
1500    /// the engine resolved it against `catalog.domain_types`),
1501    /// this carries the domain name. `ty` is the domain's base
1502    /// type; INSERT/UPDATE re-evaluates the domain's CHECK list
1503    /// + NOT NULL against the cell value. Persisted in catalog
1504    /// FILE_VERSION 30+; older catalogs deserialise with None.
1505    pub user_domain_type: Option<String>,
1506    /// v7.39 (read01 round 56) — when the column is bound to a user-defined
1507    /// COMPOSITE type. `ty` stays `DataType::Jsonb` (the on-disk form), but the
1508    /// engine REHYDRATES the stored JSON into a `Value::Composite` on read, so
1509    /// field access `(p).x`, `= ROW(…)`, ordering and the canonical `(2,b)`
1510    /// text form all work — they were already implemented on Value::Composite;
1511    /// what was missing was that the column never recorded WHICH composite type
1512    /// it holds (this field's doc comment existed for two releases, the field
1513    /// itself did not). Persisted in the composite-column appendix
1514    /// (FILE_VERSION 63+); older catalogs deserialise with None.
1515    pub user_composite_type: Option<String>,
1516    /// v7.39 (read01 round 59) — column-level privileges (PG
1517    /// `pg_attribute.attacl`). `GRANT SELECT (pub) ON t TO dan` lands here and
1518    /// does NOT touch the table's `relacl`. Empty = no column grant, which is
1519    /// every column until one is made.
1520    pub acl: Vec<AclItem>,
1521    /// v7.17.0 Phase 2.1 — MySQL `ON UPDATE CURRENT_TIMESTAMP`
1522    /// column attribute. When `Some(expr_src)`, an UPDATE that
1523    /// does NOT bind this column overrides the new value with
1524    /// the engine-evaluated expression (always `now()` in
1525    /// v7.17.0). Stored as Display-form source so storage
1526    /// stays free of spg-sql; the engine re-parses at UPDATE
1527    /// time. Persisted in catalog FILE_VERSION 32+; older
1528    /// catalogs deserialise with None — preserves the existing
1529    /// "silent ignore" behaviour for snapshots written before
1530    /// the upgrade.
1531    pub on_update_runtime: Option<String>,
1532    /// v7.17.0 Phase 2.5 — text collation. Pre-2.5 SPG accepted
1533    /// `COLLATE <name>` clauses but discarded the name, so a
1534    /// column declared `COLLATE "case_insensitive"` (or any
1535    /// MySQL `_ci` collation) still compared byte-wise — a
1536    /// Tier-S silent failure where `WHERE name = 'foo'` never
1537    /// matched stored `'Foo'`. This carries the parser-derived
1538    /// classification so the engine's WHERE evaluator can route
1539    /// text equality through a case-aware compare. `Binary` (the
1540    /// default) preserves the prior byte-wise behaviour. Only
1541    /// CaseInsensitive lands in the catalog appendix — Binary
1542    /// columns stay implicit, keeping snapshots compact.
1543    /// Persisted in catalog FILE_VERSION 34+; older catalogs
1544    /// deserialise every column as `Binary`.
1545    pub collation: Collation,
1546    /// v7.17.0 Phase 4.4 — MySQL `UNSIGNED` modifier flag. Drives
1547    /// engine-side INSERT / UPDATE range enforcement (rejects
1548    /// negative values on UNSIGNED int columns). Pre-4.4 the
1549    /// parser consumed and discarded the keyword silently, so
1550    /// every UNSIGNED column quietly accepted negatives — a
1551    /// Tier-A correctness drift. Sparse: only UNSIGNED columns
1552    /// land in the catalog appendix; the default `false` keeps
1553    /// snapshots compact for the common signed-int path.
1554    /// Persisted in catalog FILE_VERSION 35+; older catalogs
1555    /// deserialise every column as `is_unsigned = false`.
1556    pub is_unsigned: bool,
1557    /// v7.17.0 Phase 3.P0-36 — MySQL inline `ENUM('a','b','c')`
1558    /// value list. Distinct from `user_enum_type` (which points
1559    /// to a separately CREATE TYPE'd PG enum); this carries the
1560    /// column-local list MySQL DDL declares inline. When `Some`,
1561    /// `ty` is `DataType::Text` and INSERT/UPDATE validates the
1562    /// cell value against this list. Variant ORDER is preserved
1563    /// (MySQL uses it for `ORDER BY col`). Sparse: only ENUM
1564    /// columns land in the catalog appendix.
1565    /// Persisted in catalog FILE_VERSION 41+; older catalogs
1566    /// deserialise with None — preserves silent-drop behaviour
1567    /// for snapshots written before P0-36.
1568    pub inline_enum_variants: Option<Vec<String>>,
1569    /// v7.17.0 Phase 3.P0-37 — MySQL inline `SET('a','b','c')`
1570    /// variant list. Storage is TEXT (canonical comma-joined in
1571    /// definition order, de-duplicated). INSERT/UPDATE validates
1572    /// every comma-separated token against this list. Sparse:
1573    /// only SET columns land in the catalog appendix.
1574    /// Persisted in catalog FILE_VERSION 42+; older catalogs
1575    /// deserialise with None.
1576    pub inline_set_variants: Option<Vec<String>>,
1577    /// v7.37.7(sentori Epic 3 P1)— `GENERATED ALWAYS AS (<expr>)
1578    /// STORED` computed-column source. When `Some`, INSERT / UPDATE
1579    /// recompute the cell against the candidate row(re-parse the
1580    /// stored Display form and evaluate)and overwrite any
1581    /// user-supplied value, matching PG's stored-generated-column
1582    /// semantics. `None` (the default) preserves the regular
1583    /// "column value is whatever the caller passed" path.
1584    /// Persisted in catalog FILE_VERSION 50+; older catalogs
1585    /// deserialise with None.
1586    pub generated_stored_expr: Option<String>,
1587    /// v7.38 (read01) — `GENERATED ALWAYS AS IDENTITY`. Both identity
1588    /// flavours set `auto_increment`; this additionally marks the ALWAYS
1589    /// flavour, whose explicit INSERT value PG rejects ("cannot insert a
1590    /// non-DEFAULT value into column …") unless `OVERRIDING SYSTEM VALUE`.
1591    /// `false` (serial / `BY DEFAULT`) keeps the permissive path. In-memory
1592    /// only for now — not yet in the catalog appendix, so a reloaded table
1593    /// deserialises as `false` (the pre-existing permissive behaviour).
1594    pub identity_always: bool,
1595    /// v7.38 (read01) — the DEFAULT expression's source text, deparsed to
1596    /// PG-compatible form at CREATE TABLE time (e.g. `0`, `(3 + 4)`,
1597    /// `'hi'::text`, `now()`, `CURRENT_DATE`). Distinct from `default`
1598    /// (the coerced value the INSERT path fills) and `runtime_default`
1599    /// (the recompute-per-row Display form): those lose the source
1600    /// spelling, so `information_schema.columns.column_default` /
1601    /// `pg_attrdef` / `pg_get_expr` reported the coerced render
1602    /// (`0.00` for `numeric(10,2) DEFAULT 0`) instead of PG's `0`.
1603    /// `None` for a column with no explicit default. Persisted in catalog
1604    /// FILE_VERSION 58+; older catalogs deserialise with None.
1605    pub default_text: Option<String>,
1606    /// v7.39 (round 220) — `ALTER TABLE … ALTER COLUMN … RESTART [WITH n]`
1607    /// on an identity column. SPG's identity allocation is a max+1 scan;
1608    /// this floor lifts the next allocated value to at least `n`
1609    /// (`max(max+1, n)`) — exactly what a dump-restore RESTART needs, and
1610    /// safer than PG for a backward RESTART (no duplicate-key landmine).
1611    /// Persisted in the FILE_VERSION 73+ sparse appendix; older catalogs
1612    /// deserialise with None.
1613    pub auto_restart: Option<i64>,
1614    /// v7.39 (read01 round 78) — this column is the ONLY column of a FROM item
1615    /// that calls a function returning a BASE type, so the item's row type IS
1616    /// this column: a whole-row reference collapses to the value
1617    /// (`SELECT j FROM jsonb_array_elements('[1]') AS j` → `1`, PG). Runtime
1618    /// only — a catalogued table column is never one, and it is not persisted.
1619    pub scalar_row_source: bool,
1620    /// v7.39 (round 386, type-fidelity epic P1) — the declared MySQL narrow
1621    /// integer width (TINYINT / MEDIUMINT) whose range the storage `ty`
1622    /// (SmallInt / Int) is too wide to enforce. `None` for every other
1623    /// column. Drives the epic-P2 write-path range check. Persisted in the
1624    /// FILE_VERSION 81+ sparse appendix; older catalogs deserialise as None.
1625    pub mysql_int_width: Option<MysqlIntWidth>,
1626    /// v7.39 (round 424, type-fidelity epic) — the declared MySQL
1627    /// fractional-seconds precision of a temporal column: `DATETIME(3)` is
1628    /// `Some(3)`, a BARE `DATETIME` / `TIME` / `TIMESTAMP` is `Some(0)`
1629    /// (MySQL's default is zero — the fraction is dropped on write), and
1630    /// `None` means "not a MySQL-declared temporal column", which is every
1631    /// PG column and leaves microsecond behaviour untouched.
1632    ///
1633    /// Drives write-path truncation (toward zero) and render padding
1634    /// (exactly this many digits, `.000` when the fraction is zero).
1635    /// Persisted in the FILE_VERSION 82+ sparse appendix; older catalogs
1636    /// deserialise as None.
1637    pub mysql_fsp: Option<u8>,
1638}
1639
1640/// v7.17.0 Phase 2.5 — column-level text collation. Drives the
1641/// engine's WHERE / GROUP BY equality routing for `Value::Text`.
1642/// Only two variants are modelled in v7.17:
1643///   * `Binary`  — byte-wise comparison (the SPG default;
1644///                 matches PG `COLLATE "C"` / `pg_catalog.default`
1645///                 and MySQL `*_bin`).
1646///   * `CaseInsensitive` — ASCII case-folded comparison (like
1647///                 MySQL `*_ci` collations; PG has NO built-in
1648///                 collation of this name — round-761 audit: a
1649///                 nondeterministic ICU collation must be CREATEd
1650///                 there first). Non-ASCII bytes
1651///                 still compare byte-wise; full ICU folding is
1652///                 out of v7.17 scope.
1653/// New variants append at the end — older catalogs read missing
1654/// columns as `Binary`.
1655#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1656pub enum Collation {
1657    Binary,
1658    CaseInsensitive,
1659}
1660
1661/// v7.39 (round 386, type-fidelity epic P1) — the declared MySQL narrow
1662/// integer type for a column whose storage `DataType` cannot express it.
1663/// MySQL `TINYINT` (i8, -128..127) collapses to `DataType::SmallInt` (i16)
1664/// and `MEDIUMINT` (24-bit) to `DataType::Int` (i32) — both wider than the
1665/// declared type, so a range check against `ty` alone accepts out-of-range
1666/// values (`INSERT 128 INTO TINYINT` is stored silently where MariaDB
1667/// strict raises ERROR 1264). This annotation records the lost width so the
1668/// write path (epic P2) can enforce the real bounds. `SMALLINT` / `INT` /
1669/// `BIGINT` need no marker — their storage `DataType` is already faithful.
1670/// Sparse: only TINYINT / MEDIUMINT columns carry it; persisted in the
1671/// FILE_VERSION 81+ appendix, older catalogs deserialise as None.
1672#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1673pub enum MysqlIntWidth {
1674    /// MySQL `TINYINT` — signed -128..127, unsigned 0..255. Storage i16.
1675    Tiny,
1676    /// MySQL `SMALLINT UNSIGNED` — 0..65535. Storage widened to i32 (a
1677    /// signed SMALLINT keeps `DataType::SmallInt` and carries no marker).
1678    Small,
1679    /// MySQL `MEDIUMINT` — signed -8388608..8388607, unsigned 0..16777215.
1680    /// Storage i32.
1681    Medium,
1682    /// MySQL `INT UNSIGNED` — 0..4294967295. Storage widened to i64 (a
1683    /// signed INT keeps `DataType::Int` and carries no marker).
1684    Int,
1685    /// v7.39 (round 471, epic P4b) — MySQL `BIGINT UNSIGNED` —
1686    /// 0..18446744073709551615. i64 stops at 2^63-1, so the storage tag is
1687    /// widened to `Numeric` (i128-backed, scale 0), which already compares,
1688    /// orders, indexes and renders as an exact integer. A signed BIGINT
1689    /// keeps `DataType::BigInt` and carries no marker.
1690    Big,
1691}
1692
1693/// v7.39 (round 363, M4 P1) — MySQL's default accent- and
1694/// case-insensitive fold (`utf8mb4_uca1400_ai_ci`).
1695///
1696/// This is the primitive M4 rests on: a session on the MySQL dialect
1697/// compares, groups, sorts and de-duplicates text by its FOLDED form, so
1698/// `Foo` = `foo` = `FOO` and, because the default collation is accent-
1699/// insensitive too, `Bär` = `bar`. The later stages (read path, then the
1700/// UNIQUE / index write path) all route through here so they cannot fold
1701/// differently from one another.
1702///
1703/// The fold is more than case + strip-combining: MariaDB EXPANDS some
1704/// letters — `ß` → `ss`, `æ` → `ae`, `œ` → `oe` — which is why the result
1705/// is built as a `String` rather than mapped char-for-char. Every mapping
1706/// below was measured on MariaDB 11 (`'Bär'='bar'` is 1, `'straße'=
1707/// 'strasse'` is 1, `'a'='æ'` is 0, `'s'='ß'` is 0). Characters with no
1708/// entry keep their lower-cased self, so ASCII and unknown scripts pass
1709/// through unchanged.
1710#[must_use]
1711pub fn mysql_ci_fold(s: &str) -> String {
1712    let mut out = String::with_capacity(s.len());
1713    for ch in s.chars() {
1714        // Lower-case first (`À` → `à`, `Æ` → `æ`), then fold the base.
1715        for lc in ch.to_lowercase() {
1716            match fold_latin_base(lc) {
1717                Some(base) => out.push_str(base),
1718                None => out.push(lc),
1719            }
1720        }
1721    }
1722    out
1723}
1724
1725/// v7.39 (round 375) — the fold used to COMPARE / GROUP / de-dup text on
1726/// the MySQL dialect. Its default collation is PAD SPACE: trailing spaces
1727/// do not affect a comparison (`'a' = 'a '`, `'' = ' '`, measured on
1728/// MariaDB 11), so they are stripped before the case/accent fold. Only
1729/// literal spaces pad — a tab or other whitespace is significant — and
1730/// this is NOT used by `LIKE`, whose pattern treats a trailing space
1731/// literally.
1732pub fn mysql_compare_fold(s: &str) -> String {
1733    mysql_ci_fold(s.trim_end_matches(' '))
1734}
1735
1736/// The base letter(s) a lower-cased Latin character folds to, or `None`
1737/// when it is already a base / has no fold. Expansions (`ß` → `ss`) are
1738/// why this returns a string.
1739fn fold_latin_base(c: char) -> Option<&'static str> {
1740    Some(match c {
1741        'à' | 'á' | 'â' | 'ã' | 'ä' | 'å' | 'ā' | 'ă' | 'ą' => "a",
1742        'æ' => "ae",
1743        'ç' | 'ć' | 'č' | 'ĉ' | 'ċ' => "c",
1744        'ð' | 'ď' | 'đ' => "d",
1745        'è' | 'é' | 'ê' | 'ë' | 'ē' | 'ĕ' | 'ė' | 'ę' | 'ě' => "e",
1746        'ĝ' | 'ğ' | 'ġ' | 'ģ' => "g",
1747        'ì' | 'í' | 'î' | 'ï' | 'ĩ' | 'ī' | 'ĭ' | 'į' => "i",
1748        'ĵ' => "j",
1749        'ķ' => "k",
1750        'ł' | 'ĺ' | 'ļ' | 'ľ' => "l",
1751        'ñ' | 'ń' | 'ņ' | 'ň' => "n",
1752        'ò' | 'ó' | 'ô' | 'õ' | 'ö' | 'ø' | 'ō' | 'ŏ' | 'ő' => "o",
1753        'œ' => "oe",
1754        'ŕ' | 'ŗ' | 'ř' => "r",
1755        'ś' | 'š' | 'ŝ' | 'ş' => "s",
1756        'ß' => "ss",
1757        'ţ' | 'ť' | 'ŧ' => "t",
1758        'ù' | 'ú' | 'û' | 'ü' | 'ũ' | 'ū' | 'ŭ' | 'ů' | 'ű' | 'ų' => "u",
1759        'ý' | 'ÿ' => "y",
1760        'ź' | 'ž' | 'ż' => "z",
1761        _ => return None,
1762    })
1763}
1764
1765#[allow(clippy::derivable_impls)]
1766impl Default for Collation {
1767    fn default() -> Self {
1768        Self::Binary
1769    }
1770}
1771
1772impl Collation {
1773    /// Wire tag persisted in the FILE_VERSION 34+ catalog appendix.
1774    /// Stable: future variants append above the recognised range
1775    /// and unknown tags read back as `Binary` for forward-compat
1776    /// on rollback.
1777    pub const TAG_BINARY: u8 = 0;
1778    pub const TAG_CASE_INSENSITIVE: u8 = 1;
1779}
1780
1781/// v7.39 (RLS) — the command a policy applies to. `ALL` is the default and
1782/// covers every command; the others scope the policy to one statement kind.
1783/// Persisted as a single byte in the policy appendix (FILE_VERSION 59+).
1784#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1785pub enum PolicyCmd {
1786    All,
1787    Select,
1788    Insert,
1789    Update,
1790    Delete,
1791}
1792
1793impl PolicyCmd {
1794    /// PG `pg_policy.polcmd` single-char encoding.
1795    #[must_use]
1796    pub const fn as_pg_char(self) -> char {
1797        match self {
1798            Self::All => '*',
1799            Self::Select => 'r',
1800            Self::Insert => 'a',
1801            Self::Update => 'w',
1802            Self::Delete => 'd',
1803        }
1804    }
1805
1806    /// PG `pg_policies.cmd` word form.
1807    #[must_use]
1808    pub const fn as_pg_word(self) -> &'static str {
1809        match self {
1810            Self::All => "ALL",
1811            Self::Select => "SELECT",
1812            Self::Insert => "INSERT",
1813            Self::Update => "UPDATE",
1814            Self::Delete => "DELETE",
1815        }
1816    }
1817
1818    #[must_use]
1819    pub const fn to_wire_byte(self) -> u8 {
1820        match self {
1821            Self::All => 0,
1822            Self::Select => 1,
1823            Self::Insert => 2,
1824            Self::Update => 3,
1825            Self::Delete => 4,
1826        }
1827    }
1828
1829    #[must_use]
1830    pub const fn from_wire_byte(b: u8) -> Option<Self> {
1831        match b {
1832            0 => Some(Self::All),
1833            1 => Some(Self::Select),
1834            2 => Some(Self::Insert),
1835            3 => Some(Self::Update),
1836            4 => Some(Self::Delete),
1837            _ => None,
1838        }
1839    }
1840}
1841
1842/// v7.39 (RLS) — one `CREATE POLICY` object, stored per table. The `using_expr`
1843/// / `with_check_expr` hold the qualifying expression's `Display` form
1844/// (re-parsed and evaluated per row at enforcement time, exactly like
1845/// `TableSchema.checks`); `None` means the clause was absent. `roles` empty =
1846/// PUBLIC. Persisted in the policy appendix (FILE_VERSION 59+).
1847#[derive(Debug, Clone, PartialEq)]
1848pub struct PolicyDef {
1849    pub name: String,
1850    pub cmd: PolicyCmd,
1851    /// `true` = PERMISSIVE (default, OR-combined), `false` = RESTRICTIVE
1852    /// (AND-combined).
1853    pub permissive: bool,
1854    pub roles: Vec<String>,
1855    pub using_expr: Option<String>,
1856    pub with_check_expr: Option<String>,
1857}
1858
1859#[derive(Debug, Clone, PartialEq)]
1860pub struct TableSchema {
1861    pub name: String,
1862    pub columns: Vec<ColumnSchema>,
1863    /// v6.7.2 — per-table hot-tier byte budget override. `None`
1864    /// falls through to the global `SPG_HOT_TIER_BYTES` setting;
1865    /// `Some(n)` overrides it for this specific table. Set via
1866    /// `ALTER TABLE t SET hot_tier_bytes = X`. Persisted in
1867    /// catalog FILE_VERSION 11+.
1868    pub hot_tier_bytes: Option<u64>,
1869    /// v7.6.1 — FOREIGN KEY constraints declared on this table.
1870    /// Engine maintains this in lock-step with `spg-sql`'s parser
1871    /// AST; the storage layer carries the on-disk shape so a
1872    /// catalog snapshot round-trips without external mapping.
1873    /// Persisted in catalog FILE_VERSION 13+. Older catalogs
1874    /// deserialise with an empty vec.
1875    pub foreign_keys: Vec<ForeignKeyConstraint>,
1876    /// v7.9.19 — composite UNIQUE / PRIMARY KEY constraints
1877    /// declared at the table level. Each entry's leading column
1878    /// has a BTree index (created via the constraint), and INSERT
1879    /// path enforces the full-tuple uniqueness via a scan keyed
1880    /// by the leading column. Persisted in catalog FILE_VERSION
1881    /// 15+. Older catalogs (≤ 14) deserialise with an empty vec.
1882    pub uniqueness_constraints: Vec<UniquenessConstraint>,
1883    /// v7.39 (round 210) — `EXCLUDE` constraints declared at the table level.
1884    /// Enforced on INSERT/UPDATE by a full live-row scan re-checking each
1885    /// element's operator (no equality index can answer overlap). Persisted
1886    /// in catalog FILE_VERSION 72+; older catalogs deserialise with an empty
1887    /// vec.
1888    pub exclusion_constraints: Vec<ExclusionConstraint>,
1889    /// v7.13.0 — `CHECK (<expr>)` predicates declared on this
1890    /// table. Both column-level inline `CHECK (…)` and
1891    /// table-level `CHECK (…)` fold into this list. Each entry
1892    /// is the AST Expr's `Display` form, re-parsed on every
1893    /// INSERT/UPDATE and evaluated against the candidate row.
1894    /// A false / NULL result rejects the mutation (PG semantics).
1895    /// Persisted in catalog FILE_VERSION 23+. Older catalogs
1896    /// deserialise with an empty vec. v7.39 (read01 round 48) — each entry
1897    /// now carries the user's constraint name too (FILE_VERSION 60+).
1898    pub checks: Vec<CheckConstraint>,
1899    /// v7.37.6-B — declarative partition role(sentori Epic 2 P0).
1900    /// `None` = 普通表(后向兼容,< v49 catalog 默认 None)。
1901    /// `Some(Parent { … })` = `CREATE TABLE p (...) PARTITION BY RANGE (key_col)` 父表 —
1902    /// 父表自己 `rows` 永远空,INSERT 在引擎层路由到命中的 child。
1903    /// `Some(Range { … })` = `CREATE TABLE c PARTITION OF p FOR VALUES FROM (a) TO (b)` 范围子表。
1904    /// `Some(Default { … })` = `CREATE TABLE c PARTITION OF p DEFAULT` 兜底子表。
1905    /// 持久化于 FILE_VERSION 49+。
1906    pub partition_role: Option<PartitionRole>,
1907    /// v7.39 (RLS) — `CREATE POLICY` objects on this table, independent of the
1908    /// `row_security` flag (PG stores policies even on non-RLS tables; they
1909    /// only take effect once RLS is enabled). Persisted in the policy appendix
1910    /// (FILE_VERSION 59+). Older catalogs deserialise with an empty vec.
1911    pub policies: Vec<PolicyDef>,
1912    /// v7.39 (RLS) — `ALTER TABLE … ENABLE ROW LEVEL SECURITY`
1913    /// (PG `pg_class.relrowsecurity`). Fresh table = `false`.
1914    pub row_security: bool,
1915    /// v7.39 (RLS) — `ALTER TABLE … FORCE ROW LEVEL SECURITY`
1916    /// (PG `pg_class.relforcerowsecurity`); subjects the table owner to RLS
1917    /// too. Fresh table = `false`.
1918    pub force_row_security: bool,
1919    /// v7.39 (read01 round 57, ACL) — the role that owns this table: whoever
1920    /// ran CREATE TABLE (PG `pg_class.relowner`). The owner holds every
1921    /// privilege implicitly and is the only role that may ALTER / DROP it.
1922    /// `None` = an image written before FILE_VERSION 64, which predates roles
1923    /// entirely; those tables read back as owned by the login role.
1924    pub owner: Option<String>,
1925    /// v7.39 (read01 round 57, ACL) — explicit GRANTs on this table
1926    /// (PG `pg_class.relacl`). EMPTY means "never granted": PG leaves relacl
1927    /// NULL while only the owner's implicit privileges apply, and materialises
1928    /// the whole list — owner's default entry included — on the first GRANT.
1929    /// Once materialised it stays, even after every grant is revoked.
1930    pub acl: Vec<AclItem>,
1931}
1932
1933/// v7.39 (read01 round 57) — one PG `aclitem`: what `grantee` may do to a
1934/// table, and who granted it. Renders as `grantee=privs/grantor`, with an
1935/// EMPTY grantee meaning PUBLIC (`=r/owner`).
1936#[derive(Debug, Clone, PartialEq, Eq)]
1937pub struct AclItem {
1938    /// The role the privileges are held by. Empty string = PUBLIC.
1939    pub grantee: String,
1940    /// Bitmask over `priv_bits`: which privileges are held.
1941    pub privs: u16,
1942    /// Bitmask over `priv_bits`: which of them carry WITH GRANT OPTION
1943    /// (PG renders those with a trailing `*` — `r*`).
1944    pub grantable: u16,
1945    /// The role that ran the GRANT.
1946    pub grantor: String,
1947}
1948
1949/// v7.39 (read01 round 57) — the table-privilege bits, in PG's `aclitem`
1950/// rendering order (`arwdDxtm`). The order matters: `relacl` output is
1951/// byte-compared against PG.
1952pub mod priv_bits {
1953    pub const INSERT: u16 = 1 << 0; // a
1954    pub const SELECT: u16 = 1 << 1; // r
1955    pub const UPDATE: u16 = 1 << 2; // w
1956    pub const DELETE: u16 = 1 << 3; // d
1957    pub const TRUNCATE: u16 = 1 << 4; // D
1958    pub const REFERENCES: u16 = 1 << 5; // x
1959    pub const TRIGGER: u16 = 1 << 6; // t
1960    pub const MAINTAIN: u16 = 1 << 7; // m
1961    /// v7.39 (read01 round 60) — the non-table privileges. They share the
1962    /// bitmask because an aclitem is an aclitem whatever it hangs off; which
1963    /// bits are MEANINGFUL depends on the object (a sequence has r / w / U, a
1964    /// schema has U / C, a database has C / c / T).
1965    pub const USAGE: u16 = 1 << 8; // U
1966    pub const CREATE: u16 = 1 << 9; // C
1967    pub const CONNECT: u16 = 1 << 10; // c
1968    pub const TEMPORARY: u16 = 1 << 11; // T
1969    pub const EXECUTE: u16 = 1 << 12; // X
1970    /// Every TABLE privilege — what `GRANT ALL ON <table>` grants and what a
1971    /// table's owner holds.
1972    pub const ALL: u16 =
1973        INSERT | SELECT | UPDATE | DELETE | TRUNCATE | REFERENCES | TRIGGER | MAINTAIN;
1974    /// `GRANT ALL ON SEQUENCE` — PG renders a sequence owner's default as `rwU`.
1975    pub const ALL_SEQUENCE: u16 = SELECT | UPDATE | USAGE;
1976    /// `GRANT ALL ON SCHEMA` — `UC`.
1977    pub const ALL_SCHEMA: u16 = USAGE | CREATE;
1978    /// `GRANT ALL ON DATABASE` — `CTc`.
1979    pub const ALL_DATABASE: u16 = CREATE | CONNECT | TEMPORARY;
1980    /// `GRANT ALL ON FUNCTION` — just `X`.
1981    pub const ALL_FUNCTION: u16 = EXECUTE;
1982}
1983
1984/// v7.37.6-B — partition 三态(parent / range child / default child)。
1985#[derive(Debug, Clone, PartialEq, Eq)]
1986pub enum PartitionRole {
1987    Parent {
1988        kind: PartitionKind,
1989        /// 父表 columns 中 key 列的下标(单列 v7.37.6-B,
1990        /// `Vec` 为将来扩多列预留)。
1991        key_column_positions: Vec<usize>,
1992        /// `CREATE INDEX ON parent (…)` 的 Display-form 源串。
1993        /// child 创建时再 parse + 在 child 上 execute,这样 future
1994        /// child 也自动继承父表索引。fan-out 实施在引擎层。
1995        index_template_sources: Vec<String>,
1996    },
1997    Range {
1998        parent_name: String,
1999        /// 半开区间下界(`>=`,SQL `FROM (lower)`).
2000        lower: PartitionBound,
2001        /// 半开区间上界(`<`,SQL `TO (upper)`).
2002        upper: PartitionBound,
2003    },
2004    /// v7.37.16 (16.1) — LIST child:行属于本 child iff key ∈ values。
2005    /// `values` 在 child 创建时从 SQL `FOR VALUES IN (lit, …)` 求值;
2006    /// 跟 PG 一样,显式 NULL ∈ values 由 caller 单独处理(不在
2007    /// PartitionBound 内表达 NULL)。
2008    List {
2009        parent_name: String,
2010        values: Vec<PartitionBound>,
2011    },
2012    /// v7.39 (round 645) — PG 表继承的 CHILD:`CREATE TABLE c (…)
2013    /// INHERITS (p1, p2)`。跟分区 child 的三个本质区别(实测 PG18):
2014    ///   * 父表**自己有行**(分区父表永远空),所以父表的联合体要含自身;
2015    ///   * `INSERT INTO 父表` **不路由**到 child(分区会路由);
2016    ///   * `DROP TABLE 父表` 不带 CASCADE **报错**(分区父表连子表一起删)。
2017    /// 多父继承合法,故 `parent_names` 是 Vec;`pg_inherits.inhseqno`
2018    /// 正是父表在这个列表里的位置(1-based)。
2019    Inherits {
2020        parent_names: Vec<String>,
2021    },
2022    /// v7.37.16 (16.2) — HASH child:行属于本 child iff
2023    /// `pg_compatible_hash(key) mod modulus == remainder`。
2024    /// PG 强制 `0 ≤ remainder < modulus`;parser/DDL 层先 gate。
2025    Hash {
2026        parent_name: String,
2027        modulus: u32,
2028        remainder: u32,
2029    },
2030    Default {
2031        parent_name: String,
2032    },
2033}
2034
2035/// v7.37.6-B — 分区策略。
2036///
2037/// - `Range`:半开区间 `[lower, upper)`(v7.37.6-B 初始)
2038/// - `List` (v7.37.16):枚举集合 — 行属于 partition iff key ∈ children list
2039/// - `Hash` (v7.37.16):`hash(key) mod modulus == remainder`
2040#[derive(Debug, Clone, Copy, PartialEq, Eq)]
2041pub enum PartitionKind {
2042    Range,
2043    List,
2044    Hash,
2045}
2046
2047/// v7.37.6-B — partition 边界 literal。
2048///
2049/// v7.37.6-B 仅 `TimestampTz`(i64 microseconds since epoch);
2050/// v7.37.16 (16.6) 加全 PG 内建可比类型,匹配 `Value` 的对应 variant
2051/// 以避免 LIST membership 比较时的类型转换。
2052///
2053/// `MinValue` / `MaxValue` 对应 SQL `MINVALUE` / `MAXVALUE`,仅
2054/// Range 策略有意义(LIST 无 minvalue/maxvalue 概念,HASH 不
2055/// 使用 PartitionBound)。
2056#[derive(Debug, Clone, PartialEq, Eq)]
2057pub enum PartitionBound {
2058    MinValue,
2059    MaxValue,
2060    TimestampTz(i64),
2061    /// v7.37.16 (16.6) — BIGINT partition key.
2062    BigInt(i64),
2063    /// v7.37.16 (16.6) — INTEGER partition key (also covers
2064    /// `SERIAL` since SPG decomposes it to INTEGER + sequence).
2065    Int(i32),
2066    /// v7.37.16 (16.6) — SMALLINT partition key.
2067    SmallInt(i16),
2068    /// v7.37.16 (16.6) — DATE partition key. Stored as days
2069    /// since the Unix epoch (matches `Value::Date`).
2070    Date(i32),
2071    /// v7.37.16 (16.6) — TEXT / VARCHAR partition key.
2072    Text(alloc::string::String),
2073}
2074
2075impl PartitionBound {
2076    /// v7.37.16 (16.6) — true iff this bound's underlying value
2077    /// equals `other`'s. Used for LIST partition membership
2078    /// checks. Returns false for `MinValue` / `MaxValue`
2079    /// (sentinels — never literal equality).
2080    #[must_use]
2081    pub fn equals_value(&self, other: &Value<'_>) -> bool {
2082        match (self, other) {
2083            (PartitionBound::TimestampTz(a), Value::Timestamp(b)) => a == b,
2084            (PartitionBound::BigInt(a), Value::BigInt(b)) => a == b,
2085            (PartitionBound::Int(a), Value::Int(b)) => a == b,
2086            (PartitionBound::SmallInt(a), Value::SmallInt(b)) => a == b,
2087            (PartitionBound::Date(a), Value::Date(b)) => a == b,
2088            (PartitionBound::Text(a), Value::Text(b)) => a.as_str() == b.as_ref(),
2089            _ => false,
2090        }
2091    }
2092}
2093
2094/// v7.9.19 — composite UNIQUE / PRIMARY KEY constraint persisted
2095/// on the table schema. The leading column always has a BTree
2096/// index (created at CREATE TABLE time); INSERT enforcement
2097/// scans that index for collisions on the full column tuple.
2098/// v7.39 (read01 round 48) — a `CHECK` constraint: the SQL name the user
2099/// gave it (via `ADD CONSTRAINT <name> CHECK (...)` or the inline
2100/// `CONSTRAINT <name> CHECK (...)` form) plus the predicate source. `None`
2101/// name = unnamed, in which case `pg_constraint` synthesises PG's
2102/// `<table>_<col>_check` form. Names are persisted in the constraint-name
2103/// appendix (FILE_VERSION 60+); older catalogs deserialise with `None`.
2104#[derive(Debug, Clone, PartialEq, Eq)]
2105pub struct CheckConstraint {
2106    pub name: Option<String>,
2107    /// The AST Expr's `Display` form, re-parsed on every INSERT/UPDATE.
2108    pub expr: String,
2109    /// v7.39 (round 652) — `false` for a constraint added `NOT VALID`: the
2110    /// rows already in the table were never scanned against it, and
2111    /// `pg_constraint.convalidated` says so. It does NOT weaken the check on
2112    /// new rows — INSERT and UPDATE enforce it either way, as in PG.
2113    /// `VALIDATE CONSTRAINT` does the deferred scan and flips it. Persisted
2114    /// by the FILE_VERSION 87 appendix; older catalogs deserialise as `true`,
2115    /// which is what every constraint they could hold actually was.
2116    pub validated: bool,
2117}
2118
2119#[derive(Debug, Clone, PartialEq, Eq)]
2120pub struct UniquenessConstraint {
2121    /// `true` when this constraint was declared as `PRIMARY KEY`
2122    /// (vs `UNIQUE`). Semantically PK implies NOT NULL on all
2123    /// referenced columns; the engine enforces that at CREATE
2124    /// TABLE time.
2125    pub is_primary_key: bool,
2126    /// Column positions on the parent table. ≥ 1 element. For
2127    /// single-column UNIQUE this is exactly one position; the
2128    /// BTree index alone enforces it.
2129    pub columns: Vec<usize>,
2130    /// v7.13.0 — `UNIQUE NULLS NOT DISTINCT` modifier
2131    /// (mailrs round-5 G10; PG 15+ surface). When `true`, two
2132    /// rows whose constrained columns are all NULL collide on
2133    /// the constraint. Default (`false`) is the SQL-standard
2134    /// `NULLS DISTINCT` behaviour where any NULL passes.
2135    /// Persisted in catalog FILE_VERSION 23+.
2136    pub nulls_not_distinct: bool,
2137    /// v7.39 (read01 round 48) — the constraint's SQL name when the user
2138    /// supplied one (`ADD CONSTRAINT <name> PRIMARY KEY/UNIQUE (...)`, or
2139    /// the inline `CONSTRAINT <name>` form). `None` = unnamed, in which
2140    /// case `pg_constraint` synthesises PG's `<table>_pkey` /
2141    /// `<table>_<col>_key` form. DROP CONSTRAINT resolves the stored name
2142    /// first and falls back to the synthesised one, so catalogs written
2143    /// before this field (< FILE_VERSION 60) keep working unchanged.
2144    pub name: Option<String>,
2145    /// v7.39 (round 711) — `[NOT] DEFERRABLE`. Round 621 taught the parser
2146    /// to CONSUME the clause on PK/UNIQUE (the FK path had stored it since
2147    /// round 288); this is the storing half. Persisted in the v89 timing
2148    /// appendix.
2149    pub deferrable: bool,
2150    /// `INITIALLY DEFERRED`: the check belongs to COMMIT, not the
2151    /// statement, unless `SET CONSTRAINTS … IMMEDIATE` pulls it in.
2152    pub initially_deferred: bool,
2153}
2154
2155/// v7.39 (round 210) — an `EXCLUDE` constraint. Forbids two distinct live
2156/// rows from satisfying, for EVERY element, `new.col <op> existing.col`
2157/// (e.g. `EXCLUDE USING gist (during WITH &&)` = no two `during` ranges
2158/// overlap). Unlike a uniqueness constraint the operator is not equality,
2159/// so enforcement is a full live-row scan re-checking the operator (a real
2160/// GiST index that answers overlap in O(log n) is a later perf phase). A
2161/// NULL in any element column exempts the row (matching PG / UNIQUE NULL
2162/// semantics). Persisted in catalog FILE_VERSION 72+.
2163#[derive(Debug, Clone, PartialEq, Eq)]
2164pub struct ExclusionConstraint {
2165    /// The constraint's SQL name. PG auto-names an unnamed EXCLUDE
2166    /// `<table>_<leading-col>_excl`; the engine synthesises that at CREATE
2167    /// TABLE time so this is always populated.
2168    pub name: String,
2169    /// Access method spelled after `USING` (`gist`, `spgist`, …), lower-cased.
2170    /// `None` = no `USING` clause. Purely cosmetic for enforcement; it round-
2171    /// trips into `pg_get_constraintdef`.
2172    pub method: Option<String>,
2173    /// One `(column-position, operator-spelling)` pair per element, in
2174    /// declaration order. The operator spelling is the wire token (`&&`,
2175    /// `=`, `@>`, `<@`, `&<`, `&>`) evaluated against each existing row.
2176    pub elements: Vec<(usize, String)>,
2177}
2178
2179/// v7.6.1 — Storage-layer mirror of `spg_sql::ast::ForeignKeyConstraint`.
2180/// The engine's CREATE TABLE path translates between the two; keeping
2181/// them separate preserves the no-deps boundary between
2182/// `spg-storage` and `spg-sql`.
2183#[derive(Debug, Clone, PartialEq, Eq)]
2184pub struct ForeignKeyConstraint {
2185    /// Optional user-supplied constraint name (`CONSTRAINT <name>`
2186    /// prefix). Used by `ALTER TABLE DROP CONSTRAINT <name>` in
2187    /// v7.6.8; ignored by enforcement.
2188    pub name: Option<String>,
2189    /// Positions of local columns in this table's column list.
2190    /// Same arity as `parent_columns`.
2191    pub local_columns: Vec<usize>,
2192    /// Referenced parent table name.
2193    pub parent_table: String,
2194    /// Positions of parent columns in the parent's column list.
2195    /// Engine resolves these at CREATE TABLE time (after the parent
2196    /// schema is known) so enforcement paths can skip the name
2197    /// lookup on every row.
2198    pub parent_columns: Vec<usize>,
2199    /// Referential action when a parent row is deleted.
2200    pub on_delete: FkAction,
2201    /// Referential action when a parent row's referenced columns
2202    /// are updated.
2203    pub on_update: FkAction,
2204    /// v7.38 (read01, T29) — `MATCH SIMPLE | FULL`. Defaults to `Simple`.
2205    pub match_type: MatchType,
2206    /// v7.39 (round 288) — `[NOT] DEFERRABLE`.
2207    pub deferrable: bool,
2208    /// `INITIALLY DEFERRED`: the check runs at COMMIT rather than at
2209    /// the statement, unless `SET CONSTRAINTS … IMMEDIATE` pulls it in.
2210    pub initially_deferred: bool,
2211}
2212
2213/// v7.38 (read01, T29) — FK MATCH type. Mirrors `spg_sql::ast::MatchType`.
2214#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
2215pub enum MatchType {
2216    #[default]
2217    Simple,
2218    Full,
2219}
2220
2221impl MatchType {
2222    /// On-disk tag byte (catalog appendix, `FILE_VERSION` 55+).
2223    pub const fn tag(self) -> u8 {
2224        match self {
2225            Self::Simple => 0,
2226            Self::Full => 1,
2227        }
2228    }
2229    pub const fn from_tag(b: u8) -> Option<Self> {
2230        Some(match b {
2231            0 => Self::Simple,
2232            1 => Self::Full,
2233            _ => return None,
2234        })
2235    }
2236}
2237
2238/// v7.6.1 — referential action tag. Mirrors `spg_sql::ast::FkAction`.
2239#[derive(Debug, Clone, Copy, PartialEq, Eq)]
2240pub enum FkAction {
2241    Restrict,
2242    Cascade,
2243    SetNull,
2244    SetDefault,
2245    NoAction,
2246}
2247
2248impl FkAction {
2249    /// On-disk tag byte (v13 catalog appendix).
2250    pub const fn tag(self) -> u8 {
2251        match self {
2252            Self::Restrict => 0,
2253            Self::Cascade => 1,
2254            Self::SetNull => 2,
2255            Self::SetDefault => 3,
2256            Self::NoAction => 4,
2257        }
2258    }
2259    pub const fn from_tag(b: u8) -> Option<Self> {
2260        Some(match b {
2261            0 => Self::Restrict,
2262            1 => Self::Cascade,
2263            2 => Self::SetNull,
2264            3 => Self::SetDefault,
2265            4 => Self::NoAction,
2266            _ => return None,
2267        })
2268    }
2269}
2270
2271impl TableSchema {
2272    pub fn column_position(&self, name: &str) -> Option<usize> {
2273        self.columns.iter().position(|c| c.name == name)
2274    }
2275}
2276
2277/// Key type accepted by secondary indices. Float / NULL / Vector values
2278/// can't participate in a B-tree index — `f64` is only `PartialOrd`, NULL
2279/// has SQL-three-valued semantics, and Vector belongs to the (future) HNSW
2280/// path. Index lookups on those columns fall back to full scan.
2281#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
2282pub enum IndexKey {
2283    Int(i64),
2284    Text(String),
2285    Bool(bool),
2286    /// v7.17.0 — `Value::Uuid` index key. Comparison is byte-wise
2287    /// (RFC 4122 byte order) so PRIMARY KEY UUID lookups land on
2288    /// the same fast-path as Int / Text.
2289    Uuid([u8; 16]),
2290    /// r1039 — `Value::Bytes` (bytea). PG orders bytea by plain byte
2291    /// comparison, shorter-prefix first (`'' < \x00 < \x0000 < \x01ff <
2292    /// \xff`, measured on 18.4), which is exactly `Vec<u8>`'s `Ord`.
2293    Bytes(Vec<u8>),
2294    /// r1039 — exact decimal, in the canonical form described on
2295    /// [`NumericKey`].
2296    ///
2297    /// r1040 — BOXED, and the box is load-bearing for every OTHER index.
2298    /// A `NumericKey` is 48 bytes against `Text(String)`'s 24, so inline
2299    /// it set the size of the whole enum and every B-tree node in every
2300    /// index grew with it: 32 bytes per key to 48, align 8 to 16.
2301    /// Measured through the release sweep, `SELECT pad FROM t ORDER BY
2302    /// id` over 400,000 rows — a walk of the primary key's index — went
2303    /// 39.4-40.6 ms to 42.3-44.1, in both leg orders. The indirection is
2304    /// charged to numeric keys, which are new, instead of to every index
2305    /// that existed already.
2306    Numeric(alloc::boxed::Box<NumericKey>),
2307    /// v7.38.1 (L12) — a NULL component INSIDE a composite key, and
2308    /// nothing else. `IndexKey::from_value(Value::Null)` still returns
2309    /// `None`, so single-column B-trees never hold one, and no probe
2310    /// path ever BUILDS one (`col = NULL` is not a match in SQL) — the
2311    /// variant is only reachable through a composite key's component
2312    /// list, where it exists so that a row like `(2, 3, NULL)` stays
2313    /// findable by a PREFIX probe on `(w, d)`. Declared last: slice
2314    /// `Ord` then sorts NULL components after every value, PG's
2315    /// NULLS LAST.
2316    Null,
2317}
2318
2319/// r1039 — an exact-decimal index key, canonical so that representation
2320/// equality IS value equality.
2321///
2322/// That property is the whole reason this is a struct rather than the
2323/// `(scaled, scale)` pair the value carries. `1.5` and `1.50` are the
2324/// same NUMERIC (PG18.4: `1.5::numeric = 1.50::numeric` is true) and
2325/// arrive here as `(15, 1)` and `(150, 2)`. A B-tree keyed on the raw
2326/// pair would file them apart, so `WHERE n = 1.5` would miss a row stored
2327/// as `1.50` — an index changing the answer, which is the one thing an
2328/// index may never do. `BigNumeric::cmp` carries the same warning and
2329/// declines to implement `Ord` for exactly this reason; a KEY cannot
2330/// decline, so it normalizes instead.
2331///
2332/// Canonical form: significant decimal digits with no leading and no
2333/// trailing zeros, most significant first, plus the decimal exponent of
2334/// the leading digit. Zero is the empty digit vector with `neg == false`
2335/// and `exp == 0`, so there is no `-0`.
2336///
2337/// Ordering is PG's, measured: `-Infinity < -1 < 0 < 1 < Infinity < NaN`,
2338/// and `NaN = NaN`.
2339#[derive(Debug, Clone, PartialEq, Eq)]
2340pub struct NumericKey {
2341    /// 0 = -Infinity, 1 = finite, 2 = +Infinity, 3 = NaN. Ordering the
2342    /// classes by this byte is what puts NaN on top, where PG keeps it.
2343    class: u8,
2344    /// Finite only, and never set for zero.
2345    neg: bool,
2346    /// Decimal exponent of the leading significant digit; 0 for zero.
2347    exp: i32,
2348    /// r1040 — the first [`HEAD_DIGITS`] significant digits, LEFT-ALIGNED
2349    /// (multiplied up so the leading digit always sits at 10^36). That
2350    /// alignment is what makes an integer comparison of two heads the same
2351    /// answer as a digit-by-digit one: `12` and `1` become 1.2e36 and
2352    /// 1.0e36, which order the way the digit strings do, where the bare
2353    /// integers 12 and 1 would not.
2354    ///
2355    /// Zero for the value zero and for every special.
2356    ///
2357    /// This started as a `Vec<u8>` of digits, which is correct and cost
2358    /// an allocation per key and a slice comparison per sort comparison.
2359    /// `ORDER BY <numeric>` builds one key per row and compares n log n
2360    /// times: 200,000 rows measured 65.4 ms against 39.6 for the f64
2361    /// projection that had been returning rows in the wrong order.
2362    head: u128,
2363    /// Significant digits past the 37th, one per byte, no trailing zeros.
2364    /// Empty for everything an `i128` mantissa can hold with room to
2365    /// spare — and an empty `Vec` does not allocate, which is the point.
2366    tail: Vec<u8>,
2367}
2368
2369/// Significant digits carried in [`NumericKey::head`]. 37 is the most
2370/// that can be left-aligned inside a `u128`: the largest such value is
2371/// 9.99…e36, and `u128::MAX` is 3.4e38.
2372const HEAD_DIGITS: u32 = 37;
2373/// `10^36` — where a left-aligned leading digit sits.
2374const HEAD_SCALE: u128 = 1_000_000_000_000_000_000_000_000_000_000_000_000;
2375
2376/// The `class` byte of [`NumericKey`], in PG's order.
2377const NUM_CLASS_NEG_INF: u8 = 0;
2378const NUM_CLASS_FINITE: u8 = 1;
2379const NUM_CLASS_POS_INF: u8 = 2;
2380const NUM_CLASS_NAN: u8 = 3;
2381
2382impl NumericKey {
2383    /// The key for a `Value::Numeric`'s three fields.
2384    ///
2385    /// Public because the ORDER BY key wants the same canonical form the
2386    /// index key uses: two sort keys that disagree about which of two
2387    /// NUMERICs is larger is the same class of defect as an index that
2388    /// disagrees with a scan, and one definition is how they stay honest.
2389    #[must_use]
2390    pub fn from_numeric(scaled: i128, scale: u16, kind: NumericKind) -> Self {
2391        match kind {
2392            NumericKind::Finite => {
2393                let mut buf = [0u8; 40];
2394                let n = digits_of_u128(scaled.unsigned_abs(), &mut buf);
2395                Self::finite(scaled < 0, &buf[..n], i32::from(scale))
2396            }
2397            NumericKind::NaN => Self::special(NUM_CLASS_NAN),
2398            NumericKind::PosInf => Self::special(NUM_CLASS_POS_INF),
2399            NumericKind::NegInf => Self::special(NUM_CLASS_NEG_INF),
2400        }
2401    }
2402
2403    /// The key for an exact integer — no scale, so no rounding.
2404    #[must_use]
2405    pub fn from_i128(n: i128) -> Self {
2406        let mut buf = [0u8; 40];
2407        let len = digits_of_u128(n.unsigned_abs(), &mut buf);
2408        Self::finite(n < 0, &buf[..len], 0)
2409    }
2410
2411    /// The key for a mantissa that overflowed `i128`. The two
2412    /// representations of one value land on one key.
2413    #[must_use]
2414    pub fn from_big(b: &crate::bignum::BigNumeric) -> Self {
2415        let (neg, limbs, scale) = b.parts();
2416        Self::finite(neg, &digits_of_limbs(limbs), i32::from(scale))
2417    }
2418
2419    /// The `f64` this key means, for the one comparison PG defines that
2420    /// way: `numeric` against `float8` demotes the numeric.
2421    ///
2422    /// Lossy by construction — that is the point, and it is why nothing
2423    /// else uses it.
2424    #[must_use]
2425    #[allow(clippy::cast_precision_loss)]
2426    pub fn to_f64(&self) -> f64 {
2427        match self.class {
2428            NUM_CLASS_NAN => return f64::NAN,
2429            NUM_CLASS_POS_INF => return f64::INFINITY,
2430            NUM_CLASS_NEG_INF => return f64::NEG_INFINITY,
2431            _ => {}
2432        }
2433        if self.head == 0 {
2434            return 0.0;
2435        }
2436        // `head` is `d.ddd… × 10^36`; the value is that leading digit and
2437        // its followers at `exp`. The tail is below f64's resolution by
2438        // construction (it starts at the 38th significant digit).
2439        let mantissa = self.head as f64 / HEAD_SCALE as f64;
2440        let out = mantissa * pow10_f64(self.exp);
2441        if self.neg { -out } else { out }
2442    }
2443
2444    /// The significant decimal digits, most significant first — the form
2445    /// the catalog codec writes, and the one `from_parts` reads back.
2446    #[must_use]
2447    pub fn digits(&self) -> Vec<u8> {
2448        let mut out = Vec::new();
2449        if self.head != 0 {
2450            let mut h = self.head;
2451            for _ in 0..HEAD_DIGITS {
2452                let d = u8::try_from(h / HEAD_SCALE).unwrap_or(0);
2453                out.push(d);
2454                h = (h % HEAD_SCALE) * 10;
2455            }
2456            while out.last() == Some(&0) {
2457                out.pop();
2458            }
2459        }
2460        out.extend_from_slice(&self.tail);
2461        out
2462    }
2463
2464    /// The wire parts, for the catalog codec.
2465    #[must_use]
2466    pub fn parts(&self) -> (u8, bool, i32) {
2467        (self.class, self.neg, self.exp)
2468    }
2469
2470    /// Rebuild from the wire parts. Returns `None` on parts that are not
2471    /// canonical, so a corrupt catalog cannot smuggle in a key whose `Eq`
2472    /// and `Ord` disagree.
2473    #[must_use]
2474    pub fn from_parts(class: u8, neg: bool, exp: i32, digits: &[u8]) -> Option<Self> {
2475        if class > NUM_CLASS_NAN || digits.iter().any(|d| *d > 9) {
2476            return None;
2477        }
2478        if class != NUM_CLASS_FINITE && (neg || exp != 0 || !digits.is_empty()) {
2479            return None;
2480        }
2481        if digits.is_empty() {
2482            if neg || exp != 0 {
2483                return None;
2484            }
2485            return Some(Self::special(class));
2486        }
2487        if digits[0] == 0 || digits[digits.len() - 1] == 0 {
2488            return None;
2489        }
2490        Some(Self {
2491            class,
2492            neg,
2493            exp,
2494            head: head_of(digits),
2495            tail: digits.iter().skip(HEAD_DIGITS as usize).copied().collect(),
2496        })
2497    }
2498
2499    /// Canonicalize `(-1)^neg · <digits as an integer> · 10^-scale`.
2500    ///
2501    /// `digits` is most-significant-first and may carry leading and
2502    /// trailing zeros; both are stripped, which is what makes `1.5` and
2503    /// `1.50` land on the same key.
2504    fn finite(neg: bool, digits: &[u8], scale: i32) -> Self {
2505        let lead = digits.iter().position(|d| *d != 0).unwrap_or(digits.len());
2506        let digits = &digits[lead..];
2507        if digits.is_empty() {
2508            return Self::special(NUM_CLASS_FINITE);
2509        }
2510        // The leading digit's exponent, taken BEFORE trailing zeros go:
2511        // dropping low-order digits does not move the leading one.
2512        let exp = i32::try_from(digits.len()).unwrap_or(i32::MAX) - 1 - scale;
2513        let mut end = digits.len();
2514        while end > 0 && digits[end - 1] == 0 {
2515            end -= 1;
2516        }
2517        let digits = &digits[..end];
2518        Self {
2519            class: NUM_CLASS_FINITE,
2520            neg,
2521            exp,
2522            head: head_of(digits),
2523            tail: digits.iter().skip(HEAD_DIGITS as usize).copied().collect(),
2524        }
2525    }
2526
2527    fn special(class: u8) -> Self {
2528        Self {
2529            class,
2530            neg: false,
2531            exp: 0,
2532            head: 0,
2533            tail: Vec::new(),
2534        }
2535    }
2536}
2537
2538/// The first [`HEAD_DIGITS`] of `digits`, left-aligned so the leading one
2539/// sits at `10^36`.
2540fn head_of(digits: &[u8]) -> u128 {
2541    let mut head: u128 = 0;
2542    let take = (HEAD_DIGITS as usize).min(digits.len());
2543    for d in &digits[..take] {
2544        head = head * 10 + u128::from(*d);
2545    }
2546    for _ in take..HEAD_DIGITS as usize {
2547        head *= 10;
2548    }
2549    head
2550}
2551
2552/// Decimal digits of `mag` into `buf`, most significant first; returns how
2553/// many were written. Zero writes none.
2554///
2555/// r1040 — split at `u64` on purpose. A `u128` divide is a called routine,
2556/// not an instruction, and this loop runs once per digit per key.
2557fn digits_of_u128(mag: u128, buf: &mut [u8; 40]) -> usize {
2558    if mag == 0 {
2559        return 0;
2560    }
2561    let mut rev = [0u8; 40];
2562    let mut n = 0usize;
2563    let mut big = mag;
2564    // Peel nineteen digits at a time — the most a `u64` holds — so the
2565    // wide divide runs at most twice.
2566    while big > u128::from(u64::MAX) {
2567        let mut chunk = u64::try_from(big % 10_000_000_000_000_000_000_u128).unwrap_or(0);
2568        big /= 10_000_000_000_000_000_000_u128;
2569        for _ in 0..19 {
2570            rev[n] = u8::try_from(chunk % 10).unwrap_or(0);
2571            chunk /= 10;
2572            n += 1;
2573        }
2574    }
2575    let mut small = u64::try_from(big).unwrap_or(0);
2576    while small > 0 {
2577        rev[n] = u8::try_from(small % 10).unwrap_or(0);
2578        small /= 10;
2579        n += 1;
2580    }
2581    for i in 0..n {
2582        buf[i] = rev[n - 1 - i];
2583    }
2584    n
2585}
2586
2587/// Decimal digits of a base-10^9 little-endian limb vector, most
2588/// significant first. Every limb but the leading one is padded to its
2589/// full nine digits — that padding is the whole point, since a limb of 5
2590/// in the middle of a number means `000000005`.
2591fn digits_of_limbs(limbs: &[u32]) -> Vec<u8> {
2592    let mut out = Vec::new();
2593    let mut buf = [0u8; 40];
2594    for (i, limb) in limbs.iter().enumerate().rev() {
2595        let n = digits_of_u128(u128::from(*limb), &mut buf);
2596        if i + 1 == limbs.len() {
2597            out.extend_from_slice(&buf[..n]);
2598        } else {
2599            out.extend(core::iter::repeat_n(0u8, 9 - n));
2600            out.extend_from_slice(&buf[..n]);
2601        }
2602    }
2603    out
2604}
2605
2606/// `10^e` as an `f64`, for any `e` a canonical key can carry.
2607#[allow(clippy::cast_precision_loss)]
2608fn pow10_f64(e: i32) -> f64 {
2609    let mut out = 1.0_f64;
2610    let mag = e.unsigned_abs();
2611    for _ in 0..mag {
2612        out *= 10.0;
2613    }
2614    if e < 0 { 1.0 / out } else { out }
2615}
2616
2617impl Ord for NumericKey {
2618    fn cmp(&self, other: &Self) -> core::cmp::Ordering {
2619        use core::cmp::Ordering;
2620        if self.class != other.class {
2621            return self.class.cmp(&other.class);
2622        }
2623        if self.class != NUM_CLASS_FINITE {
2624            // Each of the three specials is a single value, and PG holds
2625            // `'NaN'::numeric = 'NaN'::numeric` true.
2626            return Ordering::Equal;
2627        }
2628        // Zero first: it is stored with `neg == false` and `exp == 0`, so
2629        // the magnitude comparison below would put it above every value
2630        // smaller than 1 rather than between the negatives and positives.
2631        match (self.head == 0, other.head == 0) {
2632            (true, true) => return Ordering::Equal,
2633            (true, false) => {
2634                return if other.neg {
2635                    Ordering::Greater
2636                } else {
2637                    Ordering::Less
2638                };
2639            }
2640            (false, true) => {
2641                return if self.neg {
2642                    Ordering::Less
2643                } else {
2644                    Ordering::Greater
2645                };
2646            }
2647            (false, false) => {}
2648        }
2649        match (self.neg, other.neg) {
2650            (false, true) => return Ordering::Greater,
2651            (true, false) => return Ordering::Less,
2652            _ => {}
2653        }
2654        // Same sign, both non-zero: more integer digits is bigger, and at
2655        // equal exponent the left-aligned heads compare as one integer —
2656        // the alignment is what makes that the same answer as comparing
2657        // the digit strings. The tail only speaks when the first 37
2658        // significant digits are identical.
2659        let mag = self
2660            .exp
2661            .cmp(&other.exp)
2662            .then_with(|| self.head.cmp(&other.head))
2663            .then_with(|| self.tail.cmp(&other.tail));
2664        if self.neg { mag.reverse() } else { mag }
2665    }
2666}
2667
2668impl PartialOrd for NumericKey {
2669    fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
2670        Some(self.cmp(other))
2671    }
2672}
2673
2674impl IndexKey {
2675    /// v7.37.43 (INSUBQ B-4) — inline-friendly BigInt fast path.
2676    /// `try_count_star_pk_in_subquery_fast` (and any other hot loop
2677    /// probing an integer PK) already holds an `i64`; this builds the
2678    /// `IndexKey` without going through the generic `from_value`
2679    /// dispatch tree.
2680    #[inline]
2681    pub fn from_i64(n: i64) -> Self {
2682        Self::Int(n)
2683    }
2684
2685    /// r1039 — the key a value takes when the INDEXED COLUMN is `ty`, or
2686    /// `None` when it takes none (→ the caller falls back to a scan).
2687    ///
2688    /// Every key under one index comes from one column, so they all live
2689    /// in one key SPACE. A probe built in a different space finds nothing
2690    /// — and "nothing" is indistinguishable from "no matching rows",
2691    /// which is how round 564 and r1037 both turned an index into a wrong
2692    /// answer (a TEXT key sought against a DATE-keyed and a UUID-keyed
2693    /// index).
2694    ///
2695    /// The two spaces this round adds make that trap reachable again from
2696    /// a new direction: `WHERE n = 2` on a NUMERIC column produces
2697    /// `Value::Int`, and an integer key would look in a space nothing
2698    /// lives in. So NUMERIC columns take integers by converting them
2699    /// exactly, and refuse anything they cannot convert; BYTEA columns
2700    /// take only `Value::Bytes`; and no other column may be keyed in
2701    /// either of the two new spaces.
2702    ///
2703    /// Use this wherever the key comes from a LITERAL or from another
2704    /// table's value. [`IndexKey::from_value`] stays right for building
2705    /// the index itself, where the value is the column's own.
2706    pub fn from_value_for_column(v: &Value<'_>, ty: DataType) -> Option<Self> {
2707        match ty {
2708            DataType::Numeric { .. } => match v {
2709                Value::SmallInt(n) => Some(Self::exact_int_key(i128::from(*n))),
2710                Value::Int(n) => Some(Self::exact_int_key(i128::from(*n))),
2711                Value::BigInt(n) => Some(Self::exact_int_key(i128::from(*n))),
2712                Value::Numeric { .. } | Value::NumericBig(_) => Self::from_value(v),
2713                // Float included: `2.0::float8` and `2.0::numeric` are not
2714                // the same value to a B-tree, and rounding one into the
2715                // other's space is how a seek reaches the wrong row.
2716                _ => None,
2717            },
2718            DataType::Bytes => match v {
2719                Value::Bytes(b) => Some(Self::Bytes(b.to_vec())),
2720                _ => None,
2721            },
2722            _ => match Self::from_value(v) {
2723                Some(Self::Numeric(_) | Self::Bytes(_)) => None,
2724                other => other,
2725            },
2726        }
2727    }
2728
2729    /// An integer as a NUMERIC key. Exact by construction — no scale, no
2730    /// rounding — which is why the conversion is allowed at all.
2731    fn exact_int_key(n: i128) -> Self {
2732        Self::Numeric(alloc::boxed::Box::new(NumericKey::from_i128(n)))
2733    }
2734
2735    pub fn from_value(v: &Value<'_>) -> Option<Self> {
2736        match v {
2737            // v7.37.43 (INSUBQ B-4) — BigInt hits first (the dominant
2738            // INSUBQ shape probes PK as BigInt). Tiny micro-win.
2739            Value::BigInt(n) => Some(Self::Int(*n)),
2740            Value::SmallInt(n) => Some(Self::Int(i64::from(*n))),
2741            Value::Int(n) => Some(Self::Int(i64::from(*n))),
2742            Value::Text(s) => Some(Self::Text(s.clone().into_owned())),
2743            // v7.38 (read01, T11) — bpchar keys compare blank-insensitively.
2744            Value::BpChar(s) => Some(Self::Text(s.trim_end_matches(' ').to_string())),
2745            Value::Bool(b) => Some(Self::Bool(*b)),
2746            // Date/Timestamp use their integer storage repr as the
2747            // index key — same order semantics, same comparison.
2748            Value::Date(d) => Some(Self::Int(i64::from(*d))),
2749            Value::Timestamp(t) => Some(Self::Int(*t)),
2750            // v7.17.0: UUID indexable via byte-wise ordering. Lookup
2751            // on `id = '...'::uuid` resolves through the secondary
2752            // index rather than full-scan.
2753            Value::Uuid(b) => Some(Self::Uuid(*b)),
2754            // v7.17.0 Phase 3.P0-32: TIME indexable via i64 — same
2755            // order semantics as Date/Timestamp.
2756            Value::Time(us) => Some(Self::Int(*us)),
2757            // v7.17.0 Phase 3.P0-33: YEAR indexable as i64 — u16
2758            // widens losslessly and gives the natural calendar
2759            // ordering.
2760            Value::Year(y) => Some(Self::Int(i64::from(*y))),
2761            // v7.17.0 Phase 3.P0-34: TIMETZ indexable by its
2762            // UTC-equivalent microseconds (local wall - offset).
2763            // Without normalising, two values for the same
2764            // physical instant in different zones would sort
2765            // wrong. Matches PG's TIMETZ index behaviour.
2766            Value::TimeTz { us, offset_secs } => {
2767                Some(Self::Int(us - i64::from(*offset_secs) * 1_000_000))
2768            }
2769            // v7.17.0 Phase 3.P0-35: MONEY indexable as i64 cents
2770            // (no scaling needed — natural numeric ordering).
2771            Value::Money(c) => Some(Self::Int(*c)),
2772            // v7.17.0 Phase 3.P0-38: ranges are NOT indexable in
2773            // v7.17.0 — they'd need a custom comparator (PG uses
2774            // SP-GiST for this). Skip.
2775            Value::Range { .. } => None,
2776            // v7.17.0 Phase 3.P0-39: hstore is NOT indexable in
2777            // v7.17.0 — map columns need GIN with bespoke ops.
2778            Value::Hstore(_) => None,
2779            // r1039 — exact decimals index through the canonical
2780            // [`NumericKey`], which is what makes `1.5` and `1.50` one key.
2781            Value::NumericBig(b) => Some(Self::Numeric(alloc::boxed::Box::new(NumericKey::from_big(b)))),
2782            Value::Numeric {
2783                scaled,
2784                scale,
2785                kind,
2786            } => Some(Self::Numeric(alloc::boxed::Box::new(
2787                NumericKey::from_numeric(*scaled, *scale, *kind),
2788            ))),
2789            // r1039 — bytea orders by plain byte comparison, which is
2790            // `Vec<u8>`'s own.
2791            Value::Bytes(b) => Some(Self::Bytes(b.to_vec())),
2792            // v7.17.0 Phase 3.P0-40: 2D arrays aren't indexable.
2793            Value::IntArray2D(_)
2794            | Value::BigIntArray2D(_)
2795            | Value::TextArray2D(_)
2796            | Value::BoolArray2D(_) => None,
2797            // v7.37.5 β-P4: INTERVAL[] isn't indexable (PG uses
2798            // GIN/intarray for array-contains queries; SPG plans
2799            // that as a separate axis under v7.37.8 GIN-on-jsonb).
2800            Value::IntervalArray(_) => None,
2801            // v7.37.5 γ — none of the array-of-scalar family is
2802            // B-tree indexable. Same reason as IntervalArray: PG
2803            // serves array-contains / array-overlap queries via
2804            // GIN, and SPG's GIN axis lands in v7.37.8.
2805            Value::BoolArray(_)
2806            | Value::SmallIntArray(_)
2807            | Value::FloatArray(_)
2808            | Value::NumericArray(_)
2809            | Value::DateArray(_)
2810            | Value::TimestampArray(_)
2811            | Value::TimestamptzArray(_)
2812            | Value::UuidArray(_)
2813            | Value::JsonArray(_)
2814            | Value::JsonbArray(_)
2815            | Value::BytesArray(_)
2816            | Value::VarcharArray(_)
2817            | Value::CharArray(_)
2818            // v7.37.5 δ — multirange not indexable (PG uses GiST/
2819            // SP-GiST + a custom operator class; SPG plans the same
2820            // axis under v7.37.8 with ranges).
2821            | Value::Multirange { .. }
2822            // v7.37.5 ε — geometric scalars not B-tree indexable
2823            // (PG uses GiST/SP-GiST for these too; SPG plans the
2824            // same axis under v7.37.8).
2825            | Value::Point(_)
2826            | Value::Lseg(_, _)
2827            | Value::Path { .. }
2828            | Value::PgBox(_, _)
2829            | Value::Polygon(_)
2830            | Value::Line { .. }
2831            | Value::Circle { .. }
2832            // v7.37.5 ζ-A — network / bit / xml / "char" / money[].
2833            // INET / CIDR / MACADDR / MACADDR8 could be B-tree
2834            // indexable (PG does this), but the byte-wise compare
2835            // family-blind would mis-order IPv4 vs IPv6; left as
2836            // a follow-up under v7.37.8 GIN window.
2837            | Value::Inet { .. }
2838            | Value::Cidr { .. }
2839            | Value::Macaddr(_)
2840            | Value::Macaddr8(_)
2841            | Value::PgLsn(_)
2842            | Value::BitString { .. }
2843            | Value::Xml(_)
2844            | Value::Char1(_)
2845            | Value::MoneyArray(_)
2846            | Value::Composite(_)
2847            | Value::Tid(..)
2848            | Value::Xid(_)
2849            | Value::Cid(_)
2850            | Value::RegClass(..)
2851            | Value::RegProc(..)
2852            | Value::RegType(..) => None,
2853            // Interval isn't index-eligible (and can't reach this path
2854            // through column storage anyway). Float / Real stay out
2855            // because `f64` is only `PartialOrd`.
2856            Value::Null
2857            | Value::Float(_)
2858            | Value::Vector(_)
2859            | Value::Sq8Vector(_)
2860            | Value::HalfVector(_)
2861            | Value::Interval { .. }
2862            | Value::Json(_)
2863            | Value::TextArray(_)
2864            | Value::IntArray(_)
2865            | Value::BigIntArray(_)
2866            | Value::TsVector(_)
2867            | Value::TsQuery(_)
2868            | Value::Real(_) => None,
2869        }
2870    }
2871}
2872
2873/// A single-column secondary index. v2.0 carries either a B-tree map
2874/// (the default — used for equality / range lookups on scalar columns)
2875/// or a navigable-small-world graph (used for kNN over vector
2876/// columns).
2877#[derive(Debug, Clone)]
2878pub struct Index {
2879    pub name: String,
2880    pub column_position: usize,
2881    pub kind: IndexKind,
2882    /// v6.8.0 — column positions of `INCLUDE (col1, col2, …)`
2883    /// non-key columns. Carries the planner's "this query is
2884    /// covered by the index" signal; lookup paths still resolve
2885    /// via the `RowLocator` to fetch the row body, but EXPLAIN
2886    /// surfaces the covered-scan annotation so operators can
2887    /// confirm the planner sees the coverage.
2888    ///
2889    /// Empty `Vec` = no `INCLUDE` clause (the legacy shape). v12
2890    /// catalog snapshots deserialise with an empty vec.
2891    pub included_columns: Vec<usize>,
2892    /// v6.8.1 — partial-index predicate stored as its canonical
2893    /// Display form (the engine re-parses it on the maintenance
2894    /// path). `None` = unconditional index (the legacy shape).
2895    /// Persisted as `[u8 has_pred][u16 LE len][bytes]` on the
2896    /// catalog snapshot (FILE_VERSION 12, appended after
2897    /// `included_columns`).
2898    pub partial_predicate: Option<String>,
2899    /// v6.8.2 — expression-index key, stored as the expression's
2900    /// canonical Display form. `None` = bare column-reference
2901    /// index (the legacy shape). Persisted alongside
2902    /// `partial_predicate` on the v12 catalog snapshot.
2903    pub expression: Option<String>,
2904    /// v7.39 (read01 round 52) — `CREATE UNIQUE INDEX … NULLS NOT DISTINCT`
2905    /// (PG 15+): a NULL in the key no longer exempts the row, so two
2906    /// all-NULL keys collide. Default `false` = SQL-standard NULLS DISTINCT.
2907    /// Persisted in the index appendix (FILE_VERSION 62+); older catalogs
2908    /// deserialise with `false`.
2909    pub nulls_not_distinct: bool,
2910    /// v7.39 (round 537) — the key column's ordering clause, as written.
2911    ///
2912    /// SPG's index does not scan in a direction, so this changes no
2913    /// lookup; `pg_indexes.indexdef` is a reproduction of the DDL and
2914    /// dropping the clause made `CREATE INDEX i ON t (a DESC NULLS
2915    /// LAST)` read back as `(a)` — a dump lost it and a schema diff saw
2916    /// drift every run. `nulls_first` is `None` when the statement did
2917    /// not say, in which case PG's default applies and neither word is
2918    /// rendered.
2919    pub descending: bool,
2920    pub nulls_first: Option<bool>,
2921    /// v7.39 (round 538) — an explicit `COLLATE` on the key, as written.
2922    /// SPG orders text by bytes, so it changes no comparison; PG prints
2923    /// it because a named collation and an inherited one are different
2924    /// objects even where they sort identically.
2925    pub collation: Option<String>,
2926    /// v7.9.29 — `CREATE UNIQUE INDEX …`. When true the engine
2927    /// rejects INSERTs whose key already appears in this index
2928    /// (combined with `partial_predicate` when present — only
2929    /// rows matching the predicate enter the uniqueness check).
2930    /// Catalog FILE_VERSION 16+; older snapshots deserialise
2931    /// with `false`. mailrs K1.
2932    pub is_unique: bool,
2933    /// v7.9.29 — extra (non-leading) column positions for
2934    /// multi-column indexes (`CREATE INDEX … (a, b, c)`). The
2935    /// planner today still only uses the leading
2936    /// `column_position` for index seeks, but UNIQUE INDEX
2937    /// enforcement walks the full tuple so partial-unique
2938    /// invariants like CalDAV `(calendar_id, uid,
2939    /// recurrence_id)` are enforced correctly. Catalog
2940    /// FILE_VERSION 16+; older snapshots deserialise empty.
2941    pub extra_column_positions: Vec<usize>,
2942}
2943
2944/// Default neighbor degree (M) for the NSW graph. Picked at construction
2945/// time and persisted with the index.
2946pub const NSW_DEFAULT_M: usize = 16;
2947
2948/// v5.2.2: outcome of a successful [`Catalog::freeze_oldest_to_cold`]
2949/// call. The catalog state has already been mutated by the time this
2950/// is returned (hot rows dropped + segment registered + Cold locators
2951/// flipped). The caller's only remaining concern is `segment_bytes` —
2952/// persist them to disk under `<db>.spg/segments/seg_<id>.spg` so a
2953/// future restart can reload via the v5.1 `SPG_PRELOAD_COLD_SEGMENT`
2954/// path. (v5.3's manifest will subsume this manual step.)
2955#[derive(Debug, Clone)]
2956pub struct FreezeReport {
2957    /// Id allocated by [`Catalog::load_segment_bytes`] for the new
2958    /// cold-tier segment. Stable across the call's success path.
2959    pub segment_id: u32,
2960    /// Number of rows that moved hot → cold. Equals the `max_rows`
2961    /// the caller asked for (the API is strict on the count).
2962    pub frozen_rows: usize,
2963    /// Hot-tier bytes reclaimed by the freeze — the
2964    /// [`Table::hot_bytes`] delta before vs after. Useful to feed
2965    /// back into the freezer's budget check on the next tick.
2966    pub bytes_freed: u64,
2967    /// Encoded segment bytes, byte-identical to what
2968    /// [`encode_segment`] produced. The catalog already owns a
2969    /// copy inside `cold_segments`; this hand-off lets the caller
2970    /// persist them without re-encoding.
2971    pub segment_bytes: Vec<u8>,
2972}
2973
2974/// v6.7.4 — read-only output of [`Catalog::prepare_freeze_slice`].
2975/// Carries every row body + key in a contiguous hot-row range,
2976/// already encoded and sorted by PK so the coordinator's merge
2977/// step is a k-way merge over already-sorted streams.
2978///
2979/// `Vec<FreezeSlice>` from N independent workers feeds
2980/// [`Catalog::commit_freeze_slices`], which concats + encodes the
2981/// merged segment + atomically swaps the catalog state.
2982#[derive(Debug, Clone)]
2983pub struct FreezeSlice {
2984    /// Hot-row index range this slice covered (half-open, in the
2985    /// table's `rows: PersistentVec` ordering at call time). The
2986    /// commit step uses this to compute the union range that
2987    /// gets passed to [`Table::delete_rows`].
2988    pub row_range: core::ops::Range<usize>,
2989    /// `(pk_u64, encoded_row_body, IndexKey)` triples, sorted
2990    /// ascending by `pk_u64`. Per-slice sort happens inside
2991    /// `prepare_freeze_slice`; the coordinator does only a
2992    /// k-way merge to reach the global PK ordering
2993    /// [`encode_segment`] requires.
2994    pub rows: Vec<(u64, Vec<u8>, IndexKey)>,
2995}
2996
2997/// v6.7.3 — outcome of a [`Catalog::compact_cold_segments`] call.
2998/// The catalog state has already been mutated when this is returned:
2999/// the merged segment is loaded into `cold_segments`, the source
3000/// segment slots are tombstoned (`None`), and every BTree-index
3001/// `RowLocator::Cold` that previously pointed at a source now
3002/// points at the merged segment. The caller's remaining job is to
3003/// persist `merged_segment_bytes` under
3004/// `<db>.spg/segments/seg_<merged_segment_id>.spg` and update the
3005/// in-memory `segment_id → path` map (remove the source ids, add
3006/// the merged id) so the next CHECKPOINT writes a manifest that
3007/// no longer lists the retired sources.
3008///
3009/// On a no-op (fewer than 2 candidate segments under the threshold),
3010/// `merged_segment_id` is `None` and `sources` is empty; the
3011/// catalog was not mutated.
3012#[derive(Debug, Clone)]
3013pub struct CompactReport {
3014    /// Source segment ids that were merged + tombstoned.
3015    pub sources: Vec<u32>,
3016    /// Id allocated for the merged segment. `None` on no-op.
3017    pub merged_segment_id: Option<u32>,
3018    /// Encoded merged-segment bytes (empty on no-op).
3019    pub merged_segment_bytes: Vec<u8>,
3020    /// Number of rows that landed in the merged segment.
3021    pub merged_rows: usize,
3022    /// `Σ source.num_rows − merged_rows`. Rows present in source
3023    /// segment payloads but unreferenced by any live BTree
3024    /// `Cold` locator — DELETE'd-but-still-frozen rows that
3025    /// compaction GC'd during the merge.
3026    pub deleted_rows_pruned: usize,
3027    /// `Σ source.bytes() − merged.bytes()`. Estimate of on-disk
3028    /// space the merge will reclaim once the source segment files
3029    /// are GC'd. Saturating subtract — never negative.
3030    pub bytes_reclaimed_estimate: u64,
3031}
3032
3033#[derive(Debug, Clone)]
3034pub enum IndexKind {
3035    /// v4.40: structural-sharing B-tree over `IndexKey`. Replaces the v0.8
3036    /// `BTreeMap<IndexKey, Vec<usize>>` — `Index::clone` is now an `Arc`
3037    /// bump regardless of index size, so `Catalog::clone` inside the
3038    /// v4.34 auto-commit wrap stays O(1) even for tables with secondary
3039    /// indices (the case that bottlenecked v4.39 at 1M rows in the
3040    /// sweep).
3041    ///
3042    /// v5.1: value type widened from `Vec<usize>` to `Vec<RowLocator>` so
3043    /// a single key can point to a mix of hot-tier rows (`RowLocator::Hot`,
3044    /// equivalent to the pre-v5 `usize` row index) and cold-tier rows
3045    /// (`RowLocator::Cold { segment_id, page_offset }`) once the v5.2
3046    /// freezer starts producing them. Pre-v5.2 only `Hot` entries appear
3047    /// — the on-disk encoding stays at `FILE_VERSION` 8 (raw u64 row index)
3048    /// because every locator round-trips through `RowLocator::from_legacy_v8_u64`
3049    /// without information loss. `FILE_VERSION` 9 with tagged encoding lands
3050    /// alongside the first freezer commit (v5.1 step 2b / v5.2).
3051    BTree(PersistentBTreeMap<IndexKey, crate::posting::PostingList>),
3052    /// Navigable-small-world graph for vector kNN search.
3053    Nsw(NswGraph),
3054    /// v6.7.1 — BRIN (Block Range INdex). Pure metadata: BRIN
3055    /// indexes carry NO in-memory key→locator map. The (min,
3056    /// max) summaries live in each cold-tier segment's v2
3057    /// envelope sidecar; the BRIN entry in `Table.indices` only
3058    /// records THAT a BRIN index exists on this column so the
3059    /// segment encoder + planner can opt into the summary path.
3060    Brin {
3061        /// The cell type at `column_position` at CREATE INDEX time.
3062        /// Used by the planner to type-check WHERE-clause range
3063        /// predicates against the BRIN-indexed column.
3064        column_type: DataType,
3065    },
3066    /// v7.12.3 — GIN inverted index over a `tsvector` column.
3067    ///
3068    /// Storage shape: `lexeme word → Vec<RowLocator>`. The posting
3069    /// list per word is appended in row-order, so range scans are
3070    /// O(matching rows) once the per-word lookup is done. Multi-
3071    /// term queries intersect / union posting lists.
3072    ///
3073    /// `IndexKey::from_value(TsVector)` returns `None` — GIN doesn't
3074    /// participate in `try_index_seek` (which is BTree-equality-keyed).
3075    /// The engine consults this index through `try_gin_lookup` on
3076    /// `WHERE col @@ tsquery` predicates instead.
3077    ///
3078    /// Backed by a `PersistentBTreeMap` so `Catalog::clone` (the
3079    /// per-write snapshot) stays O(1) — same structural-sharing
3080    /// invariant as BTree.
3081    Gin(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3082    /// v7.15.0 — `USING gin (col gin_trgm_ops)` over a `TEXT`
3083    /// column. Posting lists map `trigram` (PG-compatible 3-byte
3084    /// shingle on the lower-cased + space-padded input) to row
3085    /// locators. The planner uses this index to accelerate
3086    /// `WHERE col LIKE '…'` / `ILIKE '…'` / `similarity(col, q) >
3087    /// t` — every literal run of length ≥ 1 in the pattern
3088    /// produces a trigram set, the engine intersects the posting
3089    /// lists, and the LIKE / similarity predicate is re-evaluated
3090    /// per candidate row to filter the over-approximation.
3091    /// Persisted via tag-4 index payload in `FILE_VERSION` 24+.
3092    GinTrgm(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3093    /// v7.17.0 Phase 2.2 — MySQL `FULLTEXT KEY (col)` over a
3094    /// `TEXT` / `VARCHAR` column. Posting lists map
3095    /// `tsvector('simple') lexeme` to row locators. At insert /
3096    /// build time the engine derives the lexemes from the cell
3097    /// via the same lower-case tokenisation rule as
3098    /// `to_tsvector('simple', ...)` — the column itself stays a
3099    /// plain text type on disk (mysqldump round-trips would be
3100    /// broken otherwise). The planner uses this index to
3101    /// accelerate MySQL-shape `MATCH(col) AGAINST('term')`
3102    /// queries by mapping them onto the existing tsquery `@@`
3103    /// walker. Persisted via tag-5 index payload in
3104    /// `FILE_VERSION` 33+.
3105    GinFulltext(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3106    /// v7.37.8(sentori Epic 5 P2)— `USING gin (col)` over a
3107    /// `JSON` / `JSONB` column. Posting lists map a canonical
3108    /// `(path, leaf)` token(see [`crate::jsonb_gin::extract_tokens`])
3109    /// to row locators so the planner can resolve
3110    /// `<col> @> <jsonb_literal>` to a candidate row set via
3111    /// posting-list intersection + per-row `json::contains`
3112    /// re-verification. Pre-7.37.8 the same DDL loaded as a
3113    /// BTree fallback so `pg_dump` JSONB-GIN scripts kept loading
3114    /// without query-time acceleration. Persisted via tag-6 index
3115    /// payload in `FILE_VERSION` 51+.
3116    GinJsonb(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3117    /// v7.38.1 (L12) — a REAL multi-column B-tree: the key is the whole
3118    /// column tuple, `[leading, extras…]`, ordered lexicographically by
3119    /// slice `Ord`. That ordering is the entire design: every key
3120    /// sharing a prefix is contiguous, so an equality on a PREFIX of
3121    /// the columns is one `O(log N)` descent plus a bounded walk, and a
3122    /// full-tuple equality is a point `get`. The single-column `BTree`
3123    /// kind used to stand in for multi-column DDL by keying on the
3124    /// leading column only and carrying the rest as metadata — TPC-C's
3125    /// `customer (c_w_id, c_d_id, c_last, c_first)` then answered a
3126    /// three-column equality with every row of one warehouse and a
3127    /// per-row filter over 30 000 candidates.
3128    ///
3129    /// Rows where any component column is NULL (or of an unkeyable
3130    /// type) are NOT entered: this index serves `=` probes, and in SQL
3131    /// `col = v` never selects a NULL. Uniqueness keeps its own
3132    /// full-tuple walk with NULLS-DISTINCT semantics on the
3133    /// enforcement path, exactly as before.
3134    ///
3135    /// Persisted via tag-7 index payload in `FILE_VERSION` 91+.
3136    BTreeMulti(PersistentBTreeMap<alloc::boxed::Box<[IndexKey]>, crate::posting::PostingList>),
3137}
3138
3139impl IndexKind {
3140    /// v7.31 (memory campaign, C2) — bytes this index variant holds
3141    /// resident in RAM, computed by walking its OWN structure rather
3142    /// than a parametric guess made by the engine. Replaces the old
3143    /// `spg_admin::memory_stats` inline match, which charged NSW with
3144    /// a stale `m_max_0 * 8` per node (neighbour slots are `u32` = 4 B
3145    /// since v6.1.x, and most nodes never fill `m_max_0`) and lumped
3146    /// every GIN family index into a flat 1 KiB token — a gross
3147    /// undercount for the text-heavy posting lists that dominate
3148    /// mailrs' footprint. Per-entry container overhead uses the
3149    /// 3-word (24 B on 64-bit) `Vec`/`String` header as the charge.
3150    ///
3151    /// O(index entries): operator/monitoring surface (`memory_stats` /
3152    /// `spg_memory_stats`), not a query path.
3153    #[must_use]
3154    pub fn approx_resident_bytes(&self) -> u64 {
3155        const HEADER: usize = 24; // Vec/String 3-word header on 64-bit.
3156        let loc = core::mem::size_of::<RowLocator>();
3157        match self {
3158            IndexKind::BTree(map) => {
3159                let key = core::mem::size_of::<IndexKey>();
3160                map.iter()
3161                    .map(|(_, locs)| (key + HEADER + locs.len() * loc) as u64)
3162                    .sum()
3163            }
3164            // v7.38.1 (L12) — multi keys own a boxed slice of components.
3165            IndexKind::BTreeMulti(map) => {
3166                let key = core::mem::size_of::<IndexKey>();
3167                map.iter()
3168                    .map(|(k, locs)| (HEADER + k.len() * key + HEADER + locs.len() * loc) as u64)
3169                    .sum()
3170            }
3171            IndexKind::Nsw(g) => {
3172                // `levels` is one byte per node; each layer's adjacency
3173                // is a `Vec<u32>` per node whose actual length we walk
3174                // (the dense layer-0 list dominates, but upper layers
3175                // are sparse — the old estimate ignored that).
3176                let mut b = g.levels.len() as u64;
3177                for layer in &g.layers {
3178                    for nbrs in layer.iter() {
3179                        b += (HEADER + nbrs.len() * core::mem::size_of::<u32>()) as u64;
3180                    }
3181                }
3182                b
3183            }
3184            // BRIN carries NO in-memory key→locator map (the (min,max)
3185            // summaries live in cold-segment sidecars on disk); the
3186            // resident footprint is just the column-type token.
3187            IndexKind::Brin { .. } => core::mem::size_of::<DataType>() as u64,
3188            IndexKind::Gin(map)
3189            | IndexKind::GinTrgm(map)
3190            | IndexKind::GinFulltext(map)
3191            | IndexKind::GinJsonb(map) => map
3192                .iter()
3193                .map(|(word, postings)| {
3194                    (word.len() + HEADER + HEADER + postings.len() * loc) as u64
3195                })
3196                .sum(),
3197        }
3198    }
3199}
3200
3201/// Multi-layer HNSW graph (v2.13). Each node is assigned a `top_level`;
3202/// it appears in layers `0..=top_level`. Higher layers are sparser, so
3203/// search starts from the entry at the top layer, greedy-descends to
3204/// layer 0, and beam-searches there. Layer 0 keeps a larger neighbour
3205/// budget (`m_max_0 = 2 * m` per the HNSW paper); upper layers cap at
3206/// `m`. The struct name stays `NswGraph` so external users / on-disk
3207/// callers don't have to track a rename — the algorithm changed, the
3208/// data slot didn't.
3209#[derive(Debug, Clone)]
3210pub struct NswGraph {
3211    /// Max neighbours per node on layers ≥ 1.
3212    pub m: usize,
3213    /// Max neighbours on layer 0 (the dense bottom layer). HNSW
3214    /// convention: `m_max_0 = 2 * m`.
3215    pub m_max_0: usize,
3216    /// Entry point — the node that sits on the topmost layer. Search
3217    /// always starts here.
3218    pub entry: Option<usize>,
3219    /// Top layer of the entry node (== `layers.len() - 1` when populated).
3220    pub entry_level: u8,
3221    /// `levels[i]` = top layer of node `i`. Nodes whose vector cell is
3222    /// NULL / non-Vector have `levels[i] = 0` and no neighbour entries.
3223    ///
3224    /// v5.5.0: backed by `PersistentVec` so `NswGraph::clone` (and the
3225    /// `Catalog::clone` on every group-commit write that contains it) is O(1)
3226    /// structural-sharing instead of an O(N) element copy.
3227    pub levels: PersistentVec<u8>,
3228    /// `layers[l][i]` = neighbours of node `i` at layer `l`. Inner vec
3229    /// is empty when node `i` doesn't reach layer `l`.
3230    ///
3231    /// v5.5.0: the per-node middle dimension (the O(N) one) is a
3232    /// `PersistentVec`; the outer layer dimension stays a plain `Vec`
3233    /// (layer count ≤ 8, so its clone is O(1) in practice) and the inner
3234    /// neighbour list stays a `Vec` (bounded by `m_max_0`).
3235    ///
3236    /// v6.1.x: neighbour slot widened from `usize` (8 B on 64-bit) to
3237    /// `u32` (4 B). Row indices are catalog-bounded by `u32::MAX` (4G
3238    /// rows per table); the cast at the NSW boundary asserts this. At
3239    /// 1M dim-128 SQ8, layer 0 adjacency alone shrinks by ~128 MiB
3240    /// — the largest single contribution to the v6.0.5-measured
3241    /// 624 MiB ambition gap. On-disk format already used u32 LE, so
3242    /// this is a pure in-memory layout change; no `FILE_VERSION` bump.
3243    pub layers: Vec<PersistentVec<Vec<u32>>>,
3244}
3245
3246impl NswGraph {
3247    fn new(m: usize) -> Self {
3248        Self {
3249            m,
3250            m_max_0: m.saturating_mul(2),
3251            entry: None,
3252            entry_level: 0,
3253            levels: PersistentVec::new(),
3254            layers: alloc::vec![PersistentVec::new()],
3255        }
3256    }
3257
3258    /// Max-neighbour budget for layer `l`.
3259    pub const fn cap_for_layer(&self, layer: u8) -> usize {
3260        if layer == 0 { self.m_max_0 } else { self.m }
3261    }
3262}
3263
3264/// Deterministic level assignment, seeded on the row index so the same
3265/// insert order reproduces the same topology. Distribution is roughly
3266/// HNSW-flavoured with `mL ≈ 1/ln(M) ≈ 0.36` for M=16: each 4-bit
3267/// chunk that comes up zero promotes the node one layer (so P(level ≥
3268/// L) ≈ (1/16)^L).
3269#[allow(clippy::verbose_bit_mask)] // clippy suggests trailing_zeros(); we need an explicit MAX cap and a stable distribution shape.
3270pub fn nsw_assign_level(row_idx: usize) -> u8 {
3271    const MAX_LEVEL: u8 = 7; // 7 ⇒ ~16^7 ≈ 2.7e8 expected nodes between promotions; ample.
3272    // SplitMix-style mixer — cheap and seedable.
3273    let mut x = (row_idx as u64).wrapping_mul(0x9E37_79B9_7F4A_7C15);
3274    x ^= x >> 30;
3275    x = x.wrapping_mul(0xBF58_476D_1CE4_E5B9);
3276    x ^= x >> 27;
3277    x = x.wrapping_mul(0x94D0_49BB_1331_11EB);
3278    x ^= x >> 31;
3279    // Count contiguous low-end zero nibbles (4-bit chunks). Each zero
3280    // nibble has probability 1/16, mirroring HNSW's `mL ≈ 1/ln(M)` for
3281    // M=16. `trailing_zeros / 4` would lose the ordering when x = 0, so
3282    // a plain loop with a cap is clearer.
3283    let mut level: u8 = 0;
3284    while x & 0xF == 0 && level < MAX_LEVEL {
3285        level += 1;
3286        x >>= 4;
3287    }
3288    level
3289}
3290
3291/// v7.38.1 (L12) — the composite key `values` takes in a multi-column
3292/// B-tree over `[lead, extras…]`. A NULL component keys as
3293/// [`IndexKey::Null`] (declared to sort last, PG's NULLS LAST) so the
3294/// row stays findable by prefix probes on the columns before it. `None`
3295/// = some non-null component has no key form; the row is then not
3296/// entered, which is why creation gates every component column's type
3297/// through [`multi_component_type_ok`].
3298pub(crate) fn compose_multi_key(
3299    values: &[Value<'_>],
3300    lead: usize,
3301    extras: &[usize],
3302) -> Option<alloc::boxed::Box<[IndexKey]>> {
3303    let mut comps: Vec<IndexKey> = Vec::with_capacity(1 + extras.len());
3304    for pos in core::iter::once(lead).chain(extras.iter().copied()) {
3305        let v = values.get(pos)?;
3306        if matches!(v, Value::Null) {
3307            comps.push(IndexKey::Null);
3308        } else {
3309            comps.push(IndexKey::from_value(v)?);
3310        }
3311    }
3312    Some(comps.into_boxed_slice())
3313}
3314
3315/// v7.38.1 (L12) — component-type gate for multi-column B-trees: every
3316/// NON-NULL value of these types keys through `IndexKey::from_value`,
3317/// so a row can only be absent from the index when creation raced a
3318/// type this list does not name. Deliberately conservative — a type
3319/// outside the list simply keeps its index on the leading-column path.
3320pub(crate) fn multi_component_type_ok(ty: DataType) -> bool {
3321    matches!(
3322        ty,
3323        DataType::SmallInt
3324            | DataType::Int
3325            | DataType::BigInt
3326            | DataType::Text
3327            | DataType::Varchar(_)
3328            | DataType::Char(_)
3329            | DataType::Bool
3330            | DataType::Uuid
3331            | DataType::Date
3332            | DataType::Timestamp
3333    )
3334}
3335
3336impl Index {
3337    fn new_btree(name: String, column_position: usize) -> Self {
3338        Self {
3339            name,
3340            column_position,
3341            kind: IndexKind::BTree(PersistentBTreeMap::new()),
3342            included_columns: Vec::new(),
3343            partial_predicate: None,
3344            expression: None,
3345            is_unique: false,
3346            nulls_not_distinct: false,
3347            descending: false,
3348            nulls_first: None,
3349            collation: None,
3350            extra_column_positions: Vec::new(),
3351        }
3352    }
3353
3354    /// v7.38.1 (L12) — a real multi-column B-tree shell. The caller
3355    /// sets `extra_column_positions` before the first row enters; the
3356    /// key arity is `1 + extras` from then on.
3357    fn new_btree_multi(name: String, column_position: usize) -> Self {
3358        Self {
3359            kind: IndexKind::BTreeMulti(PersistentBTreeMap::new()),
3360            ..Self::new_btree(name, column_position)
3361        }
3362    }
3363
3364    /// v7.38.1 (L12) — the composite key this row takes in a
3365    /// [`IndexKind::BTreeMulti`] index. NULL components key as
3366    /// [`IndexKey::Null`] so prefix probes still find the row; `None`
3367    /// only when a non-null component produces no key, which creation's
3368    /// component-type gate makes unreachable for well-formed indexes.
3369    pub fn multi_key_for_row(&self, values: &[Value<'_>]) -> Option<alloc::boxed::Box<[IndexKey]>> {
3370        compose_multi_key(values, self.column_position, &self.extra_column_positions)
3371    }
3372
3373    fn new_nsw(name: String, column_position: usize, m: usize) -> Self {
3374        Self {
3375            name,
3376            column_position,
3377            kind: IndexKind::Nsw(NswGraph::new(m)),
3378            included_columns: Vec::new(),
3379            partial_predicate: None,
3380            expression: None,
3381            is_unique: false,
3382            nulls_not_distinct: false,
3383            descending: false,
3384            nulls_first: None,
3385            collation: None,
3386            extra_column_positions: Vec::new(),
3387        }
3388    }
3389
3390    /// v6.7.1 — BRIN index constructor. BRIN carries no in-memory
3391    /// data; the `column_type` snapshot is used by the segment
3392    /// encoder + planner for type-checking range predicates.
3393    fn new_brin(name: String, column_position: usize, column_type: DataType) -> Self {
3394        Self {
3395            name,
3396            column_position,
3397            kind: IndexKind::Brin { column_type },
3398            included_columns: Vec::new(),
3399            partial_predicate: None,
3400            expression: None,
3401            is_unique: false,
3402            nulls_not_distinct: false,
3403            descending: false,
3404            nulls_first: None,
3405            collation: None,
3406            extra_column_positions: Vec::new(),
3407        }
3408    }
3409
3410    /// v7.12.3 — GIN inverted-index constructor. Empty posting-list
3411    /// map; caller (typically [`Table::add_gin_index`] or
3412    /// [`Table::restore_gin_index`]) populates it from existing rows
3413    /// or from a deserialised snapshot.
3414    fn new_gin(name: String, column_position: usize) -> Self {
3415        Self {
3416            name,
3417            column_position,
3418            kind: IndexKind::Gin(PersistentBTreeMap::new()),
3419            included_columns: Vec::new(),
3420            partial_predicate: None,
3421            expression: None,
3422            is_unique: false,
3423            nulls_not_distinct: false,
3424            descending: false,
3425            nulls_first: None,
3426            collation: None,
3427            extra_column_positions: Vec::new(),
3428        }
3429    }
3430
3431    /// v7.15.0 — `gin_trgm_ops`-flavoured GIN constructor. Same
3432    /// shape as `new_gin` but the posting-list keys are 3-byte
3433    /// trigram shingles (`pg_trgm`-compatible) and the column
3434    /// type is `TEXT` / `VARCHAR` (not `TSVECTOR`).
3435    fn new_gin_trgm(name: String, column_position: usize) -> Self {
3436        Self {
3437            name,
3438            column_position,
3439            kind: IndexKind::GinTrgm(PersistentBTreeMap::new()),
3440            included_columns: Vec::new(),
3441            partial_predicate: None,
3442            expression: None,
3443            is_unique: false,
3444            nulls_not_distinct: false,
3445            descending: false,
3446            nulls_first: None,
3447            collation: None,
3448            extra_column_positions: Vec::new(),
3449        }
3450    }
3451
3452    /// v7.17.0 Phase 2.2 — MySQL `FULLTEXT KEY` GIN constructor.
3453    /// Same shape as `new_gin_trgm` but the posting-list keys
3454    /// are lower-cased word lexemes (`to_tsvector('simple', col)`
3455    /// equivalent) instead of trigrams, and the column type is
3456    /// `TEXT` / `VARCHAR` (not `TSVECTOR`).
3457    fn new_gin_fulltext(name: String, column_position: usize) -> Self {
3458        Self {
3459            name,
3460            column_position,
3461            kind: IndexKind::GinFulltext(PersistentBTreeMap::new()),
3462            included_columns: Vec::new(),
3463            partial_predicate: None,
3464            expression: None,
3465            is_unique: false,
3466            nulls_not_distinct: false,
3467            descending: false,
3468            nulls_first: None,
3469            collation: None,
3470            extra_column_positions: Vec::new(),
3471        }
3472    }
3473
3474    /// v7.37.8(sentori Epic 5 P2)— JSONB-GIN constructor. Same
3475    /// shape as the other GIN-family indexes; posting-list keys
3476    /// are the canonical `(path, leaf)` tokens emitted by
3477    /// `crate::jsonb_gin::extract_tokens`. Maintains posting
3478    /// lists from `Value::Json` cells(JSONB is a synonym for the
3479    /// same in-memory string-backed Value).
3480    fn new_gin_jsonb(name: String, column_position: usize) -> Self {
3481        Self {
3482            name,
3483            column_position,
3484            kind: IndexKind::GinJsonb(PersistentBTreeMap::new()),
3485            included_columns: Vec::new(),
3486            partial_predicate: None,
3487            expression: None,
3488            is_unique: false,
3489            nulls_not_distinct: false,
3490            descending: false,
3491            nulls_first: None,
3492            collation: None,
3493            extra_column_positions: Vec::new(),
3494        }
3495    }
3496
3497    /// v7.34.4 — descending-order iterator over `(IndexKey, locators)`
3498    /// pairs for a BTree index, with O(log N) descent to the rightmost
3499    /// leaf and lazy emission thereafter. Returns an empty iterator
3500    /// for non-BTree index kinds — callers handle both uniformly.
3501    /// Used by the ORDER BY `<indexed col>` DESC + LIMIT N executor
3502    /// path: walking only the first N matches off the rightmost leaf
3503    /// avoids the per-row materialisation + partial-sort cost on
3504    /// large tables (mailrs `content_worker` at 250 k rows).
3505    pub fn iter_desc(
3506        &self,
3507    ) -> alloc::boxed::Box<dyn Iterator<Item = (&IndexKey, &crate::posting::PostingList)> + '_>
3508    {
3509        match &self.kind {
3510            IndexKind::BTree(m) => alloc::boxed::Box::new(m.iter_rev()),
3511            // v7.38.1 (L12) — projecting the leading component of a
3512            // composite key preserves order: keys sort by the whole
3513            // tuple, so the leading component is non-increasing here
3514            // (non-decreasing in iter_asc), exactly what an ORDER BY
3515            // on the leading column needs.
3516            IndexKind::BTreeMulti(m) => {
3517                alloc::boxed::Box::new(m.iter_rev().map(|(k, l)| (&k[0], l)))
3518            }
3519            IndexKind::Nsw(_)
3520            | IndexKind::Brin { .. }
3521            | IndexKind::Gin(_)
3522            | IndexKind::GinTrgm(_)
3523            | IndexKind::GinFulltext(_)
3524            | IndexKind::GinJsonb(_) => alloc::boxed::Box::new(core::iter::empty()),
3525        }
3526    }
3527
3528    /// v7.34.4 — ascending-order iterator over `(IndexKey, locators)`
3529    /// pairs. Mirror of `iter_desc` for ORDER BY ... ASC + LIMIT N.
3530    pub fn iter_asc(
3531        &self,
3532    ) -> alloc::boxed::Box<dyn Iterator<Item = (&IndexKey, &crate::posting::PostingList)> + '_>
3533    {
3534        match &self.kind {
3535            IndexKind::BTree(m) => alloc::boxed::Box::new(m.iter()),
3536            // v7.38.1 (L12) — see iter_desc: the leading component of
3537            // a tuple-sorted walk is itself in order.
3538            IndexKind::BTreeMulti(m) => alloc::boxed::Box::new(m.iter().map(|(k, l)| (&k[0], l))),
3539            IndexKind::Nsw(_)
3540            | IndexKind::Brin { .. }
3541            | IndexKind::Gin(_)
3542            | IndexKind::GinTrgm(_)
3543            | IndexKind::GinFulltext(_)
3544            | IndexKind::GinJsonb(_) => alloc::boxed::Box::new(core::iter::empty()),
3545        }
3546    }
3547
3548    /// Look up the locators stored under `key` (B-tree only). Returns
3549    /// an empty slice when the key is absent or the index isn't a
3550    /// BTree — callers can treat both cases uniformly.
3551    ///
3552    /// v5.1: return type widened from `&[usize]` to `&[RowLocator]`.
3553    /// Pre-v5.2 callers can read the slice and `.as_hot().unwrap()`
3554    /// each entry (no `Cold` variants exist until the freezer lands);
3555    /// post-v5.2 callers dispatch hot vs. cold per locator.
3556    pub fn lookup_eq(&self, key: &IndexKey) -> &crate::posting::PostingList {
3557        match &self.kind {
3558            IndexKind::BTree(m) => m.get(key).map_or(&EMPTY_POSTINGS, |l| l),
3559            // BRIN / NSW / GIN / trigram-GIN / fulltext-GIN have
3560            // no IndexKey-keyed map; lookup is a no-op. GIN uses
3561            // [`Index::gin_lookup_word`] instead.
3562            IndexKind::Nsw(_)
3563            | IndexKind::Brin { .. }
3564            | IndexKind::Gin(_)
3565            | IndexKind::GinTrgm(_)
3566            | IndexKind::GinFulltext(_)
3567            | IndexKind::GinJsonb(_)
3568            | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3569        }
3570    }
3571
3572    /// v7.37.43 (INSUBQ B-2) — specialised lookup for integer-PK probes.
3573    /// `try_count_star_pk_in_subquery_fast` already holds an `i64` (the
3574    /// inner survivor key); skip the `IndexKey::from_value` enum-dispatch
3575    /// trip and build the key inline. ~20 ns × N_survivors saved on
3576    /// the INSUBQ hot loop.
3577    #[inline]
3578    pub fn lookup_eq_i64(&self, n: i64) -> &crate::posting::PostingList {
3579        match &self.kind {
3580            IndexKind::BTree(m) => m.get(&IndexKey::Int(n)).map_or(&EMPTY_POSTINGS, |l| l),
3581            IndexKind::Nsw(_)
3582            | IndexKind::Brin { .. }
3583            | IndexKind::Gin(_)
3584            | IndexKind::GinTrgm(_)
3585            | IndexKind::GinFulltext(_)
3586            | IndexKind::GinJsonb(_)
3587            | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3588        }
3589    }
3590
3591    /// v7.38 (perf, index range scan) — flatten the row locators for every key
3592    /// in `[lo, hi]` (bounds per `core::ops::Bound`) via the BTree's `O(log N +
3593    /// k)` range walk. Returns `None` once more than `cap` locators accumulate
3594    /// — a "this range isn't selective enough, seq-scan instead" signal that
3595    /// stops a wide range from materialising a near-full table's worth of rows
3596    /// through the index. BTree only (other kinds → None).
3597    pub fn lookup_range_capped(
3598        &self,
3599        lo: core::ops::Bound<&IndexKey>,
3600        hi: core::ops::Bound<&IndexKey>,
3601        cap: usize,
3602    ) -> Option<Vec<RowLocator>> {
3603        self.lookup_range_capped_by(lo, hi, cap, |_| true)
3604    }
3605
3606    /// v7.39 (round 490) — the same range walk, but the caller decides
3607    /// which locators are worth carrying, and the cap counts only those.
3608    ///
3609    /// A BTree index holds one locator per row VERSION. On a churned table
3610    /// the dead versions are still in there: round 490 measured a
3611    /// 1000-row range handing back 61 000 locators after 60
3612    /// delete-and-reinsert cycles with the background vacuum switched off.
3613    /// Every caller then dropped the dead ones — the mutation paths and the
3614    /// SELECT range path all test `is_row_visible` and `continue` — but only
3615    /// after they had been collected into a `Vec`, sorted, and walked.
3616    ///
3617    /// Handing the predicate down means the walk keeps ~1000, and the cap
3618    /// (which exists so an index walk never costs more than the scan it
3619    /// replaces) is once again measured in rows a caller will actually look
3620    /// at. Round 461 had to add the dead count to the budget to stop the
3621    /// seek being refused outright; with the filter here that compensation
3622    /// is no longer needed.
3623    pub fn lookup_range_capped_by(
3624        &self,
3625        lo: core::ops::Bound<&IndexKey>,
3626        hi: core::ops::Bound<&IndexKey>,
3627        cap: usize,
3628        keep: impl Fn(RowLocator) -> bool,
3629    ) -> Option<Vec<RowLocator>> {
3630        match &self.kind {
3631            IndexKind::BTree(m) => {
3632                let mut out: Vec<RowLocator> = Vec::new();
3633                for (_, locs) in m.range(lo, hi) {
3634                    out.extend(locs.iter().copied().filter(|l| keep(*l)));
3635                    if out.len() > cap {
3636                        return None;
3637                    }
3638                }
3639                Some(out)
3640            }
3641            IndexKind::Nsw(_)
3642            | IndexKind::Brin { .. }
3643            | IndexKind::Gin(_)
3644            | IndexKind::GinTrgm(_)
3645            | IndexKind::GinFulltext(_)
3646            | IndexKind::GinJsonb(_)
3647            | IndexKind::BTreeMulti(_) => None,
3648        }
3649    }
3650
3651    /// v7.38.1 (L12) — full-tuple point lookup on a [`IndexKind::BTreeMulti`]
3652    /// index. `key` must carry exactly as many components as the index
3653    /// has columns; anything else (including a probe against a
3654    /// non-multi index) finds nothing, and "nothing" here is safe
3655    /// because the caller falls back to a scan, never to an answer.
3656    pub fn lookup_eq_multi(&self, key: &[IndexKey]) -> &crate::posting::PostingList {
3657        match &self.kind {
3658            IndexKind::BTreeMulti(m) if key.len() == 1 + self.extra_column_positions.len() => {
3659                m.get_by(key).map_or(&EMPTY_POSTINGS, |l| l)
3660            }
3661            _ => &EMPTY_POSTINGS,
3662        }
3663    }
3664
3665    /// v7.38.1 (L12) — locators for every key whose leading components
3666    /// equal `prefix`, on a [`IndexKind::BTreeMulti`] index. Slice
3667    /// ordering keeps a prefix's keys contiguous, so this is one
3668    /// descent to `[prefix]` and a walk that stops at the first key
3669    /// leaving the prefix. Same cap/keep contract as
3670    /// [`Index::lookup_range_capped_by`]: `None` = not selective
3671    /// enough (or not a multi index), fall back.
3672    pub fn lookup_prefix_capped_by(
3673        &self,
3674        prefix: &[IndexKey],
3675        cap: usize,
3676        keep: impl Fn(RowLocator) -> bool,
3677    ) -> Option<Vec<RowLocator>> {
3678        let IndexKind::BTreeMulti(m) = &self.kind else {
3679            return None;
3680        };
3681        if prefix.is_empty() || prefix.len() > 1 + self.extra_column_positions.len() {
3682            return None;
3683        }
3684        let lo: alloc::boxed::Box<[IndexKey]> = prefix.to_vec().into_boxed_slice();
3685        let mut out: Vec<RowLocator> = Vec::new();
3686        for (k, locs) in m.range(core::ops::Bound::Included(&lo), core::ops::Bound::Unbounded) {
3687            if k.len() < prefix.len() || k[..prefix.len()] != *prefix {
3688                break;
3689            }
3690            out.extend(locs.iter().copied().filter(|l| keep(*l)));
3691            if out.len() > cap {
3692                return None;
3693            }
3694        }
3695        Some(out)
3696    }
3697
3698    /// v7.39 (round 560) — the index range as (key, locator) pairs.
3699    ///
3700    /// `lookup_range_capped_by` throws the KEY away and returns only
3701    /// locators, so a query whose projection is exactly the indexed
3702    /// column still goes to the row store for a value the walk already
3703    /// had in hand — paying per row for something the index knows.
3704    ///
3705    /// Uncapped on purpose: an index-only walk touches no row, so the
3706    /// selectivity ceiling that keeps a seek from being worse than the
3707    /// scan it replaces does not apply to it.
3708    ///
3709    /// v7.39 (round 562) — and it does not collect, either. This
3710    /// returned a `Vec<(IndexKey, RowLocator)>`: for a 100k-row range,
3711    /// 100k key clones into a `Vec::new()` that doubles its way up to
3712    /// several MB, all to be walked once and dropped. A profile of the
3713    /// server serving that query put 20% of the connection thread's CPU
3714    /// on the collect alone, with another 18% in the allocator beside
3715    /// it. The caller consumes the pairs in order and needs the key
3716    /// only by reference, so it can have the walk itself.
3717    pub fn range_keyed(
3718        &self,
3719        lo: core::ops::Bound<&IndexKey>,
3720        hi: core::ops::Bound<&IndexKey>,
3721    ) -> Option<impl Iterator<Item = (&IndexKey, RowLocator)> + '_> {
3722        match &self.kind {
3723            IndexKind::BTree(m) => Some(
3724                m.range(lo, hi)
3725                    .flat_map(|(k, locs)| locs.iter().map(move |l| (k, *l))),
3726            ),
3727            IndexKind::Nsw(_)
3728            | IndexKind::Brin { .. }
3729            | IndexKind::Gin(_)
3730            | IndexKind::GinTrgm(_)
3731            | IndexKind::GinFulltext(_)
3732            | IndexKind::GinJsonb(_)
3733            | IndexKind::BTreeMulti(_) => None,
3734        }
3735    }
3736
3737    /// v7.12.3 — GIN posting-list lookup. Returns the row locators
3738    /// whose `tsvector` cell contains `word`. Empty when the word is
3739    /// absent from the index or this isn't a GIN index.
3740    pub fn gin_lookup_word(&self, word: &str) -> &crate::posting::PostingList {
3741        match &self.kind {
3742            // v7.17.0 Phase 2.2 — fulltext-GIN shares the same
3743            // lexeme-keyed posting list shape as the
3744            // tsvector-typed GIN, so the same lookup applies.
3745            IndexKind::Gin(m) | IndexKind::GinFulltext(m) => {
3746                m.get(&String::from(word)).map_or(&EMPTY_POSTINGS, |l| l)
3747            }
3748            IndexKind::BTree(_)
3749            | IndexKind::Nsw(_)
3750            | IndexKind::Brin { .. }
3751            | IndexKind::GinTrgm(_)
3752            | IndexKind::GinJsonb(_)
3753            | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3754        }
3755    }
3756
3757    /// v7.15.0 — trigram-GIN posting-list lookup. Returns the row
3758    /// locators whose indexed `TEXT` cell contains the trigram
3759    /// `tri`. Empty when the trigram is absent or this isn't a
3760    /// trigram-GIN index.
3761    pub fn gin_trgm_lookup(&self, tri: &str) -> &crate::posting::PostingList {
3762        match &self.kind {
3763            IndexKind::GinTrgm(m) => m.get(&String::from(tri)).map_or(&EMPTY_POSTINGS, |l| l),
3764            IndexKind::BTree(_)
3765            | IndexKind::Nsw(_)
3766            | IndexKind::Brin { .. }
3767            | IndexKind::Gin(_)
3768            | IndexKind::GinFulltext(_)
3769            | IndexKind::GinJsonb(_)
3770            | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3771        }
3772    }
3773
3774    /// v7.37.8(sentori Epic 5 P2)— JSONB-GIN posting-list lookup.
3775    /// Returns the row locators whose indexed JSONB cell carries
3776    /// the canonical `token`(see [`crate::jsonb_gin::extract_tokens`]).
3777    /// Empty when the token is absent or this isn't a JSONB-GIN
3778    /// index. Planners drive `<col> @> <jsonb_literal>` through here.
3779    pub fn gin_jsonb_lookup(&self, token: &str) -> &crate::posting::PostingList {
3780        match &self.kind {
3781            IndexKind::GinJsonb(m) => m.get(&String::from(token)).map_or(&EMPTY_POSTINGS, |l| l),
3782            IndexKind::BTree(_)
3783            | IndexKind::Nsw(_)
3784            | IndexKind::Brin { .. }
3785            | IndexKind::Gin(_)
3786            | IndexKind::GinTrgm(_)
3787            | IndexKind::GinFulltext(_)
3788            | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3789        }
3790    }
3791
3792    /// Borrow the NSW graph (if this is an NSW index). Callers that need
3793    /// the graph for a kNN search go through here.
3794    pub const fn nsw(&self) -> Option<&NswGraph> {
3795        match &self.kind {
3796            IndexKind::Nsw(g) => Some(g),
3797            IndexKind::BTree(_)
3798            | IndexKind::Brin { .. }
3799            | IndexKind::Gin(_)
3800            | IndexKind::GinTrgm(_)
3801            | IndexKind::GinFulltext(_)
3802            | IndexKind::GinJsonb(_)
3803            | IndexKind::BTreeMulti(_) => None,
3804        }
3805    }
3806
3807    /// v6.7.1 — true when this index is a BRIN (block range) index.
3808    /// Used by the segment encoder to opt into BRIN sidecar emission
3809    /// at freeze time, and by the planner to opt into page-skipping
3810    /// on range predicates.
3811    pub const fn is_brin(&self) -> bool {
3812        matches!(self.kind, IndexKind::Brin { .. })
3813    }
3814
3815    /// v7.15.0 — true when this index is a trigram GIN
3816    /// (`gin_trgm_ops`-flavoured). Used by the LIKE planner to
3817    /// opt into trigram acceleration.
3818    pub const fn is_gin_trgm(&self) -> bool {
3819        matches!(self.kind, IndexKind::GinTrgm(_))
3820    }
3821
3822    /// v7.12.3 — true when this index is a GIN inverted index.
3823    /// Used by the planner to opt into posting-list acceleration on
3824    /// `WHERE col @@ tsquery` predicates.
3825    pub const fn is_gin(&self) -> bool {
3826        matches!(self.kind, IndexKind::Gin(_))
3827    }
3828
3829    /// v7.17.0 Phase 2.2 — true when this index is a fulltext
3830    /// GIN over a TEXT / VARCHAR column (MySQL `FULLTEXT KEY`
3831    /// surface). Used by the planner to opt the FULLTEXT-indexed
3832    /// column into MATCH AGAINST acceleration.
3833    pub const fn is_gin_fulltext(&self) -> bool {
3834        matches!(self.kind, IndexKind::GinFulltext(_))
3835    }
3836
3837    /// v7.37.8(sentori Epic 5 P2)— true when this index is a
3838    /// real JSONB-GIN(posting-list backed). Used by the planner
3839    /// to opt `<col> @> <jsonb_literal>` into posting-list seek.
3840    pub const fn is_gin_jsonb(&self) -> bool {
3841        matches!(self.kind, IndexKind::GinJsonb(_))
3842    }
3843}
3844
3845/// In-memory table: schema + a persistent row vector + secondary indices.
3846///
3847/// v4.39: `rows` is a [`PersistentVec`] (Bitmapped Vector Trie, 32-way) so
3848/// `Table::clone()` is `O(1)` — the whole reason for v4.39's existence is
3849/// to make `Catalog::clone()` cheap inside the v4.34 auto-commit wrap.
3850///
3851/// v5.2.1: `hot_bytes` tracks the encoded byte size of every row currently
3852/// in [`Self::rows`], summed over rows. Updated incrementally by `insert`
3853/// (+= encoded row size), `delete_rows` (-= removed rows' encoded sizes),
3854/// and `update_row` (-= old size, += new size). The value is what the
3855/// v5.2 freezer reads to decide when to demote cold rows — when the
3856/// catalog-wide sum crosses `SPG_HOT_TIER_BYTES` (default 4 GiB) the
3857/// freezer thread wakes. v5.2.1 ships measurement only; the freezer
3858/// itself lands in v5.2.2. Stored as `u64` so a single field clone in
3859/// `Catalog::clone` stays at the O(1) invariant v4.39 built.
3860/// v7.34 (crash-recovery P0 #2) — one row-level physical redo record.
3861/// Row-level redo replaces statement-based WAL replay (which re-executes
3862/// each SQL through the full engine — O(records × catalog_rows), the
3863/// superlinear recovery hang root-caused on the mailrs crash-recovery
3864/// P0). A `RowChange` is the exact storage mutation the engine applied
3865/// (`Table::insert` / `update_row` / `delete_rows`); replaying it on a
3866/// catalog restored from the matching checkpoint reproduces the state
3867/// WITHOUT re-validating uniqueness/FK/parse/plan — O(changed rows).
3868///
3869/// Positions are physical, not key-based: `serialize`/`deserialize`
3870/// preserve row order exactly (rows written + read back in `self.rows`
3871/// order) and the mutation ops are deterministic, so the same op sequence
3872/// replayed from the same checkpoint reproduces the same positions. This
3873/// matches PostgreSQL's physical redo and supports tables with no primary
3874/// key. (Caveat handled at replay integration: a post-checkpoint cold-tier
3875/// freeze shifts hot positions and must itself be logged or fenced by a
3876/// checkpoint — see `row-level-redo-design`.)
3877/// ## v7.37.15 (Epic W slice 1) — additive MVCC identity metadata
3878///
3879/// Each variant now also carries, additively, the stable
3880/// [`RowId`](row_header::RowId) of the affected row(s) and the
3881/// **writer version** (`xmin` for an insert, `xmax` for a
3882/// delete/update). This is the codec foundation for making
3883/// in-place MVCC tombstones durable across crash/upgrade recovery.
3884///
3885/// Two important properties for the durability path:
3886///
3887/// 1. **Replay resolution is UNCHANGED.** `apply_redo_run_on_table`
3888///    still resolves every change by physical `pos`/`positions`
3889///    exactly as before. The new metadata is *carried but unused*
3890///    by replay in this slice; resolving-by-`RowId` and
3891///    header-preserving replay are later slices.
3892/// 2. **Backward compatibility.** A redo payload written by
3893///    pre-Epic-W code carries no metadata; [`decode_redo_log`]
3894///    fills `rowid`/`rowids` with [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED)
3895///    (empty for `Delete`) and `writer_version` with `0`. See the
3896///    codec version gate in [`encode_redo_log`]/[`decode_redo_log`].
3897///
3898/// The `writer_version` is captured as `0` at the storage layer
3899/// (`Table::insert`/`delete_rows`/`update_row` don't have the
3900/// committing `TxId`), then **stamped with the real committing
3901/// version by the engine** after it drains the statement's changes
3902/// (Epic W slice 2 — [`RowChange::set_writer_version`], driven from
3903/// `Engine::writer_version_for_current_stmt`). All changes from one
3904/// statement share the one version. Replay still resolves by
3905/// physical position and does not read `writer_version` — that is a
3906/// later slice (header-preserving replay).
3907#[derive(Debug, Clone, PartialEq)]
3908pub enum RowChange {
3909    /// Append `row` to `table`.
3910    Insert {
3911        table: String,
3912        row: Row<'static>,
3913        /// Epic W: stable id the appended row will receive.
3914        /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) when
3915        /// decoded from a pre-Epic-W redo payload.
3916        rowid: row_header::RowId,
3917        /// Epic W: writer version (`xmin`). `0` until the writing
3918        /// `TxId` is threaded to the storage layer (later slice).
3919        writer_version: u64,
3920    },
3921    /// Replace the row at physical `pos` in `table` with `new_row`.
3922    Update {
3923        table: String,
3924        pos: usize,
3925        new_row: Vec<Value<'static>>,
3926        /// Epic W: stable id of the row at `pos`.
3927        /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) when
3928        /// decoded from a pre-Epic-W redo payload.
3929        rowid: row_header::RowId,
3930        /// Epic W: writer version (`xmax` of the superseded tuple).
3931        /// `0` until the writing `TxId` is threaded (later slice).
3932        writer_version: u64,
3933    },
3934    /// Remove the rows at the given physical `positions` from `table`.
3935    Delete {
3936        table: String,
3937        positions: Vec<usize>,
3938        /// Epic W: stable ids parallel to `positions` (same length,
3939        /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) for an
3940        /// out-of-bounds input position). **Empty** when decoded from
3941        /// a pre-Epic-W redo payload (no metadata was recorded).
3942        rowids: Vec<row_header::RowId>,
3943        /// Epic W: writer version (`xmax`). `0` until the writing
3944        /// `TxId` is threaded to the storage layer (later slice).
3945        writer_version: u64,
3946    },
3947    /// v7.37.15 (Epic W durable-tombstone slice) — an **in-place MVCC
3948    /// delete**: the row(s) named by `rowids` are NOT physically
3949    /// removed; their header `xmax` is stamped so newer snapshots stop
3950    /// seeing them (vacuum reclaims later). This is the redo shape of
3951    /// the gate-on (`SPG_MVCC_INPLACE`) DELETE / UPDATE-old-version /
3952    /// ON-CONFLICT paths, which call [`Table::mark_row_deleted`]
3953    /// instead of `delete_rows`.
3954    ///
3955    /// Unlike `Delete`, the target is named by **stable `RowId`**, not
3956    /// physical position: a tombstone keeps the slot, so position would
3957    /// be ambiguous after later compaction, and the header-preserving
3958    /// replay must re-find the exact row the writer tombstoned. On
3959    /// replay the id is matched against the ids the same redo run
3960    /// produced (an `Insert`'s `rowid`, or the table's ids snapshotted
3961    /// at run start); an id that cannot be resolved is skipped and
3962    /// counted (see `apply_redo_run_on_table`) — this is the documented
3963    /// cross-checkpoint limitation until the V6 envelope persists ids.
3964    Tombstone {
3965        table: String,
3966        /// Stable ids of the tombstoned rows (from `self.rowids()[pos]`
3967        /// at capture). Never empty for a recorded tombstone.
3968        rowids: Vec<row_header::RowId>,
3969        /// The version stamped into each target row's header `xmax`
3970        /// (the deleting statement's writer version).
3971        xmax: u64,
3972    },
3973}
3974
3975impl RowChange {
3976    /// v7.39 (round 736) — which table this change applies to.
3977    #[must_use]
3978    pub fn table_name(&self) -> &str {
3979        match self {
3980            Self::Insert { table, .. }
3981            | Self::Update { table, .. }
3982            | Self::Delete { table, .. }
3983            | Self::Tombstone { table, .. } => table,
3984        }
3985    }
3986
3987    /// v7.37.15 (Epic W slice 2) — stamp the committing writer
3988    /// version onto this change. Every change drained from a single
3989    /// statement shares one version (the statement's `xmin`/`xmax`),
3990    /// so the engine calls this on each drained change with the value
3991    /// from [`Engine::writer_version_for_current_stmt`]. Additive
3992    /// metadata only: replay still resolves by physical position and
3993    /// does not read `writer_version` (that is a later slice).
3994    pub fn set_writer_version(&mut self, v: u64) {
3995        match self {
3996            RowChange::Insert { writer_version, .. }
3997            | RowChange::Update { writer_version, .. }
3998            | RowChange::Delete { writer_version, .. } => *writer_version = v,
3999            // A tombstone captures `xmax` directly from the deleting
4000            // statement's version at record time (via
4001            // `mark_row_deleted`), so it already equals `v`. Keep the
4002            // "one statement, one version" invariant mechanical by
4003            // asserting agreement in debug builds rather than silently
4004            // overwriting a possibly-different value.
4005            RowChange::Tombstone { xmax, .. } => {
4006                debug_assert_eq!(
4007                    *xmax, v,
4008                    "tombstone xmax must match the statement writer version"
4009                );
4010                *xmax = v;
4011            }
4012        }
4013    }
4014}
4015
4016/// v7.37.15 (Epic W slice 1) — leading marker byte of the
4017/// metadata-carrying redo layout. A **pre-Epic-W** redo payload leads
4018/// with `FILE_VERSION` (8..=52 today, rising ~1 per release); this
4019/// marker is `0xFF` and can therefore never collide with a real
4020/// `FILE_VERSION`, so [`decode_redo_log`] tells the two layouts apart
4021/// by inspecting the first byte alone. The compile-time assertion
4022/// below makes the "never collide" invariant a hard build gate: if
4023/// `FILE_VERSION` ever climbs toward `0xFF` the build breaks and forces
4024/// a redesign long before an ambiguity could ship.
4025const REDO_META_MARKER: u8 = 0xFF;
4026/// v7.37.15 (Epic W slice 1) — version of the metadata-carrying redo
4027/// layout that follows [`REDO_META_MARKER`]. Bumped when the per-change
4028/// metadata shape changes; an unknown value is a hard decode error.
4029const REDO_META_VERSION: u8 = 1;
4030
4031/// v7.37.15 (Epic W durable-tombstone slice) — process-wide count of
4032/// [`RowChange::Tombstone`] targets that `apply_redo` could NOT resolve
4033/// to a row by `RowId`. A non-zero value is expected only across a
4034/// checkpoint boundary (the table's ids are reassigned on deserialize
4035/// and the V6 envelope does not yet persist them), where a tombstone
4036/// naming a pre-checkpoint row is left visible rather than mis-applied.
4037/// Surfaced for observability; never affects correctness of the resolved
4038/// tombstones. Read via [`unresolved_tombstone_count`].
4039static UNRESOLVED_TOMBSTONES: core::sync::atomic::AtomicU64 = core::sync::atomic::AtomicU64::new(0);
4040
4041/// v7.39 (flip crash-replay P0) — observability read for the replay
4042/// tombstones that could not be resolved to a row (each one is a
4043/// resurrected delete).
4044#[must_use]
4045pub fn unresolved_tombstones() -> u64 {
4046    UNRESOLVED_TOMBSTONES.load(core::sync::atomic::Ordering::Relaxed)
4047}
4048
4049/// v7.37.15 (Epic W durable-tombstone slice) — read the process-wide
4050/// count of redo tombstones that could not be resolved to a row by
4051/// `RowId` during `apply_redo`. See [`UNRESOLVED_TOMBSTONES`].
4052#[must_use]
4053pub fn unresolved_tombstone_count() -> u64 {
4054    UNRESOLVED_TOMBSTONES.load(core::sync::atomic::Ordering::Relaxed)
4055}
4056// Provably-unambiguous old/new distinction: the pre-Epic-W layout's
4057// first byte is `FILE_VERSION`, which must stay strictly below the
4058// marker forever.
4059const _: () = assert!(FILE_VERSION < REDO_META_MARKER);
4060
4061/// v7.34 (crash-recovery P0 #2), extended v7.37.15 (Epic W slice 1) —
4062/// encode a row-level redo log to bytes for a WAL record.
4063///
4064/// ## Layout (Epic W metadata-carrying form, always emitted now)
4065///
4066/// `[u8 REDO_META_MARKER=0xFF][u8 REDO_META_VERSION][u8 FILE_VERSION]
4067/// [u32 count]` then per change `[u8 op][str table]` and, per op:
4068/// - `Insert [u32 n][value×n][u64 rowid][u64 writer_version]`
4069/// - `Update [u32 pos][u32 n][value×n][u64 rowid][u64 writer_version]`
4070/// - `Delete [u32 n][u32 pos×n][u64 rowid×n][u64 writer_version]`
4071/// - `Tombstone [u32 n][u64 rowid×n][u64 xmax]` (op byte 3; only ever
4072///   emitted under the metadata-carrying layout — the pre-Epic-W layout
4073///   had no in-place tombstone, so a legacy stream can never carry it)
4074///
4075/// Positions are physical (u32 ≤ 4 G rows). The `FILE_VERSION` byte
4076/// still rides along (now the 3rd byte) so the value codec decodes
4077/// string / BYTEA escapes exactly as before.
4078///
4079/// ## Backward compatibility
4080///
4081/// The **pre-Epic-W** layout was `[u8 FILE_VERSION][u32 count]…` with
4082/// no per-change metadata. [`decode_redo_log`] still decodes that form
4083/// (first byte < `0xFF`) byte-for-byte identically — every WAL file
4084/// written by released code replays unchanged.
4085#[must_use]
4086pub fn encode_redo_log(changes: &[RowChange]) -> Vec<u8> {
4087    let mut out = Vec::new();
4088    out.push(REDO_META_MARKER);
4089    out.push(REDO_META_VERSION);
4090    out.push(FILE_VERSION);
4091    codec::write_u32(&mut out, changes.len() as u32);
4092    let write_values = |out: &mut Vec<u8>, vals: &[Value<'static>]| {
4093        codec::write_u32(out, vals.len() as u32);
4094        for v in vals {
4095            codec::write_value(out, v);
4096        }
4097    };
4098    for change in changes {
4099        match change {
4100            RowChange::Insert {
4101                table,
4102                row,
4103                rowid,
4104                writer_version,
4105            } => {
4106                out.push(0);
4107                codec::write_str(&mut out, table);
4108                write_values(&mut out, &row.values);
4109                codec::write_u64(&mut out, rowid.0);
4110                codec::write_u64(&mut out, *writer_version);
4111            }
4112            RowChange::Update {
4113                table,
4114                pos,
4115                new_row,
4116                rowid,
4117                writer_version,
4118            } => {
4119                out.push(1);
4120                codec::write_str(&mut out, table);
4121                codec::write_u32(&mut out, *pos as u32);
4122                write_values(&mut out, new_row);
4123                codec::write_u64(&mut out, rowid.0);
4124                codec::write_u64(&mut out, *writer_version);
4125            }
4126            RowChange::Delete {
4127                table,
4128                positions,
4129                rowids,
4130                writer_version,
4131            } => {
4132                out.push(2);
4133                codec::write_str(&mut out, table);
4134                codec::write_u32(&mut out, positions.len() as u32);
4135                for p in positions {
4136                    codec::write_u32(&mut out, *p as u32);
4137                }
4138                // Epic W: one RowId per position (parallel). Capture
4139                // sites always produce `rowids.len() == positions.len()`;
4140                // this assertion pins that invariant at encode time so a
4141                // mismatch is a loud bug, not a silently short payload.
4142                debug_assert_eq!(
4143                    rowids.len(),
4144                    positions.len(),
4145                    "redo Delete: rowids must be parallel to positions"
4146                );
4147                for rid in rowids {
4148                    codec::write_u64(&mut out, rid.0);
4149                }
4150                codec::write_u64(&mut out, *writer_version);
4151            }
4152            RowChange::Tombstone {
4153                table,
4154                rowids,
4155                xmax,
4156            } => {
4157                out.push(3);
4158                codec::write_str(&mut out, table);
4159                codec::write_u32(&mut out, rowids.len() as u32);
4160                for rid in rowids {
4161                    codec::write_u64(&mut out, rid.0);
4162                }
4163                codec::write_u64(&mut out, *xmax);
4164            }
4165        }
4166    }
4167    out
4168}
4169
4170/// v7.34, extended v7.37.15 (Epic W slice 1) — decode a row-level redo
4171/// log written by [`encode_redo_log`].
4172///
4173/// Decodes **both** the Epic W metadata-carrying layout (first byte
4174/// `REDO_META_MARKER = 0xFF`) and the pre-Epic-W layout (first byte is
4175/// `FILE_VERSION`, always `< 0xFF`). For the old layout the per-change
4176/// metadata is absent, so `rowid`/`rowids` come back
4177/// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) (empty for
4178/// `Delete`) and `writer_version` comes back `0`.
4179///
4180/// A truncated / corrupt buffer is a hard error — never a panic — the
4181/// embedding layer frames each record with its own length + CRC, so a
4182/// frame that decodes short is corruption, not a torn tail.
4183pub fn decode_redo_log(bytes: &[u8]) -> Result<Vec<RowChange>, StorageError> {
4184    let first = *bytes
4185        .first()
4186        .ok_or_else(|| StorageError::Corrupt("redo log: empty".into()))?;
4187    // Epic W: `0xFF` marker ⇒ metadata-carrying layout; anything else
4188    // is a pre-Epic-W `FILE_VERSION` byte (old layout, no metadata).
4189    let has_meta = first == REDO_META_MARKER;
4190    let (codec_version, header_len) = if has_meta {
4191        let meta_version = *bytes
4192            .get(1)
4193            .ok_or_else(|| StorageError::Corrupt("redo log: short header".into()))?;
4194        if meta_version != REDO_META_VERSION {
4195            return Err(StorageError::Corrupt(alloc::format!(
4196                "redo log: unknown metadata version {meta_version}"
4197            )));
4198        }
4199        let file_version = *bytes
4200            .get(2)
4201            .ok_or_else(|| StorageError::Corrupt("redo log: short header".into()))?;
4202        // header = [marker][meta_version][file_version]
4203        (file_version, 3usize)
4204    } else {
4205        // Old layout: the first byte IS the FILE_VERSION.
4206        (first, 1usize)
4207    };
4208    let mut cur = codec::Cursor::new(bytes).with_codec_version(codec_version);
4209    for _ in 0..header_len {
4210        cur.read_u8()?;
4211    }
4212    let count = cur.read_u32()? as usize;
4213    let mut read_values =
4214        |cur: &mut codec::Cursor<'_>| -> Result<Vec<Value<'static>>, StorageError> {
4215            let n = cur.read_u32()? as usize;
4216            let mut vals = Vec::with_capacity(n);
4217            for _ in 0..n {
4218                vals.push(cur.read_value()?);
4219            }
4220            Ok(vals)
4221        };
4222    let mut changes = Vec::with_capacity(count);
4223    for _ in 0..count {
4224        let op = cur.read_u8()?;
4225        let table = cur.read_str()?;
4226        let change = match op {
4227            0 => {
4228                let row = Row::new(read_values(&mut cur)?);
4229                let (rowid, writer_version) = if has_meta {
4230                    (row_header::RowId(cur.read_u64()?), cur.read_u64()?)
4231                } else {
4232                    (row_header::RowId::UNASSIGNED, 0)
4233                };
4234                RowChange::Insert {
4235                    table,
4236                    row,
4237                    rowid,
4238                    writer_version,
4239                }
4240            }
4241            1 => {
4242                let pos = cur.read_u32()? as usize;
4243                let new_row = read_values(&mut cur)?;
4244                let (rowid, writer_version) = if has_meta {
4245                    (row_header::RowId(cur.read_u64()?), cur.read_u64()?)
4246                } else {
4247                    (row_header::RowId::UNASSIGNED, 0)
4248                };
4249                RowChange::Update {
4250                    table,
4251                    pos,
4252                    new_row,
4253                    rowid,
4254                    writer_version,
4255                }
4256            }
4257            2 => {
4258                let n = cur.read_u32()? as usize;
4259                let mut positions = Vec::with_capacity(n);
4260                for _ in 0..n {
4261                    positions.push(cur.read_u32()? as usize);
4262                }
4263                let (rowids, writer_version) = if has_meta {
4264                    let mut rowids = Vec::with_capacity(n);
4265                    for _ in 0..n {
4266                        rowids.push(row_header::RowId(cur.read_u64()?));
4267                    }
4268                    (rowids, cur.read_u64()?)
4269                } else {
4270                    // Old layout carried no RowId metadata.
4271                    (Vec::new(), 0)
4272                };
4273                RowChange::Delete {
4274                    table,
4275                    positions,
4276                    rowids,
4277                    writer_version,
4278                }
4279            }
4280            // Op 3 is the Epic W in-place tombstone — it only exists in
4281            // the metadata-carrying layout. Guarding on `has_meta` means
4282            // a legacy stream that happens to contain a `3` byte here is
4283            // reported as an unknown op (corruption), never mis-decoded.
4284            3 if has_meta => {
4285                let n = cur.read_u32()? as usize;
4286                let mut rowids = Vec::with_capacity(n);
4287                for _ in 0..n {
4288                    rowids.push(row_header::RowId(cur.read_u64()?));
4289                }
4290                let xmax = cur.read_u64()?;
4291                RowChange::Tombstone {
4292                    table,
4293                    rowids,
4294                    xmax,
4295                }
4296            }
4297            other => {
4298                return Err(StorageError::Corrupt(alloc::format!(
4299                    "redo log: unknown op {other}"
4300                )));
4301            }
4302        };
4303        changes.push(change);
4304    }
4305    Ok(changes)
4306}
4307
4308/// v7.39 (pg_stat knife B) — per-table scan counters, bumped from
4309/// `&self` read paths. Clone (tx shadow catalogs clone tables) copies
4310/// the current values; the counters are volatile like PG's cumulative
4311/// stats.
4312#[derive(Debug, Default)]
4313pub struct ScanStats {
4314    pub seq_scan: core::sync::atomic::AtomicU64,
4315    pub seq_tup_read: core::sync::atomic::AtomicU64,
4316    pub idx_scan: core::sync::atomic::AtomicU64,
4317    pub idx_tup_fetch: core::sync::atomic::AtomicU64,
4318}
4319
4320impl Clone for ScanStats {
4321    fn clone(&self) -> Self {
4322        use core::sync::atomic::{AtomicU64, Ordering};
4323        Self {
4324            seq_scan: AtomicU64::new(self.seq_scan.load(Ordering::Relaxed)),
4325            seq_tup_read: AtomicU64::new(self.seq_tup_read.load(Ordering::Relaxed)),
4326            idx_scan: AtomicU64::new(self.idx_scan.load(Ordering::Relaxed)),
4327            idx_tup_fetch: AtomicU64::new(self.idx_tup_fetch.load(Ordering::Relaxed)),
4328        }
4329    }
4330}
4331
4332/// v7.39 (round 215) — the lower-bound sort key for a range value, used by
4333/// the range-exclusion index. The bound as an `i128` (unbounded lower =
4334/// `i128::MIN`, sorting first) plus an inclusivity rank (inclusive lower
4335/// sorts before exclusive at the same value, `[3` before `(3`). Returns
4336/// `None` for range kinds whose bound isn't an integer scalar (numrange's
4337/// numeric/bignum), for empty ranges, and for non-range values — the caller
4338/// then keeps the O(n) scan rather than risk an unsound order. Int4/Int8/
4339/// Date/Ts/TsTz all reduce here (tstzrange bounds are `Value::Timestamp`).
4340/// Maintenance (index build) and query (overlap probe) MUST agree on this
4341/// key, so both sides call exactly this function.
4342#[must_use]
4343pub fn range_excl_index_key(v: &Value<'_>) -> Option<(i128, u8)> {
4344    let Value::Range {
4345        lower,
4346        lower_inc,
4347        empty,
4348        ..
4349    } = v
4350    else {
4351        return None;
4352    };
4353    if *empty {
4354        return None;
4355    }
4356    let key = match lower {
4357        None => i128::MIN,
4358        Some(b) => match b.as_ref() {
4359            Value::SmallInt(n) => i128::from(*n),
4360            Value::Int(n) => i128::from(*n),
4361            Value::BigInt(n) => i128::from(*n),
4362            Value::Date(n) => i128::from(*n),
4363            Value::Timestamp(n) => i128::from(*n),
4364            _ => return None,
4365        },
4366    };
4367    Some((key, u8::from(!*lower_inc)))
4368}
4369
4370/// v7.39 (round 215) — a per-table range-exclusion index: an incrementally
4371/// maintained map from a range column's lower-bound key
4372/// ([`range_excl_index_key`]) to the physical row locators carrying that
4373/// bound. Lets EXCLUDE enforcement find the few candidate rows a new range
4374/// might overlap in O(log n) instead of scanning every row (measured O(N²),
4375/// r213). Because the stored ranges under a valid `EXCLUDE (col WITH &&)`
4376/// are pairwise disjoint, a candidate overlaps only its predecessor or the
4377/// successors whose lower bound precedes its upper — a handful of probes.
4378///
4379/// NOT persisted: rebuilt from the (persisted) exclusion constraints + rows
4380/// on catalog load, exactly like BRIN re-derives. Backed by a
4381/// `PersistentBTreeMap` so `Table::clone` (the per-write snapshot) stays
4382/// O(1). Locators to tombstoned rows are left in place and filtered by the
4383/// consumer via `is_deleted()` at query time — the established index pattern.
4384#[derive(Debug, Clone)]
4385pub struct ExclRangeIndex {
4386    /// The constrained range column's position in the table.
4387    pub column_position: usize,
4388    /// Lower-bound key → row locators. A key maps to a `Vec` because a
4389    /// tombstoned-then-reinserted bound can transiently collide; live rows
4390    /// under the constraint are disjoint so each key has one live locator.
4391    pub map: PersistentBTreeMap<(i128, u8), crate::posting::PostingList>,
4392}
4393
4394#[derive(Debug, Clone)]
4395pub struct Table {
4396    schema: TableSchema,
4397    /// v7.37.15 (Phase C.1) — stable per-catalog relation identity.
4398    /// [`RelId::UNASSIGNED`](row_header::RelId::UNASSIGNED) until
4399    /// `Catalog::create_table` (or the deserialize dense-assign pass)
4400    /// stamps a real id. Keys the Phase C.4 row-lock table and the
4401    /// Phase C.5 `RelationStore`; survives `DROP TABLE` slot shifts.
4402    rel_id: row_header::RelId,
4403    rows: PersistentVec<Row<'static>>,
4404    /// v7.37.15 (Phase A.2) — per-row MVCC visibility headers
4405    /// parallel to `rows`. `headers.len() == rows.len()` is the
4406    /// load-bearing invariant; debug builds assert it on every
4407    /// scan boundary, release builds rely on it from
4408    /// disciplined insert / delete / update paths.
4409    ///
4410    /// Pre-v7.37.15-loaded tables (every row currently in the
4411    /// fleet) start as `RowHeader::frozen()` — `is_all_visible_fast()`
4412    /// returns `true`, so the per-row visibility gate Phase B
4413    /// adds is a no-op against any snapshot.
4414    ///
4415    /// Headers are NOT yet serialised into the envelope at this
4416    /// commit — on snapshot deserialize every row gets a fresh
4417    /// `RowHeader::frozen()`. Phase D adds the visibility-map
4418    /// + segment-freeze story which makes serialisation
4419    /// meaningful; until then the on-disk story is "the catalog
4420    /// is the set of visible rows."
4421    headers: PersistentVec<row_header::RowHeader>,
4422    /// v7.37.15 (Phase C.1) — stable per-relation row identity
4423    /// parallel to `rows` / `headers`. `rowids[i]` is the never-
4424    /// reused [`RowId`](row_header::RowId) of the row physically at
4425    /// slot `i`; `rowids.len() == rows.len()` joins the same load-
4426    /// bearing lock-step invariant as `headers`. Compaction (delete
4427    /// / vacuum) rebuilds all three vecs together so the id travels
4428    /// with the row while the slot shifts.
4429    ///
4430    /// Introduced additively: allocated + kept lock-step, but index
4431    /// locators still address rows by physical slot at this commit.
4432    /// Later phases migrate the lock table (C.4), HOT chains (D),
4433    /// and the WAL (Epic W) to address by `RowId`.
4434    ///
4435    /// Not yet serialised into the envelope — on load every row is
4436    /// assigned a fresh dense id `1..=len` (see `next_rowid`), which
4437    /// is sufficient while the id is process-local bookkeeping. The
4438    /// V6 envelope (Phase C.6) will persist ids so a WAL redo can
4439    /// name a row across restart.
4440    rowids: PersistentVec<row_header::RowId>,
4441    /// v7.37.15 (Phase C.1) — per-relation monotonic allocator for
4442    /// `rowids`. Starts at 1 (0 is the `RowId::UNASSIGNED` sentinel);
4443    /// every append takes `next_rowid` then increments. Never reused
4444    /// even after the row is deleted / vacuumed, so a stale lock /
4445    /// redo reference can be detected rather than silently aliasing a
4446    /// later row that reused the slot.
4447    ///
4448    /// 7.38.1 (S2.4, MATRIX #20 root cause) — the allocator is SHARED
4449    /// across every `clone()` of the relation (`Arc`), because the
4450    /// monotonic-never-reused promise is a LINEAGE invariant: each
4451    /// open transaction's shadow catalog is a clone, and when clones
4452    /// carried private counters two concurrent shadows minted the
4453    /// same id — duplicate rids in the base after both committed,
4454    /// aliasing every rid-addressed mechanism (locks, tombstones,
4455    /// redo, the rebase unique pre-check).
4456    next_rowid: alloc::sync::Arc<core::sync::atomic::AtomicU64>,
4457    /// v7.37.16 (autovacuum) — live count of tombstoned-but-present hot
4458    /// rows (`headers[i].xmax != XMAX_ALIVE`). Maintained incrementally:
4459    /// `mark_row_deleted` / `mark_rows_deleted` increment (the only
4460    /// tombstone producers), `delete_rows_no_index` recomputes over the
4461    /// survivors (it is the compaction hub every physical removal —
4462    /// including vacuum — flows through), and the v53 snapshot loader
4463    /// recounts verbatim-restored headers. Drives the engine's
4464    /// autovacuum threshold; not persisted (recomputed on load).
4465    dead_rows: u64,
4466    /// v7.39 (pg_stat knife A) — volatile per-table write counters
4467    /// backing `pg_stat_user_tables.n_tup_ins/upd/del`. Not persisted
4468    /// (PG's cumulative stats are shared-memory-volatile too — a
4469    /// restart zeroes them).
4470    stat_tup_ins: u64,
4471    stat_tup_upd: u64,
4472    stat_tup_del: u64,
4473    /// v7.39 (pg_stat knife B) — volatile scan counters
4474    /// (`seq_scan/seq_tup_read/idx_scan/idx_tup_fetch`). Atomics: the
4475    /// read paths that bump them hold only `&Table`.
4476    scan_stats: ScanStats,
4477    /// v7.39 (pg_stat knife C) — wall-clock stamps (unix µs, from the
4478    /// host ClockFn) for pg_stat_user_tables' last_autovacuum /
4479    /// last_analyze. Volatile, like PG's cumulative stats. SPG has no
4480    /// manual-VACUUM statement semantics, so last_vacuum stays NULL.
4481    last_autovacuum_us: Option<i64>,
4482    last_analyze_us: Option<i64>,
4483    indices: Vec<Index>,
4484    hot_bytes: u64,
4485    /// v6.7.0 — cached count of rows currently materialised in the
4486    /// cold tier via `RowLocator::Cold` entries across THIS table's
4487    /// indices. Populated by `ANALYZE` (walks every BTree index and
4488    /// counts Cold locators); the count survives until the next
4489    /// ANALYZE recomputes it. Surfaced via `spg_statistic.cold_row_count`
4490    /// and `spg_stat_segment.table_name`.
4491    ///
4492    /// Honest scope: this is a CACHED count, not a live one.
4493    /// Freezer / promote / DELETE don't currently update the cache
4494    /// incrementally — they invalidate it by setting the
4495    /// `cold_row_count_stale` flag, and the next ANALYZE re-walks.
4496    /// Incremental maintenance is a v6.7.x candidate if observation
4497    /// shows the ANALYZE walk cost dominates.
4498    cold_row_count: u64,
4499    /// v6.7.0 — set when the cached `cold_row_count` may be wrong
4500    /// because rows moved into / out of the cold tier since the last
4501    /// ANALYZE. The virtual-table surface reports the cached value
4502    /// regardless (operators run ANALYZE to refresh).
4503    cold_row_count_stale: bool,
4504    /// v7.34 (crash-recovery P0 #2) — row-level redo capture buffer.
4505    /// `None` (default, in-memory mode) captures nothing — zero overhead.
4506    /// `Some` (set by the engine when persistence is on, before a
4507    /// mutating call) makes `insert` / `update_row` / `delete_rows`
4508    /// record the physical [`RowChange`] they applied, which the engine
4509    /// drains after the statement and writes to the WAL in place of the
4510    /// SQL text. Transient: never serialized; a `Catalog::clone` between
4511    /// enable and drain copies it (cheap — empty in the steady state).
4512    redo_log: Option<Vec<RowChange>>,
4513    /// v7.39 (round 215) — per-`EXCLUDE`-constraint range-overlap indexes,
4514    /// one per single-`&&` constraint on an integer-keyable range column.
4515    /// Maintained incrementally on insert / update / rebuild (mirroring the
4516    /// BTree secondary indexes); NOT serialized — rebuilt from the schema's
4517    /// exclusion constraints on load. Empty for tables with no EXCLUDE
4518    /// constraint (the common case), so `Table::clone` pays nothing.
4519    excl_indexes: Vec<ExclRangeIndex>,
4520    /// v7.39 (round 493) — the snapshot floor below which a deleted row
4521    /// version is invisible to everyone, as of the statement now running.
4522    ///
4523    /// Runtime only: never serialised, and `0` (the default) prunes
4524    /// nothing, so any path that forgets to set it is merely slower, not
4525    /// wrong. The engine sets it from `vacuum_oldest_active()` — the same
4526    /// floor `vacuum` itself takes — before the statement's inserts.
4527    prune_horizon: u64,
4528}
4529
4530/// Catalog: insertion-ordered `Vec<Table>` for stable iter / serialize,
4531/// plus a `BTreeMap<String, usize>` sidecar index so `get` / `get_mut`
4532/// run in O(log n) instead of the old linear scan with per-element
4533/// string compares.
4534///
4535/// A pure `BTreeMap<String, Table>` was tried in an interim version
4536/// of v3.1.2 and regressed the single-table catalog benches by ~10%
4537/// (the per-element `BTreeMap` overhead outweighs the lookup win
4538/// when n is small). The sidecar shape preserves the insertion-order
4539/// iteration the on-disk encoding relies on and keeps `last_mut`
4540/// (used by the deserialize hot path) cheap.
4541/// v7.39 (pg_stat blks knife) — catalog-wide cold-tier read counter
4542/// backing pg_stat_database.blks_read. Row-granular (SPG has no 8 KB
4543/// page notion): one cold-segment row resolution = one "block read",
4544/// one hot row access = one "block hit" — the hit RATIO monitoring
4545/// dashboards compute keeps its meaning. Volatile like PG's stats.
4546#[derive(Debug, Default)]
4547pub struct ColdReadStats {
4548    pub cold_reads: core::sync::atomic::AtomicU64,
4549}
4550
4551impl Clone for ColdReadStats {
4552    fn clone(&self) -> Self {
4553        Self {
4554            cold_reads: core::sync::atomic::AtomicU64::new(
4555                self.cold_reads.load(core::sync::atomic::Ordering::Relaxed),
4556            ),
4557        }
4558    }
4559}
4560
4561/// 7.38.1 S3.1 (D4) — the non-table catalog families that carry a
4562/// per-transaction dirty window (see `Catalog::dirty_nontable`). One
4563/// entry class per side-map the poisoned-commit merge reconciles.
4564#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
4565pub enum NonTableKind {
4566    Sequence,
4567    View,
4568    MaterializedView,
4569    EnumType,
4570    DomainType,
4571    CompositeType,
4572}
4573
4574#[derive(Debug, Clone, Default)]
4575pub struct Catalog {
4576    /// v7.39 (pg_stat blks knife) — see [`ColdReadStats`].
4577    pub cold_read_stats: ColdReadStats,
4578    tables: Vec<Table>,
4579    /// `name → tables[index]`. Kept in lock-step with `tables`.
4580    /// `create_table` is the only write path.
4581    by_name: BTreeMap<String, usize>,
4582    /// v7.39 (round 436) — the current session's temporary-table namespace.
4583    /// A temp table is stored under `<prefix><name>`, and every lookup tries
4584    /// that first: exactly PG's `pg_temp` search-path rule, and MySQL's
4585    /// "a TEMPORARY table shadows a permanent one of the same name".
4586    ///
4587    /// Process-local, never serialised: the engine sets it per session, and
4588    /// a catalog read back from disk starts with none. Kept here rather than
4589    /// at each of the ~170 engine call sites because `by_name` is private —
4590    /// this is the ONE place a table name becomes an index.
4591    temp_prefix: Option<String>,
4592    /// v7.39 (round 496) — the names of tables this catalog handle has had
4593    /// changed since the set was last cleared.
4594    ///
4595    /// Runtime only, never serialised. A transaction's shadow catalog
4596    /// clears it at BEGIN, so at COMMIT the set is exactly the tables the
4597    /// transaction changed — which is what lets a commit that cannot use
4598    /// the row-level merge install only those tables instead of the whole
4599    /// catalog, leaving another session's concurrent work in place.
4600    ///
4601    /// Recorded where the change actually happens (`get_mut`,
4602    /// `create_table`, `drop_table`) rather than from the statement
4603    /// classifier: round 494 tried classification for a correctness gate
4604    /// and it was wrong, because `SELECT lo_write(…)` reads as read-only.
4605    dirty_tables: alloc::collections::BTreeSet<String>,
4606    /// 7.38.1 S3.1 (D4) — the non-table twin of `dirty_tables`: which
4607    /// sequences / views / matviews / enum / domain / composite types
4608    /// THIS window created, altered, renamed or dropped. Counter
4609    /// advances (`nextval`) deliberately do NOT record — counter
4610    /// values merge via `sequence_counters` / `restore_sequence_
4611    /// counters`, and a tx that only consumed ids must not shadow a
4612    /// neighbour's ALTER SEQUENCE. Cleared by `clear_dirty_tables`
4613    /// (one window, both records).
4614    dirty_nontable: alloc::collections::BTreeSet<(NonTableKind, String)>,
4615    /// v7.37.15 (Phase C.1) — monotonic allocator for stable
4616    /// [`RelId`](row_header::RelId)s. Pre-incremented on each
4617    /// `create_table` so real ids start at 1 (0 is `UNASSIGNED`);
4618    /// never reused even after `DROP TABLE`, so a stale lock / redo
4619    /// reference is detectable. Process-local bookkeeping — not yet
4620    /// serialised; `deserialize` re-assigns dense ids on load (the
4621    /// V6 envelope, Phase C.6, will round-trip real ids).
4622    next_rel_id: u64,
4623    /// v5.1: in-memory cold-tier segments. Side-loaded via
4624    /// [`Catalog::load_segment_bytes`] — they live outside the
4625    /// catalog snapshot (caller persists them as separate files
4626    /// and re-loads on boot, until v5.3's `CatalogManifest` makes
4627    /// that wiring automatic). `RowLocator::Cold { segment_id, .. }`
4628    /// indexes this `Vec`. Cleared on `Catalog::new` / fresh
4629    /// `deserialize`.
4630    ///
4631    /// `Arc` wrap keeps `Catalog::clone` at O(N segments) bumps
4632    /// (rather than O(total segment bytes) memcpy) so the v4.42
4633    /// group-commit pre-image rollback invariant — clone is
4634    /// effectively free — survives the cold-tier addition.
4635    ///
4636    /// v6.7.3 — slots became `Option<…>` so cold-segment compaction
4637    /// can tombstone merged sources without breaking the
4638    /// `segment_id = index_into_vec` contract that on-disk
4639    /// `RowLocator::Cold { segment_id }` already serialized.
4640    /// `None` slot = the segment was retired by compaction; the
4641    /// physical file may still be on disk (next CHECKPOINT writes
4642    /// a manifest that no longer lists it, and the file becomes
4643    /// an orphan eligible for offline cleanup).
4644    cold_segments: Vec<Option<Arc<OwnedSegment>>>,
4645    /// v7.12.4 — user-defined functions (PL/pgSQL + SQL).
4646    /// Keyed by function name (PG overloading is out of scope).
4647    /// Bodies are stored as the raw source text the parser saw
4648    /// between `$$ ... $$`; the engine re-parses on each
4649    /// invocation. This keeps `spg-storage` free of `spg-sql`
4650    /// dependency — same pattern as partial-index predicates.
4651    functions: BTreeMap<String, FunctionDef>,
4652    /// v7.12.4 — triggers in insertion order. PG18-measured (round
4653    /// 753): PG fires same-event triggers in NAME order (a_trig
4654    /// before z_trig regardless of creation order); SPG fires in
4655    /// insertion order — a real divergence, ledgered as F31-B2.
4656    triggers: Vec<TriggerDef>,
4657    /// v7.39 (round 139) — query-rewrite RULEs, flat like triggers.
4658    rules: Vec<RuleDef>,
4659    /// v7.39 (round 280) — extended-statistics objects. Recorded so a
4660    /// pg_dump restores them and reflection reports them; the planner
4661    /// does not consult them yet.
4662    statistics_ext: Vec<StatisticsExtDef>,
4663    /// v7.39 (round 287) — server-side large objects, keyed by OID.
4664    /// PG stores them as 2 KB pages in `pg_largeobject`; the page split
4665    /// is a storage detail of ITS heap, so SPG holds the whole byte
4666    /// string and renders the pages on read. What must match is the
4667    /// observable surface: the OIDs, the bytes, and the page rows.
4668    large_objects: alloc::collections::BTreeMap<u32, Vec<u8>>,
4669    /// v7.17.0 — catalogued SEQUENCE objects (Phase 1.1). Each
4670    /// `nextval(name)` reaches in here, atomically increments
4671    /// `last_value` / flips `is_called`, returns the new value.
4672    /// Persisted in catalog FILE_VERSION 26+; older catalogs
4673    /// deserialise with an empty map.
4674    sequences: BTreeMap<String, SequenceDef>,
4675    /// v7.39 (read01 round 60) — the `public` schema's ACL (PG
4676    /// `pg_namespace.nspacl`). EMPTY = PG's default, which is not "nothing":
4677    /// PUBLIC holds USAGE and the owner holds USAGE + CREATE. Materialised on
4678    /// the first GRANT / REVOKE, exactly like a table's relacl.
4679    schema_acl: Vec<AclItem>,
4680    /// v7.39 (read01 round 60) — the database's ACL. EMPTY = PG's default:
4681    /// PUBLIC holds CONNECT + TEMPORARY, the owner holds all three.
4682    database_acl: Vec<AclItem>,
4683    /// v7.17.0 — catalogued VIEW objects (Phase 1.2). Each
4684    /// `SELECT FROM v` at engine exec-time looks up `v` here and
4685    /// prepends the view body as a synthetic CTE. Persisted in
4686    /// catalog FILE_VERSION 27+; older catalogs deserialise with
4687    /// an empty map.
4688    views: BTreeMap<String, ViewDef>,
4689    /// v7.17.0 — catalogued MATERIALIZED VIEW source registry
4690    /// (Phase 1.3). Maps name → SELECT source. The materialised
4691    /// rows themselves live as a regular `Table` with the same
4692    /// name; REFRESH re-parses + re-executes the source against
4693    /// the table. Persisted in catalog FILE_VERSION 28+;
4694    /// older catalogs deserialise with an empty map.
4695    materialized_views: BTreeMap<String, String>,
4696    /// v7.17.0 — catalogued user-defined ENUM types (Phase 1.4).
4697    /// Maps name → label list. Columns reference these by name
4698    /// via `ColumnSchema.user_enum_type`. Persisted in catalog
4699    /// FILE_VERSION 29+; older catalogs deserialise with an empty
4700    /// map.
4701    enum_types: BTreeMap<String, EnumDef>,
4702    /// v7.17.0 — catalogued user-defined DOMAIN types (Phase 1.5).
4703    /// Maps name → base + CHECK constraints. Columns reference
4704    /// these by name via `ColumnSchema.user_domain_type`.
4705    /// Persisted in catalog FILE_VERSION 30+; older catalogs
4706    /// deserialise with an empty map.
4707    domain_types: BTreeMap<String, DomainDef>,
4708    /// v7.39 (read01 round 50) — `COMMENT ON <kind> <obj> IS '…'` store.
4709    /// Keyed by a canonical `"<kind>:<name>"` string (`"table:t"`,
4710    /// `"column:t.c"`, `"index:i"`, `"view:v"`, …) so a new commentable
4711    /// object kind needs no schema change. `COMMENT … IS NULL` removes the
4712    /// entry. Persisted in catalog FILE_VERSION 61+; older catalogs
4713    /// deserialise with an empty map. Read back by obj_description /
4714    /// col_description and the pg_description view.
4715    comments: BTreeMap<String, String>,
4716    /// v7.39 (round 547) — PG's `pg_db_role_setting`: the GUC defaults
4717    /// `ALTER ROLE … SET` / `ALTER DATABASE … SET` record, applied when
4718    /// a session starts.
4719    ///
4720    /// Keyed exactly as PG keys it — `(database, role)` where an empty
4721    /// name is PG's oid 0, meaning "all". So `ALTER ROLE ALL SET` is
4722    /// `("", "")`, `ALTER DATABASE d SET` is `(d, "")`, `ALTER ROLE r
4723    /// SET` is `("", r)` and `ALTER ROLE r IN DATABASE d SET` is
4724    /// `(d, r)`. The value is that scope's parameter list.
4725    db_role_settings: BTreeMap<(String, String), BTreeMap<String, String>>,
4726    /// v7.39 (round 550) — replication slots, by name.
4727    ///
4728    /// A slot in PG is two things: a named record, and a reservation
4729    /// that holds WAL back. SPG keeps the record — which is what every
4730    /// setup script and monitoring query reads — and reports
4731    /// `wal_status = 'unreserved'`, PG's own word for a slot that no
4732    /// longer holds WAL. The whole family used to answer NULL and
4733    /// report success, so `pg_drop_replication_slot('nosuchslot')` said
4734    /// it worked and a setup script created nothing.
4735    ///
4736    /// Value: (plugin, slot_type). `plugin` is empty for a physical slot.
4737    replication_slots: BTreeMap<String, (String, String)>,
4738    /// v7.37.42-T2 ζ-B — catalogued user-defined COMPOSITE types
4739    /// (`CREATE TYPE name AS (field_name field_type, …)`). Columns
4740    /// reference these by name via
4741    /// `ColumnSchema.user_composite_type` (parallel to
4742    /// `user_enum_type` / `user_domain_type`). Persisted in catalog
4743    /// FILE_VERSION 52+; older catalogs deserialise with an empty
4744    /// map.
4745    composite_types: BTreeMap<String, CompositeDef>,
4746    /// v7.17.0 — schema-namespace registry (Phase 1.6). Tracks
4747    /// which schemas exist. `public`, `pg_catalog`, and
4748    /// `information_schema` are built-in and always present.
4749    /// Schema-qualified table references still strip the prefix
4750    /// at lookup time per v7.16-and-earlier — full
4751    /// schema-as-isolation is v7.18+ scope. Persisted in catalog
4752    /// FILE_VERSION 31+; older catalogs deserialise with just
4753    /// the built-ins.
4754    schemas: alloc::collections::BTreeSet<String>,
4755}
4756
4757/// v7.12.4 — catalogued user-defined function. `body` is the raw
4758/// source text between `$$ ... $$`; the engine re-parses it on
4759/// invocation. This keeps the storage codec stable when the
4760/// PL/pgSQL surface grows (no breaking-change risk on the disk
4761/// format).
4762// v7.39 (round 322, V46) — no longer `Eq`: COST / ROWS are f64, as in PG.
4763#[derive(Debug, Clone, PartialEq)]
4764pub struct FunctionDef {
4765    pub name: String,
4766    /// Display form of the argument list, e.g.
4767    /// `"(name TEXT, ts TIMESTAMP)"`. Empty `"()"` for the trigger
4768    /// function shape. Parser-side canonicalised before storage.
4769    pub args_repr: String,
4770    /// Display form of the return type, e.g. `"TRIGGER"` /
4771    /// `"INT"` / `"SETOF text"`. The engine special-cases
4772    /// `"TRIGGER"` (case-insensitive) to gate trigger-only
4773    /// semantics (NEW/OLD).
4774    pub returns: String,
4775    /// `LANGUAGE` clause, lowercased. `"plpgsql"` / `"sql"`.
4776    pub language: String,
4777    /// Source body of the function. PL/pgSQL: includes the
4778    /// surrounding `BEGIN ... END;`. SQL: includes the
4779    /// statement(s). The engine re-parses on invocation; bad
4780    /// bodies surface as a parse error at CALL time, not CREATE.
4781    pub body: String,
4782    /// v7.39 (read01 round 61) — the role that ran CREATE FUNCTION.
4783    pub owner: Option<String>,
4784    /// v7.39 (read01 round 61) — explicit GRANTs (PG `pg_proc.proacl`). EMPTY
4785    /// is NOT "nobody may call it": PG grants EXECUTE to PUBLIC by default, and
4786    /// leaves proacl NULL to say so. The list materialises on the first
4787    /// GRANT / REVOKE.
4788    pub acl: Vec<AclItem>,
4789    /// v7.39 (round 322, V46) — `IMMUTABLE` / `STRICT` / `PARALLEL SAFE` /
4790    /// `SECURITY DEFINER` / `LEAKPROOF` / `COST` / `ROWS`. `strict` is the
4791    /// only one with execution semantics today (a NULL argument yields a
4792    /// NULL result without running the body); the rest are recorded so
4793    /// `pg_get_functiondef` and `pg_proc` report what was declared.
4794    pub volatility: u8,
4795    pub strict: bool,
4796    pub security_definer: bool,
4797    pub leakproof: bool,
4798    pub parallel: u8,
4799    pub cost: Option<f64>,
4800    pub rows: Option<f64>,
4801}
4802
4803/// v7.39 (round 322, V46) — `FunctionDef.volatility` codes: PG's
4804/// `pg_proc.provolatile` letters.
4805pub const FN_VOLATILE: u8 = b'v';
4806pub const FN_IMMUTABLE: u8 = b'i';
4807pub const FN_STABLE: u8 = b's';
4808
4809/// v7.39 (round 322, V46) — `FunctionDef.parallel` codes: PG's
4810/// `pg_proc.proparallel` letters.
4811pub const FN_PARALLEL_UNSAFE: u8 = b'u';
4812pub const FN_PARALLEL_RESTRICTED: u8 = b'r';
4813pub const FN_PARALLEL_SAFE: u8 = b's';
4814
4815/// v7.39 (round 315, V19) — which catalogued function does a persisted
4816/// ACL key refer to?
4817///
4818/// The key was computed by whichever formula was current when the image
4819/// was written, and the multi-word fix changed that formula for bare
4820/// types like `double precision`. A miss therefore does NOT mean "no
4821/// such function": an older image's key would land nowhere and its owner
4822/// and grants would be dropped in silence. Exact match first, then the
4823/// pre-fix formula.
4824#[must_use]
4825pub fn resolve_stored_function_key(
4826    functions: &BTreeMap<String, FunctionDef>,
4827    stored: &str,
4828) -> Option<String> {
4829    if functions.contains_key(stored) {
4830        return Some(stored.to_string());
4831    }
4832    functions
4833        .values()
4834        .find(|f| function_signature_key_legacy(&f.name, &f.args_repr) == stored)
4835        .map(|f| function_signature_key(&f.name, &f.args_repr))
4836}
4837
4838/// v7.39 (round 344, V49) — re-exported from [`spg_sql`], which owns the
4839/// SQL type spellings. This crate carried a byte-identical copy because
4840/// the two were siblings that did not depend on each other; spg-sql is a
4841/// dependency-free leaf, so the dependency is acyclic and the publish
4842/// order already puts it first. One list, one place to keep it right.
4843pub use spg_sql::parser::is_multiword_type_phrase;
4844
4845/// v7.39 (round 315, V19) — the signature key as computed BEFORE the
4846/// multi-word fix, used only to recognise what an older image wrote.
4847///
4848/// The function catalogue recomputes its keys from the stored name and
4849/// argument text on load, so it needs no migration. The ACL block does
4850/// not: it persists the computed key as a string and matches on it. A
4851/// key that changed shape would simply fail to match, and the owner and
4852/// grants would be dropped without a word — so the loader falls back to
4853/// this when the stored key finds nothing.
4854#[must_use]
4855pub fn function_signature_key_legacy(name: &str, args_repr: &str) -> String {
4856    let inner = args_repr
4857        .trim()
4858        .trim_start_matches('(')
4859        .trim_end_matches(')');
4860    let types: Vec<String> = if inner.trim().is_empty() {
4861        Vec::new()
4862    } else {
4863        inner
4864            .split(',')
4865            .map(|part| {
4866                let mut words: Vec<&str> = part.split_whitespace().collect();
4867                if !words.is_empty()
4868                    && (words[0].eq_ignore_ascii_case("OUT")
4869                        || words[0].eq_ignore_ascii_case("INOUT"))
4870                {
4871                    words.remove(0);
4872                }
4873                let ty = if words.len() >= 2 {
4874                    words[1..].join(" ")
4875                } else {
4876                    words.first().map_or(String::new(), |w| (*w).to_string())
4877                };
4878                normalize_type_name(&ty)
4879            })
4880            .collect()
4881    };
4882    format!("{}({})", name.to_ascii_lowercase(), types.join(","))
4883}
4884
4885pub fn function_signature_key(name: &str, args_repr: &str) -> String {
4886    let types = function_arg_types(args_repr);
4887    format!("{}({})", name.to_ascii_lowercase(), types.join(","))
4888}
4889
4890/// The declared argument TYPES of a function, out of its `args_repr`
4891/// (`"(x INT, y DOUBLE PRECISION)"` → `["int", "float"]`). An entry may be a
4892/// bare type with no name (`"(INT)"`).
4893#[must_use]
4894pub fn function_arg_types(args_repr: &str) -> Vec<String> {
4895    let inner = args_repr
4896        .trim()
4897        .trim_start_matches('(')
4898        .trim_end_matches(')');
4899    if inner.trim().is_empty() {
4900        return Vec::new();
4901    }
4902    inner
4903        .split(',')
4904        .map(|part| {
4905            let mut words: Vec<&str> = part.split_whitespace().collect();
4906            // `OUT x INT` / `INOUT x INT` — the mode is not part of the type.
4907            if !words.is_empty()
4908                && (words[0].eq_ignore_ascii_case("OUT") || words[0].eq_ignore_ascii_case("INOUT"))
4909            {
4910                words.remove(0);
4911            }
4912            // v7.39 (round 315, V19) — two or more words is USUALLY
4913            // `name TYPE`, but not when the type itself is spelled in
4914            // several words. `double precision` was read as a parameter
4915            // named "double" of type "precision", so it keyed differently
4916            // from `x double precision` — the same signature written two
4917            // ways did not resolve to the same function. Decide by asking
4918            // whether the whole phrase names a type first; only then is
4919            // the leading word a parameter name.
4920            let whole = words.join(" ");
4921            let ty = if words.len() >= 2 && !is_multiword_type_phrase(&whole) {
4922                words[1..].join(" ")
4923            } else {
4924                whole
4925            };
4926            normalize_type_name(&ty)
4927        })
4928        .collect()
4929}
4930
4931/// v7.39 (read01 round 65) — the declared argument NAMES of a function (`""` for
4932/// a bare type with no name).
4933#[must_use]
4934pub fn function_arg_names(args_repr: &str) -> Vec<String> {
4935    let inner = args_repr
4936        .trim()
4937        .trim_start_matches('(')
4938        .trim_end_matches(')');
4939    if inner.trim().is_empty() {
4940        return Vec::new();
4941    }
4942    inner
4943        .split(',')
4944        .map(|part| {
4945            let mut words: Vec<&str> = part.split_whitespace().collect();
4946            if !words.is_empty()
4947                && (words[0].eq_ignore_ascii_case("OUT") || words[0].eq_ignore_ascii_case("INOUT"))
4948            {
4949                words.remove(0);
4950            }
4951            if words.len() >= 2 {
4952                words[0].to_string()
4953            } else {
4954                String::new()
4955            }
4956        })
4957        .collect()
4958}
4959
4960/// Fold PG's type aliases so a signature key is stable across spellings.
4961/// Unknown names pass through lower-cased — consistency is what the key needs.
4962#[must_use]
4963pub fn normalize_type_name(ty: &str) -> String {
4964    let t = ty.trim().to_ascii_lowercase();
4965    // Peel a precision/length modifier: `numeric(10,2)`, `varchar(64)`.
4966    let base = t.split_once('(').map_or(t.as_str(), |(h, _)| h).trim();
4967    match base {
4968        "int" | "int4" | "integer" => "int",
4969        "bigint" | "int8" => "bigint",
4970        "smallint" | "int2" => "smallint",
4971        "text" | "varchar" | "character varying" | "char" | "character" | "bpchar" => "text",
4972        "bool" | "boolean" => "bool",
4973        "float" | "float8" | "double precision" => "float",
4974        "real" | "float4" => "real",
4975        "numeric" | "decimal" => "numeric",
4976        "timestamptz" | "timestamp with time zone" => "timestamptz",
4977        "timestamp" | "timestamp without time zone" => "timestamp",
4978        other => other,
4979    }
4980    .to_string()
4981}
4982
4983/// v7.12.4 — catalogued trigger. References its function by
4984/// name; the function must exist at TRIGGER creation time
4985/// (forward references are deferred to v7.12.5+).
4986#[derive(Debug, Clone, PartialEq, Eq)]
4987pub struct TriggerDef {
4988    pub name: String,
4989    /// Watched table. Trigger is dropped when the table drops.
4990    pub table: String,
4991    /// `"BEFORE"` / `"AFTER"` / `"INSTEAD OF"`. Stored as the
4992    /// uppercased keyword so deserialised catalogs round-trip
4993    /// without canonicalisation surprises.
4994    pub timing: String,
4995    /// Each entry is one of `"INSERT"` / `"UPDATE"` / `"DELETE"`
4996    /// / `"TRUNCATE"`. `INSERT OR UPDATE` parses to two entries.
4997    pub events: Vec<String>,
4998    /// `"ROW"` / `"STATEMENT"`. v7.12.4 ships `"ROW"` only;
4999    /// `"STATEMENT"` parses and persists but the executor
5000    /// refuses it at trigger fire time.
5001    pub for_each: String,
5002    /// Name of the PL/pgSQL function to invoke.
5003    pub function: String,
5004    /// v7.13.0 — `UPDATE OF col, col, …` column-list filter
5005    /// (mailrs round-5 G7). Non-empty means the trigger fires
5006    /// only when at least one of these columns appears in the
5007    /// UPDATE's SET list. Empty = no column filter. Stored in
5008    /// catalog FILE_VERSION 23+; older catalogs deserialise with
5009    /// an empty vec.
5010    pub update_columns: Vec<String>,
5011    /// v7.16.1 — whether the trigger fires when its watched
5012    /// event occurs. Toggled by `ALTER TABLE … { ENABLE |
5013    /// DISABLE } TRIGGER …`; pg_dump --disable-triggers wraps
5014    /// every data block with a DISABLE/ENABLE pair so the
5015    /// rows already-computed in prod don't get re-rewritten.
5016    /// Defaults to `true` at CREATE TRIGGER time. Stored in
5017    /// catalog FILE_VERSION 25+; older catalogs deserialise
5018    /// with `enabled = true`.
5019    pub enabled: bool,
5020    /// v7.39 (round 138) — the deparsed `WHEN ( condition )` predicate text
5021    /// (re-parsed at fire time to filter row triggers). Empty = no WHEN.
5022    /// Persisted from FILE_VERSION 70; older catalogs read back empty.
5023    pub when_condition: String,
5024}
5025
5026/// v7.39 (round 280) — one `CREATE STATISTICS` object.
5027#[derive(Debug, Clone, PartialEq, Eq)]
5028pub struct StatisticsExtDef {
5029    pub name: String,
5030    pub table: String,
5031    /// PG's single-letter kinds: `d` ndistinct, `f` dependencies,
5032    /// `m` mcv. PG's default set is all three.
5033    pub kinds: Vec<String>,
5034    pub columns: Vec<String>,
5035}
5036
5037/// v7.39 (round 139) — a catalogued query-rewrite RULE. Stored flat like
5038/// `TriggerDef`, keyed by `(name, table)`. Command / WHEN text is deparsed SQL
5039/// re-parsed at rewrite time (the same round-trip trick as
5040/// `TriggerDef.when_condition`). Persisted from FILE_VERSION 71.
5041#[derive(Debug, Clone, PartialEq, Eq)]
5042pub struct RuleDef {
5043    pub name: String,
5044    pub table: String,
5045    /// Event keyword, uppercased: `INSERT` / `UPDATE` / `DELETE` / `SELECT`.
5046    pub event: String,
5047    /// `true` = `DO INSTEAD`, `false` = `DO ALSO`.
5048    pub instead: bool,
5049    /// Deparsed `WHERE` predicate text; empty = unconditional.
5050    pub when_condition: String,
5051    /// Deparsed DO command statements; empty = `NOTHING`.
5052    pub commands: Vec<String>,
5053}
5054
5055/// v7.17.0 — catalogued SEQUENCE. PG semantics: a counter object
5056/// returning monotonically increasing values via `nextval(name)`.
5057/// `last_value` is the most recent value handed out; `is_called`
5058/// is false until the first `nextval`/`setval`. Stored separately
5059/// from tables in the catalog.
5060#[derive(Debug, Clone, PartialEq, Eq)]
5061pub struct SequenceDef {
5062    pub name: String,
5063    /// Data type — narrows the i64 range. PG default BIGINT.
5064    pub data_type: SequenceDataType,
5065    pub start: i64,
5066    pub increment: i64,
5067    pub min_value: i64,
5068    pub max_value: i64,
5069    pub cache: i64,
5070    pub cycle: bool,
5071    /// `OWNED BY` target — `(table, column)` or NONE.
5072    pub owned_by: Option<(String, String)>,
5073    /// Most recently handed-out value. Meaningless when
5074    /// `is_called == false`; in that case the NEXT `nextval`
5075    /// will return `start`.
5076    pub last_value: i64,
5077    pub is_called: bool,
5078    /// v7.39 (read01 round 60) — the role that ran CREATE SEQUENCE. `None` = an
5079    /// image written before FILE_VERSION 66, which predates sequence owners.
5080    pub owner: Option<String>,
5081    /// v7.39 (read01 round 60) — explicit GRANTs on this sequence. A sequence's
5082    /// meaningful privileges are SELECT (`currval`), UPDATE (`setval`) and
5083    /// USAGE (`nextval`).
5084    pub acl: Vec<AclItem>,
5085}
5086
5087/// v7.17.0 — sequence integer width.
5088#[derive(Debug, Clone, Copy, PartialEq, Eq)]
5089pub enum SequenceDataType {
5090    SmallInt,
5091    Int,
5092    BigInt,
5093}
5094
5095/// v7.17.0 Phase 1.6 — built-in schema names that every Catalog
5096/// understands without an explicit CREATE SCHEMA. Used by
5097/// [`Catalog::schema_exists`] and the engine's schema-qualified
5098/// lookup path.
5099#[must_use]
5100pub fn is_builtin_schema(name: &str) -> bool {
5101    name.eq_ignore_ascii_case("public")
5102        || name.eq_ignore_ascii_case("pg_catalog")
5103        || name.eq_ignore_ascii_case("information_schema")
5104}
5105
5106/// v7.17.0 — parse a PG-canonical UUID text representation into the
5107/// 16-byte network-order layout used by `Value::Uuid`. Accepted input
5108/// shapes (all case-insensitive):
5109///   * Canonical hyphenated 8-4-4-4-12 (`550e8400-e29b-41d4-a716-446655440000`)
5110///   * Unhyphenated 32-char hex (`550e8400e29b41d4a716446655440000`)
5111///   * Either form wrapped in `{ ... }`
5112///
5113/// Returns `None` for any malformed input (wrong length, non-hex
5114/// characters, misplaced hyphens). The caller surfaces a SQL error
5115/// at coercion time — silent acceptance of garbage would mask
5116/// application bugs and is exactly the divergence from PG that
5117/// breaks the 0-change cutover promise.
5118#[must_use]
5119pub fn parse_uuid_str(input: &str) -> Option<[u8; 16]> {
5120    let s = input.trim();
5121    // Strip surrounding braces if present.
5122    let s = if let Some(inner) = s.strip_prefix('{').and_then(|x| x.strip_suffix('}')) {
5123        inner
5124    } else {
5125        s
5126    };
5127    // Two valid shapes after braces are stripped: 32 hex chars or
5128    // the canonical 36-char hyphenated form.
5129    let hex: String = match s.len() {
5130        32 => s.to_ascii_lowercase(),
5131        36 => {
5132            // Hyphens must be exactly at positions 8, 13, 18, 23.
5133            let b = s.as_bytes();
5134            if b[8] != b'-' || b[13] != b'-' || b[18] != b'-' || b[23] != b'-' {
5135                return None;
5136            }
5137            let mut out = String::with_capacity(32);
5138            out.push_str(&s[0..8]);
5139            out.push_str(&s[9..13]);
5140            out.push_str(&s[14..18]);
5141            out.push_str(&s[19..23]);
5142            out.push_str(&s[24..36]);
5143            out.make_ascii_lowercase();
5144            out
5145        }
5146        _ => return None,
5147    };
5148    let bytes = hex.as_bytes();
5149    let mut out = [0u8; 16];
5150    for i in 0..16 {
5151        let hi = hex_nibble(bytes[i * 2])?;
5152        let lo = hex_nibble(bytes[i * 2 + 1])?;
5153        out[i] = (hi << 4) | lo;
5154    }
5155    Some(out)
5156}
5157
5158fn hex_nibble(b: u8) -> Option<u8> {
5159    match b {
5160        b'0'..=b'9' => Some(b - b'0'),
5161        b'a'..=b'f' => Some(10 + b - b'a'),
5162        b'A'..=b'F' => Some(10 + b - b'A'),
5163        _ => None,
5164    }
5165}
5166
5167/// v7.17.0 — render a `Value::Uuid` payload as the canonical
5168/// lowercase 8-4-4-4-12 hyphenated form PG `text` cast surfaces.
5169#[must_use]
5170pub fn format_uuid(b: &[u8; 16]) -> String {
5171    const HEX: &[u8; 16] = b"0123456789abcdef";
5172    let mut out = String::with_capacity(36);
5173    for (i, byte) in b.iter().enumerate() {
5174        if matches!(i, 4 | 6 | 8 | 10) {
5175            out.push('-');
5176        }
5177        out.push(HEX[(byte >> 4) as usize] as char);
5178        out.push(HEX[(byte & 0x0f) as usize] as char);
5179    }
5180    out
5181}
5182
5183/// v7.17.0 Phase 1.5 — catalogued user-defined DOMAIN. A domain
5184/// is a named CHECK-constrained alias over a built-in type;
5185/// columns bound to it inherit the base type plus the CHECK
5186/// predicates + NOT NULL + DEFAULT at INSERT/UPDATE time.
5187/// v7.37.17 (Phase E RC rebase) — the write-set one writer version left
5188/// on a table, addressed by stable [`row_header::RowId`]s so it can be
5189/// replayed onto a fresher clone of the relation whose physical slots
5190/// differ. Produced by [`Table::extract_tx_writeset`], consumed by
5191/// [`Table::replay_tx_writeset`].
5192#[derive(Debug, Clone, Default)]
5193pub struct TxWriteSet {
5194    /// INSERTs and UPDATE-new-versions (`header.xmin == v`).
5195    pub inserted: Vec<(row_header::RowId, Row<'static>)>,
5196    /// DELETE / UPDATE-old-version targets (`header.xmax == v`).
5197    pub tombstoned: Vec<row_header::RowId>,
5198}
5199
5200impl TxWriteSet {
5201    #[must_use]
5202    pub fn is_empty(&self) -> bool {
5203        self.inserted.is_empty() && self.tombstoned.is_empty()
5204    }
5205}
5206
5207/// v7.39 (round 260) — one named CHECK on a domain. PG auto-names an
5208/// unnamed one `<domain>_check`, then `_check1`, `_check2`, … (probed).
5209#[derive(Debug, Clone, PartialEq, Eq)]
5210pub struct DomainCheck {
5211    pub name: String,
5212    /// The predicate source, referencing the pseudo-column `VALUE`.
5213    pub expr: String,
5214}
5215
5216/// `default` / `checks` are stored as Display-form source so
5217/// `spg-storage` stays free of `spg-sql` dependency — same
5218/// pattern as FunctionDef / ViewDef.
5219#[derive(Debug, Clone, PartialEq, Eq)]
5220pub struct DomainDef {
5221    pub name: String,
5222    pub base_type: DataType,
5223    pub nullable: bool,
5224    pub default: Option<String>,
5225    /// v7.39 (round 260) — each CHECK carries its constraint NAME, so
5226    /// `ALTER DOMAIN … DROP CONSTRAINT <name>` can find it and the
5227    /// violation message can report the constraint that actually failed.
5228    /// PG's auto-naming for an unnamed check is `<domain>_check`, then
5229    /// `_check1`, `_check2`, … (probed).
5230    pub checks: Vec<DomainCheck>,
5231    /// v7.39 (round 258/259) — when this domain was declared over ANOTHER
5232    /// domain (`CREATE DOMAIN child AS parent CHECK (…)`), the parent's
5233    /// name. `base_type` is the ultimate scalar type either way, so
5234    /// without this the parent's constraints were invisible and a value
5235    /// violating them was silently accepted. PG checks the whole chain,
5236    /// base-first, and an `ALTER DOMAIN` on the parent takes effect for
5237    /// the child immediately (probed) — so the chain is walked at check
5238    /// time rather than copied at CREATE time. Catalog FILE_VERSION 74+.
5239    pub base_domain: Option<String>,
5240}
5241
5242/// v7.17.0 Phase 1.4 — catalogued user-defined ENUM type. The
5243/// label vector is order-preserving (PG enum ordering follows the
5244/// declared order). At INSERT/UPDATE on a column bound to this
5245/// enum, the engine looks up the value against `labels` and
5246/// rejects non-members.
5247#[derive(Debug, Clone, PartialEq, Eq)]
5248pub struct EnumDef {
5249    pub name: String,
5250    pub labels: Vec<String>,
5251}
5252
5253/// v7.37.42-T2 ζ-B — catalogued user-defined COMPOSITE type
5254/// (`CREATE TYPE name AS (field_name field_type, ...)`). Order
5255/// matters: PG composite literals are positional, and SPG mirrors
5256/// that. Stored as ordered `(name, DataType)` pairs to keep the
5257/// codec straightforward and to allow eventual `Value::Composite`
5258/// bodies to encode positionally. Persisted in catalog FILE_VERSION
5259/// 52+; older catalogs deserialise with an empty composite_types
5260/// map. Composite types can be used as a column type by spelling
5261/// the composite's name; the resolution from
5262/// `ColumnSchema.user_composite_type = Some(name)` happens at the
5263/// engine boundary (parallel to `user_enum_type` /
5264/// `user_domain_type`). The dense storage shape — JSON-text body
5265/// keyed by the composite's field list — keeps the codec free of
5266/// recursive `Value` bodies until the full Value::Composite arena
5267/// migration in a later phase.
5268#[derive(Debug, Clone, PartialEq, Eq)]
5269pub struct CompositeDef {
5270    pub name: String,
5271    /// Ordered `(field_name, field_type)` pairs. PG composite
5272    /// literals are positional, so order is part of the type's
5273    /// identity.
5274    pub fields: Vec<(String, DataType)>,
5275    /// v7.39 (round 264) — parallel to `fields`: the USER type name of
5276    /// each field when it is itself a composite (or another named user
5277    /// type). `DataType` has no room for one, so a nested composite
5278    /// field resolved to the parser's Text placeholder and the inner
5279    /// record stayed TEXT — `(x).inner.street` errored, `pg_typeof`
5280    /// said text, and `row_to_json` nested a string instead of an
5281    /// object. Same shape as `ColumnSchema.user_composite_type` and
5282    /// `DomainDef.base_domain`. Catalog FILE_VERSION 76+; an older
5283    /// catalog reads all-None, which is what it meant.
5284    pub field_user_types: Vec<Option<String>>,
5285}
5286
5287/// v7.17.0 Phase 1.2 — catalogued VIEW. The body is stored as the
5288/// raw source text the parser saw between `AS` and the statement
5289/// terminator; the engine re-parses on each invocation. Same
5290/// pattern as `FunctionDef` — keeps `spg-storage` free of
5291/// `spg-sql` dependency.
5292#[derive(Debug, Clone, PartialEq, Eq)]
5293pub struct ViewDef {
5294    pub name: String,
5295    /// Optional `(col, col, …)` rename list. Empty when the body's
5296    /// projected names are used directly.
5297    pub columns: Vec<String>,
5298    /// Raw SELECT source. Display-rendered at storage time so the
5299    /// catalog round-trips a deterministic form regardless of
5300    /// whitespace / comments in the original input. Re-parsed at
5301    /// SELECT-from-view time to materialise as a synthetic CTE.
5302    pub body: String,
5303    /// v7.39 (round 132) — `WITH CHECK OPTION`: 0 = none, 1 = LOCAL,
5304    /// 2 = CASCADED. A storage-local u8 (no dependency on the SQL AST).
5305    /// Persisted from FILE_VERSION 69; older catalogs read back as 0.
5306    pub check_option: u8,
5307}
5308
5309impl SequenceDataType {
5310    /// PG default min/max per AS clause.
5311    pub fn default_bounds(self, increment_positive: bool) -> (i64, i64) {
5312        match self {
5313            Self::SmallInt => {
5314                if increment_positive {
5315                    (1, i64::from(i16::MAX))
5316                } else {
5317                    (i64::from(i16::MIN), -1)
5318                }
5319            }
5320            Self::Int => {
5321                if increment_positive {
5322                    (1, i64::from(i32::MAX))
5323                } else {
5324                    (i64::from(i32::MIN), -1)
5325                }
5326            }
5327            Self::BigInt => {
5328                if increment_positive {
5329                    (1, i64::MAX)
5330                } else {
5331                    (i64::MIN, -1)
5332                }
5333            }
5334        }
5335    }
5336}
5337
5338impl Catalog {
5339    /// v7.37.15 (Phase D) — fleet-wide vacuum pass. Walks every
5340    /// user table and reclaims rows whose delete-commit version is
5341    /// older than `oldest_active_snapshot`. Returns an aggregated
5342    /// report with per-table breakdown so hosts can emit metrics.
5343    ///
5344    /// `dry_run = true` reports the work without doing it. Use it
5345    /// to estimate the cost before scheduling a real pass.
5346    pub fn vacuum_all(
5347        &mut self,
5348        oldest_active_snapshot: u64,
5349        dry_run: bool,
5350    ) -> vacuum::VacuumReport {
5351        let mut total = vacuum::VacuumReport::default();
5352        // Snapshot the table names so we don't hold an immutable
5353        // borrow during the get_mut loop.
5354        let names: Vec<String> = self
5355            .tables
5356            .iter()
5357            .map(|t| t.schema().name.clone())
5358            .collect();
5359        for name in names {
5360            let Some(t) = self.get_mut(&name) else {
5361                continue;
5362            };
5363            let r = t.vacuum(oldest_active_snapshot, dry_run);
5364            if r.rows_reclaimed > 0 {
5365                total.per_table.push((name, r.rows_reclaimed));
5366            }
5367            total.rows_reclaimed += r.rows_reclaimed;
5368            total.rows_examined += r.rows_examined;
5369        }
5370        total
5371    }
5372
5373    pub const fn new() -> Self {
5374        Self {
5375            cold_read_stats: ColdReadStats {
5376                cold_reads: core::sync::atomic::AtomicU64::new(0),
5377            },
5378            tables: Vec::new(),
5379            by_name: BTreeMap::new(),
5380            temp_prefix: None,
5381            dirty_tables: alloc::collections::BTreeSet::new(),
5382            dirty_nontable: alloc::collections::BTreeSet::new(),
5383            next_rel_id: 0,
5384            cold_segments: Vec::new(),
5385            functions: BTreeMap::new(),
5386            triggers: Vec::new(),
5387            rules: Vec::new(),
5388            statistics_ext: Vec::new(),
5389            large_objects: alloc::collections::BTreeMap::new(),
5390            sequences: BTreeMap::new(),
5391            schema_acl: Vec::new(),
5392            database_acl: Vec::new(),
5393            views: BTreeMap::new(),
5394            materialized_views: BTreeMap::new(),
5395            enum_types: BTreeMap::new(),
5396            domain_types: BTreeMap::new(),
5397            comments: BTreeMap::new(),
5398            db_role_settings: BTreeMap::new(),
5399            replication_slots: BTreeMap::new(),
5400            composite_types: BTreeMap::new(),
5401            schemas: alloc::collections::BTreeSet::new(),
5402        }
5403    }
5404
5405    /// v7.12.4 — read-only view of catalogued user-defined
5406    /// functions. Engine callers go through here to look up the
5407    /// function body before re-parsing it for invocation.
5408    pub const fn functions(&self) -> &BTreeMap<String, FunctionDef> {
5409        &self.functions
5410    }
5411
5412    /// v7.12.4 — register a new user-defined function. With
5413    /// `or_replace = false`, errors if the name is taken. The
5414    /// engine validates the body before passing it here.
5415    pub fn create_function(
5416        &mut self,
5417        def: FunctionDef,
5418        or_replace: bool,
5419    ) -> Result<(), StorageError> {
5420        // v7.39 (read01 round 62) — functions are keyed by SIGNATURE, not by
5421        // name: `f(int)` and `f(text)` are two functions, as in PG. Keying by
5422        // name alone made a second overload an "already exists" error — so a
5423        // pg_dump carrying an overload set could not restore — and, worse, a
5424        // call to one overload silently ran the other.
5425        let key = function_signature_key(&def.name, &def.args_repr);
5426        if !or_replace && self.functions.contains_key(&key) {
5427            return Err(StorageError::Corrupt(format!(
5428                "function {:?} already exists (drop or use CREATE OR REPLACE)",
5429                def.name
5430            )));
5431        }
5432        self.functions.insert(key, def);
5433        Ok(())
5434    }
5435
5436    /// v7.39 (read01 round 62) — every overload of `name`.
5437    #[must_use]
5438    pub fn functions_named(&self, name: &str) -> Vec<&FunctionDef> {
5439        self.functions
5440            .values()
5441            .filter(|f| f.name.eq_ignore_ascii_case(name))
5442            .collect()
5443    }
5444
5445    /// v7.39 (read01 round 62) — one overload, by its signature key.
5446    #[must_use]
5447    pub fn function_by_key(&self, key: &str) -> Option<&FunctionDef> {
5448        self.functions.get(key)
5449    }
5450
5451    /// v7.39 (read01 round 62) — drop ONE overload. `true` if it was there.
5452    pub fn drop_function_by_key(&mut self, key: &str) -> bool {
5453        self.functions.remove(key).is_some()
5454    }
5455
5456    /// v7.12.4 — remove a user-defined function by name. Returns
5457    /// `true` if a function was removed, `false` if none matched.
5458    /// Caller decides whether to surface `if_exists` semantics.
5459    /// v7.39 (read01 round 62) — with no signature, PG drops the function only
5460    /// when the name is unambiguous. SPG mirrors that: this removes EVERY
5461    /// overload of `name`, and the caller (ddl.rs) refuses the ambiguous case
5462    /// before getting here.
5463    pub fn drop_function(&mut self, name: &str) -> bool {
5464        let keys: Vec<String> = self
5465            .functions
5466            .iter()
5467            .filter(|(_, f)| f.name.eq_ignore_ascii_case(name))
5468            .map(|(k, _)| k.clone())
5469            .collect();
5470        let hit = !keys.is_empty();
5471        for k in keys {
5472            self.functions.remove(&k);
5473        }
5474        hit
5475    }
5476
5477    /// v7.17.0 — read-only handle to catalogued sequences.
5478    /// v7.39 (read01 round 60) — the `public` schema's ACL (PG nspacl).
5479    #[must_use]
5480    pub fn schema_acl(&self) -> &[AclItem] {
5481        &self.schema_acl
5482    }
5483
5484    pub fn schema_acl_mut(&mut self) -> &mut Vec<AclItem> {
5485        &mut self.schema_acl
5486    }
5487
5488    /// v7.39 (read01 round 60) — the database's ACL.
5489    #[must_use]
5490    pub fn database_acl(&self) -> &[AclItem] {
5491        &self.database_acl
5492    }
5493
5494    pub fn database_acl_mut(&mut self) -> &mut Vec<AclItem> {
5495        &mut self.database_acl
5496    }
5497
5498    /// v7.39 (read01 round 60) — mutable sequence access, for GRANT.
5499    /// v7.39 (round 469) — resolves the session's temporary sequence
5500    /// first, like its read-only twin. `nextval` and `setval` reach the
5501    /// map through here, so a temporary sequence shadowing a permanent one
5502    /// advances the temporary one — measured against PG18, where the
5503    /// permanent sequence's counter is untouched while the temp exists.
5504    pub fn sequence_mut(&mut self, name: &str) -> Option<&mut SequenceDef> {
5505        let key = self.sequence_key(name);
5506        self.sequences.get_mut(&key)
5507    }
5508
5509    /// v7.39 (read01 round 61) — mutable function access, for GRANT.
5510    pub fn function_mut(&mut self, name: &str) -> Option<&mut FunctionDef> {
5511        self.functions.get_mut(name)
5512    }
5513
5514    /// Every catalogued sequence, temp ones included under their mangled
5515    /// storage names. Listing code filters these through
5516    /// [`Self::listed_name`]; anything resolving ONE name by its logical
5517    /// spelling wants [`Self::sequence`] instead.
5518    pub const fn sequences_all(&self) -> &BTreeMap<String, SequenceDef> {
5519        &self.sequences
5520    }
5521
5522    /// v7.39 (round 469) — resolve one sequence by its logical name, the
5523    /// session's temporary one winning over a permanent one of the same
5524    /// name. The same rule [`Self::resolve_index`] applies to tables.
5525    #[must_use]
5526    pub fn sequence(&self, name: &str) -> Option<&SequenceDef> {
5527        if let Some(mangled) = self.temp_name_for(name)
5528            && let Some(def) = self.sequences.get(&mangled)
5529        {
5530            return Some(def);
5531        }
5532        self.sequences.get(name)
5533    }
5534
5535    /// Does a sequence of this logical name exist for this session?
5536    #[must_use]
5537    pub fn has_sequence(&self, name: &str) -> bool {
5538        self.sequence(name).is_some()
5539    }
5540
5541    /// The storage key a sequence of this logical name resolves to — the
5542    /// session's temp mangling when it has one, else the name itself.
5543    #[must_use]
5544    pub fn sequence_key(&self, name: &str) -> String {
5545        if let Some(mangled) = self.temp_name_for(name)
5546            && self.sequences.contains_key(&mangled)
5547        {
5548            return mangled;
5549        }
5550        name.into()
5551    }
5552
5553    /// v7.17.0 — register a new SEQUENCE. Errors if `name`
5554    /// collides with an existing sequence and `if_not_exists`
5555    /// is false.
5556    pub fn create_sequence(
5557        &mut self,
5558        def: SequenceDef,
5559        if_not_exists: bool,
5560    ) -> Result<(), StorageError> {
5561        if self.sequences.contains_key(&def.name) {
5562            if if_not_exists {
5563                return Ok(());
5564            }
5565            // v7.39 (read01 round 47) — a sequence is a relation to PG (42P07).
5566            return Err(StorageError::Corrupt(format!(
5567                "relation {:?} already exists",
5568                def.name
5569            )));
5570        }
5571        self.mark_nontable_dirty(NonTableKind::Sequence, &def.name);
5572        self.sequences.insert(def.name.clone(), def);
5573        Ok(())
5574    }
5575
5576    /// v7.17.0 — remove a SEQUENCE by name. Returns `true` if a
5577    /// sequence was removed, `false` if none matched. Caller
5578    /// surfaces IF EXISTS semantics.
5579    /// v7.39 (read01 round 49) — `ALTER SEQUENCE old RENAME TO new`.
5580    /// Errors when `old` is missing or `new` is taken; the SequenceDef's own
5581    /// `name` field is rewritten so it stays self-describing.
5582    pub fn rename_sequence(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
5583        if !self.sequences.contains_key(old) {
5584            return Err(StorageError::Corrupt(format!(
5585                "relation {old:?} does not exist"
5586            )));
5587        }
5588        if self.sequences.contains_key(new) {
5589            return Err(StorageError::Corrupt(format!(
5590                "relation {new:?} already exists"
5591            )));
5592        }
5593        self.mark_nontable_dirty(NonTableKind::Sequence, old);
5594        self.mark_nontable_dirty(NonTableKind::Sequence, new);
5595        if let Some(mut def) = self.sequences.remove(old) {
5596            def.name = new.to_string();
5597            self.sequences.insert(new.to_string(), def);
5598        }
5599        Ok(())
5600    }
5601
5602    pub fn drop_sequence(&mut self, name: &str) -> bool {
5603        self.mark_nontable_dirty(NonTableKind::Sequence, name);
5604        self.sequences.remove(name).is_some()
5605    }
5606
5607    /// v7.17.0 — atomic nextval. Increments `last_value` per
5608    /// `increment`, returns the new value, sets `is_called`.
5609    /// Returns an error on CYCLE-less overflow.
5610    /// v7.39 (round 497) — the counter state of every sequence, for
5611    /// carrying across a commit install.
5612    ///
5613    /// A sequence's VALUE is not transactional in PG: `nextval` advances
5614    /// shared state that a rollback does not give back, because two
5615    /// sessions must never receive the same number. SPG keeps sequences in
5616    /// the catalog, and a transaction works on a catalog CLONE, so
5617    /// installing that clone at COMMIT would restore whatever the counter
5618    /// was at BEGIN. These two let the install put the live counters back.
5619    #[must_use]
5620    pub fn sequence_counters(&self) -> Vec<(String, i64, bool)> {
5621        self.sequences
5622            .iter()
5623            .map(|(k, d)| (k.clone(), d.last_value, d.is_called))
5624            .collect()
5625    }
5626
5627    /// Restore counters saved by [`Self::sequence_counters`], for the
5628    /// sequences that still exist. A sequence the transaction CREATED is
5629    /// absent from the saved set and keeps the value it was given.
5630    pub fn restore_sequence_counters(&mut self, saved: &[(String, i64, bool)]) {
5631        for (k, last, called) in saved {
5632            if let Some(d) = self.sequences.get_mut(k) {
5633                d.last_value = *last;
5634                d.is_called = *called;
5635            }
5636        }
5637    }
5638
5639    pub fn sequence_next_value(&mut self, name: &str) -> Result<i64, StorageError> {
5640        let key = self.sequence_key(name);
5641        let Some(seq) = self.sequences.get_mut(&key) else {
5642            return Err(StorageError::TableNotFound { name: name.into() });
5643        };
5644        // PG semantics: when !is_called (fresh sequence or
5645        // setval(_, false)), the next nextval returns the stored
5646        // `last_value`. When is_called, it advances by `increment`
5647        // and CYCLE-wraps on overflow.
5648        let candidate = if seq.is_called {
5649            let next = seq.last_value.checked_add(seq.increment).ok_or_else(|| {
5650                StorageError::Corrupt(format!("sequence {name:?} arithmetic overflow"))
5651            })?;
5652            if seq.increment > 0 {
5653                if next > seq.max_value {
5654                    if seq.cycle {
5655                        seq.min_value
5656                    } else {
5657                        // v7.39 (round 220) — PG's 2200H wording, not a
5658                        // Corrupt-classed error.
5659                        return Err(StorageError::SequenceExhausted {
5660                            name: name.into(),
5661                            limit: seq.max_value,
5662                            is_max: true,
5663                        });
5664                    }
5665                } else {
5666                    next
5667                }
5668            } else if next < seq.min_value {
5669                if seq.cycle {
5670                    seq.max_value
5671                } else {
5672                    return Err(StorageError::SequenceExhausted {
5673                        name: name.into(),
5674                        limit: seq.min_value,
5675                        is_max: false,
5676                    });
5677                }
5678            } else {
5679                next
5680            }
5681        } else {
5682            seq.last_value
5683        };
5684        seq.last_value = candidate;
5685        seq.is_called = true;
5686        Ok(candidate)
5687    }
5688
5689    /// v7.17.0 — currval. Errors if the session has never called
5690    /// nextval on this sequence (PG semantics). At the catalog
5691    /// level we approximate "session" with "is_called persisted";
5692    /// the engine session-tracking layer can wrap this for the
5693    /// strict per-session semantics later.
5694    pub fn sequence_current_value(&self, name: &str) -> Result<i64, StorageError> {
5695        let Some(seq) = self.sequences.get(name) else {
5696            return Err(StorageError::TableNotFound { name: name.into() });
5697        };
5698        if !seq.is_called {
5699            return Err(StorageError::Corrupt(format!(
5700                "currval of sequence {name:?} is not yet defined in this session"
5701            )));
5702        }
5703        Ok(seq.last_value)
5704    }
5705
5706    /// v7.17.0 — setval(name, value [, is_called]). PG returns
5707    /// `value` regardless. `is_called=true` means the NEXT
5708    /// nextval will return `value + increment`; `is_called=false`
5709    /// means the next nextval will return `value`.
5710    pub fn sequence_set_value(
5711        &mut self,
5712        name: &str,
5713        value: i64,
5714        is_called: bool,
5715    ) -> Result<i64, StorageError> {
5716        let key = self.sequence_key(name);
5717        let Some(seq) = self.sequences.get_mut(&key) else {
5718            return Err(StorageError::TableNotFound { name: name.into() });
5719        };
5720        // v7.39 (round 244) — PG refuses a value outside the sequence's
5721        // range (22003); SPG accepted it silently, leaving last_value out
5722        // of bounds.
5723        if value < seq.min_value || value > seq.max_value {
5724            return Err(StorageError::Unsupported(format!(
5725                "setval: value {value} is out of bounds for sequence \"{name}\" ({}..{})",
5726                seq.min_value, seq.max_value
5727            )));
5728        }
5729        seq.last_value = value;
5730        seq.is_called = is_called;
5731        Ok(value)
5732    }
5733
5734    /// v7.17.0 Phase 1.2 — read-only handle to catalogued views. Temp ones
5735    /// are in here under their mangled storage names; listing code filters
5736    /// through [`Self::listed_name`], and anything resolving ONE name by
5737    /// its logical spelling wants [`Self::view`].
5738    pub const fn views_all(&self) -> &BTreeMap<String, ViewDef> {
5739        &self.views
5740    }
5741
5742    /// v7.39 (round 469) — resolve one view by its logical name, the
5743    /// session's temporary one winning over a permanent one of the same
5744    /// name.
5745    #[must_use]
5746    pub fn view(&self, name: &str) -> Option<&ViewDef> {
5747        if let Some(mangled) = self.temp_name_for(name)
5748            && let Some(def) = self.views.get(&mangled)
5749        {
5750            return Some(def);
5751        }
5752        self.views.get(name)
5753    }
5754
5755    /// Does a view of this logical name exist for this session?
5756    #[must_use]
5757    pub fn has_view(&self, name: &str) -> bool {
5758        self.view(name).is_some()
5759    }
5760
5761    /// The storage key a view of this logical name resolves to.
5762    #[must_use]
5763    pub fn view_key(&self, name: &str) -> String {
5764        if let Some(mangled) = self.temp_name_for(name)
5765            && self.views.contains_key(&mangled)
5766        {
5767            return mangled;
5768        }
5769        name.into()
5770    }
5771
5772    /// v7.17.0 Phase 1.2 — install a VIEW. `or_replace=true`
5773    /// overwrites an existing entry; `if_not_exists=true` is a
5774    /// silent no-op when the name is taken. Errors if both flags
5775    /// are off and the name collides.
5776    pub fn create_view(
5777        &mut self,
5778        def: ViewDef,
5779        or_replace: bool,
5780        if_not_exists: bool,
5781    ) -> Result<(), StorageError> {
5782        if self.views.contains_key(&def.name) {
5783            if or_replace {
5784                self.mark_nontable_dirty(NonTableKind::View, &def.name);
5785                self.mark_nontable_dirty(NonTableKind::View, &def.name);
5786                self.views.insert(def.name.clone(), def);
5787                return Ok(());
5788            }
5789            if if_not_exists {
5790                return Ok(());
5791            }
5792            // v7.39 (read01 round 47) — a view is a relation to PG (42P07).
5793            return Err(StorageError::Corrupt(format!(
5794                "relation {:?} already exists",
5795                def.name
5796            )));
5797        }
5798        // Reject name collision with tables / sequences — same
5799        // namespace per PG.
5800        if self.by_name.contains_key(&def.name) {
5801            return Err(StorageError::Corrupt(format!(
5802                "view {:?} would shadow an existing table",
5803                def.name
5804            )));
5805        }
5806        if self.sequences.contains_key(&def.name) {
5807            return Err(StorageError::Corrupt(format!(
5808                "view {:?} would shadow an existing sequence",
5809                def.name
5810            )));
5811        }
5812        self.views.insert(def.name.clone(), def);
5813        Ok(())
5814    }
5815
5816    /// v7.17.0 Phase 1.2 — remove a view by name. Returns true if
5817    /// a view was removed.
5818    pub fn drop_view(&mut self, name: &str) -> bool {
5819        self.mark_nontable_dirty(NonTableKind::View, name);
5820        self.views.remove(name).is_some()
5821    }
5822
5823    /// v7.17.0 Phase 1.3 — read-only handle to the materialised-
5824    /// view source registry. Each entry pairs with a regular
5825    /// table of the same name that holds the cached rows.
5826    pub const fn materialized_views(&self) -> &BTreeMap<String, String> {
5827        &self.materialized_views
5828    }
5829
5830    /// v7.17.0 Phase 1.3 — register a source for a materialised
5831    /// view. Caller has already created the backing table.
5832    pub fn register_materialized_view(&mut self, name: String, body: String) {
5833        self.mark_nontable_dirty(NonTableKind::MaterializedView, &name);
5834        self.materialized_views.insert(name, body);
5835    }
5836
5837    /// v7.17.0 Phase 1.3 — drop the source registry entry. Returns
5838    /// true if a source was unregistered. Caller separately drops
5839    /// the backing table.
5840    pub fn drop_materialized_view_source(&mut self, name: &str) -> bool {
5841        self.mark_nontable_dirty(NonTableKind::MaterializedView, name);
5842        self.materialized_views.remove(name).is_some()
5843    }
5844
5845    /// v7.17.0 Phase 1.4 — read-only handle to user-defined ENUM
5846    /// catalog.
5847    pub const fn enum_types(&self) -> &BTreeMap<String, EnumDef> {
5848        &self.enum_types
5849    }
5850
5851    /// v7.17.0 Phase 1.4 — install a new ENUM type. Errors if
5852    /// `name` collides with an existing enum (no IF NOT EXISTS
5853    /// per PG semantics for CREATE TYPE).
5854    pub fn create_enum_type(&mut self, def: EnumDef) -> Result<(), StorageError> {
5855        if self.enum_types.contains_key(&def.name) {
5856            return Err(StorageError::Corrupt(format!(
5857                "type {:?} already exists",
5858                def.name
5859            )));
5860        }
5861        self.mark_nontable_dirty(NonTableKind::EnumType, &def.name);
5862        self.enum_types.insert(def.name.clone(), def);
5863        Ok(())
5864    }
5865
5866    /// v7.17.0 Phase 1.4 — drop an ENUM type by name. Returns
5867    /// true if a type was removed.
5868    /// v7.37 D.55 — `ALTER TYPE … ADD VALUE`. Appends `label` to an existing
5869    /// enum's ordered label list, or inserts it before/after an existing label.
5870    /// `if_not_exists` makes a duplicate a no-op; otherwise a duplicate errors.
5871    /// Returns `Ok(true)` if a label was added, `Ok(false)` if it already existed
5872    /// (only possible under `if_not_exists`).
5873    /// v7.39 (read01 round 49) — `ALTER TYPE t RENAME VALUE 'old' TO 'new'`.
5874    /// The parser used to swallow this form as a no-op, so the rename was
5875    /// accepted and silently ignored. Renaming in place keeps the label's
5876    /// sort position, which is what PG does (enumsortorder is untouched).
5877    pub fn rename_enum_value(
5878        &mut self,
5879        type_name: &str,
5880        old: &str,
5881        new: &str,
5882    ) -> Result<(), StorageError> {
5883        let def = self
5884            .enum_types
5885            .get_mut(type_name)
5886            .ok_or_else(|| StorageError::Corrupt(format!("type {type_name:?} does not exist")))?;
5887        if def.labels.iter().any(|l| l == new) {
5888            return Err(StorageError::Corrupt(format!(
5889                "enum label {new:?} already exists"
5890            )));
5891        }
5892        let at = def.labels.iter().position(|l| l == old).ok_or_else(|| {
5893            StorageError::Corrupt(format!("{old:?} is not an existing enum label"))
5894        })?;
5895        def.labels[at] = new.to_string();
5896        Ok(())
5897    }
5898
5899    /// v7.39 (read01 round 50) — set (or, with `None`, remove) the comment on
5900    /// an object. `key` is the canonical `"<kind>:<name>"` form.
5901    pub fn set_comment(&mut self, key: &str, text: Option<&str>) {
5902        match text {
5903            Some(t) => {
5904                self.comments.insert(key.to_string(), t.to_string());
5905            }
5906            None => {
5907                self.comments.remove(key);
5908            }
5909        }
5910    }
5911
5912    /// v7.39 (read01 round 50) — the comment on an object, if any.
5913    #[must_use]
5914    pub fn comment(&self, key: &str) -> Option<&str> {
5915        self.comments.get(key).map(String::as_str)
5916    }
5917
5918    /// v7.39 (round 547) — record a GUC default for a scope. An empty
5919    /// database or role name is PG's oid 0 ("all"). `None` value
5920    /// removes just that parameter, as PG's RESET does.
5921    pub fn set_db_role_setting(
5922        &mut self,
5923        database: &str,
5924        role: &str,
5925        param: &str,
5926        value: Option<&str>,
5927    ) {
5928        let key = (database.to_string(), role.to_string());
5929        match value {
5930            Some(v) => {
5931                self.db_role_settings
5932                    .entry(key)
5933                    .or_default()
5934                    .insert(param.to_ascii_lowercase(), v.to_string());
5935            }
5936            None => {
5937                if let Some(m) = self.db_role_settings.get_mut(&key) {
5938                    m.remove(&param.to_ascii_lowercase());
5939                    if m.is_empty() {
5940                        self.db_role_settings.remove(&key);
5941                    }
5942                }
5943            }
5944        }
5945    }
5946
5947    /// v7.39 (round 550) — create a replication slot. `Err` carries
5948    /// PG's own message for a duplicate.
5949    ///
5950    /// # Errors
5951    /// When a slot of that name already exists.
5952    pub fn create_replication_slot(
5953        &mut self,
5954        name: &str,
5955        plugin: &str,
5956        slot_type: &str,
5957    ) -> Result<(), String> {
5958        if self.replication_slots.contains_key(name) {
5959            return Err(alloc::format!("replication slot \"{name}\" already exists"));
5960        }
5961        self.replication_slots.insert(
5962            name.to_string(),
5963            (plugin.to_string(), slot_type.to_string()),
5964        );
5965        Ok(())
5966    }
5967
5968    /// # Errors
5969    /// When no slot of that name exists — PG's message, and the case
5970    /// that used to report success.
5971    pub fn drop_replication_slot(&mut self, name: &str) -> Result<(), String> {
5972        if self.replication_slots.remove(name).is_none() {
5973            return Err(alloc::format!("replication slot \"{name}\" does not exist"));
5974        }
5975        Ok(())
5976    }
5977
5978    #[must_use]
5979    pub const fn replication_slots(&self) -> &BTreeMap<String, (String, String)> {
5980        &self.replication_slots
5981    }
5982
5983    /// PG's RESET ALL: drops this scope's whole entry, leaving the
5984    /// other scopes alone — measured on PG18, where `ALTER ROLE r RESET
5985    /// ALL` left the ALL, the database and the role-in-database rows.
5986    pub fn reset_db_role_settings(&mut self, database: &str, role: &str) {
5987        self.db_role_settings
5988            .remove(&(database.to_string(), role.to_string()));
5989    }
5990
5991    #[must_use]
5992    pub const fn db_role_settings(&self) -> &BTreeMap<(String, String), BTreeMap<String, String>> {
5993        &self.db_role_settings
5994    }
5995
5996    /// v7.39 (read01 round 50) — every `(key, text)` pair, for the
5997    /// pg_description view.
5998    #[must_use]
5999    pub const fn comments(&self) -> &BTreeMap<String, String> {
6000        &self.comments
6001    }
6002
6003    /// v7.39 (read01 round 50) — drop every comment whose key names `obj`
6004    /// (the object itself and, for a table, its columns). Called when the
6005    /// object is dropped so a later object of the same name doesn't inherit
6006    /// a stale comment.
6007    pub fn drop_comments_for(&mut self, kind: &str, name: &str) {
6008        let exact = alloc::format!("{kind}:{name}");
6009        let col_prefix = alloc::format!("column:{name}.");
6010        self.comments
6011            .retain(|k, _| *k != exact && !k.starts_with(&col_prefix));
6012    }
6013
6014    pub fn add_enum_value(
6015        &mut self,
6016        type_name: &str,
6017        label: &str,
6018        if_not_exists: bool,
6019        position: Option<(bool, String)>,
6020    ) -> Result<bool, StorageError> {
6021        self.mark_nontable_dirty(NonTableKind::EnumType, type_name);
6022        let def = self
6023            .enum_types
6024            .get_mut(type_name)
6025            .ok_or_else(|| StorageError::Corrupt(format!("type {type_name:?} does not exist")))?;
6026        if def.labels.iter().any(|l| l == label) {
6027            if if_not_exists {
6028                return Ok(false);
6029            }
6030            // v7.39 (read01 round 49) — PG wording (42710 at the wire).
6031            return Err(StorageError::Corrupt(format!(
6032                "enum label {label:?} already exists"
6033            )));
6034        }
6035        match position {
6036            None => def.labels.push(label.to_string()),
6037            Some((is_before, anchor)) => {
6038                let at = def
6039                    .labels
6040                    .iter()
6041                    .position(|l| l == &anchor)
6042                    .ok_or_else(|| {
6043                        StorageError::Corrupt(format!(
6044                            "enum label {anchor:?} does not exist in type {type_name:?}"
6045                        ))
6046                    })?;
6047                let idx = if is_before { at } else { at + 1 };
6048                def.labels.insert(idx, label.to_string());
6049            }
6050        }
6051        Ok(true)
6052    }
6053
6054    pub fn drop_enum_type(&mut self, name: &str) -> bool {
6055        self.mark_nontable_dirty(NonTableKind::EnumType, name);
6056        self.enum_types.remove(name).is_some()
6057    }
6058
6059    /// v7.17.0 Phase 1.5 — read-only handle to DOMAIN catalog.
6060    pub const fn domain_types(&self) -> &BTreeMap<String, DomainDef> {
6061        &self.domain_types
6062    }
6063
6064    /// v7.17.0 Phase 1.5 — install a DOMAIN. Errors on collision
6065    /// with an existing domain.
6066    pub fn create_domain_type(&mut self, def: DomainDef) -> Result<(), StorageError> {
6067        if self.domain_types.contains_key(&def.name) {
6068            return Err(StorageError::Corrupt(format!(
6069                "domain {:?} already exists",
6070                def.name
6071            )));
6072        }
6073        self.mark_nontable_dirty(NonTableKind::DomainType, &def.name);
6074        self.domain_types.insert(def.name.clone(), def);
6075        Ok(())
6076    }
6077
6078    /// v7.17.0 Phase 1.5 — drop a DOMAIN by name.
6079    pub fn drop_domain_type(&mut self, name: &str) -> bool {
6080        self.mark_nontable_dirty(NonTableKind::DomainType, name);
6081        self.domain_types.remove(name).is_some()
6082    }
6083
6084    /// v7.37.42-T2 ζ-B — read-only handle to user-defined COMPOSITE
6085    /// catalog. Used by the engine to resolve
6086    /// `ColumnSchema.user_composite_type` lookups + by
6087    /// information_schema-style introspection.
6088    pub const fn composite_types(&self) -> &BTreeMap<String, CompositeDef> {
6089        &self.composite_types
6090    }
6091
6092    /// v7.37.42-T2 ζ-B — install a new COMPOSITE type. Errors if
6093    /// `name` already exists in the composite registry (PG forbids
6094    /// IF NOT EXISTS on CREATE TYPE composite; the engine surfaces
6095    /// the collision with the existing name).
6096    pub fn create_composite_type(&mut self, def: CompositeDef) -> Result<(), StorageError> {
6097        if self.composite_types.contains_key(&def.name) {
6098            return Err(StorageError::Corrupt(format!(
6099                "type {:?} already exists",
6100                def.name
6101            )));
6102        }
6103        self.mark_nontable_dirty(NonTableKind::CompositeType, &def.name);
6104        self.composite_types.insert(def.name.clone(), def);
6105        Ok(())
6106    }
6107
6108    /// v7.37.42-T2 ζ-B — drop a COMPOSITE type by name. Returns
6109    /// true if a type was removed.
6110    pub fn drop_composite_type(&mut self, name: &str) -> bool {
6111        self.mark_nontable_dirty(NonTableKind::CompositeType, name);
6112        self.composite_types.remove(name).is_some()
6113    }
6114
6115    /// v7.17.0 Phase 1.6 — read-only handle to the user-created
6116    /// schema registry. Built-in schemas (`public`, `pg_catalog`,
6117    /// `information_schema`) are NOT included here; use
6118    /// [`schema_exists`](Self::schema_exists) for the full
6119    /// check.
6120    pub const fn user_schemas(&self) -> &alloc::collections::BTreeSet<String> {
6121        &self.schemas
6122    }
6123
6124    /// v7.17.0 Phase 1.6 — schema-name resolver. Returns true
6125    /// for built-in schemas + every user-CREATEd one. Used by
6126    /// CREATE SCHEMA collision checks and (future) by
6127    /// information_schema.schemata.
6128    pub fn schema_exists(&self, name: &str) -> bool {
6129        is_builtin_schema(name) || self.schemas.contains(name)
6130    }
6131
6132    /// v7.17.0 Phase 1.6 — register a new schema. Errors if the
6133    /// name already exists and `if_not_exists=false`. Built-in
6134    /// names cannot be redeclared.
6135    pub fn create_schema(&mut self, name: String, if_not_exists: bool) -> Result<(), StorageError> {
6136        if is_builtin_schema(&name) {
6137            if if_not_exists {
6138                return Ok(());
6139            }
6140            return Err(StorageError::Corrupt(format!(
6141                "schema {name:?} is built-in and cannot be redeclared"
6142            )));
6143        }
6144        if self.schemas.contains(&name) {
6145            if if_not_exists {
6146                return Ok(());
6147            }
6148            return Err(StorageError::Corrupt(format!(
6149                "schema {name:?} already exists"
6150            )));
6151        }
6152        self.schemas.insert(name);
6153        Ok(())
6154    }
6155
6156    /// v7.17.0 Phase 1.6 — drop a user-created schema. Returns
6157    /// true if a schema was removed. Built-in names always
6158    /// return false (cannot be dropped). Tables that previously
6159    /// used the schema as a prefix keep their bare name and stay
6160    /// queryable — this is the "prefix routing, not isolation"
6161    /// posture documented in v7.17 Phase 1.6.
6162    pub fn drop_schema(&mut self, name: &str) -> Result<bool, StorageError> {
6163        if is_builtin_schema(name) {
6164            return Err(StorageError::Corrupt(format!(
6165                "schema {name:?} is built-in and cannot be dropped"
6166            )));
6167        }
6168        Ok(self.schemas.remove(name))
6169    }
6170
6171    /// v7.17.0 — ALTER SEQUENCE option merge. Caller-provided
6172    /// updates overwrite the matching fields; unset fields keep
6173    /// their stored values. RESTART variants update last_value
6174    /// directly per PG: `RESTART` resets to current `start`;
6175    /// `RESTART WITH n` resets to `n`.
6176    #[allow(clippy::too_many_arguments)]
6177    pub fn alter_sequence(
6178        &mut self,
6179        name: &str,
6180        increment: Option<i64>,
6181        min_value: Option<i64>,
6182        max_value: Option<i64>,
6183        start: Option<i64>,
6184        restart: Option<Option<i64>>,
6185        cache: Option<i64>,
6186        cycle: Option<bool>,
6187        owned_by: Option<Option<(String, String)>>,
6188    ) -> Result<(), StorageError> {
6189        self.mark_nontable_dirty(NonTableKind::Sequence, name);
6190        let Some(seq) = self.sequences.get_mut(name) else {
6191            return Err(StorageError::TableNotFound { name: name.into() });
6192        };
6193        if let Some(v) = increment {
6194            seq.increment = v;
6195        }
6196        if let Some(v) = min_value {
6197            seq.min_value = v;
6198        }
6199        if let Some(v) = max_value {
6200            seq.max_value = v;
6201        }
6202        if let Some(v) = start {
6203            seq.start = v;
6204        }
6205        if let Some(restart_value) = restart {
6206            seq.last_value = restart_value.unwrap_or(seq.start);
6207            seq.is_called = false;
6208        }
6209        if let Some(v) = cache {
6210            seq.cache = v;
6211        }
6212        if let Some(v) = cycle {
6213            seq.cycle = v;
6214        }
6215        if let Some(v) = owned_by {
6216            seq.owned_by = v;
6217        }
6218        Ok(())
6219    }
6220
6221    /// v7.12.4 — read-only slice of all catalogued triggers.
6222    /// Engine row-write paths filter this by (table, event,
6223    /// timing) and fire matches in slice order.
6224    pub fn triggers(&self) -> &[TriggerDef] {
6225        &self.triggers
6226    }
6227
6228    /// v7.15.0 — mutable handle to the trigger slice for
6229    /// `ALTER TABLE … RENAME COLUMN`, which rewrites every
6230    /// `update_columns` entry that referenced the renamed
6231    /// column.
6232    pub fn triggers_mut(&mut self) -> &mut Vec<TriggerDef> {
6233        &mut self.triggers
6234    }
6235
6236    /// v7.12.4 — register a new trigger. With `or_replace = false`,
6237    /// errors when a trigger with the same name already exists on
6238    /// the same table (PG scoping rule — trigger names are
6239    /// per-table, not global). Trigger function must already
6240    /// exist in the catalog at registration time.
6241    pub fn create_trigger(
6242        &mut self,
6243        def: TriggerDef,
6244        or_replace: bool,
6245    ) -> Result<(), StorageError> {
6246        // v7.39 (round 137) — a trigger may target a base table (BEFORE / AFTER)
6247        // or a view (INSTEAD OF). The engine enforces the timing↔target rule;
6248        // storage only requires the relation to exist as one or the other.
6249        if !self.by_name.contains_key(&def.table) && !self.views.contains_key(&def.table) {
6250            return Err(StorageError::TableNotFound {
6251                name: def.table.clone(),
6252            });
6253        }
6254        // v7.39 (read01 round 62) — functions are keyed by SIGNATURE now. A
6255        // trigger names its function by NAME (a trigger function takes no
6256        // arguments), so the existence check goes through the name index.
6257        if self.functions_named(&def.function).is_empty() {
6258            // v7.39 (round 710) — PG's wording: the FUNCTION is what does
6259            // not exist (`function nosuch_fn() does not exist`), and the
6260            // old message rode `Corrupt`'s on-disk banner besides.
6261            return Err(StorageError::Corrupt(format!(
6262                "function {}() does not exist",
6263                def.function
6264            )));
6265        }
6266        let dup = self
6267            .triggers
6268            .iter()
6269            .position(|t| t.name == def.name && t.table == def.table);
6270        match (dup, or_replace) {
6271            (Some(_), false) => Err(StorageError::Corrupt(format!(
6272                "trigger {:?} already exists on table {:?}",
6273                def.name, def.table
6274            ))),
6275            (Some(i), true) => {
6276                self.triggers[i] = def;
6277                Ok(())
6278            }
6279            (None, _) => {
6280                self.triggers.push(def);
6281                Ok(())
6282            }
6283        }
6284    }
6285
6286    /// v7.12.4 — remove a trigger by `(name, table)`. Returns
6287    /// `true` if one was removed.
6288    pub fn drop_trigger(&mut self, name: &str, table: &str) -> bool {
6289        let before = self.triggers.len();
6290        self.triggers
6291            .retain(|t| !(t.name == name && t.table == table));
6292        before != self.triggers.len()
6293    }
6294
6295    /// v7.39 (round 139) — the catalogued query-rewrite RULEs.
6296    pub fn rules(&self) -> &[RuleDef] {
6297        &self.rules
6298    }
6299
6300    /// v7.39 (round 280) — the catalogued extended-statistics objects.
6301    #[must_use]
6302    pub fn statistics_ext(&self) -> &[StatisticsExtDef] {
6303        &self.statistics_ext
6304    }
6305
6306    /// v7.39 (round 287) — every large object, ascending by OID.
6307    #[must_use]
6308    pub fn large_objects(&self) -> &alloc::collections::BTreeMap<u32, Vec<u8>> {
6309        &self.large_objects
6310    }
6311
6312    /// The bytes of one large object, or `None` when no such OID exists.
6313    #[must_use]
6314    pub fn large_object(&self, oid: u32) -> Option<&[u8]> {
6315        self.large_objects.get(&oid).map(Vec::as_slice)
6316    }
6317
6318    /// Create a large object. `oid` of 0 means "pick one" — PG's
6319    /// `lo_create(0)` / `lo_creat(-1)` spelling. Errors when the
6320    /// requested OID is taken.
6321    pub fn create_large_object(&mut self, oid: u32, bytes: Vec<u8>) -> Result<u32, String> {
6322        let id = if oid == 0 {
6323            self.next_large_object_oid()
6324        } else {
6325            oid
6326        };
6327        if self.large_objects.contains_key(&id) {
6328            return Err(format!("large object {id} already exists"));
6329        }
6330        self.large_objects.insert(id, bytes);
6331        Ok(id)
6332    }
6333
6334    /// Overwrite `len` bytes at `offset` (0-based), growing the object
6335    /// with zero bytes if the write starts past the end — PG's
6336    /// `lo_put` semantics.
6337    pub fn put_large_object(&mut self, oid: u32, offset: usize, data: &[u8]) -> Result<(), String> {
6338        let Some(buf) = self.large_objects.get_mut(&oid) else {
6339            return Err(format!("large object {oid} does not exist"));
6340        };
6341        let end = offset.saturating_add(data.len());
6342        if buf.len() < end {
6343            buf.resize(end, 0);
6344        }
6345        buf[offset..end].copy_from_slice(data);
6346        Ok(())
6347    }
6348
6349    /// v7.39 (round 306) — `lo_truncate`. PG's truncate sets the object
6350    /// to exactly `len` bytes in BOTH directions: it shortens, and it
6351    /// GROWS with zero fill when `len` exceeds the current size
6352    /// (measured — `lo_truncate(fd, 8)` over a 4-byte object leaves
6353    /// eight bytes, the last four zero).
6354    pub fn truncate_large_object(&mut self, oid: u32, len: usize) -> Result<(), String> {
6355        let Some(buf) = self.large_objects.get_mut(&oid) else {
6356            return Err(format!("large object {oid} does not exist"));
6357        };
6358        buf.resize(len, 0);
6359        Ok(())
6360    }
6361
6362    /// Remove a large object. `false` when the OID was not there.
6363    pub fn unlink_large_object(&mut self, oid: u32) -> bool {
6364        self.large_objects.remove(&oid).is_some()
6365    }
6366
6367    /// The next free OID in PG's user band.
6368    /// v7.39 (round 343, V40) — large objects have their own oid band.
6369    /// It used to start at 16_384, which is where user TABLES start, so
6370    /// the first large object and the first table shared an oid — and
6371    /// `pg_largeobject_metadata.oid` is joinable against `pg_class.oid`,
6372    /// so a join across them matched a row that has nothing to do with
6373    /// it. (PG cannot collide: every oid there comes off one counter.)
6374    /// An object already stored keeps the oid it was given; only new
6375    /// ones land in the band.
6376    fn next_large_object_oid(&self) -> u32 {
6377        self.large_objects
6378            .keys()
6379            .next_back()
6380            .map_or(500_000, |m| m.saturating_add(1))
6381    }
6382
6383    /// Register one. `Err(name)` when the name is taken.
6384    pub fn create_statistics_ext(&mut self, def: StatisticsExtDef) -> Result<(), String> {
6385        if self.statistics_ext.iter().any(|s| s.name == def.name) {
6386            return Err(def.name);
6387        }
6388        self.statistics_ext.push(def);
6389        Ok(())
6390    }
6391
6392    /// Drop one by name; false when absent.
6393    pub fn drop_statistics_ext(&mut self, name: &str) -> bool {
6394        let before = self.statistics_ext.len();
6395        self.statistics_ext.retain(|s| s.name != name);
6396        before != self.statistics_ext.len()
6397    }
6398
6399    /// v7.39 (round 139) — register a RULE. Its target relation (table or view)
6400    /// must exist; `or_replace` overwrites a same-(name,table) rule.
6401    pub fn create_rule(&mut self, def: RuleDef, or_replace: bool) -> Result<(), StorageError> {
6402        if !self.by_name.contains_key(&def.table) && !self.views.contains_key(&def.table) {
6403            return Err(StorageError::TableNotFound {
6404                name: def.table.clone(),
6405            });
6406        }
6407        let dup = self
6408            .rules
6409            .iter()
6410            .position(|r| r.name == def.name && r.table == def.table);
6411        match (dup, or_replace) {
6412            (Some(_), false) => Err(StorageError::Corrupt(format!(
6413                "rule {:?} for relation {:?} already exists",
6414                def.name, def.table
6415            ))),
6416            (Some(i), true) => {
6417                self.rules[i] = def;
6418                Ok(())
6419            }
6420            (None, _) => {
6421                self.rules.push(def);
6422                Ok(())
6423            }
6424        }
6425    }
6426
6427    /// v7.39 (round 139) — drop a RULE by `(name, table)`.
6428    pub fn drop_rule(&mut self, name: &str, table: &str) -> bool {
6429        let before = self.rules.len();
6430        self.rules.retain(|r| !(r.name == name && r.table == table));
6431        before != self.rules.len()
6432    }
6433
6434    pub fn create_table(&mut self, schema: TableSchema) -> Result<(), StorageError> {
6435        if self.by_name.contains_key(&schema.name) {
6436            return Err(StorageError::DuplicateTable {
6437                name: schema.name.clone(),
6438            });
6439        }
6440        let idx = self.tables.len();
6441        let name = schema.name.clone();
6442        self.tables.push(Table::new(schema));
6443        self.by_name.insert(name.clone(), idx);
6444        // v7.39 (round 496) — see `dirty_tables`.
6445        self.dirty_tables.insert(name);
6446        // v7.37.15 (Phase C.1) — stamp the new relation with a stable,
6447        // monotonic, never-reused RelId. Pre-increment so ids start at
6448        // 1 (0 = UNASSIGNED); a later DROP TABLE frees the slot but not
6449        // the id.
6450        self.next_rel_id += 1;
6451        let rid = row_header::RelId(self.next_rel_id);
6452        self.tables[idx].set_rel_id(rid);
6453        Ok(())
6454    }
6455
6456    /// v7.39 (round 436) — the session's temporary table of this name wins
6457    /// over a permanent one, as `pg_temp` does in PG's search path and as
6458    /// MySQL's TEMPORARY shadowing does. Every name → index resolution in
6459    /// this catalog goes through here.
6460    fn resolve_index(&self, name: &str) -> Option<usize> {
6461        if let Some(prefix) = &self.temp_prefix {
6462            let mut mangled = String::with_capacity(prefix.len() + name.len());
6463            mangled.push_str(prefix);
6464            mangled.push_str(name);
6465            if let Some(idx) = self.by_name.get(&mangled) {
6466                return Some(*idx);
6467            }
6468        }
6469        self.by_name.get(name).copied()
6470    }
6471
6472    /// v7.39 (round 436) — install the calling session's temp namespace.
6473    /// `None` disables temp resolution entirely (a session that never made
6474    /// one pays a single `Option` check per lookup).
6475    pub fn set_temp_prefix(&mut self, prefix: Option<String>) {
6476        self.temp_prefix = prefix;
6477    }
6478
6479    /// The mangled storage name a temp table of `name` takes in this
6480    /// session, or `None` when the session has no temp namespace.
6481    #[must_use]
6482    pub fn temp_name_for(&self, name: &str) -> Option<String> {
6483        self.temp_prefix
6484            .as_ref()
6485            .map(|p| alloc::format!("{p}{name}"))
6486    }
6487
6488    pub fn get(&self, name: &str) -> Option<&Table> {
6489        let idx = self.resolve_index(name)?;
6490        self.tables.get(idx)
6491    }
6492
6493    pub fn get_mut(&mut self, name: &str) -> Option<&mut Table> {
6494        let idx = self.resolve_index(name)?;
6495        // v7.39 (round 496) — the choke point for changing a table, so the
6496        // record is taken here. Over-approximate on purpose: a caller that
6497        // takes the handle and writes nothing merely carries that table
6498        // through a commit, which is the old behaviour.
6499        let recorded = self.tables.get(idx).map(|t| t.schema().name.clone());
6500        if let Some(n) = recorded {
6501            self.dirty_tables.insert(n);
6502        }
6503        self.tables.get_mut(idx)
6504    }
6505
6506    /// v7.39 (round 496) — the tables changed through this handle since
6507    /// [`Self::clear_dirty_tables`]. See `dirty_tables`.
6508    #[must_use]
6509    pub fn dirty_tables(&self) -> &alloc::collections::BTreeSet<String> {
6510        &self.dirty_tables
6511    }
6512
6513    /// r1059 — mark one table dirty without taking its handle. The
6514    /// rebase/merge paths replace a tx's shadow with a fresh base
6515    /// clone and must carry the tx's OWN dirty window across (the
6516    /// base's set is an ever-growing history, never cleared).
6517    pub fn mark_table_dirty(&mut self, name: &str) {
6518        self.dirty_tables.insert(name.into());
6519    }
6520
6521    /// v7.39 (round 496) — start a fresh recording window. A transaction's
6522    /// shadow calls this at BEGIN so the set means "changed by this tx".
6523    /// 7.38.1 S3.1 — one window covers both records (tables and the
6524    /// non-table families).
6525    pub fn clear_dirty_tables(&mut self) {
6526        self.dirty_tables.clear();
6527        self.dirty_nontable.clear();
6528    }
6529
6530    /// 7.38.1 S3.1 (D4) — record a non-table object as changed by this
6531    /// window. Called from every create/alter/rename/drop of the six
6532    /// [`NonTableKind`] families; a rename records BOTH names.
6533    fn mark_nontable_dirty(&mut self, kind: NonTableKind, name: &str) {
6534        self.dirty_nontable.insert((kind, name.into()));
6535    }
6536
6537    /// 7.38.1 S3.1 (D4) — reconcile the six non-table families with
6538    /// `base` (the latest committed catalog): every entry this window
6539    /// did NOT touch is taken from base — existence, definition and
6540    /// absence alike — so a neighbour's CREATE / ALTER / DROP of a
6541    /// sequence, view, matview, enum, domain or composite type
6542    /// survives a poisoned transaction's COMMIT. Entries this window
6543    /// DID touch keep the shadow's version (the tx's own DDL wins its
6544    /// own objects, exactly like the dirty-table merge above it).
6545    pub fn merge_nontable_objects_from(&mut self, base: &Catalog) {
6546        use NonTableKind as K;
6547        fn merge_map<V: Clone>(
6548            kind: NonTableKind,
6549            dirty: &alloc::collections::BTreeSet<(NonTableKind, String)>,
6550            mine: &mut BTreeMap<String, V>,
6551            theirs: &BTreeMap<String, V>,
6552        ) {
6553            let names: alloc::vec::Vec<String> =
6554                mine.keys().chain(theirs.keys()).cloned().collect();
6555            for n in names {
6556                if dirty.contains(&(kind, n.clone())) {
6557                    continue;
6558                }
6559                match theirs.get(&n) {
6560                    Some(v) => {
6561                        mine.insert(n, v.clone());
6562                    }
6563                    None => {
6564                        mine.remove(&n);
6565                    }
6566                }
6567            }
6568        }
6569        let dirty = self.dirty_nontable.clone();
6570        merge_map(K::Sequence, &dirty, &mut self.sequences, &base.sequences);
6571        merge_map(K::View, &dirty, &mut self.views, &base.views);
6572        merge_map(
6573            K::MaterializedView,
6574            &dirty,
6575            &mut self.materialized_views,
6576            &base.materialized_views,
6577        );
6578        merge_map(K::EnumType, &dirty, &mut self.enum_types, &base.enum_types);
6579        merge_map(
6580            K::DomainType,
6581            &dirty,
6582            &mut self.domain_types,
6583            &base.domain_types,
6584        );
6585        merge_map(
6586            K::CompositeType,
6587            &dirty,
6588            &mut self.composite_types,
6589            &base.composite_types,
6590        );
6591    }
6592
6593    /// v7.39 (round 496) — put `table` in at `name`, replacing any table
6594    /// already there and keeping the rest of the catalog untouched.
6595    ///
6596    /// The commit-time table-granularity merge needs exactly this: take
6597    /// the latest committed catalog, then overwrite only the tables the
6598    /// transaction changed.
6599    pub fn install_table(&mut self, name: &str, table: Table) {
6600        match self.by_name.get(name).copied() {
6601            Some(idx) => self.tables[idx] = table,
6602            None => {
6603                let idx = self.tables.len();
6604                self.tables.push(table);
6605                self.by_name.insert(name.into(), idx);
6606            }
6607        }
6608        self.dirty_tables.insert(name.into());
6609    }
6610
6611    /// v7.37.42 (docker-fair SCALARSQ attack) — resolve a table name to
6612    /// its insertion-order index ONCE, so callers that need to fetch the
6613    /// same table many times (per-row PK probes in correlated scalar
6614    /// subqueries) can avoid the per-call `BTreeMap<String, usize>` string
6615    /// descent. The returned index is stable for the lifetime of the
6616    /// catalog snapshot the caller holds (same engine read guard).
6617    pub fn tables_position_of(&self, name: &str) -> Option<usize> {
6618        self.resolve_index(name)
6619    }
6620
6621    /// Direct positional fetch counterpart to [`tables_position_of`].
6622    /// `idx` must come from `tables_position_of` against the same catalog
6623    /// snapshot — out-of-range returns `None`.
6624    pub fn tables_at(&self, idx: usize) -> Option<&Table> {
6625        self.tables.get(idx)
6626    }
6627
6628    /// v7.34 (crash-recovery P0 #2) — replay a row-level redo log onto
6629    /// this catalog (the [`RowChange`] physical-redo apply primitive that
6630    /// row-level WAL recovery will use in place of statement re-execution).
6631    /// Applies each change in order via the same `Table` mutators the
6632    /// engine used — no uniqueness/FK/parse/plan: the original execution
6633    /// already validated, replay trusts and applies. Positions are
6634    /// physical and only valid when replayed from the matching checkpoint
6635    /// baseline in original order (see [`RowChange`] docs).
6636    ///
6637    /// A change naming an absent table, or whose position is out of range,
6638    /// is a corrupt/misaligned log and surfaces as an error rather than a
6639    /// silent skip.
6640    pub fn apply_redo(&mut self, changes: &[RowChange]) -> Result<(), StorageError> {
6641        // v7.37.5 (mailrs crash-recovery Ask 3) — true batched replay.
6642        // Pre-v7.37.5 each `RowChange::Delete` record ran a fresh
6643        // O(N) PersistentVec rebuild + O(N × indices × log N)
6644        // `rebuild_indices()` — 5000 records × 100k rows × 13 indices
6645        // ≈ 27 min on the mailrs prod-shape WAL.
6646        //
6647        // The strategy: group consecutive changes by table, and for
6648        // each run, compose all the row-level mutations through a
6649        // single "live" tracking vector + a per-table operation log,
6650        // then apply rows + indices ONCE at the end. The result:
6651        //  - DELETE blow-up: O(records × rows × indices × log rows)
6652        //    → O(rows × indices × log rows) — one rebuild per run.
6653        //  - Row-position semantics preserved: positions in a later
6654        //    `Delete` / `Update` record reference the layout produced
6655        //    by every earlier change; we walk the live-vector
6656        //    forward as each change is processed so positions
6657        //    translate correctly to the ORIGINAL row index space.
6658        //
6659        // For correctness, even with this batching `apply_redo`
6660        // remains in-order: a single per-table run only batches
6661        // a contiguous slice of changes targeting that table; a
6662        // mid-run change targeting a DIFFERENT table forces a
6663        // flush of the current run.
6664        let mut runs: alloc::vec::Vec<(String, alloc::vec::Vec<&RowChange>)> =
6665            alloc::vec::Vec::new();
6666        for change in changes {
6667            // v7.39 (flip crash-replay P0) — a replayed tombstone carries
6668            // the xmax the CRASHED process allocated, but this process's
6669            // version cursor restarted; without advancing it past every
6670            // replayed version, `Snapshot::visible`'s "deletion is in the
6671            // future" branch (xmax > snapshot.version) resurrects every
6672            // replayed delete. Same recovery contract as the snapshot
6673            // loader (`observe_persisted_version`, the pg_control-style
6674            // nextXid recovery).
6675            if let RowChange::Tombstone { xmax, .. } = change {
6676                row_header::observe_persisted_version(*xmax);
6677            }
6678            let table = match change {
6679                RowChange::Insert { table, .. }
6680                | RowChange::Update { table, .. }
6681                | RowChange::Delete { table, .. }
6682                | RowChange::Tombstone { table, .. } => table.clone(),
6683            };
6684            if runs.last().map(|(t, _)| t.as_str()) != Some(table.as_str()) {
6685                runs.push((table, alloc::vec::Vec::new()));
6686            }
6687            runs.last_mut().unwrap().1.push(change);
6688        }
6689        for (table_name, run) in runs {
6690            self.apply_redo_run_on_table(&table_name, &run)?;
6691        }
6692        Ok(())
6693    }
6694
6695    /// v7.37.5 — apply a contiguous slice of `RowChange`s all
6696    /// targeting the same `table_name`. Composes row mutations
6697    /// through a single live-tracking vector + a single tail
6698    /// for appended `Insert`s + a single in-place edit set for
6699    /// `Update`s, then writes the final row layout to
6700    /// `self.rows` and rebuilds indices ONCE.
6701    fn apply_redo_run_on_table(
6702        &mut self,
6703        table_name: &str,
6704        run: &[&RowChange],
6705    ) -> Result<(), StorageError> {
6706        // Look up the table once; the unchecked unwrap is safe
6707        // because the caller just resolved `table_name` for each
6708        // change.
6709        let table = self.get_mut(table_name).ok_or_else(|| {
6710            StorageError::Corrupt(alloc::format!("redo: unknown table {table_name:?}"))
6711        })?;
6712        // Live-tracking over both pre-existing rows and tail-
6713        // appended Insert rows. `live[i] = true` initially for
6714        // every existing row. Appended Inserts extend with `true`.
6715        // A `Delete` flips entries to `false` (using the position
6716        // mapping that walks live indices in order). An `Update`
6717        // edits in place — collected into an overlay map keyed by
6718        // ORIGINAL row position so later Updates win.
6719        let original_rows: alloc::vec::Vec<Row<'static>> = table.rows().iter().cloned().collect();
6720        let mut live: alloc::vec::Vec<bool> = alloc::vec![true; original_rows.len()];
6721        let mut tail: alloc::vec::Vec<Row<'static>> = alloc::vec::Vec::new();
6722        // Overlay: index into ORIGINAL row space (existing rows
6723        // 0..original_rows.len()) or into tail (offset
6724        // original_rows.len()). Map -> new values.
6725        let mut overlay: alloc::collections::BTreeMap<usize, alloc::vec::Vec<Value<'static>>> =
6726            alloc::collections::BTreeMap::new();
6727        // v7.37.15 (Epic W durable-tombstone slice) — extra bookkeeping
6728        // ONLY when this run actually carries an in-place `Tombstone`.
6729        // A tombstone keeps its row physically present but stamps `xmax`
6730        // on the header; the run finalizer `set_rows_and_rebuild_indices`
6731        // freezes every header (and reassigns ids), so we must re-stamp
6732        // in a post-pass keyed by RowId. When the run has no tombstone
6733        // (every default gate-off replay) this is all skipped and the
6734        // path below stays byte-for-byte the legacy one.
6735        let has_tomb = run.iter().any(|c| matches!(c, RowChange::Tombstone { .. }));
6736        // Ids of the pre-existing rows, snapshotted parallel to
6737        // `original_rows`, and ids of the tail rows filled from each
6738        // `Insert`'s carried `rowid`. Together they let a tombstone name
6739        // the exact row the writer stamped, independent of the ids the
6740        // finalizer will hand out. (When `!has_tomb`, both stay empty.)
6741        // v7.39 (flip crash-replay P0) — ids are tracked UNCONDITIONALLY
6742        // now: the finalizer preserves them so a later WAL record's
6743        // tombstone can still name rows this record produced.
6744        let orig_rowids: alloc::vec::Vec<row_header::RowId> =
6745            table.rowids().iter().copied().collect();
6746        // Headers snapshotted in lock-step: the finalizer preserves
6747        // them so earlier records' tombstone stamps survive.
6748        let orig_headers: alloc::vec::Vec<row_header::RowHeader> =
6749            table.headers().iter().copied().collect();
6750        let mut tail_rowids: alloc::vec::Vec<row_header::RowId> = alloc::vec::Vec::new();
6751        // (RowId, xmax) of every row this run tombstones.
6752        let mut tomb_targets: alloc::vec::Vec<(row_header::RowId, u64)> = alloc::vec::Vec::new();
6753        // Helper: given a "current" position (i.e. position in
6754        // the post-prior-deletes layout), translate to the
6755        // ABSOLUTE position in the unified live + tail space
6756        // by walking the live vector + tail. Returns None when
6757        // the position is out of range.
6758        fn translate(live: &[bool], tail_len: usize, current_pos: usize) -> Option<usize> {
6759            // Walk live[..] counting live entries until we hit
6760            // current_pos. Then if not yet matched, dip into tail.
6761            let mut seen = 0usize;
6762            for (i, &alive) in live.iter().enumerate() {
6763                if alive {
6764                    if seen == current_pos {
6765                        return Some(i);
6766                    }
6767                    seen += 1;
6768                }
6769            }
6770            // Position lives in tail. tail_len rows in the tail
6771            // are all live (we haven't deleted any tail rows in
6772            // this simplification; if we did, we'd extend `live`).
6773            let off = current_pos - seen;
6774            if off < tail_len {
6775                Some(live.len() + off)
6776            } else {
6777                None
6778            }
6779        }
6780        for change in run {
6781            match *change {
6782                RowChange::Insert { row, rowid, .. } => {
6783                    // Validate against schema before recording the
6784                    // change so a corrupt log surfaces as an error
6785                    // rather than silently mis-applying.
6786                    if row.len() != table.schema().columns.len() {
6787                        return Err(StorageError::ArityMismatch {
6788                            expected: table.schema().columns.len(),
6789                            actual: row.len(),
6790                        });
6791                    }
6792                    tail.push(row.clone());
6793                    // Keep the id lock-step with `tail` so a later
6794                    // tombstone (this run or a later WAL record) can
6795                    // find the row by the id the writer captured.
6796                    tail_rowids.push(*rowid);
6797                }
6798                RowChange::Update { pos, new_row, .. } => {
6799                    if new_row.len() != table.schema().columns.len() {
6800                        return Err(StorageError::ArityMismatch {
6801                            expected: table.schema().columns.len(),
6802                            actual: new_row.len(),
6803                        });
6804                    }
6805                    let abs = translate(&live, tail.len(), *pos).ok_or_else(|| {
6806                        StorageError::Corrupt(alloc::format!(
6807                            "redo: update_row position {pos} out of bounds in table {table_name:?}",
6808                        ))
6809                    })?;
6810                    // Tail edits are applied directly to `tail`
6811                    // (we own it); existing-row edits land in
6812                    // the overlay map keyed by original index.
6813                    if abs < live.len() {
6814                        overlay.insert(abs, new_row.clone());
6815                    } else {
6816                        tail[abs - live.len()] = Row::new(new_row.clone());
6817                    }
6818                }
6819                RowChange::Delete { positions, .. } => {
6820                    // De-dup + sort so the translate walk stays
6821                    // monotone (the second translate doesn't have
6822                    // to redo work the first one did, in principle;
6823                    // we keep it simple here and re-walk per
6824                    // position). Bounds-filter silently mirrors
6825                    // `Table::delete_rows`.
6826                    let mut sorted: alloc::vec::Vec<usize> = positions.clone();
6827                    sorted.sort_unstable();
6828                    sorted.dedup();
6829                    // Walk live[] once per Delete record to
6830                    // translate all positions in this record's
6831                    // post-prior-deletes layout to absolute
6832                    // indices. We MUST defer the live[] flip
6833                    // until after all positions are translated
6834                    // so two positions in the same record
6835                    // (e.g. [3, 7]) reference the same layout.
6836                    let mut to_flip_live: alloc::vec::Vec<usize> = alloc::vec::Vec::new();
6837                    let mut to_flip_tail: alloc::vec::Vec<usize> = alloc::vec::Vec::new();
6838                    // Two-pointer walk: live[i] scanned monotonically,
6839                    // sorted positions consumed in order.
6840                    let mut seen = 0usize;
6841                    let mut sp = sorted.iter().peekable();
6842                    for (i, &alive) in live.iter().enumerate() {
6843                        if !alive {
6844                            continue;
6845                        }
6846                        while let Some(&&p) = sp.peek() {
6847                            if seen == p {
6848                                to_flip_live.push(i);
6849                                sp.next();
6850                            } else {
6851                                break;
6852                            }
6853                        }
6854                        if sp.peek().is_none() {
6855                            break;
6856                        }
6857                        seen += 1;
6858                    }
6859                    // Remaining positions fall into the tail.
6860                    for &p in sp {
6861                        // p >= seen and refers to the (p - seen)-th
6862                        // entry in tail. Filter out-of-bounds.
6863                        let off = p - seen;
6864                        if off < tail.len() {
6865                            to_flip_tail.push(off);
6866                        }
6867                    }
6868                    for i in to_flip_live {
6869                        live[i] = false;
6870                        // Any pending overlay edit for this
6871                        // index is moot — the row is gone.
6872                        overlay.remove(&i);
6873                    }
6874                    // Tail deletes: remove in REVERSE order so
6875                    // shifting indices stay valid.
6876                    to_flip_tail.sort_unstable();
6877                    to_flip_tail.dedup();
6878                    for off in to_flip_tail.into_iter().rev() {
6879                        tail.remove(off);
6880                        {
6881                            // Keep the id vector lock-step with `tail`.
6882                            tail_rowids.remove(off);
6883                        }
6884                        // Re-key tail-relative overlay entries that
6885                        // were past `off` — in practice tail edits
6886                        // are applied directly so the overlay map
6887                        // only holds existing-row keys; nothing to
6888                        // do here.
6889                    }
6890                }
6891                RowChange::Tombstone { rowids, xmax, .. } => {
6892                    // An in-place tombstone leaves the row physically
6893                    // present — it does not touch `live` / `tail` /
6894                    // `overlay`. Record the (id, xmax) targets; the
6895                    // post-finalizer pass re-stamps `xmax` onto the
6896                    // matching row's (otherwise-frozen) header.
6897                    for rid in rowids {
6898                        tomb_targets.push((*rid, *xmax));
6899                    }
6900                }
6901            }
6902        }
6903        // Compose the final row layout: keep existing rows where
6904        // live[i] = true, applying overlay edits in place; then
6905        // append the surviving tail.
6906        let mut new_rows: PersistentVec<Row> = PersistentVec::new();
6907        let mut new_hot_bytes: u64 = 0;
6908        let schema_snapshot = table.schema().clone();
6909        // Parallel to `new_rows` (only built when `has_tomb`): the RowId
6910        // of each row in its FINAL slot, so the post-pass can map a
6911        // tombstone target id → the slot to re-stamp `xmax` on.
6912        let mut final_rowids: alloc::vec::Vec<row_header::RowId> = alloc::vec::Vec::new();
6913        let mut final_headers: alloc::vec::Vec<row_header::RowHeader> = alloc::vec::Vec::new();
6914        for (i, row) in original_rows.into_iter().enumerate() {
6915            if !live[i] {
6916                continue;
6917            }
6918            let final_row = if let Some(new_values) = overlay.remove(&i) {
6919                Row::new(new_values)
6920            } else {
6921                row
6922            };
6923            new_hot_bytes = new_hot_bytes
6924                .saturating_add(row_body_encoded_len(&final_row, &schema_snapshot) as u64);
6925            new_rows.push_mut(final_row);
6926            final_rowids.push(
6927                orig_rowids
6928                    .get(i)
6929                    .copied()
6930                    .unwrap_or(row_header::RowId::UNASSIGNED),
6931            );
6932            final_headers.push(
6933                orig_headers
6934                    .get(i)
6935                    .copied()
6936                    .unwrap_or_else(row_header::RowHeader::frozen),
6937            );
6938        }
6939        for (off, row) in tail.into_iter().enumerate() {
6940            new_hot_bytes =
6941                new_hot_bytes.saturating_add(row_body_encoded_len(&row, &schema_snapshot) as u64);
6942            new_rows.push_mut(row);
6943            final_rowids.push(
6944                tail_rowids
6945                    .get(off)
6946                    .copied()
6947                    .unwrap_or(row_header::RowId::UNASSIGNED),
6948            );
6949            final_headers.push(row_header::RowHeader::frozen());
6950        }
6951        // v7.39 (flip crash-replay P0) — id-preserving finalizer, so a
6952        // LATER WAL record's tombstone still resolves rows this record
6953        // produced (per-statement replay used to reassign ids between
6954        // records, orphaning every cross-record tombstone target).
6955        table.set_rows_and_rebuild_indices_with_rowids(
6956            new_rows,
6957            new_hot_bytes,
6958            &final_rowids,
6959            &final_headers,
6960        );
6961        // v7.37.15 (Epic W durable-tombstone slice) — header-preserving
6962        // re-stamp. `set_rows_and_rebuild_indices` above froze every
6963        // header, so any row this run tombstoned is currently all-
6964        // visible again. Re-apply the `xmax` stamp by matching the
6965        // tombstone's target RowId against the final-slot id map. This
6966        // is what makes a gate-on DELETE durable across replay without
6967        // changing the on-disk snapshot format (headers/ids are still
6968        // NOT serialised — that is the deferred V6 coupling; see below).
6969        if has_tomb && !tomb_targets.is_empty() {
6970            let mut id_to_slot: alloc::collections::BTreeMap<row_header::RowId, usize> =
6971                alloc::collections::BTreeMap::new();
6972            for (slot, rid) in final_rowids.iter().enumerate() {
6973                if *rid != row_header::RowId::UNASSIGNED {
6974                    id_to_slot.insert(*rid, slot);
6975                }
6976            }
6977            let table = self.get_mut(table_name).ok_or_else(|| {
6978                StorageError::Corrupt(alloc::format!("redo: unknown table {table_name:?}"))
6979            })?;
6980            for (rid, xmax) in &tomb_targets {
6981                match id_to_slot.get(rid) {
6982                    Some(&slot) => {
6983                        // First-deleter-wins + bounds handled inside.
6984                        let _ = table.mark_row_deleted(slot, *xmax);
6985                    }
6986                    None => {
6987                        // The target row was not produced by THIS redo
6988                        // run and its id was not in the run-start
6989                        // snapshot — the documented cross-checkpoint
6990                        // limitation: after a checkpoint restore the
6991                        // table's ids are reassigned (not yet persisted
6992                        // in the envelope), so a tombstone naming a
6993                        // pre-checkpoint row cannot be resolved by id.
6994                        // Skipping leaves the row visible (identical to
6995                        // the pre-Epic-W non-durable behaviour); it is
6996                        // never a correctness regression, only an
6997                        // unclosed durability gap the V6 envelope slice
6998                        // closes. Counted for observability.
6999                        UNRESOLVED_TOMBSTONES.fetch_add(1, core::sync::atomic::Ordering::Relaxed);
7000                    }
7001                }
7002            }
7003        }
7004        Ok(())
7005    }
7006
7007    fn table_for_redo(&mut self, name: &str) -> Result<&mut Table, StorageError> {
7008        self.get_mut(name)
7009            .ok_or_else(|| StorageError::Corrupt(alloc::format!("redo: unknown table {name:?}")))
7010    }
7011
7012    /// v7.34 (crash-recovery P0 #2) — enable row-level redo capture on
7013    /// every table (the engine calls this before a mutating statement
7014    /// when persistence is on; idempotent, keeps any in-flight capture).
7015    pub fn enable_redo_all(&mut self) {
7016        for t in &mut self.tables {
7017            t.enable_redo();
7018        }
7019    }
7020
7021    /// v7.34 — drain the row-level redo captured across all tables, in
7022    /// table order then per-table apply order, and stop capturing. The
7023    /// engine calls this after a successful mutating statement and writes
7024    /// the returned [`RowChange`]s to the WAL in place of the SQL text.
7025    pub fn drain_redo(&mut self) -> Vec<RowChange> {
7026        let mut all = Vec::new();
7027        for t in &mut self.tables {
7028            all.extend(t.take_redo());
7029        }
7030        all
7031    }
7032
7033    pub fn table_count(&self) -> usize {
7034        self.tables.len()
7035    }
7036
7037    /// v7.14.0 — remove a table by name. Returns `true` when the
7038    /// table existed (and is now gone), `false` when it didn't.
7039    /// Used by `DROP TABLE` from pg_dump / mysqldump preambles
7040    /// where the dump re-creates schema and starts with
7041    /// `DROP TABLE IF EXISTS`.
7042    pub fn drop_table(&mut self, name: &str) -> bool {
7043        // v7.39 (round 436) — resolve through the session's temp namespace
7044        // first, exactly as a read would: MariaDB's plain `DROP TABLE tmp`
7045        // drops the TEMPORARY one and leaves a permanent namesake standing
7046        // (measured). Removing by the raw name would have dropped the
7047        // permanent table out from under every other session.
7048        let key = match self.temp_prefix.as_ref() {
7049            Some(p) => {
7050                let mangled = alloc::format!("{p}{name}");
7051                if self.by_name.contains_key(&mangled) {
7052                    mangled
7053                } else {
7054                    name.into()
7055                }
7056            }
7057            None => name.into(),
7058        };
7059        let Some(idx) = self.by_name.remove(&key) else {
7060            return false;
7061        };
7062        // v7.39 (round 496) — see `dirty_tables`. Recorded under the
7063        // RESOLVED key, which is what a commit-time merge looks up.
7064        self.dirty_tables.insert(key.clone());
7065        // swap_remove invalidates the trailing index → rebuild
7066        // by_name for affected entries.
7067        self.tables.swap_remove(idx);
7068        // Re-stamp moved table's index slot in by_name.
7069        if idx < self.tables.len() {
7070            let moved_name = self.tables[idx].schema.name.clone();
7071            self.by_name.insert(moved_name, idx);
7072        }
7073        true
7074    }
7075
7076    /// v7.16.2 — rename a table (mailrs round-10 A.5). Updates
7077    /// the schema name, the catalog name → index map, and
7078    /// rewrites every reference dangling at the table name:
7079    ///   * every FK on every OTHER table whose `parent_table`
7080    ///     pointed at the old name now points at the new
7081    ///     name, so FK enforcement keeps working
7082    ///   * every trigger watching the table updates its `table`
7083    ///     field
7084    /// Returns `Ok` on success; `Err(StorageError::TableNotFound)`
7085    /// when the old name isn't in the catalog and
7086    /// `Err(StorageError::DuplicateTable)` when the new name is
7087    /// already taken.
7088    pub fn rename_table(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
7089        if old == new {
7090            return Ok(());
7091        }
7092        if self.by_name.contains_key(new) {
7093            return Err(StorageError::Corrupt(format!(
7094                "rename_table: target name {new:?} already exists"
7095            )));
7096        }
7097        let idx = self
7098            .by_name
7099            .remove(old)
7100            .ok_or_else(|| StorageError::TableNotFound { name: old.into() })?;
7101        self.tables[idx].schema.name = new.to_string();
7102        self.by_name.insert(new.to_string(), idx);
7103        for t in &mut self.tables {
7104            for fk in &mut t.schema.foreign_keys {
7105                if fk.parent_table == old {
7106                    fk.parent_table = new.to_string();
7107                }
7108            }
7109        }
7110        for trig in &mut self.triggers {
7111            if trig.table == old {
7112                trig.table = new.to_string();
7113            }
7114        }
7115        Ok(())
7116    }
7117
7118    /// v7.16.2 — rename an index by name. Walks every table
7119    /// since the index lives on its owning table; updates the
7120    /// name in place. Errors with `IndexNotFound` when no
7121    /// index matches. mailrs round-10 A.5.
7122    pub fn rename_index(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
7123        if old == new {
7124            return Ok(());
7125        }
7126        // Reject the new name if it already exists anywhere.
7127        for t in &self.tables {
7128            if t.indices.iter().any(|i| i.name == new) {
7129                return Err(StorageError::Corrupt(format!(
7130                    "rename_index: target name {new:?} already exists"
7131                )));
7132            }
7133        }
7134        for t in &mut self.tables {
7135            for i in &mut t.indices {
7136                if i.name == old {
7137                    i.name = new.to_string();
7138                    return Ok(());
7139                }
7140            }
7141        }
7142        Err(StorageError::IndexNotFound { name: old.into() })
7143    }
7144
7145    /// v7.14.0 — remove a named index across the catalog.
7146    /// Returns `true` when found + dropped.
7147    pub fn drop_named_index(&mut self, name: &str) -> bool {
7148        for t in &mut self.tables {
7149            let before = t.indices.len();
7150            t.indices.retain(|i| i.name != name);
7151            if t.indices.len() != before {
7152                return true;
7153            }
7154        }
7155        false
7156    }
7157
7158    /// Borrow-free copy of every table's name in catalog order
7159    /// (= insertion order, matching the on-disk encoding).
7160    pub fn table_names(&self) -> Vec<String> {
7161        self.tables.iter().map(|t| t.schema.name.clone()).collect()
7162    }
7163
7164    /// v7.39 (round 436) — the marker every session's temporary-table
7165    /// namespace starts with. Public so the catalog synths can tell a
7166    /// temp table from an ordinary one without knowing the session id.
7167    pub const TEMP_NAME_MARKER: &'static str = "__spg_temp_";
7168
7169    /// v7.39 (round 437) — how a stored table name should appear to the
7170    /// CALLING session in a catalog listing (SHOW TABLES, pg_class,
7171    /// information_schema, …):
7172    ///   * an ordinary table → its own name
7173    ///   * this session's temporary table → its logical name, prefix stripped
7174    ///   * another session's temporary table → `None`, i.e. not listed
7175    ///
7176    /// Measured on both oracles: MariaDB 11 and PG 18 each list the calling
7177    /// session's own temporary tables and neither lists anybody else's.
7178    /// Round 436 stored temp tables under a prefix without teaching the
7179    /// listings about it, so the mangled names leaked to every client.
7180    #[must_use]
7181    pub fn listed_name<'a>(&self, stored: &'a str) -> Option<&'a str> {
7182        if !stored.starts_with(Self::TEMP_NAME_MARKER) {
7183            return Some(stored);
7184        }
7185        let prefix = self.temp_prefix.as_ref()?;
7186        stored.strip_prefix(prefix.as_str())
7187    }
7188
7189    /// The listing names of every table this session may see, in catalog
7190    /// order. See [`Catalog::listed_name`].
7191    #[must_use]
7192    pub fn visible_table_names(&self) -> Vec<String> {
7193        self.tables
7194            .iter()
7195            .filter_map(|t| self.listed_name(&t.schema.name).map(String::from))
7196            .collect()
7197    }
7198
7199    /// v5.1: register a cold-tier segment that already lives in
7200    /// memory (caller did the file read). Returns the
7201    /// `segment_id` that `RowLocator::Cold { segment_id, .. }`
7202    /// will reference — currently this is just the index into
7203    /// `cold_segments`, but treat it as an opaque token.
7204    ///
7205    /// Storage is `no_std`, so file I/O is the caller's
7206    /// responsibility — `spg-server` reads the file and forwards
7207    /// the bytes here. The bytes stay resident in the catalog
7208    /// for the life of the `Catalog`, parsed only once.
7209    pub fn load_segment_bytes(&mut self, bytes: Vec<u8>) -> Result<u32, StorageError> {
7210        let id = u32::try_from(self.cold_segments.len()).map_err(|_| {
7211            StorageError::Corrupt("cold segment count would exceed u32::MAX".into())
7212        })?;
7213        let seg = OwnedSegment::from_bytes(bytes)
7214            .map_err(|e| StorageError::Corrupt(format!("cold segment parse failed: {e}")))?;
7215        self.cold_segments.push(Some(Arc::new(seg)));
7216        Ok(id)
7217    }
7218
7219    /// v6.7.3 — register a cold-tier segment at a specific id. Used
7220    /// by the spg-server manifest-boot path so segments whose
7221    /// neighbouring ids were retired by compaction still get back
7222    /// the same `segment_id` they had pre-restart (the
7223    /// `RowLocator::Cold { segment_id }` baked into the BTree-index
7224    /// snapshot persists across restart and must continue to
7225    /// resolve).
7226    ///
7227    /// Pads the Vec with `None` slots up to `target_id` if needed.
7228    /// Errors when the target slot is already occupied (would
7229    /// stomp another segment), the parse fails, or `target_id`
7230    /// exceeds `u32::MAX`.
7231    pub fn load_segment_bytes_at(
7232        &mut self,
7233        target_id: u32,
7234        bytes: Vec<u8>,
7235    ) -> Result<(), StorageError> {
7236        let seg = OwnedSegment::from_bytes(bytes)
7237            .map_err(|e| StorageError::Corrupt(format!("cold segment parse failed: {e}")))?;
7238        let idx = target_id as usize;
7239        while self.cold_segments.len() <= idx {
7240            self.cold_segments.push(None);
7241        }
7242        if self.cold_segments[idx].is_some() {
7243            return Err(StorageError::Corrupt(format!(
7244                "load_segment_bytes_at: segment_id {target_id} already occupied"
7245            )));
7246        }
7247        self.cold_segments[idx] = Some(Arc::new(seg));
7248        Ok(())
7249    }
7250
7251    /// v6.7.3 — retire a cold-tier segment slot (compaction-driven).
7252    /// The physical file is the caller's concern (typically kept
7253    /// on disk until the next CHECKPOINT writes a manifest that
7254    /// no longer lists it); this just flips the in-memory slot
7255    /// to `None` so later cold lookups for `segment_id` resolve
7256    /// as "unknown" instead of returning a stale row.
7257    ///
7258    /// No-op when the slot is already `None`. Errors only when
7259    /// `segment_id` is out of bounds.
7260    pub fn tombstone_segment(&mut self, segment_id: u32) -> Result<(), StorageError> {
7261        let idx = segment_id as usize;
7262        if idx >= self.cold_segments.len() {
7263            return Err(StorageError::Corrupt(format!(
7264                "tombstone_segment: segment_id {segment_id} out of bounds (len={})",
7265                self.cold_segments.len()
7266            )));
7267        }
7268        self.cold_segments[idx] = None;
7269        Ok(())
7270    }
7271
7272    /// Number of *active* (non-tombstoned) cold segments.
7273    #[must_use]
7274    pub fn cold_segment_count(&self) -> usize {
7275        self.cold_segments.iter().filter(|s| s.is_some()).count()
7276    }
7277
7278    /// v7.37.42 (docker-fair SCALARSQ attack 3) — short-circuit guard
7279    /// for scan loops that conditionally walk the cold tier. Returns
7280    /// `false` when the catalog has never loaded a cold segment (or all
7281    /// segments are tombstoned), so callers can skip the per-table cold
7282    /// PK-index walk entirely on hot-only databases. O(N segments);
7283    /// typical N is small (single-digit) so the check is sub-µs.
7284    #[must_use]
7285    pub fn has_any_cold_segments(&self) -> bool {
7286        self.cold_segments.iter().any(Option::is_some)
7287    }
7288
7289    /// Slot count including tombstones (= the next id the
7290    /// no-arg `load_segment_bytes` would allocate).
7291    #[must_use]
7292    pub fn cold_segment_slot_count(&self) -> usize {
7293        self.cold_segments.len()
7294    }
7295
7296    /// v6.2.7 — list every *active* cold-tier segment id known to
7297    /// this catalog (skips compaction tombstones since v6.7.3).
7298    /// Used by EXPLAIN ANALYZE to annotate scan nodes with the
7299    /// segments they could have walked.
7300    #[must_use]
7301    pub fn cold_segment_ids_global(&self) -> Vec<u32> {
7302        self.cold_segments
7303            .iter()
7304            .enumerate()
7305            .filter_map(|(i, s)| s.as_ref().map(|_| i as u32))
7306            .collect()
7307    }
7308
7309    /// v5.2.1: sum of `Table::hot_bytes` across every table. The v5.2
7310    /// freezer compares this against `SPG_HOT_TIER_BYTES` (parsed at
7311    /// server startup; default 4 GiB) and wakes when the budget is
7312    /// crossed. Pre-freezer (v5.2.1) this is measurement-only — the
7313    /// counter exposes whether the budget is being approached without
7314    /// triggering any demotion.
7315    #[must_use]
7316    pub fn hot_tier_bytes(&self) -> u64 {
7317        self.tables
7318            .iter()
7319            .map(Table::hot_bytes)
7320            .fold(0u64, u64::saturating_add)
7321    }
7322
7323    /// v5.2.2: freeze the **first** `max_rows` rows of `table_name`'s
7324    /// hot tier into a brand-new cold-tier segment. The named `BTree`
7325    /// index supplies the per-row PK (its column must be an integer
7326    /// type — v5.2.2 only supports `IndexKey::Int` PKs, matching the
7327    /// `index_key_as_u64` constraint used by the cold-tier lookup
7328    /// path). On success returns a [`FreezeReport`] with the
7329    /// freshly-allocated segment id, the count of rows that moved,
7330    /// the encoded segment bytes (so the caller can persist them to
7331    /// disk for later reload via `SPG_PRELOAD_COLD_SEGMENT`), and the
7332    /// hot-tier byte delta that was reclaimed.
7333    ///
7334    /// **Semantics**:
7335    /// 1. The first `max_rows` rows (by hot-tier position — same as
7336    ///    insertion order under v4.39 `PersistentVec`) are read.
7337    /// 2. Rows are sorted ascending by PK and serialised into a new
7338    ///    segment via [`encode_segment`].
7339    /// 3. The hot rows are dropped via [`Table::delete_rows`]; the
7340    ///    `rebuild_indices` it triggers regenerates `Hot` locators
7341    ///    for every remaining row (their positions shift down by
7342    ///    `max_rows`). Existing `Cold` locators in this index — from
7343    ///    a previous freeze — are also rebuilt **but with empty
7344    ///    payload** since rebuild reads only `self.rows`; this
7345    ///    routine re-registers them at the end of the call so the
7346    ///    user-visible state preserves all prior cold locators.
7347    /// 4. The new segment is loaded into `self.cold_segments` via
7348    ///    [`Catalog::load_segment_bytes`] (allocating a fresh
7349    ///    `segment_id`). New `Cold` locators are registered on the
7350    ///    named index — one per frozen row.
7351    ///
7352    /// **v5.2.2 limits** (relaxed in later sub-versions):
7353    /// - INSERT-only flow: subsequent UPDATE/DELETE on a frozen row
7354    ///   returns a stale-locator error (no promote-on-write until
7355    ///   v5.2.3).
7356    /// - Single-table scope: callers iterate tables themselves.
7357    /// - All-or-nothing: returns `Err` and leaves catalog unchanged
7358    ///   if any step fails before the atomic swap point.
7359    ///
7360    /// Errors:
7361    /// - [`StorageError::Corrupt`] for missing table/index, non-`BTree`
7362    ///   index, non-integer PK column, `max_rows == 0`, or
7363    ///   `max_rows > row_count`.
7364    /// - The encoder's [`SegmentError`] surfaces as `Corrupt` (the
7365    ///   only realistic source is "a single row is larger than the
7366    ///   page size"; SPG schemas don't hit it in practice).
7367    pub fn freeze_oldest_to_cold(
7368        &mut self,
7369        table_name: &str,
7370        index_name: &str,
7371        max_rows: usize,
7372    ) -> Result<FreezeReport, StorageError> {
7373        // --- validation phase: never mutates ---------------------
7374        if max_rows == 0 {
7375            return Err(StorageError::Corrupt(
7376                "freeze_oldest_to_cold: max_rows must be > 0".into(),
7377            ));
7378        }
7379        let table = self.get(table_name).ok_or_else(|| {
7380            StorageError::Corrupt(format!(
7381                "freeze_oldest_to_cold: table {table_name:?} not found"
7382            ))
7383        })?;
7384        if max_rows > table.rows.len() {
7385            return Err(StorageError::Corrupt(format!(
7386                "freeze_oldest_to_cold: max_rows {max_rows} > row_count {}",
7387                table.rows.len()
7388            )));
7389        }
7390        let idx = table
7391            .indices
7392            .iter()
7393            .find(|i| i.name == index_name)
7394            .ok_or_else(|| {
7395                StorageError::Corrupt(format!(
7396                    "freeze_oldest_to_cold: index {index_name:?} not found on {table_name:?}"
7397                ))
7398            })?;
7399        if !matches!(idx.kind, IndexKind::BTree(_)) {
7400            return Err(StorageError::Corrupt(format!(
7401                "freeze_oldest_to_cold: index {index_name:?} is NSW; only BTree indices may freeze"
7402            )));
7403        }
7404        let column_position = idx.column_position;
7405
7406        // --- segment build phase: reads only --------------------
7407        let schema = table.schema.clone();
7408        let mut to_freeze: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(max_rows);
7409        for row_idx in 0..max_rows {
7410            let row = table.rows.get(row_idx).expect("bounds-checked above");
7411            let key = IndexKey::from_value(&row.values[column_position]).ok_or_else(|| {
7412                StorageError::Corrupt(format!(
7413                    "freeze_oldest_to_cold: row {row_idx} has NULL / non-key value in index column"
7414                ))
7415            })?;
7416            let pk_u64 = index_key_as_u64(&key).ok_or_else(|| {
7417                StorageError::Corrupt(format!(
7418                    "freeze_oldest_to_cold: index {index_name:?} column type is non-integer; \
7419                     v5.2.2 cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
7420                ))
7421            })?;
7422            to_freeze.push((pk_u64, encode_row_body_dense(row, &schema), key));
7423        }
7424        // encode_segment requires ascending u64 keys. Sort by PK
7425        // before encoding; the caller's row-position order is not
7426        // necessarily PK order (e.g. workloads that insert random
7427        // PKs).
7428        to_freeze.sort_by_key(|(k, _, _)| *k);
7429        // Reject duplicate PKs — encode_segment also rejects them
7430        // (`SegmentError::UnsortedKey`), but the resulting error
7431        // message there is misleading. Surface a clearer one.
7432        for w in to_freeze.windows(2) {
7433            if w[0].0 == w[1].0 {
7434                return Err(StorageError::Corrupt(format!(
7435                    "freeze_oldest_to_cold: duplicate PK {} in freeze batch",
7436                    w[0].0
7437                )));
7438            }
7439        }
7440        // Snapshot the (key, locator) pairs that will be registered
7441        // post-swap. Cloning the IndexKey out before the move makes
7442        // the registration loop borrow-free.
7443        let post_swap_keys: Vec<IndexKey> = to_freeze.iter().map(|(_, _, k)| k.clone()).collect();
7444        // Segment encode is now infallible w.r.t. ordering. Map the
7445        // `SegmentError` into a `StorageError::Corrupt` so the
7446        // public surface stays one error type.
7447        let seg_rows: Vec<(u64, Vec<u8>)> = to_freeze
7448            .into_iter()
7449            .map(|(k, body, _)| (k, body))
7450            .collect();
7451        let frozen_rows = seg_rows.len();
7452        let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
7453            .map_err(|e| StorageError::Corrupt(format!("freeze_oldest_to_cold: encode: {e}")))?;
7454
7455        // --- atomic swap phase: mutations only past this point ---
7456        // v5.2.3 made `Table::rebuild_indices` preserve every Cold
7457        // locator across the per-table rebuild, so `delete_rows`
7458        // below no longer wipes prior-freeze cold entries. The pre-
7459        // v5.2.3 capture-then-re-register that used to live here
7460        // was removed in v5.3.1 — keeping it would double-count
7461        // every prior-frozen key's Cold locator on each subsequent
7462        // freeze.
7463        let bytes_before = self.get(table_name).expect("just validated").hot_bytes();
7464        let positions: Vec<usize> = (0..max_rows).collect();
7465        let t_mut = self
7466            .get_mut(table_name)
7467            .expect("just validated; still present");
7468        let removed = t_mut.delete_rows(&positions);
7469        debug_assert_eq!(removed, max_rows, "delete_rows count matches request");
7470        let bytes_after = t_mut.hot_bytes();
7471        let bytes_freed = bytes_before.saturating_sub(bytes_after);
7472
7473        let segment_id = self
7474            .load_segment_bytes(seg_bytes.clone())
7475            .map_err(|e| StorageError::Corrupt(format!("freeze_oldest_to_cold: load: {e}")))?;
7476        let new_cold = post_swap_keys.into_iter().map(|k| {
7477            (
7478                k,
7479                RowLocator::Cold {
7480                    segment_id,
7481                    page_offset: 0,
7482                },
7483            )
7484        });
7485        let t_mut = self.get_mut(table_name).expect("still present");
7486        t_mut.register_cold_locators(index_name, new_cold)?;
7487        // r944 — a freeze has to say that it froze something.
7488        //
7489        // `has_cold_rows_fast()` reads the cached count, and neither
7490        // freeze path touched it, so afterwards it answered "no cold
7491        // rows" while cold rows existed. That predicate gates four join
7492        // paths, and a gate that wrongly declines the cold-aware path
7493        // drops the frozen rows from the answer.
7494        //
7495        // Marking it stale rather than adding to it: stale reads as
7496        // true, which is the safe direction, and this function cannot
7497        // know the exact total (rows may already have been cold). ANALYZE
7498        // recomputes the number.
7499        t_mut.mark_cold_row_count_stale();
7500
7501        Ok(FreezeReport {
7502            segment_id,
7503            frozen_rows,
7504            bytes_freed,
7505            segment_bytes: seg_bytes,
7506        })
7507    }
7508
7509    /// v5.1: borrow the cold segment at `segment_id`. Used by the
7510    /// spg-server preload path to enumerate (key, locator) pairs
7511    /// after loading a segment, so it can call
7512    /// [`Table::register_cold_locators`] without re-parsing the
7513    /// bytes.
7514    #[must_use]
7515    pub fn cold_segment(&self, segment_id: u32) -> Option<&OwnedSegment> {
7516        self.cold_segments
7517            .get(segment_id as usize)
7518            .and_then(|s| s.as_deref())
7519    }
7520
7521    /// v5.1: resolve a single `RowLocator::Cold` to its underlying
7522    /// `Row`. Decoupled from [`Catalog::lookup_by_pk`] so callers
7523    /// iterating a multi-locator slice (e.g. the engine's index
7524    /// seek path) can dispatch per locator instead of getting back
7525    /// only the first row for a key. Returns `None` when the
7526    /// segment isn't registered, the key isn't `u64`-coercible, or
7527    /// the segment doesn't actually carry the key (bloom or page-
7528    /// index reject).
7529    pub fn resolve_cold_locator(
7530        &self,
7531        table_name: &str,
7532        segment_id: u32,
7533        key: &IndexKey,
7534    ) -> Option<Row<'static>> {
7535        let t = self.get(table_name)?;
7536        let u64_key = index_key_as_u64(key)?;
7537        let seg = self.cold_segments.get(segment_id as usize)?.as_ref()?;
7538        let payload = seg.lookup(u64_key)?;
7539        let (row, _) = decode_row_body_dense(&payload, &t.schema, seg.codec_version()).ok()?;
7540        // v7.39 (pg_stat blks knife) — one cold-tier "block read".
7541        self.cold_read_stats
7542            .cold_reads
7543            .fetch_add(1, core::sync::atomic::Ordering::Relaxed);
7544        Some(row)
7545    }
7546
7547    /// v5.1: indexed PK lookup that dispatches per locator,
7548    /// returning the first matching row from either the hot tier
7549    /// (`Table::rows`) or a registered cold segment.
7550    ///
7551    /// The cold path requires the index column to be coercible to
7552    /// a `u64` (the segment's PK type) and the segment payload to
7553    /// be a [`encode_row_body_dense`]-encoded row body for the
7554    /// same schema. v5.1 ships this for BIGINT / INT / SMALLINT
7555    /// PKs; other types fall through to hot-only behavior.
7556    ///
7557    /// Returns `None` if (a) the table or index doesn't exist,
7558    /// (b) the key isn't in the index at all, or (c) the key was
7559    /// resolved to a stale locator (Hot index out of range, Cold
7560    /// segment id unknown, segment lookup miss). Does not surface
7561    /// segment-decode errors — those would indicate corrupted
7562    /// cold-tier files and should be caught at
7563    /// [`Catalog::load_segment_bytes`] time.
7564    pub fn lookup_by_pk(&self, table: &str, index_name: &str, key: &IndexKey) -> Option<Row<'_>> {
7565        let t = self.get(table)?;
7566        let idx = t.indices.iter().find(|i| i.name == index_name)?;
7567        let locators = idx.lookup_eq(key);
7568        let cold_u64_key = index_key_as_u64(key);
7569        for loc in locators {
7570            match *loc {
7571                RowLocator::Hot(i) => {
7572                    if let Some(row) = t.rows.get(i) {
7573                        return Some(row.clone());
7574                    }
7575                }
7576                RowLocator::Cold {
7577                    segment_id,
7578                    page_offset: _,
7579                } => {
7580                    let Some(u64_key) = cold_u64_key else {
7581                        // Key type not coercible to u64 — cold tier
7582                        // only handles BIGINT/INT/SMALLINT in v5.1.
7583                        continue;
7584                    };
7585                    let Some(seg) = self
7586                        .cold_segments
7587                        .get(segment_id as usize)
7588                        .and_then(|s| s.as_deref())
7589                    else {
7590                        // v6.7.3 — `None` slot = compaction
7591                        // retired this segment; the live locator
7592                        // on a freshly-compacted index points to
7593                        // the merged segment_id, so a Cold hit
7594                        // here against a tombstone means the BTree
7595                        // entry hasn't been swapped yet (mid-
7596                        // compaction reader race) or the caller is
7597                        // looking up a stale snapshot. Skip — the
7598                        // next locator in the list, if any, is
7599                        // typically the merged segment.
7600                        continue;
7601                    };
7602                    let Some(payload) = seg.lookup(u64_key) else {
7603                        continue;
7604                    };
7605                    let (row, _) =
7606                        decode_row_body_dense(&payload, &t.schema, seg.codec_version()).ok()?;
7607                    return Some(row);
7608                }
7609            }
7610        }
7611        None
7612    }
7613
7614    /// v5.2.3: promote a frozen row back to the hot tier so an
7615    /// UPDATE / DELETE can mutate it. Reads the cold-tier row body
7616    /// (decoded from its registered segment), pushes it into
7617    /// `table.rows` via [`Table::insert`] (which also adds a fresh
7618    /// `Hot(new_idx)` locator on `index_name`), then retires the
7619    /// shadowed `Cold` locator via
7620    /// [`Table::remove_cold_locators_for_key`]. The cold-tier row
7621    /// in the segment file becomes garbage — recoverable when a
7622    /// future cold-segment compaction job lands.
7623    ///
7624    /// Returns:
7625    /// - `Ok(Some(new_hot_idx))` when the key resolved through a
7626    ///   cold locator and the promote completed. `new_hot_idx` is
7627    ///   the position the row now occupies in `table.rows`.
7628    /// - `Ok(None)` when the key has no Cold locator on the index
7629    ///   (already hot, or wasn't present at all). Callers treat this
7630    ///   as "nothing to do here, fall back to the hot-only path".
7631    ///
7632    /// Errors when the table / index doesn't exist, the index isn't
7633    /// `BTree`, the cold segment is missing / can't decode the row,
7634    /// or the inferred row body fails `Table::insert` validation.
7635    pub fn promote_cold_row(
7636        &mut self,
7637        table_name: &str,
7638        index_name: &str,
7639        key: &IndexKey,
7640    ) -> Result<Option<usize>, StorageError> {
7641        let cold_loc = self.find_cold_locator(table_name, index_name, key)?;
7642        let Some((segment_id, _page_offset)) = cold_loc else {
7643            return Ok(None);
7644        };
7645        let u64_key = index_key_as_u64(key).ok_or_else(|| {
7646            StorageError::Corrupt(
7647                "promote_cold_row: key type not coercible to u64 (cold tier requires integer PK)"
7648                    .into(),
7649            )
7650        })?;
7651        // Read the row body from the segment. Borrow the segment +
7652        // schema short-term so we can then take `&mut self` for the
7653        // hot-side insert.
7654        let schema = self
7655            .get(table_name)
7656            .ok_or_else(|| {
7657                StorageError::Corrupt(format!("promote_cold_row: table {table_name:?} not found"))
7658            })?
7659            .schema
7660            .clone();
7661        let seg = self
7662            .cold_segments
7663            .get(segment_id as usize)
7664            .and_then(|s| s.as_ref())
7665            .ok_or_else(|| {
7666                StorageError::Corrupt(format!(
7667                    "promote_cold_row: segment {segment_id} not registered on catalog"
7668                ))
7669            })?;
7670        let payload = seg.lookup(u64_key).ok_or_else(|| {
7671            StorageError::Corrupt(format!(
7672                "promote_cold_row: key {u64_key} resolves to segment {segment_id} \
7673                 but the segment's bloom/page lookup didn't return a row"
7674            ))
7675        })?;
7676        let (row, _consumed) = decode_row_body_dense(&payload, &schema, seg.codec_version())?;
7677        // Insert the promoted row into the hot tier. `Table::insert`
7678        // appends to `self.rows`, adds a `Hot(new_idx)` locator to
7679        // every BTree index covering the row's keyed columns, and
7680        // increments `hot_bytes`.
7681        let t = self
7682            .get_mut(table_name)
7683            .expect("table existed at lookup time");
7684        t.insert(row)?;
7685        let new_hot_idx =
7686            t.rows.len().checked_sub(1).ok_or_else(|| {
7687                StorageError::Corrupt("promote_cold_row: empty after insert".into())
7688            })?;
7689        // The hot insert added Hot(new_idx) alongside the still-
7690        // present Cold locator. Drop the Cold entry so future
7691        // lookups return only the fresh hot row.
7692        t.remove_cold_locators_for_key(index_name, key)?;
7693        Ok(Some(new_hot_idx))
7694    }
7695
7696    /// v5.2.3: shadow a frozen row's index entry. Used by DELETE
7697    /// when the row to remove lives in a cold-tier segment — the
7698    /// row body stays in the segment file (becoming garbage) but
7699    /// every `Cold` locator for `key` on `index_name` is removed
7700    /// so PK lookups stop returning it.
7701    ///
7702    /// Returns the number of cold locators retired (0 when the key
7703    /// has no cold entries — the DELETE fell on a hot row or a
7704    /// key that was already absent). Errors when the table /
7705    /// index doesn't exist or the index isn't `BTree`.
7706    ///
7707    /// Cold-segment compaction (which merges shadowed-heavy
7708    /// segments and reclaims their disk footprint) lands in a
7709    /// later v5.x sub-version; until then, repeated UPDATE/DELETE
7710    /// of cold rows can amplify cold-segment disk usage by up to
7711    /// 1-2× — still well under typical LSM-tree shadowing because
7712    /// SPG segments are bulk-baked, not write-merged.
7713    pub fn shadow_cold_row(
7714        &mut self,
7715        table_name: &str,
7716        index_name: &str,
7717        key: &IndexKey,
7718    ) -> Result<usize, StorageError> {
7719        let t = self.get_mut(table_name).ok_or_else(|| {
7720            StorageError::Corrupt(format!("shadow_cold_row: table {table_name:?} not found"))
7721        })?;
7722        t.remove_cold_locators_for_key(index_name, key)
7723    }
7724
7725    /// v6.7.4 — read-only slice preparation for the parallel
7726    /// freezer. Walks rows in `row_range`, builds the
7727    /// `(pk_u64, encoded_body, IndexKey)` triples that the
7728    /// coordinator's k-way merge consumes, sorts the slice by
7729    /// `pk_u64`, and returns a [`FreezeSlice`].
7730    ///
7731    /// Caller invariants:
7732    /// - `row_range.end <= table.rows.len()` (caller's job to
7733    ///   compute the partition).
7734    /// - All slices passed to `commit_freeze_slices` must cover a
7735    ///   contiguous half-open range `[0, total_max_rows)` with no
7736    ///   gaps and no overlaps. The coordinator validates this
7737    ///   invariant before committing.
7738    ///
7739    /// `&self`-only — multiple workers can run this concurrently
7740    /// against the same `Catalog` reference under the engine's
7741    /// write lock (workers don't mutate; the coordinator does).
7742    pub fn prepare_freeze_slice(
7743        &self,
7744        table_name: &str,
7745        index_name: &str,
7746        row_range: core::ops::Range<usize>,
7747    ) -> Result<FreezeSlice, StorageError> {
7748        let table = self.get(table_name).ok_or_else(|| {
7749            StorageError::Corrupt(format!(
7750                "prepare_freeze_slice: table {table_name:?} not found"
7751            ))
7752        })?;
7753        let idx = table
7754            .indices
7755            .iter()
7756            .find(|i| i.name == index_name)
7757            .ok_or_else(|| {
7758                StorageError::Corrupt(format!(
7759                    "prepare_freeze_slice: index {index_name:?} not found on {table_name:?}"
7760                ))
7761            })?;
7762        if !matches!(idx.kind, IndexKind::BTree(_)) {
7763            return Err(StorageError::Corrupt(format!(
7764                "prepare_freeze_slice: index {index_name:?} is NSW; only BTree indices may freeze"
7765            )));
7766        }
7767        if row_range.end > table.rows.len() {
7768            return Err(StorageError::Corrupt(format!(
7769                "prepare_freeze_slice: row_range end {} > row_count {}",
7770                row_range.end,
7771                table.rows.len()
7772            )));
7773        }
7774        let column_position = idx.column_position;
7775        let schema = table.schema.clone();
7776        let mut rows: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(row_range.len());
7777        for row_idx in row_range.clone() {
7778            let row = table.rows.get(row_idx).expect("bounds-checked above");
7779            let key = IndexKey::from_value(&row.values[column_position]).ok_or_else(|| {
7780                StorageError::Corrupt(format!(
7781                    "prepare_freeze_slice: row {row_idx} has NULL / non-key value in index column"
7782                ))
7783            })?;
7784            let pk_u64 = index_key_as_u64(&key).ok_or_else(|| {
7785                StorageError::Corrupt(format!(
7786                    "prepare_freeze_slice: index {index_name:?} column type is non-integer; \
7787                     v5.2.2 cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
7788                ))
7789            })?;
7790            rows.push((pk_u64, encode_row_body_dense(row, &schema), key));
7791        }
7792        rows.sort_by_key(|(k, _, _)| *k);
7793        Ok(FreezeSlice { row_range, rows })
7794    }
7795
7796    /// v6.7.4 — coordinator commit step. Merges N
7797    /// [`FreezeSlice`]s into one segment via the standard
7798    /// [`encode_segment`] path, atomically swaps the catalog
7799    /// state (delete the union row range + register Cold
7800    /// locators + load the segment).
7801    ///
7802    /// Validates that the slices cover a contiguous, gap-free,
7803    /// overlap-free half-open range starting at index 0 (the
7804    /// freezer always freezes "oldest first" — same semantics as
7805    /// the single-threaded [`Catalog::freeze_oldest_to_cold`]).
7806    ///
7807    /// Empty `slices` → no-op success (returns a zero-row report
7808    /// without mutating). Total row count = `Σ slice.rows.len()`.
7809    pub fn commit_freeze_slices(
7810        &mut self,
7811        table_name: &str,
7812        index_name: &str,
7813        slices: Vec<FreezeSlice>,
7814    ) -> Result<FreezeReport, StorageError> {
7815        // --- validation phase: never mutates ---------------------
7816        let table = self.get(table_name).ok_or_else(|| {
7817            StorageError::Corrupt(format!(
7818                "commit_freeze_slices: table {table_name:?} not found"
7819            ))
7820        })?;
7821        let idx = table
7822            .indices
7823            .iter()
7824            .find(|i| i.name == index_name)
7825            .ok_or_else(|| {
7826                StorageError::Corrupt(format!(
7827                    "commit_freeze_slices: index {index_name:?} not found on {table_name:?}"
7828                ))
7829            })?;
7830        if !matches!(idx.kind, IndexKind::BTree(_)) {
7831            return Err(StorageError::Corrupt(format!(
7832                "commit_freeze_slices: index {index_name:?} is NSW; only BTree indices may freeze"
7833            )));
7834        }
7835        // Validate slice coverage: contiguous from 0, no gaps, no
7836        // overlaps. Allow the caller to pass slices in any order —
7837        // sort by row_range.start first.
7838        let mut ordered = slices;
7839        ordered.sort_by_key(|s| s.row_range.start);
7840        // Drop fully-empty slices that fell out of an uneven
7841        // partition; they carry no data but contribute to the
7842        // contiguity check, so keep them in line.
7843        let mut expected_start = 0usize;
7844        for s in &ordered {
7845            if s.row_range.start != expected_start {
7846                return Err(StorageError::Corrupt(format!(
7847                    "commit_freeze_slices: gap/overlap at row {}; expected start {}",
7848                    s.row_range.start, expected_start
7849                )));
7850            }
7851            expected_start = s.row_range.end;
7852        }
7853        let max_rows = expected_start;
7854        if max_rows > table.rows.len() {
7855            return Err(StorageError::Corrupt(format!(
7856                "commit_freeze_slices: total row range {} exceeds row_count {}",
7857                max_rows,
7858                table.rows.len()
7859            )));
7860        }
7861        if max_rows == 0 {
7862            return Ok(FreezeReport {
7863                segment_id: u32::MAX,
7864                frozen_rows: 0,
7865                bytes_freed: 0,
7866                segment_bytes: Vec::new(),
7867            });
7868        }
7869
7870        // --- segment build phase: reads only --------------------
7871        // K-way merge of already-sorted slices. Each slice's rows
7872        // are ascending by pk_u64; we keep a per-slice cursor and
7873        // pull the next-smallest head until every cursor drains.
7874        let total_rows: usize = ordered.iter().map(|s| s.rows.len()).sum();
7875        if total_rows != max_rows {
7876            return Err(StorageError::Corrupt(format!(
7877                "commit_freeze_slices: total slice rows {total_rows} ≠ row_range coverage {max_rows}"
7878            )));
7879        }
7880        let mut cursors: Vec<usize> = alloc::vec![0; ordered.len()];
7881        let mut merged: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(total_rows);
7882        loop {
7883            // Pick the slice whose head row has the smallest key
7884            // and isn't yet exhausted.
7885            let mut pick: Option<usize> = None;
7886            for (i, c) in cursors.iter().enumerate() {
7887                let slice = &ordered[i];
7888                if *c >= slice.rows.len() {
7889                    continue;
7890                }
7891                match pick {
7892                    None => pick = Some(i),
7893                    Some(j) => {
7894                        if slice.rows[*c].0 < ordered[j].rows[cursors[j]].0 {
7895                            pick = Some(i);
7896                        }
7897                    }
7898                }
7899            }
7900            let Some(i) = pick else { break };
7901            let row = ordered[i].rows[cursors[i]].clone();
7902            cursors[i] += 1;
7903            merged.push(row);
7904        }
7905        // Reject duplicate PKs — same error as the single-threaded
7906        // path so callers get a uniform surface.
7907        for w in merged.windows(2) {
7908            if w[0].0 == w[1].0 {
7909                return Err(StorageError::Corrupt(format!(
7910                    "commit_freeze_slices: duplicate PK {} across slices",
7911                    w[0].0
7912                )));
7913            }
7914        }
7915        let post_swap_keys: Vec<IndexKey> = merged.iter().map(|(_, _, k)| k.clone()).collect();
7916        let seg_rows: Vec<(u64, Vec<u8>)> =
7917            merged.into_iter().map(|(k, body, _)| (k, body)).collect();
7918        let frozen_rows = seg_rows.len();
7919        let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
7920            .map_err(|e| StorageError::Corrupt(format!("commit_freeze_slices: encode: {e}")))?;
7921
7922        // --- atomic swap phase: mutations only past this point ---
7923        let bytes_before = self.get(table_name).expect("just validated").hot_bytes();
7924        let positions: Vec<usize> = (0..max_rows).collect();
7925        let t_mut = self
7926            .get_mut(table_name)
7927            .expect("just validated; still present");
7928        let removed = t_mut.delete_rows(&positions);
7929        debug_assert_eq!(removed, max_rows, "delete_rows count matches request");
7930        let bytes_after = t_mut.hot_bytes();
7931        let bytes_freed = bytes_before.saturating_sub(bytes_after);
7932
7933        let segment_id = self
7934            .load_segment_bytes(seg_bytes.clone())
7935            .map_err(|e| StorageError::Corrupt(format!("commit_freeze_slices: load: {e}")))?;
7936        let new_cold = post_swap_keys.into_iter().map(|k| {
7937            (
7938                k,
7939                RowLocator::Cold {
7940                    segment_id,
7941                    page_offset: 0,
7942                },
7943            )
7944        });
7945        let t_mut = self.get_mut(table_name).expect("still present");
7946        t_mut.register_cold_locators(index_name, new_cold)?;
7947        // r944 — a freeze has to say that it froze something.
7948        //
7949        // `has_cold_rows_fast()` reads the cached count, and neither
7950        // freeze path touched it, so afterwards it answered "no cold
7951        // rows" while cold rows existed. That predicate gates four join
7952        // paths, and a gate that wrongly declines the cold-aware path
7953        // drops the frozen rows from the answer.
7954        //
7955        // Marking it stale rather than adding to it: stale reads as
7956        // true, which is the safe direction, and this function cannot
7957        // know the exact total (rows may already have been cold). ANALYZE
7958        // recomputes the number.
7959        t_mut.mark_cold_row_count_stale();
7960
7961        Ok(FreezeReport {
7962            segment_id,
7963            frozen_rows,
7964            bytes_freed,
7965            segment_bytes: seg_bytes,
7966        })
7967    }
7968
7969    /// v6.7.3 — compact every cold segment on `(table, index)` whose
7970    /// `OwnedSegment::bytes().len()` is below `target_segment_bytes`
7971    /// into a single larger merged segment. Rows present in source
7972    /// segment payloads but no longer referenced by any
7973    /// `RowLocator::Cold` on the index (DELETE'd + frozen rows
7974    /// retired via [`Catalog::shadow_cold_row`]) are GC'd in the
7975    /// merge.
7976    ///
7977    /// **Semantics**:
7978    /// 1. Walk the BTree index to collect every Cold locator that
7979    ///    targets a small (< threshold) segment. Each such
7980    ///    `(key, segment_id)` becomes a row in the merged segment;
7981    ///    payload is looked up from the source segment in-place.
7982    /// 2. Encode the collected rows into one new segment via
7983    ///    [`encode_segment`]; register it via
7984    ///    [`Catalog::load_segment_bytes`] (allocating a fresh
7985    ///    `merged_segment_id` at the end of `cold_segments`).
7986    /// 3. Rewrite the BTree index in one pass: every
7987    ///    `RowLocator::Cold { segment_id ∈ sources }` becomes
7988    ///    `RowLocator::Cold { segment_id = merged_id, page_offset = 0 }`.
7989    ///    Hot locators are untouched.
7990    /// 4. Tombstone every source slot via
7991    ///    [`Catalog::tombstone_segment`]. Source segment payloads
7992    ///    are no longer reachable through the catalog; the on-disk
7993    ///    files are the caller's concern.
7994    ///
7995    /// On fewer than 2 candidate segments the catalog is **not**
7996    /// mutated and a no-op report (`merged_segment_id: None`,
7997    /// `sources: []`) is returned. This is the routine case — a
7998    /// freshly-frozen table has at most 1 small segment, no merge
7999    /// possible.
8000    ///
8001    /// Atomicity: every mutating step runs after the read-only
8002    /// gather phase, so a panic before the merge encode leaves the
8003    /// catalog unchanged. The mutation block itself (load + rewrite +
8004    /// tombstone) takes only `&mut self` — callers serialise the
8005    /// engine write lock outside this function.
8006    ///
8007    /// Errors when the table / index doesn't exist, the index isn't
8008    /// `BTree`, the index column type isn't u64-coercible (cold-tier
8009    /// pre-condition), or a source segment fails its in-place
8010    /// row-body lookup (would indicate prior catalog corruption).
8011    pub fn compact_cold_segments(
8012        &mut self,
8013        table_name: &str,
8014        index_name: &str,
8015        target_segment_bytes: u64,
8016    ) -> Result<CompactReport, StorageError> {
8017        // --- validation phase ----------------------------------
8018        let t = self.get(table_name).ok_or_else(|| {
8019            StorageError::Corrupt(format!(
8020                "compact_cold_segments: table {table_name:?} not found"
8021            ))
8022        })?;
8023        let idx = t
8024            .indices
8025            .iter()
8026            .find(|i| i.name == index_name)
8027            .ok_or_else(|| {
8028                StorageError::Corrupt(format!(
8029                    "compact_cold_segments: index {index_name:?} not found on {table_name:?}"
8030                ))
8031            })?;
8032        let map = match &idx.kind {
8033            IndexKind::BTree(m) => m,
8034            IndexKind::Nsw(_)
8035            | IndexKind::Brin { .. }
8036            | IndexKind::Gin(_)
8037            | IndexKind::GinTrgm(_)
8038            | IndexKind::GinFulltext(_)
8039            | IndexKind::GinJsonb(_)
8040            | IndexKind::BTreeMulti(_) => {
8041                return Err(StorageError::Corrupt(format!(
8042                    "compact_cold_segments: index {index_name:?} is not BTree; \
8043                     compaction applies only to BTree cold-tier indices"
8044                )));
8045            }
8046        };
8047
8048        // --- gather phase --------------------------------------
8049        // Step A: every segment_id this BTree index Cold-references.
8050        let mut referenced_ids: BTreeSet<u32> = BTreeSet::new();
8051        for (_key, locators) in map.iter() {
8052            for loc in locators {
8053                if let RowLocator::Cold { segment_id, .. } = loc {
8054                    referenced_ids.insert(*segment_id);
8055                }
8056            }
8057        }
8058        // Step B: keep only the small + still-active ones.
8059        let candidate_set: BTreeSet<u32> = referenced_ids
8060            .into_iter()
8061            .filter(|id| {
8062                self.cold_segments
8063                    .get(*id as usize)
8064                    .and_then(|s| s.as_deref())
8065                    .is_some_and(|s| (s.bytes().len() as u64) < target_segment_bytes)
8066            })
8067            .collect();
8068        if candidate_set.len() < 2 {
8069            return Ok(CompactReport {
8070                sources: Vec::new(),
8071                merged_segment_id: None,
8072                merged_segment_bytes: Vec::new(),
8073                merged_rows: 0,
8074                deleted_rows_pruned: 0,
8075                bytes_reclaimed_estimate: 0,
8076            });
8077        }
8078        // Step C: pre-count source rows for the deleted-pruned metric.
8079        let mut source_row_count: usize = 0;
8080        let mut source_byte_total: u64 = 0;
8081        for &id in &candidate_set {
8082            let seg = self.cold_segments[id as usize]
8083                .as_ref()
8084                .expect("candidate selected only when slot is Some");
8085            source_row_count = source_row_count.saturating_add(seg.meta().num_rows as usize);
8086            source_byte_total = source_byte_total.saturating_add(seg.bytes().len() as u64);
8087        }
8088        // Step D: collect (key, body) pairs from every live Cold
8089        // locator pointing at a candidate. dedupe by key — one
8090        // BTree key resolves to at most one cold payload (the
8091        // freezer + promote/shadow flow keeps Cold locators
8092        // unique per key).
8093        let mut collected: BTreeMap<u64, (Vec<u8>, IndexKey)> = BTreeMap::new();
8094        for (key, locators) in map.iter() {
8095            for loc in locators {
8096                let RowLocator::Cold { segment_id, .. } = loc else {
8097                    continue;
8098                };
8099                if !candidate_set.contains(segment_id) {
8100                    continue;
8101                }
8102                let u64_key = index_key_as_u64(key).ok_or_else(|| {
8103                    StorageError::Corrupt(format!(
8104                        "compact_cold_segments: index {index_name:?} has non-integer Cold key; \
8105                         cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
8106                    ))
8107                })?;
8108                let seg = self.cold_segments[*segment_id as usize]
8109                    .as_ref()
8110                    .expect("candidate slot guaranteed Some above");
8111                let payload = seg.lookup(u64_key).ok_or_else(|| {
8112                    StorageError::Corrupt(format!(
8113                        "compact_cold_segments: BTree {index_name:?} points key={u64_key} \
8114                         at segment {segment_id} but the segment lookup missed"
8115                    ))
8116                })?;
8117                collected.insert(u64_key, (payload, key.clone()));
8118                break;
8119            }
8120        }
8121        let merged_rows = collected.len();
8122        let deleted_rows_pruned = source_row_count.saturating_sub(merged_rows);
8123
8124        // Step E: encode the merged segment. `BTreeMap<u64, _>`
8125        // iteration is ascending by key, which is what
8126        // `encode_segment` requires.
8127        let seg_rows: Vec<(u64, Vec<u8>)> = collected
8128            .iter()
8129            .map(|(k, (body, _))| (*k, body.clone()))
8130            .collect();
8131        let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
8132            .map_err(|e| StorageError::Corrupt(format!("compact_cold_segments: encode: {e}")))?;
8133        let merged_bytes_len = seg_bytes.len() as u64;
8134
8135        // --- atomic mutation phase ------------------------------
8136        let merged_segment_id = self
8137            .load_segment_bytes(seg_bytes.clone())
8138            .map_err(|e| StorageError::Corrupt(format!("compact_cold_segments: load: {e}")))?;
8139
8140        // Rewrite the BTree index: every Cold locator pointing at
8141        // a candidate source becomes a Cold locator pointing at
8142        // the merged segment. Use a flat collect-then-replace
8143        // pattern so we never hold a `&self` borrow across the
8144        // `&mut self` write.
8145        let entries: Vec<(IndexKey, crate::posting::PostingList)> = {
8146            let t = self
8147                .get(table_name)
8148                .expect("table existed at the start of this fn");
8149            let idx = t
8150                .indices
8151                .iter()
8152                .find(|i| i.name == index_name)
8153                .expect("index existed at the start of this fn");
8154            let IndexKind::BTree(map) = &idx.kind else {
8155                unreachable!("validated above");
8156            };
8157            map.iter().map(|(k, v)| (k.clone(), v.clone())).collect()
8158        };
8159        let t_mut = self
8160            .get_mut(table_name)
8161            .expect("table existed at the start of this fn");
8162        let idx_mut = t_mut
8163            .indices
8164            .iter_mut()
8165            .find(|i| i.name == index_name)
8166            .expect("index existed at the start of this fn");
8167        let IndexKind::BTree(map_mut) = &mut idx_mut.kind else {
8168            unreachable!("validated above");
8169        };
8170        for (key, locators) in entries {
8171            let mut new_locs = crate::posting::PostingList::new();
8172            let mut changed = false;
8173            for loc in &locators {
8174                match *loc {
8175                    RowLocator::Cold {
8176                        segment_id,
8177                        page_offset: _,
8178                    } if candidate_set.contains(&segment_id) => {
8179                        let replacement = RowLocator::Cold {
8180                            segment_id: merged_segment_id,
8181                            page_offset: 0,
8182                        };
8183                        if !new_locs.contains(replacement) {
8184                            new_locs.push(replacement);
8185                        }
8186                        changed = true;
8187                    }
8188                    other => new_locs.push(other),
8189                }
8190            }
8191            if changed {
8192                map_mut.insert_mut(key, new_locs);
8193            }
8194        }
8195
8196        // Tombstone every source slot. Last step — failures here
8197        // would leave the segment double-referenced in both
8198        // memory + manifest, but `tombstone_segment` only errors
8199        // on out-of-bounds, which we've already validated.
8200        for &id in &candidate_set {
8201            self.tombstone_segment(id)?;
8202        }
8203
8204        let bytes_reclaimed_estimate = source_byte_total.saturating_sub(merged_bytes_len);
8205        Ok(CompactReport {
8206            sources: candidate_set.into_iter().collect(),
8207            merged_segment_id: Some(merged_segment_id),
8208            merged_segment_bytes: seg_bytes,
8209            merged_rows,
8210            deleted_rows_pruned,
8211            bytes_reclaimed_estimate,
8212        })
8213    }
8214
8215    /// Internal helper: scan `(table, index)` for a `Cold` locator
8216    /// keyed by `key`. Returns `Ok(Some((segment_id, page_offset)))`
8217    /// when found, `Ok(None)` when the key has only hot entries
8218    /// or no entries at all, `Err` on the same input-validation
8219    /// errors as the public `promote_cold_row` / `shadow_cold_row`.
8220    fn find_cold_locator(
8221        &self,
8222        table_name: &str,
8223        index_name: &str,
8224        key: &IndexKey,
8225    ) -> Result<Option<(u32, u32)>, StorageError> {
8226        let t = self.get(table_name).ok_or_else(|| {
8227            StorageError::Corrupt(format!("find_cold_locator: table {table_name:?} not found"))
8228        })?;
8229        let idx = t
8230            .indices
8231            .iter()
8232            .find(|i| i.name == index_name)
8233            .ok_or_else(|| {
8234                StorageError::Corrupt(format!(
8235                    "find_cold_locator: index {index_name:?} not found on {table_name:?}"
8236                ))
8237            })?;
8238        if !matches!(idx.kind, IndexKind::BTree(_)) {
8239            return Err(StorageError::Corrupt(format!(
8240                "find_cold_locator: index {index_name:?} is NSW; promote-on-write only applies to BTree indices"
8241            )));
8242        }
8243        for loc in idx.lookup_eq(key) {
8244            if let RowLocator::Cold {
8245                segment_id,
8246                page_offset,
8247            } = *loc
8248            {
8249                return Ok(Some((segment_id, page_offset)));
8250            }
8251        }
8252        Ok(None)
8253    }
8254}
8255
8256/// Coerce an [`IndexKey`] to the `u64` that v5.1 cold-tier
8257/// segments use as their on-disk PK. Returns `None` for keys that
8258/// aren't representable as `u64` — Text PKs need a hash mapping
8259/// the segment writer baked in (deferred to v5.2+), Bool PKs are
8260/// almost never wide enough to be sharded into a cold tier.
8261fn index_key_as_u64(key: &IndexKey) -> Option<u64> {
8262    match key {
8263        // Reinterpret the i64 bit pattern as u64. Cold-tier segments
8264        // are sorted by this u64 view, so the chosen interpretation
8265        // only has to match between insert (bake_segment / freezer)
8266        // and lookup — using cast_unsigned keeps both sides honest
8267        // and silences clippy::cast_sign_loss.
8268        IndexKey::Int(n) => Some(n.cast_unsigned()),
8269        // Text / Bool / Uuid / Bytes / Numeric PKs aren't representable
8270        // as u64 and so can't participate in the u64-sorted cold-tier
8271        // segment PK layout. Same deferral story as Text — lookup falls
8272        // through the in-memory btree.
8273        IndexKey::Text(_)
8274        | IndexKey::Bool(_)
8275        | IndexKey::Uuid(_)
8276        | IndexKey::Bytes(_)
8277        | IndexKey::Numeric(_)
8278        | IndexKey::Null => None,
8279    }
8280}
8281
8282#[derive(Debug, Clone, PartialEq, Eq)]
8283#[non_exhaustive]
8284pub enum StorageError {
8285    DuplicateTable {
8286        name: String,
8287    },
8288    TableNotFound {
8289        name: String,
8290    },
8291    ArityMismatch {
8292        expected: usize,
8293        actual: usize,
8294    },
8295    TypeMismatch {
8296        column: String,
8297        expected: DataType,
8298        actual: DataType,
8299        position: usize,
8300    },
8301    NullInNotNull {
8302        column: String,
8303    },
8304    /// Index with this name already exists on the table.
8305    DuplicateIndex {
8306        name: String,
8307    },
8308    /// Column referenced by an index doesn't exist on the table.
8309    ColumnNotFound {
8310        column: String,
8311    },
8312    /// On-disk format failed to parse — corrupted file, wrong magic, truncated
8313    /// payload, or unknown tag bytes.
8314    Corrupt(String),
8315    /// v6.0.4 — ALTER INDEX targeted an index name that doesn't
8316    /// exist on any table in this catalog.
8317    IndexNotFound {
8318        name: String,
8319    },
8320    /// v6.0.4 — operation requested isn't supported on this index
8321    /// kind / column type (e.g. ALTER INDEX REBUILD on a `BTree`
8322    /// index, or REBUILD WITH (encoding=…) on a non-vector column).
8323    Unsupported(String),
8324    /// v7.39 (round 220) — a CYCLE-less sequence ran past its bound.
8325    /// PG's 2200H phrasing: `nextval: reached maximum value of
8326    /// sequence "s" (n)` (`is_max: false` = the MINVALUE direction).
8327    SequenceExhausted {
8328        name: String,
8329        limit: i64,
8330        is_max: bool,
8331    },
8332}
8333
8334impl fmt::Display for StorageError {
8335    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
8336        match self {
8337            // v7.39 (read01 round 47) — PG's 42P07 wording.
8338            Self::DuplicateTable { name } => write!(f, "relation \"{name}\" already exists"),
8339            // v7.39 (read01 round 47) — PG's wording for a missing relation
8340            // (42P01). DROP TABLE says "table" and raises its own error at
8341            // the engine; every other path (SELECT / ALTER / …) says
8342            // "relation", which is what this carries.
8343            Self::TableNotFound { name } => write!(f, "relation \"{name}\" does not exist"),
8344            Self::ArityMismatch { expected, actual } => write!(
8345                f,
8346                "row arity mismatch: expected {expected} columns, got {actual}"
8347            ),
8348            Self::TypeMismatch {
8349                column,
8350                expected,
8351                actual,
8352                position,
8353            } => write!(
8354                f,
8355                "type mismatch in column {column:?} (position {position}): expected {expected}, got {actual}"
8356            ),
8357            Self::NullInNotNull { column } => {
8358                // v7.39 (SQLSTATE fidelity) — PG's 23502 phrasing (the
8359                // relation-qualified long form is added by engine call
8360                // sites that know the table name).
8361                write!(
8362                    f,
8363                    "null value in column \"{column}\" violates not-null constraint"
8364                )
8365            }
8366            // v7.39 (read01 round 47) — an index is a relation to PG (42P07).
8367            Self::DuplicateIndex { name } => write!(f, "relation \"{name}\" already exists"),
8368            // v7.39 (round 701) — PG's wording, and the same fix `EvalError::
8369            // ColumnNotFound` took in read01 round 81 with the same reason:
8370            // "column not found: x" matches none of the wire layer's `does
8371            // not exist` patterns, so a missing column reached the client as
8372            // the generic error class. The eval-side variant was changed and
8373            // the storage-side one was not, so which sentence you got
8374            // depended on which layer noticed — `CREATE INDEX ix ON t(nope)`
8375            // came out of storage and kept the old spelling.
8376            Self::ColumnNotFound { column } => write!(f, "column \"{column}\" does not exist"),
8377            Self::Corrupt(detail) => write!(f, "corrupt on-disk format: {detail}"),
8378            Self::IndexNotFound { name } => write!(f, "index \"{name}\" does not exist"),
8379            Self::Unsupported(detail) => write!(f, "unsupported: {detail}"),
8380            // v7.39 (round 220) — PG's exact 2200H wording.
8381            Self::SequenceExhausted {
8382                name,
8383                limit,
8384                is_max,
8385            } => write!(
8386                f,
8387                "nextval: reached {} value of sequence \"{name}\" ({limit})",
8388                if *is_max { "maximum" } else { "minimum" }
8389            ),
8390        }
8391    }
8392}
8393
8394impl ColumnSchema {
8395    pub fn new(name: impl Into<String>, ty: DataType, nullable: bool) -> Self {
8396        Self {
8397            name: name.into(),
8398            ty,
8399            nullable,
8400            collation_name: None,
8401            default: None,
8402            runtime_default: None,
8403            auto_increment: false,
8404            user_enum_type: None,
8405            user_domain_type: None,
8406            user_composite_type: None,
8407            acl: Vec::new(),
8408            on_update_runtime: None,
8409            collation: Collation::Binary,
8410            is_unsigned: false,
8411            inline_enum_variants: None,
8412            inline_set_variants: None,
8413            generated_stored_expr: None,
8414            identity_always: false,
8415            default_text: None,
8416            auto_restart: None,
8417            scalar_row_source: false,
8418            mysql_int_width: None,
8419            mysql_fsp: None,
8420        }
8421    }
8422
8423    /// Builder-style helper to attach a default value to an otherwise
8424    /// plain column schema. Used by the engine when CREATE TABLE
8425    /// specifies `column TYPE DEFAULT <expr>`.
8426    #[must_use]
8427    pub fn with_default(mut self, default: Value<'static>) -> Self {
8428        self.default = Some(default);
8429        self
8430    }
8431
8432    /// v7.9.21 — builder for runtime-evaluated defaults
8433    /// (`DEFAULT now()`, `DEFAULT CURRENT_TIMESTAMP`, …).
8434    /// `expr` is the Expr's `Display` form, re-parsed by the
8435    /// engine at each INSERT.
8436    #[must_use]
8437    pub fn with_runtime_default(mut self, expr: impl Into<String>) -> Self {
8438        self.runtime_default = Some(expr.into());
8439        self
8440    }
8441
8442    /// Builder-style helper to mark a column as `AUTO_INCREMENT`.
8443    #[must_use]
8444    pub const fn with_auto_increment(mut self) -> Self {
8445        self.auto_increment = true;
8446        self
8447    }
8448}
8449
8450impl TableSchema {
8451    pub fn new(name: impl Into<String>, columns: Vec<ColumnSchema>) -> Self {
8452        Self {
8453            name: name.into(),
8454            columns,
8455            hot_tier_bytes: None,
8456            foreign_keys: Vec::new(),
8457            uniqueness_constraints: Vec::new(),
8458            exclusion_constraints: Vec::new(),
8459            checks: Vec::new(),
8460            partition_role: None,
8461            policies: Vec::new(),
8462            row_security: false,
8463            force_row_security: false,
8464            owner: None,
8465            acl: Vec::new(),
8466        }
8467    }
8468}
8469
8470// =========================================================================
8471// Persistent binary format for the catalog.
8472//
8473// Layout (little-endian throughout):
8474//
8475//   [magic "SPGDB001" 8 bytes][version u8]
8476//   [table_count u32]
8477//   for each table:
8478//       [name_len u16][name bytes]
8479//       [col_count u16]
8480//       for each col:
8481//           [name_len u16][name bytes]
8482//           [type_tag u8 + optional payload]
8483//               1=Int 2=BigInt 3=Float 4=Text 5=Bool
8484//               6=Vector(u32 dim)
8485//               7=SmallInt
8486//               8=Varchar(u32 max)
8487//               9=Char(u32 size)
8488//               10=Numeric(u8 precision, u8 scale)
8489//               11=Date
8490//               12=Timestamp
8491//           [nullable u8]   0/1
8492//           [default_tag u8] 0=none 1=value (followed by [value_tag u8] + bytes)
8493//       [row_count u32]
8494//       for each row, for each col, one [value_tag u8] + value bytes:
8495//           tag 0 (Null)     → no body
8496//           tag 1 (Int)      → i32 LE
8497//           tag 2 (BigInt)   → i64 LE
8498//           tag 3 (Float)    → f64 LE
8499//           tag 4 (Text)     → u16 LE len + UTF-8 bytes
8500//           tag 5 (Bool)     → u8 0/1
8501//           tag 6 (Vector)   → u32 LE dim + dim×f32 LE
8502//           tag 7 (SmallInt) → i16 LE
8503//           tag 8 (Numeric)  → i128 LE (16 bytes) + u8 scale
8504//           tag 9 (Date)     → i32 LE (days since Unix epoch)
8505//           tag 10 (Timestamp) → i64 LE (microseconds since Unix epoch)
8506//
8507// Bumped to version 3 when NUMERIC was added; to version 4 when
8508// AUTO_INCREMENT (per-column flag) + NSW index `kind` byte landed;
8509// to version 5 when DATE / TIMESTAMP were added; to version 6 when
8510// NSW graph topology started travelling on disk (v2.7); to version 7
8511// when the NSW topology became multi-layer HNSW (v2.13); to version 8
8512// when row encoding switched to schema-driven dense layout (v3.0.2 —
8513// per-row NULL bitmap + per-column fixed-width body, no per-cell type
8514// tag).
8515// =========================================================================
8516
8517const FILE_MAGIC: &[u8; 8] = b"SPGDB001";
8518/// Current catalog snapshot format version emitted by [`Catalog::serialize`].
8519///
8520/// v9 (v5.2) extends v8 by serialising `BTree` index entries directly — every
8521/// `(IndexKey, Vec<RowLocator>)` pair travels on disk with the v5.1
8522/// `RowLocator::write_le` tag-prefixed codec. v8 `BTree` indices stored no
8523/// entries at all (the map was rebuilt from `Table::rows` on load); v9
8524/// preserves on-disk Cold locators so freezer-produced cold-tier index
8525/// entries survive a catalog snapshot round-trip. v8 readers are accepted
8526/// by version dispatch in [`Catalog::deserialize`] — every entry decodes
8527/// as `RowLocator::Hot(_)` via `add_index` rebuild, identical to v5.1
8528/// behaviour.
8529/// v6.7.2 — bumped from 10 to 11 to append per-table
8530/// `hot_tier_bytes: Option<u64>` after the per-table indices
8531/// section. v10 catalogs (v6.7.1) load with `hot_tier_bytes =
8532/// None` for every table (the deserialiser short-circuits when
8533/// version < 11). v11 snapshots written by a pre-v6.7.2 binary
8534/// fail loudly at the version check, matching the v6.1.2 /
8535/// v6.1.4 / v6.2.0 / v6.7.1 envelope-bump upgrade fences.
8536///
8537/// v6.8.0 — bumped from 11 to 12: per-index
8538/// `included_columns: Vec<u16>` appended at the tail of each
8539/// index payload. v11 (= v6.7.2) catalogs load with
8540/// `included_columns = Vec::new()` for every index — same
8541/// "older readers, append-only extension" pattern as the v6.7.2
8542/// hot_tier_bytes byte.
8543/// v7.13.0 — bumped from 22 to 23. mailrs round-5 G3 / G10.
8544/// Per-table appendix gains two new sections:
8545///   * `checks: Vec<String>` — CHECK predicate sources (Display
8546///     form of the AST Expr); re-parsed on INSERT/UPDATE to
8547///     enforce against candidate rows. Same persistence pattern
8548///     as `Index::partial_predicate`.
8549///   * Per `UniquenessConstraint`: trailing `nulls_not_distinct:
8550///     u8` flag for PG 15+ `UNIQUE NULLS NOT DISTINCT (cols)`
8551///     semantics.
8552/// v22 catalogs deserialise with empty `checks` and every UC
8553/// at `nulls_not_distinct = false`.
8554/// v24 introduces:
8555///   * Index kind tag 4 = trigram-GIN (`gin_trgm_ops`-flavoured
8556///     `USING gin` over a TEXT/VARCHAR column). Payload shape is
8557///     identical to tag-3 GIN (String → Vec<RowLocator>); the
8558///     keys are PG-compatible 3-byte trigram shingles instead of
8559///     tsvector lexemes. v23 catalogs deserialise unchanged — no
8560///     v23 writer ever emitted tag 4.
8561/// v25 introduces:
8562///   * Per `TriggerDef`: trailing `enabled: u8` flag (mailrs
8563///     round-9 A.2.b — `ALTER TABLE … { ENABLE | DISABLE }
8564///     TRIGGER …`). v24 catalogs deserialise with every trigger
8565///     `enabled = true`, matching pre-v7.16.1 behaviour.
8566/// v26 introduces (v7.17.0 Phase 1.1):
8567///   * Trailing SEQUENCE catalog block after triggers. Encoded
8568///     as `u32 count` followed by per-sequence:
8569///     `name`, `data_type: u8` (0=SmallInt,1=Int,2=BigInt),
8570///     `start i64`, `increment i64`, `min_value i64`,
8571///     `max_value i64`, `cache i64`, `cycle u8`,
8572///     `owned_by_tag u8` (0=NONE, 1=Column → `table`,`column`),
8573///     `last_value i64`, `is_called u8`. v25-and-below catalogs
8574///     deserialise with an empty sequences map.
8575/// v27 introduces (v7.17.0 Phase 1.2):
8576///   * Trailing VIEW catalog block after sequences. Encoded as
8577///     `u32 count` followed by per-view:
8578///     `name`, `column_count u16`, then column names, then
8579///     `body` long-string. v26-and-below catalogs deserialise
8580///     with an empty views map.
8581/// v28 introduces (v7.17.0 Phase 1.3):
8582///   * Trailing MATERIALIZED VIEW source registry block after
8583///     views. Encoded as `u32 count` followed by per-entry:
8584///     `name`, `body` long-string. The materialised rows live
8585///     as a regular Table of the same name (already covered by
8586///     the pre-existing tables block). v27-and-below catalogs
8587///     deserialise with an empty map.
8588/// v29 introduces (v7.17.0 Phase 1.4):
8589///   * Per-table user_enum_type appendix (after the CHECK
8590///     appendix). Layout: `u16 count` followed by per-binding
8591///     `[u16 col_pos][str enum_name]`. Only columns whose
8592///     `user_enum_type` is Some land here; the catalog stays
8593///     compact for the common no-enum case.
8594///   * Trailing ENUM types catalog block after materialized
8595///     views. Encoded as `u32 count` followed by per-entry:
8596///     `name`, `u16 label_count`, then `label_count` short
8597///     strings. v28-and-below catalogs deserialise with an
8598///     empty enum_types map and every column's
8599///     `user_enum_type = None`.
8600/// v30 introduces (v7.17.0 Phase 1.5):
8601///   * Per-table user_domain_type appendix (after the
8602///     user_enum_type appendix). Same shape as the enum one.
8603///   * Trailing DOMAIN types catalog block after the enum
8604///     block. Encoded as `u32 count` followed by per-entry:
8605///     `name`, `data_type` byte, `nullable u8`,
8606///     `default_present u8` + optional default string,
8607///     `u16 check_count` then `check_count` Display-form
8608///     CHECK strings. v29-and-below catalogs deserialise with
8609///     an empty domain_types map and `user_domain_type = None`.
8610/// v31 introduces (v7.17.0 Phase 1.6):
8611///   * Trailing user-schemas block after the DOMAIN block.
8612///     Encoded as `u32 count` followed by `count` schema-name
8613///     short strings. Built-in schemas (`public`, `pg_catalog`,
8614///     `information_schema`) are NOT serialised — they're
8615///     hardcoded in `is_builtin_schema`. v30-and-below catalogs
8616///     deserialise with an empty user-schemas set.
8617/// v32 introduces (v7.17.0 Phase 2.1):
8618///   * Per-table on_update_runtime appendix (after the
8619///     user_domain_type appendix). Layout: `u16 count` followed
8620///     by per-binding `[u16 col_pos][str expr_src]`. Only
8621///     columns whose `on_update_runtime` is Some land here;
8622///     the catalog stays compact when no MySQL-shaped table
8623///     uses the attribute. v31-and-below catalogs deserialise
8624///     with every column's `on_update_runtime = None`.
8625/// v33 introduces (v7.17.0 Phase 2.2):
8626///   * Index kind tag 5 = fulltext-GIN (MySQL `FULLTEXT KEY`
8627///     surface over a TEXT / VARCHAR column). Payload shape is
8628///     identical to tag-3 / tag-4 GIN (`String → Vec<RowLocator>`);
8629///     the keys are lower-cased word lexemes (same rule as
8630///     `to_tsvector('simple', text)`). v32 catalogs deserialise
8631///     unchanged — no v32 writer ever emitted tag 5, and FULLTEXT
8632///     KEY was silently dropped pre-v7.17 so no rebuild shim is
8633///     needed for round-tripped catalogs.
8634/// v34 introduces (v7.17.0 Phase 2.5):
8635///   * Per-table collation appendix (after the on_update_runtime
8636///     appendix). Sparse layout: only columns whose `collation`
8637///     is non-Binary land here. `u16 count` then per-binding
8638///     `[u16 col_pos][u8 collation_tag]` where the tag matches
8639///     `Collation::TAG_*`. Snapshots written by v33-and-below
8640///     readers deserialise every column with `collation =
8641///     Binary`, preserving the prior byte-wise compare
8642///     semantics. Unknown tags read back as Binary too — keeps
8643///     a forward-compat path if a future v35 adds variants
8644///     and someone rolls back to a v34 reader.
8645/// v35 introduces (v7.17.0 Phase 4.4):
8646///   * Per-table is_unsigned appendix (after the collation
8647///     appendix). Sparse layout: only `is_unsigned = true`
8648///     columns land. `u16 count` then per-binding `[u16 col_pos]`.
8649///     v34-and-below catalogs deserialise every column as
8650///     `is_unsigned = false`, preserving the prior silent-
8651///     accept behaviour for negative inserts on UNSIGNED columns.
8652/// v46 introduces (v7.23, mailrs round-14):
8653///   * Escaped short-string codec — `write_str` lengths >= 0xFFFF
8654///     emit `[u16 0xFFFF][u32 real_len]` so TEXT cells (mail bodies,
8655///     document text) above 64 KiB encode instead of panicking.
8656///     One-way upgrade: v45-and-below readers reject v46 catalogs
8657///     loudly via the version gate; v46 readers decode v45 catalogs
8658///     with the plain-u16 rules (0xFFFF is a legitimate length
8659///     there).
8660/// v47 introduces (v7.27, mailrs round-21):
8661///   * Escaped lengths for the REMAINING u16-length cell payloads —
8662///     BYTEA cells, TEXT[] elements, tsvector lexemes and tsquery
8663///     terms — the same `[u16 0xFFFF][u32 real_len]` escape v46
8664///     gave short strings. Round-14 fixed TEXT and missed these;
8665///     round-21 fired the BYTEA twin during a production migration.
8666///     One-way upgrade, same posture as v46.
8667/// v48 introduces (v7.37.5 β-P2, sentori cutover window):
8668///   * `INTERVAL` becomes a real column type. Catalog tag 34 in
8669///     `write_data_type`; per-row body is a fixed 16 bytes
8670///     (i64 micros + i32 days + i32 months, LE, PG-byte-equal
8671///     field order). The runtime-only days collapse is gone —
8672///     `'1 day'` and `'24 hours'` are stored distinctly. One-way
8673///     upgrade: v47 catalogs without INTERVAL columns deserialise
8674///     identically; v47 readers fed a v48 catalog that contains
8675///     INTERVAL hit the explicit "unknown data type tag: 34"
8676///     fence in `read_data_type`.
8677/// v49 introduces (v7.37.6-B, sentori Epic 2 P0):
8678///   * Per-table partition role appendix(declarative
8679///     `PARTITION BY RANGE` parent / range child / DEFAULT
8680///     child)。Layout, written **after** the inline_set_variants
8681///     appendix and **before** the per-table block close:
8682///       `[u8 role_tag]`
8683///         0 = `None`(普通表,后向兼容默认)
8684///         1 = `Parent`:  `[u8 kind_tag (0=Range)]`
8685///                        `[u16 key_col_count]` `(× u16 col_pos)`
8686///                        `[u16 tmpl_count]` `(× str source)`
8687///         2 = `Range`:   `[str parent_name]` `[Bound]` `[Bound]`
8688///         3 = `Default`: `[str parent_name]`
8689///     `PartitionBound` codec:
8690///       `[u8 bound_tag]` 0=MinValue 1=MaxValue 2=TimestampTz(`[i64 LE micros]`)
8691///     v48-and-below readers stop after the inline_set_variants
8692///     block — they don't see this appendix and deserialise every
8693///     table with `partition_role = None`. v49 writers always emit
8694///     `[0]` for plain tables, so the encoding stays one-byte-cheap.
8695/// v50 introduces (v7.37.7, sentori Epic 3 P1):
8696///   * Per-table `generated_stored_expr` appendix(stored generated
8697///     columns — `GENERATED ALWAYS AS (<expr>) STORED`)。Layout,
8698///     written **after** the partition_role appendix and before
8699///     the per-table block close:
8700///       `[u16 binding_count]`
8701///       `binding_count × { [u16 col_pos][str expr_source] }`
8702///     Sparse — only generated columns land here, so plain-shape
8703///     catalogs stay byte-for-byte identical save for the new
8704///     u16 zero count. v49-and-below readers stop after the
8705///     partition_role appendix; v50 readers default every column
8706///     to `generated_stored_expr = None` when this block is absent.
8707/// v51 introduces (v7.37.8, sentori Epic 5 P2):
8708///   * Per-index tag byte 6 = `GinJsonb`(real posting-list GIN
8709///     over a JSONB column). Payload shape mirrors tag-3 / 4 / 5:
8710///     `[u32 posting_list_count]` then `(str token, u32 locator_count,
8711///     locators …)` per posting list. Same `write_str` /
8712///     `RowLocator::write_le` codec as the rest of the GIN family.
8713///     v50 catalogs never wrote tag 6(the same DDL loaded as a
8714///     BTree fallback); v51 readers see tag 6 explicitly and dispatch
8715///     into `IndexKind::GinJsonb`.
8716/// v52 introduces (v7.37.42-T2 ζ-B composite + domain metasystem):
8717///   * Trailing COMPOSITE-types catalog block after the
8718///     user-schemas block. Encoded as `u32 count` followed by
8719///     per-entry: `name`, `u16 field_count`, then `field_count`
8720///     `[str field_name][data_type]` pairs (`write_data_type` is
8721///     reused). v51-and-below catalogs deserialise with an empty
8722///     composite_types map; v52 readers tolerate v51 catalogs by
8723///     stopping at the schema block (no composite block present
8724///     ⇒ empty map). Composite types are referenced by columns
8725///     via `ColumnSchema.user_composite_type`, mirroring the
8726///     `user_enum_type` / `user_domain_type` pattern. The block
8727///     lands here (not as a per-table appendix) so dropping the
8728///     composite type registers globally and DROP TYPE can find it
8729///     without a table scan.
8730/// v53 introduces (v7.37.16 Epic W — cross-checkpoint tombstone
8731///   durability):
8732///   * Trailing per-table MVCC appendix carrying, for every row,
8733///     its `RowHeader` (`xmin:u64`, `xmax:u64`, `flags:u8`) and its
8734///     stable `RowId` (`u64`), followed by the relation's
8735///     `next_rowid:u64`. Layout per table (after the v50
8736///     generated_stored_expr block, before the table loop closes):
8737///       `[u32 row_count]` (== `Table::rows().len()`, cross-check)
8738///       per row in physical order:
8739///         `[u64 xmin][u64 xmax][u8 flags][u64 rowid]`
8740///       `[u64 next_rowid]`
8741///     v52-and-below catalogs never wrote this block; their reader
8742///     stops after the last per-table appendix and
8743///     `deserialize_rows` leaves every row `RowHeader::frozen()`
8744///     with dense 1..=N ids — the exact pre-v53 contract. A v53
8745///     reader instead reconstructs headers + ids VERBATIM, so a
8746///     tombstone-redo naming a row inserted before the last
8747///     checkpoint resolves by `RowId` across the base-snapshot
8748///     boundary (closing the coupling the Epic W WAL slices deferred
8749///     to this format bump). Because the reader routes on `version`,
8750///     the block is strictly backward-compatible: old images load
8751///     byte-for-byte as before. `SPG_MVCC_INPLACE` is unaffected —
8752///     a gate-off database's rows are all frozen/alive, so
8753///     persisting + restoring their headers is observationally a
8754///     no-op.
8755/// v7.38 (read01 P5.05) — v54 appends a CRC32C over the whole preceding
8756/// image so a corrupted `base.spg` is caught on load instead of silently
8757/// deserialising garbage. Older images (v8..=53) carry no trailer and load
8758/// unchanged.
8759/// v7.39 (round 210) — v72 appends a per-table EXCLUDE-constraint appendix
8760/// (sparse: only tables carrying an EXCLUDE write it) at the very end of the
8761/// per-table block, after the column-ACL appendix. A v71 reader stops before
8762/// it and its tables read back with no exclusion constraints, which is what
8763/// they were.
8764/// v7.39 (round 220) — v73 appends a per-table identity-RESTART appendix
8765/// (sparse: [u16 count] then per entry [u16 col_pos][i64 LE floor]) after
8766/// the EXCLUDE appendix. A v72 reader stops before it; its columns read
8767/// back with no RESTART floor, losing only an un-consumed
8768/// `ALTER … RESTART WITH` across a restart.
8769/// r1039 — v90 adds index-key tags 4 (bytea) and 5 (the canonical
8770/// numeric key), so BYTEA and NUMERIC columns carry a real B-tree
8771/// instead of falling back to a scan. A v89 reader meeting either tag
8772/// reports a corrupt catalog rather than mis-reading it, which is the
8773/// same forward-compatibility story tag 3 (uuid) had at v36.
8774const FILE_VERSION: u8 = 91;
8775
8776/// v7.37 (round 833) — the codec version to decode a row that
8777/// [`encode_row_body_dense`] has just produced.
8778///
8779/// That encoder always writes the newest form, and every decoder gate is
8780/// a `codec_version >= N` feature test, so a freshly encoded row must be
8781/// read at the current version. Cold segments carry their own version in
8782/// their header and keep passing that; this is for in-process round
8783/// trips — sort runs on temp storage — where the bytes never outlive the
8784/// build that wrote them.
8785pub const CURRENT_ROW_CODEC_VERSION: u8 = FILE_VERSION;
8786/// First version that appends the trailing CRC32C integrity trailer.
8787const FILE_VERSION_CRC_TRAILER: u8 = 54;
8788/// Oldest format version [`Catalog::deserialize`] still accepts. v8 is the
8789/// v3.0.2 dense-row layout; pre-v8 catalogs require an offline migration.
8790const MIN_SUPPORTED_FILE_VERSION: u8 = 8;
8791
8792// IndexKey wire format (v9):
8793//   tag 0 = Int  → [i64 LE]
8794//   tag 1 = Text → [u16 LE len + UTF-8 bytes] (via write_str / read_str)
8795//   tag 2 = Bool → [u8 0/1]
8796const INDEX_KEY_TAG_INT: u8 = 0;
8797const INDEX_KEY_TAG_TEXT: u8 = 1;
8798const INDEX_KEY_TAG_BOOL: u8 = 2;
8799/// v7.17.0 — `IndexKey::Uuid([u8; 16])`. Body = raw 16 bytes
8800/// (RFC 4122 byte order). Persisted only in FILE_VERSION 36+
8801/// catalogs.
8802const INDEX_KEY_TAG_UUID: u8 = 3;
8803/// r1039 — `IndexKey::Bytes`. Body = [u32 LE len][raw bytes].
8804/// Persisted only in FILE_VERSION 90+ catalogs.
8805const INDEX_KEY_TAG_BYTES: u8 = 4;
8806/// r1039 — `IndexKey::Numeric`. Body = [u8 class][u8 neg][i32 LE exp]
8807/// [u32 LE digit count][one byte per decimal digit, 0..=9, MSD first].
8808/// Persisted only in FILE_VERSION 90+ catalogs.
8809const INDEX_KEY_TAG_NUMERIC: u8 = 5;
8810/// v7.38.1 (L12) — `IndexKey::Null`, a NULL component inside a
8811/// composite key. No body. Persisted only inside tag-7 multi-index
8812/// payloads, FILE_VERSION 91+.
8813const INDEX_KEY_TAG_NULL: u8 = 6;
8814
8815impl Catalog {
8816    /// Serialize the whole catalog (schema + every row) into a self-contained
8817    /// byte buffer. Format is documented above the impl block.
8818    pub fn serialize(&self) -> Vec<u8> {
8819        let mut out = Vec::with_capacity(64);
8820        out.extend_from_slice(FILE_MAGIC);
8821        out.push(FILE_VERSION);
8822        write_u32(
8823            &mut out,
8824            u32::try_from(self.tables.len()).expect("≤ 4G tables"),
8825        );
8826        for t in &self.tables {
8827            write_str(&mut out, &t.schema.name);
8828            write_u16(
8829                &mut out,
8830                u16::try_from(t.schema.columns.len()).expect("≤ 65k columns/table"),
8831            );
8832            for c in &t.schema.columns {
8833                write_str(&mut out, &c.name);
8834                write_data_type(&mut out, c.ty);
8835                out.push(u8::from(c.nullable));
8836                match &c.default {
8837                    None => out.push(0),
8838                    Some(v) => {
8839                        out.push(1);
8840                        write_value(&mut out, v);
8841                    }
8842                }
8843                out.push(u8::from(c.auto_increment));
8844            }
8845            write_u32(
8846                &mut out,
8847                u32::try_from(t.rows.len()).expect("≤ 4G rows/table"),
8848            );
8849            // v3.0.2 dense row encoding (FILE_VERSION 8): per-row NULL
8850            // bitmap, then tightly-packed bodies. Identical wire format
8851            // as before — extracted into `encode_row_body_dense` so cold-
8852            // tier segments (v5.1+) can share the encoding.
8853            for row in &t.rows {
8854                out.extend_from_slice(&encode_row_body_dense(row, &t.schema));
8855            }
8856            // Index definitions. Per-index payload:
8857            //   [name][col_pos u16][kind u8]
8858            //     kind 0 = B-tree           (no params — rebuilt on load)
8859            //     kind 1 = NSW graph        (u16 M + serialized graph)
8860            // For NSW the graph topology travels on disk so startup
8861            // doesn't re-run the O(n²M) rebuild — see v2.7 notes.
8862            write_u16(
8863                &mut out,
8864                u16::try_from(t.indices.len()).expect("≤ 65k indices/table"),
8865            );
8866            for idx in &t.indices {
8867                write_str(&mut out, &idx.name);
8868                write_u16(
8869                    &mut out,
8870                    u16::try_from(idx.column_position).expect("≤ 65k columns/table"),
8871                );
8872                match &idx.kind {
8873                    IndexKind::BTree(map) => {
8874                        out.push(0);
8875                        // v9: serialise the full PB map. Each entry's
8876                        // RowLocator list travels with the tag-prefixed
8877                        // codec from `row_locator::write_le`, so freezer-
8878                        // produced Cold locators survive a snapshot
8879                        // round-trip. v8 BTree wrote nothing here and
8880                        // rebuilt from rows — v9 readers tolerate v8 by
8881                        // version dispatch in `Catalog::deserialize`.
8882                        write_u32(
8883                            &mut out,
8884                            u32::try_from(map.len()).expect("≤ 4G index entries/index"),
8885                        );
8886                        for (key, locators) in map {
8887                            write_index_key(&mut out, key);
8888                            write_u32(
8889                                &mut out,
8890                                u32::try_from(locators.len()).expect("≤ 4G locators/key"),
8891                            );
8892                            for loc in locators {
8893                                loc.write_le(&mut out);
8894                            }
8895                        }
8896                    }
8897                    // v7.38.1 (L12) — tag byte 7 = BTreeMulti. Payload
8898                    // mirrors the tag-0 BTree encoding, with each key
8899                    // written as `[u16 arity]` followed by that many
8900                    // `write_index_key` components. FILE_VERSION 91+;
8901                    // older catalogs never carried a multi index, so no
8902                    // migration shim is needed.
8903                    IndexKind::BTreeMulti(map) => {
8904                        out.push(7);
8905                        write_u32(
8906                            &mut out,
8907                            u32::try_from(map.len()).expect("≤ 4G index entries/index"),
8908                        );
8909                        for (key, locators) in map {
8910                            write_u16(
8911                                &mut out,
8912                                u16::try_from(key.len()).expect("≤ 65k key components"),
8913                            );
8914                            for component in key.iter() {
8915                                write_index_key(&mut out, component);
8916                            }
8917                            write_u32(
8918                                &mut out,
8919                                u32::try_from(locators.len()).expect("≤ 4G locators/key"),
8920                            );
8921                            for loc in locators {
8922                                loc.write_le(&mut out);
8923                            }
8924                        }
8925                    }
8926                    IndexKind::Nsw(g) => {
8927                        out.push(1);
8928                        write_u16(&mut out, u16::try_from(g.m).expect("≤ 65k NSW neighbours"));
8929                        write_nsw_graph(&mut out, g);
8930                    }
8931                    IndexKind::Brin { column_type } => {
8932                        // v6.7.1 — tag byte 2 = BRIN. Payload is the
8933                        // column type code (1 byte mapping to the
8934                        // shared DataType numeric encoding); no
8935                        // further data — BRIN summaries live in
8936                        // cold segments, not the catalog.
8937                        out.push(2);
8938                        write_data_type(&mut out, *column_type);
8939                    }
8940                    IndexKind::Gin(map) => {
8941                        // v7.12.3 — tag byte 3 = GIN. Payload mirrors
8942                        // the BTree encoding but with String (lexeme
8943                        // word) keys instead of IndexKey. Tag-prefixed
8944                        // RowLocator codec so freezer-produced Cold
8945                        // locators survive snapshot round-trip.
8946                        // FILE_VERSION 21+; v20 catalogs never wrote a
8947                        // GIN index (the AM degraded to BTree fallback
8948                        // pre-v7.12.3), so no migration shim is needed.
8949                        out.push(3);
8950                        write_u32(
8951                            &mut out,
8952                            u32::try_from(map.len()).expect("≤ 4G GIN posting lists"),
8953                        );
8954                        for (word, locators) in map {
8955                            write_str(&mut out, word);
8956                            write_u32(
8957                                &mut out,
8958                                u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
8959                            );
8960                            for loc in locators {
8961                                loc.write_le(&mut out);
8962                            }
8963                        }
8964                    }
8965                    IndexKind::GinTrgm(map) => {
8966                        // v7.15.0 — tag byte 4 = GinTrgm
8967                        // (`gin_trgm_ops` GIN over a TEXT column).
8968                        // Payload shape is identical to tag-3 GIN —
8969                        // `String → Vec<RowLocator>` posting lists.
8970                        // The String keys are 3-byte trigrams instead
8971                        // of tsvector lexemes; the deserializer
8972                        // dispatches on the tag, not the key shape.
8973                        // FILE_VERSION 24+; v23 catalogs never wrote
8974                        // a trigram-GIN.
8975                        out.push(4);
8976                        write_u32(
8977                            &mut out,
8978                            u32::try_from(map.len()).expect("≤ 4G trigram-GIN posting lists"),
8979                        );
8980                        for (tri, locators) in map {
8981                            write_str(&mut out, tri);
8982                            write_u32(
8983                                &mut out,
8984                                u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
8985                            );
8986                            for loc in locators {
8987                                loc.write_le(&mut out);
8988                            }
8989                        }
8990                    }
8991                    IndexKind::GinFulltext(map) => {
8992                        // v7.17.0 Phase 2.2 — tag byte 5 =
8993                        // GinFulltext (MySQL `FULLTEXT KEY` GIN
8994                        // over a TEXT/VARCHAR column). Payload
8995                        // shape mirrors tag-3 / tag-4 GIN —
8996                        // `String → Vec<RowLocator>` posting
8997                        // lists keyed by lower-cased word
8998                        // lexemes. FILE_VERSION 33+; v32 catalogs
8999                        // never wrote a fulltext-GIN (FULLTEXT
9000                        // KEY was silently dropped pre-v7.17).
9001                        out.push(5);
9002                        write_u32(
9003                            &mut out,
9004                            u32::try_from(map.len()).expect("≤ 4G fulltext-GIN posting lists"),
9005                        );
9006                        for (lex, locators) in map {
9007                            write_str(&mut out, lex);
9008                            write_u32(
9009                                &mut out,
9010                                u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9011                            );
9012                            for loc in locators {
9013                                loc.write_le(&mut out);
9014                            }
9015                        }
9016                    }
9017                    IndexKind::GinJsonb(map) => {
9018                        // v7.37.8 — tag byte 6 = GinJsonb
9019                        // (real posting-list GIN over a JSONB
9020                        // column; sentori Epic 5 P2). Payload
9021                        // shape mirrors tag-3 / 4 / 5 — keys are
9022                        // the canonical `(path, leaf)` tokens
9023                        // from `jsonb_gin::extract_tokens`.
9024                        // FILE_VERSION 51+; v50 catalogs never
9025                        // wrote a JSONB-GIN (the same DDL loaded
9026                        // as a BTree fallback).
9027                        out.push(6);
9028                        write_u32(
9029                            &mut out,
9030                            u32::try_from(map.len()).expect("≤ 4G JSONB-GIN posting lists"),
9031                        );
9032                        for (token, locators) in map {
9033                            write_str(&mut out, token);
9034                            write_u32(
9035                                &mut out,
9036                                u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9037                            );
9038                            for loc in locators {
9039                                loc.write_le(&mut out);
9040                            }
9041                        }
9042                    }
9043                }
9044                // v6.8.0 — included_columns appendix per index.
9045                // Layout: [u16 num_included][num × u16 column_position].
9046                // v11 readers stop before this u16 (deserialise loop
9047                // gated on version >= 12); v12+ readers always
9048                // consume it. Empty Vec serialises as a bare 0u16.
9049                write_u16(
9050                    &mut out,
9051                    u16::try_from(idx.included_columns.len()).expect("≤ 65k INCLUDE columns/index"),
9052                );
9053                for col_pos in &idx.included_columns {
9054                    write_u16(
9055                        &mut out,
9056                        u16::try_from(*col_pos).expect("≤ 65k columns/table"),
9057                    );
9058                }
9059                // v6.8.1 — partial_predicate appendix per index.
9060                // Layout: [u8 has_pred][u16 LE len][bytes (if has_pred)].
9061                // Same v12 gate as included_columns.
9062                match &idx.partial_predicate {
9063                    None => out.push(0),
9064                    Some(pred) => {
9065                        out.push(1);
9066                        write_str(&mut out, pred);
9067                    }
9068                }
9069                // v6.8.2 — expression appendix. Same shape as
9070                // partial_predicate.
9071                match &idx.expression {
9072                    None => out.push(0),
9073                    Some(expr) => {
9074                        out.push(1);
9075                        write_str(&mut out, expr);
9076                    }
9077                }
9078                // v7.9.29 — is_unique appendix (FILE_VERSION 16+).
9079                // Single byte 0/1. v15-and-below readers stop before
9080                // this byte; v16 readers always consume it. mailrs K1.
9081                out.push(u8::from(idx.is_unique));
9082                // v7.9.29 — extra_column_positions appendix.
9083                // Layout: [u16 count][count × u16 column_position].
9084                write_u16(
9085                    &mut out,
9086                    u16::try_from(idx.extra_column_positions.len())
9087                        .expect("≤ 65k extra cols / index"),
9088                );
9089                for cp in &idx.extra_column_positions {
9090                    write_u16(&mut out, u16::try_from(*cp).expect("≤ 65k columns/table"));
9091                }
9092                // v7.39 (read01 round 52) — nulls_not_distinct (FILE_VERSION
9093                // 62+). Appended at the end of the per-index block so the v16
9094                // layout above is untouched; v61-and-below readers stop before
9095                // this byte and default the flag to false (NULLS DISTINCT).
9096                out.push(u8::from(idx.nulls_not_distinct));
9097                // v7.39 (round 537) — the key column's ordering clause
9098                // (FILE_VERSION 83+).
9099                out.push(u8::from(idx.descending));
9100                out.push(match idx.nulls_first {
9101                    None => 0,
9102                    Some(true) => 1,
9103                    Some(false) => 2,
9104                });
9105                // v7.39 (round 538) — the key's explicit collation
9106                // (FILE_VERSION 84+).
9107                match &idx.collation {
9108                    Some(c) => {
9109                        out.push(1);
9110                        write_str(&mut out, c);
9111                    }
9112                    None => out.push(0),
9113                }
9114            }
9115            // v6.7.2 — per-table hot_tier_bytes Option<u64>.
9116            // Layout: [u8 has_value][u64 LE value (if has_value)].
9117            // v10 readers stop before this byte (deserialise loop
9118            // gated on version >= 11); v11+ readers always
9119            // consume it.
9120            match t.schema.hot_tier_bytes {
9121                None => out.push(0),
9122                Some(n) => {
9123                    out.push(1);
9124                    out.extend_from_slice(&n.to_le_bytes());
9125                }
9126            }
9127            // v7.6.1 — FOREIGN KEY appendix (catalog FILE_VERSION 13+).
9128            // Layout: [u16 LE fk_count]
9129            //   per fk:
9130            //     [u8 has_name] [str name (if has_name)]
9131            //     [u16 LE local_arity] [u16 LE local_pos]*arity
9132            //     [str parent_table]
9133            //     [u16 LE parent_arity] [u16 LE parent_pos]*arity
9134            //     [u8 on_delete_tag] [u8 on_update_tag]
9135            // Older catalogs (v12 and below) skip this block entirely;
9136            // their reader stops before this byte.
9137            write_u16(
9138                &mut out,
9139                u16::try_from(t.schema.foreign_keys.len()).expect("≤ 65k FKs/table"),
9140            );
9141            for fk in &t.schema.foreign_keys {
9142                match &fk.name {
9143                    None => out.push(0),
9144                    Some(n) => {
9145                        out.push(1);
9146                        write_str(&mut out, n);
9147                    }
9148                }
9149                write_u16(
9150                    &mut out,
9151                    u16::try_from(fk.local_columns.len()).expect("≤ 65k FK columns"),
9152                );
9153                for &p in &fk.local_columns {
9154                    write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9155                }
9156                write_str(&mut out, &fk.parent_table);
9157                write_u16(
9158                    &mut out,
9159                    u16::try_from(fk.parent_columns.len()).expect("≤ 65k FK parent columns"),
9160                );
9161                for &p in &fk.parent_columns {
9162                    write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9163                }
9164                out.push(fk.on_delete.tag());
9165                out.push(fk.on_update.tag());
9166                // v7.38 (read01, T29) — MATCH type tag (FILE_VERSION 55+).
9167                out.push(fk.match_type.tag());
9168                // v7.39 (round 288) — constraint timing (FILE_VERSION 79+).
9169                // One byte, bit 0 = DEFERRABLE, bit 1 = INITIALLY DEFERRED.
9170                out.push(u8::from(fk.deferrable) | (u8::from(fk.initially_deferred) << 1));
9171            }
9172            // v7.9.19 — UniquenessConstraint appendix (catalog
9173            // FILE_VERSION 15+). Layout per table after the FK
9174            // block:
9175            //   [u16 count]
9176            //     per constraint:
9177            //       [u8 is_primary_key]
9178            //       [u16 arity][u16 col_pos]*arity
9179            // Older catalogs (v14 and below) skip this block.
9180            write_u16(
9181                &mut out,
9182                u16::try_from(t.schema.uniqueness_constraints.len())
9183                    .expect("≤ 65k uniqueness constraints/table"),
9184            );
9185            for uc in &t.schema.uniqueness_constraints {
9186                out.push(u8::from(uc.is_primary_key));
9187                write_u16(
9188                    &mut out,
9189                    u16::try_from(uc.columns.len()).expect("≤ 65k cols in uniqueness constraint"),
9190                );
9191                for &p in &uc.columns {
9192                    write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9193                }
9194                // v7.13.0 — `nulls_not_distinct` flag
9195                // (FILE_VERSION 23+). Always written by writers at
9196                // version 23+; deserialise gates on `version >= 23`
9197                // so v22-and-below catalogs round-trip cleanly.
9198                out.push(u8::from(uc.nulls_not_distinct));
9199            }
9200            // v7.9.21 — runtime_default appendix per table.
9201            // Layout: [u16 count] then for each:
9202            //   [u16 col_pos][str expr]
9203            // Only columns whose runtime_default is Some land here;
9204            // catalog stays compact for the common literal-default
9205            // case.
9206            let mut rt_defaults: Vec<(usize, &str)> = Vec::new();
9207            for (i, c) in t.schema.columns.iter().enumerate() {
9208                if let Some(e) = &c.runtime_default {
9209                    rt_defaults.push((i, e.as_str()));
9210                }
9211            }
9212            write_u16(
9213                &mut out,
9214                u16::try_from(rt_defaults.len()).expect("≤ 65k runtime defaults/table"),
9215            );
9216            for (pos, expr) in rt_defaults {
9217                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9218                write_str(&mut out, expr);
9219            }
9220            // v7.13.0 — CHECK constraint appendix per table.
9221            // Layout: [u16 count] then `count` Display-form
9222            // expression strings. Re-parsed on every INSERT/UPDATE
9223            // by the engine. FILE_VERSION 23+ only; v22 readers
9224            // never reach this block because the writer also moves
9225            // to v23 in lock-step.
9226            write_u16(
9227                &mut out,
9228                u16::try_from(t.schema.checks.len()).expect("≤ 65k CHECK constraints/table"),
9229            );
9230            for c in &t.schema.checks {
9231                // v7.39 (read01 round 48) — the expr stays in this v23
9232                // appendix (byte layout unchanged for old readers); the
9233                // name rides the v60 constraint-name appendix at the tail.
9234                write_str(&mut out, c.expr.as_str());
9235            }
9236            // v7.17.0 Phase 1.4 — per-table user_enum_type
9237            // appendix. Layout: [u16 count] then
9238            // [u16 col_pos][str enum_name] per binding. Only
9239            // columns whose user_enum_type is Some land here.
9240            let mut enum_bindings: Vec<(usize, &str)> = Vec::new();
9241            for (i, c) in t.schema.columns.iter().enumerate() {
9242                if let Some(e) = &c.user_enum_type {
9243                    enum_bindings.push((i, e.as_str()));
9244                }
9245            }
9246            write_u16(
9247                &mut out,
9248                u16::try_from(enum_bindings.len()).expect("≤ 65k enum-typed columns/table"),
9249            );
9250            for (pos, ename) in enum_bindings {
9251                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9252                write_str(&mut out, ename);
9253            }
9254            // v7.17.0 Phase 1.5 — per-table user_domain_type
9255            // appendix. Same layout as the enum one. v29-and-
9256            // below readers stop after the enum appendix.
9257            let mut domain_bindings: Vec<(usize, &str)> = Vec::new();
9258            for (i, c) in t.schema.columns.iter().enumerate() {
9259                if let Some(d) = &c.user_domain_type {
9260                    domain_bindings.push((i, d.as_str()));
9261                }
9262            }
9263            write_u16(
9264                &mut out,
9265                u16::try_from(domain_bindings.len()).expect("≤ 65k domain-typed columns/table"),
9266            );
9267            for (pos, dname) in domain_bindings {
9268                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9269                write_str(&mut out, dname);
9270            }
9271            // v7.17.0 Phase 2.1 — per-table on_update_runtime
9272            // appendix. Sparse: only ON UPDATE-bound columns.
9273            let mut on_update_bindings: Vec<(usize, &str)> = Vec::new();
9274            for (i, c) in t.schema.columns.iter().enumerate() {
9275                if let Some(e) = &c.on_update_runtime {
9276                    on_update_bindings.push((i, e.as_str()));
9277                }
9278            }
9279            write_u16(
9280                &mut out,
9281                u16::try_from(on_update_bindings.len()).expect("≤ 65k ON UPDATE columns/table"),
9282            );
9283            for (pos, expr_src) in on_update_bindings {
9284                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9285                write_str(&mut out, expr_src);
9286            }
9287            // v7.17.0 Phase 2.5 — per-table collation appendix.
9288            // Sparse: only non-Binary columns land. Layout:
9289            // `[u16 count][u16 col_pos][u8 tag] × count`.
9290            let mut coll_bindings: Vec<(usize, u8)> = Vec::new();
9291            for (i, c) in t.schema.columns.iter().enumerate() {
9292                let tag = match c.collation {
9293                    Collation::Binary => continue,
9294                    Collation::CaseInsensitive => Collation::TAG_CASE_INSENSITIVE,
9295                };
9296                coll_bindings.push((i, tag));
9297            }
9298            write_u16(
9299                &mut out,
9300                u16::try_from(coll_bindings.len()).expect("≤ 65k collation bindings/table"),
9301            );
9302            for (pos, tag) in coll_bindings {
9303                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9304                out.push(tag);
9305            }
9306            // v7.17.0 Phase 4.4 — per-table is_unsigned appendix.
9307            // Sparse: only UNSIGNED columns land. Layout:
9308            // `[u16 count][u16 col_pos] × count`.
9309            let mut unsigned_bindings: Vec<usize> = Vec::new();
9310            for (i, c) in t.schema.columns.iter().enumerate() {
9311                if c.is_unsigned {
9312                    unsigned_bindings.push(i);
9313                }
9314            }
9315            write_u16(
9316                &mut out,
9317                u16::try_from(unsigned_bindings.len()).expect("≤ 65k UNSIGNED columns/table"),
9318            );
9319            for pos in unsigned_bindings {
9320                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9321            }
9322            // v7.17.0 Phase 3.P0-36 — per-table inline_enum_variants
9323            // appendix. Sparse: only ENUM columns land. Layout:
9324            // `[u16 count] then per binding [u16 col_pos]
9325            // [u16 variant_count] then variant strings`.
9326            // FILE_VERSION 41+; v40 readers never reach this block.
9327            let mut enum_inline_bindings: Vec<(usize, &[String])> = Vec::new();
9328            for (i, c) in t.schema.columns.iter().enumerate() {
9329                if let Some(vs) = &c.inline_enum_variants {
9330                    enum_inline_bindings.push((i, vs.as_slice()));
9331                }
9332            }
9333            write_u16(
9334                &mut out,
9335                u16::try_from(enum_inline_bindings.len()).expect("≤ 65k inline-ENUM columns/table"),
9336            );
9337            for (pos, variants) in enum_inline_bindings {
9338                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9339                write_u16(
9340                    &mut out,
9341                    u16::try_from(variants.len()).expect("≤ 65k variants/ENUM"),
9342                );
9343                for v in variants {
9344                    write_str(&mut out, v.as_str());
9345                }
9346            }
9347            // v7.17.0 Phase 3.P0-37 — per-table inline_set_variants
9348            // appendix. Same layout as the inline ENUM block.
9349            // FILE_VERSION 42+; v41 readers never reach this block.
9350            let mut set_inline_bindings: Vec<(usize, &[String])> = Vec::new();
9351            for (i, c) in t.schema.columns.iter().enumerate() {
9352                if let Some(vs) = &c.inline_set_variants {
9353                    set_inline_bindings.push((i, vs.as_slice()));
9354                }
9355            }
9356            write_u16(
9357                &mut out,
9358                u16::try_from(set_inline_bindings.len()).expect("≤ 65k inline-SET columns/table"),
9359            );
9360            for (pos, variants) in set_inline_bindings {
9361                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9362                write_u16(
9363                    &mut out,
9364                    u16::try_from(variants.len()).expect("≤ 65k variants/SET"),
9365                );
9366                for v in variants {
9367                    write_str(&mut out, v.as_str());
9368                }
9369            }
9370            // v7.37.6-B — partition role appendix(FILE_VERSION 49+)。
9371            // Layout 详见 FILE_VERSION 49 docstring。普通表 = 单字节 0。
9372            write_partition_role(&mut out, t.schema.partition_role.as_ref());
9373            // v7.37.7 — per-table generated_stored_expr appendix
9374            // (FILE_VERSION 50+). Sparse: only columns whose
9375            // generated_stored_expr is Some land here.
9376            let mut gen_bindings: Vec<(usize, &str)> = Vec::new();
9377            for (i, c) in t.schema.columns.iter().enumerate() {
9378                if let Some(src) = &c.generated_stored_expr {
9379                    gen_bindings.push((i, src.as_str()));
9380                }
9381            }
9382            write_u16(
9383                &mut out,
9384                u16::try_from(gen_bindings.len()).expect("≤ 65k GENERATED STORED columns/table"),
9385            );
9386            for (pos, src) in gen_bindings {
9387                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9388                write_str(&mut out, src);
9389            }
9390            // v7.38 (read01) — per-table default_text appendix
9391            // (FILE_VERSION 58+). Sparse: only columns whose default_text
9392            // is Some land here. Mirrors the generated_stored_expr shape.
9393            let mut default_texts: Vec<(usize, &str)> = Vec::new();
9394            for (i, c) in t.schema.columns.iter().enumerate() {
9395                if let Some(src) = &c.default_text {
9396                    default_texts.push((i, src.as_str()));
9397                }
9398            }
9399            write_u16(
9400                &mut out,
9401                u16::try_from(default_texts.len()).expect("≤ 65k defaulted columns/table"),
9402            );
9403            for (pos, src) in default_texts {
9404                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9405                write_str(&mut out, src);
9406            }
9407            // v7.39 (RLS) — per-table policy appendix + the two RLS flags
9408            // (FILE_VERSION 59+). Written after the default_text block and
9409            // before the MVCC row appendix, so a v58 reader stops before it.
9410            // Layout: [u8 row_security][u8 force] [u16 policy_count] then per
9411            // policy: [str name][u8 cmd][u8 permissive][u16 role_count]
9412            // (role_count × str) [u8 has_using](+str)[u8 has_check](+str).
9413            out.push(u8::from(t.schema.row_security));
9414            out.push(u8::from(t.schema.force_row_security));
9415            write_u16(
9416                &mut out,
9417                u16::try_from(t.schema.policies.len()).expect("≤ 65k policies/table"),
9418            );
9419            for p in &t.schema.policies {
9420                write_str(&mut out, &p.name);
9421                out.push(p.cmd.to_wire_byte());
9422                out.push(u8::from(p.permissive));
9423                write_u16(
9424                    &mut out,
9425                    u16::try_from(p.roles.len()).expect("≤ 65k roles/policy"),
9426                );
9427                for r in &p.roles {
9428                    write_str(&mut out, r);
9429                }
9430                match &p.using_expr {
9431                    Some(s) => {
9432                        out.push(1);
9433                        write_str(&mut out, s);
9434                    }
9435                    None => out.push(0),
9436                }
9437                match &p.with_check_expr {
9438                    Some(s) => {
9439                        out.push(1);
9440                        write_str(&mut out, s);
9441                    }
9442                    None => out.push(0),
9443                }
9444            }
9445            // v7.37.16 (Epic W) — per-row MVCC header + stable RowId
9446            // appendix (FILE_VERSION 53+). Persists xmin/xmax/flags +
9447            // RowId for every row so a tombstone naming a pre-checkpoint
9448            // row survives a serialize→deserialize base restore
9449            // (cross-checkpoint tombstone durability). `headers` /
9450            // `rowids` are lock-step parallel to `rows` (invariant held
9451            // at every mutation boundary), so the count is `rows.len()`
9452            // and the zipped walk visits them in physical row order —
9453            // the same order the rows block above was written in. v52
9454            // readers never reach this block (the writer also moves to
9455            // v53 in lock-step); a v53 reader restores headers + ids
9456            // verbatim instead of freezing + dense-assigning.
9457            debug_assert_eq!(
9458                t.rows.len(),
9459                t.headers.len(),
9460                "headers must be lock-step with rows at serialize"
9461            );
9462            debug_assert_eq!(
9463                t.rows.len(),
9464                t.rowids.len(),
9465                "rowids must be lock-step with rows at serialize"
9466            );
9467            write_u32(
9468                &mut out,
9469                u32::try_from(t.rows.len()).expect("≤ 4G rows/table"),
9470            );
9471            for (h, rid) in t.headers.iter().zip(t.rowids.iter()) {
9472                out.extend_from_slice(&h.xmin.to_le_bytes());
9473                out.extend_from_slice(&h.xmax.to_le_bytes());
9474                out.push(h.flags);
9475                out.extend_from_slice(&rid.0.to_le_bytes());
9476            }
9477            out.extend_from_slice(
9478                &t.next_rowid
9479                    .load(core::sync::atomic::Ordering::Relaxed)
9480                    .to_le_bytes(),
9481            );
9482            // v7.39 (read01 round 48) — constraint-name appendix
9483            // (FILE_VERSION 60+). Index-aligned to the CHECK and
9484            // uniqueness-constraint appendices written above, so the
9485            // existing byte layouts stay untouched and a v59 catalog still
9486            // decodes (its constraints just come back unnamed).
9487            // Layout: [u16 check_count] then per check
9488            //         [u8 has_name] ([str name] when has_name)
9489            //         [u16 uc_count] then per uc the same pair.
9490            write_u16(
9491                &mut out,
9492                u16::try_from(t.schema.checks.len()).expect("≤ 65k CHECK constraints/table"),
9493            );
9494            for c in &t.schema.checks {
9495                match &c.name {
9496                    Some(n) => {
9497                        out.push(1);
9498                        write_str(&mut out, n);
9499                    }
9500                    None => out.push(0),
9501                }
9502            }
9503            write_u16(
9504                &mut out,
9505                u16::try_from(t.schema.uniqueness_constraints.len())
9506                    .expect("≤ 65k uniqueness constraints/table"),
9507            );
9508            for uc in &t.schema.uniqueness_constraints {
9509                match &uc.name {
9510                    Some(n) => {
9511                        out.push(1);
9512                        write_str(&mut out, n);
9513                    }
9514                    None => out.push(0),
9515                }
9516            }
9517            // v7.39 (read01 round 56) — user_composite_type appendix
9518            // (FILE_VERSION 63+). Sparse, at the very end of the per-table
9519            // block: only composite-typed columns land here, so a v62 reader
9520            // stops before it and its composite columns stay plain JSON.
9521            let mut comp_bindings: Vec<(usize, &str)> = Vec::new();
9522            for (i, c) in t.schema.columns.iter().enumerate() {
9523                if let Some(n) = &c.user_composite_type {
9524                    comp_bindings.push((i, n.as_str()));
9525                }
9526            }
9527            write_u16(
9528                &mut out,
9529                u16::try_from(comp_bindings.len()).expect("≤ 65k composite-typed columns/table"),
9530            );
9531            for (pos, n) in comp_bindings {
9532                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9533                write_str(&mut out, n);
9534            }
9535            // v7.39 (read01 round 57) — owner + ACL appendix (FILE_VERSION
9536            // 64+), at the very end of the per-table block so a v63 reader
9537            // stops before it (its tables then read back owner-less, i.e.
9538            // owned by the login role, with no grants — which is exactly what
9539            // they were).
9540            match &t.schema.owner {
9541                Some(o) => {
9542                    out.push(1);
9543                    write_str(&mut out, o);
9544                }
9545                None => out.push(0),
9546            }
9547            write_u16(
9548                &mut out,
9549                u16::try_from(t.schema.acl.len()).expect("≤ 65k aclitems/table"),
9550            );
9551            for a in &t.schema.acl {
9552                write_str(&mut out, &a.grantee);
9553                write_u16(&mut out, a.privs);
9554                write_u16(&mut out, a.grantable);
9555                write_str(&mut out, &a.grantor);
9556            }
9557            // v7.39 (read01 round 59) — COLUMN acl appendix (FILE_VERSION 65+),
9558            // sparse: only columns that carry a grant land here, so a v64 reader
9559            // stops before it and its columns read back un-granted, which is
9560            // what they were.
9561            let granted: Vec<(usize, &ColumnSchema)> = t
9562                .schema
9563                .columns
9564                .iter()
9565                .enumerate()
9566                .filter(|(_, c)| !c.acl.is_empty())
9567                .collect();
9568            write_u16(
9569                &mut out,
9570                u16::try_from(granted.len()).expect("≤ 65k granted columns/table"),
9571            );
9572            for (pos, c) in granted {
9573                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9574                write_u16(
9575                    &mut out,
9576                    u16::try_from(c.acl.len()).expect("≤ 65k aclitems/column"),
9577                );
9578                for a in &c.acl {
9579                    write_str(&mut out, &a.grantee);
9580                    write_u16(&mut out, a.privs);
9581                    write_u16(&mut out, a.grantable);
9582                    write_str(&mut out, &a.grantor);
9583                }
9584            }
9585            // v7.39 (round 210) — EXCLUDE-constraint appendix (FILE_VERSION
9586            // 72+), at the very end of the per-table block so a v71 reader
9587            // stops before it and its tables read back with no exclusion
9588            // constraints. Layout: [u16 excl_count] then per constraint
9589            // [str name] [u8 has_method](+str) [u16 elem_count] then per
9590            // element [u16 col_pos][str op].
9591            write_u16(
9592                &mut out,
9593                u16::try_from(t.schema.exclusion_constraints.len())
9594                    .expect("≤ 65k exclusion constraints/table"),
9595            );
9596            for ex in &t.schema.exclusion_constraints {
9597                write_str(&mut out, &ex.name);
9598                match &ex.method {
9599                    Some(m) => {
9600                        out.push(1);
9601                        write_str(&mut out, m);
9602                    }
9603                    None => out.push(0),
9604                }
9605                write_u16(
9606                    &mut out,
9607                    u16::try_from(ex.elements.len()).expect("≤ 65k elements/exclusion"),
9608                );
9609                for (pos, op) in &ex.elements {
9610                    write_u16(&mut out, u16::try_from(*pos).expect("≤ 65k columns/table"));
9611                    write_str(&mut out, op);
9612                }
9613            }
9614            // v7.39 (round 220) — identity-RESTART appendix (FILE_VERSION
9615            // 73+), sparse: only columns carrying a RESTART floor land here.
9616            let restarts: Vec<(usize, i64)> = t
9617                .schema
9618                .columns
9619                .iter()
9620                .enumerate()
9621                .filter_map(|(i, c)| c.auto_restart.map(|n| (i, n)))
9622                .collect();
9623            write_u16(
9624                &mut out,
9625                u16::try_from(restarts.len()).expect("≤ 65k restart columns/table"),
9626            );
9627            for (pos, n) in restarts {
9628                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9629                out.extend_from_slice(&n.to_le_bytes());
9630            }
9631            // v7.39 (round 386, type-fidelity epic P1) — per-table
9632            // mysql_int_width appendix (FILE_VERSION 81+). Sparse: only
9633            // TINYINT / MEDIUMINT columns land. Layout:
9634            // `[u16 count]([u16 col_pos][u8 width_tag]) × count`
9635            // (tag 0 = Tiny, 1 = Medium). v80-and-below readers stop after
9636            // the identity-RESTART appendix, leaving every column at None.
9637            let int_widths: Vec<(usize, u8)> = t
9638                .schema
9639                .columns
9640                .iter()
9641                .enumerate()
9642                .filter_map(|(i, c)| {
9643                    c.mysql_int_width.map(|w| {
9644                        let tag = match w {
9645                            MysqlIntWidth::Tiny => 0u8,
9646                            MysqlIntWidth::Medium => 1u8,
9647                            MysqlIntWidth::Small => 2u8,
9648                            MysqlIntWidth::Int => 3u8,
9649                            MysqlIntWidth::Big => 4u8,
9650                        };
9651                        (i, tag)
9652                    })
9653                })
9654                .collect();
9655            write_u16(
9656                &mut out,
9657                u16::try_from(int_widths.len()).expect("≤ 65k narrow-int columns/table"),
9658            );
9659            for (pos, tag) in int_widths {
9660                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9661                out.push(tag);
9662            }
9663            // v7.39 (round 424, type-fidelity epic) — per-table mysql_fsp
9664            // appendix (FILE_VERSION 82+). Sparse: only MySQL-declared
9665            // temporal columns land. Layout:
9666            // `[u16 count]([u16 col_pos][u8 fsp]) × count`, fsp in 0..=6.
9667            // v81-and-below readers stop after the int-width appendix,
9668            // leaving every column at None (PG microsecond behaviour).
9669            let fsps: Vec<(usize, u8)> = t
9670                .schema
9671                .columns
9672                .iter()
9673                .enumerate()
9674                .filter_map(|(i, c)| c.mysql_fsp.map(|p| (i, p)))
9675                .collect();
9676            write_u16(
9677                &mut out,
9678                u16::try_from(fsps.len()).expect("≤ 65k temporal columns/table"),
9679            );
9680            for (pos, fsp) in fsps {
9681                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9682                out.push(fsp);
9683            }
9684            // v7.39 (round 652) — CHECK-validated appendix (FILE_VERSION
9685            // 87+). Sparse the other way round from the ones above: the
9686            // common case is every constraint validated, so only the
9687            // NOT VALID ones are written, by their index into the CHECK
9688            // appendix. Layout: `[u16 count]([u16 check_idx]) × count`.
9689            let unvalidated: Vec<usize> = t
9690                .schema
9691                .checks
9692                .iter()
9693                .enumerate()
9694                .filter_map(|(i, c)| (!c.validated).then_some(i))
9695                .collect();
9696            write_u16(
9697                &mut out,
9698                u16::try_from(unvalidated.len()).expect("≤ 65k CHECK constraints/table"),
9699            );
9700            for idx in unvalidated {
9701                write_u16(&mut out, u16::try_from(idx).expect("≤ 65k CHECK/table"));
9702            }
9703            // v7.39 (round 677) — per-column collation names (FILE_VERSION
9704            // 88+). Sparse: only the columns that were written with an
9705            // explicit `COLLATE` appear, so a table that declares none pays
9706            // two bytes. Layout: `[u16 count]([u16 col_idx][str]) × count`.
9707            //
9708            // Without this the declaration survives CREATE TABLE and dies
9709            // at the next restart — measured: a column declared
9710            // `COLLATE "C"` reported attcollation 950 in the session that
9711            // created it and 100 after a reload.
9712            let collated: Vec<(usize, &str)> = t
9713                .schema
9714                .columns
9715                .iter()
9716                .enumerate()
9717                .filter_map(|(i, c)| c.collation_name.as_deref().map(|n| (i, n)))
9718                .collect();
9719            write_u16(
9720                &mut out,
9721                u16::try_from(collated.len()).expect("≤ 65k columns/table"),
9722            );
9723            for (idx, name) in collated {
9724                write_u16(&mut out, u16::try_from(idx).expect("≤ 65k columns/table"));
9725                write_str(&mut out, name);
9726            }
9727            // v7.39 (round 711) — PK/UNIQUE constraint timing (FILE_VERSION
9728            // 89+). Dense, one byte per uniqueness constraint in
9729            // declaration order, the same bit layout the FK block has
9730            // carried since round 288: bit 0 = DEFERRABLE, bit 1 =
9731            // INITIALLY DEFERRED. A v88 reader stops before it.
9732            write_u16(
9733                &mut out,
9734                u16::try_from(t.schema.uniqueness_constraints.len())
9735                    .expect("≤ 65k uniqueness constraints/table"),
9736            );
9737            for uc in &t.schema.uniqueness_constraints {
9738                out.push(u8::from(uc.deferrable) | (u8::from(uc.initially_deferred) << 1));
9739            }
9740        }
9741        // v7.12.4 — catalog-wide appendix: user-defined functions
9742        // then triggers. FILE_VERSION 22+ only. v21 and earlier
9743        // readers stop after the last table; v22 readers always
9744        // consume two `u32` counts (possibly zero).
9745        //
9746        // Function entry layout:
9747        //   [str name] [str args_repr] [str returns]
9748        //   [str language] [str body]
9749        // Trigger entry layout:
9750        //   [str name] [str table] [str timing]
9751        //   [u16 event_count] (event_count × str)
9752        //   [str for_each] [str function]
9753        write_u32(
9754            &mut out,
9755            u32::try_from(self.functions.len()).expect("≤ 4G functions"),
9756        );
9757        for fd in self.functions.values() {
9758            write_str(&mut out, &fd.name);
9759            write_str(&mut out, &fd.args_repr);
9760            write_str(&mut out, &fd.returns);
9761            write_str(&mut out, &fd.language);
9762            write_str_long(&mut out, &fd.body);
9763        }
9764        write_u32(
9765            &mut out,
9766            u32::try_from(self.triggers.len()).expect("≤ 4G triggers"),
9767        );
9768        for td in &self.triggers {
9769            write_str(&mut out, &td.name);
9770            write_str(&mut out, &td.table);
9771            write_str(&mut out, &td.timing);
9772            write_u16(
9773                &mut out,
9774                u16::try_from(td.events.len()).expect("≤ 65k events / trigger"),
9775            );
9776            for ev in &td.events {
9777                write_str(&mut out, ev);
9778            }
9779            write_str(&mut out, &td.for_each);
9780            write_str(&mut out, &td.function);
9781            // v7.13.0 — `UPDATE OF cols` filter
9782            // (FILE_VERSION 23+). v22 readers omit; v23 writers
9783            // always emit (possibly zero).
9784            write_u16(
9785                &mut out,
9786                u16::try_from(td.update_columns.len()).expect("≤ 65k cols / trigger"),
9787            );
9788            for c in &td.update_columns {
9789                write_str(&mut out, c);
9790            }
9791            // v7.16.1 — TriggerDef.enabled (FILE_VERSION 25+).
9792            out.push(u8::from(td.enabled));
9793            // v7.39 (round 138) — WHEN condition text (FILE_VERSION 70+).
9794            write_str(&mut out, &td.when_condition);
9795        }
9796        // v7.17.0 Phase 1.1 — SEQUENCE catalog block (FILE_VERSION 26+).
9797        write_u32(
9798            &mut out,
9799            u32::try_from(self.sequences.len()).expect("≤ 4G sequences"),
9800        );
9801        for seq in self.sequences.values() {
9802            write_str(&mut out, &seq.name);
9803            out.push(match seq.data_type {
9804                SequenceDataType::SmallInt => 0,
9805                SequenceDataType::Int => 1,
9806                SequenceDataType::BigInt => 2,
9807            });
9808            out.extend_from_slice(&seq.start.to_le_bytes());
9809            out.extend_from_slice(&seq.increment.to_le_bytes());
9810            out.extend_from_slice(&seq.min_value.to_le_bytes());
9811            out.extend_from_slice(&seq.max_value.to_le_bytes());
9812            out.extend_from_slice(&seq.cache.to_le_bytes());
9813            out.push(u8::from(seq.cycle));
9814            match &seq.owned_by {
9815                None => out.push(0),
9816                Some((table, column)) => {
9817                    out.push(1);
9818                    write_str(&mut out, table);
9819                    write_str(&mut out, column);
9820                }
9821            }
9822            out.extend_from_slice(&seq.last_value.to_le_bytes());
9823            out.push(u8::from(seq.is_called));
9824        }
9825        // v7.17.0 Phase 1.2 — VIEW catalog block (FILE_VERSION 27+).
9826        write_u32(
9827            &mut out,
9828            u32::try_from(self.views.len()).expect("≤ 4G views"),
9829        );
9830        for view in self.views.values() {
9831            write_str(&mut out, &view.name);
9832            write_u16(
9833                &mut out,
9834                u16::try_from(view.columns.len()).expect("≤ 65k cols / view"),
9835            );
9836            for c in &view.columns {
9837                write_str(&mut out, c);
9838            }
9839            write_str_long(&mut out, &view.body);
9840            // v7.39 (round 132, FILE_VERSION 69+) — WITH CHECK OPTION marker.
9841            out.push(view.check_option);
9842        }
9843        // v7.17.0 Phase 1.3 — MATERIALIZED VIEW source registry
9844        // (FILE_VERSION 28+). The backing rows live as a regular
9845        // table of the same name already in the tables block.
9846        write_u32(
9847            &mut out,
9848            u32::try_from(self.materialized_views.len()).expect("≤ 4G materialized views"),
9849        );
9850        for (name, body) in &self.materialized_views {
9851            write_str(&mut out, name);
9852            write_str_long(&mut out, body);
9853        }
9854        // v7.17.0 Phase 1.4 — ENUM types catalog block
9855        // (FILE_VERSION 29+).
9856        write_u32(
9857            &mut out,
9858            u32::try_from(self.enum_types.len()).expect("≤ 4G enum types"),
9859        );
9860        for e in self.enum_types.values() {
9861            write_str(&mut out, &e.name);
9862            write_u16(
9863                &mut out,
9864                u16::try_from(e.labels.len()).expect("≤ 65k labels / enum"),
9865            );
9866            for l in &e.labels {
9867                write_str(&mut out, l);
9868            }
9869        }
9870        // v7.17.0 Phase 1.5 — DOMAIN types catalog block
9871        // (FILE_VERSION 30+).
9872        write_u32(
9873            &mut out,
9874            u32::try_from(self.domain_types.len()).expect("≤ 4G domain types"),
9875        );
9876        for d in self.domain_types.values() {
9877            write_str(&mut out, &d.name);
9878            write_data_type(&mut out, d.base_type);
9879            out.push(u8::from(d.nullable));
9880            match &d.default {
9881                None => out.push(0),
9882                Some(s) => {
9883                    out.push(1);
9884                    write_str(&mut out, s);
9885                }
9886            }
9887            write_u16(
9888                &mut out,
9889                u16::try_from(d.checks.len()).expect("≤ 65k CHECKs / domain"),
9890            );
9891            for c in &d.checks {
9892                write_str(&mut out, &c.expr);
9893                // v7.39 (round 260) — the constraint name (FILE_VERSION 75+).
9894                write_str(&mut out, &c.name);
9895            }
9896            // v7.39 (round 259) — the parent domain (FILE_VERSION 74+).
9897            match &d.base_domain {
9898                None => out.push(0),
9899                Some(s) => {
9900                    out.push(1);
9901                    write_str(&mut out, s);
9902                }
9903            }
9904        }
9905        // v7.17.0 Phase 1.6 — user-schemas registry
9906        // (FILE_VERSION 31+). Built-ins are hardcoded in
9907        // `is_builtin_schema` and not persisted.
9908        write_u32(
9909            &mut out,
9910            u32::try_from(self.schemas.len()).expect("≤ 4G schemas"),
9911        );
9912        for name in &self.schemas {
9913            write_str(&mut out, name);
9914        }
9915        // v7.37.42-T2 ζ-B — COMPOSITE types catalog block
9916        // (FILE_VERSION 52+). Each entry: name, u16 field_count,
9917        // then field_count `[str field_name][data_type]` pairs.
9918        write_u32(
9919            &mut out,
9920            u32::try_from(self.composite_types.len()).expect("≤ 4G composite types"),
9921        );
9922        for c in self.composite_types.values() {
9923            write_str(&mut out, &c.name);
9924            write_u16(
9925                &mut out,
9926                u16::try_from(c.fields.len()).expect("≤ 65k fields / composite"),
9927            );
9928            for (i, (fname, fty)) in c.fields.iter().enumerate() {
9929                write_str(&mut out, fname);
9930                write_data_type(&mut out, *fty);
9931                // v7.39 (round 264) — the field's user type (v76+).
9932                match c.field_user_types.get(i).and_then(Option::as_ref) {
9933                    None => out.push(0),
9934                    Some(n) => {
9935                        out.push(1);
9936                        write_str(&mut out, n);
9937                    }
9938                }
9939            }
9940        }
9941        // v7.39 (read01 round 50) — COMMENT store (FILE_VERSION 61+).
9942        // Catalog-wide, written last (before the CRC trailer) so every older
9943        // reader stops before it. Layout: [u32 count] then [str key][str text].
9944        write_u32(
9945            &mut out,
9946            u32::try_from(self.comments.len()).expect("≤ 4G comments"),
9947        );
9948        for (k, v) in &self.comments {
9949            write_str(&mut out, k);
9950            write_str_long(&mut out, v);
9951        }
9952        // v7.39 (read01 round 60) — non-table ACLs (FILE_VERSION 66+), catalog-
9953        // wide and written last so a v65 reader stops before them. The sequence
9954        // block itself sits mid-image and cannot grow without breaking older
9955        // readers, so a sequence's owner + ACL rides here, keyed by name.
9956        let acl_out = |out: &mut Vec<u8>, acl: &[AclItem]| {
9957            write_u16(out, u16::try_from(acl.len()).expect("≤ 65k aclitems"));
9958            for a in acl {
9959                write_str(out, &a.grantee);
9960                write_u16(out, a.privs);
9961                write_u16(out, a.grantable);
9962                write_str(out, &a.grantor);
9963            }
9964        };
9965        let owned: Vec<&SequenceDef> = self
9966            .sequences
9967            .values()
9968            .filter(|s| s.owner.is_some() || !s.acl.is_empty())
9969            .collect();
9970        write_u32(
9971            &mut out,
9972            u32::try_from(owned.len()).expect("≤ 4G sequences"),
9973        );
9974        for seq in owned {
9975            write_str(&mut out, &seq.name);
9976            match &seq.owner {
9977                Some(o) => {
9978                    out.push(1);
9979                    write_str(&mut out, o);
9980                }
9981                None => out.push(0),
9982            }
9983            acl_out(&mut out, &seq.acl);
9984        }
9985        acl_out(&mut out, &self.schema_acl);
9986        acl_out(&mut out, &self.database_acl);
9987        // v7.39 (read01 round 61) — FUNCTION owner + ACL (FILE_VERSION 67+).
9988        // The function block sits mid-image like the sequence one, so this
9989        // rides the catalog-wide tail too, keyed by name.
9990        let fns: Vec<&FunctionDef> = self
9991            .functions
9992            .values()
9993            .filter(|f| f.owner.is_some() || !f.acl.is_empty())
9994            .collect();
9995        write_u32(&mut out, u32::try_from(fns.len()).expect("≤ 4G functions"));
9996        for f in fns {
9997            // v7.39 (read01 round 62) — keyed by SIGNATURE now: two overloads
9998            // have two ACLs.
9999            write_str(&mut out, &function_signature_key(&f.name, &f.args_repr));
10000            match &f.owner {
10001                Some(o) => {
10002                    out.push(1);
10003                    write_str(&mut out, o);
10004                }
10005                None => out.push(0),
10006            }
10007            acl_out(&mut out, &f.acl);
10008        }
10009        // v7.39 (round 139) — RULE catalog block (FILE_VERSION 71+), catalog-
10010        // wide and written last (right before the CRC trailer) so every older
10011        // reader stops cleanly before it. Layout: [u32 count] then per rule
10012        // [str name][str table][str event][u8 instead][str when]
10013        // [u16 cmd_count]([str cmd] × cmd_count).
10014        write_u32(
10015            &mut out,
10016            u32::try_from(self.rules.len()).expect("≤ 4G rules"),
10017        );
10018        for r in &self.rules {
10019            write_str(&mut out, &r.name);
10020            write_str(&mut out, &r.table);
10021            write_str(&mut out, &r.event);
10022            out.push(u8::from(r.instead));
10023            write_str(&mut out, &r.when_condition);
10024            write_u16(
10025                &mut out,
10026                u16::try_from(r.commands.len()).expect("≤ 65k commands / rule"),
10027            );
10028            for c in &r.commands {
10029                write_str(&mut out, c);
10030            }
10031        }
10032        // v7.39 (round 280) — extended-statistics block (FILE_VERSION
10033        // 77+), appended after the RULE block for the same reason: an
10034        // older reader stops cleanly before it. Layout: [u32 count]
10035        // then per object [str name][str table][u16 n]([str kind] × n)
10036        // [u16 m]([str column] × m).
10037        write_u32(
10038            &mut out,
10039            u32::try_from(self.statistics_ext.len()).expect("≤ 4G statistics objects"),
10040        );
10041        for st in &self.statistics_ext {
10042            write_str(&mut out, &st.name);
10043            write_str(&mut out, &st.table);
10044            write_u16(
10045                &mut out,
10046                u16::try_from(st.kinds.len()).expect("≤ 65k kinds"),
10047            );
10048            for k in &st.kinds {
10049                write_str(&mut out, k);
10050            }
10051            write_u16(
10052                &mut out,
10053                u16::try_from(st.columns.len()).expect("≤ 65k columns"),
10054            );
10055            for c in &st.columns {
10056                write_str(&mut out, c);
10057            }
10058        }
10059        // v7.39 (round 287) — large-object block (FILE_VERSION 78+),
10060        // appended after the statistics block for the same reason: an
10061        // older reader stops cleanly before it. Layout: [u32 count]
10062        // then per object [u32 oid][u32 len][len bytes].
10063        write_u32(
10064            &mut out,
10065            u32::try_from(self.large_objects.len()).expect("≤ 4G large objects"),
10066        );
10067        for (oid, bytes) in &self.large_objects {
10068            write_u32(&mut out, *oid);
10069            write_u32(
10070                &mut out,
10071                u32::try_from(bytes.len()).expect("≤ 4G per object"),
10072            );
10073            out.extend_from_slice(bytes);
10074        }
10075        // v7.39 (round 322, V46) — function-attribute block (FILE_VERSION
10076        // 80+), appended last for the same reason as every block before
10077        // it: an older reader stops cleanly ahead of it and simply sees
10078        // functions with PG's default attributes. Only functions that
10079        // declared something non-default are written. Layout: [u32 count]
10080        // then per function [str signature_key][u8 volatility][u8 flags]
10081        // [u8 parallel][f64 cost or NaN][f64 rows or NaN], where flags bit
10082        // 0 = strict, 1 = security definer, 2 = leakproof.
10083        let attr_fns: Vec<(&String, &FunctionDef)> = self
10084            .functions
10085            .iter()
10086            .filter(|(_, f)| {
10087                f.volatility != FN_VOLATILE
10088                    || f.strict
10089                    || f.security_definer
10090                    || f.leakproof
10091                    || f.parallel != FN_PARALLEL_UNSAFE
10092                    || f.cost.is_some()
10093                    || f.rows.is_some()
10094            })
10095            .collect();
10096        write_u32(
10097            &mut out,
10098            u32::try_from(attr_fns.len()).expect("≤ 4G functions"),
10099        );
10100        for (key, f) in attr_fns {
10101            write_str(&mut out, key);
10102            out.push(f.volatility);
10103            let flags = u8::from(f.strict)
10104                | (u8::from(f.security_definer) << 1)
10105                | (u8::from(f.leakproof) << 2);
10106            out.push(flags);
10107            out.push(f.parallel);
10108            out.extend_from_slice(&f.cost.unwrap_or(f64::NAN).to_le_bytes());
10109            out.extend_from_slice(&f.rows.unwrap_or(f64::NAN).to_le_bytes());
10110        }
10111        // v7.38 (read01 P5.05) — CRC32C trailer over the whole image so a
10112        // corrupted snapshot is rejected on load. FILE_VERSION is >= the
10113        // trailer version, so this always runs for freshly-written images.
10114        // v7.39 (round 547) — pg_db_role_setting (FILE_VERSION 85+),
10115        // catalog-wide and written LAST so a v84 reader stops before it.
10116        // Layout: [u32 scopes] then [str database][str role][u32 params]
10117        // then [str name][str value] per param.
10118        write_u32(
10119            &mut out,
10120            u32::try_from(self.db_role_settings.len()).expect("≤ 4G scopes"),
10121        );
10122        for ((db, role), params) in &self.db_role_settings {
10123            write_str(&mut out, db);
10124            write_str(&mut out, role);
10125            write_u32(&mut out, u32::try_from(params.len()).expect("≤ 4G params"));
10126            for (name, value) in params {
10127                write_str(&mut out, name);
10128                write_str(&mut out, value);
10129            }
10130        }
10131        // v7.39 (round 550) — replication slots (FILE_VERSION 86+),
10132        // written LAST so a v85 reader stops before them.
10133        write_u32(
10134            &mut out,
10135            u32::try_from(self.replication_slots.len()).expect("≤ 4G slots"),
10136        );
10137        for (name, (plugin, slot_type)) in &self.replication_slots {
10138            write_str(&mut out, name);
10139            write_str(&mut out, plugin);
10140            write_str(&mut out, slot_type);
10141        }
10142        let crc = spg_crypto::crc32c::crc32c(&out);
10143        write_u32(&mut out, crc);
10144        out
10145    }
10146
10147    /// Deserialize a previously-serialized catalog. Rejects bad magic, version
10148    /// mismatch, unknown tags, truncation, and trailing bytes.
10149    pub fn deserialize(buf: &[u8]) -> Result<Self, StorageError> {
10150        let mut cur = Cursor::new(buf);
10151        let magic = cur.take(8)?;
10152        if magic != FILE_MAGIC {
10153            return Err(StorageError::Corrupt(format!(
10154                "bad magic: expected SPGDB001, got {magic:?}"
10155            )));
10156        }
10157        let version = cur.read_u8()?;
10158        if !(MIN_SUPPORTED_FILE_VERSION..=FILE_VERSION).contains(&version) {
10159            return Err(StorageError::Corrupt(format!(
10160                "unsupported file version: {version} (supported: {MIN_SUPPORTED_FILE_VERSION}..={FILE_VERSION})"
10161            )));
10162        }
10163        // v7.23/v7.27 — escape decoding is version-gated (see
10164        // STR_LEN_ESCAPE / Cursor::codec_version).
10165        cur.codec_version = version;
10166        let table_count = cur.read_u32()? as usize;
10167        let mut cat = Self::new();
10168        for _ in 0..table_count {
10169            deserialize_table(&mut cur, &mut cat, version)?;
10170        }
10171        // v7.37.15 (Phase C.1) — stamp dense stable RelIds on load.
10172        // Pre-V6 envelopes carry no ids; a dense 1..=N assignment is
10173        // sufficient while RelId is process-local bookkeeping (the V6
10174        // envelope, Phase C.6, will round-trip real ids). Sets the
10175        // allocator above the loaded ids so a post-load CREATE TABLE
10176        // never collides.
10177        for (i, t) in cat.tables.iter_mut().enumerate() {
10178            t.set_rel_id(row_header::RelId((i as u64) + 1));
10179        }
10180        cat.next_rel_id = cat.tables.len() as u64;
10181        // v7.12.4 — catalog-wide function + trigger appendix.
10182        // FILE_VERSION 22+ only; v21 and earlier catalogs stop
10183        // after the last table.
10184        if version >= 22 {
10185            let fn_count = cur.read_u32()? as usize;
10186            for _ in 0..fn_count {
10187                let name = cur.read_str()?;
10188                let args_repr = cur.read_str()?;
10189                let returns = cur.read_str()?;
10190                let language = cur.read_str()?;
10191                let body = cur.read_str_long()?;
10192                let key = function_signature_key(&name, &args_repr);
10193                cat.functions.insert(
10194                    key,
10195                    FunctionDef {
10196                        name,
10197                        args_repr,
10198                        returns,
10199                        language,
10200                        body,
10201                        owner: None,
10202                        acl: Vec::new(),
10203                        volatility: FN_VOLATILE,
10204                        strict: false,
10205                        security_definer: false,
10206                        leakproof: false,
10207                        parallel: FN_PARALLEL_UNSAFE,
10208                        cost: None,
10209                        rows: None,
10210                    },
10211                );
10212            }
10213            let trg_count = cur.read_u32()? as usize;
10214            for _ in 0..trg_count {
10215                let name = cur.read_str()?;
10216                let table = cur.read_str()?;
10217                let timing = cur.read_str()?;
10218                let ev_count = cur.read_u16()? as usize;
10219                let mut events = Vec::with_capacity(ev_count);
10220                for _ in 0..ev_count {
10221                    events.push(cur.read_str()?);
10222                }
10223                let for_each = cur.read_str()?;
10224                let function = cur.read_str()?;
10225                // v7.13.0 — trailing `UPDATE OF cols` filter
10226                // (FILE_VERSION 23+ only; v22 catalogs omit and
10227                // deserialise with an empty vec).
10228                let update_columns = if version >= 23 {
10229                    let n = cur.read_u16()? as usize;
10230                    let mut cols = Vec::with_capacity(n);
10231                    for _ in 0..n {
10232                        cols.push(cur.read_str()?);
10233                    }
10234                    cols
10235                } else {
10236                    Vec::new()
10237                };
10238                // v7.16.1 — TriggerDef.enabled (FILE_VERSION 25+).
10239                // v24-and-below catalogs deserialise with `true`
10240                // — pre-v7.16.1 every trigger always fired.
10241                let enabled = if version >= 25 {
10242                    cur.read_u8()? != 0
10243                } else {
10244                    true
10245                };
10246                // v7.39 (round 138) — WHEN condition text added at FILE_VERSION
10247                // 70; older catalogs read back empty (no WHEN filter).
10248                let when_condition = if version >= 70 {
10249                    cur.read_str()?
10250                } else {
10251                    String::new()
10252                };
10253                cat.triggers.push(TriggerDef {
10254                    name,
10255                    table,
10256                    timing,
10257                    events,
10258                    for_each,
10259                    function,
10260                    update_columns,
10261                    enabled,
10262                    when_condition,
10263                });
10264            }
10265        }
10266        // v7.17.0 Phase 1.1 — SEQUENCE block (FILE_VERSION 26+).
10267        // v25-and-below catalogs omit; we leave the map empty.
10268        if version >= 26 {
10269            let seq_count = cur.read_u32()? as usize;
10270            for _ in 0..seq_count {
10271                let name = cur.read_str()?;
10272                let data_type = match cur.read_u8()? {
10273                    0 => SequenceDataType::SmallInt,
10274                    1 => SequenceDataType::Int,
10275                    2 => SequenceDataType::BigInt,
10276                    other => {
10277                        return Err(StorageError::Corrupt(format!(
10278                            "unknown SEQUENCE data-type tag {other}"
10279                        )));
10280                    }
10281                };
10282                let start = cur.read_i64()?;
10283                let increment = cur.read_i64()?;
10284                let min_value = cur.read_i64()?;
10285                let max_value = cur.read_i64()?;
10286                let cache = cur.read_i64()?;
10287                let cycle = cur.read_u8()? != 0;
10288                let owned_by = match cur.read_u8()? {
10289                    0 => None,
10290                    1 => {
10291                        let t = cur.read_str()?;
10292                        let c = cur.read_str()?;
10293                        Some((t, c))
10294                    }
10295                    other => {
10296                        return Err(StorageError::Corrupt(format!(
10297                            "unknown SEQUENCE owned-by tag {other}"
10298                        )));
10299                    }
10300                };
10301                let last_value = cur.read_i64()?;
10302                let is_called = cur.read_u8()? != 0;
10303                cat.sequences.insert(
10304                    name.clone(),
10305                    SequenceDef {
10306                        name,
10307                        data_type,
10308                        start,
10309                        increment,
10310                        min_value,
10311                        max_value,
10312                        cache,
10313                        cycle,
10314                        owned_by,
10315                        last_value,
10316                        is_called,
10317                        owner: None,
10318                        acl: Vec::new(),
10319                    },
10320                );
10321            }
10322        }
10323        // v7.17.0 Phase 1.2 — VIEW block (FILE_VERSION 27+).
10324        // v26-and-below catalogs omit; we leave the map empty.
10325        if version >= 27 {
10326            let view_count = cur.read_u32()? as usize;
10327            for _ in 0..view_count {
10328                let name = cur.read_str()?;
10329                let col_count = cur.read_u16()? as usize;
10330                let mut columns = Vec::with_capacity(col_count);
10331                for _ in 0..col_count {
10332                    columns.push(cur.read_str()?);
10333                }
10334                let body = cur.read_str_long()?;
10335                // v7.39 (round 132) — check-option marker added at FILE_VERSION
10336                // 69; older catalogs default to 0 (no check option).
10337                let check_option = if version >= 69 { cur.read_u8()? } else { 0 };
10338                cat.views.insert(
10339                    name.clone(),
10340                    ViewDef {
10341                        name,
10342                        columns,
10343                        body,
10344                        check_option,
10345                    },
10346                );
10347            }
10348        }
10349        // v7.17.0 Phase 1.3 — MATERIALIZED VIEW source registry
10350        // (FILE_VERSION 28+). v27-and-below catalogs omit.
10351        if version >= 28 {
10352            let mv_count = cur.read_u32()? as usize;
10353            for _ in 0..mv_count {
10354                let name = cur.read_str()?;
10355                let body = cur.read_str_long()?;
10356                cat.materialized_views.insert(name, body);
10357            }
10358        }
10359        // v7.17.0 Phase 1.4 — ENUM types catalog block
10360        // (FILE_VERSION 29+).
10361        if version >= 29 {
10362            let etype_count = cur.read_u32()? as usize;
10363            for _ in 0..etype_count {
10364                let name = cur.read_str()?;
10365                let label_count = cur.read_u16()? as usize;
10366                let mut labels = Vec::with_capacity(label_count);
10367                for _ in 0..label_count {
10368                    labels.push(cur.read_str()?);
10369                }
10370                cat.enum_types
10371                    .insert(name.clone(), EnumDef { name, labels });
10372            }
10373        }
10374        // v7.17.0 Phase 1.5 — DOMAIN types catalog block
10375        // (FILE_VERSION 30+).
10376        if version >= 30 {
10377            let dtype_count = cur.read_u32()? as usize;
10378            for _ in 0..dtype_count {
10379                let name = cur.read_str()?;
10380                let base_type = cur.read_data_type()?;
10381                let nullable = cur.read_u8()? != 0;
10382                let default = match cur.read_u8()? {
10383                    0 => None,
10384                    1 => Some(cur.read_str()?),
10385                    other => {
10386                        return Err(StorageError::Corrupt(format!(
10387                            "unknown DOMAIN default tag {other}"
10388                        )));
10389                    }
10390                };
10391                let check_count = cur.read_u16()? as usize;
10392                let mut checks: Vec<DomainCheck> = Vec::with_capacity(check_count);
10393                for i in 0..check_count {
10394                    let expr = cur.read_str()?;
10395                    // v7.39 (round 260) — names arrived in FILE_VERSION 75.
10396                    // An older catalog gets PG's auto-naming applied to the
10397                    // checks it stored, which is what they would have been.
10398                    let cname = if version >= 75 {
10399                        cur.read_str()?
10400                    } else if i == 0 {
10401                        alloc::format!("{name}_check")
10402                    } else {
10403                        alloc::format!("{name}_check{i}")
10404                    };
10405                    checks.push(DomainCheck { name: cname, expr });
10406                }
10407                // v7.39 (round 259) — the parent domain. Absent before
10408                // FILE_VERSION 74; an older catalog reads as a domain over
10409                // a scalar, which is what it was.
10410                let base_domain = if version >= 74 {
10411                    match cur.read_u8()? {
10412                        0 => None,
10413                        1 => Some(cur.read_str()?),
10414                        other => {
10415                            return Err(StorageError::Corrupt(alloc::format!(
10416                                "domain base_domain tag {other}"
10417                            )));
10418                        }
10419                    }
10420                } else {
10421                    None
10422                };
10423                cat.domain_types.insert(
10424                    name.clone(),
10425                    DomainDef {
10426                        name,
10427                        base_type,
10428                        nullable,
10429                        default,
10430                        checks,
10431                        base_domain,
10432                    },
10433                );
10434            }
10435        }
10436        // v7.17.0 Phase 1.6 — user-schemas registry
10437        // (FILE_VERSION 31+).
10438        if version >= 31 {
10439            let sch_count = cur.read_u32()? as usize;
10440            for _ in 0..sch_count {
10441                let name = cur.read_str()?;
10442                cat.schemas.insert(name);
10443            }
10444        }
10445        // v7.37.42-T2 ζ-B — COMPOSITE types catalog block
10446        // (FILE_VERSION 52+). v51-and-below readers stop at the
10447        // user-schemas block; v52 readers fed a v51 catalog see no
10448        // composite block and default to an empty map.
10449        if version >= 52 {
10450            let ctype_count = cur.read_u32()? as usize;
10451            for _ in 0..ctype_count {
10452                let name = cur.read_str()?;
10453                let field_count = cur.read_u16()? as usize;
10454                let mut fields = Vec::with_capacity(field_count);
10455                let mut field_user_types: Vec<Option<String>> = Vec::with_capacity(field_count);
10456                for _ in 0..field_count {
10457                    let fname = cur.read_str()?;
10458                    let fty = cur.read_data_type()?;
10459                    // v7.39 (round 264) — present from FILE_VERSION 76.
10460                    let ut = if version >= 76 {
10461                        match cur.read_u8()? {
10462                            0 => None,
10463                            1 => Some(cur.read_str()?),
10464                            other => {
10465                                return Err(StorageError::Corrupt(alloc::format!(
10466                                    "composite field user-type tag {other}"
10467                                )));
10468                            }
10469                        }
10470                    } else {
10471                        None
10472                    };
10473                    fields.push((fname, fty));
10474                    field_user_types.push(ut);
10475                }
10476                cat.composite_types.insert(
10477                    name.clone(),
10478                    CompositeDef {
10479                        name,
10480                        fields,
10481                        field_user_types,
10482                    },
10483                );
10484            }
10485        }
10486        // v7.39 (read01 round 50) — COMMENT store (FILE_VERSION 61+).
10487        if version >= 61 {
10488            let comment_count = cur.read_u32()? as usize;
10489            for _ in 0..comment_count {
10490                let key = cur.read_str()?;
10491                let text = cur.read_str_long()?;
10492                cat.comments.insert(key, text);
10493            }
10494        }
10495        // v7.39 (read01 round 60) — non-table ACLs (FILE_VERSION 66+).
10496        if version >= 66 {
10497            let read_acl = |cur: &mut Cursor| -> Result<Vec<AclItem>, StorageError> {
10498                let n = cur.read_u16()? as usize;
10499                let mut acl = Vec::with_capacity(n);
10500                for _ in 0..n {
10501                    let grantee = cur.read_str()?;
10502                    let privs = cur.read_u16()?;
10503                    let grantable = cur.read_u16()?;
10504                    let grantor = cur.read_str()?;
10505                    acl.push(AclItem {
10506                        grantee,
10507                        privs,
10508                        grantable,
10509                        grantor,
10510                    });
10511                }
10512                Ok(acl)
10513            };
10514            let seq_count = cur.read_u32()? as usize;
10515            for _ in 0..seq_count {
10516                let name = cur.read_str()?;
10517                let owner = if cur.read_u8()? == 1 {
10518                    Some(cur.read_str()?)
10519                } else {
10520                    None
10521                };
10522                let acl = read_acl(&mut cur)?;
10523                if let Some(seq) = cat.sequences.get_mut(&name) {
10524                    seq.owner = owner;
10525                    seq.acl = acl;
10526                }
10527            }
10528            cat.schema_acl = read_acl(&mut cur)?;
10529            cat.database_acl = read_acl(&mut cur)?;
10530            // v7.39 (read01 round 61) — FUNCTION owner + ACL (v67+; keyed by
10531            // signature from v68, when overloads became possible).
10532            if version >= 67 {
10533                let fn_count = cur.read_u32()? as usize;
10534                for _ in 0..fn_count {
10535                    let name = cur.read_str()?;
10536                    let owner = if cur.read_u8()? == 1 {
10537                        Some(cur.read_str()?)
10538                    } else {
10539                        None
10540                    };
10541                    let acl = read_acl(&mut cur)?;
10542                    // v7.39 (round 315, V19) — the stored key was computed
10543                    // by whichever formula was current when the image was
10544                    // written. A miss is not "no such function": before the
10545                    // multi-word fix, `f(double precision)` keyed as
10546                    // `f(precision)`, so an older image's grants would land
10547                    // nowhere and vanish silently. Fall back to matching by
10548                    // the old formula, which re-attaches them.
10549                    let target = resolve_stored_function_key(&cat.functions, &name);
10550                    if let Some(k) = target
10551                        && let Some(f) = cat.functions.get_mut(&k)
10552                    {
10553                        f.owner = owner;
10554                        f.acl = acl;
10555                    }
10556                }
10557            }
10558        }
10559        // v7.39 (round 139) — RULE catalog block (FILE_VERSION 71+), read from
10560        // the tail right before the CRC trailer. Pre-71 images stop before it.
10561        if version >= 71 {
10562            let rule_count = cur.read_u32()? as usize;
10563            for _ in 0..rule_count {
10564                let name = cur.read_str()?;
10565                let table = cur.read_str()?;
10566                let event = cur.read_str()?;
10567                let instead = cur.read_u8()? != 0;
10568                let when_condition = cur.read_str()?;
10569                let cmd_count = cur.read_u16()? as usize;
10570                let mut commands = Vec::with_capacity(cmd_count);
10571                for _ in 0..cmd_count {
10572                    commands.push(cur.read_str()?);
10573                }
10574                cat.rules.push(RuleDef {
10575                    name,
10576                    table,
10577                    event,
10578                    instead,
10579                    when_condition,
10580                    commands,
10581                });
10582            }
10583        }
10584        // v7.39 (round 280) — extended-statistics block (FILE_VERSION
10585        // 77+). Pre-77 images stop before it.
10586        if version >= 77 {
10587            let count = cur.read_u32()? as usize;
10588            for _ in 0..count {
10589                let name = cur.read_str()?;
10590                let table = cur.read_str()?;
10591                let nk = cur.read_u16()? as usize;
10592                let mut kinds = Vec::with_capacity(nk);
10593                for _ in 0..nk {
10594                    kinds.push(cur.read_str()?);
10595                }
10596                let nc = cur.read_u16()? as usize;
10597                let mut columns = Vec::with_capacity(nc);
10598                for _ in 0..nc {
10599                    columns.push(cur.read_str()?);
10600                }
10601                cat.statistics_ext.push(StatisticsExtDef {
10602                    name,
10603                    table,
10604                    kinds,
10605                    columns,
10606                });
10607            }
10608        }
10609        // v7.39 (round 287) — large-object block (FILE_VERSION 78+).
10610        // Pre-78 images stop before it.
10611        if version >= 78 {
10612            let count = cur.read_u32()? as usize;
10613            for _ in 0..count {
10614                let oid = cur.read_u32()?;
10615                let len = cur.read_u32()? as usize;
10616                let bytes = cur.read_bytes(len)?;
10617                cat.large_objects.insert(oid, bytes);
10618            }
10619        }
10620        // v7.39 (round 322, V46) — function-attribute block (FILE_VERSION
10621        // 80+). Pre-80 images stop before it and keep PG's defaults.
10622        if version >= 80 {
10623            let count = cur.read_u32()? as usize;
10624            for _ in 0..count {
10625                let key = cur.read_str()?;
10626                let volatility = cur.read_u8()?;
10627                let flags = cur.read_u8()?;
10628                let parallel = cur.read_u8()?;
10629                let cost = f64::from_le_bytes(cur.read_bytes(8)?.try_into().unwrap_or([0; 8]));
10630                let rows = f64::from_le_bytes(cur.read_bytes(8)?.try_into().unwrap_or([0; 8]));
10631                if let Some(f) = cat.functions.get_mut(&key) {
10632                    f.volatility = volatility;
10633                    f.strict = flags & 1 != 0;
10634                    f.security_definer = flags & 2 != 0;
10635                    f.leakproof = flags & 4 != 0;
10636                    f.parallel = parallel;
10637                    f.cost = (!cost.is_nan()).then_some(cost);
10638                    f.rows = (!rows.is_nan()).then_some(rows);
10639                }
10640            }
10641        }
10642        // v7.39 (round 547) — pg_db_role_setting (FILE_VERSION 85+).
10643        // Pre-85 images stop before it and carry no GUC defaults.
10644        if version >= 85 {
10645            let scopes = cur.read_u32()? as usize;
10646            for _ in 0..scopes {
10647                let db = cur.read_str()?;
10648                let role = cur.read_str()?;
10649                let params = cur.read_u32()? as usize;
10650                let mut m: BTreeMap<String, String> = BTreeMap::new();
10651                for _ in 0..params {
10652                    let name = cur.read_str()?;
10653                    let value = cur.read_str()?;
10654                    m.insert(name, value);
10655                }
10656                if !m.is_empty() {
10657                    cat.db_role_settings.insert((db, role), m);
10658                }
10659            }
10660        }
10661        // v7.39 (round 550) — replication slots (FILE_VERSION 86+).
10662        if version >= 86 {
10663            let count = cur.read_u32()? as usize;
10664            for _ in 0..count {
10665                let name = cur.read_str()?;
10666                let plugin = cur.read_str()?;
10667                let slot_type = cur.read_str()?;
10668                cat.replication_slots.insert(name, (plugin, slot_type));
10669            }
10670        }
10671        // v7.38 (read01 P5.05) — v54+ images end with a CRC32C over every
10672        // preceding byte; verify it before accepting the snapshot. Older
10673        // images have no trailer and fall through to the trailing-byte check.
10674        if version >= FILE_VERSION_CRC_TRAILER {
10675            let crc_start = cur.pos;
10676            let stored = cur.read_u32()?;
10677            let computed = spg_crypto::crc32c::crc32c(&buf[..crc_start]);
10678            if computed != stored {
10679                return Err(StorageError::Corrupt(format!(
10680                    "base snapshot CRC mismatch: computed {computed:#010x}, stored {stored:#010x}"
10681                )));
10682            }
10683        }
10684        if cur.pos < buf.len() {
10685            return Err(StorageError::Corrupt(format!(
10686                "trailing bytes: {} unread",
10687                buf.len() - cur.pos
10688            )));
10689        }
10690        Ok(cat)
10691    }
10692}
10693
10694#[cfg(test)]
10695mod tests;