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/// The fold used to COMPARE / GROUP / de-dup text on the MySQL dialect:
1726/// case- and accent-insensitive, and **trailing spaces significant**.
1727///
1728/// v7.38.17 — this used to strip trailing spaces first, and its comment
1729/// said why: "measured on MariaDB 11". MariaDB's default collation is
1730/// PAD SPACE, so that measurement was right about MariaDB. SPG
1731/// advertises `8.0.0-spg-v…` on the MySQL wire, and MySQL 8.0's default
1732/// `utf8mb4_0900_ai_ci` is **NO PAD**. The rule had been calibrated
1733/// against the engine we do not claim to be.
1734///
1735/// Measured today, MySQL 9.7.2 against MariaDB 12.3.2, each in its own
1736/// default collation, over rows `'alpha'` and `'alpha  '`:
1737///
1738/// | | MySQL | MariaDB |
1739/// |---|---|---|
1740/// | `WHERE s = 'alpha'` | 1 | 1,2 |
1741/// | `s IN ('alpha','beta')` | 1,3,4 | 1,2,3,4 |
1742/// | `COUNT(DISTINCT s)` | 3 | 2 |
1743/// | `GROUP BY s` groups | 3 | 2 |
1744/// | `JOIN ON v.s = r.s` | 1/10, 2/20 | all four pairs |
1745///
1746/// SPG answered MariaDB's four and MySQL's join — the same question
1747/// decided differently by two paths, which is the shape v7.38.13,
1748/// v7.38.14 and v7.38.16 were each spent on.
1749///
1750/// `CHAR(n)` is a separate question and keeps its old answer: BOTH
1751/// engines ignore a CHAR's trailing spaces, because that is a property
1752/// of the TYPE rather than of the collation. Use
1753/// [`mysql_compare_fold_char`] for a `BpChar` cell.
1754///
1755/// Only literal spaces ever padded — a tab is significant either way —
1756/// and neither function is used by `LIKE`, whose pattern treats a
1757/// trailing space literally.
1758/// Whether a collation of this NAME orders by bytes.
1759///
1760/// v7.38.18 (S0) — pure string classification, and it lives here because
1761/// storage has to ask it: an index whose column collates by a locale
1762/// cannot key on the raw text, and the write path is here. The engine's
1763/// `collate::is_byte_wise` delegates to this one, for the reason the SQL
1764/// type spellings have one owner.
1765///
1766/// `C`, `POSIX`, MySQL's `binary` and every `_bin` family member. The
1767/// encoding suffix rides along: PG publishes `C.utf8` beside `C`.
1768pub fn collation_is_byte_wise(collation: &str) -> bool {
1769    let name = collation.trim();
1770    let base = name.split(['.', '@']).next().unwrap_or(name);
1771    base.eq_ignore_ascii_case("C")
1772        || base.eq_ignore_ascii_case("POSIX")
1773        || base.eq_ignore_ascii_case("binary")
1774        || base
1775            .rsplit_once('_')
1776            .is_some_and(|(_, tail)| tail.eq_ignore_ascii_case("bin"))
1777}
1778
1779/// v7.38.18 (S0/S2) — does an index on a column of this collation key
1780/// by an ICU SORT KEY rather than by the raw text?
1781///
1782/// True for a locale collation (`en_US.utf8`, `de_DE`), which orders by
1783/// rules a byte comparison cannot express.
1784///
1785/// False for byte-wise names, and false for MySQL's folding collations
1786/// (`utf8mb4_0900_ai_ci` and family). Those fold rather than collate,
1787/// and the engine has folded them since v7.37 — routing them here made
1788/// an indexed `s = 'ALPHA'` over the MySQL wire answer nothing where
1789/// MySQL 9.7.1 answers one row, because ICU at PG's strength does not
1790/// call `ALPHA` and `alpha` equal.
1791///
1792/// One owner for the same reason the byte-wise question has one: the
1793/// engine builds the PROBE and this crate builds the ENTRIES, and a
1794/// probe built in another space finds nothing — which reads exactly
1795/// like "no matching rows".
1796pub fn collation_uses_sort_key(collation: &str) -> bool {
1797    if collation_is_byte_wise(collation) {
1798        return false;
1799    }
1800    let name = collation.trim();
1801    let base = name.split(['.', '@']).next().unwrap_or(name);
1802    let lower = base.to_ascii_lowercase();
1803    !(lower.ends_with("_ci") || lower.ends_with("_cs"))
1804}
1805
1806pub fn mysql_compare_fold(s: &str) -> String {
1807    mysql_ci_fold(s)
1808}
1809
1810/// The comparison form of one text value under the MySQL default
1811/// collation, or `None` for a value that is not text.
1812///
1813/// v7.38.18 — one function, applied to each side SEPARATELY, because
1814/// the pair is not the unit. Several sites matched
1815/// `(Text, Text) | (BpChar, BpChar)` and folded a pair; a CHAR compared
1816/// against a VARCHAR or against a literal is neither shape, so it fell
1817/// through and was compared by bytes — with the CHAR still carrying its
1818/// padding. `CASE c WHEN 'ALPHA'` on a `CHAR(8)` holding `'alpha'`
1819/// answered ELSE where MySQL 9.7.2 answers the branch.
1820///
1821/// Folding per value also states the rule correctly: whether trailing
1822/// spaces count is a property of EACH side's own type, so a pair whose
1823/// sides differ has two answers rather than one.
1824pub fn mysql_fold_value(v: &Value<'_>) -> Option<String> {
1825    match v {
1826        Value::BpChar(s) => Some(mysql_compare_fold_char(s)),
1827        Value::Text(s) => Some(mysql_compare_fold(s)),
1828        _ => None,
1829    }
1830}
1831
1832/// [`mysql_compare_fold`] for a `CHAR(n)` cell, whose trailing spaces
1833/// are padding rather than data.
1834///
1835/// Measured on both engines: over `'alpha'` and `'alpha  '` in a
1836/// `CHAR(8)`, `WHERE s = 'alpha'` returns both rows and
1837/// `COUNT(DISTINCT s)` is 2 (four rows folding to two values) — MySQL
1838/// 9.7.2 and MariaDB 12.3.2 agree, unlike the VARCHAR case above.
1839pub fn mysql_compare_fold_char(s: &str) -> String {
1840    mysql_ci_fold(s.trim_end_matches(' '))
1841}
1842
1843/// The base letter(s) a lower-cased Latin character folds to, or `None`
1844/// when it is already a base / has no fold. Expansions (`ß` → `ss`) are
1845/// why this returns a string.
1846fn fold_latin_base(c: char) -> Option<&'static str> {
1847    Some(match c {
1848        'à' | 'á' | 'â' | 'ã' | 'ä' | 'å' | 'ā' | 'ă' | 'ą' => "a",
1849        'æ' => "ae",
1850        'ç' | 'ć' | 'č' | 'ĉ' | 'ċ' => "c",
1851        'ð' | 'ď' | 'đ' => "d",
1852        'è' | 'é' | 'ê' | 'ë' | 'ē' | 'ĕ' | 'ė' | 'ę' | 'ě' => "e",
1853        'ĝ' | 'ğ' | 'ġ' | 'ģ' => "g",
1854        'ì' | 'í' | 'î' | 'ï' | 'ĩ' | 'ī' | 'ĭ' | 'į' => "i",
1855        'ĵ' => "j",
1856        'ķ' => "k",
1857        'ł' | 'ĺ' | 'ļ' | 'ľ' => "l",
1858        'ñ' | 'ń' | 'ņ' | 'ň' => "n",
1859        'ò' | 'ó' | 'ô' | 'õ' | 'ö' | 'ø' | 'ō' | 'ŏ' | 'ő' => "o",
1860        'œ' => "oe",
1861        'ŕ' | 'ŗ' | 'ř' => "r",
1862        'ś' | 'š' | 'ŝ' | 'ş' => "s",
1863        'ß' => "ss",
1864        'ţ' | 'ť' | 'ŧ' => "t",
1865        'ù' | 'ú' | 'û' | 'ü' | 'ũ' | 'ū' | 'ŭ' | 'ů' | 'ű' | 'ų' => "u",
1866        'ý' | 'ÿ' => "y",
1867        'ź' | 'ž' | 'ż' => "z",
1868        _ => return None,
1869    })
1870}
1871
1872#[allow(clippy::derivable_impls)]
1873impl Default for Collation {
1874    fn default() -> Self {
1875        Self::Binary
1876    }
1877}
1878
1879impl Collation {
1880    /// Wire tag persisted in the FILE_VERSION 34+ catalog appendix.
1881    /// Stable: future variants append above the recognised range
1882    /// and unknown tags read back as `Binary` for forward-compat
1883    /// on rollback.
1884    pub const TAG_BINARY: u8 = 0;
1885    pub const TAG_CASE_INSENSITIVE: u8 = 1;
1886}
1887
1888/// v7.39 (RLS) — the command a policy applies to. `ALL` is the default and
1889/// covers every command; the others scope the policy to one statement kind.
1890/// Persisted as a single byte in the policy appendix (FILE_VERSION 59+).
1891#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1892pub enum PolicyCmd {
1893    All,
1894    Select,
1895    Insert,
1896    Update,
1897    Delete,
1898}
1899
1900impl PolicyCmd {
1901    /// PG `pg_policy.polcmd` single-char encoding.
1902    #[must_use]
1903    pub const fn as_pg_char(self) -> char {
1904        match self {
1905            Self::All => '*',
1906            Self::Select => 'r',
1907            Self::Insert => 'a',
1908            Self::Update => 'w',
1909            Self::Delete => 'd',
1910        }
1911    }
1912
1913    /// PG `pg_policies.cmd` word form.
1914    #[must_use]
1915    pub const fn as_pg_word(self) -> &'static str {
1916        match self {
1917            Self::All => "ALL",
1918            Self::Select => "SELECT",
1919            Self::Insert => "INSERT",
1920            Self::Update => "UPDATE",
1921            Self::Delete => "DELETE",
1922        }
1923    }
1924
1925    #[must_use]
1926    pub const fn to_wire_byte(self) -> u8 {
1927        match self {
1928            Self::All => 0,
1929            Self::Select => 1,
1930            Self::Insert => 2,
1931            Self::Update => 3,
1932            Self::Delete => 4,
1933        }
1934    }
1935
1936    #[must_use]
1937    pub const fn from_wire_byte(b: u8) -> Option<Self> {
1938        match b {
1939            0 => Some(Self::All),
1940            1 => Some(Self::Select),
1941            2 => Some(Self::Insert),
1942            3 => Some(Self::Update),
1943            4 => Some(Self::Delete),
1944            _ => None,
1945        }
1946    }
1947}
1948
1949/// v7.39 (RLS) — one `CREATE POLICY` object, stored per table. The `using_expr`
1950/// / `with_check_expr` hold the qualifying expression's `Display` form
1951/// (re-parsed and evaluated per row at enforcement time, exactly like
1952/// `TableSchema.checks`); `None` means the clause was absent. `roles` empty =
1953/// PUBLIC. Persisted in the policy appendix (FILE_VERSION 59+).
1954#[derive(Debug, Clone, PartialEq)]
1955pub struct PolicyDef {
1956    pub name: String,
1957    pub cmd: PolicyCmd,
1958    /// `true` = PERMISSIVE (default, OR-combined), `false` = RESTRICTIVE
1959    /// (AND-combined).
1960    pub permissive: bool,
1961    pub roles: Vec<String>,
1962    pub using_expr: Option<String>,
1963    pub with_check_expr: Option<String>,
1964}
1965
1966#[derive(Debug, Clone, PartialEq)]
1967pub struct TableSchema {
1968    pub name: String,
1969    pub columns: Vec<ColumnSchema>,
1970    /// v6.7.2 — per-table hot-tier byte budget override. `None`
1971    /// falls through to the global `SPG_HOT_TIER_BYTES` setting;
1972    /// `Some(n)` overrides it for this specific table. Set via
1973    /// `ALTER TABLE t SET hot_tier_bytes = X`. Persisted in
1974    /// catalog FILE_VERSION 11+.
1975    pub hot_tier_bytes: Option<u64>,
1976    /// v7.6.1 — FOREIGN KEY constraints declared on this table.
1977    /// Engine maintains this in lock-step with `spg-sql`'s parser
1978    /// AST; the storage layer carries the on-disk shape so a
1979    /// catalog snapshot round-trips without external mapping.
1980    /// Persisted in catalog FILE_VERSION 13+. Older catalogs
1981    /// deserialise with an empty vec.
1982    pub foreign_keys: Vec<ForeignKeyConstraint>,
1983    /// v7.9.19 — composite UNIQUE / PRIMARY KEY constraints
1984    /// declared at the table level. Each entry's leading column
1985    /// has a BTree index (created via the constraint), and INSERT
1986    /// path enforces the full-tuple uniqueness via a scan keyed
1987    /// by the leading column. Persisted in catalog FILE_VERSION
1988    /// 15+. Older catalogs (≤ 14) deserialise with an empty vec.
1989    pub uniqueness_constraints: Vec<UniquenessConstraint>,
1990    /// v7.39 (round 210) — `EXCLUDE` constraints declared at the table level.
1991    /// Enforced on INSERT/UPDATE by a full live-row scan re-checking each
1992    /// element's operator (no equality index can answer overlap). Persisted
1993    /// in catalog FILE_VERSION 72+; older catalogs deserialise with an empty
1994    /// vec.
1995    pub exclusion_constraints: Vec<ExclusionConstraint>,
1996    /// v7.13.0 — `CHECK (<expr>)` predicates declared on this
1997    /// table. Both column-level inline `CHECK (…)` and
1998    /// table-level `CHECK (…)` fold into this list. Each entry
1999    /// is the AST Expr's `Display` form, re-parsed on every
2000    /// INSERT/UPDATE and evaluated against the candidate row.
2001    /// A false / NULL result rejects the mutation (PG semantics).
2002    /// Persisted in catalog FILE_VERSION 23+. Older catalogs
2003    /// deserialise with an empty vec. v7.39 (read01 round 48) — each entry
2004    /// now carries the user's constraint name too (FILE_VERSION 60+).
2005    pub checks: Vec<CheckConstraint>,
2006    /// v7.37.6-B — declarative partition role(sentori Epic 2 P0).
2007    /// `None` = 普通表(后向兼容,< v49 catalog 默认 None)。
2008    /// `Some(Parent { … })` = `CREATE TABLE p (...) PARTITION BY RANGE (key_col)` 父表 —
2009    /// 父表自己 `rows` 永远空,INSERT 在引擎层路由到命中的 child。
2010    /// `Some(Range { … })` = `CREATE TABLE c PARTITION OF p FOR VALUES FROM (a) TO (b)` 范围子表。
2011    /// `Some(Default { … })` = `CREATE TABLE c PARTITION OF p DEFAULT` 兜底子表。
2012    /// 持久化于 FILE_VERSION 49+。
2013    pub partition_role: Option<PartitionRole>,
2014    /// v7.39 (RLS) — `CREATE POLICY` objects on this table, independent of the
2015    /// `row_security` flag (PG stores policies even on non-RLS tables; they
2016    /// only take effect once RLS is enabled). Persisted in the policy appendix
2017    /// (FILE_VERSION 59+). Older catalogs deserialise with an empty vec.
2018    pub policies: Vec<PolicyDef>,
2019    /// v7.39 (RLS) — `ALTER TABLE … ENABLE ROW LEVEL SECURITY`
2020    /// (PG `pg_class.relrowsecurity`). Fresh table = `false`.
2021    pub row_security: bool,
2022    /// v7.39 (RLS) — `ALTER TABLE … FORCE ROW LEVEL SECURITY`
2023    /// (PG `pg_class.relforcerowsecurity`); subjects the table owner to RLS
2024    /// too. Fresh table = `false`.
2025    pub force_row_security: bool,
2026    /// v7.39 (read01 round 57, ACL) — the role that owns this table: whoever
2027    /// ran CREATE TABLE (PG `pg_class.relowner`). The owner holds every
2028    /// privilege implicitly and is the only role that may ALTER / DROP it.
2029    /// `None` = an image written before FILE_VERSION 64, which predates roles
2030    /// entirely; those tables read back as owned by the login role.
2031    pub owner: Option<String>,
2032    /// v7.39 (read01 round 57, ACL) — explicit GRANTs on this table
2033    /// (PG `pg_class.relacl`). EMPTY means "never granted": PG leaves relacl
2034    /// NULL while only the owner's implicit privileges apply, and materialises
2035    /// the whole list — owner's default entry included — on the first GRANT.
2036    /// Once materialised it stays, even after every grant is revoked.
2037    pub acl: Vec<AclItem>,
2038}
2039
2040/// v7.39 (read01 round 57) — one PG `aclitem`: what `grantee` may do to a
2041/// table, and who granted it. Renders as `grantee=privs/grantor`, with an
2042/// EMPTY grantee meaning PUBLIC (`=r/owner`).
2043#[derive(Debug, Clone, PartialEq, Eq)]
2044pub struct AclItem {
2045    /// The role the privileges are held by. Empty string = PUBLIC.
2046    pub grantee: String,
2047    /// Bitmask over `priv_bits`: which privileges are held.
2048    pub privs: u16,
2049    /// Bitmask over `priv_bits`: which of them carry WITH GRANT OPTION
2050    /// (PG renders those with a trailing `*` — `r*`).
2051    pub grantable: u16,
2052    /// The role that ran the GRANT.
2053    pub grantor: String,
2054}
2055
2056/// v7.39 (read01 round 57) — the table-privilege bits, in PG's `aclitem`
2057/// rendering order (`arwdDxtm`). The order matters: `relacl` output is
2058/// byte-compared against PG.
2059pub mod priv_bits {
2060    pub const INSERT: u16 = 1 << 0; // a
2061    pub const SELECT: u16 = 1 << 1; // r
2062    pub const UPDATE: u16 = 1 << 2; // w
2063    pub const DELETE: u16 = 1 << 3; // d
2064    pub const TRUNCATE: u16 = 1 << 4; // D
2065    pub const REFERENCES: u16 = 1 << 5; // x
2066    pub const TRIGGER: u16 = 1 << 6; // t
2067    pub const MAINTAIN: u16 = 1 << 7; // m
2068    /// v7.39 (read01 round 60) — the non-table privileges. They share the
2069    /// bitmask because an aclitem is an aclitem whatever it hangs off; which
2070    /// bits are MEANINGFUL depends on the object (a sequence has r / w / U, a
2071    /// schema has U / C, a database has C / c / T).
2072    pub const USAGE: u16 = 1 << 8; // U
2073    pub const CREATE: u16 = 1 << 9; // C
2074    pub const CONNECT: u16 = 1 << 10; // c
2075    pub const TEMPORARY: u16 = 1 << 11; // T
2076    pub const EXECUTE: u16 = 1 << 12; // X
2077    /// Every TABLE privilege — what `GRANT ALL ON <table>` grants and what a
2078    /// table's owner holds.
2079    pub const ALL: u16 =
2080        INSERT | SELECT | UPDATE | DELETE | TRUNCATE | REFERENCES | TRIGGER | MAINTAIN;
2081    /// `GRANT ALL ON SEQUENCE` — PG renders a sequence owner's default as `rwU`.
2082    pub const ALL_SEQUENCE: u16 = SELECT | UPDATE | USAGE;
2083    /// `GRANT ALL ON SCHEMA` — `UC`.
2084    pub const ALL_SCHEMA: u16 = USAGE | CREATE;
2085    /// `GRANT ALL ON DATABASE` — `CTc`.
2086    pub const ALL_DATABASE: u16 = CREATE | CONNECT | TEMPORARY;
2087    /// `GRANT ALL ON FUNCTION` — just `X`.
2088    pub const ALL_FUNCTION: u16 = EXECUTE;
2089}
2090
2091/// v7.37.6-B — partition 三态(parent / range child / default child)。
2092#[derive(Debug, Clone, PartialEq, Eq)]
2093pub enum PartitionRole {
2094    Parent {
2095        kind: PartitionKind,
2096        /// 父表 columns 中 key 列的下标(单列 v7.37.6-B,
2097        /// `Vec` 为将来扩多列预留)。
2098        key_column_positions: Vec<usize>,
2099        /// `CREATE INDEX ON parent (…)` 的 Display-form 源串。
2100        /// child 创建时再 parse + 在 child 上 execute,这样 future
2101        /// child 也自动继承父表索引。fan-out 实施在引擎层。
2102        index_template_sources: Vec<String>,
2103    },
2104    Range {
2105        parent_name: String,
2106        /// 半开区间下界(`>=`,SQL `FROM (lower)`).
2107        lower: PartitionBound,
2108        /// 半开区间上界(`<`,SQL `TO (upper)`).
2109        upper: PartitionBound,
2110    },
2111    /// v7.37.16 (16.1) — LIST child:行属于本 child iff key ∈ values。
2112    /// `values` 在 child 创建时从 SQL `FOR VALUES IN (lit, …)` 求值;
2113    /// 跟 PG 一样,显式 NULL ∈ values 由 caller 单独处理(不在
2114    /// PartitionBound 内表达 NULL)。
2115    List {
2116        parent_name: String,
2117        values: Vec<PartitionBound>,
2118    },
2119    /// v7.39 (round 645) — PG 表继承的 CHILD:`CREATE TABLE c (…)
2120    /// INHERITS (p1, p2)`。跟分区 child 的三个本质区别(实测 PG18):
2121    ///   * 父表**自己有行**(分区父表永远空),所以父表的联合体要含自身;
2122    ///   * `INSERT INTO 父表` **不路由**到 child(分区会路由);
2123    ///   * `DROP TABLE 父表` 不带 CASCADE **报错**(分区父表连子表一起删)。
2124    /// 多父继承合法,故 `parent_names` 是 Vec;`pg_inherits.inhseqno`
2125    /// 正是父表在这个列表里的位置(1-based)。
2126    Inherits {
2127        parent_names: Vec<String>,
2128    },
2129    /// v7.37.16 (16.2) — HASH child:行属于本 child iff
2130    /// `pg_compatible_hash(key) mod modulus == remainder`。
2131    /// PG 强制 `0 ≤ remainder < modulus`;parser/DDL 层先 gate。
2132    Hash {
2133        parent_name: String,
2134        modulus: u32,
2135        remainder: u32,
2136    },
2137    Default {
2138        parent_name: String,
2139    },
2140}
2141
2142/// v7.37.6-B — 分区策略。
2143///
2144/// - `Range`:半开区间 `[lower, upper)`(v7.37.6-B 初始)
2145/// - `List` (v7.37.16):枚举集合 — 行属于 partition iff key ∈ children list
2146/// - `Hash` (v7.37.16):`hash(key) mod modulus == remainder`
2147#[derive(Debug, Clone, Copy, PartialEq, Eq)]
2148pub enum PartitionKind {
2149    Range,
2150    List,
2151    Hash,
2152}
2153
2154/// v7.37.6-B — partition 边界 literal。
2155///
2156/// v7.37.6-B 仅 `TimestampTz`(i64 microseconds since epoch);
2157/// v7.37.16 (16.6) 加全 PG 内建可比类型,匹配 `Value` 的对应 variant
2158/// 以避免 LIST membership 比较时的类型转换。
2159///
2160/// `MinValue` / `MaxValue` 对应 SQL `MINVALUE` / `MAXVALUE`,仅
2161/// Range 策略有意义(LIST 无 minvalue/maxvalue 概念,HASH 不
2162/// 使用 PartitionBound)。
2163#[derive(Debug, Clone, PartialEq, Eq)]
2164pub enum PartitionBound {
2165    MinValue,
2166    MaxValue,
2167    TimestampTz(i64),
2168    /// v7.37.16 (16.6) — BIGINT partition key.
2169    BigInt(i64),
2170    /// v7.37.16 (16.6) — INTEGER partition key (also covers
2171    /// `SERIAL` since SPG decomposes it to INTEGER + sequence).
2172    Int(i32),
2173    /// v7.37.16 (16.6) — SMALLINT partition key.
2174    SmallInt(i16),
2175    /// v7.37.16 (16.6) — DATE partition key. Stored as days
2176    /// since the Unix epoch (matches `Value::Date`).
2177    Date(i32),
2178    /// v7.37.16 (16.6) — TEXT / VARCHAR partition key.
2179    Text(alloc::string::String),
2180}
2181
2182impl PartitionBound {
2183    /// v7.37.16 (16.6) — true iff this bound's underlying value
2184    /// equals `other`'s. Used for LIST partition membership
2185    /// checks. Returns false for `MinValue` / `MaxValue`
2186    /// (sentinels — never literal equality).
2187    #[must_use]
2188    pub fn equals_value(&self, other: &Value<'_>) -> bool {
2189        match (self, other) {
2190            (PartitionBound::TimestampTz(a), Value::Timestamp(b)) => a == b,
2191            (PartitionBound::BigInt(a), Value::BigInt(b)) => a == b,
2192            (PartitionBound::Int(a), Value::Int(b)) => a == b,
2193            (PartitionBound::SmallInt(a), Value::SmallInt(b)) => a == b,
2194            (PartitionBound::Date(a), Value::Date(b)) => a == b,
2195            (PartitionBound::Text(a), Value::Text(b)) => a.as_str() == b.as_ref(),
2196            _ => false,
2197        }
2198    }
2199}
2200
2201/// v7.9.19 — composite UNIQUE / PRIMARY KEY constraint persisted
2202/// on the table schema. The leading column always has a BTree
2203/// index (created at CREATE TABLE time); INSERT enforcement
2204/// scans that index for collisions on the full column tuple.
2205/// v7.39 (read01 round 48) — a `CHECK` constraint: the SQL name the user
2206/// gave it (via `ADD CONSTRAINT <name> CHECK (...)` or the inline
2207/// `CONSTRAINT <name> CHECK (...)` form) plus the predicate source. `None`
2208/// name = unnamed, in which case `pg_constraint` synthesises PG's
2209/// `<table>_<col>_check` form. Names are persisted in the constraint-name
2210/// appendix (FILE_VERSION 60+); older catalogs deserialise with `None`.
2211#[derive(Debug, Clone, PartialEq, Eq)]
2212pub struct CheckConstraint {
2213    pub name: Option<String>,
2214    /// The AST Expr's `Display` form, re-parsed on every INSERT/UPDATE.
2215    pub expr: String,
2216    /// v7.39 (round 652) — `false` for a constraint added `NOT VALID`: the
2217    /// rows already in the table were never scanned against it, and
2218    /// `pg_constraint.convalidated` says so. It does NOT weaken the check on
2219    /// new rows — INSERT and UPDATE enforce it either way, as in PG.
2220    /// `VALIDATE CONSTRAINT` does the deferred scan and flips it. Persisted
2221    /// by the FILE_VERSION 87 appendix; older catalogs deserialise as `true`,
2222    /// which is what every constraint they could hold actually was.
2223    pub validated: bool,
2224}
2225
2226#[derive(Debug, Clone, PartialEq, Eq)]
2227pub struct UniquenessConstraint {
2228    /// `true` when this constraint was declared as `PRIMARY KEY`
2229    /// (vs `UNIQUE`). Semantically PK implies NOT NULL on all
2230    /// referenced columns; the engine enforces that at CREATE
2231    /// TABLE time.
2232    pub is_primary_key: bool,
2233    /// Column positions on the parent table. ≥ 1 element. For
2234    /// single-column UNIQUE this is exactly one position; the
2235    /// BTree index alone enforces it.
2236    pub columns: Vec<usize>,
2237    /// v7.13.0 — `UNIQUE NULLS NOT DISTINCT` modifier
2238    /// (mailrs round-5 G10; PG 15+ surface). When `true`, two
2239    /// rows whose constrained columns are all NULL collide on
2240    /// the constraint. Default (`false`) is the SQL-standard
2241    /// `NULLS DISTINCT` behaviour where any NULL passes.
2242    /// Persisted in catalog FILE_VERSION 23+.
2243    pub nulls_not_distinct: bool,
2244    /// v7.39 (read01 round 48) — the constraint's SQL name when the user
2245    /// supplied one (`ADD CONSTRAINT <name> PRIMARY KEY/UNIQUE (...)`, or
2246    /// the inline `CONSTRAINT <name>` form). `None` = unnamed, in which
2247    /// case `pg_constraint` synthesises PG's `<table>_pkey` /
2248    /// `<table>_<col>_key` form. DROP CONSTRAINT resolves the stored name
2249    /// first and falls back to the synthesised one, so catalogs written
2250    /// before this field (< FILE_VERSION 60) keep working unchanged.
2251    pub name: Option<String>,
2252    /// v7.39 (round 711) — `[NOT] DEFERRABLE`. Round 621 taught the parser
2253    /// to CONSUME the clause on PK/UNIQUE (the FK path had stored it since
2254    /// round 288); this is the storing half. Persisted in the v89 timing
2255    /// appendix.
2256    pub deferrable: bool,
2257    /// `INITIALLY DEFERRED`: the check belongs to COMMIT, not the
2258    /// statement, unless `SET CONSTRAINTS … IMMEDIATE` pulls it in.
2259    pub initially_deferred: bool,
2260}
2261
2262/// v7.39 (round 210) — an `EXCLUDE` constraint. Forbids two distinct live
2263/// rows from satisfying, for EVERY element, `new.col <op> existing.col`
2264/// (e.g. `EXCLUDE USING gist (during WITH &&)` = no two `during` ranges
2265/// overlap). Unlike a uniqueness constraint the operator is not equality,
2266/// so enforcement is a full live-row scan re-checking the operator (a real
2267/// GiST index that answers overlap in O(log n) is a later perf phase). A
2268/// NULL in any element column exempts the row (matching PG / UNIQUE NULL
2269/// semantics). Persisted in catalog FILE_VERSION 72+.
2270#[derive(Debug, Clone, PartialEq, Eq)]
2271pub struct ExclusionConstraint {
2272    /// The constraint's SQL name. PG auto-names an unnamed EXCLUDE
2273    /// `<table>_<leading-col>_excl`; the engine synthesises that at CREATE
2274    /// TABLE time so this is always populated.
2275    pub name: String,
2276    /// Access method spelled after `USING` (`gist`, `spgist`, …), lower-cased.
2277    /// `None` = no `USING` clause. Purely cosmetic for enforcement; it round-
2278    /// trips into `pg_get_constraintdef`.
2279    pub method: Option<String>,
2280    /// One `(column-position, operator-spelling)` pair per element, in
2281    /// declaration order. The operator spelling is the wire token (`&&`,
2282    /// `=`, `@>`, `<@`, `&<`, `&>`) evaluated against each existing row.
2283    pub elements: Vec<(usize, String)>,
2284}
2285
2286/// v7.6.1 — Storage-layer mirror of `spg_sql::ast::ForeignKeyConstraint`.
2287/// The engine's CREATE TABLE path translates between the two; keeping
2288/// them separate preserves the no-deps boundary between
2289/// `spg-storage` and `spg-sql`.
2290#[derive(Debug, Clone, PartialEq, Eq)]
2291pub struct ForeignKeyConstraint {
2292    /// Optional user-supplied constraint name (`CONSTRAINT <name>`
2293    /// prefix). Used by `ALTER TABLE DROP CONSTRAINT <name>` in
2294    /// v7.6.8; ignored by enforcement.
2295    pub name: Option<String>,
2296    /// Positions of local columns in this table's column list.
2297    /// Same arity as `parent_columns`.
2298    pub local_columns: Vec<usize>,
2299    /// Referenced parent table name.
2300    pub parent_table: String,
2301    /// Positions of parent columns in the parent's column list.
2302    /// Engine resolves these at CREATE TABLE time (after the parent
2303    /// schema is known) so enforcement paths can skip the name
2304    /// lookup on every row.
2305    pub parent_columns: Vec<usize>,
2306    /// Referential action when a parent row is deleted.
2307    pub on_delete: FkAction,
2308    /// Referential action when a parent row's referenced columns
2309    /// are updated.
2310    pub on_update: FkAction,
2311    /// v7.38 (read01, T29) — `MATCH SIMPLE | FULL`. Defaults to `Simple`.
2312    pub match_type: MatchType,
2313    /// v7.39 (round 288) — `[NOT] DEFERRABLE`.
2314    pub deferrable: bool,
2315    /// `INITIALLY DEFERRED`: the check runs at COMMIT rather than at
2316    /// the statement, unless `SET CONSTRAINTS … IMMEDIATE` pulls it in.
2317    pub initially_deferred: bool,
2318}
2319
2320/// v7.38 (read01, T29) — FK MATCH type. Mirrors `spg_sql::ast::MatchType`.
2321#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
2322pub enum MatchType {
2323    #[default]
2324    Simple,
2325    Full,
2326}
2327
2328impl MatchType {
2329    /// On-disk tag byte (catalog appendix, `FILE_VERSION` 55+).
2330    pub const fn tag(self) -> u8 {
2331        match self {
2332            Self::Simple => 0,
2333            Self::Full => 1,
2334        }
2335    }
2336    pub const fn from_tag(b: u8) -> Option<Self> {
2337        Some(match b {
2338            0 => Self::Simple,
2339            1 => Self::Full,
2340            _ => return None,
2341        })
2342    }
2343}
2344
2345/// v7.6.1 — referential action tag. Mirrors `spg_sql::ast::FkAction`.
2346#[derive(Debug, Clone, Copy, PartialEq, Eq)]
2347pub enum FkAction {
2348    Restrict,
2349    Cascade,
2350    SetNull,
2351    SetDefault,
2352    NoAction,
2353}
2354
2355impl FkAction {
2356    /// On-disk tag byte (v13 catalog appendix).
2357    pub const fn tag(self) -> u8 {
2358        match self {
2359            Self::Restrict => 0,
2360            Self::Cascade => 1,
2361            Self::SetNull => 2,
2362            Self::SetDefault => 3,
2363            Self::NoAction => 4,
2364        }
2365    }
2366    pub const fn from_tag(b: u8) -> Option<Self> {
2367        Some(match b {
2368            0 => Self::Restrict,
2369            1 => Self::Cascade,
2370            2 => Self::SetNull,
2371            3 => Self::SetDefault,
2372            4 => Self::NoAction,
2373            _ => return None,
2374        })
2375    }
2376}
2377
2378impl TableSchema {
2379    pub fn column_position(&self, name: &str) -> Option<usize> {
2380        self.columns.iter().position(|c| c.name == name)
2381    }
2382}
2383
2384/// Key type accepted by secondary indices. Float / NULL / Vector values
2385/// can't participate in a B-tree index — `f64` is only `PartialOrd`, NULL
2386/// has SQL-three-valued semantics, and Vector belongs to the (future) HNSW
2387/// path. Index lookups on those columns fall back to full scan.
2388#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
2389pub enum IndexKey {
2390    Int(i64),
2391    Text(String),
2392    Bool(bool),
2393    /// v7.17.0 — `Value::Uuid` index key. Comparison is byte-wise
2394    /// (RFC 4122 byte order) so PRIMARY KEY UUID lookups land on
2395    /// the same fast-path as Int / Text.
2396    Uuid([u8; 16]),
2397    /// r1039 — `Value::Bytes` (bytea). PG orders bytea by plain byte
2398    /// comparison, shorter-prefix first (`'' < \x00 < \x0000 < \x01ff <
2399    /// \xff`, measured on 18.4), which is exactly `Vec<u8>`'s `Ord`.
2400    Bytes(Vec<u8>),
2401    /// r1039 — exact decimal, in the canonical form described on
2402    /// [`NumericKey`].
2403    ///
2404    /// r1040 — BOXED, and the box is load-bearing for every OTHER index.
2405    /// A `NumericKey` is 48 bytes against `Text(String)`'s 24, so inline
2406    /// it set the size of the whole enum and every B-tree node in every
2407    /// index grew with it: 32 bytes per key to 48, align 8 to 16.
2408    /// Measured through the release sweep, `SELECT pad FROM t ORDER BY
2409    /// id` over 400,000 rows — a walk of the primary key's index — went
2410    /// 39.4-40.6 ms to 42.3-44.1, in both leg orders. The indirection is
2411    /// charged to numeric keys, which are new, instead of to every index
2412    /// that existed already.
2413    Numeric(alloc::boxed::Box<NumericKey>),
2414    /// v7.38.1 (L12) — a NULL component INSIDE a composite key, and
2415    /// nothing else. `IndexKey::from_value(Value::Null)` still returns
2416    /// `None`, so single-column B-trees never hold one, and no probe
2417    /// path ever BUILDS one (`col = NULL` is not a match in SQL) — the
2418    /// variant is only reachable through a composite key's component
2419    /// list, where it exists so that a row like `(2, 3, NULL)` stays
2420    /// findable by a PREFIX probe on `(w, d)`. Declared last: slice
2421    /// `Ord` then sorts NULL components after every value, PG's
2422    /// NULLS LAST.
2423    Null,
2424}
2425
2426/// r1039 — an exact-decimal index key, canonical so that representation
2427/// equality IS value equality.
2428///
2429/// That property is the whole reason this is a struct rather than the
2430/// `(scaled, scale)` pair the value carries. `1.5` and `1.50` are the
2431/// same NUMERIC (PG18.4: `1.5::numeric = 1.50::numeric` is true) and
2432/// arrive here as `(15, 1)` and `(150, 2)`. A B-tree keyed on the raw
2433/// pair would file them apart, so `WHERE n = 1.5` would miss a row stored
2434/// as `1.50` — an index changing the answer, which is the one thing an
2435/// index may never do. `BigNumeric::cmp` carries the same warning and
2436/// declines to implement `Ord` for exactly this reason; a KEY cannot
2437/// decline, so it normalizes instead.
2438///
2439/// Canonical form: significant decimal digits with no leading and no
2440/// trailing zeros, most significant first, plus the decimal exponent of
2441/// the leading digit. Zero is the empty digit vector with `neg == false`
2442/// and `exp == 0`, so there is no `-0`.
2443///
2444/// Ordering is PG's, measured: `-Infinity < -1 < 0 < 1 < Infinity < NaN`,
2445/// and `NaN = NaN`.
2446#[derive(Debug, Clone, PartialEq, Eq)]
2447pub struct NumericKey {
2448    /// 0 = -Infinity, 1 = finite, 2 = +Infinity, 3 = NaN. Ordering the
2449    /// classes by this byte is what puts NaN on top, where PG keeps it.
2450    class: u8,
2451    /// Finite only, and never set for zero.
2452    neg: bool,
2453    /// Decimal exponent of the leading significant digit; 0 for zero.
2454    exp: i32,
2455    /// r1040 — the first [`HEAD_DIGITS`] significant digits, LEFT-ALIGNED
2456    /// (multiplied up so the leading digit always sits at 10^36). That
2457    /// alignment is what makes an integer comparison of two heads the same
2458    /// answer as a digit-by-digit one: `12` and `1` become 1.2e36 and
2459    /// 1.0e36, which order the way the digit strings do, where the bare
2460    /// integers 12 and 1 would not.
2461    ///
2462    /// Zero for the value zero and for every special.
2463    ///
2464    /// This started as a `Vec<u8>` of digits, which is correct and cost
2465    /// an allocation per key and a slice comparison per sort comparison.
2466    /// `ORDER BY <numeric>` builds one key per row and compares n log n
2467    /// times: 200,000 rows measured 65.4 ms against 39.6 for the f64
2468    /// projection that had been returning rows in the wrong order.
2469    head: u128,
2470    /// Significant digits past the 37th, one per byte, no trailing zeros.
2471    /// Empty for everything an `i128` mantissa can hold with room to
2472    /// spare — and an empty `Vec` does not allocate, which is the point.
2473    tail: Vec<u8>,
2474}
2475
2476/// Significant digits carried in [`NumericKey::head`]. 37 is the most
2477/// that can be left-aligned inside a `u128`: the largest such value is
2478/// 9.99…e36, and `u128::MAX` is 3.4e38.
2479const HEAD_DIGITS: u32 = 37;
2480/// `10^36` — where a left-aligned leading digit sits.
2481const HEAD_SCALE: u128 = 1_000_000_000_000_000_000_000_000_000_000_000_000;
2482
2483/// The `class` byte of [`NumericKey`], in PG's order.
2484const NUM_CLASS_NEG_INF: u8 = 0;
2485const NUM_CLASS_FINITE: u8 = 1;
2486const NUM_CLASS_POS_INF: u8 = 2;
2487const NUM_CLASS_NAN: u8 = 3;
2488
2489impl NumericKey {
2490    /// The key for a `Value::Numeric`'s three fields.
2491    ///
2492    /// Public because the ORDER BY key wants the same canonical form the
2493    /// index key uses: two sort keys that disagree about which of two
2494    /// NUMERICs is larger is the same class of defect as an index that
2495    /// disagrees with a scan, and one definition is how they stay honest.
2496    #[must_use]
2497    pub fn from_numeric(scaled: i128, scale: u16, kind: NumericKind) -> Self {
2498        match kind {
2499            NumericKind::Finite => {
2500                let mut buf = [0u8; 40];
2501                let n = digits_of_u128(scaled.unsigned_abs(), &mut buf);
2502                Self::finite(scaled < 0, &buf[..n], i32::from(scale))
2503            }
2504            NumericKind::NaN => Self::special(NUM_CLASS_NAN),
2505            NumericKind::PosInf => Self::special(NUM_CLASS_POS_INF),
2506            NumericKind::NegInf => Self::special(NUM_CLASS_NEG_INF),
2507        }
2508    }
2509
2510    /// The key for an exact integer — no scale, so no rounding.
2511    #[must_use]
2512    pub fn from_i128(n: i128) -> Self {
2513        let mut buf = [0u8; 40];
2514        let len = digits_of_u128(n.unsigned_abs(), &mut buf);
2515        Self::finite(n < 0, &buf[..len], 0)
2516    }
2517
2518    /// The key for a mantissa that overflowed `i128`. The two
2519    /// representations of one value land on one key.
2520    #[must_use]
2521    pub fn from_big(b: &crate::bignum::BigNumeric) -> Self {
2522        let (neg, limbs, scale) = b.parts();
2523        Self::finite(neg, &digits_of_limbs(limbs), i32::from(scale))
2524    }
2525
2526    /// The `f64` this key means, for the one comparison PG defines that
2527    /// way: `numeric` against `float8` demotes the numeric.
2528    ///
2529    /// Lossy by construction — that is the point, and it is why nothing
2530    /// else uses it.
2531    #[must_use]
2532    #[allow(clippy::cast_precision_loss)]
2533    pub fn to_f64(&self) -> f64 {
2534        match self.class {
2535            NUM_CLASS_NAN => return f64::NAN,
2536            NUM_CLASS_POS_INF => return f64::INFINITY,
2537            NUM_CLASS_NEG_INF => return f64::NEG_INFINITY,
2538            _ => {}
2539        }
2540        if self.head == 0 {
2541            return 0.0;
2542        }
2543        // `head` is `d.ddd… × 10^36`; the value is that leading digit and
2544        // its followers at `exp`. The tail is below f64's resolution by
2545        // construction (it starts at the 38th significant digit).
2546        let mantissa = self.head as f64 / HEAD_SCALE as f64;
2547        let out = mantissa * pow10_f64(self.exp);
2548        if self.neg { -out } else { out }
2549    }
2550
2551    /// The significant decimal digits, most significant first — the form
2552    /// the catalog codec writes, and the one `from_parts` reads back.
2553    #[must_use]
2554    pub fn digits(&self) -> Vec<u8> {
2555        let mut out = Vec::new();
2556        if self.head != 0 {
2557            let mut h = self.head;
2558            for _ in 0..HEAD_DIGITS {
2559                let d = u8::try_from(h / HEAD_SCALE).unwrap_or(0);
2560                out.push(d);
2561                h = (h % HEAD_SCALE) * 10;
2562            }
2563            while out.last() == Some(&0) {
2564                out.pop();
2565            }
2566        }
2567        out.extend_from_slice(&self.tail);
2568        out
2569    }
2570
2571    /// The wire parts, for the catalog codec.
2572    #[must_use]
2573    pub fn parts(&self) -> (u8, bool, i32) {
2574        (self.class, self.neg, self.exp)
2575    }
2576
2577    /// Rebuild from the wire parts. Returns `None` on parts that are not
2578    /// canonical, so a corrupt catalog cannot smuggle in a key whose `Eq`
2579    /// and `Ord` disagree.
2580    #[must_use]
2581    pub fn from_parts(class: u8, neg: bool, exp: i32, digits: &[u8]) -> Option<Self> {
2582        if class > NUM_CLASS_NAN || digits.iter().any(|d| *d > 9) {
2583            return None;
2584        }
2585        if class != NUM_CLASS_FINITE && (neg || exp != 0 || !digits.is_empty()) {
2586            return None;
2587        }
2588        if digits.is_empty() {
2589            if neg || exp != 0 {
2590                return None;
2591            }
2592            return Some(Self::special(class));
2593        }
2594        if digits[0] == 0 || digits[digits.len() - 1] == 0 {
2595            return None;
2596        }
2597        Some(Self {
2598            class,
2599            neg,
2600            exp,
2601            head: head_of(digits),
2602            tail: digits.iter().skip(HEAD_DIGITS as usize).copied().collect(),
2603        })
2604    }
2605
2606    /// Canonicalize `(-1)^neg · <digits as an integer> · 10^-scale`.
2607    ///
2608    /// `digits` is most-significant-first and may carry leading and
2609    /// trailing zeros; both are stripped, which is what makes `1.5` and
2610    /// `1.50` land on the same key.
2611    fn finite(neg: bool, digits: &[u8], scale: i32) -> Self {
2612        let lead = digits.iter().position(|d| *d != 0).unwrap_or(digits.len());
2613        let digits = &digits[lead..];
2614        if digits.is_empty() {
2615            return Self::special(NUM_CLASS_FINITE);
2616        }
2617        // The leading digit's exponent, taken BEFORE trailing zeros go:
2618        // dropping low-order digits does not move the leading one.
2619        let exp = i32::try_from(digits.len()).unwrap_or(i32::MAX) - 1 - scale;
2620        let mut end = digits.len();
2621        while end > 0 && digits[end - 1] == 0 {
2622            end -= 1;
2623        }
2624        let digits = &digits[..end];
2625        Self {
2626            class: NUM_CLASS_FINITE,
2627            neg,
2628            exp,
2629            head: head_of(digits),
2630            tail: digits.iter().skip(HEAD_DIGITS as usize).copied().collect(),
2631        }
2632    }
2633
2634    fn special(class: u8) -> Self {
2635        Self {
2636            class,
2637            neg: false,
2638            exp: 0,
2639            head: 0,
2640            tail: Vec::new(),
2641        }
2642    }
2643}
2644
2645/// The first [`HEAD_DIGITS`] of `digits`, left-aligned so the leading one
2646/// sits at `10^36`.
2647fn head_of(digits: &[u8]) -> u128 {
2648    let mut head: u128 = 0;
2649    let take = (HEAD_DIGITS as usize).min(digits.len());
2650    for d in &digits[..take] {
2651        head = head * 10 + u128::from(*d);
2652    }
2653    for _ in take..HEAD_DIGITS as usize {
2654        head *= 10;
2655    }
2656    head
2657}
2658
2659/// Decimal digits of `mag` into `buf`, most significant first; returns how
2660/// many were written. Zero writes none.
2661///
2662/// r1040 — split at `u64` on purpose. A `u128` divide is a called routine,
2663/// not an instruction, and this loop runs once per digit per key.
2664fn digits_of_u128(mag: u128, buf: &mut [u8; 40]) -> usize {
2665    if mag == 0 {
2666        return 0;
2667    }
2668    let mut rev = [0u8; 40];
2669    let mut n = 0usize;
2670    let mut big = mag;
2671    // Peel nineteen digits at a time — the most a `u64` holds — so the
2672    // wide divide runs at most twice.
2673    while big > u128::from(u64::MAX) {
2674        let mut chunk = u64::try_from(big % 10_000_000_000_000_000_000_u128).unwrap_or(0);
2675        big /= 10_000_000_000_000_000_000_u128;
2676        for _ in 0..19 {
2677            rev[n] = u8::try_from(chunk % 10).unwrap_or(0);
2678            chunk /= 10;
2679            n += 1;
2680        }
2681    }
2682    let mut small = u64::try_from(big).unwrap_or(0);
2683    while small > 0 {
2684        rev[n] = u8::try_from(small % 10).unwrap_or(0);
2685        small /= 10;
2686        n += 1;
2687    }
2688    for i in 0..n {
2689        buf[i] = rev[n - 1 - i];
2690    }
2691    n
2692}
2693
2694/// Decimal digits of a base-10^9 little-endian limb vector, most
2695/// significant first. Every limb but the leading one is padded to its
2696/// full nine digits — that padding is the whole point, since a limb of 5
2697/// in the middle of a number means `000000005`.
2698fn digits_of_limbs(limbs: &[u32]) -> Vec<u8> {
2699    let mut out = Vec::new();
2700    let mut buf = [0u8; 40];
2701    for (i, limb) in limbs.iter().enumerate().rev() {
2702        let n = digits_of_u128(u128::from(*limb), &mut buf);
2703        if i + 1 == limbs.len() {
2704            out.extend_from_slice(&buf[..n]);
2705        } else {
2706            out.extend(core::iter::repeat_n(0u8, 9 - n));
2707            out.extend_from_slice(&buf[..n]);
2708        }
2709    }
2710    out
2711}
2712
2713/// `10^e` as an `f64`, for any `e` a canonical key can carry.
2714#[allow(clippy::cast_precision_loss)]
2715fn pow10_f64(e: i32) -> f64 {
2716    let mut out = 1.0_f64;
2717    let mag = e.unsigned_abs();
2718    for _ in 0..mag {
2719        out *= 10.0;
2720    }
2721    if e < 0 { 1.0 / out } else { out }
2722}
2723
2724impl Ord for NumericKey {
2725    fn cmp(&self, other: &Self) -> core::cmp::Ordering {
2726        use core::cmp::Ordering;
2727        if self.class != other.class {
2728            return self.class.cmp(&other.class);
2729        }
2730        if self.class != NUM_CLASS_FINITE {
2731            // Each of the three specials is a single value, and PG holds
2732            // `'NaN'::numeric = 'NaN'::numeric` true.
2733            return Ordering::Equal;
2734        }
2735        // Zero first: it is stored with `neg == false` and `exp == 0`, so
2736        // the magnitude comparison below would put it above every value
2737        // smaller than 1 rather than between the negatives and positives.
2738        match (self.head == 0, other.head == 0) {
2739            (true, true) => return Ordering::Equal,
2740            (true, false) => {
2741                return if other.neg {
2742                    Ordering::Greater
2743                } else {
2744                    Ordering::Less
2745                };
2746            }
2747            (false, true) => {
2748                return if self.neg {
2749                    Ordering::Less
2750                } else {
2751                    Ordering::Greater
2752                };
2753            }
2754            (false, false) => {}
2755        }
2756        match (self.neg, other.neg) {
2757            (false, true) => return Ordering::Greater,
2758            (true, false) => return Ordering::Less,
2759            _ => {}
2760        }
2761        // Same sign, both non-zero: more integer digits is bigger, and at
2762        // equal exponent the left-aligned heads compare as one integer —
2763        // the alignment is what makes that the same answer as comparing
2764        // the digit strings. The tail only speaks when the first 37
2765        // significant digits are identical.
2766        let mag = self
2767            .exp
2768            .cmp(&other.exp)
2769            .then_with(|| self.head.cmp(&other.head))
2770            .then_with(|| self.tail.cmp(&other.tail));
2771        if self.neg { mag.reverse() } else { mag }
2772    }
2773}
2774
2775impl PartialOrd for NumericKey {
2776    fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
2777        Some(self.cmp(other))
2778    }
2779}
2780
2781impl IndexKey {
2782    /// v7.37.43 (INSUBQ B-4) — inline-friendly BigInt fast path.
2783    /// `try_count_star_pk_in_subquery_fast` (and any other hot loop
2784    /// probing an integer PK) already holds an `i64`; this builds the
2785    /// `IndexKey` without going through the generic `from_value`
2786    /// dispatch tree.
2787    #[inline]
2788    pub fn from_i64(n: i64) -> Self {
2789        Self::Int(n)
2790    }
2791
2792    /// r1039 — the key a value takes when the INDEXED COLUMN is `ty`, or
2793    /// `None` when it takes none (→ the caller falls back to a scan).
2794    ///
2795    /// Every key under one index comes from one column, so they all live
2796    /// in one key SPACE. A probe built in a different space finds nothing
2797    /// — and "nothing" is indistinguishable from "no matching rows",
2798    /// which is how round 564 and r1037 both turned an index into a wrong
2799    /// answer (a TEXT key sought against a DATE-keyed and a UUID-keyed
2800    /// index).
2801    ///
2802    /// The two spaces this round adds make that trap reachable again from
2803    /// a new direction: `WHERE n = 2` on a NUMERIC column produces
2804    /// `Value::Int`, and an integer key would look in a space nothing
2805    /// lives in. So NUMERIC columns take integers by converting them
2806    /// exactly, and refuse anything they cannot convert; BYTEA columns
2807    /// take only `Value::Bytes`; and no other column may be keyed in
2808    /// either of the two new spaces.
2809    ///
2810    /// Use this wherever the key comes from a LITERAL or from another
2811    /// table's value. [`IndexKey::from_value`] stays right for building
2812    /// the index itself, where the value is the column's own.
2813    pub fn from_value_for_column(v: &Value<'_>, ty: DataType) -> Option<Self> {
2814        match ty {
2815            DataType::Numeric { .. } => match v {
2816                Value::SmallInt(n) => Some(Self::exact_int_key(i128::from(*n))),
2817                Value::Int(n) => Some(Self::exact_int_key(i128::from(*n))),
2818                Value::BigInt(n) => Some(Self::exact_int_key(i128::from(*n))),
2819                Value::Numeric { .. } | Value::NumericBig(_) => Self::from_value(v),
2820                // Float included: `2.0::float8` and `2.0::numeric` are not
2821                // the same value to a B-tree, and rounding one into the
2822                // other's space is how a seek reaches the wrong row.
2823                _ => None,
2824            },
2825            DataType::Bytes => match v {
2826                Value::Bytes(b) => Some(Self::Bytes(b.to_vec())),
2827                _ => None,
2828            },
2829            _ => match Self::from_value(v) {
2830                Some(Self::Numeric(_) | Self::Bytes(_)) => None,
2831                other => other,
2832            },
2833        }
2834    }
2835
2836    /// An integer as a NUMERIC key. Exact by construction — no scale, no
2837    /// rounding — which is why the conversion is allowed at all.
2838    fn exact_int_key(n: i128) -> Self {
2839        Self::Numeric(alloc::boxed::Box::new(NumericKey::from_i128(n)))
2840    }
2841
2842    pub fn from_value(v: &Value<'_>) -> Option<Self> {
2843        match v {
2844            // v7.37.43 (INSUBQ B-4) — BigInt hits first (the dominant
2845            // INSUBQ shape probes PK as BigInt). Tiny micro-win.
2846            Value::BigInt(n) => Some(Self::Int(*n)),
2847            Value::SmallInt(n) => Some(Self::Int(i64::from(*n))),
2848            Value::Int(n) => Some(Self::Int(i64::from(*n))),
2849            Value::Text(s) => Some(Self::Text(s.clone().into_owned())),
2850            // v7.38 (read01, T11) — bpchar keys compare blank-insensitively.
2851            Value::BpChar(s) => Some(Self::Text(s.trim_end_matches(' ').to_string())),
2852            Value::Bool(b) => Some(Self::Bool(*b)),
2853            // Date/Timestamp use their integer storage repr as the
2854            // index key — same order semantics, same comparison.
2855            Value::Date(d) => Some(Self::Int(i64::from(*d))),
2856            Value::Timestamp(t) => Some(Self::Int(*t)),
2857            // v7.17.0: UUID indexable via byte-wise ordering. Lookup
2858            // on `id = '...'::uuid` resolves through the secondary
2859            // index rather than full-scan.
2860            Value::Uuid(b) => Some(Self::Uuid(*b)),
2861            // v7.17.0 Phase 3.P0-32: TIME indexable via i64 — same
2862            // order semantics as Date/Timestamp.
2863            Value::Time(us) => Some(Self::Int(*us)),
2864            // v7.17.0 Phase 3.P0-33: YEAR indexable as i64 — u16
2865            // widens losslessly and gives the natural calendar
2866            // ordering.
2867            Value::Year(y) => Some(Self::Int(i64::from(*y))),
2868            // v7.17.0 Phase 3.P0-34: TIMETZ indexable by its
2869            // UTC-equivalent microseconds (local wall - offset).
2870            // Without normalising, two values for the same
2871            // physical instant in different zones would sort
2872            // wrong. Matches PG's TIMETZ index behaviour.
2873            Value::TimeTz { us, offset_secs } => {
2874                Some(Self::Int(us - i64::from(*offset_secs) * 1_000_000))
2875            }
2876            // v7.17.0 Phase 3.P0-35: MONEY indexable as i64 cents
2877            // (no scaling needed — natural numeric ordering).
2878            Value::Money(c) => Some(Self::Int(*c)),
2879            // v7.17.0 Phase 3.P0-38: ranges are NOT indexable in
2880            // v7.17.0 — they'd need a custom comparator (PG uses
2881            // SP-GiST for this). Skip.
2882            Value::Range { .. } => None,
2883            // v7.17.0 Phase 3.P0-39: hstore is NOT indexable in
2884            // v7.17.0 — map columns need GIN with bespoke ops.
2885            Value::Hstore(_) => None,
2886            // r1039 — exact decimals index through the canonical
2887            // [`NumericKey`], which is what makes `1.5` and `1.50` one key.
2888            Value::NumericBig(b) => Some(Self::Numeric(alloc::boxed::Box::new(NumericKey::from_big(b)))),
2889            Value::Numeric {
2890                scaled,
2891                scale,
2892                kind,
2893            } => Some(Self::Numeric(alloc::boxed::Box::new(
2894                NumericKey::from_numeric(*scaled, *scale, *kind),
2895            ))),
2896            // r1039 — bytea orders by plain byte comparison, which is
2897            // `Vec<u8>`'s own.
2898            Value::Bytes(b) => Some(Self::Bytes(b.to_vec())),
2899            // v7.17.0 Phase 3.P0-40: 2D arrays aren't indexable.
2900            Value::IntArray2D(_)
2901            | Value::BigIntArray2D(_)
2902            | Value::TextArray2D(_)
2903            | Value::BoolArray2D(_) => None,
2904            // v7.37.5 β-P4: INTERVAL[] isn't indexable (PG uses
2905            // GIN/intarray for array-contains queries; SPG plans
2906            // that as a separate axis under v7.37.8 GIN-on-jsonb).
2907            Value::IntervalArray(_) => None,
2908            // v7.37.5 γ — none of the array-of-scalar family is
2909            // B-tree indexable. Same reason as IntervalArray: PG
2910            // serves array-contains / array-overlap queries via
2911            // GIN, and SPG's GIN axis lands in v7.37.8.
2912            Value::BoolArray(_)
2913            | Value::SmallIntArray(_)
2914            | Value::FloatArray(_)
2915            | Value::NumericArray(_)
2916            | Value::DateArray(_)
2917            | Value::TimestampArray(_)
2918            | Value::TimestamptzArray(_)
2919            | Value::UuidArray(_)
2920            | Value::JsonArray(_)
2921            | Value::JsonbArray(_)
2922            | Value::BytesArray(_)
2923            | Value::VarcharArray(_)
2924            | Value::CharArray(_)
2925            // v7.37.5 δ — multirange not indexable (PG uses GiST/
2926            // SP-GiST + a custom operator class; SPG plans the same
2927            // axis under v7.37.8 with ranges).
2928            | Value::Multirange { .. }
2929            // v7.37.5 ε — geometric scalars not B-tree indexable
2930            // (PG uses GiST/SP-GiST for these too; SPG plans the
2931            // same axis under v7.37.8).
2932            | Value::Point(_)
2933            | Value::Lseg(_, _)
2934            | Value::Path { .. }
2935            | Value::PgBox(_, _)
2936            | Value::Polygon(_)
2937            | Value::Line { .. }
2938            | Value::Circle { .. }
2939            // v7.37.5 ζ-A — network / bit / xml / "char" / money[].
2940            // INET / CIDR / MACADDR / MACADDR8 could be B-tree
2941            // indexable (PG does this), but the byte-wise compare
2942            // family-blind would mis-order IPv4 vs IPv6; left as
2943            // a follow-up under v7.37.8 GIN window.
2944            | Value::Inet { .. }
2945            | Value::Cidr { .. }
2946            | Value::Macaddr(_)
2947            | Value::Macaddr8(_)
2948            | Value::PgLsn(_)
2949            | Value::BitString { .. }
2950            | Value::Xml(_)
2951            | Value::Char1(_)
2952            | Value::MoneyArray(_)
2953            | Value::Composite(_)
2954            | Value::Tid(..)
2955            | Value::Xid(_)
2956            | Value::Cid(_)
2957            | Value::RegClass(..)
2958            | Value::RegProc(..)
2959            | Value::RegType(..) => None,
2960            // Interval isn't index-eligible (and can't reach this path
2961            // through column storage anyway). Float / Real stay out
2962            // because `f64` is only `PartialOrd`.
2963            Value::Null
2964            | Value::Float(_)
2965            | Value::Vector(_)
2966            | Value::Sq8Vector(_)
2967            | Value::HalfVector(_)
2968            | Value::Interval { .. }
2969            | Value::Json(_)
2970            | Value::TextArray(_)
2971            | Value::IntArray(_)
2972            | Value::BigIntArray(_)
2973            | Value::TsVector(_)
2974            | Value::TsQuery(_)
2975            | Value::Real(_) => None,
2976        }
2977    }
2978}
2979
2980/// A single-column secondary index. v2.0 carries either a B-tree map
2981/// (the default — used for equality / range lookups on scalar columns)
2982/// or a navigable-small-world graph (used for kNN over vector
2983/// columns).
2984#[derive(Debug, Clone)]
2985pub struct Index {
2986    pub name: String,
2987    pub column_position: usize,
2988    pub kind: IndexKind,
2989    /// v6.8.0 — column positions of `INCLUDE (col1, col2, …)`
2990    /// non-key columns. Carries the planner's "this query is
2991    /// covered by the index" signal; lookup paths still resolve
2992    /// via the `RowLocator` to fetch the row body, but EXPLAIN
2993    /// surfaces the covered-scan annotation so operators can
2994    /// confirm the planner sees the coverage.
2995    ///
2996    /// Empty `Vec` = no `INCLUDE` clause (the legacy shape). v12
2997    /// catalog snapshots deserialise with an empty vec.
2998    pub included_columns: Vec<usize>,
2999    /// v6.8.1 — partial-index predicate stored as its canonical
3000    /// Display form (the engine re-parses it on the maintenance
3001    /// path). `None` = unconditional index (the legacy shape).
3002    /// Persisted as `[u8 has_pred][u16 LE len][bytes]` on the
3003    /// catalog snapshot (FILE_VERSION 12, appended after
3004    /// `included_columns`).
3005    pub partial_predicate: Option<String>,
3006    /// v6.8.2 — expression-index key, stored as the expression's
3007    /// canonical Display form. `None` = bare column-reference
3008    /// index (the legacy shape). Persisted alongside
3009    /// `partial_predicate` on the v12 catalog snapshot.
3010    pub expression: Option<String>,
3011    /// v7.39 (read01 round 52) — `CREATE UNIQUE INDEX … NULLS NOT DISTINCT`
3012    /// (PG 15+): a NULL in the key no longer exempts the row, so two
3013    /// all-NULL keys collide. Default `false` = SQL-standard NULLS DISTINCT.
3014    /// Persisted in the index appendix (FILE_VERSION 62+); older catalogs
3015    /// deserialise with `false`.
3016    pub nulls_not_distinct: bool,
3017    /// v7.39 (round 537) — the key column's ordering clause, as written.
3018    ///
3019    /// SPG's index does not scan in a direction, so this changes no
3020    /// lookup; `pg_indexes.indexdef` is a reproduction of the DDL and
3021    /// dropping the clause made `CREATE INDEX i ON t (a DESC NULLS
3022    /// LAST)` read back as `(a)` — a dump lost it and a schema diff saw
3023    /// drift every run. `nulls_first` is `None` when the statement did
3024    /// not say, in which case PG's default applies and neither word is
3025    /// rendered.
3026    pub descending: bool,
3027    pub nulls_first: Option<bool>,
3028    /// v7.39 (round 538) — an explicit `COLLATE` on the key, as written.
3029    /// SPG orders text by bytes, so it changes no comparison; PG prints
3030    /// it because a named collation and an inherited one are different
3031    /// objects even where they sort identically.
3032    pub collation: Option<String>,
3033    /// v7.9.29 — `CREATE UNIQUE INDEX …`. When true the engine
3034    /// rejects INSERTs whose key already appears in this index
3035    /// (combined with `partial_predicate` when present — only
3036    /// rows matching the predicate enter the uniqueness check).
3037    /// Catalog FILE_VERSION 16+; older snapshots deserialise
3038    /// with `false`. mailrs K1.
3039    pub is_unique: bool,
3040    /// v7.9.29 — extra (non-leading) column positions for
3041    /// multi-column indexes (`CREATE INDEX … (a, b, c)`). The
3042    /// planner today still only uses the leading
3043    /// `column_position` for index seeks, but UNIQUE INDEX
3044    /// enforcement walks the full tuple so partial-unique
3045    /// invariants like CalDAV `(calendar_id, uid,
3046    /// recurrence_id)` are enforced correctly. Catalog
3047    /// FILE_VERSION 16+; older snapshots deserialise empty.
3048    pub extra_column_positions: Vec<usize>,
3049}
3050
3051/// Default neighbor degree (M) for the NSW graph. Picked at construction
3052/// time and persisted with the index.
3053pub const NSW_DEFAULT_M: usize = 16;
3054
3055/// v5.2.2: outcome of a successful [`Catalog::freeze_oldest_to_cold`]
3056/// call. The catalog state has already been mutated by the time this
3057/// is returned (hot rows dropped + segment registered + Cold locators
3058/// flipped). The caller's only remaining concern is `segment_bytes` —
3059/// persist them to disk under `<db>.spg/segments/seg_<id>.spg` so a
3060/// future restart can reload via the v5.1 `SPG_PRELOAD_COLD_SEGMENT`
3061/// path. (v5.3's manifest will subsume this manual step.)
3062#[derive(Debug, Clone)]
3063pub struct FreezeReport {
3064    /// Id allocated by [`Catalog::load_segment_bytes`] for the new
3065    /// cold-tier segment. Stable across the call's success path.
3066    pub segment_id: u32,
3067    /// Number of rows that moved hot → cold. Equals the `max_rows`
3068    /// the caller asked for (the API is strict on the count).
3069    pub frozen_rows: usize,
3070    /// Hot-tier bytes reclaimed by the freeze — the
3071    /// [`Table::hot_bytes`] delta before vs after. Useful to feed
3072    /// back into the freezer's budget check on the next tick.
3073    pub bytes_freed: u64,
3074    /// Encoded segment bytes, byte-identical to what
3075    /// [`encode_segment`] produced. The catalog already owns a
3076    /// copy inside `cold_segments`; this hand-off lets the caller
3077    /// persist them without re-encoding.
3078    pub segment_bytes: Vec<u8>,
3079}
3080
3081/// v6.7.4 — read-only output of [`Catalog::prepare_freeze_slice`].
3082/// Carries every row body + key in a contiguous hot-row range,
3083/// already encoded and sorted by PK so the coordinator's merge
3084/// step is a k-way merge over already-sorted streams.
3085///
3086/// `Vec<FreezeSlice>` from N independent workers feeds
3087/// [`Catalog::commit_freeze_slices`], which concats + encodes the
3088/// merged segment + atomically swaps the catalog state.
3089#[derive(Debug, Clone)]
3090pub struct FreezeSlice {
3091    /// Hot-row index range this slice covered (half-open, in the
3092    /// table's `rows: PersistentVec` ordering at call time). The
3093    /// commit step uses this to compute the union range that
3094    /// gets passed to [`Table::delete_rows`].
3095    pub row_range: core::ops::Range<usize>,
3096    /// `(pk_u64, encoded_row_body, IndexKey)` triples, sorted
3097    /// ascending by `pk_u64`. Per-slice sort happens inside
3098    /// `prepare_freeze_slice`; the coordinator does only a
3099    /// k-way merge to reach the global PK ordering
3100    /// [`encode_segment`] requires.
3101    pub rows: Vec<(u64, Vec<u8>, IndexKey)>,
3102}
3103
3104/// v6.7.3 — outcome of a [`Catalog::compact_cold_segments`] call.
3105/// The catalog state has already been mutated when this is returned:
3106/// the merged segment is loaded into `cold_segments`, the source
3107/// segment slots are tombstoned (`None`), and every BTree-index
3108/// `RowLocator::Cold` that previously pointed at a source now
3109/// points at the merged segment. The caller's remaining job is to
3110/// persist `merged_segment_bytes` under
3111/// `<db>.spg/segments/seg_<merged_segment_id>.spg` and update the
3112/// in-memory `segment_id → path` map (remove the source ids, add
3113/// the merged id) so the next CHECKPOINT writes a manifest that
3114/// no longer lists the retired sources.
3115///
3116/// On a no-op (fewer than 2 candidate segments under the threshold),
3117/// `merged_segment_id` is `None` and `sources` is empty; the
3118/// catalog was not mutated.
3119#[derive(Debug, Clone)]
3120pub struct CompactReport {
3121    /// Source segment ids that were merged + tombstoned.
3122    pub sources: Vec<u32>,
3123    /// Id allocated for the merged segment. `None` on no-op.
3124    pub merged_segment_id: Option<u32>,
3125    /// Encoded merged-segment bytes (empty on no-op).
3126    pub merged_segment_bytes: Vec<u8>,
3127    /// Number of rows that landed in the merged segment.
3128    pub merged_rows: usize,
3129    /// `Σ source.num_rows − merged_rows`. Rows present in source
3130    /// segment payloads but unreferenced by any live BTree
3131    /// `Cold` locator — DELETE'd-but-still-frozen rows that
3132    /// compaction GC'd during the merge.
3133    pub deleted_rows_pruned: usize,
3134    /// `Σ source.bytes() − merged.bytes()`. Estimate of on-disk
3135    /// space the merge will reclaim once the source segment files
3136    /// are GC'd. Saturating subtract — never negative.
3137    pub bytes_reclaimed_estimate: u64,
3138}
3139
3140#[derive(Debug, Clone)]
3141pub enum IndexKind {
3142    /// v4.40: structural-sharing B-tree over `IndexKey`. Replaces the v0.8
3143    /// `BTreeMap<IndexKey, Vec<usize>>` — `Index::clone` is now an `Arc`
3144    /// bump regardless of index size, so `Catalog::clone` inside the
3145    /// v4.34 auto-commit wrap stays O(1) even for tables with secondary
3146    /// indices (the case that bottlenecked v4.39 at 1M rows in the
3147    /// sweep).
3148    ///
3149    /// v5.1: value type widened from `Vec<usize>` to `Vec<RowLocator>` so
3150    /// a single key can point to a mix of hot-tier rows (`RowLocator::Hot`,
3151    /// equivalent to the pre-v5 `usize` row index) and cold-tier rows
3152    /// (`RowLocator::Cold { segment_id, page_offset }`) once the v5.2
3153    /// freezer starts producing them. Pre-v5.2 only `Hot` entries appear
3154    /// — the on-disk encoding stays at `FILE_VERSION` 8 (raw u64 row index)
3155    /// because every locator round-trips through `RowLocator::from_legacy_v8_u64`
3156    /// without information loss. `FILE_VERSION` 9 with tagged encoding lands
3157    /// alongside the first freezer commit (v5.1 step 2b / v5.2).
3158    BTree(PersistentBTreeMap<IndexKey, crate::posting::PostingList>),
3159    /// Navigable-small-world graph for vector kNN search.
3160    Nsw(NswGraph),
3161    /// v6.7.1 — BRIN (Block Range INdex). Pure metadata: BRIN
3162    /// indexes carry NO in-memory key→locator map. The (min,
3163    /// max) summaries live in each cold-tier segment's v2
3164    /// envelope sidecar; the BRIN entry in `Table.indices` only
3165    /// records THAT a BRIN index exists on this column so the
3166    /// segment encoder + planner can opt into the summary path.
3167    Brin {
3168        /// The cell type at `column_position` at CREATE INDEX time.
3169        /// Used by the planner to type-check WHERE-clause range
3170        /// predicates against the BRIN-indexed column.
3171        column_type: DataType,
3172        /// v7.38.11 — one `(min, max)` per [`BRIN_RANGE_ROWS`] slots of
3173        /// the hot tier, so a range predicate can skip the ranges that
3174        /// cannot contain a match.
3175        ///
3176        /// Maintenance is WIDEN-ONLY and that is the whole safety
3177        /// argument: an insert widens its range, an update widens, and
3178        /// a delete leaves the range alone. A range left wider than the
3179        /// rows it now covers is correct and merely less selective —
3180        /// which is exactly PG's contract for a lossy index, since the
3181        /// predicate is re-checked on every row the summary lets
3182        /// through. A summary may over-report; it can never
3183        /// under-report, so no matching row can be skipped.
3184        ///
3185        /// `None` for a range whose rows carry no comparable key (all
3186        /// NULL, say), and such a range is never skipped.
3187        summaries: alloc::vec::Vec<Option<(i64, i64)>>,
3188    },
3189    /// v7.12.3 — GIN inverted index over a `tsvector` column.
3190    ///
3191    /// Storage shape: `lexeme word → Vec<RowLocator>`. The posting
3192    /// list per word is appended in row-order, so range scans are
3193    /// O(matching rows) once the per-word lookup is done. Multi-
3194    /// term queries intersect / union posting lists.
3195    ///
3196    /// `IndexKey::from_value(TsVector)` returns `None` — GIN doesn't
3197    /// participate in `try_index_seek` (which is BTree-equality-keyed).
3198    /// The engine consults this index through `try_gin_lookup` on
3199    /// `WHERE col @@ tsquery` predicates instead.
3200    ///
3201    /// Backed by a `PersistentBTreeMap` so `Catalog::clone` (the
3202    /// per-write snapshot) stays O(1) — same structural-sharing
3203    /// invariant as BTree.
3204    Gin(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3205    /// v7.15.0 — `USING gin (col gin_trgm_ops)` over a `TEXT`
3206    /// column. Posting lists map `trigram` (PG-compatible 3-byte
3207    /// shingle on the lower-cased + space-padded input) to row
3208    /// locators. The planner uses this index to accelerate
3209    /// `WHERE col LIKE '…'` / `ILIKE '…'` / `similarity(col, q) >
3210    /// t` — every literal run of length ≥ 1 in the pattern
3211    /// produces a trigram set, the engine intersects the posting
3212    /// lists, and the LIKE / similarity predicate is re-evaluated
3213    /// per candidate row to filter the over-approximation.
3214    /// Persisted via tag-4 index payload in `FILE_VERSION` 24+.
3215    GinTrgm(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3216    /// v7.17.0 Phase 2.2 — MySQL `FULLTEXT KEY (col)` over a
3217    /// `TEXT` / `VARCHAR` column. Posting lists map
3218    /// `tsvector('simple') lexeme` to row locators. At insert /
3219    /// build time the engine derives the lexemes from the cell
3220    /// via the same lower-case tokenisation rule as
3221    /// `to_tsvector('simple', ...)` — the column itself stays a
3222    /// plain text type on disk (mysqldump round-trips would be
3223    /// broken otherwise). The planner uses this index to
3224    /// accelerate MySQL-shape `MATCH(col) AGAINST('term')`
3225    /// queries by mapping them onto the existing tsquery `@@`
3226    /// walker. Persisted via tag-5 index payload in
3227    /// `FILE_VERSION` 33+.
3228    GinFulltext(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3229    /// v7.37.8(sentori Epic 5 P2)— `USING gin (col)` over a
3230    /// `JSON` / `JSONB` column. Posting lists map a canonical
3231    /// `(path, leaf)` token(see [`crate::jsonb_gin::extract_tokens`])
3232    /// to row locators so the planner can resolve
3233    /// `<col> @> <jsonb_literal>` to a candidate row set via
3234    /// posting-list intersection + per-row `json::contains`
3235    /// re-verification. Pre-7.37.8 the same DDL loaded as a
3236    /// BTree fallback so `pg_dump` JSONB-GIN scripts kept loading
3237    /// without query-time acceleration. Persisted via tag-6 index
3238    /// payload in `FILE_VERSION` 51+.
3239    GinJsonb(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3240    /// v7.38.1 (L12) — a REAL multi-column B-tree: the key is the whole
3241    /// column tuple, `[leading, extras…]`, ordered lexicographically by
3242    /// slice `Ord`. That ordering is the entire design: every key
3243    /// sharing a prefix is contiguous, so an equality on a PREFIX of
3244    /// the columns is one `O(log N)` descent plus a bounded walk, and a
3245    /// full-tuple equality is a point `get`. The single-column `BTree`
3246    /// kind used to stand in for multi-column DDL by keying on the
3247    /// leading column only and carrying the rest as metadata — TPC-C's
3248    /// `customer (c_w_id, c_d_id, c_last, c_first)` then answered a
3249    /// three-column equality with every row of one warehouse and a
3250    /// per-row filter over 30 000 candidates.
3251    ///
3252    /// Rows where any component column is NULL (or of an unkeyable
3253    /// type) are NOT entered: this index serves `=` probes, and in SQL
3254    /// `col = v` never selects a NULL. Uniqueness keeps its own
3255    /// full-tuple walk with NULLS-DISTINCT semantics on the
3256    /// enforcement path, exactly as before.
3257    ///
3258    /// Persisted via tag-7 index payload in `FILE_VERSION` 91+.
3259    BTreeMulti(PersistentBTreeMap<alloc::boxed::Box<[IndexKey]>, crate::posting::PostingList>),
3260}
3261
3262impl IndexKind {
3263    /// v7.31 (memory campaign, C2) — bytes this index variant holds
3264    /// resident in RAM, computed by walking its OWN structure rather
3265    /// than a parametric guess made by the engine. Replaces the old
3266    /// `spg_admin::memory_stats` inline match, which charged NSW with
3267    /// a stale `m_max_0 * 8` per node (neighbour slots are `u32` = 4 B
3268    /// since v6.1.x, and most nodes never fill `m_max_0`) and lumped
3269    /// every GIN family index into a flat 1 KiB token — a gross
3270    /// undercount for the text-heavy posting lists that dominate
3271    /// mailrs' footprint. Per-entry container overhead uses the
3272    /// 3-word (24 B on 64-bit) `Vec`/`String` header as the charge.
3273    ///
3274    /// O(index entries): operator/monitoring surface (`memory_stats` /
3275    /// `spg_memory_stats`), not a query path.
3276    #[must_use]
3277    pub fn approx_resident_bytes(&self) -> u64 {
3278        const HEADER: usize = 24; // Vec/String 3-word header on 64-bit.
3279        let loc = core::mem::size_of::<RowLocator>();
3280        match self {
3281            IndexKind::BTree(map) => {
3282                let key = core::mem::size_of::<IndexKey>();
3283                map.iter()
3284                    .map(|(_, locs)| (key + HEADER + locs.len() * loc) as u64)
3285                    .sum()
3286            }
3287            // v7.38.1 (L12) — multi keys own a boxed slice of components.
3288            IndexKind::BTreeMulti(map) => {
3289                let key = core::mem::size_of::<IndexKey>();
3290                map.iter()
3291                    .map(|(k, locs)| (HEADER + k.len() * key + HEADER + locs.len() * loc) as u64)
3292                    .sum()
3293            }
3294            IndexKind::Nsw(g) => {
3295                // `levels` is one byte per node; each layer's adjacency
3296                // is a `Vec<u32>` per node whose actual length we walk
3297                // (the dense layer-0 list dominates, but upper layers
3298                // are sparse — the old estimate ignored that).
3299                let mut b = g.levels.len() as u64;
3300                for layer in &g.layers {
3301                    for nbrs in layer.iter() {
3302                        b += (HEADER + nbrs.len() * core::mem::size_of::<u32>()) as u64;
3303                    }
3304                }
3305                b
3306            }
3307            // BRIN carries NO in-memory key→locator map (the (min,max)
3308            // summaries live in cold-segment sidecars on disk); the
3309            // resident footprint is just the column-type token.
3310            IndexKind::Brin { .. } => core::mem::size_of::<DataType>() as u64,
3311            IndexKind::Gin(map)
3312            | IndexKind::GinTrgm(map)
3313            | IndexKind::GinFulltext(map)
3314            | IndexKind::GinJsonb(map) => map
3315                .iter()
3316                .map(|(word, postings)| {
3317                    (word.len() + HEADER + HEADER + postings.len() * loc) as u64
3318                })
3319                .sum(),
3320        }
3321    }
3322}
3323
3324/// Multi-layer HNSW graph (v2.13). Each node is assigned a `top_level`;
3325/// it appears in layers `0..=top_level`. Higher layers are sparser, so
3326/// search starts from the entry at the top layer, greedy-descends to
3327/// layer 0, and beam-searches there. Layer 0 keeps a larger neighbour
3328/// budget (`m_max_0 = 2 * m` per the HNSW paper); upper layers cap at
3329/// `m`. The struct name stays `NswGraph` so external users / on-disk
3330/// callers don't have to track a rename — the algorithm changed, the
3331/// data slot didn't.
3332#[derive(Debug, Clone)]
3333pub struct NswGraph {
3334    /// Max neighbours per node on layers ≥ 1.
3335    pub m: usize,
3336    /// Max neighbours on layer 0 (the dense bottom layer). HNSW
3337    /// convention: `m_max_0 = 2 * m`.
3338    pub m_max_0: usize,
3339    /// Entry point — the node that sits on the topmost layer. Search
3340    /// always starts here.
3341    pub entry: Option<usize>,
3342    /// Top layer of the entry node (== `layers.len() - 1` when populated).
3343    pub entry_level: u8,
3344    /// `levels[i]` = top layer of node `i`. Nodes whose vector cell is
3345    /// NULL / non-Vector have `levels[i] = 0` and no neighbour entries.
3346    ///
3347    /// v5.5.0: backed by `PersistentVec` so `NswGraph::clone` (and the
3348    /// `Catalog::clone` on every group-commit write that contains it) is O(1)
3349    /// structural-sharing instead of an O(N) element copy.
3350    pub levels: PersistentVec<u8>,
3351    /// `layers[l][i]` = neighbours of node `i` at layer `l`. Inner vec
3352    /// is empty when node `i` doesn't reach layer `l`.
3353    ///
3354    /// v5.5.0: the per-node middle dimension (the O(N) one) is a
3355    /// `PersistentVec`; the outer layer dimension stays a plain `Vec`
3356    /// (layer count ≤ 8, so its clone is O(1) in practice) and the inner
3357    /// neighbour list stays a `Vec` (bounded by `m_max_0`).
3358    ///
3359    /// v6.1.x: neighbour slot widened from `usize` (8 B on 64-bit) to
3360    /// `u32` (4 B). Row indices are catalog-bounded by `u32::MAX` (4G
3361    /// rows per table); the cast at the NSW boundary asserts this. At
3362    /// 1M dim-128 SQ8, layer 0 adjacency alone shrinks by ~128 MiB
3363    /// — the largest single contribution to the v6.0.5-measured
3364    /// 624 MiB ambition gap. On-disk format already used u32 LE, so
3365    /// this is a pure in-memory layout change; no `FILE_VERSION` bump.
3366    pub layers: Vec<PersistentVec<Vec<u32>>>,
3367}
3368
3369impl NswGraph {
3370    fn new(m: usize) -> Self {
3371        Self {
3372            m,
3373            m_max_0: m.saturating_mul(2),
3374            entry: None,
3375            entry_level: 0,
3376            levels: PersistentVec::new(),
3377            layers: alloc::vec![PersistentVec::new()],
3378        }
3379    }
3380
3381    /// Max-neighbour budget for layer `l`.
3382    pub const fn cap_for_layer(&self, layer: u8) -> usize {
3383        if layer == 0 { self.m_max_0 } else { self.m }
3384    }
3385}
3386
3387/// Deterministic level assignment, seeded on the row index so the same
3388/// insert order reproduces the same topology. Distribution is roughly
3389/// HNSW-flavoured with `mL ≈ 1/ln(M) ≈ 0.36` for M=16: each 4-bit
3390/// chunk that comes up zero promotes the node one layer (so P(level ≥
3391/// L) ≈ (1/16)^L).
3392#[allow(clippy::verbose_bit_mask)] // clippy suggests trailing_zeros(); we need an explicit MAX cap and a stable distribution shape.
3393pub fn nsw_assign_level(row_idx: usize) -> u8 {
3394    const MAX_LEVEL: u8 = 7; // 7 ⇒ ~16^7 ≈ 2.7e8 expected nodes between promotions; ample.
3395    // SplitMix-style mixer — cheap and seedable.
3396    let mut x = (row_idx as u64).wrapping_mul(0x9E37_79B9_7F4A_7C15);
3397    x ^= x >> 30;
3398    x = x.wrapping_mul(0xBF58_476D_1CE4_E5B9);
3399    x ^= x >> 27;
3400    x = x.wrapping_mul(0x94D0_49BB_1331_11EB);
3401    x ^= x >> 31;
3402    // Count contiguous low-end zero nibbles (4-bit chunks). Each zero
3403    // nibble has probability 1/16, mirroring HNSW's `mL ≈ 1/ln(M)` for
3404    // M=16. `trailing_zeros / 4` would lose the ordering when x = 0, so
3405    // a plain loop with a cap is clearer.
3406    let mut level: u8 = 0;
3407    while x & 0xF == 0 && level < MAX_LEVEL {
3408        level += 1;
3409        x >>= 4;
3410    }
3411    level
3412}
3413
3414/// v7.38.1 (L12) — the composite key `values` takes in a multi-column
3415/// B-tree over `[lead, extras…]`. A NULL component keys as
3416/// [`IndexKey::Null`] (declared to sort last, PG's NULLS LAST) so the
3417/// row stays findable by prefix probes on the columns before it. `None`
3418/// = some non-null component has no key form; the row is then not
3419/// entered, which is why creation gates every component column's type
3420/// through [`multi_component_type_ok`].
3421pub(crate) fn compose_multi_key(
3422    values: &[Value<'_>],
3423    lead: usize,
3424    extras: &[usize],
3425) -> Option<alloc::boxed::Box<[IndexKey]>> {
3426    let mut comps: Vec<IndexKey> = Vec::with_capacity(1 + extras.len());
3427    for pos in core::iter::once(lead).chain(extras.iter().copied()) {
3428        let v = values.get(pos)?;
3429        if matches!(v, Value::Null) {
3430            comps.push(IndexKey::Null);
3431        } else {
3432            comps.push(IndexKey::from_value(v)?);
3433        }
3434    }
3435    Some(comps.into_boxed_slice())
3436}
3437
3438/// v7.38.1 (L12) — component-type gate for multi-column B-trees: every
3439/// NON-NULL value of these types keys through `IndexKey::from_value`,
3440/// so a row can only be absent from the index when creation raced a
3441/// type this list does not name. Deliberately conservative — a type
3442/// outside the list simply keeps its index on the leading-column path.
3443pub(crate) fn multi_component_type_ok(ty: DataType) -> bool {
3444    matches!(
3445        ty,
3446        DataType::SmallInt
3447            | DataType::Int
3448            | DataType::BigInt
3449            | DataType::Text
3450            | DataType::Varchar(_)
3451            | DataType::Char(_)
3452            | DataType::Bool
3453            | DataType::Uuid
3454            | DataType::Date
3455            | DataType::Timestamp
3456    )
3457}
3458
3459impl Index {
3460    /// Any key this B-tree currently holds, or `None` if it holds none.
3461    ///
3462    /// A probe built from a query literal has to be the same SHAPE as the
3463    /// keys the maintenance side made, or `lookup_eq` misses every row and
3464    /// the caller reads the empty answer as "no rows match". One stored
3465    /// key settles it: an index keys one expression, whose values are one
3466    /// type.
3467    pub fn sample_key(&self) -> Option<&IndexKey> {
3468        match &self.kind {
3469            IndexKind::BTree(map) => map.iter().next().map(|(k, _)| k),
3470            _ => None,
3471        }
3472    }
3473
3474    fn new_btree(name: String, column_position: usize) -> Self {
3475        Self {
3476            name,
3477            column_position,
3478            kind: IndexKind::BTree(PersistentBTreeMap::new()),
3479            included_columns: Vec::new(),
3480            partial_predicate: None,
3481            expression: None,
3482            is_unique: false,
3483            nulls_not_distinct: false,
3484            descending: false,
3485            nulls_first: None,
3486            collation: None,
3487            extra_column_positions: Vec::new(),
3488        }
3489    }
3490
3491    /// v7.38.1 (L12) — a real multi-column B-tree shell. The caller
3492    /// sets `extra_column_positions` before the first row enters; the
3493    /// key arity is `1 + extras` from then on.
3494    fn new_btree_multi(name: String, column_position: usize) -> Self {
3495        Self {
3496            kind: IndexKind::BTreeMulti(PersistentBTreeMap::new()),
3497            ..Self::new_btree(name, column_position)
3498        }
3499    }
3500
3501    /// v7.38.1 (L12) — the composite key this row takes in a
3502    /// [`IndexKind::BTreeMulti`] index. NULL components key as
3503    /// [`IndexKey::Null`] so prefix probes still find the row; `None`
3504    /// only when a non-null component produces no key, which creation's
3505    /// component-type gate makes unreachable for well-formed indexes.
3506    pub fn multi_key_for_row(&self, values: &[Value<'_>]) -> Option<alloc::boxed::Box<[IndexKey]>> {
3507        compose_multi_key(values, self.column_position, &self.extra_column_positions)
3508    }
3509
3510    fn new_nsw(name: String, column_position: usize, m: usize) -> Self {
3511        Self {
3512            name,
3513            column_position,
3514            kind: IndexKind::Nsw(NswGraph::new(m)),
3515            included_columns: Vec::new(),
3516            partial_predicate: None,
3517            expression: None,
3518            is_unique: false,
3519            nulls_not_distinct: false,
3520            descending: false,
3521            nulls_first: None,
3522            collation: None,
3523            extra_column_positions: Vec::new(),
3524        }
3525    }
3526
3527    /// v6.7.1 — BRIN index constructor. BRIN carries no in-memory
3528    /// data; the `column_type` snapshot is used by the segment
3529    /// encoder + planner for type-checking range predicates.
3530    fn new_brin(name: String, column_position: usize, column_type: DataType) -> Self {
3531        Self {
3532            name,
3533            column_position,
3534            kind: IndexKind::Brin {
3535                column_type,
3536                summaries: alloc::vec::Vec::new(),
3537            },
3538            included_columns: Vec::new(),
3539            partial_predicate: None,
3540            expression: None,
3541            is_unique: false,
3542            nulls_not_distinct: false,
3543            descending: false,
3544            nulls_first: None,
3545            collation: None,
3546            extra_column_positions: Vec::new(),
3547        }
3548    }
3549
3550    /// v7.12.3 — GIN inverted-index constructor. Empty posting-list
3551    /// map; caller (typically [`Table::add_gin_index`] or
3552    /// [`Table::restore_gin_index`]) populates it from existing rows
3553    /// or from a deserialised snapshot.
3554    fn new_gin(name: String, column_position: usize) -> Self {
3555        Self {
3556            name,
3557            column_position,
3558            kind: IndexKind::Gin(PersistentBTreeMap::new()),
3559            included_columns: Vec::new(),
3560            partial_predicate: None,
3561            expression: None,
3562            is_unique: false,
3563            nulls_not_distinct: false,
3564            descending: false,
3565            nulls_first: None,
3566            collation: None,
3567            extra_column_positions: Vec::new(),
3568        }
3569    }
3570
3571    /// v7.15.0 — `gin_trgm_ops`-flavoured GIN constructor. Same
3572    /// shape as `new_gin` but the posting-list keys are 3-byte
3573    /// trigram shingles (`pg_trgm`-compatible) and the column
3574    /// type is `TEXT` / `VARCHAR` (not `TSVECTOR`).
3575    fn new_gin_trgm(name: String, column_position: usize) -> Self {
3576        Self {
3577            name,
3578            column_position,
3579            kind: IndexKind::GinTrgm(PersistentBTreeMap::new()),
3580            included_columns: Vec::new(),
3581            partial_predicate: None,
3582            expression: None,
3583            is_unique: false,
3584            nulls_not_distinct: false,
3585            descending: false,
3586            nulls_first: None,
3587            collation: None,
3588            extra_column_positions: Vec::new(),
3589        }
3590    }
3591
3592    /// v7.17.0 Phase 2.2 — MySQL `FULLTEXT KEY` GIN constructor.
3593    /// Same shape as `new_gin_trgm` but the posting-list keys
3594    /// are lower-cased word lexemes (`to_tsvector('simple', col)`
3595    /// equivalent) instead of trigrams, and the column type is
3596    /// `TEXT` / `VARCHAR` (not `TSVECTOR`).
3597    fn new_gin_fulltext(name: String, column_position: usize) -> Self {
3598        Self {
3599            name,
3600            column_position,
3601            kind: IndexKind::GinFulltext(PersistentBTreeMap::new()),
3602            included_columns: Vec::new(),
3603            partial_predicate: None,
3604            expression: None,
3605            is_unique: false,
3606            nulls_not_distinct: false,
3607            descending: false,
3608            nulls_first: None,
3609            collation: None,
3610            extra_column_positions: Vec::new(),
3611        }
3612    }
3613
3614    /// v7.37.8(sentori Epic 5 P2)— JSONB-GIN constructor. Same
3615    /// shape as the other GIN-family indexes; posting-list keys
3616    /// are the canonical `(path, leaf)` tokens emitted by
3617    /// `crate::jsonb_gin::extract_tokens`. Maintains posting
3618    /// lists from `Value::Json` cells(JSONB is a synonym for the
3619    /// same in-memory string-backed Value).
3620    fn new_gin_jsonb(name: String, column_position: usize) -> Self {
3621        Self {
3622            name,
3623            column_position,
3624            kind: IndexKind::GinJsonb(PersistentBTreeMap::new()),
3625            included_columns: Vec::new(),
3626            partial_predicate: None,
3627            expression: None,
3628            is_unique: false,
3629            nulls_not_distinct: false,
3630            descending: false,
3631            nulls_first: None,
3632            collation: None,
3633            extra_column_positions: Vec::new(),
3634        }
3635    }
3636
3637    /// v7.34.4 — descending-order iterator over `(IndexKey, locators)`
3638    /// pairs for a BTree index, with O(log N) descent to the rightmost
3639    /// leaf and lazy emission thereafter. Returns an empty iterator
3640    /// for non-BTree index kinds — callers handle both uniformly.
3641    /// Used by the ORDER BY `<indexed col>` DESC + LIMIT N executor
3642    /// path: walking only the first N matches off the rightmost leaf
3643    /// avoids the per-row materialisation + partial-sort cost on
3644    /// large tables (mailrs `content_worker` at 250 k rows).
3645    pub fn iter_desc(
3646        &self,
3647    ) -> alloc::boxed::Box<dyn Iterator<Item = (&IndexKey, &crate::posting::PostingList)> + '_>
3648    {
3649        match &self.kind {
3650            IndexKind::BTree(m) => alloc::boxed::Box::new(m.iter_rev()),
3651            // v7.38.1 (L12) — projecting the leading component of a
3652            // composite key preserves order: keys sort by the whole
3653            // tuple, so the leading component is non-increasing here
3654            // (non-decreasing in iter_asc), exactly what an ORDER BY
3655            // on the leading column needs.
3656            IndexKind::BTreeMulti(m) => {
3657                alloc::boxed::Box::new(m.iter_rev().map(|(k, l)| (&k[0], l)))
3658            }
3659            IndexKind::Nsw(_)
3660            | IndexKind::Brin { .. }
3661            | IndexKind::Gin(_)
3662            | IndexKind::GinTrgm(_)
3663            | IndexKind::GinFulltext(_)
3664            | IndexKind::GinJsonb(_) => alloc::boxed::Box::new(core::iter::empty()),
3665        }
3666    }
3667
3668    /// v7.34.4 — ascending-order iterator over `(IndexKey, locators)`
3669    /// pairs. Mirror of `iter_desc` for ORDER BY ... ASC + LIMIT N.
3670    pub fn iter_asc(
3671        &self,
3672    ) -> alloc::boxed::Box<dyn Iterator<Item = (&IndexKey, &crate::posting::PostingList)> + '_>
3673    {
3674        match &self.kind {
3675            IndexKind::BTree(m) => alloc::boxed::Box::new(m.iter()),
3676            // v7.38.1 (L12) — see iter_desc: the leading component of
3677            // a tuple-sorted walk is itself in order.
3678            IndexKind::BTreeMulti(m) => alloc::boxed::Box::new(m.iter().map(|(k, l)| (&k[0], l))),
3679            IndexKind::Nsw(_)
3680            | IndexKind::Brin { .. }
3681            | IndexKind::Gin(_)
3682            | IndexKind::GinTrgm(_)
3683            | IndexKind::GinFulltext(_)
3684            | IndexKind::GinJsonb(_) => alloc::boxed::Box::new(core::iter::empty()),
3685        }
3686    }
3687
3688    /// Look up the locators stored under `key` (B-tree only). Returns
3689    /// an empty slice when the key is absent or the index isn't a
3690    /// BTree — callers can treat both cases uniformly.
3691    ///
3692    /// v5.1: return type widened from `&[usize]` to `&[RowLocator]`.
3693    /// Pre-v5.2 callers can read the slice and `.as_hot().unwrap()`
3694    /// each entry (no `Cold` variants exist until the freezer lands);
3695    /// post-v5.2 callers dispatch hot vs. cold per locator.
3696    pub fn lookup_eq(&self, key: &IndexKey) -> &crate::posting::PostingList {
3697        match &self.kind {
3698            IndexKind::BTree(m) => m.get(key).map_or(&EMPTY_POSTINGS, |l| l),
3699            // BRIN / NSW / GIN / trigram-GIN / fulltext-GIN have
3700            // no IndexKey-keyed map; lookup is a no-op. GIN uses
3701            // [`Index::gin_lookup_word`] instead.
3702            IndexKind::Nsw(_)
3703            | IndexKind::Brin { .. }
3704            | IndexKind::Gin(_)
3705            | IndexKind::GinTrgm(_)
3706            | IndexKind::GinFulltext(_)
3707            | IndexKind::GinJsonb(_)
3708            | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3709        }
3710    }
3711
3712    /// v7.37.43 (INSUBQ B-2) — specialised lookup for integer-PK probes.
3713    /// `try_count_star_pk_in_subquery_fast` already holds an `i64` (the
3714    /// inner survivor key); skip the `IndexKey::from_value` enum-dispatch
3715    /// trip and build the key inline. ~20 ns × N_survivors saved on
3716    /// the INSUBQ hot loop.
3717    #[inline]
3718    pub fn lookup_eq_i64(&self, n: i64) -> &crate::posting::PostingList {
3719        match &self.kind {
3720            IndexKind::BTree(m) => m.get(&IndexKey::Int(n)).map_or(&EMPTY_POSTINGS, |l| l),
3721            IndexKind::Nsw(_)
3722            | IndexKind::Brin { .. }
3723            | IndexKind::Gin(_)
3724            | IndexKind::GinTrgm(_)
3725            | IndexKind::GinFulltext(_)
3726            | IndexKind::GinJsonb(_)
3727            | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3728        }
3729    }
3730
3731    /// v7.38 (perf, index range scan) — flatten the row locators for every key
3732    /// in `[lo, hi]` (bounds per `core::ops::Bound`) via the BTree's `O(log N +
3733    /// k)` range walk. Returns `None` once more than `cap` locators accumulate
3734    /// — a "this range isn't selective enough, seq-scan instead" signal that
3735    /// stops a wide range from materialising a near-full table's worth of rows
3736    /// through the index. BTree only (other kinds → None).
3737    pub fn lookup_range_capped(
3738        &self,
3739        lo: core::ops::Bound<&IndexKey>,
3740        hi: core::ops::Bound<&IndexKey>,
3741        cap: usize,
3742    ) -> Option<Vec<RowLocator>> {
3743        self.lookup_range_capped_by(lo, hi, cap, |_| true)
3744    }
3745
3746    /// v7.39 (round 490) — the same range walk, but the caller decides
3747    /// which locators are worth carrying, and the cap counts only those.
3748    ///
3749    /// A BTree index holds one locator per row VERSION. On a churned table
3750    /// the dead versions are still in there: round 490 measured a
3751    /// 1000-row range handing back 61 000 locators after 60
3752    /// delete-and-reinsert cycles with the background vacuum switched off.
3753    /// Every caller then dropped the dead ones — the mutation paths and the
3754    /// SELECT range path all test `is_row_visible` and `continue` — but only
3755    /// after they had been collected into a `Vec`, sorted, and walked.
3756    ///
3757    /// Handing the predicate down means the walk keeps ~1000, and the cap
3758    /// (which exists so an index walk never costs more than the scan it
3759    /// replaces) is once again measured in rows a caller will actually look
3760    /// at. Round 461 had to add the dead count to the budget to stop the
3761    /// seek being refused outright; with the filter here that compensation
3762    /// is no longer needed.
3763    pub fn lookup_range_capped_by(
3764        &self,
3765        lo: core::ops::Bound<&IndexKey>,
3766        hi: core::ops::Bound<&IndexKey>,
3767        cap: usize,
3768        keep: impl Fn(RowLocator) -> bool,
3769    ) -> Option<Vec<RowLocator>> {
3770        match &self.kind {
3771            IndexKind::BTree(m) => {
3772                let mut out: Vec<RowLocator> = Vec::new();
3773                for (_, locs) in m.range(lo, hi) {
3774                    out.extend(locs.iter().copied().filter(|l| keep(*l)));
3775                    if out.len() > cap {
3776                        return None;
3777                    }
3778                }
3779                Some(out)
3780            }
3781            IndexKind::Nsw(_)
3782            | IndexKind::Brin { .. }
3783            | IndexKind::Gin(_)
3784            | IndexKind::GinTrgm(_)
3785            | IndexKind::GinFulltext(_)
3786            | IndexKind::GinJsonb(_)
3787            | IndexKind::BTreeMulti(_) => None,
3788        }
3789    }
3790
3791    /// v7.38.1 (L12) — full-tuple point lookup on a [`IndexKind::BTreeMulti`]
3792    /// index. `key` must carry exactly as many components as the index
3793    /// has columns; anything else (including a probe against a
3794    /// non-multi index) finds nothing, and "nothing" here is safe
3795    /// because the caller falls back to a scan, never to an answer.
3796    pub fn lookup_eq_multi(&self, key: &[IndexKey]) -> &crate::posting::PostingList {
3797        match &self.kind {
3798            IndexKind::BTreeMulti(m) if key.len() == 1 + self.extra_column_positions.len() => {
3799                m.get_by(key).map_or(&EMPTY_POSTINGS, |l| l)
3800            }
3801            _ => &EMPTY_POSTINGS,
3802        }
3803    }
3804
3805    /// v7.38.1 (L12) — locators for every key whose leading components
3806    /// equal `prefix`, on a [`IndexKind::BTreeMulti`] index. Slice
3807    /// ordering keeps a prefix's keys contiguous, so this is one
3808    /// descent to `[prefix]` and a walk that stops at the first key
3809    /// leaving the prefix. Same cap/keep contract as
3810    /// [`Index::lookup_range_capped_by`]: `None` = not selective
3811    /// enough (or not a multi index), fall back.
3812    pub fn lookup_prefix_capped_by(
3813        &self,
3814        prefix: &[IndexKey],
3815        cap: usize,
3816        keep: impl Fn(RowLocator) -> bool,
3817    ) -> Option<Vec<RowLocator>> {
3818        let IndexKind::BTreeMulti(m) = &self.kind else {
3819            return None;
3820        };
3821        if prefix.is_empty() || prefix.len() > 1 + self.extra_column_positions.len() {
3822            return None;
3823        }
3824        let lo: alloc::boxed::Box<[IndexKey]> = prefix.to_vec().into_boxed_slice();
3825        let mut out: Vec<RowLocator> = Vec::new();
3826        for (k, locs) in m.range(core::ops::Bound::Included(&lo), core::ops::Bound::Unbounded) {
3827            if k.len() < prefix.len() || k[..prefix.len()] != *prefix {
3828                break;
3829            }
3830            out.extend(locs.iter().copied().filter(|l| keep(*l)));
3831            if out.len() > cap {
3832                return None;
3833            }
3834        }
3835        Some(out)
3836    }
3837
3838    /// v7.39 (round 560) — the index range as (key, locator) pairs.
3839    ///
3840    /// `lookup_range_capped_by` throws the KEY away and returns only
3841    /// locators, so a query whose projection is exactly the indexed
3842    /// column still goes to the row store for a value the walk already
3843    /// had in hand — paying per row for something the index knows.
3844    ///
3845    /// Uncapped on purpose: an index-only walk touches no row, so the
3846    /// selectivity ceiling that keeps a seek from being worse than the
3847    /// scan it replaces does not apply to it.
3848    ///
3849    /// v7.39 (round 562) — and it does not collect, either. This
3850    /// returned a `Vec<(IndexKey, RowLocator)>`: for a 100k-row range,
3851    /// 100k key clones into a `Vec::new()` that doubles its way up to
3852    /// several MB, all to be walked once and dropped. A profile of the
3853    /// server serving that query put 20% of the connection thread's CPU
3854    /// on the collect alone, with another 18% in the allocator beside
3855    /// it. The caller consumes the pairs in order and needs the key
3856    /// only by reference, so it can have the walk itself.
3857    pub fn range_keyed(
3858        &self,
3859        lo: core::ops::Bound<&IndexKey>,
3860        hi: core::ops::Bound<&IndexKey>,
3861    ) -> Option<impl Iterator<Item = (&IndexKey, RowLocator)> + '_> {
3862        match &self.kind {
3863            IndexKind::BTree(m) => Some(
3864                m.range(lo, hi)
3865                    .flat_map(|(k, locs)| locs.iter().map(move |l| (k, *l))),
3866            ),
3867            IndexKind::Nsw(_)
3868            | IndexKind::Brin { .. }
3869            | IndexKind::Gin(_)
3870            | IndexKind::GinTrgm(_)
3871            | IndexKind::GinFulltext(_)
3872            | IndexKind::GinJsonb(_)
3873            | IndexKind::BTreeMulti(_) => None,
3874        }
3875    }
3876
3877    /// v7.12.3 — GIN posting-list lookup. Returns the row locators
3878    /// whose `tsvector` cell contains `word`. Empty when the word is
3879    /// absent from the index or this isn't a GIN index.
3880    pub fn gin_lookup_word(&self, word: &str) -> &crate::posting::PostingList {
3881        match &self.kind {
3882            // v7.17.0 Phase 2.2 — fulltext-GIN shares the same
3883            // lexeme-keyed posting list shape as the
3884            // tsvector-typed GIN, so the same lookup applies.
3885            IndexKind::Gin(m) | IndexKind::GinFulltext(m) => {
3886                m.get(&String::from(word)).map_or(&EMPTY_POSTINGS, |l| l)
3887            }
3888            IndexKind::BTree(_)
3889            | IndexKind::Nsw(_)
3890            | IndexKind::Brin { .. }
3891            | IndexKind::GinTrgm(_)
3892            | IndexKind::GinJsonb(_)
3893            | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3894        }
3895    }
3896
3897    /// v7.15.0 — trigram-GIN posting-list lookup. Returns the row
3898    /// locators whose indexed `TEXT` cell contains the trigram
3899    /// `tri`. Empty when the trigram is absent or this isn't a
3900    /// trigram-GIN index.
3901    pub fn gin_trgm_lookup(&self, tri: &str) -> &crate::posting::PostingList {
3902        match &self.kind {
3903            IndexKind::GinTrgm(m) => m.get(&String::from(tri)).map_or(&EMPTY_POSTINGS, |l| l),
3904            IndexKind::BTree(_)
3905            | IndexKind::Nsw(_)
3906            | IndexKind::Brin { .. }
3907            | IndexKind::Gin(_)
3908            | IndexKind::GinFulltext(_)
3909            | IndexKind::GinJsonb(_)
3910            | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3911        }
3912    }
3913
3914    /// v7.37.8(sentori Epic 5 P2)— JSONB-GIN posting-list lookup.
3915    /// Returns the row locators whose indexed JSONB cell carries
3916    /// the canonical `token`(see [`crate::jsonb_gin::extract_tokens`]).
3917    /// Empty when the token is absent or this isn't a JSONB-GIN
3918    /// index. Planners drive `<col> @> <jsonb_literal>` through here.
3919    pub fn gin_jsonb_lookup(&self, token: &str) -> &crate::posting::PostingList {
3920        match &self.kind {
3921            IndexKind::GinJsonb(m) => m.get(&String::from(token)).map_or(&EMPTY_POSTINGS, |l| l),
3922            IndexKind::BTree(_)
3923            | IndexKind::Nsw(_)
3924            | IndexKind::Brin { .. }
3925            | IndexKind::Gin(_)
3926            | IndexKind::GinTrgm(_)
3927            | IndexKind::GinFulltext(_)
3928            | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3929        }
3930    }
3931
3932    /// Borrow the NSW graph (if this is an NSW index). Callers that need
3933    /// the graph for a kNN search go through here.
3934    pub const fn nsw(&self) -> Option<&NswGraph> {
3935        match &self.kind {
3936            IndexKind::Nsw(g) => Some(g),
3937            IndexKind::BTree(_)
3938            | IndexKind::Brin { .. }
3939            | IndexKind::Gin(_)
3940            | IndexKind::GinTrgm(_)
3941            | IndexKind::GinFulltext(_)
3942            | IndexKind::GinJsonb(_)
3943            | IndexKind::BTreeMulti(_) => None,
3944        }
3945    }
3946
3947    /// v6.7.1 — true when this index is a BRIN (block range) index.
3948    /// Used by the segment encoder to opt into BRIN sidecar emission
3949    /// at freeze time, and by the planner to opt into page-skipping
3950    /// on range predicates.
3951    pub const fn is_brin(&self) -> bool {
3952        matches!(self.kind, IndexKind::Brin { .. })
3953    }
3954
3955    /// v7.15.0 — true when this index is a trigram GIN
3956    /// (`gin_trgm_ops`-flavoured). Used by the LIKE planner to
3957    /// opt into trigram acceleration.
3958    pub const fn is_gin_trgm(&self) -> bool {
3959        matches!(self.kind, IndexKind::GinTrgm(_))
3960    }
3961
3962    /// v7.12.3 — true when this index is a GIN inverted index.
3963    /// Used by the planner to opt into posting-list acceleration on
3964    /// `WHERE col @@ tsquery` predicates.
3965    pub const fn is_gin(&self) -> bool {
3966        matches!(self.kind, IndexKind::Gin(_))
3967    }
3968
3969    /// v7.17.0 Phase 2.2 — true when this index is a fulltext
3970    /// GIN over a TEXT / VARCHAR column (MySQL `FULLTEXT KEY`
3971    /// surface). Used by the planner to opt the FULLTEXT-indexed
3972    /// column into MATCH AGAINST acceleration.
3973    pub const fn is_gin_fulltext(&self) -> bool {
3974        matches!(self.kind, IndexKind::GinFulltext(_))
3975    }
3976
3977    /// v7.37.8(sentori Epic 5 P2)— true when this index is a
3978    /// real JSONB-GIN(posting-list backed). Used by the planner
3979    /// to opt `<col> @> <jsonb_literal>` into posting-list seek.
3980    pub const fn is_gin_jsonb(&self) -> bool {
3981        matches!(self.kind, IndexKind::GinJsonb(_))
3982    }
3983}
3984
3985/// In-memory table: schema + a persistent row vector + secondary indices.
3986///
3987/// v4.39: `rows` is a [`PersistentVec`] (Bitmapped Vector Trie, 32-way) so
3988/// `Table::clone()` is `O(1)` — the whole reason for v4.39's existence is
3989/// to make `Catalog::clone()` cheap inside the v4.34 auto-commit wrap.
3990///
3991/// v5.2.1: `hot_bytes` tracks the encoded byte size of every row currently
3992/// in [`Self::rows`], summed over rows. Updated incrementally by `insert`
3993/// (+= encoded row size), `delete_rows` (-= removed rows' encoded sizes),
3994/// and `update_row` (-= old size, += new size). The value is what the
3995/// v5.2 freezer reads to decide when to demote cold rows — when the
3996/// catalog-wide sum crosses `SPG_HOT_TIER_BYTES` (default 4 GiB) the
3997/// freezer thread wakes. v5.2.1 ships measurement only; the freezer
3998/// itself lands in v5.2.2. Stored as `u64` so a single field clone in
3999/// `Catalog::clone` stays at the O(1) invariant v4.39 built.
4000/// v7.34 (crash-recovery P0 #2) — one row-level physical redo record.
4001/// Row-level redo replaces statement-based WAL replay (which re-executes
4002/// each SQL through the full engine — O(records × catalog_rows), the
4003/// superlinear recovery hang root-caused on the mailrs crash-recovery
4004/// P0). A `RowChange` is the exact storage mutation the engine applied
4005/// (`Table::insert` / `update_row` / `delete_rows`); replaying it on a
4006/// catalog restored from the matching checkpoint reproduces the state
4007/// WITHOUT re-validating uniqueness/FK/parse/plan — O(changed rows).
4008///
4009/// Positions are physical, not key-based: `serialize`/`deserialize`
4010/// preserve row order exactly (rows written + read back in `self.rows`
4011/// order) and the mutation ops are deterministic, so the same op sequence
4012/// replayed from the same checkpoint reproduces the same positions. This
4013/// matches PostgreSQL's physical redo and supports tables with no primary
4014/// key. (Caveat handled at replay integration: a post-checkpoint cold-tier
4015/// freeze shifts hot positions and must itself be logged or fenced by a
4016/// checkpoint — see `row-level-redo-design`.)
4017/// ## v7.37.15 (Epic W slice 1) — additive MVCC identity metadata
4018///
4019/// Each variant now also carries, additively, the stable
4020/// [`RowId`](row_header::RowId) of the affected row(s) and the
4021/// **writer version** (`xmin` for an insert, `xmax` for a
4022/// delete/update). This is the codec foundation for making
4023/// in-place MVCC tombstones durable across crash/upgrade recovery.
4024///
4025/// Two important properties for the durability path:
4026///
4027/// 1. **Replay resolution is UNCHANGED.** `apply_redo_run_on_table`
4028///    still resolves every change by physical `pos`/`positions`
4029///    exactly as before. The new metadata is *carried but unused*
4030///    by replay in this slice; resolving-by-`RowId` and
4031///    header-preserving replay are later slices.
4032/// 2. **Backward compatibility.** A redo payload written by
4033///    pre-Epic-W code carries no metadata; [`decode_redo_log`]
4034///    fills `rowid`/`rowids` with [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED)
4035///    (empty for `Delete`) and `writer_version` with `0`. See the
4036///    codec version gate in [`encode_redo_log`]/[`decode_redo_log`].
4037///
4038/// The `writer_version` is captured as `0` at the storage layer
4039/// (`Table::insert`/`delete_rows`/`update_row` don't have the
4040/// committing `TxId`), then **stamped with the real committing
4041/// version by the engine** after it drains the statement's changes
4042/// (Epic W slice 2 — [`RowChange::set_writer_version`], driven from
4043/// `Engine::writer_version_for_current_stmt`). All changes from one
4044/// statement share the one version. Replay still resolves by
4045/// physical position and does not read `writer_version` — that is a
4046/// later slice (header-preserving replay).
4047#[derive(Debug, Clone, PartialEq)]
4048pub enum RowChange {
4049    /// Append `row` to `table`.
4050    Insert {
4051        table: String,
4052        row: Row<'static>,
4053        /// Epic W: stable id the appended row will receive.
4054        /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) when
4055        /// decoded from a pre-Epic-W redo payload.
4056        rowid: row_header::RowId,
4057        /// Epic W: writer version (`xmin`). `0` until the writing
4058        /// `TxId` is threaded to the storage layer (later slice).
4059        writer_version: u64,
4060    },
4061    /// Replace the row at physical `pos` in `table` with `new_row`.
4062    Update {
4063        table: String,
4064        pos: usize,
4065        new_row: Vec<Value<'static>>,
4066        /// Epic W: stable id of the row at `pos`.
4067        /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) when
4068        /// decoded from a pre-Epic-W redo payload.
4069        rowid: row_header::RowId,
4070        /// Epic W: writer version (`xmax` of the superseded tuple).
4071        /// `0` until the writing `TxId` is threaded (later slice).
4072        writer_version: u64,
4073    },
4074    /// Remove the rows at the given physical `positions` from `table`.
4075    Delete {
4076        table: String,
4077        positions: Vec<usize>,
4078        /// Epic W: stable ids parallel to `positions` (same length,
4079        /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) for an
4080        /// out-of-bounds input position). **Empty** when decoded from
4081        /// a pre-Epic-W redo payload (no metadata was recorded).
4082        rowids: Vec<row_header::RowId>,
4083        /// Epic W: writer version (`xmax`). `0` until the writing
4084        /// `TxId` is threaded to the storage layer (later slice).
4085        writer_version: u64,
4086    },
4087    /// v7.37.15 (Epic W durable-tombstone slice) — an **in-place MVCC
4088    /// delete**: the row(s) named by `rowids` are NOT physically
4089    /// removed; their header `xmax` is stamped so newer snapshots stop
4090    /// seeing them (vacuum reclaims later). This is the redo shape of
4091    /// the gate-on (`SPG_MVCC_INPLACE`) DELETE / UPDATE-old-version /
4092    /// ON-CONFLICT paths, which call [`Table::mark_row_deleted`]
4093    /// instead of `delete_rows`.
4094    ///
4095    /// Unlike `Delete`, the target is named by **stable `RowId`**, not
4096    /// physical position: a tombstone keeps the slot, so position would
4097    /// be ambiguous after later compaction, and the header-preserving
4098    /// replay must re-find the exact row the writer tombstoned. On
4099    /// replay the id is matched against the ids the same redo run
4100    /// produced (an `Insert`'s `rowid`, or the table's ids snapshotted
4101    /// at run start); an id that cannot be resolved is skipped and
4102    /// counted (see `apply_redo_run_on_table`) — this is the documented
4103    /// cross-checkpoint limitation until the V6 envelope persists ids.
4104    Tombstone {
4105        table: String,
4106        /// Stable ids of the tombstoned rows (from `self.rowids()[pos]`
4107        /// at capture). Never empty for a recorded tombstone.
4108        rowids: Vec<row_header::RowId>,
4109        /// The version stamped into each target row's header `xmax`
4110        /// (the deleting statement's writer version).
4111        xmax: u64,
4112    },
4113}
4114
4115impl RowChange {
4116    /// v7.39 (round 736) — which table this change applies to.
4117    #[must_use]
4118    pub fn table_name(&self) -> &str {
4119        match self {
4120            Self::Insert { table, .. }
4121            | Self::Update { table, .. }
4122            | Self::Delete { table, .. }
4123            | Self::Tombstone { table, .. } => table,
4124        }
4125    }
4126
4127    /// v7.37.15 (Epic W slice 2) — stamp the committing writer
4128    /// version onto this change. Every change drained from a single
4129    /// statement shares one version (the statement's `xmin`/`xmax`),
4130    /// so the engine calls this on each drained change with the value
4131    /// from [`Engine::writer_version_for_current_stmt`]. Additive
4132    /// metadata only: replay still resolves by physical position and
4133    /// does not read `writer_version` (that is a later slice).
4134    pub fn set_writer_version(&mut self, v: u64) {
4135        match self {
4136            RowChange::Insert { writer_version, .. }
4137            | RowChange::Update { writer_version, .. }
4138            | RowChange::Delete { writer_version, .. } => *writer_version = v,
4139            // A tombstone captures `xmax` directly from the deleting
4140            // statement's version at record time (via
4141            // `mark_row_deleted`), so it already equals `v`. Keep the
4142            // "one statement, one version" invariant mechanical by
4143            // asserting agreement in debug builds rather than silently
4144            // overwriting a possibly-different value.
4145            RowChange::Tombstone { xmax, .. } => {
4146                debug_assert_eq!(
4147                    *xmax, v,
4148                    "tombstone xmax must match the statement writer version"
4149                );
4150                *xmax = v;
4151            }
4152        }
4153    }
4154}
4155
4156/// v7.37.15 (Epic W slice 1) — leading marker byte of the
4157/// metadata-carrying redo layout. A **pre-Epic-W** redo payload leads
4158/// with `FILE_VERSION` (8..=52 today, rising ~1 per release); this
4159/// marker is `0xFF` and can therefore never collide with a real
4160/// `FILE_VERSION`, so [`decode_redo_log`] tells the two layouts apart
4161/// by inspecting the first byte alone. The compile-time assertion
4162/// below makes the "never collide" invariant a hard build gate: if
4163/// `FILE_VERSION` ever climbs toward `0xFF` the build breaks and forces
4164/// a redesign long before an ambiguity could ship.
4165const REDO_META_MARKER: u8 = 0xFF;
4166/// v7.37.15 (Epic W slice 1) — version of the metadata-carrying redo
4167/// layout that follows [`REDO_META_MARKER`]. Bumped when the per-change
4168/// metadata shape changes; an unknown value is a hard decode error.
4169const REDO_META_VERSION: u8 = 1;
4170
4171/// v7.37.15 (Epic W durable-tombstone slice) — process-wide count of
4172/// [`RowChange::Tombstone`] targets that `apply_redo` could NOT resolve
4173/// to a row by `RowId`. A non-zero value is expected only across a
4174/// checkpoint boundary (the table's ids are reassigned on deserialize
4175/// and the V6 envelope does not yet persist them), where a tombstone
4176/// naming a pre-checkpoint row is left visible rather than mis-applied.
4177/// Surfaced for observability; never affects correctness of the resolved
4178/// tombstones. Read via [`unresolved_tombstone_count`].
4179static UNRESOLVED_TOMBSTONES: core::sync::atomic::AtomicU64 = core::sync::atomic::AtomicU64::new(0);
4180
4181/// v7.39 (flip crash-replay P0) — observability read for the replay
4182/// tombstones that could not be resolved to a row (each one is a
4183/// resurrected delete).
4184#[must_use]
4185pub fn unresolved_tombstones() -> u64 {
4186    UNRESOLVED_TOMBSTONES.load(core::sync::atomic::Ordering::Relaxed)
4187}
4188
4189/// v7.37.15 (Epic W durable-tombstone slice) — read the process-wide
4190/// count of redo tombstones that could not be resolved to a row by
4191/// `RowId` during `apply_redo`. See [`UNRESOLVED_TOMBSTONES`].
4192#[must_use]
4193pub fn unresolved_tombstone_count() -> u64 {
4194    UNRESOLVED_TOMBSTONES.load(core::sync::atomic::Ordering::Relaxed)
4195}
4196// Provably-unambiguous old/new distinction: the pre-Epic-W layout's
4197// first byte is `FILE_VERSION`, which must stay strictly below the
4198// marker forever.
4199const _: () = assert!(FILE_VERSION < REDO_META_MARKER);
4200
4201/// v7.34 (crash-recovery P0 #2), extended v7.37.15 (Epic W slice 1) —
4202/// encode a row-level redo log to bytes for a WAL record.
4203///
4204/// ## Layout (Epic W metadata-carrying form, always emitted now)
4205///
4206/// `[u8 REDO_META_MARKER=0xFF][u8 REDO_META_VERSION][u8 FILE_VERSION]
4207/// [u32 count]` then per change `[u8 op][str table]` and, per op:
4208/// - `Insert [u32 n][value×n][u64 rowid][u64 writer_version]`
4209/// - `Update [u32 pos][u32 n][value×n][u64 rowid][u64 writer_version]`
4210/// - `Delete [u32 n][u32 pos×n][u64 rowid×n][u64 writer_version]`
4211/// - `Tombstone [u32 n][u64 rowid×n][u64 xmax]` (op byte 3; only ever
4212///   emitted under the metadata-carrying layout — the pre-Epic-W layout
4213///   had no in-place tombstone, so a legacy stream can never carry it)
4214///
4215/// Positions are physical (u32 ≤ 4 G rows). The `FILE_VERSION` byte
4216/// still rides along (now the 3rd byte) so the value codec decodes
4217/// string / BYTEA escapes exactly as before.
4218///
4219/// ## Backward compatibility
4220///
4221/// The **pre-Epic-W** layout was `[u8 FILE_VERSION][u32 count]…` with
4222/// no per-change metadata. [`decode_redo_log`] still decodes that form
4223/// (first byte < `0xFF`) byte-for-byte identically — every WAL file
4224/// written by released code replays unchanged.
4225#[must_use]
4226pub fn encode_redo_log(changes: &[RowChange]) -> Vec<u8> {
4227    let mut out = Vec::new();
4228    out.push(REDO_META_MARKER);
4229    out.push(REDO_META_VERSION);
4230    out.push(FILE_VERSION);
4231    codec::write_u32(&mut out, changes.len() as u32);
4232    let write_values = |out: &mut Vec<u8>, vals: &[Value<'static>]| {
4233        codec::write_u32(out, vals.len() as u32);
4234        for v in vals {
4235            codec::write_value(out, v);
4236        }
4237    };
4238    for change in changes {
4239        match change {
4240            RowChange::Insert {
4241                table,
4242                row,
4243                rowid,
4244                writer_version,
4245            } => {
4246                out.push(0);
4247                codec::write_str(&mut out, table);
4248                write_values(&mut out, &row.values);
4249                codec::write_u64(&mut out, rowid.0);
4250                codec::write_u64(&mut out, *writer_version);
4251            }
4252            RowChange::Update {
4253                table,
4254                pos,
4255                new_row,
4256                rowid,
4257                writer_version,
4258            } => {
4259                out.push(1);
4260                codec::write_str(&mut out, table);
4261                codec::write_u32(&mut out, *pos as u32);
4262                write_values(&mut out, new_row);
4263                codec::write_u64(&mut out, rowid.0);
4264                codec::write_u64(&mut out, *writer_version);
4265            }
4266            RowChange::Delete {
4267                table,
4268                positions,
4269                rowids,
4270                writer_version,
4271            } => {
4272                out.push(2);
4273                codec::write_str(&mut out, table);
4274                codec::write_u32(&mut out, positions.len() as u32);
4275                for p in positions {
4276                    codec::write_u32(&mut out, *p as u32);
4277                }
4278                // Epic W: one RowId per position (parallel). Capture
4279                // sites always produce `rowids.len() == positions.len()`;
4280                // this assertion pins that invariant at encode time so a
4281                // mismatch is a loud bug, not a silently short payload.
4282                debug_assert_eq!(
4283                    rowids.len(),
4284                    positions.len(),
4285                    "redo Delete: rowids must be parallel to positions"
4286                );
4287                for rid in rowids {
4288                    codec::write_u64(&mut out, rid.0);
4289                }
4290                codec::write_u64(&mut out, *writer_version);
4291            }
4292            RowChange::Tombstone {
4293                table,
4294                rowids,
4295                xmax,
4296            } => {
4297                out.push(3);
4298                codec::write_str(&mut out, table);
4299                codec::write_u32(&mut out, rowids.len() as u32);
4300                for rid in rowids {
4301                    codec::write_u64(&mut out, rid.0);
4302                }
4303                codec::write_u64(&mut out, *xmax);
4304            }
4305        }
4306    }
4307    out
4308}
4309
4310/// v7.34, extended v7.37.15 (Epic W slice 1) — decode a row-level redo
4311/// log written by [`encode_redo_log`].
4312///
4313/// Decodes **both** the Epic W metadata-carrying layout (first byte
4314/// `REDO_META_MARKER = 0xFF`) and the pre-Epic-W layout (first byte is
4315/// `FILE_VERSION`, always `< 0xFF`). For the old layout the per-change
4316/// metadata is absent, so `rowid`/`rowids` come back
4317/// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) (empty for
4318/// `Delete`) and `writer_version` comes back `0`.
4319///
4320/// A truncated / corrupt buffer is a hard error — never a panic — the
4321/// embedding layer frames each record with its own length + CRC, so a
4322/// frame that decodes short is corruption, not a torn tail.
4323pub fn decode_redo_log(bytes: &[u8]) -> Result<Vec<RowChange>, StorageError> {
4324    let first = *bytes
4325        .first()
4326        .ok_or_else(|| StorageError::Corrupt("redo log: empty".into()))?;
4327    // Epic W: `0xFF` marker ⇒ metadata-carrying layout; anything else
4328    // is a pre-Epic-W `FILE_VERSION` byte (old layout, no metadata).
4329    let has_meta = first == REDO_META_MARKER;
4330    let (codec_version, header_len) = if has_meta {
4331        let meta_version = *bytes
4332            .get(1)
4333            .ok_or_else(|| StorageError::Corrupt("redo log: short header".into()))?;
4334        if meta_version != REDO_META_VERSION {
4335            return Err(StorageError::Corrupt(alloc::format!(
4336                "redo log: unknown metadata version {meta_version}"
4337            )));
4338        }
4339        let file_version = *bytes
4340            .get(2)
4341            .ok_or_else(|| StorageError::Corrupt("redo log: short header".into()))?;
4342        // header = [marker][meta_version][file_version]
4343        (file_version, 3usize)
4344    } else {
4345        // Old layout: the first byte IS the FILE_VERSION.
4346        (first, 1usize)
4347    };
4348    let mut cur = codec::Cursor::new(bytes).with_codec_version(codec_version);
4349    for _ in 0..header_len {
4350        cur.read_u8()?;
4351    }
4352    let count = cur.read_u32()? as usize;
4353    let mut read_values =
4354        |cur: &mut codec::Cursor<'_>| -> Result<Vec<Value<'static>>, StorageError> {
4355            let n = cur.read_u32()? as usize;
4356            let mut vals = Vec::with_capacity(n);
4357            for _ in 0..n {
4358                vals.push(cur.read_value()?);
4359            }
4360            Ok(vals)
4361        };
4362    let mut changes = Vec::with_capacity(count);
4363    for _ in 0..count {
4364        let op = cur.read_u8()?;
4365        let table = cur.read_str()?;
4366        let change = match op {
4367            0 => {
4368                let row = Row::new(read_values(&mut cur)?);
4369                let (rowid, writer_version) = if has_meta {
4370                    (row_header::RowId(cur.read_u64()?), cur.read_u64()?)
4371                } else {
4372                    (row_header::RowId::UNASSIGNED, 0)
4373                };
4374                RowChange::Insert {
4375                    table,
4376                    row,
4377                    rowid,
4378                    writer_version,
4379                }
4380            }
4381            1 => {
4382                let pos = cur.read_u32()? as usize;
4383                let new_row = read_values(&mut cur)?;
4384                let (rowid, writer_version) = if has_meta {
4385                    (row_header::RowId(cur.read_u64()?), cur.read_u64()?)
4386                } else {
4387                    (row_header::RowId::UNASSIGNED, 0)
4388                };
4389                RowChange::Update {
4390                    table,
4391                    pos,
4392                    new_row,
4393                    rowid,
4394                    writer_version,
4395                }
4396            }
4397            2 => {
4398                let n = cur.read_u32()? as usize;
4399                let mut positions = Vec::with_capacity(n);
4400                for _ in 0..n {
4401                    positions.push(cur.read_u32()? as usize);
4402                }
4403                let (rowids, writer_version) = if has_meta {
4404                    let mut rowids = Vec::with_capacity(n);
4405                    for _ in 0..n {
4406                        rowids.push(row_header::RowId(cur.read_u64()?));
4407                    }
4408                    (rowids, cur.read_u64()?)
4409                } else {
4410                    // Old layout carried no RowId metadata.
4411                    (Vec::new(), 0)
4412                };
4413                RowChange::Delete {
4414                    table,
4415                    positions,
4416                    rowids,
4417                    writer_version,
4418                }
4419            }
4420            // Op 3 is the Epic W in-place tombstone — it only exists in
4421            // the metadata-carrying layout. Guarding on `has_meta` means
4422            // a legacy stream that happens to contain a `3` byte here is
4423            // reported as an unknown op (corruption), never mis-decoded.
4424            3 if has_meta => {
4425                let n = cur.read_u32()? as usize;
4426                let mut rowids = Vec::with_capacity(n);
4427                for _ in 0..n {
4428                    rowids.push(row_header::RowId(cur.read_u64()?));
4429                }
4430                let xmax = cur.read_u64()?;
4431                RowChange::Tombstone {
4432                    table,
4433                    rowids,
4434                    xmax,
4435                }
4436            }
4437            other => {
4438                return Err(StorageError::Corrupt(alloc::format!(
4439                    "redo log: unknown op {other}"
4440                )));
4441            }
4442        };
4443        changes.push(change);
4444    }
4445    Ok(changes)
4446}
4447
4448/// v7.39 (pg_stat knife B) — per-table scan counters, bumped from
4449/// `&self` read paths. Clone (tx shadow catalogs clone tables) copies
4450/// the current values; the counters are volatile like PG's cumulative
4451/// stats.
4452#[derive(Debug, Default)]
4453pub struct ScanStats {
4454    pub seq_scan: core::sync::atomic::AtomicU64,
4455    pub seq_tup_read: core::sync::atomic::AtomicU64,
4456    pub idx_scan: core::sync::atomic::AtomicU64,
4457    pub idx_tup_fetch: core::sync::atomic::AtomicU64,
4458}
4459
4460impl Clone for ScanStats {
4461    fn clone(&self) -> Self {
4462        use core::sync::atomic::{AtomicU64, Ordering};
4463        Self {
4464            seq_scan: AtomicU64::new(self.seq_scan.load(Ordering::Relaxed)),
4465            seq_tup_read: AtomicU64::new(self.seq_tup_read.load(Ordering::Relaxed)),
4466            idx_scan: AtomicU64::new(self.idx_scan.load(Ordering::Relaxed)),
4467            idx_tup_fetch: AtomicU64::new(self.idx_tup_fetch.load(Ordering::Relaxed)),
4468        }
4469    }
4470}
4471
4472/// v7.39 (round 215) — the lower-bound sort key for a range value, used by
4473/// the range-exclusion index. The bound as an `i128` (unbounded lower =
4474/// `i128::MIN`, sorting first) plus an inclusivity rank (inclusive lower
4475/// sorts before exclusive at the same value, `[3` before `(3`). Returns
4476/// `None` for range kinds whose bound isn't an integer scalar (numrange's
4477/// numeric/bignum), for empty ranges, and for non-range values — the caller
4478/// then keeps the O(n) scan rather than risk an unsound order. Int4/Int8/
4479/// Date/Ts/TsTz all reduce here (tstzrange bounds are `Value::Timestamp`).
4480/// Maintenance (index build) and query (overlap probe) MUST agree on this
4481/// key, so both sides call exactly this function.
4482#[must_use]
4483pub fn range_excl_index_key(v: &Value<'_>) -> Option<(i128, u8)> {
4484    let Value::Range {
4485        lower,
4486        lower_inc,
4487        empty,
4488        ..
4489    } = v
4490    else {
4491        return None;
4492    };
4493    if *empty {
4494        return None;
4495    }
4496    let key = match lower {
4497        None => i128::MIN,
4498        Some(b) => match b.as_ref() {
4499            Value::SmallInt(n) => i128::from(*n),
4500            Value::Int(n) => i128::from(*n),
4501            Value::BigInt(n) => i128::from(*n),
4502            Value::Date(n) => i128::from(*n),
4503            Value::Timestamp(n) => i128::from(*n),
4504            _ => return None,
4505        },
4506    };
4507    Some((key, u8::from(!*lower_inc)))
4508}
4509
4510/// v7.39 (round 215) — a per-table range-exclusion index: an incrementally
4511/// maintained map from a range column's lower-bound key
4512/// ([`range_excl_index_key`]) to the physical row locators carrying that
4513/// bound. Lets EXCLUDE enforcement find the few candidate rows a new range
4514/// might overlap in O(log n) instead of scanning every row (measured O(N²),
4515/// r213). Because the stored ranges under a valid `EXCLUDE (col WITH &&)`
4516/// are pairwise disjoint, a candidate overlaps only its predecessor or the
4517/// successors whose lower bound precedes its upper — a handful of probes.
4518///
4519/// NOT persisted: rebuilt from the (persisted) exclusion constraints + rows
4520/// on catalog load, exactly like BRIN re-derives. Backed by a
4521/// `PersistentBTreeMap` so `Table::clone` (the per-write snapshot) stays
4522/// O(1). Locators to tombstoned rows are left in place and filtered by the
4523/// consumer via `is_deleted()` at query time — the established index pattern.
4524#[derive(Debug, Clone)]
4525pub struct ExclRangeIndex {
4526    /// The constrained range column's position in the table.
4527    pub column_position: usize,
4528    /// Lower-bound key → row locators. A key maps to a `Vec` because a
4529    /// tombstoned-then-reinserted bound can transiently collide; live rows
4530    /// under the constraint are disjoint so each key has one live locator.
4531    pub map: PersistentBTreeMap<(i128, u8), crate::posting::PostingList>,
4532}
4533
4534/// v7.38.2 (R2) — see [`Table::tx_write_track`]. Positions are the
4535/// insert-time slots (verified against the header's version at
4536/// extraction, so a shifted slot falls back to the scan); tombstones
4537/// carry the stable RowId, which is what the write-set wants anyway.
4538#[derive(Debug, Clone, Default)]
4539struct TxWriteTrack {
4540    version: u64,
4541    inserted: Vec<(usize, row_header::RowId)>,
4542    tombstoned: Vec<row_header::RowId>,
4543}
4544
4545/// v7.38.11 — hot-tier BRIN granularity: slots per summarised range.
4546///
4547/// 1024 keeps the summary vector three orders of magnitude smaller
4548/// than the table while staying fine enough that a one-day window over
4549/// a 90-day table skips ~99 % of it. A tuning constant, not a format:
4550/// summaries are rebuilt from the rows on load, so changing it costs
4551/// nothing on disk.
4552pub const BRIN_RANGE_ROWS: usize = 1024;
4553
4554/// The comparable scalar a BRIN summary tracks, or `None` for a value
4555/// with no ordering this index can use.
4556///
4557/// Deliberately narrow: only types whose ordering IS the i64 ordering
4558/// of this number. A type added here whose comparison is not that —
4559/// text under a collation, say — would make the summary under-report
4560/// and skip matching rows, which is the one failure this design must
4561/// not have.
4562#[must_use]
4563pub fn brin_scalar(v: &Value<'_>) -> Option<i64> {
4564    match v {
4565        Value::SmallInt(n) => Some(i64::from(*n)),
4566        Value::Int(n) => Some(i64::from(*n)),
4567        Value::BigInt(n) | Value::Timestamp(n) => Some(*n),
4568        Value::Date(d) => Some(i64::from(*d)),
4569        Value::Bool(b) => Some(i64::from(*b)),
4570        _ => None,
4571    }
4572}
4573
4574#[derive(Debug, Clone)]
4575pub struct Table {
4576    schema: TableSchema,
4577    /// v7.38.18 (S2) — the DATABASE's collation, copied in by the
4578    /// catalog that owns this table.
4579    ///
4580    /// A text column that declares no collation inherits it, which is
4581    /// what PostgreSQL does and what `information_schema.columns`
4582    /// reports as NULL. Runtime only, never serialised: it belongs to
4583    /// the catalog, and a table that has been handed around outside one
4584    /// falls back to `C`, which is the answer for every database written
4585    /// before this existed.
4586    db_collation: Option<String>,
4587    /// v7.38.16 — names of the expression indexes whose B-tree currently
4588    /// holds keys derived from the EXPRESSION.
4589    ///
4590    /// Every catalog written before this version stored, under an
4591    /// expression index, the values of its leading column — keys no
4592    /// lookup could ever match, which is why every read path guarded
4593    /// itself with `expression.is_none()` and the index bought nothing
4594    /// while costing 1.9x a plain insert to maintain.
4595    ///
4596    /// Deliberately NOT persisted: a table read off disk starts with the
4597    /// set empty, so those old wrong keys can never answer a query. The
4598    /// engine, which owns the expression evaluator, refills it.
4599    expr_index_complete: alloc::collections::BTreeSet<String>,
4600    /// v7.37.15 (Phase C.1) — stable per-catalog relation identity.
4601    /// [`RelId::UNASSIGNED`](row_header::RelId::UNASSIGNED) until
4602    /// `Catalog::create_table` (or the deserialize dense-assign pass)
4603    /// stamps a real id. Keys the Phase C.4 row-lock table and the
4604    /// Phase C.5 `RelationStore`; survives `DROP TABLE` slot shifts.
4605    rel_id: row_header::RelId,
4606    rows: PersistentVec<Row<'static>>,
4607    /// v7.37.15 (Phase A.2) — per-row MVCC visibility headers
4608    /// parallel to `rows`. `headers.len() == rows.len()` is the
4609    /// load-bearing invariant; debug builds assert it on every
4610    /// scan boundary, release builds rely on it from
4611    /// disciplined insert / delete / update paths.
4612    ///
4613    /// Pre-v7.37.15-loaded tables (every row currently in the
4614    /// fleet) start as `RowHeader::frozen()` — `is_all_visible_fast()`
4615    /// returns `true`, so the per-row visibility gate Phase B
4616    /// adds is a no-op against any snapshot.
4617    ///
4618    /// Headers are NOT yet serialised into the envelope at this
4619    /// commit — on snapshot deserialize every row gets a fresh
4620    /// `RowHeader::frozen()`. Phase D adds the visibility-map
4621    /// + segment-freeze story which makes serialisation
4622    /// meaningful; until then the on-disk story is "the catalog
4623    /// is the set of visible rows."
4624    headers: PersistentVec<row_header::RowHeader>,
4625    /// v7.37.15 (Phase C.1) — stable per-relation row identity
4626    /// parallel to `rows` / `headers`. `rowids[i]` is the never-
4627    /// reused [`RowId`](row_header::RowId) of the row physically at
4628    /// slot `i`; `rowids.len() == rows.len()` joins the same load-
4629    /// bearing lock-step invariant as `headers`. Compaction (delete
4630    /// / vacuum) rebuilds all three vecs together so the id travels
4631    /// with the row while the slot shifts.
4632    ///
4633    /// Introduced additively: allocated + kept lock-step, but index
4634    /// locators still address rows by physical slot at this commit.
4635    /// Later phases migrate the lock table (C.4), HOT chains (D),
4636    /// and the WAL (Epic W) to address by `RowId`.
4637    ///
4638    /// Not yet serialised into the envelope — on load every row is
4639    /// assigned a fresh dense id `1..=len` (see `next_rowid`), which
4640    /// is sufficient while the id is process-local bookkeeping. The
4641    /// V6 envelope (Phase C.6) will persist ids so a WAL redo can
4642    /// name a row across restart.
4643    rowids: PersistentVec<row_header::RowId>,
4644    /// v7.37.15 (Phase C.1) — per-relation monotonic allocator for
4645    /// `rowids`. Starts at 1 (0 is the `RowId::UNASSIGNED` sentinel);
4646    /// every append takes `next_rowid` then increments. Never reused
4647    /// even after the row is deleted / vacuumed, so a stale lock /
4648    /// redo reference can be detected rather than silently aliasing a
4649    /// later row that reused the slot.
4650    ///
4651    /// 7.38.1 (S2.4, MATRIX #20 root cause) — the allocator is SHARED
4652    /// across every `clone()` of the relation (`Arc`), because the
4653    /// monotonic-never-reused promise is a LINEAGE invariant: each
4654    /// open transaction's shadow catalog is a clone, and when clones
4655    /// carried private counters two concurrent shadows minted the
4656    /// same id — duplicate rids in the base after both committed,
4657    /// aliasing every rid-addressed mechanism (locks, tombstones,
4658    /// redo, the rebase unique pre-check).
4659    next_rowid: alloc::sync::Arc<core::sync::atomic::AtomicU64>,
4660    /// v7.37.16 (autovacuum) — live count of tombstoned-but-present hot
4661    /// rows (`headers[i].xmax != XMAX_ALIVE`). Maintained incrementally:
4662    /// `mark_row_deleted` / `mark_rows_deleted` increment (the only
4663    /// tombstone producers), `delete_rows_no_index` recomputes over the
4664    /// survivors (it is the compaction hub every physical removal —
4665    /// including vacuum — flows through), and the v53 snapshot loader
4666    /// recounts verbatim-restored headers. Drives the engine's
4667    /// autovacuum threshold; not persisted (recomputed on load).
4668    dead_rows: u64,
4669    /// v7.39 (pg_stat knife A) — volatile per-table write counters
4670    /// backing `pg_stat_user_tables.n_tup_ins/upd/del`. Not persisted
4671    /// (PG's cumulative stats are shared-memory-volatile too — a
4672    /// restart zeroes them).
4673    stat_tup_ins: u64,
4674    stat_tup_upd: u64,
4675    stat_tup_del: u64,
4676    /// v7.39 (pg_stat knife B) — volatile scan counters
4677    /// (`seq_scan/seq_tup_read/idx_scan/idx_tup_fetch`). Atomics: the
4678    /// read paths that bump them hold only `&Table`.
4679    scan_stats: ScanStats,
4680    /// v7.39 (pg_stat knife C) — wall-clock stamps (unix µs, from the
4681    /// host ClockFn) for pg_stat_user_tables' last_autovacuum /
4682    /// last_analyze. Volatile, like PG's cumulative stats. SPG has no
4683    /// manual-VACUUM statement semantics, so last_vacuum stays NULL.
4684    last_autovacuum_us: Option<i64>,
4685    last_analyze_us: Option<i64>,
4686    indices: Vec<Index>,
4687    hot_bytes: u64,
4688    /// v6.7.0 — cached count of rows currently materialised in the
4689    /// cold tier via `RowLocator::Cold` entries across THIS table's
4690    /// indices. Populated by `ANALYZE` (walks every BTree index and
4691    /// counts Cold locators); the count survives until the next
4692    /// ANALYZE recomputes it. Surfaced via `spg_statistic.cold_row_count`
4693    /// and `spg_stat_segment.table_name`.
4694    ///
4695    /// Honest scope: this is a CACHED count, not a live one.
4696    /// Freezer / promote / DELETE don't currently update the cache
4697    /// incrementally — they invalidate it by setting the
4698    /// `cold_row_count_stale` flag, and the next ANALYZE re-walks.
4699    /// Incremental maintenance is a v6.7.x candidate if observation
4700    /// shows the ANALYZE walk cost dominates.
4701    cold_row_count: u64,
4702    /// v6.7.0 — set when the cached `cold_row_count` may be wrong
4703    /// because rows moved into / out of the cold tier since the last
4704    /// ANALYZE. The virtual-table surface reports the cached value
4705    /// regardless (operators run ANALYZE to refresh).
4706    cold_row_count_stale: bool,
4707    /// v7.34 (crash-recovery P0 #2) — row-level redo capture buffer.
4708    /// `None` (default, in-memory mode) captures nothing — zero overhead.
4709    /// `Some` (set by the engine when persistence is on, before a
4710    /// mutating call) makes `insert` / `update_row` / `delete_rows`
4711    /// record the physical [`RowChange`] they applied, which the engine
4712    /// drains after the statement and writes to the WAL in place of the
4713    /// SQL text. Transient: never serialized; a `Catalog::clone` between
4714    /// enable and drain copies it (cheap — empty in the steady state).
4715    redo_log: Option<Vec<RowChange>>,
4716    /// v7.39 (round 215) — per-`EXCLUDE`-constraint range-overlap indexes,
4717    /// one per single-`&&` constraint on an integer-keyable range column.
4718    /// Maintained incrementally on insert / update / rebuild (mirroring the
4719    /// BTree secondary indexes); NOT serialized — rebuilt from the schema's
4720    /// exclusion constraints on load. Empty for tables with no EXCLUDE
4721    /// constraint (the common case), so `Table::clone` pays nothing.
4722    excl_indexes: Vec<ExclRangeIndex>,
4723    /// v7.38.2 (R2) — incremental write-set track for the RC rebase.
4724    /// `extract_tx_writeset` used to full-scan every header per call —
4725    /// ~200 µs on a 20k-row table, per in-transaction statement, every
4726    /// time a concurrent COMMIT moved the epoch; on tpcb's 100k-row
4727    /// accounts that scan was the c2 concurrency cliff itself. The
4728    /// three version-marking funnels (`insert_with_xmin`,
4729    /// `mark_row_deleted`, `mark_rows_deleted`) record here instead.
4730    ///
4731    /// One track per table, keyed by the LAST writer version: a shadow
4732    /// belongs to one transaction, so a different version claiming the
4733    /// table simply replaces the track (on the committed base that
4734    /// makes memory bounded by the last writer's footprint). Extraction
4735    /// verifies every recorded position still carries the version —
4736    /// any mismatch (compaction, inherited track, pre-track rows)
4737    /// falls back to the full scan, so the fast path can be wrong
4738    /// about NOTHING, only slow.
4739    tx_write_track: Option<TxWriteTrack>,
4740    /// v7.39 (round 493) — the snapshot floor below which a deleted row
4741    /// version is invisible to everyone, as of the statement now running.
4742    ///
4743    /// Runtime only: never serialised, and `0` (the default) prunes
4744    /// nothing, so any path that forgets to set it is merely slower, not
4745    /// wrong. The engine sets it from `vacuum_oldest_active()` — the same
4746    /// floor `vacuum` itself takes — before the statement's inserts.
4747    prune_horizon: u64,
4748}
4749
4750/// Catalog: insertion-ordered `Vec<Table>` for stable iter / serialize,
4751/// plus a `BTreeMap<String, usize>` sidecar index so `get` / `get_mut`
4752/// run in O(log n) instead of the old linear scan with per-element
4753/// string compares.
4754///
4755/// A pure `BTreeMap<String, Table>` was tried in an interim version
4756/// of v3.1.2 and regressed the single-table catalog benches by ~10%
4757/// (the per-element `BTreeMap` overhead outweighs the lookup win
4758/// when n is small). The sidecar shape preserves the insertion-order
4759/// iteration the on-disk encoding relies on and keeps `last_mut`
4760/// (used by the deserialize hot path) cheap.
4761/// v7.39 (pg_stat blks knife) — catalog-wide cold-tier read counter
4762/// backing pg_stat_database.blks_read. Row-granular (SPG has no 8 KB
4763/// page notion): one cold-segment row resolution = one "block read",
4764/// one hot row access = one "block hit" — the hit RATIO monitoring
4765/// dashboards compute keeps its meaning. Volatile like PG's stats.
4766#[derive(Debug, Default)]
4767pub struct ColdReadStats {
4768    pub cold_reads: core::sync::atomic::AtomicU64,
4769}
4770
4771impl Clone for ColdReadStats {
4772    fn clone(&self) -> Self {
4773        Self {
4774            cold_reads: core::sync::atomic::AtomicU64::new(
4775                self.cold_reads.load(core::sync::atomic::Ordering::Relaxed),
4776            ),
4777        }
4778    }
4779}
4780
4781/// 7.38.1 S3.1 (D4) — the non-table catalog families that carry a
4782/// per-transaction dirty window (see `Catalog::dirty_nontable`). One
4783/// entry class per side-map the poisoned-commit merge reconciles.
4784#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
4785pub enum NonTableKind {
4786    Sequence,
4787    View,
4788    MaterializedView,
4789    EnumType,
4790    DomainType,
4791    CompositeType,
4792}
4793
4794#[derive(Debug, Clone, Default)]
4795pub struct Catalog {
4796    /// v7.39 (pg_stat blks knife) — see [`ColdReadStats`].
4797    pub cold_read_stats: ColdReadStats,
4798    tables: Vec<Table>,
4799    /// `name → tables[index]`. Kept in lock-step with `tables`.
4800    /// `create_table` is the only write path.
4801    by_name: BTreeMap<String, usize>,
4802    /// v7.39 (round 436) — the current session's temporary-table namespace.
4803    /// A temp table is stored under `<prefix><name>`, and every lookup tries
4804    /// that first: exactly PG's `pg_temp` search-path rule, and MySQL's
4805    /// "a TEMPORARY table shadows a permanent one of the same name".
4806    ///
4807    /// Process-local, never serialised: the engine sets it per session, and
4808    /// a catalog read back from disk starts with none. Kept here rather than
4809    /// at each of the ~170 engine call sites because `by_name` is private —
4810    /// this is the ONE place a table name becomes an index.
4811    temp_prefix: Option<String>,
4812    /// v7.39 (round 496) — the names of tables this catalog handle has had
4813    /// changed since the set was last cleared.
4814    ///
4815    /// Runtime only, never serialised. A transaction's shadow catalog
4816    /// clears it at BEGIN, so at COMMIT the set is exactly the tables the
4817    /// transaction changed — which is what lets a commit that cannot use
4818    /// the row-level merge install only those tables instead of the whole
4819    /// catalog, leaving another session's concurrent work in place.
4820    ///
4821    /// Recorded where the change actually happens (`get_mut`,
4822    /// `create_table`, `drop_table`) rather than from the statement
4823    /// classifier: round 494 tried classification for a correctness gate
4824    /// and it was wrong, because `SELECT lo_write(…)` reads as read-only.
4825    dirty_tables: alloc::collections::BTreeSet<String>,
4826    /// 7.38.1 S3.1 (D4) — the non-table twin of `dirty_tables`: which
4827    /// sequences / views / matviews / enum / domain / composite types
4828    /// THIS window created, altered, renamed or dropped. Counter
4829    /// advances (`nextval`) deliberately do NOT record — counter
4830    /// values merge via `sequence_counters` / `restore_sequence_
4831    /// counters`, and a tx that only consumed ids must not shadow a
4832    /// neighbour's ALTER SEQUENCE. Cleared by `clear_dirty_tables`
4833    /// (one window, both records).
4834    dirty_nontable: alloc::collections::BTreeSet<(NonTableKind, String)>,
4835    /// v7.37.15 (Phase C.1) — monotonic allocator for stable
4836    /// [`RelId`](row_header::RelId)s. Pre-incremented on each
4837    /// `create_table` so real ids start at 1 (0 is `UNASSIGNED`);
4838    /// never reused even after `DROP TABLE`, so a stale lock / redo
4839    /// reference is detectable. Process-local bookkeeping — not yet
4840    /// serialised; `deserialize` re-assigns dense ids on load (the
4841    /// V6 envelope, Phase C.6, will round-trip real ids).
4842    next_rel_id: u64,
4843    /// v5.1: in-memory cold-tier segments. Side-loaded via
4844    /// [`Catalog::load_segment_bytes`] — they live outside the
4845    /// catalog snapshot (caller persists them as separate files
4846    /// and re-loads on boot, until v5.3's `CatalogManifest` makes
4847    /// that wiring automatic). `RowLocator::Cold { segment_id, .. }`
4848    /// indexes this `Vec`. Cleared on `Catalog::new` / fresh
4849    /// `deserialize`.
4850    ///
4851    /// `Arc` wrap keeps `Catalog::clone` at O(N segments) bumps
4852    /// (rather than O(total segment bytes) memcpy) so the v4.42
4853    /// group-commit pre-image rollback invariant — clone is
4854    /// effectively free — survives the cold-tier addition.
4855    ///
4856    /// v6.7.3 — slots became `Option<…>` so cold-segment compaction
4857    /// can tombstone merged sources without breaking the
4858    /// `segment_id = index_into_vec` contract that on-disk
4859    /// `RowLocator::Cold { segment_id }` already serialized.
4860    /// `None` slot = the segment was retired by compaction; the
4861    /// physical file may still be on disk (next CHECKPOINT writes
4862    /// a manifest that no longer lists it, and the file becomes
4863    /// an orphan eligible for offline cleanup).
4864    cold_segments: Vec<Option<Arc<OwnedSegment>>>,
4865    /// v7.12.4 — user-defined functions (PL/pgSQL + SQL).
4866    /// Keyed by function name (PG overloading is out of scope).
4867    /// Bodies are stored as the raw source text the parser saw
4868    /// between `$$ ... $$`; the engine re-parses on each
4869    /// invocation. This keeps `spg-storage` free of `spg-sql`
4870    /// dependency — same pattern as partial-index predicates.
4871    functions: BTreeMap<String, FunctionDef>,
4872    /// v7.12.4 — triggers in insertion order. PG18-measured (round
4873    /// 753): PG fires same-event triggers in NAME order (a_trig
4874    /// before z_trig regardless of creation order); SPG fires in
4875    /// insertion order — a real divergence, ledgered as F31-B2.
4876    triggers: Vec<TriggerDef>,
4877    /// v7.39 (round 139) — query-rewrite RULEs, flat like triggers.
4878    rules: Vec<RuleDef>,
4879    /// v7.39 (round 280) — extended-statistics objects. Recorded so a
4880    /// pg_dump restores them and reflection reports them; the planner
4881    /// does not consult them yet.
4882    statistics_ext: Vec<StatisticsExtDef>,
4883    /// v7.39 (round 287) — server-side large objects, keyed by OID.
4884    /// PG stores them as 2 KB pages in `pg_largeobject`; the page split
4885    /// is a storage detail of ITS heap, so SPG holds the whole byte
4886    /// string and renders the pages on read. What must match is the
4887    /// observable surface: the OIDs, the bytes, and the page rows.
4888    large_objects: alloc::collections::BTreeMap<u32, Vec<u8>>,
4889    /// v7.17.0 — catalogued SEQUENCE objects (Phase 1.1). Each
4890    /// `nextval(name)` reaches in here, atomically increments
4891    /// `last_value` / flips `is_called`, returns the new value.
4892    /// Persisted in catalog FILE_VERSION 26+; older catalogs
4893    /// deserialise with an empty map.
4894    sequences: BTreeMap<String, SequenceDef>,
4895    /// v7.39 (read01 round 60) — the `public` schema's ACL (PG
4896    /// `pg_namespace.nspacl`). EMPTY = PG's default, which is not "nothing":
4897    /// PUBLIC holds USAGE and the owner holds USAGE + CREATE. Materialised on
4898    /// the first GRANT / REVOKE, exactly like a table's relacl.
4899    schema_acl: Vec<AclItem>,
4900    /// v7.39 (read01 round 60) — the database's ACL. EMPTY = PG's default:
4901    /// PUBLIC holds CONNECT + TEMPORARY, the owner holds all three.
4902    database_acl: Vec<AclItem>,
4903    /// v7.17.0 — catalogued VIEW objects (Phase 1.2). Each
4904    /// `SELECT FROM v` at engine exec-time looks up `v` here and
4905    /// prepends the view body as a synthetic CTE. Persisted in
4906    /// catalog FILE_VERSION 27+; older catalogs deserialise with
4907    /// an empty map.
4908    views: BTreeMap<String, ViewDef>,
4909    /// v7.17.0 — catalogued MATERIALIZED VIEW source registry
4910    /// (Phase 1.3). Maps name → SELECT source. The materialised
4911    /// rows themselves live as a regular `Table` with the same
4912    /// name; REFRESH re-parses + re-executes the source against
4913    /// the table. Persisted in catalog FILE_VERSION 28+;
4914    /// older catalogs deserialise with an empty map.
4915    materialized_views: BTreeMap<String, String>,
4916    /// v7.17.0 — catalogued user-defined ENUM types (Phase 1.4).
4917    /// Maps name → label list. Columns reference these by name
4918    /// via `ColumnSchema.user_enum_type`. Persisted in catalog
4919    /// FILE_VERSION 29+; older catalogs deserialise with an empty
4920    /// map.
4921    enum_types: BTreeMap<String, EnumDef>,
4922    /// v7.17.0 — catalogued user-defined DOMAIN types (Phase 1.5).
4923    /// Maps name → base + CHECK constraints. Columns reference
4924    /// these by name via `ColumnSchema.user_domain_type`.
4925    /// Persisted in catalog FILE_VERSION 30+; older catalogs
4926    /// deserialise with an empty map.
4927    domain_types: BTreeMap<String, DomainDef>,
4928    /// v7.39 (read01 round 50) — `COMMENT ON <kind> <obj> IS '…'` store.
4929    /// Keyed by a canonical `"<kind>:<name>"` string (`"table:t"`,
4930    /// `"column:t.c"`, `"index:i"`, `"view:v"`, …) so a new commentable
4931    /// object kind needs no schema change. `COMMENT … IS NULL` removes the
4932    /// entry. Persisted in catalog FILE_VERSION 61+; older catalogs
4933    /// deserialise with an empty map. Read back by obj_description /
4934    /// col_description and the pg_description view.
4935    comments: BTreeMap<String, String>,
4936    /// v7.39 (round 547) — PG's `pg_db_role_setting`: the GUC defaults
4937    /// `ALTER ROLE … SET` / `ALTER DATABASE … SET` record, applied when
4938    /// a session starts.
4939    ///
4940    /// Keyed exactly as PG keys it — `(database, role)` where an empty
4941    /// name is PG's oid 0, meaning "all". So `ALTER ROLE ALL SET` is
4942    /// `("", "")`, `ALTER DATABASE d SET` is `(d, "")`, `ALTER ROLE r
4943    /// SET` is `("", r)` and `ALTER ROLE r IN DATABASE d SET` is
4944    /// `(d, r)`. The value is that scope's parameter list.
4945    db_role_settings: BTreeMap<(String, String), BTreeMap<String, String>>,
4946    /// v7.39 (round 550) — replication slots, by name.
4947    ///
4948    /// A slot in PG is two things: a named record, and a reservation
4949    /// that holds WAL back. SPG keeps the record — which is what every
4950    /// setup script and monitoring query reads — and reports
4951    /// `wal_status = 'unreserved'`, PG's own word for a slot that no
4952    /// longer holds WAL. The whole family used to answer NULL and
4953    /// report success, so `pg_drop_replication_slot('nosuchslot')` said
4954    /// it worked and a setup script created nothing.
4955    ///
4956    /// Value: (plugin, slot_type). `plugin` is empty for a physical slot.
4957    replication_slots: BTreeMap<String, (String, String)>,
4958    /// v7.38.18 (S1) — the collation this database was CREATED with, and
4959    /// the one every text column that declares none is compared under.
4960    ///
4961    /// `None` means `C`, which is what every database written by every
4962    /// earlier version was built with — so an upgrade changes no answer
4963    /// and rebuilds no index. That is the whole migration story, and it
4964    /// is why this is an `Option` rather than a `String` defaulting to
4965    /// `"C"`.
4966    ///
4967    /// Set once, at creation, and never after. PostgreSQL refuses
4968    /// `ALTER DATABASE … LC_COLLATE` and the reason is the one that
4969    /// matters here too: every index key in this database was built
4970    /// under this collation, so it cannot move out from under them.
4971    /// See `docs/DESIGN-2026-08-23-collation.md`.
4972    db_collation: Option<String>,
4973    /// v7.37.42-T2 ζ-B — catalogued user-defined COMPOSITE types
4974    /// (`CREATE TYPE name AS (field_name field_type, …)`). Columns
4975    /// reference these by name via
4976    /// `ColumnSchema.user_composite_type` (parallel to
4977    /// `user_enum_type` / `user_domain_type`). Persisted in catalog
4978    /// FILE_VERSION 52+; older catalogs deserialise with an empty
4979    /// map.
4980    composite_types: BTreeMap<String, CompositeDef>,
4981    /// v7.17.0 — schema-namespace registry (Phase 1.6). Tracks
4982    /// which schemas exist. `public`, `pg_catalog`, and
4983    /// `information_schema` are built-in and always present.
4984    /// Schema-qualified table references still strip the prefix
4985    /// at lookup time per v7.16-and-earlier — full
4986    /// schema-as-isolation is v7.18+ scope. Persisted in catalog
4987    /// FILE_VERSION 31+; older catalogs deserialise with just
4988    /// the built-ins.
4989    schemas: alloc::collections::BTreeSet<String>,
4990}
4991
4992/// v7.12.4 — catalogued user-defined function. `body` is the raw
4993/// source text between `$$ ... $$`; the engine re-parses it on
4994/// invocation. This keeps the storage codec stable when the
4995/// PL/pgSQL surface grows (no breaking-change risk on the disk
4996/// format).
4997// v7.39 (round 322, V46) — no longer `Eq`: COST / ROWS are f64, as in PG.
4998#[derive(Debug, Clone, PartialEq)]
4999pub struct FunctionDef {
5000    pub name: String,
5001    /// Display form of the argument list, e.g.
5002    /// `"(name TEXT, ts TIMESTAMP)"`. Empty `"()"` for the trigger
5003    /// function shape. Parser-side canonicalised before storage.
5004    pub args_repr: String,
5005    /// Display form of the return type, e.g. `"TRIGGER"` /
5006    /// `"INT"` / `"SETOF text"`. The engine special-cases
5007    /// `"TRIGGER"` (case-insensitive) to gate trigger-only
5008    /// semantics (NEW/OLD).
5009    pub returns: String,
5010    /// `LANGUAGE` clause, lowercased. `"plpgsql"` / `"sql"`.
5011    pub language: String,
5012    /// Source body of the function. PL/pgSQL: includes the
5013    /// surrounding `BEGIN ... END;`. SQL: includes the
5014    /// statement(s). The engine re-parses on invocation; bad
5015    /// bodies surface as a parse error at CALL time, not CREATE.
5016    pub body: String,
5017    /// v7.39 (read01 round 61) — the role that ran CREATE FUNCTION.
5018    pub owner: Option<String>,
5019    /// v7.39 (read01 round 61) — explicit GRANTs (PG `pg_proc.proacl`). EMPTY
5020    /// is NOT "nobody may call it": PG grants EXECUTE to PUBLIC by default, and
5021    /// leaves proacl NULL to say so. The list materialises on the first
5022    /// GRANT / REVOKE.
5023    pub acl: Vec<AclItem>,
5024    /// v7.39 (round 322, V46) — `IMMUTABLE` / `STRICT` / `PARALLEL SAFE` /
5025    /// `SECURITY DEFINER` / `LEAKPROOF` / `COST` / `ROWS`. `strict` is the
5026    /// only one with execution semantics today (a NULL argument yields a
5027    /// NULL result without running the body); the rest are recorded so
5028    /// `pg_get_functiondef` and `pg_proc` report what was declared.
5029    pub volatility: u8,
5030    pub strict: bool,
5031    pub security_definer: bool,
5032    pub leakproof: bool,
5033    pub parallel: u8,
5034    pub cost: Option<f64>,
5035    pub rows: Option<f64>,
5036}
5037
5038/// v7.39 (round 322, V46) — `FunctionDef.volatility` codes: PG's
5039/// `pg_proc.provolatile` letters.
5040pub const FN_VOLATILE: u8 = b'v';
5041pub const FN_IMMUTABLE: u8 = b'i';
5042pub const FN_STABLE: u8 = b's';
5043
5044/// v7.39 (round 322, V46) — `FunctionDef.parallel` codes: PG's
5045/// `pg_proc.proparallel` letters.
5046pub const FN_PARALLEL_UNSAFE: u8 = b'u';
5047pub const FN_PARALLEL_RESTRICTED: u8 = b'r';
5048pub const FN_PARALLEL_SAFE: u8 = b's';
5049
5050/// v7.39 (round 315, V19) — which catalogued function does a persisted
5051/// ACL key refer to?
5052///
5053/// The key was computed by whichever formula was current when the image
5054/// was written, and the multi-word fix changed that formula for bare
5055/// types like `double precision`. A miss therefore does NOT mean "no
5056/// such function": an older image's key would land nowhere and its owner
5057/// and grants would be dropped in silence. Exact match first, then the
5058/// pre-fix formula.
5059#[must_use]
5060pub fn resolve_stored_function_key(
5061    functions: &BTreeMap<String, FunctionDef>,
5062    stored: &str,
5063) -> Option<String> {
5064    if functions.contains_key(stored) {
5065        return Some(stored.to_string());
5066    }
5067    functions
5068        .values()
5069        .find(|f| function_signature_key_legacy(&f.name, &f.args_repr) == stored)
5070        .map(|f| function_signature_key(&f.name, &f.args_repr))
5071}
5072
5073/// v7.39 (round 344, V49) — re-exported from [`spg_sql`], which owns the
5074/// SQL type spellings. This crate carried a byte-identical copy because
5075/// the two were siblings that did not depend on each other; spg-sql is a
5076/// dependency-free leaf, so the dependency is acyclic and the publish
5077/// order already puts it first. One list, one place to keep it right.
5078pub use spg_sql::parser::is_multiword_type_phrase;
5079
5080/// v7.39 (round 315, V19) — the signature key as computed BEFORE the
5081/// multi-word fix, used only to recognise what an older image wrote.
5082///
5083/// The function catalogue recomputes its keys from the stored name and
5084/// argument text on load, so it needs no migration. The ACL block does
5085/// not: it persists the computed key as a string and matches on it. A
5086/// key that changed shape would simply fail to match, and the owner and
5087/// grants would be dropped without a word — so the loader falls back to
5088/// this when the stored key finds nothing.
5089#[must_use]
5090pub fn function_signature_key_legacy(name: &str, args_repr: &str) -> String {
5091    let inner = args_repr
5092        .trim()
5093        .trim_start_matches('(')
5094        .trim_end_matches(')');
5095    let types: Vec<String> = if inner.trim().is_empty() {
5096        Vec::new()
5097    } else {
5098        inner
5099            .split(',')
5100            .map(|part| {
5101                let mut words: Vec<&str> = part.split_whitespace().collect();
5102                if !words.is_empty()
5103                    && (words[0].eq_ignore_ascii_case("OUT")
5104                        || words[0].eq_ignore_ascii_case("INOUT"))
5105                {
5106                    words.remove(0);
5107                }
5108                let ty = if words.len() >= 2 {
5109                    words[1..].join(" ")
5110                } else {
5111                    words.first().map_or(String::new(), |w| (*w).to_string())
5112                };
5113                normalize_type_name(&ty)
5114            })
5115            .collect()
5116    };
5117    format!("{}({})", name.to_ascii_lowercase(), types.join(","))
5118}
5119
5120pub fn function_signature_key(name: &str, args_repr: &str) -> String {
5121    let types = function_arg_types(args_repr);
5122    format!("{}({})", name.to_ascii_lowercase(), types.join(","))
5123}
5124
5125/// The declared argument TYPES of a function, out of its `args_repr`
5126/// (`"(x INT, y DOUBLE PRECISION)"` → `["int", "float"]`). An entry may be a
5127/// bare type with no name (`"(INT)"`).
5128#[must_use]
5129pub fn function_arg_types(args_repr: &str) -> Vec<String> {
5130    let inner = args_repr
5131        .trim()
5132        .trim_start_matches('(')
5133        .trim_end_matches(')');
5134    if inner.trim().is_empty() {
5135        return Vec::new();
5136    }
5137    inner
5138        .split(',')
5139        .map(|part| {
5140            let mut words: Vec<&str> = part.split_whitespace().collect();
5141            // `OUT x INT` / `INOUT x INT` — the mode is not part of the type.
5142            if !words.is_empty()
5143                && (words[0].eq_ignore_ascii_case("OUT") || words[0].eq_ignore_ascii_case("INOUT"))
5144            {
5145                words.remove(0);
5146            }
5147            // v7.39 (round 315, V19) — two or more words is USUALLY
5148            // `name TYPE`, but not when the type itself is spelled in
5149            // several words. `double precision` was read as a parameter
5150            // named "double" of type "precision", so it keyed differently
5151            // from `x double precision` — the same signature written two
5152            // ways did not resolve to the same function. Decide by asking
5153            // whether the whole phrase names a type first; only then is
5154            // the leading word a parameter name.
5155            let whole = words.join(" ");
5156            let ty = if words.len() >= 2 && !is_multiword_type_phrase(&whole) {
5157                words[1..].join(" ")
5158            } else {
5159                whole
5160            };
5161            normalize_type_name(&ty)
5162        })
5163        .collect()
5164}
5165
5166/// v7.39 (read01 round 65) — the declared argument NAMES of a function (`""` for
5167/// a bare type with no name).
5168#[must_use]
5169pub fn function_arg_names(args_repr: &str) -> Vec<String> {
5170    let inner = args_repr
5171        .trim()
5172        .trim_start_matches('(')
5173        .trim_end_matches(')');
5174    if inner.trim().is_empty() {
5175        return Vec::new();
5176    }
5177    inner
5178        .split(',')
5179        .map(|part| {
5180            let mut words: Vec<&str> = part.split_whitespace().collect();
5181            if !words.is_empty()
5182                && (words[0].eq_ignore_ascii_case("OUT") || words[0].eq_ignore_ascii_case("INOUT"))
5183            {
5184                words.remove(0);
5185            }
5186            if words.len() >= 2 {
5187                words[0].to_string()
5188            } else {
5189                String::new()
5190            }
5191        })
5192        .collect()
5193}
5194
5195/// Fold PG's type aliases so a signature key is stable across spellings.
5196/// Unknown names pass through lower-cased — consistency is what the key needs.
5197#[must_use]
5198pub fn normalize_type_name(ty: &str) -> String {
5199    let t = ty.trim().to_ascii_lowercase();
5200    // Peel a precision/length modifier: `numeric(10,2)`, `varchar(64)`.
5201    let base = t.split_once('(').map_or(t.as_str(), |(h, _)| h).trim();
5202    match base {
5203        "int" | "int4" | "integer" => "int",
5204        "bigint" | "int8" => "bigint",
5205        "smallint" | "int2" => "smallint",
5206        "text" | "varchar" | "character varying" | "char" | "character" | "bpchar" => "text",
5207        "bool" | "boolean" => "bool",
5208        "float" | "float8" | "double precision" => "float",
5209        "real" | "float4" => "real",
5210        "numeric" | "decimal" => "numeric",
5211        "timestamptz" | "timestamp with time zone" => "timestamptz",
5212        "timestamp" | "timestamp without time zone" => "timestamp",
5213        other => other,
5214    }
5215    .to_string()
5216}
5217
5218/// v7.12.4 — catalogued trigger. References its function by
5219/// name; the function must exist at TRIGGER creation time
5220/// (forward references are deferred to v7.12.5+).
5221#[derive(Debug, Clone, PartialEq, Eq)]
5222pub struct TriggerDef {
5223    pub name: String,
5224    /// Watched table. Trigger is dropped when the table drops.
5225    pub table: String,
5226    /// `"BEFORE"` / `"AFTER"` / `"INSTEAD OF"`. Stored as the
5227    /// uppercased keyword so deserialised catalogs round-trip
5228    /// without canonicalisation surprises.
5229    pub timing: String,
5230    /// Each entry is one of `"INSERT"` / `"UPDATE"` / `"DELETE"`
5231    /// / `"TRUNCATE"`. `INSERT OR UPDATE` parses to two entries.
5232    pub events: Vec<String>,
5233    /// `"ROW"` / `"STATEMENT"`. v7.12.4 ships `"ROW"` only;
5234    /// `"STATEMENT"` parses and persists but the executor
5235    /// refuses it at trigger fire time.
5236    pub for_each: String,
5237    /// Name of the PL/pgSQL function to invoke.
5238    pub function: String,
5239    /// v7.13.0 — `UPDATE OF col, col, …` column-list filter
5240    /// (mailrs round-5 G7). Non-empty means the trigger fires
5241    /// only when at least one of these columns appears in the
5242    /// UPDATE's SET list. Empty = no column filter. Stored in
5243    /// catalog FILE_VERSION 23+; older catalogs deserialise with
5244    /// an empty vec.
5245    pub update_columns: Vec<String>,
5246    /// v7.16.1 — whether the trigger fires when its watched
5247    /// event occurs. Toggled by `ALTER TABLE … { ENABLE |
5248    /// DISABLE } TRIGGER …`; pg_dump --disable-triggers wraps
5249    /// every data block with a DISABLE/ENABLE pair so the
5250    /// rows already-computed in prod don't get re-rewritten.
5251    /// Defaults to `true` at CREATE TRIGGER time. Stored in
5252    /// catalog FILE_VERSION 25+; older catalogs deserialise
5253    /// with `enabled = true`.
5254    pub enabled: bool,
5255    /// v7.39 (round 138) — the deparsed `WHEN ( condition )` predicate text
5256    /// (re-parsed at fire time to filter row triggers). Empty = no WHEN.
5257    /// Persisted from FILE_VERSION 70; older catalogs read back empty.
5258    pub when_condition: String,
5259}
5260
5261/// v7.39 (round 280) — one `CREATE STATISTICS` object.
5262#[derive(Debug, Clone, PartialEq, Eq)]
5263pub struct StatisticsExtDef {
5264    pub name: String,
5265    pub table: String,
5266    /// PG's single-letter kinds: `d` ndistinct, `f` dependencies,
5267    /// `m` mcv. PG's default set is all three.
5268    pub kinds: Vec<String>,
5269    pub columns: Vec<String>,
5270}
5271
5272/// v7.39 (round 139) — a catalogued query-rewrite RULE. Stored flat like
5273/// `TriggerDef`, keyed by `(name, table)`. Command / WHEN text is deparsed SQL
5274/// re-parsed at rewrite time (the same round-trip trick as
5275/// `TriggerDef.when_condition`). Persisted from FILE_VERSION 71.
5276#[derive(Debug, Clone, PartialEq, Eq)]
5277pub struct RuleDef {
5278    pub name: String,
5279    pub table: String,
5280    /// Event keyword, uppercased: `INSERT` / `UPDATE` / `DELETE` / `SELECT`.
5281    pub event: String,
5282    /// `true` = `DO INSTEAD`, `false` = `DO ALSO`.
5283    pub instead: bool,
5284    /// Deparsed `WHERE` predicate text; empty = unconditional.
5285    pub when_condition: String,
5286    /// Deparsed DO command statements; empty = `NOTHING`.
5287    pub commands: Vec<String>,
5288}
5289
5290/// v7.17.0 — catalogued SEQUENCE. PG semantics: a counter object
5291/// returning monotonically increasing values via `nextval(name)`.
5292/// `last_value` is the most recent value handed out; `is_called`
5293/// is false until the first `nextval`/`setval`. Stored separately
5294/// from tables in the catalog.
5295#[derive(Debug, Clone, PartialEq, Eq)]
5296pub struct SequenceDef {
5297    pub name: String,
5298    /// Data type — narrows the i64 range. PG default BIGINT.
5299    pub data_type: SequenceDataType,
5300    pub start: i64,
5301    pub increment: i64,
5302    pub min_value: i64,
5303    pub max_value: i64,
5304    pub cache: i64,
5305    pub cycle: bool,
5306    /// `OWNED BY` target — `(table, column)` or NONE.
5307    pub owned_by: Option<(String, String)>,
5308    /// Most recently handed-out value. Meaningless when
5309    /// `is_called == false`; in that case the NEXT `nextval`
5310    /// will return `start`.
5311    pub last_value: i64,
5312    pub is_called: bool,
5313    /// v7.39 (read01 round 60) — the role that ran CREATE SEQUENCE. `None` = an
5314    /// image written before FILE_VERSION 66, which predates sequence owners.
5315    pub owner: Option<String>,
5316    /// v7.39 (read01 round 60) — explicit GRANTs on this sequence. A sequence's
5317    /// meaningful privileges are SELECT (`currval`), UPDATE (`setval`) and
5318    /// USAGE (`nextval`).
5319    pub acl: Vec<AclItem>,
5320}
5321
5322/// v7.17.0 — sequence integer width.
5323#[derive(Debug, Clone, Copy, PartialEq, Eq)]
5324pub enum SequenceDataType {
5325    SmallInt,
5326    Int,
5327    BigInt,
5328}
5329
5330/// v7.17.0 Phase 1.6 — built-in schema names that every Catalog
5331/// understands without an explicit CREATE SCHEMA. Used by
5332/// [`Catalog::schema_exists`] and the engine's schema-qualified
5333/// lookup path.
5334#[must_use]
5335pub fn is_builtin_schema(name: &str) -> bool {
5336    name.eq_ignore_ascii_case("public")
5337        || name.eq_ignore_ascii_case("pg_catalog")
5338        || name.eq_ignore_ascii_case("information_schema")
5339}
5340
5341/// v7.17.0 — parse a PG-canonical UUID text representation into the
5342/// 16-byte network-order layout used by `Value::Uuid`. Accepted input
5343/// shapes (all case-insensitive):
5344///   * Canonical hyphenated 8-4-4-4-12 (`550e8400-e29b-41d4-a716-446655440000`)
5345///   * Unhyphenated 32-char hex (`550e8400e29b41d4a716446655440000`)
5346///   * Either form wrapped in `{ ... }`
5347///
5348/// Returns `None` for any malformed input (wrong length, non-hex
5349/// characters, misplaced hyphens). The caller surfaces a SQL error
5350/// at coercion time — silent acceptance of garbage would mask
5351/// application bugs and is exactly the divergence from PG that
5352/// breaks the 0-change cutover promise.
5353#[must_use]
5354pub fn parse_uuid_str(input: &str) -> Option<[u8; 16]> {
5355    let s = input.trim();
5356    // Strip surrounding braces if present.
5357    let s = if let Some(inner) = s.strip_prefix('{').and_then(|x| x.strip_suffix('}')) {
5358        inner
5359    } else {
5360        s
5361    };
5362    // Two valid shapes after braces are stripped: 32 hex chars or
5363    // the canonical 36-char hyphenated form.
5364    let hex: String = match s.len() {
5365        32 => s.to_ascii_lowercase(),
5366        36 => {
5367            // Hyphens must be exactly at positions 8, 13, 18, 23.
5368            let b = s.as_bytes();
5369            if b[8] != b'-' || b[13] != b'-' || b[18] != b'-' || b[23] != b'-' {
5370                return None;
5371            }
5372            let mut out = String::with_capacity(32);
5373            out.push_str(&s[0..8]);
5374            out.push_str(&s[9..13]);
5375            out.push_str(&s[14..18]);
5376            out.push_str(&s[19..23]);
5377            out.push_str(&s[24..36]);
5378            out.make_ascii_lowercase();
5379            out
5380        }
5381        _ => return None,
5382    };
5383    let bytes = hex.as_bytes();
5384    let mut out = [0u8; 16];
5385    for i in 0..16 {
5386        let hi = hex_nibble(bytes[i * 2])?;
5387        let lo = hex_nibble(bytes[i * 2 + 1])?;
5388        out[i] = (hi << 4) | lo;
5389    }
5390    Some(out)
5391}
5392
5393fn hex_nibble(b: u8) -> Option<u8> {
5394    match b {
5395        b'0'..=b'9' => Some(b - b'0'),
5396        b'a'..=b'f' => Some(10 + b - b'a'),
5397        b'A'..=b'F' => Some(10 + b - b'A'),
5398        _ => None,
5399    }
5400}
5401
5402/// v7.17.0 — render a `Value::Uuid` payload as the canonical
5403/// lowercase 8-4-4-4-12 hyphenated form PG `text` cast surfaces.
5404#[must_use]
5405pub fn format_uuid(b: &[u8; 16]) -> String {
5406    const HEX: &[u8; 16] = b"0123456789abcdef";
5407    let mut out = String::with_capacity(36);
5408    for (i, byte) in b.iter().enumerate() {
5409        if matches!(i, 4 | 6 | 8 | 10) {
5410            out.push('-');
5411        }
5412        out.push(HEX[(byte >> 4) as usize] as char);
5413        out.push(HEX[(byte & 0x0f) as usize] as char);
5414    }
5415    out
5416}
5417
5418/// v7.17.0 Phase 1.5 — catalogued user-defined DOMAIN. A domain
5419/// is a named CHECK-constrained alias over a built-in type;
5420/// columns bound to it inherit the base type plus the CHECK
5421/// predicates + NOT NULL + DEFAULT at INSERT/UPDATE time.
5422/// v7.37.17 (Phase E RC rebase) — the write-set one writer version left
5423/// on a table, addressed by stable [`row_header::RowId`]s so it can be
5424/// replayed onto a fresher clone of the relation whose physical slots
5425/// differ. Produced by [`Table::extract_tx_writeset`], consumed by
5426/// [`Table::replay_tx_writeset`].
5427#[derive(Debug, Clone, Default)]
5428pub struct TxWriteSet {
5429    /// INSERTs and UPDATE-new-versions (`header.xmin == v`).
5430    pub inserted: Vec<(row_header::RowId, Row<'static>)>,
5431    /// DELETE / UPDATE-old-version targets (`header.xmax == v`).
5432    pub tombstoned: Vec<row_header::RowId>,
5433}
5434
5435impl TxWriteSet {
5436    #[must_use]
5437    pub fn is_empty(&self) -> bool {
5438        self.inserted.is_empty() && self.tombstoned.is_empty()
5439    }
5440}
5441
5442/// v7.39 (round 260) — one named CHECK on a domain. PG auto-names an
5443/// unnamed one `<domain>_check`, then `_check1`, `_check2`, … (probed).
5444#[derive(Debug, Clone, PartialEq, Eq)]
5445pub struct DomainCheck {
5446    pub name: String,
5447    /// The predicate source, referencing the pseudo-column `VALUE`.
5448    pub expr: String,
5449}
5450
5451/// `default` / `checks` are stored as Display-form source so
5452/// `spg-storage` stays free of `spg-sql` dependency — same
5453/// pattern as FunctionDef / ViewDef.
5454#[derive(Debug, Clone, PartialEq, Eq)]
5455pub struct DomainDef {
5456    pub name: String,
5457    pub base_type: DataType,
5458    pub nullable: bool,
5459    pub default: Option<String>,
5460    /// v7.39 (round 260) — each CHECK carries its constraint NAME, so
5461    /// `ALTER DOMAIN … DROP CONSTRAINT <name>` can find it and the
5462    /// violation message can report the constraint that actually failed.
5463    /// PG's auto-naming for an unnamed check is `<domain>_check`, then
5464    /// `_check1`, `_check2`, … (probed).
5465    pub checks: Vec<DomainCheck>,
5466    /// v7.39 (round 258/259) — when this domain was declared over ANOTHER
5467    /// domain (`CREATE DOMAIN child AS parent CHECK (…)`), the parent's
5468    /// name. `base_type` is the ultimate scalar type either way, so
5469    /// without this the parent's constraints were invisible and a value
5470    /// violating them was silently accepted. PG checks the whole chain,
5471    /// base-first, and an `ALTER DOMAIN` on the parent takes effect for
5472    /// the child immediately (probed) — so the chain is walked at check
5473    /// time rather than copied at CREATE time. Catalog FILE_VERSION 74+.
5474    pub base_domain: Option<String>,
5475}
5476
5477/// v7.17.0 Phase 1.4 — catalogued user-defined ENUM type. The
5478/// label vector is order-preserving (PG enum ordering follows the
5479/// declared order). At INSERT/UPDATE on a column bound to this
5480/// enum, the engine looks up the value against `labels` and
5481/// rejects non-members.
5482#[derive(Debug, Clone, PartialEq, Eq)]
5483pub struct EnumDef {
5484    pub name: String,
5485    pub labels: Vec<String>,
5486}
5487
5488/// v7.37.42-T2 ζ-B — catalogued user-defined COMPOSITE type
5489/// (`CREATE TYPE name AS (field_name field_type, ...)`). Order
5490/// matters: PG composite literals are positional, and SPG mirrors
5491/// that. Stored as ordered `(name, DataType)` pairs to keep the
5492/// codec straightforward and to allow eventual `Value::Composite`
5493/// bodies to encode positionally. Persisted in catalog FILE_VERSION
5494/// 52+; older catalogs deserialise with an empty composite_types
5495/// map. Composite types can be used as a column type by spelling
5496/// the composite's name; the resolution from
5497/// `ColumnSchema.user_composite_type = Some(name)` happens at the
5498/// engine boundary (parallel to `user_enum_type` /
5499/// `user_domain_type`). The dense storage shape — JSON-text body
5500/// keyed by the composite's field list — keeps the codec free of
5501/// recursive `Value` bodies until the full Value::Composite arena
5502/// migration in a later phase.
5503#[derive(Debug, Clone, PartialEq, Eq)]
5504pub struct CompositeDef {
5505    pub name: String,
5506    /// Ordered `(field_name, field_type)` pairs. PG composite
5507    /// literals are positional, so order is part of the type's
5508    /// identity.
5509    pub fields: Vec<(String, DataType)>,
5510    /// v7.39 (round 264) — parallel to `fields`: the USER type name of
5511    /// each field when it is itself a composite (or another named user
5512    /// type). `DataType` has no room for one, so a nested composite
5513    /// field resolved to the parser's Text placeholder and the inner
5514    /// record stayed TEXT — `(x).inner.street` errored, `pg_typeof`
5515    /// said text, and `row_to_json` nested a string instead of an
5516    /// object. Same shape as `ColumnSchema.user_composite_type` and
5517    /// `DomainDef.base_domain`. Catalog FILE_VERSION 76+; an older
5518    /// catalog reads all-None, which is what it meant.
5519    pub field_user_types: Vec<Option<String>>,
5520}
5521
5522/// v7.17.0 Phase 1.2 — catalogued VIEW. The body is stored as the
5523/// raw source text the parser saw between `AS` and the statement
5524/// terminator; the engine re-parses on each invocation. Same
5525/// pattern as `FunctionDef` — keeps `spg-storage` free of
5526/// `spg-sql` dependency.
5527#[derive(Debug, Clone, PartialEq, Eq)]
5528pub struct ViewDef {
5529    pub name: String,
5530    /// Optional `(col, col, …)` rename list. Empty when the body's
5531    /// projected names are used directly.
5532    pub columns: Vec<String>,
5533    /// Raw SELECT source. Display-rendered at storage time so the
5534    /// catalog round-trips a deterministic form regardless of
5535    /// whitespace / comments in the original input. Re-parsed at
5536    /// SELECT-from-view time to materialise as a synthetic CTE.
5537    pub body: String,
5538    /// v7.39 (round 132) — `WITH CHECK OPTION`: 0 = none, 1 = LOCAL,
5539    /// 2 = CASCADED. A storage-local u8 (no dependency on the SQL AST).
5540    /// Persisted from FILE_VERSION 69; older catalogs read back as 0.
5541    pub check_option: u8,
5542}
5543
5544impl SequenceDataType {
5545    /// PG default min/max per AS clause.
5546    pub fn default_bounds(self, increment_positive: bool) -> (i64, i64) {
5547        match self {
5548            Self::SmallInt => {
5549                if increment_positive {
5550                    (1, i64::from(i16::MAX))
5551                } else {
5552                    (i64::from(i16::MIN), -1)
5553                }
5554            }
5555            Self::Int => {
5556                if increment_positive {
5557                    (1, i64::from(i32::MAX))
5558                } else {
5559                    (i64::from(i32::MIN), -1)
5560                }
5561            }
5562            Self::BigInt => {
5563                if increment_positive {
5564                    (1, i64::MAX)
5565                } else {
5566                    (i64::MIN, -1)
5567                }
5568            }
5569        }
5570    }
5571}
5572
5573impl Catalog {
5574    /// v7.37.15 (Phase D) — fleet-wide vacuum pass. Walks every
5575    /// user table and reclaims rows whose delete-commit version is
5576    /// older than `oldest_active_snapshot`. Returns an aggregated
5577    /// report with per-table breakdown so hosts can emit metrics.
5578    ///
5579    /// `dry_run = true` reports the work without doing it. Use it
5580    /// to estimate the cost before scheduling a real pass.
5581    pub fn vacuum_all(
5582        &mut self,
5583        oldest_active_snapshot: u64,
5584        dry_run: bool,
5585    ) -> vacuum::VacuumReport {
5586        let mut total = vacuum::VacuumReport::default();
5587        // Snapshot the table names so we don't hold an immutable
5588        // borrow during the get_mut loop.
5589        let names: Vec<String> = self
5590            .tables
5591            .iter()
5592            .map(|t| t.schema().name.clone())
5593            .collect();
5594        for name in names {
5595            let Some(t) = self.get_mut(&name) else {
5596                continue;
5597            };
5598            let r = t.vacuum(oldest_active_snapshot, dry_run);
5599            if r.rows_reclaimed > 0 {
5600                total.per_table.push((name, r.rows_reclaimed));
5601            }
5602            total.rows_reclaimed += r.rows_reclaimed;
5603            total.rows_examined += r.rows_examined;
5604        }
5605        total
5606    }
5607
5608    pub const fn new() -> Self {
5609        Self {
5610            cold_read_stats: ColdReadStats {
5611                cold_reads: core::sync::atomic::AtomicU64::new(0),
5612            },
5613            tables: Vec::new(),
5614            by_name: BTreeMap::new(),
5615            temp_prefix: None,
5616            dirty_tables: alloc::collections::BTreeSet::new(),
5617            dirty_nontable: alloc::collections::BTreeSet::new(),
5618            next_rel_id: 0,
5619            cold_segments: Vec::new(),
5620            functions: BTreeMap::new(),
5621            triggers: Vec::new(),
5622            rules: Vec::new(),
5623            statistics_ext: Vec::new(),
5624            large_objects: alloc::collections::BTreeMap::new(),
5625            sequences: BTreeMap::new(),
5626            schema_acl: Vec::new(),
5627            database_acl: Vec::new(),
5628            views: BTreeMap::new(),
5629            materialized_views: BTreeMap::new(),
5630            enum_types: BTreeMap::new(),
5631            domain_types: BTreeMap::new(),
5632            comments: BTreeMap::new(),
5633            db_role_settings: BTreeMap::new(),
5634            replication_slots: BTreeMap::new(),
5635            db_collation: None,
5636            composite_types: BTreeMap::new(),
5637            schemas: alloc::collections::BTreeSet::new(),
5638        }
5639    }
5640
5641    /// v7.12.4 — read-only view of catalogued user-defined
5642    /// functions. Engine callers go through here to look up the
5643    /// function body before re-parsing it for invocation.
5644    pub const fn functions(&self) -> &BTreeMap<String, FunctionDef> {
5645        &self.functions
5646    }
5647
5648    /// v7.12.4 — register a new user-defined function. With
5649    /// `or_replace = false`, errors if the name is taken. The
5650    /// engine validates the body before passing it here.
5651    pub fn create_function(
5652        &mut self,
5653        def: FunctionDef,
5654        or_replace: bool,
5655    ) -> Result<(), StorageError> {
5656        // v7.39 (read01 round 62) — functions are keyed by SIGNATURE, not by
5657        // name: `f(int)` and `f(text)` are two functions, as in PG. Keying by
5658        // name alone made a second overload an "already exists" error — so a
5659        // pg_dump carrying an overload set could not restore — and, worse, a
5660        // call to one overload silently ran the other.
5661        let key = function_signature_key(&def.name, &def.args_repr);
5662        if !or_replace && self.functions.contains_key(&key) {
5663            return Err(StorageError::Corrupt(format!(
5664                "function {:?} already exists (drop or use CREATE OR REPLACE)",
5665                def.name
5666            )));
5667        }
5668        self.functions.insert(key, def);
5669        Ok(())
5670    }
5671
5672    /// v7.39 (read01 round 62) — every overload of `name`.
5673    #[must_use]
5674    pub fn functions_named(&self, name: &str) -> Vec<&FunctionDef> {
5675        self.functions
5676            .values()
5677            .filter(|f| f.name.eq_ignore_ascii_case(name))
5678            .collect()
5679    }
5680
5681    /// v7.39 (read01 round 62) — one overload, by its signature key.
5682    #[must_use]
5683    pub fn function_by_key(&self, key: &str) -> Option<&FunctionDef> {
5684        self.functions.get(key)
5685    }
5686
5687    /// v7.39 (read01 round 62) — drop ONE overload. `true` if it was there.
5688    pub fn drop_function_by_key(&mut self, key: &str) -> bool {
5689        self.functions.remove(key).is_some()
5690    }
5691
5692    /// v7.12.4 — remove a user-defined function by name. Returns
5693    /// `true` if a function was removed, `false` if none matched.
5694    /// Caller decides whether to surface `if_exists` semantics.
5695    /// v7.39 (read01 round 62) — with no signature, PG drops the function only
5696    /// when the name is unambiguous. SPG mirrors that: this removes EVERY
5697    /// overload of `name`, and the caller (ddl.rs) refuses the ambiguous case
5698    /// before getting here.
5699    pub fn drop_function(&mut self, name: &str) -> bool {
5700        let keys: Vec<String> = self
5701            .functions
5702            .iter()
5703            .filter(|(_, f)| f.name.eq_ignore_ascii_case(name))
5704            .map(|(k, _)| k.clone())
5705            .collect();
5706        let hit = !keys.is_empty();
5707        for k in keys {
5708            self.functions.remove(&k);
5709        }
5710        hit
5711    }
5712
5713    /// v7.17.0 — read-only handle to catalogued sequences.
5714    /// v7.39 (read01 round 60) — the `public` schema's ACL (PG nspacl).
5715    #[must_use]
5716    pub fn schema_acl(&self) -> &[AclItem] {
5717        &self.schema_acl
5718    }
5719
5720    pub fn schema_acl_mut(&mut self) -> &mut Vec<AclItem> {
5721        &mut self.schema_acl
5722    }
5723
5724    /// v7.39 (read01 round 60) — the database's ACL.
5725    #[must_use]
5726    pub fn database_acl(&self) -> &[AclItem] {
5727        &self.database_acl
5728    }
5729
5730    pub fn database_acl_mut(&mut self) -> &mut Vec<AclItem> {
5731        &mut self.database_acl
5732    }
5733
5734    /// v7.39 (read01 round 60) — mutable sequence access, for GRANT.
5735    /// v7.39 (round 469) — resolves the session's temporary sequence
5736    /// first, like its read-only twin. `nextval` and `setval` reach the
5737    /// map through here, so a temporary sequence shadowing a permanent one
5738    /// advances the temporary one — measured against PG18, where the
5739    /// permanent sequence's counter is untouched while the temp exists.
5740    pub fn sequence_mut(&mut self, name: &str) -> Option<&mut SequenceDef> {
5741        let key = self.sequence_key(name);
5742        self.sequences.get_mut(&key)
5743    }
5744
5745    /// v7.39 (read01 round 61) — mutable function access, for GRANT.
5746    pub fn function_mut(&mut self, name: &str) -> Option<&mut FunctionDef> {
5747        self.functions.get_mut(name)
5748    }
5749
5750    /// Every catalogued sequence, temp ones included under their mangled
5751    /// storage names. Listing code filters these through
5752    /// [`Self::listed_name`]; anything resolving ONE name by its logical
5753    /// spelling wants [`Self::sequence`] instead.
5754    pub const fn sequences_all(&self) -> &BTreeMap<String, SequenceDef> {
5755        &self.sequences
5756    }
5757
5758    /// v7.39 (round 469) — resolve one sequence by its logical name, the
5759    /// session's temporary one winning over a permanent one of the same
5760    /// name. The same rule [`Self::resolve_index`] applies to tables.
5761    #[must_use]
5762    pub fn sequence(&self, name: &str) -> Option<&SequenceDef> {
5763        if let Some(mangled) = self.temp_name_for(name)
5764            && let Some(def) = self.sequences.get(&mangled)
5765        {
5766            return Some(def);
5767        }
5768        self.sequences.get(name)
5769    }
5770
5771    /// Does a sequence of this logical name exist for this session?
5772    #[must_use]
5773    pub fn has_sequence(&self, name: &str) -> bool {
5774        self.sequence(name).is_some()
5775    }
5776
5777    /// The storage key a sequence of this logical name resolves to — the
5778    /// session's temp mangling when it has one, else the name itself.
5779    #[must_use]
5780    pub fn sequence_key(&self, name: &str) -> String {
5781        if let Some(mangled) = self.temp_name_for(name)
5782            && self.sequences.contains_key(&mangled)
5783        {
5784            return mangled;
5785        }
5786        name.into()
5787    }
5788
5789    /// v7.17.0 — register a new SEQUENCE. Errors if `name`
5790    /// collides with an existing sequence and `if_not_exists`
5791    /// is false.
5792    pub fn create_sequence(
5793        &mut self,
5794        def: SequenceDef,
5795        if_not_exists: bool,
5796    ) -> Result<(), StorageError> {
5797        if self.sequences.contains_key(&def.name) {
5798            if if_not_exists {
5799                return Ok(());
5800            }
5801            // v7.39 (read01 round 47) — a sequence is a relation to PG (42P07).
5802            return Err(StorageError::Corrupt(format!(
5803                "relation {:?} already exists",
5804                def.name
5805            )));
5806        }
5807        self.mark_nontable_dirty(NonTableKind::Sequence, &def.name);
5808        self.sequences.insert(def.name.clone(), def);
5809        Ok(())
5810    }
5811
5812    /// v7.17.0 — remove a SEQUENCE by name. Returns `true` if a
5813    /// sequence was removed, `false` if none matched. Caller
5814    /// surfaces IF EXISTS semantics.
5815    /// v7.39 (read01 round 49) — `ALTER SEQUENCE old RENAME TO new`.
5816    /// Errors when `old` is missing or `new` is taken; the SequenceDef's own
5817    /// `name` field is rewritten so it stays self-describing.
5818    pub fn rename_sequence(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
5819        if !self.sequences.contains_key(old) {
5820            return Err(StorageError::Corrupt(format!(
5821                "relation {old:?} does not exist"
5822            )));
5823        }
5824        if self.sequences.contains_key(new) {
5825            return Err(StorageError::Corrupt(format!(
5826                "relation {new:?} already exists"
5827            )));
5828        }
5829        self.mark_nontable_dirty(NonTableKind::Sequence, old);
5830        self.mark_nontable_dirty(NonTableKind::Sequence, new);
5831        if let Some(mut def) = self.sequences.remove(old) {
5832            def.name = new.to_string();
5833            self.sequences.insert(new.to_string(), def);
5834        }
5835        Ok(())
5836    }
5837
5838    pub fn drop_sequence(&mut self, name: &str) -> bool {
5839        self.mark_nontable_dirty(NonTableKind::Sequence, name);
5840        self.sequences.remove(name).is_some()
5841    }
5842
5843    /// v7.17.0 — atomic nextval. Increments `last_value` per
5844    /// `increment`, returns the new value, sets `is_called`.
5845    /// Returns an error on CYCLE-less overflow.
5846    /// v7.39 (round 497) — the counter state of every sequence, for
5847    /// carrying across a commit install.
5848    ///
5849    /// A sequence's VALUE is not transactional in PG: `nextval` advances
5850    /// shared state that a rollback does not give back, because two
5851    /// sessions must never receive the same number. SPG keeps sequences in
5852    /// the catalog, and a transaction works on a catalog CLONE, so
5853    /// installing that clone at COMMIT would restore whatever the counter
5854    /// was at BEGIN. These two let the install put the live counters back.
5855    #[must_use]
5856    pub fn sequence_counters(&self) -> Vec<(String, i64, bool)> {
5857        self.sequences
5858            .iter()
5859            .map(|(k, d)| (k.clone(), d.last_value, d.is_called))
5860            .collect()
5861    }
5862
5863    /// Restore counters saved by [`Self::sequence_counters`], for the
5864    /// sequences that still exist. A sequence the transaction CREATED is
5865    /// absent from the saved set and keeps the value it was given.
5866    pub fn restore_sequence_counters(&mut self, saved: &[(String, i64, bool)]) {
5867        for (k, last, called) in saved {
5868            if let Some(d) = self.sequences.get_mut(k) {
5869                d.last_value = *last;
5870                d.is_called = *called;
5871            }
5872        }
5873    }
5874
5875    pub fn sequence_next_value(&mut self, name: &str) -> Result<i64, StorageError> {
5876        let key = self.sequence_key(name);
5877        let Some(seq) = self.sequences.get_mut(&key) else {
5878            return Err(StorageError::TableNotFound { name: name.into() });
5879        };
5880        // PG semantics: when !is_called (fresh sequence or
5881        // setval(_, false)), the next nextval returns the stored
5882        // `last_value`. When is_called, it advances by `increment`
5883        // and CYCLE-wraps on overflow.
5884        let candidate = if seq.is_called {
5885            let next = seq.last_value.checked_add(seq.increment).ok_or_else(|| {
5886                StorageError::Corrupt(format!("sequence {name:?} arithmetic overflow"))
5887            })?;
5888            if seq.increment > 0 {
5889                if next > seq.max_value {
5890                    if seq.cycle {
5891                        seq.min_value
5892                    } else {
5893                        // v7.39 (round 220) — PG's 2200H wording, not a
5894                        // Corrupt-classed error.
5895                        return Err(StorageError::SequenceExhausted {
5896                            name: name.into(),
5897                            limit: seq.max_value,
5898                            is_max: true,
5899                        });
5900                    }
5901                } else {
5902                    next
5903                }
5904            } else if next < seq.min_value {
5905                if seq.cycle {
5906                    seq.max_value
5907                } else {
5908                    return Err(StorageError::SequenceExhausted {
5909                        name: name.into(),
5910                        limit: seq.min_value,
5911                        is_max: false,
5912                    });
5913                }
5914            } else {
5915                next
5916            }
5917        } else {
5918            seq.last_value
5919        };
5920        seq.last_value = candidate;
5921        seq.is_called = true;
5922        Ok(candidate)
5923    }
5924
5925    /// v7.17.0 — currval. Errors if the session has never called
5926    /// nextval on this sequence (PG semantics). At the catalog
5927    /// level we approximate "session" with "is_called persisted";
5928    /// the engine session-tracking layer can wrap this for the
5929    /// strict per-session semantics later.
5930    pub fn sequence_current_value(&self, name: &str) -> Result<i64, StorageError> {
5931        let Some(seq) = self.sequences.get(name) else {
5932            return Err(StorageError::TableNotFound { name: name.into() });
5933        };
5934        if !seq.is_called {
5935            return Err(StorageError::Corrupt(format!(
5936                "currval of sequence {name:?} is not yet defined in this session"
5937            )));
5938        }
5939        Ok(seq.last_value)
5940    }
5941
5942    /// v7.17.0 — setval(name, value [, is_called]). PG returns
5943    /// `value` regardless. `is_called=true` means the NEXT
5944    /// nextval will return `value + increment`; `is_called=false`
5945    /// means the next nextval will return `value`.
5946    pub fn sequence_set_value(
5947        &mut self,
5948        name: &str,
5949        value: i64,
5950        is_called: bool,
5951    ) -> Result<i64, StorageError> {
5952        let key = self.sequence_key(name);
5953        let Some(seq) = self.sequences.get_mut(&key) else {
5954            return Err(StorageError::TableNotFound { name: name.into() });
5955        };
5956        // v7.39 (round 244) — PG refuses a value outside the sequence's
5957        // range (22003); SPG accepted it silently, leaving last_value out
5958        // of bounds.
5959        if value < seq.min_value || value > seq.max_value {
5960            return Err(StorageError::Unsupported(format!(
5961                "setval: value {value} is out of bounds for sequence \"{name}\" ({}..{})",
5962                seq.min_value, seq.max_value
5963            )));
5964        }
5965        seq.last_value = value;
5966        seq.is_called = is_called;
5967        Ok(value)
5968    }
5969
5970    /// v7.17.0 Phase 1.2 — read-only handle to catalogued views. Temp ones
5971    /// are in here under their mangled storage names; listing code filters
5972    /// through [`Self::listed_name`], and anything resolving ONE name by
5973    /// its logical spelling wants [`Self::view`].
5974    pub const fn views_all(&self) -> &BTreeMap<String, ViewDef> {
5975        &self.views
5976    }
5977
5978    /// v7.39 (round 469) — resolve one view by its logical name, the
5979    /// session's temporary one winning over a permanent one of the same
5980    /// name.
5981    #[must_use]
5982    pub fn view(&self, name: &str) -> Option<&ViewDef> {
5983        if let Some(mangled) = self.temp_name_for(name)
5984            && let Some(def) = self.views.get(&mangled)
5985        {
5986            return Some(def);
5987        }
5988        self.views.get(name)
5989    }
5990
5991    /// Does a view of this logical name exist for this session?
5992    #[must_use]
5993    pub fn has_view(&self, name: &str) -> bool {
5994        self.view(name).is_some()
5995    }
5996
5997    /// The storage key a view of this logical name resolves to.
5998    #[must_use]
5999    pub fn view_key(&self, name: &str) -> String {
6000        if let Some(mangled) = self.temp_name_for(name)
6001            && self.views.contains_key(&mangled)
6002        {
6003            return mangled;
6004        }
6005        name.into()
6006    }
6007
6008    /// v7.17.0 Phase 1.2 — install a VIEW. `or_replace=true`
6009    /// overwrites an existing entry; `if_not_exists=true` is a
6010    /// silent no-op when the name is taken. Errors if both flags
6011    /// are off and the name collides.
6012    pub fn create_view(
6013        &mut self,
6014        def: ViewDef,
6015        or_replace: bool,
6016        if_not_exists: bool,
6017    ) -> Result<(), StorageError> {
6018        if self.views.contains_key(&def.name) {
6019            if or_replace {
6020                self.mark_nontable_dirty(NonTableKind::View, &def.name);
6021                self.mark_nontable_dirty(NonTableKind::View, &def.name);
6022                self.views.insert(def.name.clone(), def);
6023                return Ok(());
6024            }
6025            if if_not_exists {
6026                return Ok(());
6027            }
6028            // v7.39 (read01 round 47) — a view is a relation to PG (42P07).
6029            return Err(StorageError::Corrupt(format!(
6030                "relation {:?} already exists",
6031                def.name
6032            )));
6033        }
6034        // Reject name collision with tables / sequences — same
6035        // namespace per PG.
6036        if self.by_name.contains_key(&def.name) {
6037            return Err(StorageError::Corrupt(format!(
6038                "view {:?} would shadow an existing table",
6039                def.name
6040            )));
6041        }
6042        if self.sequences.contains_key(&def.name) {
6043            return Err(StorageError::Corrupt(format!(
6044                "view {:?} would shadow an existing sequence",
6045                def.name
6046            )));
6047        }
6048        self.views.insert(def.name.clone(), def);
6049        Ok(())
6050    }
6051
6052    /// v7.17.0 Phase 1.2 — remove a view by name. Returns true if
6053    /// a view was removed.
6054    pub fn drop_view(&mut self, name: &str) -> bool {
6055        self.mark_nontable_dirty(NonTableKind::View, name);
6056        self.views.remove(name).is_some()
6057    }
6058
6059    /// v7.17.0 Phase 1.3 — read-only handle to the materialised-
6060    /// view source registry. Each entry pairs with a regular
6061    /// table of the same name that holds the cached rows.
6062    pub const fn materialized_views(&self) -> &BTreeMap<String, String> {
6063        &self.materialized_views
6064    }
6065
6066    /// v7.17.0 Phase 1.3 — register a source for a materialised
6067    /// view. Caller has already created the backing table.
6068    pub fn register_materialized_view(&mut self, name: String, body: String) {
6069        self.mark_nontable_dirty(NonTableKind::MaterializedView, &name);
6070        self.materialized_views.insert(name, body);
6071    }
6072
6073    /// v7.17.0 Phase 1.3 — drop the source registry entry. Returns
6074    /// true if a source was unregistered. Caller separately drops
6075    /// the backing table.
6076    pub fn drop_materialized_view_source(&mut self, name: &str) -> bool {
6077        self.mark_nontable_dirty(NonTableKind::MaterializedView, name);
6078        self.materialized_views.remove(name).is_some()
6079    }
6080
6081    /// v7.17.0 Phase 1.4 — read-only handle to user-defined ENUM
6082    /// catalog.
6083    pub const fn enum_types(&self) -> &BTreeMap<String, EnumDef> {
6084        &self.enum_types
6085    }
6086
6087    /// v7.17.0 Phase 1.4 — install a new ENUM type. Errors if
6088    /// `name` collides with an existing enum (no IF NOT EXISTS
6089    /// per PG semantics for CREATE TYPE).
6090    pub fn create_enum_type(&mut self, def: EnumDef) -> Result<(), StorageError> {
6091        if self.enum_types.contains_key(&def.name) {
6092            return Err(StorageError::Corrupt(format!(
6093                "type {:?} already exists",
6094                def.name
6095            )));
6096        }
6097        self.mark_nontable_dirty(NonTableKind::EnumType, &def.name);
6098        self.enum_types.insert(def.name.clone(), def);
6099        Ok(())
6100    }
6101
6102    /// v7.17.0 Phase 1.4 — drop an ENUM type by name. Returns
6103    /// true if a type was removed.
6104    /// v7.37 D.55 — `ALTER TYPE … ADD VALUE`. Appends `label` to an existing
6105    /// enum's ordered label list, or inserts it before/after an existing label.
6106    /// `if_not_exists` makes a duplicate a no-op; otherwise a duplicate errors.
6107    /// Returns `Ok(true)` if a label was added, `Ok(false)` if it already existed
6108    /// (only possible under `if_not_exists`).
6109    /// v7.39 (read01 round 49) — `ALTER TYPE t RENAME VALUE 'old' TO 'new'`.
6110    /// The parser used to swallow this form as a no-op, so the rename was
6111    /// accepted and silently ignored. Renaming in place keeps the label's
6112    /// sort position, which is what PG does (enumsortorder is untouched).
6113    pub fn rename_enum_value(
6114        &mut self,
6115        type_name: &str,
6116        old: &str,
6117        new: &str,
6118    ) -> Result<(), StorageError> {
6119        let def = self
6120            .enum_types
6121            .get_mut(type_name)
6122            .ok_or_else(|| StorageError::Corrupt(format!("type {type_name:?} does not exist")))?;
6123        if def.labels.iter().any(|l| l == new) {
6124            return Err(StorageError::Corrupt(format!(
6125                "enum label {new:?} already exists"
6126            )));
6127        }
6128        let at = def.labels.iter().position(|l| l == old).ok_or_else(|| {
6129            StorageError::Corrupt(format!("{old:?} is not an existing enum label"))
6130        })?;
6131        def.labels[at] = new.to_string();
6132        Ok(())
6133    }
6134
6135    /// v7.39 (read01 round 50) — set (or, with `None`, remove) the comment on
6136    /// an object. `key` is the canonical `"<kind>:<name>"` form.
6137    pub fn set_comment(&mut self, key: &str, text: Option<&str>) {
6138        match text {
6139            Some(t) => {
6140                self.comments.insert(key.to_string(), t.to_string());
6141            }
6142            None => {
6143                self.comments.remove(key);
6144            }
6145        }
6146    }
6147
6148    /// v7.39 (read01 round 50) — the comment on an object, if any.
6149    #[must_use]
6150    pub fn comment(&self, key: &str) -> Option<&str> {
6151        self.comments.get(key).map(String::as_str)
6152    }
6153
6154    /// v7.39 (round 547) — record a GUC default for a scope. An empty
6155    /// database or role name is PG's oid 0 ("all"). `None` value
6156    /// removes just that parameter, as PG's RESET does.
6157    pub fn set_db_role_setting(
6158        &mut self,
6159        database: &str,
6160        role: &str,
6161        param: &str,
6162        value: Option<&str>,
6163    ) {
6164        let key = (database.to_string(), role.to_string());
6165        match value {
6166            Some(v) => {
6167                self.db_role_settings
6168                    .entry(key)
6169                    .or_default()
6170                    .insert(param.to_ascii_lowercase(), v.to_string());
6171            }
6172            None => {
6173                if let Some(m) = self.db_role_settings.get_mut(&key) {
6174                    m.remove(&param.to_ascii_lowercase());
6175                    if m.is_empty() {
6176                        self.db_role_settings.remove(&key);
6177                    }
6178                }
6179            }
6180        }
6181    }
6182
6183    /// v7.39 (round 550) — create a replication slot. `Err` carries
6184    /// PG's own message for a duplicate.
6185    ///
6186    /// # Errors
6187    /// When a slot of that name already exists.
6188    pub fn create_replication_slot(
6189        &mut self,
6190        name: &str,
6191        plugin: &str,
6192        slot_type: &str,
6193    ) -> Result<(), String> {
6194        if self.replication_slots.contains_key(name) {
6195            return Err(alloc::format!("replication slot \"{name}\" already exists"));
6196        }
6197        self.replication_slots.insert(
6198            name.to_string(),
6199            (plugin.to_string(), slot_type.to_string()),
6200        );
6201        Ok(())
6202    }
6203
6204    /// # Errors
6205    /// When no slot of that name exists — PG's message, and the case
6206    /// that used to report success.
6207    pub fn drop_replication_slot(&mut self, name: &str) -> Result<(), String> {
6208        if self.replication_slots.remove(name).is_none() {
6209            return Err(alloc::format!("replication slot \"{name}\" does not exist"));
6210        }
6211        Ok(())
6212    }
6213
6214    #[must_use]
6215    /// v7.38.18 (S1) — the collation this database was created with.
6216    /// `"C"` when nothing was recorded, which is what an older catalog
6217    /// and a default `initdb`-less start both mean.
6218    pub fn db_collation(&self) -> &str {
6219        self.db_collation.as_deref().unwrap_or("C")
6220    }
6221
6222    /// Record the creation collation. Refused once one is set, because
6223    /// every index key already in this database was built under it —
6224    /// the same refusal PostgreSQL gives `ALTER DATABASE … LC_COLLATE`,
6225    /// and for the same reason.
6226    ///
6227    /// `Ok(false)` when the value asked for is the one already in force,
6228    /// so a host that passes its environment on every start is not an
6229    /// error.
6230    pub fn set_db_collation(&mut self, name: &str) -> Result<bool, StorageError> {
6231        if self.db_collation.as_deref() == Some(name) {
6232            return Ok(false);
6233        }
6234        if self.db_collation.is_none() && name.eq_ignore_ascii_case("C") {
6235            return Ok(false);
6236        }
6237        if self.db_collation.is_some() || !self.tables.is_empty() {
6238            return Err(StorageError::Corrupt(format!(
6239                "database collation is already {:?} and cannot be changed; \
6240                 PostgreSQL refuses this too, because every index key here \
6241                 was built under it",
6242                self.db_collation()
6243            )));
6244        }
6245        self.db_collation = Some(name.into());
6246        Ok(true)
6247    }
6248
6249    /// The user said so, in SQL: `CREATE DATABASE … LC_COLLATE 'x'`.
6250    ///
6251    /// Differs from [`Self::set_db_collation`] in one way, and the
6252    /// difference is the whole point: this REPLACES a collation the
6253    /// database already has, as long as no table has been created yet.
6254    /// The refusal in `set_db_collation` exists because index keys were
6255    /// built under the old collation — with no tables, none were.
6256    ///
6257    /// The case it is for: a server stamps the container's `LANG` on a
6258    /// fresh database at startup, and the customer's bootstrap script
6259    /// then says `CREATE DATABASE app LC_COLLATE 'de_DE.utf8'`. What the
6260    /// script asked for beats what the container happened to export.
6261    ///
6262    /// `Ok(false)` when a table already exists — the caller warns rather
6263    /// than failing, because PostgreSQL would have made a SEPARATE
6264    /// database here and returned success, and failing a bootstrap
6265    /// script is a customer change.
6266    pub fn declare_db_collation(&mut self, name: &str) -> bool {
6267        if self.db_collation.as_deref() == Some(name) {
6268            return true;
6269        }
6270        if !self.tables.is_empty() {
6271            return false;
6272        }
6273        self.db_collation = Some(name.into());
6274        true
6275    }
6276
6277    pub const fn replication_slots(&self) -> &BTreeMap<String, (String, String)> {
6278        &self.replication_slots
6279    }
6280
6281    /// PG's RESET ALL: drops this scope's whole entry, leaving the
6282    /// other scopes alone — measured on PG18, where `ALTER ROLE r RESET
6283    /// ALL` left the ALL, the database and the role-in-database rows.
6284    pub fn reset_db_role_settings(&mut self, database: &str, role: &str) {
6285        self.db_role_settings
6286            .remove(&(database.to_string(), role.to_string()));
6287    }
6288
6289    #[must_use]
6290    pub const fn db_role_settings(&self) -> &BTreeMap<(String, String), BTreeMap<String, String>> {
6291        &self.db_role_settings
6292    }
6293
6294    /// v7.39 (read01 round 50) — every `(key, text)` pair, for the
6295    /// pg_description view.
6296    #[must_use]
6297    pub const fn comments(&self) -> &BTreeMap<String, String> {
6298        &self.comments
6299    }
6300
6301    /// v7.39 (read01 round 50) — drop every comment whose key names `obj`
6302    /// (the object itself and, for a table, its columns). Called when the
6303    /// object is dropped so a later object of the same name doesn't inherit
6304    /// a stale comment.
6305    pub fn drop_comments_for(&mut self, kind: &str, name: &str) {
6306        let exact = alloc::format!("{kind}:{name}");
6307        let col_prefix = alloc::format!("column:{name}.");
6308        self.comments
6309            .retain(|k, _| *k != exact && !k.starts_with(&col_prefix));
6310    }
6311
6312    pub fn add_enum_value(
6313        &mut self,
6314        type_name: &str,
6315        label: &str,
6316        if_not_exists: bool,
6317        position: Option<(bool, String)>,
6318    ) -> Result<bool, StorageError> {
6319        self.mark_nontable_dirty(NonTableKind::EnumType, type_name);
6320        let def = self
6321            .enum_types
6322            .get_mut(type_name)
6323            .ok_or_else(|| StorageError::Corrupt(format!("type {type_name:?} does not exist")))?;
6324        if def.labels.iter().any(|l| l == label) {
6325            if if_not_exists {
6326                return Ok(false);
6327            }
6328            // v7.39 (read01 round 49) — PG wording (42710 at the wire).
6329            return Err(StorageError::Corrupt(format!(
6330                "enum label {label:?} already exists"
6331            )));
6332        }
6333        match position {
6334            None => def.labels.push(label.to_string()),
6335            Some((is_before, anchor)) => {
6336                let at = def
6337                    .labels
6338                    .iter()
6339                    .position(|l| l == &anchor)
6340                    .ok_or_else(|| {
6341                        StorageError::Corrupt(format!(
6342                            "enum label {anchor:?} does not exist in type {type_name:?}"
6343                        ))
6344                    })?;
6345                let idx = if is_before { at } else { at + 1 };
6346                def.labels.insert(idx, label.to_string());
6347            }
6348        }
6349        Ok(true)
6350    }
6351
6352    pub fn drop_enum_type(&mut self, name: &str) -> bool {
6353        self.mark_nontable_dirty(NonTableKind::EnumType, name);
6354        self.enum_types.remove(name).is_some()
6355    }
6356
6357    /// v7.17.0 Phase 1.5 — read-only handle to DOMAIN catalog.
6358    pub const fn domain_types(&self) -> &BTreeMap<String, DomainDef> {
6359        &self.domain_types
6360    }
6361
6362    /// v7.17.0 Phase 1.5 — install a DOMAIN. Errors on collision
6363    /// with an existing domain.
6364    pub fn create_domain_type(&mut self, def: DomainDef) -> Result<(), StorageError> {
6365        if self.domain_types.contains_key(&def.name) {
6366            return Err(StorageError::Corrupt(format!(
6367                "domain {:?} already exists",
6368                def.name
6369            )));
6370        }
6371        self.mark_nontable_dirty(NonTableKind::DomainType, &def.name);
6372        self.domain_types.insert(def.name.clone(), def);
6373        Ok(())
6374    }
6375
6376    /// v7.17.0 Phase 1.5 — drop a DOMAIN by name.
6377    pub fn drop_domain_type(&mut self, name: &str) -> bool {
6378        self.mark_nontable_dirty(NonTableKind::DomainType, name);
6379        self.domain_types.remove(name).is_some()
6380    }
6381
6382    /// v7.37.42-T2 ζ-B — read-only handle to user-defined COMPOSITE
6383    /// catalog. Used by the engine to resolve
6384    /// `ColumnSchema.user_composite_type` lookups + by
6385    /// information_schema-style introspection.
6386    pub const fn composite_types(&self) -> &BTreeMap<String, CompositeDef> {
6387        &self.composite_types
6388    }
6389
6390    /// v7.37.42-T2 ζ-B — install a new COMPOSITE type. Errors if
6391    /// `name` already exists in the composite registry (PG forbids
6392    /// IF NOT EXISTS on CREATE TYPE composite; the engine surfaces
6393    /// the collision with the existing name).
6394    pub fn create_composite_type(&mut self, def: CompositeDef) -> Result<(), StorageError> {
6395        if self.composite_types.contains_key(&def.name) {
6396            return Err(StorageError::Corrupt(format!(
6397                "type {:?} already exists",
6398                def.name
6399            )));
6400        }
6401        self.mark_nontable_dirty(NonTableKind::CompositeType, &def.name);
6402        self.composite_types.insert(def.name.clone(), def);
6403        Ok(())
6404    }
6405
6406    /// v7.37.42-T2 ζ-B — drop a COMPOSITE type by name. Returns
6407    /// true if a type was removed.
6408    pub fn drop_composite_type(&mut self, name: &str) -> bool {
6409        self.mark_nontable_dirty(NonTableKind::CompositeType, name);
6410        self.composite_types.remove(name).is_some()
6411    }
6412
6413    /// v7.17.0 Phase 1.6 — read-only handle to the user-created
6414    /// schema registry. Built-in schemas (`public`, `pg_catalog`,
6415    /// `information_schema`) are NOT included here; use
6416    /// [`schema_exists`](Self::schema_exists) for the full
6417    /// check.
6418    pub const fn user_schemas(&self) -> &alloc::collections::BTreeSet<String> {
6419        &self.schemas
6420    }
6421
6422    /// v7.17.0 Phase 1.6 — schema-name resolver. Returns true
6423    /// for built-in schemas + every user-CREATEd one. Used by
6424    /// CREATE SCHEMA collision checks and (future) by
6425    /// information_schema.schemata.
6426    pub fn schema_exists(&self, name: &str) -> bool {
6427        is_builtin_schema(name) || self.schemas.contains(name)
6428    }
6429
6430    /// v7.17.0 Phase 1.6 — register a new schema. Errors if the
6431    /// name already exists and `if_not_exists=false`. Built-in
6432    /// names cannot be redeclared.
6433    pub fn create_schema(&mut self, name: String, if_not_exists: bool) -> Result<(), StorageError> {
6434        if is_builtin_schema(&name) {
6435            if if_not_exists {
6436                return Ok(());
6437            }
6438            return Err(StorageError::Corrupt(format!(
6439                "schema {name:?} is built-in and cannot be redeclared"
6440            )));
6441        }
6442        if self.schemas.contains(&name) {
6443            if if_not_exists {
6444                return Ok(());
6445            }
6446            return Err(StorageError::Corrupt(format!(
6447                "schema {name:?} already exists"
6448            )));
6449        }
6450        self.schemas.insert(name);
6451        Ok(())
6452    }
6453
6454    /// v7.17.0 Phase 1.6 — drop a user-created schema. Returns
6455    /// true if a schema was removed. Built-in names always
6456    /// return false (cannot be dropped). Tables that previously
6457    /// used the schema as a prefix keep their bare name and stay
6458    /// queryable — this is the "prefix routing, not isolation"
6459    /// posture documented in v7.17 Phase 1.6.
6460    pub fn drop_schema(&mut self, name: &str) -> Result<bool, StorageError> {
6461        if is_builtin_schema(name) {
6462            return Err(StorageError::Corrupt(format!(
6463                "schema {name:?} is built-in and cannot be dropped"
6464            )));
6465        }
6466        Ok(self.schemas.remove(name))
6467    }
6468
6469    /// v7.17.0 — ALTER SEQUENCE option merge. Caller-provided
6470    /// updates overwrite the matching fields; unset fields keep
6471    /// their stored values. RESTART variants update last_value
6472    /// directly per PG: `RESTART` resets to current `start`;
6473    /// `RESTART WITH n` resets to `n`.
6474    #[allow(clippy::too_many_arguments)]
6475    pub fn alter_sequence(
6476        &mut self,
6477        name: &str,
6478        increment: Option<i64>,
6479        min_value: Option<i64>,
6480        max_value: Option<i64>,
6481        start: Option<i64>,
6482        restart: Option<Option<i64>>,
6483        cache: Option<i64>,
6484        cycle: Option<bool>,
6485        owned_by: Option<Option<(String, String)>>,
6486    ) -> Result<(), StorageError> {
6487        self.mark_nontable_dirty(NonTableKind::Sequence, name);
6488        let Some(seq) = self.sequences.get_mut(name) else {
6489            return Err(StorageError::TableNotFound { name: name.into() });
6490        };
6491        if let Some(v) = increment {
6492            seq.increment = v;
6493        }
6494        if let Some(v) = min_value {
6495            seq.min_value = v;
6496        }
6497        if let Some(v) = max_value {
6498            seq.max_value = v;
6499        }
6500        if let Some(v) = start {
6501            seq.start = v;
6502        }
6503        if let Some(restart_value) = restart {
6504            seq.last_value = restart_value.unwrap_or(seq.start);
6505            seq.is_called = false;
6506        }
6507        if let Some(v) = cache {
6508            seq.cache = v;
6509        }
6510        if let Some(v) = cycle {
6511            seq.cycle = v;
6512        }
6513        if let Some(v) = owned_by {
6514            seq.owned_by = v;
6515        }
6516        Ok(())
6517    }
6518
6519    /// v7.12.4 — read-only slice of all catalogued triggers.
6520    /// Engine row-write paths filter this by (table, event,
6521    /// timing) and fire matches in slice order.
6522    pub fn triggers(&self) -> &[TriggerDef] {
6523        &self.triggers
6524    }
6525
6526    /// v7.15.0 — mutable handle to the trigger slice for
6527    /// `ALTER TABLE … RENAME COLUMN`, which rewrites every
6528    /// `update_columns` entry that referenced the renamed
6529    /// column.
6530    pub fn triggers_mut(&mut self) -> &mut Vec<TriggerDef> {
6531        &mut self.triggers
6532    }
6533
6534    /// v7.12.4 — register a new trigger. With `or_replace = false`,
6535    /// errors when a trigger with the same name already exists on
6536    /// the same table (PG scoping rule — trigger names are
6537    /// per-table, not global). Trigger function must already
6538    /// exist in the catalog at registration time.
6539    pub fn create_trigger(
6540        &mut self,
6541        def: TriggerDef,
6542        or_replace: bool,
6543    ) -> Result<(), StorageError> {
6544        // v7.39 (round 137) — a trigger may target a base table (BEFORE / AFTER)
6545        // or a view (INSTEAD OF). The engine enforces the timing↔target rule;
6546        // storage only requires the relation to exist as one or the other.
6547        if !self.by_name.contains_key(&def.table) && !self.views.contains_key(&def.table) {
6548            return Err(StorageError::TableNotFound {
6549                name: def.table.clone(),
6550            });
6551        }
6552        // v7.39 (read01 round 62) — functions are keyed by SIGNATURE now. A
6553        // trigger names its function by NAME (a trigger function takes no
6554        // arguments), so the existence check goes through the name index.
6555        if self.functions_named(&def.function).is_empty() {
6556            // v7.39 (round 710) — PG's wording: the FUNCTION is what does
6557            // not exist (`function nosuch_fn() does not exist`), and the
6558            // old message rode `Corrupt`'s on-disk banner besides.
6559            return Err(StorageError::Corrupt(format!(
6560                "function {}() does not exist",
6561                def.function
6562            )));
6563        }
6564        let dup = self
6565            .triggers
6566            .iter()
6567            .position(|t| t.name == def.name && t.table == def.table);
6568        match (dup, or_replace) {
6569            (Some(_), false) => Err(StorageError::Corrupt(format!(
6570                "trigger {:?} already exists on table {:?}",
6571                def.name, def.table
6572            ))),
6573            (Some(i), true) => {
6574                self.triggers[i] = def;
6575                Ok(())
6576            }
6577            (None, _) => {
6578                self.triggers.push(def);
6579                Ok(())
6580            }
6581        }
6582    }
6583
6584    /// v7.12.4 — remove a trigger by `(name, table)`. Returns
6585    /// `true` if one was removed.
6586    pub fn drop_trigger(&mut self, name: &str, table: &str) -> bool {
6587        let before = self.triggers.len();
6588        self.triggers
6589            .retain(|t| !(t.name == name && t.table == table));
6590        before != self.triggers.len()
6591    }
6592
6593    /// v7.39 (round 139) — the catalogued query-rewrite RULEs.
6594    pub fn rules(&self) -> &[RuleDef] {
6595        &self.rules
6596    }
6597
6598    /// v7.39 (round 280) — the catalogued extended-statistics objects.
6599    #[must_use]
6600    pub fn statistics_ext(&self) -> &[StatisticsExtDef] {
6601        &self.statistics_ext
6602    }
6603
6604    /// v7.39 (round 287) — every large object, ascending by OID.
6605    #[must_use]
6606    pub fn large_objects(&self) -> &alloc::collections::BTreeMap<u32, Vec<u8>> {
6607        &self.large_objects
6608    }
6609
6610    /// The bytes of one large object, or `None` when no such OID exists.
6611    #[must_use]
6612    pub fn large_object(&self, oid: u32) -> Option<&[u8]> {
6613        self.large_objects.get(&oid).map(Vec::as_slice)
6614    }
6615
6616    /// Create a large object. `oid` of 0 means "pick one" — PG's
6617    /// `lo_create(0)` / `lo_creat(-1)` spelling. Errors when the
6618    /// requested OID is taken.
6619    pub fn create_large_object(&mut self, oid: u32, bytes: Vec<u8>) -> Result<u32, String> {
6620        let id = if oid == 0 {
6621            self.next_large_object_oid()
6622        } else {
6623            oid
6624        };
6625        if self.large_objects.contains_key(&id) {
6626            return Err(format!("large object {id} already exists"));
6627        }
6628        self.large_objects.insert(id, bytes);
6629        Ok(id)
6630    }
6631
6632    /// Overwrite `len` bytes at `offset` (0-based), growing the object
6633    /// with zero bytes if the write starts past the end — PG's
6634    /// `lo_put` semantics.
6635    pub fn put_large_object(&mut self, oid: u32, offset: usize, data: &[u8]) -> Result<(), String> {
6636        let Some(buf) = self.large_objects.get_mut(&oid) else {
6637            return Err(format!("large object {oid} does not exist"));
6638        };
6639        let end = offset.saturating_add(data.len());
6640        if buf.len() < end {
6641            buf.resize(end, 0);
6642        }
6643        buf[offset..end].copy_from_slice(data);
6644        Ok(())
6645    }
6646
6647    /// v7.39 (round 306) — `lo_truncate`. PG's truncate sets the object
6648    /// to exactly `len` bytes in BOTH directions: it shortens, and it
6649    /// GROWS with zero fill when `len` exceeds the current size
6650    /// (measured — `lo_truncate(fd, 8)` over a 4-byte object leaves
6651    /// eight bytes, the last four zero).
6652    pub fn truncate_large_object(&mut self, oid: u32, len: usize) -> Result<(), String> {
6653        let Some(buf) = self.large_objects.get_mut(&oid) else {
6654            return Err(format!("large object {oid} does not exist"));
6655        };
6656        buf.resize(len, 0);
6657        Ok(())
6658    }
6659
6660    /// Remove a large object. `false` when the OID was not there.
6661    pub fn unlink_large_object(&mut self, oid: u32) -> bool {
6662        self.large_objects.remove(&oid).is_some()
6663    }
6664
6665    /// The next free OID in PG's user band.
6666    /// v7.39 (round 343, V40) — large objects have their own oid band.
6667    /// It used to start at 16_384, which is where user TABLES start, so
6668    /// the first large object and the first table shared an oid — and
6669    /// `pg_largeobject_metadata.oid` is joinable against `pg_class.oid`,
6670    /// so a join across them matched a row that has nothing to do with
6671    /// it. (PG cannot collide: every oid there comes off one counter.)
6672    /// An object already stored keeps the oid it was given; only new
6673    /// ones land in the band.
6674    fn next_large_object_oid(&self) -> u32 {
6675        self.large_objects
6676            .keys()
6677            .next_back()
6678            .map_or(500_000, |m| m.saturating_add(1))
6679    }
6680
6681    /// Register one. `Err(name)` when the name is taken.
6682    pub fn create_statistics_ext(&mut self, def: StatisticsExtDef) -> Result<(), String> {
6683        if self.statistics_ext.iter().any(|s| s.name == def.name) {
6684            return Err(def.name);
6685        }
6686        self.statistics_ext.push(def);
6687        Ok(())
6688    }
6689
6690    /// Drop one by name; false when absent.
6691    pub fn drop_statistics_ext(&mut self, name: &str) -> bool {
6692        let before = self.statistics_ext.len();
6693        self.statistics_ext.retain(|s| s.name != name);
6694        before != self.statistics_ext.len()
6695    }
6696
6697    /// v7.39 (round 139) — register a RULE. Its target relation (table or view)
6698    /// must exist; `or_replace` overwrites a same-(name,table) rule.
6699    pub fn create_rule(&mut self, def: RuleDef, or_replace: bool) -> Result<(), StorageError> {
6700        if !self.by_name.contains_key(&def.table) && !self.views.contains_key(&def.table) {
6701            return Err(StorageError::TableNotFound {
6702                name: def.table.clone(),
6703            });
6704        }
6705        let dup = self
6706            .rules
6707            .iter()
6708            .position(|r| r.name == def.name && r.table == def.table);
6709        match (dup, or_replace) {
6710            (Some(_), false) => Err(StorageError::Corrupt(format!(
6711                "rule {:?} for relation {:?} already exists",
6712                def.name, def.table
6713            ))),
6714            (Some(i), true) => {
6715                self.rules[i] = def;
6716                Ok(())
6717            }
6718            (None, _) => {
6719                self.rules.push(def);
6720                Ok(())
6721            }
6722        }
6723    }
6724
6725    /// v7.39 (round 139) — drop a RULE by `(name, table)`.
6726    pub fn drop_rule(&mut self, name: &str, table: &str) -> bool {
6727        let before = self.rules.len();
6728        self.rules.retain(|r| !(r.name == name && r.table == table));
6729        before != self.rules.len()
6730    }
6731
6732    pub fn create_table(&mut self, schema: TableSchema) -> Result<(), StorageError> {
6733        if self.by_name.contains_key(&schema.name) {
6734            return Err(StorageError::DuplicateTable {
6735                name: schema.name.clone(),
6736            });
6737        }
6738        let idx = self.tables.len();
6739        let name = schema.name.clone();
6740        let mut t = Table::new(schema);
6741        // v7.38.18 (S2) — the table inherits the database's collation,
6742        // which is what its undeclared text columns compare under.
6743        t.set_db_collation(self.db_collation());
6744        self.tables.push(t);
6745        self.by_name.insert(name.clone(), idx);
6746        // v7.39 (round 496) — see `dirty_tables`.
6747        self.dirty_tables.insert(name);
6748        // v7.37.15 (Phase C.1) — stamp the new relation with a stable,
6749        // monotonic, never-reused RelId. Pre-increment so ids start at
6750        // 1 (0 = UNASSIGNED); a later DROP TABLE frees the slot but not
6751        // the id.
6752        self.next_rel_id += 1;
6753        let rid = row_header::RelId(self.next_rel_id);
6754        self.tables[idx].set_rel_id(rid);
6755        Ok(())
6756    }
6757
6758    /// v7.39 (round 436) — the session's temporary table of this name wins
6759    /// over a permanent one, as `pg_temp` does in PG's search path and as
6760    /// MySQL's TEMPORARY shadowing does. Every name → index resolution in
6761    /// this catalog goes through here.
6762    fn resolve_index(&self, name: &str) -> Option<usize> {
6763        if let Some(prefix) = &self.temp_prefix {
6764            let mut mangled = String::with_capacity(prefix.len() + name.len());
6765            mangled.push_str(prefix);
6766            mangled.push_str(name);
6767            if let Some(idx) = self.by_name.get(&mangled) {
6768                return Some(*idx);
6769            }
6770        }
6771        self.by_name.get(name).copied()
6772    }
6773
6774    /// v7.39 (round 436) — install the calling session's temp namespace.
6775    /// `None` disables temp resolution entirely (a session that never made
6776    /// one pays a single `Option` check per lookup).
6777    pub fn set_temp_prefix(&mut self, prefix: Option<String>) {
6778        self.temp_prefix = prefix;
6779    }
6780
6781    /// The mangled storage name a temp table of `name` takes in this
6782    /// session, or `None` when the session has no temp namespace.
6783    #[must_use]
6784    pub fn temp_name_for(&self, name: &str) -> Option<String> {
6785        self.temp_prefix
6786            .as_ref()
6787            .map(|p| alloc::format!("{p}{name}"))
6788    }
6789
6790    pub fn get(&self, name: &str) -> Option<&Table> {
6791        let idx = self.resolve_index(name)?;
6792        self.tables.get(idx)
6793    }
6794
6795    pub fn get_mut(&mut self, name: &str) -> Option<&mut Table> {
6796        let idx = self.resolve_index(name)?;
6797        // v7.39 (round 496) — the choke point for changing a table, so the
6798        // record is taken here. Over-approximate on purpose: a caller that
6799        // takes the handle and writes nothing merely carries that table
6800        // through a commit, which is the old behaviour.
6801        let recorded = self.tables.get(idx).map(|t| t.schema().name.clone());
6802        if let Some(n) = recorded {
6803            self.dirty_tables.insert(n);
6804        }
6805        self.tables.get_mut(idx)
6806    }
6807
6808    /// v7.39 (round 496) — the tables changed through this handle since
6809    /// [`Self::clear_dirty_tables`]. See `dirty_tables`.
6810    #[must_use]
6811    pub fn dirty_tables(&self) -> &alloc::collections::BTreeSet<String> {
6812        &self.dirty_tables
6813    }
6814
6815    /// r1059 — mark one table dirty without taking its handle. The
6816    /// rebase/merge paths replace a tx's shadow with a fresh base
6817    /// clone and must carry the tx's OWN dirty window across (the
6818    /// base's set is an ever-growing history, never cleared).
6819    pub fn mark_table_dirty(&mut self, name: &str) {
6820        self.dirty_tables.insert(name.into());
6821    }
6822
6823    /// v7.39 (round 496) — start a fresh recording window. A transaction's
6824    /// shadow calls this at BEGIN so the set means "changed by this tx".
6825    /// 7.38.1 S3.1 — one window covers both records (tables and the
6826    /// non-table families).
6827    pub fn clear_dirty_tables(&mut self) {
6828        self.dirty_tables.clear();
6829        self.dirty_nontable.clear();
6830    }
6831
6832    /// 7.38.1 S3.1 (D4) — record a non-table object as changed by this
6833    /// window. Called from every create/alter/rename/drop of the six
6834    /// [`NonTableKind`] families; a rename records BOTH names.
6835    fn mark_nontable_dirty(&mut self, kind: NonTableKind, name: &str) {
6836        self.dirty_nontable.insert((kind, name.into()));
6837    }
6838
6839    /// 7.38.1 S3.1 (D4) — reconcile the six non-table families with
6840    /// `base` (the latest committed catalog): every entry this window
6841    /// did NOT touch is taken from base — existence, definition and
6842    /// absence alike — so a neighbour's CREATE / ALTER / DROP of a
6843    /// sequence, view, matview, enum, domain or composite type
6844    /// survives a poisoned transaction's COMMIT. Entries this window
6845    /// DID touch keep the shadow's version (the tx's own DDL wins its
6846    /// own objects, exactly like the dirty-table merge above it).
6847    pub fn merge_nontable_objects_from(&mut self, base: &Catalog) {
6848        use NonTableKind as K;
6849        fn merge_map<V: Clone>(
6850            kind: NonTableKind,
6851            dirty: &alloc::collections::BTreeSet<(NonTableKind, String)>,
6852            mine: &mut BTreeMap<String, V>,
6853            theirs: &BTreeMap<String, V>,
6854        ) {
6855            let names: alloc::vec::Vec<String> =
6856                mine.keys().chain(theirs.keys()).cloned().collect();
6857            for n in names {
6858                if dirty.contains(&(kind, n.clone())) {
6859                    continue;
6860                }
6861                match theirs.get(&n) {
6862                    Some(v) => {
6863                        mine.insert(n, v.clone());
6864                    }
6865                    None => {
6866                        mine.remove(&n);
6867                    }
6868                }
6869            }
6870        }
6871        let dirty = self.dirty_nontable.clone();
6872        merge_map(K::Sequence, &dirty, &mut self.sequences, &base.sequences);
6873        merge_map(K::View, &dirty, &mut self.views, &base.views);
6874        merge_map(
6875            K::MaterializedView,
6876            &dirty,
6877            &mut self.materialized_views,
6878            &base.materialized_views,
6879        );
6880        merge_map(K::EnumType, &dirty, &mut self.enum_types, &base.enum_types);
6881        merge_map(
6882            K::DomainType,
6883            &dirty,
6884            &mut self.domain_types,
6885            &base.domain_types,
6886        );
6887        merge_map(
6888            K::CompositeType,
6889            &dirty,
6890            &mut self.composite_types,
6891            &base.composite_types,
6892        );
6893    }
6894
6895    /// v7.39 (round 496) — put `table` in at `name`, replacing any table
6896    /// already there and keeping the rest of the catalog untouched.
6897    ///
6898    /// The commit-time table-granularity merge needs exactly this: take
6899    /// the latest committed catalog, then overwrite only the tables the
6900    /// transaction changed.
6901    pub fn install_table(&mut self, name: &str, table: Table) {
6902        match self.by_name.get(name).copied() {
6903            Some(idx) => self.tables[idx] = table,
6904            None => {
6905                let idx = self.tables.len();
6906                self.tables.push(table);
6907                self.by_name.insert(name.into(), idx);
6908            }
6909        }
6910        self.dirty_tables.insert(name.into());
6911    }
6912
6913    /// v7.37.42 (docker-fair SCALARSQ attack) — resolve a table name to
6914    /// its insertion-order index ONCE, so callers that need to fetch the
6915    /// same table many times (per-row PK probes in correlated scalar
6916    /// subqueries) can avoid the per-call `BTreeMap<String, usize>` string
6917    /// descent. The returned index is stable for the lifetime of the
6918    /// catalog snapshot the caller holds (same engine read guard).
6919    pub fn tables_position_of(&self, name: &str) -> Option<usize> {
6920        self.resolve_index(name)
6921    }
6922
6923    /// Direct positional fetch counterpart to [`tables_position_of`].
6924    /// `idx` must come from `tables_position_of` against the same catalog
6925    /// snapshot — out-of-range returns `None`.
6926    pub fn tables_at(&self, idx: usize) -> Option<&Table> {
6927        self.tables.get(idx)
6928    }
6929
6930    /// v7.34 (crash-recovery P0 #2) — replay a row-level redo log onto
6931    /// this catalog (the [`RowChange`] physical-redo apply primitive that
6932    /// row-level WAL recovery will use in place of statement re-execution).
6933    /// Applies each change in order via the same `Table` mutators the
6934    /// engine used — no uniqueness/FK/parse/plan: the original execution
6935    /// already validated, replay trusts and applies. Positions are
6936    /// physical and only valid when replayed from the matching checkpoint
6937    /// baseline in original order (see [`RowChange`] docs).
6938    ///
6939    /// A change naming an absent table, or whose position is out of range,
6940    /// is a corrupt/misaligned log and surfaces as an error rather than a
6941    /// silent skip.
6942    pub fn apply_redo(&mut self, changes: &[RowChange]) -> Result<(), StorageError> {
6943        // v7.37.5 (mailrs crash-recovery Ask 3) — true batched replay.
6944        // Pre-v7.37.5 each `RowChange::Delete` record ran a fresh
6945        // O(N) PersistentVec rebuild + O(N × indices × log N)
6946        // `rebuild_indices()` — 5000 records × 100k rows × 13 indices
6947        // ≈ 27 min on the mailrs prod-shape WAL.
6948        //
6949        // The strategy: group consecutive changes by table, and for
6950        // each run, compose all the row-level mutations through a
6951        // single "live" tracking vector + a per-table operation log,
6952        // then apply rows + indices ONCE at the end. The result:
6953        //  - DELETE blow-up: O(records × rows × indices × log rows)
6954        //    → O(rows × indices × log rows) — one rebuild per run.
6955        //  - Row-position semantics preserved: positions in a later
6956        //    `Delete` / `Update` record reference the layout produced
6957        //    by every earlier change; we walk the live-vector
6958        //    forward as each change is processed so positions
6959        //    translate correctly to the ORIGINAL row index space.
6960        //
6961        // For correctness, even with this batching `apply_redo`
6962        // remains in-order: a single per-table run only batches
6963        // a contiguous slice of changes targeting that table; a
6964        // mid-run change targeting a DIFFERENT table forces a
6965        // flush of the current run.
6966        let mut runs: alloc::vec::Vec<(String, alloc::vec::Vec<&RowChange>)> =
6967            alloc::vec::Vec::new();
6968        for change in changes {
6969            // v7.39 (flip crash-replay P0) — a replayed tombstone carries
6970            // the xmax the CRASHED process allocated, but this process's
6971            // version cursor restarted; without advancing it past every
6972            // replayed version, `Snapshot::visible`'s "deletion is in the
6973            // future" branch (xmax > snapshot.version) resurrects every
6974            // replayed delete. Same recovery contract as the snapshot
6975            // loader (`observe_persisted_version`, the pg_control-style
6976            // nextXid recovery).
6977            if let RowChange::Tombstone { xmax, .. } = change {
6978                row_header::observe_persisted_version(*xmax);
6979            }
6980            let table = match change {
6981                RowChange::Insert { table, .. }
6982                | RowChange::Update { table, .. }
6983                | RowChange::Delete { table, .. }
6984                | RowChange::Tombstone { table, .. } => table.clone(),
6985            };
6986            if runs.last().map(|(t, _)| t.as_str()) != Some(table.as_str()) {
6987                runs.push((table, alloc::vec::Vec::new()));
6988            }
6989            runs.last_mut().unwrap().1.push(change);
6990        }
6991        for (table_name, run) in runs {
6992            self.apply_redo_run_on_table(&table_name, &run)?;
6993        }
6994        Ok(())
6995    }
6996
6997    /// v7.37.5 — apply a contiguous slice of `RowChange`s all
6998    /// targeting the same `table_name`. Composes row mutations
6999    /// through a single live-tracking vector + a single tail
7000    /// for appended `Insert`s + a single in-place edit set for
7001    /// `Update`s, then writes the final row layout to
7002    /// `self.rows` and rebuilds indices ONCE.
7003    fn apply_redo_run_on_table(
7004        &mut self,
7005        table_name: &str,
7006        run: &[&RowChange],
7007    ) -> Result<(), StorageError> {
7008        // Look up the table once; the unchecked unwrap is safe
7009        // because the caller just resolved `table_name` for each
7010        // change.
7011        let table = self.get_mut(table_name).ok_or_else(|| {
7012            StorageError::Corrupt(alloc::format!("redo: unknown table {table_name:?}"))
7013        })?;
7014        // Live-tracking over both pre-existing rows and tail-
7015        // appended Insert rows. `live[i] = true` initially for
7016        // every existing row. Appended Inserts extend with `true`.
7017        // A `Delete` flips entries to `false` (using the position
7018        // mapping that walks live indices in order). An `Update`
7019        // edits in place — collected into an overlay map keyed by
7020        // ORIGINAL row position so later Updates win.
7021        let original_rows: alloc::vec::Vec<Row<'static>> = table.rows().iter().cloned().collect();
7022        let mut live: alloc::vec::Vec<bool> = alloc::vec![true; original_rows.len()];
7023        let mut tail: alloc::vec::Vec<Row<'static>> = alloc::vec::Vec::new();
7024        // Overlay: index into ORIGINAL row space (existing rows
7025        // 0..original_rows.len()) or into tail (offset
7026        // original_rows.len()). Map -> new values.
7027        let mut overlay: alloc::collections::BTreeMap<usize, alloc::vec::Vec<Value<'static>>> =
7028            alloc::collections::BTreeMap::new();
7029        // v7.37.15 (Epic W durable-tombstone slice) — extra bookkeeping
7030        // ONLY when this run actually carries an in-place `Tombstone`.
7031        // A tombstone keeps its row physically present but stamps `xmax`
7032        // on the header; the run finalizer `set_rows_and_rebuild_indices`
7033        // freezes every header (and reassigns ids), so we must re-stamp
7034        // in a post-pass keyed by RowId. When the run has no tombstone
7035        // (every default gate-off replay) this is all skipped and the
7036        // path below stays byte-for-byte the legacy one.
7037        let has_tomb = run.iter().any(|c| matches!(c, RowChange::Tombstone { .. }));
7038        // Ids of the pre-existing rows, snapshotted parallel to
7039        // `original_rows`, and ids of the tail rows filled from each
7040        // `Insert`'s carried `rowid`. Together they let a tombstone name
7041        // the exact row the writer stamped, independent of the ids the
7042        // finalizer will hand out. (When `!has_tomb`, both stay empty.)
7043        // v7.39 (flip crash-replay P0) — ids are tracked UNCONDITIONALLY
7044        // now: the finalizer preserves them so a later WAL record's
7045        // tombstone can still name rows this record produced.
7046        let orig_rowids: alloc::vec::Vec<row_header::RowId> =
7047            table.rowids().iter().copied().collect();
7048        // Headers snapshotted in lock-step: the finalizer preserves
7049        // them so earlier records' tombstone stamps survive.
7050        let orig_headers: alloc::vec::Vec<row_header::RowHeader> =
7051            table.headers().iter().copied().collect();
7052        let mut tail_rowids: alloc::vec::Vec<row_header::RowId> = alloc::vec::Vec::new();
7053        // (RowId, xmax) of every row this run tombstones.
7054        let mut tomb_targets: alloc::vec::Vec<(row_header::RowId, u64)> = alloc::vec::Vec::new();
7055        // Helper: given a "current" position (i.e. position in
7056        // the post-prior-deletes layout), translate to the
7057        // ABSOLUTE position in the unified live + tail space
7058        // by walking the live vector + tail. Returns None when
7059        // the position is out of range.
7060        fn translate(live: &[bool], tail_len: usize, current_pos: usize) -> Option<usize> {
7061            // Walk live[..] counting live entries until we hit
7062            // current_pos. Then if not yet matched, dip into tail.
7063            let mut seen = 0usize;
7064            for (i, &alive) in live.iter().enumerate() {
7065                if alive {
7066                    if seen == current_pos {
7067                        return Some(i);
7068                    }
7069                    seen += 1;
7070                }
7071            }
7072            // Position lives in tail. tail_len rows in the tail
7073            // are all live (we haven't deleted any tail rows in
7074            // this simplification; if we did, we'd extend `live`).
7075            let off = current_pos - seen;
7076            if off < tail_len {
7077                Some(live.len() + off)
7078            } else {
7079                None
7080            }
7081        }
7082        for change in run {
7083            match *change {
7084                RowChange::Insert { row, rowid, .. } => {
7085                    // Validate against schema before recording the
7086                    // change so a corrupt log surfaces as an error
7087                    // rather than silently mis-applying.
7088                    if row.len() != table.schema().columns.len() {
7089                        return Err(StorageError::ArityMismatch {
7090                            expected: table.schema().columns.len(),
7091                            actual: row.len(),
7092                        });
7093                    }
7094                    tail.push(row.clone());
7095                    // Keep the id lock-step with `tail` so a later
7096                    // tombstone (this run or a later WAL record) can
7097                    // find the row by the id the writer captured.
7098                    tail_rowids.push(*rowid);
7099                }
7100                RowChange::Update { pos, new_row, .. } => {
7101                    if new_row.len() != table.schema().columns.len() {
7102                        return Err(StorageError::ArityMismatch {
7103                            expected: table.schema().columns.len(),
7104                            actual: new_row.len(),
7105                        });
7106                    }
7107                    let abs = translate(&live, tail.len(), *pos).ok_or_else(|| {
7108                        StorageError::Corrupt(alloc::format!(
7109                            "redo: update_row position {pos} out of bounds in table {table_name:?}",
7110                        ))
7111                    })?;
7112                    // Tail edits are applied directly to `tail`
7113                    // (we own it); existing-row edits land in
7114                    // the overlay map keyed by original index.
7115                    if abs < live.len() {
7116                        overlay.insert(abs, new_row.clone());
7117                    } else {
7118                        tail[abs - live.len()] = Row::new(new_row.clone());
7119                    }
7120                }
7121                RowChange::Delete { positions, .. } => {
7122                    // De-dup + sort so the translate walk stays
7123                    // monotone (the second translate doesn't have
7124                    // to redo work the first one did, in principle;
7125                    // we keep it simple here and re-walk per
7126                    // position). Bounds-filter silently mirrors
7127                    // `Table::delete_rows`.
7128                    let mut sorted: alloc::vec::Vec<usize> = positions.clone();
7129                    sorted.sort_unstable();
7130                    sorted.dedup();
7131                    // Walk live[] once per Delete record to
7132                    // translate all positions in this record's
7133                    // post-prior-deletes layout to absolute
7134                    // indices. We MUST defer the live[] flip
7135                    // until after all positions are translated
7136                    // so two positions in the same record
7137                    // (e.g. [3, 7]) reference the same layout.
7138                    let mut to_flip_live: alloc::vec::Vec<usize> = alloc::vec::Vec::new();
7139                    let mut to_flip_tail: alloc::vec::Vec<usize> = alloc::vec::Vec::new();
7140                    // Two-pointer walk: live[i] scanned monotonically,
7141                    // sorted positions consumed in order.
7142                    let mut seen = 0usize;
7143                    let mut sp = sorted.iter().peekable();
7144                    for (i, &alive) in live.iter().enumerate() {
7145                        if !alive {
7146                            continue;
7147                        }
7148                        while let Some(&&p) = sp.peek() {
7149                            if seen == p {
7150                                to_flip_live.push(i);
7151                                sp.next();
7152                            } else {
7153                                break;
7154                            }
7155                        }
7156                        if sp.peek().is_none() {
7157                            break;
7158                        }
7159                        seen += 1;
7160                    }
7161                    // Remaining positions fall into the tail.
7162                    for &p in sp {
7163                        // p >= seen and refers to the (p - seen)-th
7164                        // entry in tail. Filter out-of-bounds.
7165                        let off = p - seen;
7166                        if off < tail.len() {
7167                            to_flip_tail.push(off);
7168                        }
7169                    }
7170                    for i in to_flip_live {
7171                        live[i] = false;
7172                        // Any pending overlay edit for this
7173                        // index is moot — the row is gone.
7174                        overlay.remove(&i);
7175                    }
7176                    // Tail deletes: remove in REVERSE order so
7177                    // shifting indices stay valid.
7178                    to_flip_tail.sort_unstable();
7179                    to_flip_tail.dedup();
7180                    for off in to_flip_tail.into_iter().rev() {
7181                        tail.remove(off);
7182                        {
7183                            // Keep the id vector lock-step with `tail`.
7184                            tail_rowids.remove(off);
7185                        }
7186                        // Re-key tail-relative overlay entries that
7187                        // were past `off` — in practice tail edits
7188                        // are applied directly so the overlay map
7189                        // only holds existing-row keys; nothing to
7190                        // do here.
7191                    }
7192                }
7193                RowChange::Tombstone { rowids, xmax, .. } => {
7194                    // An in-place tombstone leaves the row physically
7195                    // present — it does not touch `live` / `tail` /
7196                    // `overlay`. Record the (id, xmax) targets; the
7197                    // post-finalizer pass re-stamps `xmax` onto the
7198                    // matching row's (otherwise-frozen) header.
7199                    for rid in rowids {
7200                        tomb_targets.push((*rid, *xmax));
7201                    }
7202                }
7203            }
7204        }
7205        // Compose the final row layout: keep existing rows where
7206        // live[i] = true, applying overlay edits in place; then
7207        // append the surviving tail.
7208        let mut new_rows: PersistentVec<Row> = PersistentVec::new();
7209        let mut new_hot_bytes: u64 = 0;
7210        let schema_snapshot = table.schema().clone();
7211        // Parallel to `new_rows` (only built when `has_tomb`): the RowId
7212        // of each row in its FINAL slot, so the post-pass can map a
7213        // tombstone target id → the slot to re-stamp `xmax` on.
7214        let mut final_rowids: alloc::vec::Vec<row_header::RowId> = alloc::vec::Vec::new();
7215        let mut final_headers: alloc::vec::Vec<row_header::RowHeader> = alloc::vec::Vec::new();
7216        for (i, row) in original_rows.into_iter().enumerate() {
7217            if !live[i] {
7218                continue;
7219            }
7220            let final_row = if let Some(new_values) = overlay.remove(&i) {
7221                Row::new(new_values)
7222            } else {
7223                row
7224            };
7225            new_hot_bytes = new_hot_bytes
7226                .saturating_add(row_body_encoded_len(&final_row, &schema_snapshot) as u64);
7227            new_rows.push_mut(final_row);
7228            final_rowids.push(
7229                orig_rowids
7230                    .get(i)
7231                    .copied()
7232                    .unwrap_or(row_header::RowId::UNASSIGNED),
7233            );
7234            final_headers.push(
7235                orig_headers
7236                    .get(i)
7237                    .copied()
7238                    .unwrap_or_else(row_header::RowHeader::frozen),
7239            );
7240        }
7241        for (off, row) in tail.into_iter().enumerate() {
7242            new_hot_bytes =
7243                new_hot_bytes.saturating_add(row_body_encoded_len(&row, &schema_snapshot) as u64);
7244            new_rows.push_mut(row);
7245            final_rowids.push(
7246                tail_rowids
7247                    .get(off)
7248                    .copied()
7249                    .unwrap_or(row_header::RowId::UNASSIGNED),
7250            );
7251            final_headers.push(row_header::RowHeader::frozen());
7252        }
7253        // v7.39 (flip crash-replay P0) — id-preserving finalizer, so a
7254        // LATER WAL record's tombstone still resolves rows this record
7255        // produced (per-statement replay used to reassign ids between
7256        // records, orphaning every cross-record tombstone target).
7257        table.set_rows_and_rebuild_indices_with_rowids(
7258            new_rows,
7259            new_hot_bytes,
7260            &final_rowids,
7261            &final_headers,
7262        );
7263        // v7.37.15 (Epic W durable-tombstone slice) — header-preserving
7264        // re-stamp. `set_rows_and_rebuild_indices` above froze every
7265        // header, so any row this run tombstoned is currently all-
7266        // visible again. Re-apply the `xmax` stamp by matching the
7267        // tombstone's target RowId against the final-slot id map. This
7268        // is what makes a gate-on DELETE durable across replay without
7269        // changing the on-disk snapshot format (headers/ids are still
7270        // NOT serialised — that is the deferred V6 coupling; see below).
7271        if has_tomb && !tomb_targets.is_empty() {
7272            let mut id_to_slot: alloc::collections::BTreeMap<row_header::RowId, usize> =
7273                alloc::collections::BTreeMap::new();
7274            for (slot, rid) in final_rowids.iter().enumerate() {
7275                if *rid != row_header::RowId::UNASSIGNED {
7276                    id_to_slot.insert(*rid, slot);
7277                }
7278            }
7279            let table = self.get_mut(table_name).ok_or_else(|| {
7280                StorageError::Corrupt(alloc::format!("redo: unknown table {table_name:?}"))
7281            })?;
7282            for (rid, xmax) in &tomb_targets {
7283                match id_to_slot.get(rid) {
7284                    Some(&slot) => {
7285                        // First-deleter-wins + bounds handled inside.
7286                        let _ = table.mark_row_deleted(slot, *xmax);
7287                    }
7288                    None => {
7289                        // The target row was not produced by THIS redo
7290                        // run and its id was not in the run-start
7291                        // snapshot — the documented cross-checkpoint
7292                        // limitation: after a checkpoint restore the
7293                        // table's ids are reassigned (not yet persisted
7294                        // in the envelope), so a tombstone naming a
7295                        // pre-checkpoint row cannot be resolved by id.
7296                        // Skipping leaves the row visible (identical to
7297                        // the pre-Epic-W non-durable behaviour); it is
7298                        // never a correctness regression, only an
7299                        // unclosed durability gap the V6 envelope slice
7300                        // closes. Counted for observability.
7301                        UNRESOLVED_TOMBSTONES.fetch_add(1, core::sync::atomic::Ordering::Relaxed);
7302                    }
7303                }
7304            }
7305        }
7306        Ok(())
7307    }
7308
7309    fn table_for_redo(&mut self, name: &str) -> Result<&mut Table, StorageError> {
7310        self.get_mut(name)
7311            .ok_or_else(|| StorageError::Corrupt(alloc::format!("redo: unknown table {name:?}")))
7312    }
7313
7314    /// v7.34 (crash-recovery P0 #2) — enable row-level redo capture on
7315    /// every table (the engine calls this before a mutating statement
7316    /// when persistence is on; idempotent, keeps any in-flight capture).
7317    pub fn enable_redo_all(&mut self) {
7318        for t in &mut self.tables {
7319            t.enable_redo();
7320        }
7321    }
7322
7323    /// v7.34 — drain the row-level redo captured across all tables, in
7324    /// table order then per-table apply order, and stop capturing. The
7325    /// engine calls this after a successful mutating statement and writes
7326    /// the returned [`RowChange`]s to the WAL in place of the SQL text.
7327    pub fn drain_redo(&mut self) -> Vec<RowChange> {
7328        let mut all = Vec::new();
7329        for t in &mut self.tables {
7330            all.extend(t.take_redo());
7331        }
7332        all
7333    }
7334
7335    pub fn table_count(&self) -> usize {
7336        self.tables.len()
7337    }
7338
7339    /// v7.14.0 — remove a table by name. Returns `true` when the
7340    /// table existed (and is now gone), `false` when it didn't.
7341    /// Used by `DROP TABLE` from pg_dump / mysqldump preambles
7342    /// where the dump re-creates schema and starts with
7343    /// `DROP TABLE IF EXISTS`.
7344    pub fn drop_table(&mut self, name: &str) -> bool {
7345        // v7.39 (round 436) — resolve through the session's temp namespace
7346        // first, exactly as a read would: MariaDB's plain `DROP TABLE tmp`
7347        // drops the TEMPORARY one and leaves a permanent namesake standing
7348        // (measured). Removing by the raw name would have dropped the
7349        // permanent table out from under every other session.
7350        let key = match self.temp_prefix.as_ref() {
7351            Some(p) => {
7352                let mangled = alloc::format!("{p}{name}");
7353                if self.by_name.contains_key(&mangled) {
7354                    mangled
7355                } else {
7356                    name.into()
7357                }
7358            }
7359            None => name.into(),
7360        };
7361        let Some(idx) = self.by_name.remove(&key) else {
7362            return false;
7363        };
7364        // v7.39 (round 496) — see `dirty_tables`. Recorded under the
7365        // RESOLVED key, which is what a commit-time merge looks up.
7366        self.dirty_tables.insert(key.clone());
7367        // swap_remove invalidates the trailing index → rebuild
7368        // by_name for affected entries.
7369        self.tables.swap_remove(idx);
7370        // Re-stamp moved table's index slot in by_name.
7371        if idx < self.tables.len() {
7372            let moved_name = self.tables[idx].schema.name.clone();
7373            self.by_name.insert(moved_name, idx);
7374        }
7375        true
7376    }
7377
7378    /// v7.16.2 — rename a table (mailrs round-10 A.5). Updates
7379    /// the schema name, the catalog name → index map, and
7380    /// rewrites every reference dangling at the table name:
7381    ///   * every FK on every OTHER table whose `parent_table`
7382    ///     pointed at the old name now points at the new
7383    ///     name, so FK enforcement keeps working
7384    ///   * every trigger watching the table updates its `table`
7385    ///     field
7386    /// Returns `Ok` on success; `Err(StorageError::TableNotFound)`
7387    /// when the old name isn't in the catalog and
7388    /// `Err(StorageError::DuplicateTable)` when the new name is
7389    /// already taken.
7390    pub fn rename_table(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
7391        if old == new {
7392            return Ok(());
7393        }
7394        if self.by_name.contains_key(new) {
7395            return Err(StorageError::Corrupt(format!(
7396                "rename_table: target name {new:?} already exists"
7397            )));
7398        }
7399        let idx = self
7400            .by_name
7401            .remove(old)
7402            .ok_or_else(|| StorageError::TableNotFound { name: old.into() })?;
7403        self.tables[idx].schema.name = new.to_string();
7404        self.by_name.insert(new.to_string(), idx);
7405        for t in &mut self.tables {
7406            for fk in &mut t.schema.foreign_keys {
7407                if fk.parent_table == old {
7408                    fk.parent_table = new.to_string();
7409                }
7410            }
7411        }
7412        for trig in &mut self.triggers {
7413            if trig.table == old {
7414                trig.table = new.to_string();
7415            }
7416        }
7417        Ok(())
7418    }
7419
7420    /// v7.16.2 — rename an index by name. Walks every table
7421    /// since the index lives on its owning table; updates the
7422    /// name in place. Errors with `IndexNotFound` when no
7423    /// index matches. mailrs round-10 A.5.
7424    pub fn rename_index(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
7425        if old == new {
7426            return Ok(());
7427        }
7428        // Reject the new name if it already exists anywhere.
7429        for t in &self.tables {
7430            if t.indices.iter().any(|i| i.name == new) {
7431                return Err(StorageError::Corrupt(format!(
7432                    "rename_index: target name {new:?} already exists"
7433                )));
7434            }
7435        }
7436        for t in &mut self.tables {
7437            for i in &mut t.indices {
7438                if i.name == old {
7439                    i.name = new.to_string();
7440                    return Ok(());
7441                }
7442            }
7443        }
7444        Err(StorageError::IndexNotFound { name: old.into() })
7445    }
7446
7447    /// v7.14.0 — remove a named index across the catalog.
7448    /// Returns `true` when found + dropped.
7449    pub fn drop_named_index(&mut self, name: &str) -> bool {
7450        for t in &mut self.tables {
7451            let before = t.indices.len();
7452            t.indices.retain(|i| i.name != name);
7453            if t.indices.len() != before {
7454                return true;
7455            }
7456        }
7457        false
7458    }
7459
7460    /// Borrow-free copy of every table's name in catalog order
7461    /// (= insertion order, matching the on-disk encoding).
7462    pub fn table_names(&self) -> Vec<String> {
7463        self.tables.iter().map(|t| t.schema.name.clone()).collect()
7464    }
7465
7466    /// v7.39 (round 436) — the marker every session's temporary-table
7467    /// namespace starts with. Public so the catalog synths can tell a
7468    /// temp table from an ordinary one without knowing the session id.
7469    pub const TEMP_NAME_MARKER: &'static str = "__spg_temp_";
7470
7471    /// v7.39 (round 437) — how a stored table name should appear to the
7472    /// CALLING session in a catalog listing (SHOW TABLES, pg_class,
7473    /// information_schema, …):
7474    ///   * an ordinary table → its own name
7475    ///   * this session's temporary table → its logical name, prefix stripped
7476    ///   * another session's temporary table → `None`, i.e. not listed
7477    ///
7478    /// Measured on both oracles: MariaDB 11 and PG 18 each list the calling
7479    /// session's own temporary tables and neither lists anybody else's.
7480    /// Round 436 stored temp tables under a prefix without teaching the
7481    /// listings about it, so the mangled names leaked to every client.
7482    #[must_use]
7483    pub fn listed_name<'a>(&self, stored: &'a str) -> Option<&'a str> {
7484        if !stored.starts_with(Self::TEMP_NAME_MARKER) {
7485            return Some(stored);
7486        }
7487        let prefix = self.temp_prefix.as_ref()?;
7488        stored.strip_prefix(prefix.as_str())
7489    }
7490
7491    /// The listing names of every table this session may see, in catalog
7492    /// order. See [`Catalog::listed_name`].
7493    #[must_use]
7494    pub fn visible_table_names(&self) -> Vec<String> {
7495        self.tables
7496            .iter()
7497            .filter_map(|t| self.listed_name(&t.schema.name).map(String::from))
7498            .collect()
7499    }
7500
7501    /// v5.1: register a cold-tier segment that already lives in
7502    /// memory (caller did the file read). Returns the
7503    /// `segment_id` that `RowLocator::Cold { segment_id, .. }`
7504    /// will reference — currently this is just the index into
7505    /// `cold_segments`, but treat it as an opaque token.
7506    ///
7507    /// Storage is `no_std`, so file I/O is the caller's
7508    /// responsibility — `spg-server` reads the file and forwards
7509    /// the bytes here. The bytes stay resident in the catalog
7510    /// for the life of the `Catalog`, parsed only once.
7511    pub fn load_segment_bytes(&mut self, bytes: Vec<u8>) -> Result<u32, StorageError> {
7512        let id = u32::try_from(self.cold_segments.len()).map_err(|_| {
7513            StorageError::Corrupt("cold segment count would exceed u32::MAX".into())
7514        })?;
7515        let seg = OwnedSegment::from_bytes(bytes)
7516            .map_err(|e| StorageError::Corrupt(format!("cold segment parse failed: {e}")))?;
7517        self.cold_segments.push(Some(Arc::new(seg)));
7518        Ok(id)
7519    }
7520
7521    /// v6.7.3 — register a cold-tier segment at a specific id. Used
7522    /// by the spg-server manifest-boot path so segments whose
7523    /// neighbouring ids were retired by compaction still get back
7524    /// the same `segment_id` they had pre-restart (the
7525    /// `RowLocator::Cold { segment_id }` baked into the BTree-index
7526    /// snapshot persists across restart and must continue to
7527    /// resolve).
7528    ///
7529    /// Pads the Vec with `None` slots up to `target_id` if needed.
7530    /// Errors when the target slot is already occupied (would
7531    /// stomp another segment), the parse fails, or `target_id`
7532    /// exceeds `u32::MAX`.
7533    pub fn load_segment_bytes_at(
7534        &mut self,
7535        target_id: u32,
7536        bytes: Vec<u8>,
7537    ) -> Result<(), StorageError> {
7538        let seg = OwnedSegment::from_bytes(bytes)
7539            .map_err(|e| StorageError::Corrupt(format!("cold segment parse failed: {e}")))?;
7540        let idx = target_id as usize;
7541        while self.cold_segments.len() <= idx {
7542            self.cold_segments.push(None);
7543        }
7544        if self.cold_segments[idx].is_some() {
7545            return Err(StorageError::Corrupt(format!(
7546                "load_segment_bytes_at: segment_id {target_id} already occupied"
7547            )));
7548        }
7549        self.cold_segments[idx] = Some(Arc::new(seg));
7550        Ok(())
7551    }
7552
7553    /// v6.7.3 — retire a cold-tier segment slot (compaction-driven).
7554    /// The physical file is the caller's concern (typically kept
7555    /// on disk until the next CHECKPOINT writes a manifest that
7556    /// no longer lists it); this just flips the in-memory slot
7557    /// to `None` so later cold lookups for `segment_id` resolve
7558    /// as "unknown" instead of returning a stale row.
7559    ///
7560    /// No-op when the slot is already `None`. Errors only when
7561    /// `segment_id` is out of bounds.
7562    pub fn tombstone_segment(&mut self, segment_id: u32) -> Result<(), StorageError> {
7563        let idx = segment_id as usize;
7564        if idx >= self.cold_segments.len() {
7565            return Err(StorageError::Corrupt(format!(
7566                "tombstone_segment: segment_id {segment_id} out of bounds (len={})",
7567                self.cold_segments.len()
7568            )));
7569        }
7570        self.cold_segments[idx] = None;
7571        Ok(())
7572    }
7573
7574    /// Number of *active* (non-tombstoned) cold segments.
7575    #[must_use]
7576    pub fn cold_segment_count(&self) -> usize {
7577        self.cold_segments.iter().filter(|s| s.is_some()).count()
7578    }
7579
7580    /// v7.37.42 (docker-fair SCALARSQ attack 3) — short-circuit guard
7581    /// for scan loops that conditionally walk the cold tier. Returns
7582    /// `false` when the catalog has never loaded a cold segment (or all
7583    /// segments are tombstoned), so callers can skip the per-table cold
7584    /// PK-index walk entirely on hot-only databases. O(N segments);
7585    /// typical N is small (single-digit) so the check is sub-µs.
7586    #[must_use]
7587    pub fn has_any_cold_segments(&self) -> bool {
7588        self.cold_segments.iter().any(Option::is_some)
7589    }
7590
7591    /// Slot count including tombstones (= the next id the
7592    /// no-arg `load_segment_bytes` would allocate).
7593    #[must_use]
7594    pub fn cold_segment_slot_count(&self) -> usize {
7595        self.cold_segments.len()
7596    }
7597
7598    /// v6.2.7 — list every *active* cold-tier segment id known to
7599    /// this catalog (skips compaction tombstones since v6.7.3).
7600    /// Used by EXPLAIN ANALYZE to annotate scan nodes with the
7601    /// segments they could have walked.
7602    #[must_use]
7603    pub fn cold_segment_ids_global(&self) -> Vec<u32> {
7604        self.cold_segments
7605            .iter()
7606            .enumerate()
7607            .filter_map(|(i, s)| s.as_ref().map(|_| i as u32))
7608            .collect()
7609    }
7610
7611    /// v5.2.1: sum of `Table::hot_bytes` across every table. The v5.2
7612    /// freezer compares this against `SPG_HOT_TIER_BYTES` (parsed at
7613    /// server startup; default 4 GiB) and wakes when the budget is
7614    /// crossed. Pre-freezer (v5.2.1) this is measurement-only — the
7615    /// counter exposes whether the budget is being approached without
7616    /// triggering any demotion.
7617    #[must_use]
7618    pub fn hot_tier_bytes(&self) -> u64 {
7619        self.tables
7620            .iter()
7621            .map(Table::hot_bytes)
7622            .fold(0u64, u64::saturating_add)
7623    }
7624
7625    /// v5.2.2: freeze the **first** `max_rows` rows of `table_name`'s
7626    /// hot tier into a brand-new cold-tier segment. The named `BTree`
7627    /// index supplies the per-row PK (its column must be an integer
7628    /// type — v5.2.2 only supports `IndexKey::Int` PKs, matching the
7629    /// `index_key_as_u64` constraint used by the cold-tier lookup
7630    /// path). On success returns a [`FreezeReport`] with the
7631    /// freshly-allocated segment id, the count of rows that moved,
7632    /// the encoded segment bytes (so the caller can persist them to
7633    /// disk for later reload via `SPG_PRELOAD_COLD_SEGMENT`), and the
7634    /// hot-tier byte delta that was reclaimed.
7635    ///
7636    /// **Semantics**:
7637    /// 1. The first `max_rows` rows (by hot-tier position — same as
7638    ///    insertion order under v4.39 `PersistentVec`) are read.
7639    /// 2. Rows are sorted ascending by PK and serialised into a new
7640    ///    segment via [`encode_segment`].
7641    /// 3. The hot rows are dropped via [`Table::delete_rows`]; the
7642    ///    `rebuild_indices` it triggers regenerates `Hot` locators
7643    ///    for every remaining row (their positions shift down by
7644    ///    `max_rows`). Existing `Cold` locators in this index — from
7645    ///    a previous freeze — are also rebuilt **but with empty
7646    ///    payload** since rebuild reads only `self.rows`; this
7647    ///    routine re-registers them at the end of the call so the
7648    ///    user-visible state preserves all prior cold locators.
7649    /// 4. The new segment is loaded into `self.cold_segments` via
7650    ///    [`Catalog::load_segment_bytes`] (allocating a fresh
7651    ///    `segment_id`). New `Cold` locators are registered on the
7652    ///    named index — one per frozen row.
7653    ///
7654    /// **v5.2.2 limits** (relaxed in later sub-versions):
7655    /// - INSERT-only flow: subsequent UPDATE/DELETE on a frozen row
7656    ///   returns a stale-locator error (no promote-on-write until
7657    ///   v5.2.3).
7658    /// - Single-table scope: callers iterate tables themselves.
7659    /// - All-or-nothing: returns `Err` and leaves catalog unchanged
7660    ///   if any step fails before the atomic swap point.
7661    ///
7662    /// Errors:
7663    /// - [`StorageError::Corrupt`] for missing table/index, non-`BTree`
7664    ///   index, non-integer PK column, `max_rows == 0`, or
7665    ///   `max_rows > row_count`.
7666    /// - The encoder's [`SegmentError`] surfaces as `Corrupt` (the
7667    ///   only realistic source is "a single row is larger than the
7668    ///   page size"; SPG schemas don't hit it in practice).
7669    pub fn freeze_oldest_to_cold(
7670        &mut self,
7671        table_name: &str,
7672        index_name: &str,
7673        max_rows: usize,
7674    ) -> Result<FreezeReport, StorageError> {
7675        // --- validation phase: never mutates ---------------------
7676        if max_rows == 0 {
7677            return Err(StorageError::Corrupt(
7678                "freeze_oldest_to_cold: max_rows must be > 0".into(),
7679            ));
7680        }
7681        let table = self.get(table_name).ok_or_else(|| {
7682            StorageError::Corrupt(format!(
7683                "freeze_oldest_to_cold: table {table_name:?} not found"
7684            ))
7685        })?;
7686        if max_rows > table.rows.len() {
7687            return Err(StorageError::Corrupt(format!(
7688                "freeze_oldest_to_cold: max_rows {max_rows} > row_count {}",
7689                table.rows.len()
7690            )));
7691        }
7692        let idx = table
7693            .indices
7694            .iter()
7695            .find(|i| i.name == index_name)
7696            .ok_or_else(|| {
7697                StorageError::Corrupt(format!(
7698                    "freeze_oldest_to_cold: index {index_name:?} not found on {table_name:?}"
7699                ))
7700            })?;
7701        if !matches!(idx.kind, IndexKind::BTree(_)) {
7702            return Err(StorageError::Corrupt(format!(
7703                "freeze_oldest_to_cold: index {index_name:?} is NSW; only BTree indices may freeze"
7704            )));
7705        }
7706        let column_position = idx.column_position;
7707
7708        // --- segment build phase: reads only --------------------
7709        let schema = table.schema.clone();
7710        let mut to_freeze: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(max_rows);
7711        for row_idx in 0..max_rows {
7712            let row = table.rows.get(row_idx).expect("bounds-checked above");
7713            let key = IndexKey::from_value(&row.values[column_position]).ok_or_else(|| {
7714                StorageError::Corrupt(format!(
7715                    "freeze_oldest_to_cold: row {row_idx} has NULL / non-key value in index column"
7716                ))
7717            })?;
7718            let pk_u64 = index_key_as_u64(&key).ok_or_else(|| {
7719                StorageError::Corrupt(format!(
7720                    "freeze_oldest_to_cold: index {index_name:?} column type is non-integer; \
7721                     v5.2.2 cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
7722                ))
7723            })?;
7724            to_freeze.push((pk_u64, encode_row_body_dense(row, &schema), key));
7725        }
7726        // encode_segment requires ascending u64 keys. Sort by PK
7727        // before encoding; the caller's row-position order is not
7728        // necessarily PK order (e.g. workloads that insert random
7729        // PKs).
7730        to_freeze.sort_by_key(|(k, _, _)| *k);
7731        // Reject duplicate PKs — encode_segment also rejects them
7732        // (`SegmentError::UnsortedKey`), but the resulting error
7733        // message there is misleading. Surface a clearer one.
7734        for w in to_freeze.windows(2) {
7735            if w[0].0 == w[1].0 {
7736                return Err(StorageError::Corrupt(format!(
7737                    "freeze_oldest_to_cold: duplicate PK {} in freeze batch",
7738                    w[0].0
7739                )));
7740            }
7741        }
7742        // Snapshot the (key, locator) pairs that will be registered
7743        // post-swap. Cloning the IndexKey out before the move makes
7744        // the registration loop borrow-free.
7745        let post_swap_keys: Vec<IndexKey> = to_freeze.iter().map(|(_, _, k)| k.clone()).collect();
7746        // Segment encode is now infallible w.r.t. ordering. Map the
7747        // `SegmentError` into a `StorageError::Corrupt` so the
7748        // public surface stays one error type.
7749        let seg_rows: Vec<(u64, Vec<u8>)> = to_freeze
7750            .into_iter()
7751            .map(|(k, body, _)| (k, body))
7752            .collect();
7753        let frozen_rows = seg_rows.len();
7754        let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
7755            .map_err(|e| StorageError::Corrupt(format!("freeze_oldest_to_cold: encode: {e}")))?;
7756
7757        // --- atomic swap phase: mutations only past this point ---
7758        // v5.2.3 made `Table::rebuild_indices` preserve every Cold
7759        // locator across the per-table rebuild, so `delete_rows`
7760        // below no longer wipes prior-freeze cold entries. The pre-
7761        // v5.2.3 capture-then-re-register that used to live here
7762        // was removed in v5.3.1 — keeping it would double-count
7763        // every prior-frozen key's Cold locator on each subsequent
7764        // freeze.
7765        let bytes_before = self.get(table_name).expect("just validated").hot_bytes();
7766        let positions: Vec<usize> = (0..max_rows).collect();
7767        let t_mut = self
7768            .get_mut(table_name)
7769            .expect("just validated; still present");
7770        let removed = t_mut.delete_rows(&positions);
7771        debug_assert_eq!(removed, max_rows, "delete_rows count matches request");
7772        let bytes_after = t_mut.hot_bytes();
7773        let bytes_freed = bytes_before.saturating_sub(bytes_after);
7774
7775        let segment_id = self
7776            .load_segment_bytes(seg_bytes.clone())
7777            .map_err(|e| StorageError::Corrupt(format!("freeze_oldest_to_cold: load: {e}")))?;
7778        let new_cold = post_swap_keys.into_iter().map(|k| {
7779            (
7780                k,
7781                RowLocator::Cold {
7782                    segment_id,
7783                    page_offset: 0,
7784                },
7785            )
7786        });
7787        let t_mut = self.get_mut(table_name).expect("still present");
7788        t_mut.register_cold_locators(index_name, new_cold)?;
7789        // r944 — a freeze has to say that it froze something.
7790        //
7791        // `has_cold_rows_fast()` reads the cached count, and neither
7792        // freeze path touched it, so afterwards it answered "no cold
7793        // rows" while cold rows existed. That predicate gates four join
7794        // paths, and a gate that wrongly declines the cold-aware path
7795        // drops the frozen rows from the answer.
7796        //
7797        // Marking it stale rather than adding to it: stale reads as
7798        // true, which is the safe direction, and this function cannot
7799        // know the exact total (rows may already have been cold). ANALYZE
7800        // recomputes the number.
7801        t_mut.mark_cold_row_count_stale();
7802
7803        Ok(FreezeReport {
7804            segment_id,
7805            frozen_rows,
7806            bytes_freed,
7807            segment_bytes: seg_bytes,
7808        })
7809    }
7810
7811    /// v5.1: borrow the cold segment at `segment_id`. Used by the
7812    /// spg-server preload path to enumerate (key, locator) pairs
7813    /// after loading a segment, so it can call
7814    /// [`Table::register_cold_locators`] without re-parsing the
7815    /// bytes.
7816    #[must_use]
7817    pub fn cold_segment(&self, segment_id: u32) -> Option<&OwnedSegment> {
7818        self.cold_segments
7819            .get(segment_id as usize)
7820            .and_then(|s| s.as_deref())
7821    }
7822
7823    /// v5.1: resolve a single `RowLocator::Cold` to its underlying
7824    /// `Row`. Decoupled from [`Catalog::lookup_by_pk`] so callers
7825    /// iterating a multi-locator slice (e.g. the engine's index
7826    /// seek path) can dispatch per locator instead of getting back
7827    /// only the first row for a key. Returns `None` when the
7828    /// segment isn't registered, the key isn't `u64`-coercible, or
7829    /// the segment doesn't actually carry the key (bloom or page-
7830    /// index reject).
7831    pub fn resolve_cold_locator(
7832        &self,
7833        table_name: &str,
7834        segment_id: u32,
7835        key: &IndexKey,
7836    ) -> Option<Row<'static>> {
7837        let t = self.get(table_name)?;
7838        let u64_key = index_key_as_u64(key)?;
7839        let seg = self.cold_segments.get(segment_id as usize)?.as_ref()?;
7840        let payload = seg.lookup(u64_key)?;
7841        let (row, _) = decode_row_body_dense(&payload, &t.schema, seg.codec_version()).ok()?;
7842        // v7.39 (pg_stat blks knife) — one cold-tier "block read".
7843        self.cold_read_stats
7844            .cold_reads
7845            .fetch_add(1, core::sync::atomic::Ordering::Relaxed);
7846        Some(row)
7847    }
7848
7849    /// v5.1: indexed PK lookup that dispatches per locator,
7850    /// returning the first matching row from either the hot tier
7851    /// (`Table::rows`) or a registered cold segment.
7852    ///
7853    /// The cold path requires the index column to be coercible to
7854    /// a `u64` (the segment's PK type) and the segment payload to
7855    /// be a [`encode_row_body_dense`]-encoded row body for the
7856    /// same schema. v5.1 ships this for BIGINT / INT / SMALLINT
7857    /// PKs; other types fall through to hot-only behavior.
7858    ///
7859    /// Returns `None` if (a) the table or index doesn't exist,
7860    /// (b) the key isn't in the index at all, or (c) the key was
7861    /// resolved to a stale locator (Hot index out of range, Cold
7862    /// segment id unknown, segment lookup miss). Does not surface
7863    /// segment-decode errors — those would indicate corrupted
7864    /// cold-tier files and should be caught at
7865    /// [`Catalog::load_segment_bytes`] time.
7866    pub fn lookup_by_pk(&self, table: &str, index_name: &str, key: &IndexKey) -> Option<Row<'_>> {
7867        let t = self.get(table)?;
7868        let idx = t.indices.iter().find(|i| i.name == index_name)?;
7869        let locators = idx.lookup_eq(key);
7870        let cold_u64_key = index_key_as_u64(key);
7871        for loc in locators {
7872            match *loc {
7873                RowLocator::Hot(i) => {
7874                    if let Some(row) = t.rows.get(i) {
7875                        return Some(row.clone());
7876                    }
7877                }
7878                RowLocator::Cold {
7879                    segment_id,
7880                    page_offset: _,
7881                } => {
7882                    let Some(u64_key) = cold_u64_key else {
7883                        // Key type not coercible to u64 — cold tier
7884                        // only handles BIGINT/INT/SMALLINT in v5.1.
7885                        continue;
7886                    };
7887                    let Some(seg) = self
7888                        .cold_segments
7889                        .get(segment_id as usize)
7890                        .and_then(|s| s.as_deref())
7891                    else {
7892                        // v6.7.3 — `None` slot = compaction
7893                        // retired this segment; the live locator
7894                        // on a freshly-compacted index points to
7895                        // the merged segment_id, so a Cold hit
7896                        // here against a tombstone means the BTree
7897                        // entry hasn't been swapped yet (mid-
7898                        // compaction reader race) or the caller is
7899                        // looking up a stale snapshot. Skip — the
7900                        // next locator in the list, if any, is
7901                        // typically the merged segment.
7902                        continue;
7903                    };
7904                    let Some(payload) = seg.lookup(u64_key) else {
7905                        continue;
7906                    };
7907                    let (row, _) =
7908                        decode_row_body_dense(&payload, &t.schema, seg.codec_version()).ok()?;
7909                    return Some(row);
7910                }
7911            }
7912        }
7913        None
7914    }
7915
7916    /// v5.2.3: promote a frozen row back to the hot tier so an
7917    /// UPDATE / DELETE can mutate it. Reads the cold-tier row body
7918    /// (decoded from its registered segment), pushes it into
7919    /// `table.rows` via [`Table::insert`] (which also adds a fresh
7920    /// `Hot(new_idx)` locator on `index_name`), then retires the
7921    /// shadowed `Cold` locator via
7922    /// [`Table::remove_cold_locators_for_key`]. The cold-tier row
7923    /// in the segment file becomes garbage — recoverable when a
7924    /// future cold-segment compaction job lands.
7925    ///
7926    /// Returns:
7927    /// - `Ok(Some(new_hot_idx))` when the key resolved through a
7928    ///   cold locator and the promote completed. `new_hot_idx` is
7929    ///   the position the row now occupies in `table.rows`.
7930    /// - `Ok(None)` when the key has no Cold locator on the index
7931    ///   (already hot, or wasn't present at all). Callers treat this
7932    ///   as "nothing to do here, fall back to the hot-only path".
7933    ///
7934    /// Errors when the table / index doesn't exist, the index isn't
7935    /// `BTree`, the cold segment is missing / can't decode the row,
7936    /// or the inferred row body fails `Table::insert` validation.
7937    pub fn promote_cold_row(
7938        &mut self,
7939        table_name: &str,
7940        index_name: &str,
7941        key: &IndexKey,
7942    ) -> Result<Option<usize>, StorageError> {
7943        let cold_loc = self.find_cold_locator(table_name, index_name, key)?;
7944        let Some((segment_id, _page_offset)) = cold_loc else {
7945            return Ok(None);
7946        };
7947        let u64_key = index_key_as_u64(key).ok_or_else(|| {
7948            StorageError::Corrupt(
7949                "promote_cold_row: key type not coercible to u64 (cold tier requires integer PK)"
7950                    .into(),
7951            )
7952        })?;
7953        // Read the row body from the segment. Borrow the segment +
7954        // schema short-term so we can then take `&mut self` for the
7955        // hot-side insert.
7956        let schema = self
7957            .get(table_name)
7958            .ok_or_else(|| {
7959                StorageError::Corrupt(format!("promote_cold_row: table {table_name:?} not found"))
7960            })?
7961            .schema
7962            .clone();
7963        let seg = self
7964            .cold_segments
7965            .get(segment_id as usize)
7966            .and_then(|s| s.as_ref())
7967            .ok_or_else(|| {
7968                StorageError::Corrupt(format!(
7969                    "promote_cold_row: segment {segment_id} not registered on catalog"
7970                ))
7971            })?;
7972        let payload = seg.lookup(u64_key).ok_or_else(|| {
7973            StorageError::Corrupt(format!(
7974                "promote_cold_row: key {u64_key} resolves to segment {segment_id} \
7975                 but the segment's bloom/page lookup didn't return a row"
7976            ))
7977        })?;
7978        let (row, _consumed) = decode_row_body_dense(&payload, &schema, seg.codec_version())?;
7979        // Insert the promoted row into the hot tier. `Table::insert`
7980        // appends to `self.rows`, adds a `Hot(new_idx)` locator to
7981        // every BTree index covering the row's keyed columns, and
7982        // increments `hot_bytes`.
7983        let t = self
7984            .get_mut(table_name)
7985            .expect("table existed at lookup time");
7986        t.insert(row)?;
7987        let new_hot_idx =
7988            t.rows.len().checked_sub(1).ok_or_else(|| {
7989                StorageError::Corrupt("promote_cold_row: empty after insert".into())
7990            })?;
7991        // The hot insert added Hot(new_idx) alongside the still-
7992        // present Cold locator. Drop the Cold entry so future
7993        // lookups return only the fresh hot row.
7994        t.remove_cold_locators_for_key(index_name, key)?;
7995        Ok(Some(new_hot_idx))
7996    }
7997
7998    /// v5.2.3: shadow a frozen row's index entry. Used by DELETE
7999    /// when the row to remove lives in a cold-tier segment — the
8000    /// row body stays in the segment file (becoming garbage) but
8001    /// every `Cold` locator for `key` on `index_name` is removed
8002    /// so PK lookups stop returning it.
8003    ///
8004    /// Returns the number of cold locators retired (0 when the key
8005    /// has no cold entries — the DELETE fell on a hot row or a
8006    /// key that was already absent). Errors when the table /
8007    /// index doesn't exist or the index isn't `BTree`.
8008    ///
8009    /// Cold-segment compaction (which merges shadowed-heavy
8010    /// segments and reclaims their disk footprint) lands in a
8011    /// later v5.x sub-version; until then, repeated UPDATE/DELETE
8012    /// of cold rows can amplify cold-segment disk usage by up to
8013    /// 1-2× — still well under typical LSM-tree shadowing because
8014    /// SPG segments are bulk-baked, not write-merged.
8015    pub fn shadow_cold_row(
8016        &mut self,
8017        table_name: &str,
8018        index_name: &str,
8019        key: &IndexKey,
8020    ) -> Result<usize, StorageError> {
8021        let t = self.get_mut(table_name).ok_or_else(|| {
8022            StorageError::Corrupt(format!("shadow_cold_row: table {table_name:?} not found"))
8023        })?;
8024        t.remove_cold_locators_for_key(index_name, key)
8025    }
8026
8027    /// v6.7.4 — read-only slice preparation for the parallel
8028    /// freezer. Walks rows in `row_range`, builds the
8029    /// `(pk_u64, encoded_body, IndexKey)` triples that the
8030    /// coordinator's k-way merge consumes, sorts the slice by
8031    /// `pk_u64`, and returns a [`FreezeSlice`].
8032    ///
8033    /// Caller invariants:
8034    /// - `row_range.end <= table.rows.len()` (caller's job to
8035    ///   compute the partition).
8036    /// - All slices passed to `commit_freeze_slices` must cover a
8037    ///   contiguous half-open range `[0, total_max_rows)` with no
8038    ///   gaps and no overlaps. The coordinator validates this
8039    ///   invariant before committing.
8040    ///
8041    /// `&self`-only — multiple workers can run this concurrently
8042    /// against the same `Catalog` reference under the engine's
8043    /// write lock (workers don't mutate; the coordinator does).
8044    pub fn prepare_freeze_slice(
8045        &self,
8046        table_name: &str,
8047        index_name: &str,
8048        row_range: core::ops::Range<usize>,
8049    ) -> Result<FreezeSlice, StorageError> {
8050        let table = self.get(table_name).ok_or_else(|| {
8051            StorageError::Corrupt(format!(
8052                "prepare_freeze_slice: table {table_name:?} not found"
8053            ))
8054        })?;
8055        let idx = table
8056            .indices
8057            .iter()
8058            .find(|i| i.name == index_name)
8059            .ok_or_else(|| {
8060                StorageError::Corrupt(format!(
8061                    "prepare_freeze_slice: index {index_name:?} not found on {table_name:?}"
8062                ))
8063            })?;
8064        if !matches!(idx.kind, IndexKind::BTree(_)) {
8065            return Err(StorageError::Corrupt(format!(
8066                "prepare_freeze_slice: index {index_name:?} is NSW; only BTree indices may freeze"
8067            )));
8068        }
8069        if row_range.end > table.rows.len() {
8070            return Err(StorageError::Corrupt(format!(
8071                "prepare_freeze_slice: row_range end {} > row_count {}",
8072                row_range.end,
8073                table.rows.len()
8074            )));
8075        }
8076        let column_position = idx.column_position;
8077        let schema = table.schema.clone();
8078        let mut rows: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(row_range.len());
8079        for row_idx in row_range.clone() {
8080            let row = table.rows.get(row_idx).expect("bounds-checked above");
8081            let key = IndexKey::from_value(&row.values[column_position]).ok_or_else(|| {
8082                StorageError::Corrupt(format!(
8083                    "prepare_freeze_slice: row {row_idx} has NULL / non-key value in index column"
8084                ))
8085            })?;
8086            let pk_u64 = index_key_as_u64(&key).ok_or_else(|| {
8087                StorageError::Corrupt(format!(
8088                    "prepare_freeze_slice: index {index_name:?} column type is non-integer; \
8089                     v5.2.2 cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
8090                ))
8091            })?;
8092            rows.push((pk_u64, encode_row_body_dense(row, &schema), key));
8093        }
8094        rows.sort_by_key(|(k, _, _)| *k);
8095        Ok(FreezeSlice { row_range, rows })
8096    }
8097
8098    /// v6.7.4 — coordinator commit step. Merges N
8099    /// [`FreezeSlice`]s into one segment via the standard
8100    /// [`encode_segment`] path, atomically swaps the catalog
8101    /// state (delete the union row range + register Cold
8102    /// locators + load the segment).
8103    ///
8104    /// Validates that the slices cover a contiguous, gap-free,
8105    /// overlap-free half-open range starting at index 0 (the
8106    /// freezer always freezes "oldest first" — same semantics as
8107    /// the single-threaded [`Catalog::freeze_oldest_to_cold`]).
8108    ///
8109    /// Empty `slices` → no-op success (returns a zero-row report
8110    /// without mutating). Total row count = `Σ slice.rows.len()`.
8111    pub fn commit_freeze_slices(
8112        &mut self,
8113        table_name: &str,
8114        index_name: &str,
8115        slices: Vec<FreezeSlice>,
8116    ) -> Result<FreezeReport, StorageError> {
8117        // --- validation phase: never mutates ---------------------
8118        let table = self.get(table_name).ok_or_else(|| {
8119            StorageError::Corrupt(format!(
8120                "commit_freeze_slices: table {table_name:?} not found"
8121            ))
8122        })?;
8123        let idx = table
8124            .indices
8125            .iter()
8126            .find(|i| i.name == index_name)
8127            .ok_or_else(|| {
8128                StorageError::Corrupt(format!(
8129                    "commit_freeze_slices: index {index_name:?} not found on {table_name:?}"
8130                ))
8131            })?;
8132        if !matches!(idx.kind, IndexKind::BTree(_)) {
8133            return Err(StorageError::Corrupt(format!(
8134                "commit_freeze_slices: index {index_name:?} is NSW; only BTree indices may freeze"
8135            )));
8136        }
8137        // Validate slice coverage: contiguous from 0, no gaps, no
8138        // overlaps. Allow the caller to pass slices in any order —
8139        // sort by row_range.start first.
8140        let mut ordered = slices;
8141        ordered.sort_by_key(|s| s.row_range.start);
8142        // Drop fully-empty slices that fell out of an uneven
8143        // partition; they carry no data but contribute to the
8144        // contiguity check, so keep them in line.
8145        let mut expected_start = 0usize;
8146        for s in &ordered {
8147            if s.row_range.start != expected_start {
8148                return Err(StorageError::Corrupt(format!(
8149                    "commit_freeze_slices: gap/overlap at row {}; expected start {}",
8150                    s.row_range.start, expected_start
8151                )));
8152            }
8153            expected_start = s.row_range.end;
8154        }
8155        let max_rows = expected_start;
8156        if max_rows > table.rows.len() {
8157            return Err(StorageError::Corrupt(format!(
8158                "commit_freeze_slices: total row range {} exceeds row_count {}",
8159                max_rows,
8160                table.rows.len()
8161            )));
8162        }
8163        if max_rows == 0 {
8164            return Ok(FreezeReport {
8165                segment_id: u32::MAX,
8166                frozen_rows: 0,
8167                bytes_freed: 0,
8168                segment_bytes: Vec::new(),
8169            });
8170        }
8171
8172        // --- segment build phase: reads only --------------------
8173        // K-way merge of already-sorted slices. Each slice's rows
8174        // are ascending by pk_u64; we keep a per-slice cursor and
8175        // pull the next-smallest head until every cursor drains.
8176        let total_rows: usize = ordered.iter().map(|s| s.rows.len()).sum();
8177        if total_rows != max_rows {
8178            return Err(StorageError::Corrupt(format!(
8179                "commit_freeze_slices: total slice rows {total_rows} ≠ row_range coverage {max_rows}"
8180            )));
8181        }
8182        let mut cursors: Vec<usize> = alloc::vec![0; ordered.len()];
8183        let mut merged: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(total_rows);
8184        loop {
8185            // Pick the slice whose head row has the smallest key
8186            // and isn't yet exhausted.
8187            let mut pick: Option<usize> = None;
8188            for (i, c) in cursors.iter().enumerate() {
8189                let slice = &ordered[i];
8190                if *c >= slice.rows.len() {
8191                    continue;
8192                }
8193                match pick {
8194                    None => pick = Some(i),
8195                    Some(j) => {
8196                        if slice.rows[*c].0 < ordered[j].rows[cursors[j]].0 {
8197                            pick = Some(i);
8198                        }
8199                    }
8200                }
8201            }
8202            let Some(i) = pick else { break };
8203            let row = ordered[i].rows[cursors[i]].clone();
8204            cursors[i] += 1;
8205            merged.push(row);
8206        }
8207        // Reject duplicate PKs — same error as the single-threaded
8208        // path so callers get a uniform surface.
8209        for w in merged.windows(2) {
8210            if w[0].0 == w[1].0 {
8211                return Err(StorageError::Corrupt(format!(
8212                    "commit_freeze_slices: duplicate PK {} across slices",
8213                    w[0].0
8214                )));
8215            }
8216        }
8217        let post_swap_keys: Vec<IndexKey> = merged.iter().map(|(_, _, k)| k.clone()).collect();
8218        let seg_rows: Vec<(u64, Vec<u8>)> =
8219            merged.into_iter().map(|(k, body, _)| (k, body)).collect();
8220        let frozen_rows = seg_rows.len();
8221        let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
8222            .map_err(|e| StorageError::Corrupt(format!("commit_freeze_slices: encode: {e}")))?;
8223
8224        // --- atomic swap phase: mutations only past this point ---
8225        let bytes_before = self.get(table_name).expect("just validated").hot_bytes();
8226        let positions: Vec<usize> = (0..max_rows).collect();
8227        let t_mut = self
8228            .get_mut(table_name)
8229            .expect("just validated; still present");
8230        let removed = t_mut.delete_rows(&positions);
8231        debug_assert_eq!(removed, max_rows, "delete_rows count matches request");
8232        let bytes_after = t_mut.hot_bytes();
8233        let bytes_freed = bytes_before.saturating_sub(bytes_after);
8234
8235        let segment_id = self
8236            .load_segment_bytes(seg_bytes.clone())
8237            .map_err(|e| StorageError::Corrupt(format!("commit_freeze_slices: load: {e}")))?;
8238        let new_cold = post_swap_keys.into_iter().map(|k| {
8239            (
8240                k,
8241                RowLocator::Cold {
8242                    segment_id,
8243                    page_offset: 0,
8244                },
8245            )
8246        });
8247        let t_mut = self.get_mut(table_name).expect("still present");
8248        t_mut.register_cold_locators(index_name, new_cold)?;
8249        // r944 — a freeze has to say that it froze something.
8250        //
8251        // `has_cold_rows_fast()` reads the cached count, and neither
8252        // freeze path touched it, so afterwards it answered "no cold
8253        // rows" while cold rows existed. That predicate gates four join
8254        // paths, and a gate that wrongly declines the cold-aware path
8255        // drops the frozen rows from the answer.
8256        //
8257        // Marking it stale rather than adding to it: stale reads as
8258        // true, which is the safe direction, and this function cannot
8259        // know the exact total (rows may already have been cold). ANALYZE
8260        // recomputes the number.
8261        t_mut.mark_cold_row_count_stale();
8262
8263        Ok(FreezeReport {
8264            segment_id,
8265            frozen_rows,
8266            bytes_freed,
8267            segment_bytes: seg_bytes,
8268        })
8269    }
8270
8271    /// v6.7.3 — compact every cold segment on `(table, index)` whose
8272    /// `OwnedSegment::bytes().len()` is below `target_segment_bytes`
8273    /// into a single larger merged segment. Rows present in source
8274    /// segment payloads but no longer referenced by any
8275    /// `RowLocator::Cold` on the index (DELETE'd + frozen rows
8276    /// retired via [`Catalog::shadow_cold_row`]) are GC'd in the
8277    /// merge.
8278    ///
8279    /// **Semantics**:
8280    /// 1. Walk the BTree index to collect every Cold locator that
8281    ///    targets a small (< threshold) segment. Each such
8282    ///    `(key, segment_id)` becomes a row in the merged segment;
8283    ///    payload is looked up from the source segment in-place.
8284    /// 2. Encode the collected rows into one new segment via
8285    ///    [`encode_segment`]; register it via
8286    ///    [`Catalog::load_segment_bytes`] (allocating a fresh
8287    ///    `merged_segment_id` at the end of `cold_segments`).
8288    /// 3. Rewrite the BTree index in one pass: every
8289    ///    `RowLocator::Cold { segment_id ∈ sources }` becomes
8290    ///    `RowLocator::Cold { segment_id = merged_id, page_offset = 0 }`.
8291    ///    Hot locators are untouched.
8292    /// 4. Tombstone every source slot via
8293    ///    [`Catalog::tombstone_segment`]. Source segment payloads
8294    ///    are no longer reachable through the catalog; the on-disk
8295    ///    files are the caller's concern.
8296    ///
8297    /// On fewer than 2 candidate segments the catalog is **not**
8298    /// mutated and a no-op report (`merged_segment_id: None`,
8299    /// `sources: []`) is returned. This is the routine case — a
8300    /// freshly-frozen table has at most 1 small segment, no merge
8301    /// possible.
8302    ///
8303    /// Atomicity: every mutating step runs after the read-only
8304    /// gather phase, so a panic before the merge encode leaves the
8305    /// catalog unchanged. The mutation block itself (load + rewrite +
8306    /// tombstone) takes only `&mut self` — callers serialise the
8307    /// engine write lock outside this function.
8308    ///
8309    /// Errors when the table / index doesn't exist, the index isn't
8310    /// `BTree`, the index column type isn't u64-coercible (cold-tier
8311    /// pre-condition), or a source segment fails its in-place
8312    /// row-body lookup (would indicate prior catalog corruption).
8313    pub fn compact_cold_segments(
8314        &mut self,
8315        table_name: &str,
8316        index_name: &str,
8317        target_segment_bytes: u64,
8318    ) -> Result<CompactReport, StorageError> {
8319        // --- validation phase ----------------------------------
8320        let t = self.get(table_name).ok_or_else(|| {
8321            StorageError::Corrupt(format!(
8322                "compact_cold_segments: table {table_name:?} not found"
8323            ))
8324        })?;
8325        let idx = t
8326            .indices
8327            .iter()
8328            .find(|i| i.name == index_name)
8329            .ok_or_else(|| {
8330                StorageError::Corrupt(format!(
8331                    "compact_cold_segments: index {index_name:?} not found on {table_name:?}"
8332                ))
8333            })?;
8334        let map = match &idx.kind {
8335            IndexKind::BTree(m) => m,
8336            IndexKind::Nsw(_)
8337            | IndexKind::Brin { .. }
8338            | IndexKind::Gin(_)
8339            | IndexKind::GinTrgm(_)
8340            | IndexKind::GinFulltext(_)
8341            | IndexKind::GinJsonb(_)
8342            | IndexKind::BTreeMulti(_) => {
8343                return Err(StorageError::Corrupt(format!(
8344                    "compact_cold_segments: index {index_name:?} is not BTree; \
8345                     compaction applies only to BTree cold-tier indices"
8346                )));
8347            }
8348        };
8349
8350        // --- gather phase --------------------------------------
8351        // Step A: every segment_id this BTree index Cold-references.
8352        let mut referenced_ids: BTreeSet<u32> = BTreeSet::new();
8353        for (_key, locators) in map.iter() {
8354            for loc in locators {
8355                if let RowLocator::Cold { segment_id, .. } = loc {
8356                    referenced_ids.insert(*segment_id);
8357                }
8358            }
8359        }
8360        // Step B: keep only the small + still-active ones.
8361        let candidate_set: BTreeSet<u32> = referenced_ids
8362            .into_iter()
8363            .filter(|id| {
8364                self.cold_segments
8365                    .get(*id as usize)
8366                    .and_then(|s| s.as_deref())
8367                    .is_some_and(|s| (s.bytes().len() as u64) < target_segment_bytes)
8368            })
8369            .collect();
8370        if candidate_set.len() < 2 {
8371            return Ok(CompactReport {
8372                sources: Vec::new(),
8373                merged_segment_id: None,
8374                merged_segment_bytes: Vec::new(),
8375                merged_rows: 0,
8376                deleted_rows_pruned: 0,
8377                bytes_reclaimed_estimate: 0,
8378            });
8379        }
8380        // Step C: pre-count source rows for the deleted-pruned metric.
8381        let mut source_row_count: usize = 0;
8382        let mut source_byte_total: u64 = 0;
8383        for &id in &candidate_set {
8384            let seg = self.cold_segments[id as usize]
8385                .as_ref()
8386                .expect("candidate selected only when slot is Some");
8387            source_row_count = source_row_count.saturating_add(seg.meta().num_rows as usize);
8388            source_byte_total = source_byte_total.saturating_add(seg.bytes().len() as u64);
8389        }
8390        // Step D: collect (key, body) pairs from every live Cold
8391        // locator pointing at a candidate. dedupe by key — one
8392        // BTree key resolves to at most one cold payload (the
8393        // freezer + promote/shadow flow keeps Cold locators
8394        // unique per key).
8395        let mut collected: BTreeMap<u64, (Vec<u8>, IndexKey)> = BTreeMap::new();
8396        for (key, locators) in map.iter() {
8397            for loc in locators {
8398                let RowLocator::Cold { segment_id, .. } = loc else {
8399                    continue;
8400                };
8401                if !candidate_set.contains(segment_id) {
8402                    continue;
8403                }
8404                let u64_key = index_key_as_u64(key).ok_or_else(|| {
8405                    StorageError::Corrupt(format!(
8406                        "compact_cold_segments: index {index_name:?} has non-integer Cold key; \
8407                         cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
8408                    ))
8409                })?;
8410                let seg = self.cold_segments[*segment_id as usize]
8411                    .as_ref()
8412                    .expect("candidate slot guaranteed Some above");
8413                let payload = seg.lookup(u64_key).ok_or_else(|| {
8414                    StorageError::Corrupt(format!(
8415                        "compact_cold_segments: BTree {index_name:?} points key={u64_key} \
8416                         at segment {segment_id} but the segment lookup missed"
8417                    ))
8418                })?;
8419                collected.insert(u64_key, (payload, key.clone()));
8420                break;
8421            }
8422        }
8423        let merged_rows = collected.len();
8424        let deleted_rows_pruned = source_row_count.saturating_sub(merged_rows);
8425
8426        // Step E: encode the merged segment. `BTreeMap<u64, _>`
8427        // iteration is ascending by key, which is what
8428        // `encode_segment` requires.
8429        let seg_rows: Vec<(u64, Vec<u8>)> = collected
8430            .iter()
8431            .map(|(k, (body, _))| (*k, body.clone()))
8432            .collect();
8433        let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
8434            .map_err(|e| StorageError::Corrupt(format!("compact_cold_segments: encode: {e}")))?;
8435        let merged_bytes_len = seg_bytes.len() as u64;
8436
8437        // --- atomic mutation phase ------------------------------
8438        let merged_segment_id = self
8439            .load_segment_bytes(seg_bytes.clone())
8440            .map_err(|e| StorageError::Corrupt(format!("compact_cold_segments: load: {e}")))?;
8441
8442        // Rewrite the BTree index: every Cold locator pointing at
8443        // a candidate source becomes a Cold locator pointing at
8444        // the merged segment. Use a flat collect-then-replace
8445        // pattern so we never hold a `&self` borrow across the
8446        // `&mut self` write.
8447        let entries: Vec<(IndexKey, crate::posting::PostingList)> = {
8448            let t = self
8449                .get(table_name)
8450                .expect("table existed at the start of this fn");
8451            let idx = t
8452                .indices
8453                .iter()
8454                .find(|i| i.name == index_name)
8455                .expect("index existed at the start of this fn");
8456            let IndexKind::BTree(map) = &idx.kind else {
8457                unreachable!("validated above");
8458            };
8459            map.iter().map(|(k, v)| (k.clone(), v.clone())).collect()
8460        };
8461        let t_mut = self
8462            .get_mut(table_name)
8463            .expect("table existed at the start of this fn");
8464        let idx_mut = t_mut
8465            .indices
8466            .iter_mut()
8467            .find(|i| i.name == index_name)
8468            .expect("index existed at the start of this fn");
8469        let IndexKind::BTree(map_mut) = &mut idx_mut.kind else {
8470            unreachable!("validated above");
8471        };
8472        for (key, locators) in entries {
8473            let mut new_locs = crate::posting::PostingList::new();
8474            let mut changed = false;
8475            for loc in &locators {
8476                match *loc {
8477                    RowLocator::Cold {
8478                        segment_id,
8479                        page_offset: _,
8480                    } if candidate_set.contains(&segment_id) => {
8481                        let replacement = RowLocator::Cold {
8482                            segment_id: merged_segment_id,
8483                            page_offset: 0,
8484                        };
8485                        if !new_locs.contains(replacement) {
8486                            new_locs.push(replacement);
8487                        }
8488                        changed = true;
8489                    }
8490                    other => new_locs.push(other),
8491                }
8492            }
8493            if changed {
8494                map_mut.insert_mut(key, new_locs);
8495            }
8496        }
8497
8498        // Tombstone every source slot. Last step — failures here
8499        // would leave the segment double-referenced in both
8500        // memory + manifest, but `tombstone_segment` only errors
8501        // on out-of-bounds, which we've already validated.
8502        for &id in &candidate_set {
8503            self.tombstone_segment(id)?;
8504        }
8505
8506        let bytes_reclaimed_estimate = source_byte_total.saturating_sub(merged_bytes_len);
8507        Ok(CompactReport {
8508            sources: candidate_set.into_iter().collect(),
8509            merged_segment_id: Some(merged_segment_id),
8510            merged_segment_bytes: seg_bytes,
8511            merged_rows,
8512            deleted_rows_pruned,
8513            bytes_reclaimed_estimate,
8514        })
8515    }
8516
8517    /// Internal helper: scan `(table, index)` for a `Cold` locator
8518    /// keyed by `key`. Returns `Ok(Some((segment_id, page_offset)))`
8519    /// when found, `Ok(None)` when the key has only hot entries
8520    /// or no entries at all, `Err` on the same input-validation
8521    /// errors as the public `promote_cold_row` / `shadow_cold_row`.
8522    fn find_cold_locator(
8523        &self,
8524        table_name: &str,
8525        index_name: &str,
8526        key: &IndexKey,
8527    ) -> Result<Option<(u32, u32)>, StorageError> {
8528        let t = self.get(table_name).ok_or_else(|| {
8529            StorageError::Corrupt(format!("find_cold_locator: table {table_name:?} not found"))
8530        })?;
8531        let idx = t
8532            .indices
8533            .iter()
8534            .find(|i| i.name == index_name)
8535            .ok_or_else(|| {
8536                StorageError::Corrupt(format!(
8537                    "find_cold_locator: index {index_name:?} not found on {table_name:?}"
8538                ))
8539            })?;
8540        if !matches!(idx.kind, IndexKind::BTree(_)) {
8541            return Err(StorageError::Corrupt(format!(
8542                "find_cold_locator: index {index_name:?} is NSW; promote-on-write only applies to BTree indices"
8543            )));
8544        }
8545        for loc in idx.lookup_eq(key) {
8546            if let RowLocator::Cold {
8547                segment_id,
8548                page_offset,
8549            } = *loc
8550            {
8551                return Ok(Some((segment_id, page_offset)));
8552            }
8553        }
8554        Ok(None)
8555    }
8556}
8557
8558/// Coerce an [`IndexKey`] to the `u64` that v5.1 cold-tier
8559/// segments use as their on-disk PK. Returns `None` for keys that
8560/// aren't representable as `u64` — Text PKs need a hash mapping
8561/// the segment writer baked in (deferred to v5.2+), Bool PKs are
8562/// almost never wide enough to be sharded into a cold tier.
8563fn index_key_as_u64(key: &IndexKey) -> Option<u64> {
8564    match key {
8565        // Reinterpret the i64 bit pattern as u64. Cold-tier segments
8566        // are sorted by this u64 view, so the chosen interpretation
8567        // only has to match between insert (bake_segment / freezer)
8568        // and lookup — using cast_unsigned keeps both sides honest
8569        // and silences clippy::cast_sign_loss.
8570        IndexKey::Int(n) => Some(n.cast_unsigned()),
8571        // Text / Bool / Uuid / Bytes / Numeric PKs aren't representable
8572        // as u64 and so can't participate in the u64-sorted cold-tier
8573        // segment PK layout. Same deferral story as Text — lookup falls
8574        // through the in-memory btree.
8575        IndexKey::Text(_)
8576        | IndexKey::Bool(_)
8577        | IndexKey::Uuid(_)
8578        | IndexKey::Bytes(_)
8579        | IndexKey::Numeric(_)
8580        | IndexKey::Null => None,
8581    }
8582}
8583
8584#[derive(Debug, Clone, PartialEq, Eq)]
8585#[non_exhaustive]
8586pub enum StorageError {
8587    DuplicateTable {
8588        name: String,
8589    },
8590    TableNotFound {
8591        name: String,
8592    },
8593    ArityMismatch {
8594        expected: usize,
8595        actual: usize,
8596    },
8597    TypeMismatch {
8598        column: String,
8599        expected: DataType,
8600        actual: DataType,
8601        position: usize,
8602    },
8603    NullInNotNull {
8604        column: String,
8605    },
8606    /// Index with this name already exists on the table.
8607    DuplicateIndex {
8608        name: String,
8609    },
8610    /// Column referenced by an index doesn't exist on the table.
8611    ColumnNotFound {
8612        column: String,
8613    },
8614    /// On-disk format failed to parse — corrupted file, wrong magic, truncated
8615    /// payload, or unknown tag bytes.
8616    Corrupt(String),
8617    /// v6.0.4 — ALTER INDEX targeted an index name that doesn't
8618    /// exist on any table in this catalog.
8619    IndexNotFound {
8620        name: String,
8621    },
8622    /// v6.0.4 — operation requested isn't supported on this index
8623    /// kind / column type (e.g. ALTER INDEX REBUILD on a `BTree`
8624    /// index, or REBUILD WITH (encoding=…) on a non-vector column).
8625    Unsupported(String),
8626    /// v7.39 (round 220) — a CYCLE-less sequence ran past its bound.
8627    /// PG's 2200H phrasing: `nextval: reached maximum value of
8628    /// sequence "s" (n)` (`is_max: false` = the MINVALUE direction).
8629    SequenceExhausted {
8630        name: String,
8631        limit: i64,
8632        is_max: bool,
8633    },
8634}
8635
8636impl fmt::Display for StorageError {
8637    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
8638        match self {
8639            // v7.39 (read01 round 47) — PG's 42P07 wording.
8640            Self::DuplicateTable { name } => write!(f, "relation \"{name}\" already exists"),
8641            // v7.39 (read01 round 47) — PG's wording for a missing relation
8642            // (42P01). DROP TABLE says "table" and raises its own error at
8643            // the engine; every other path (SELECT / ALTER / …) says
8644            // "relation", which is what this carries.
8645            Self::TableNotFound { name } => write!(f, "relation \"{name}\" does not exist"),
8646            Self::ArityMismatch { expected, actual } => write!(
8647                f,
8648                "row arity mismatch: expected {expected} columns, got {actual}"
8649            ),
8650            Self::TypeMismatch {
8651                column,
8652                expected,
8653                actual,
8654                position,
8655            } => write!(
8656                f,
8657                "type mismatch in column {column:?} (position {position}): expected {expected}, got {actual}"
8658            ),
8659            Self::NullInNotNull { column } => {
8660                // v7.39 (SQLSTATE fidelity) — PG's 23502 phrasing (the
8661                // relation-qualified long form is added by engine call
8662                // sites that know the table name).
8663                write!(
8664                    f,
8665                    "null value in column \"{column}\" violates not-null constraint"
8666                )
8667            }
8668            // v7.39 (read01 round 47) — an index is a relation to PG (42P07).
8669            Self::DuplicateIndex { name } => write!(f, "relation \"{name}\" already exists"),
8670            // v7.39 (round 701) — PG's wording, and the same fix `EvalError::
8671            // ColumnNotFound` took in read01 round 81 with the same reason:
8672            // "column not found: x" matches none of the wire layer's `does
8673            // not exist` patterns, so a missing column reached the client as
8674            // the generic error class. The eval-side variant was changed and
8675            // the storage-side one was not, so which sentence you got
8676            // depended on which layer noticed — `CREATE INDEX ix ON t(nope)`
8677            // came out of storage and kept the old spelling.
8678            Self::ColumnNotFound { column } => write!(f, "column \"{column}\" does not exist"),
8679            Self::Corrupt(detail) => write!(f, "corrupt on-disk format: {detail}"),
8680            Self::IndexNotFound { name } => write!(f, "index \"{name}\" does not exist"),
8681            Self::Unsupported(detail) => write!(f, "unsupported: {detail}"),
8682            // v7.39 (round 220) — PG's exact 2200H wording.
8683            Self::SequenceExhausted {
8684                name,
8685                limit,
8686                is_max,
8687            } => write!(
8688                f,
8689                "nextval: reached {} value of sequence \"{name}\" ({limit})",
8690                if *is_max { "maximum" } else { "minimum" }
8691            ),
8692        }
8693    }
8694}
8695
8696impl ColumnSchema {
8697    pub fn new(name: impl Into<String>, ty: DataType, nullable: bool) -> Self {
8698        Self {
8699            name: name.into(),
8700            ty,
8701            nullable,
8702            collation_name: None,
8703            default: None,
8704            runtime_default: None,
8705            auto_increment: false,
8706            user_enum_type: None,
8707            user_domain_type: None,
8708            user_composite_type: None,
8709            acl: Vec::new(),
8710            on_update_runtime: None,
8711            collation: Collation::Binary,
8712            is_unsigned: false,
8713            inline_enum_variants: None,
8714            inline_set_variants: None,
8715            generated_stored_expr: None,
8716            identity_always: false,
8717            default_text: None,
8718            auto_restart: None,
8719            scalar_row_source: false,
8720            mysql_int_width: None,
8721            mysql_fsp: None,
8722        }
8723    }
8724
8725    /// v7.38.14 — the SAME column, re-described.
8726    ///
8727    /// `ColumnSchema::new` is for SYNTHESISING a column: a catalog row, an
8728    /// admin view, a computed output. It sets twenty-two fields to their
8729    /// defaults, which is right when there is no source column to speak of.
8730    ///
8731    /// It is wrong, and quietly so, when there IS one -- a join's combined
8732    /// schema, an aggregate's synthetic keys, a derived table's output. Those
8733    /// sites re-describe an existing column under a new name or type, and
8734    /// have each been written as `new(..)` followed by hand-picking a few
8735    /// attributes to copy across. They all pick differently and none picks
8736    /// them all.
8737    ///
8738    /// Five fields have been lost through that shape so far -- enum identity,
8739    /// MySQL fsp, the PG collation name, `ProjectedItem::fold_exempt`, and
8740    /// the `collation` enum -- and v7.38.14 alone found four sites dropping
8741    /// the last of those. The failure is never loud: `collation` defaults to
8742    /// `Binary`, which downstream reads as "byte-wise ON PURPOSE" rather than
8743    /// as "unknown", so a dropped declaration presents as a deliberate one.
8744    ///
8745    /// This constructor copies everything by construction. A field added to
8746    /// `ColumnSchema` therefore reaches every re-describe site without anyone
8747    /// having to remember, which is the property the hand-written copy lists
8748    /// never had.
8749    ///
8750    /// The two fields a re-describe legitimately changes -- name and
8751    /// nullability -- are parameters. Callers that also retype the column
8752    /// assign `ty` afterwards.
8753    #[must_use]
8754    pub fn rederive(source: &Self, name: impl Into<String>, nullable: bool) -> Self {
8755        Self {
8756            name: name.into(),
8757            nullable,
8758            ..source.clone()
8759        }
8760    }
8761
8762    /// Builder-style helper to attach a default value to an otherwise
8763    /// plain column schema. Used by the engine when CREATE TABLE
8764    /// specifies `column TYPE DEFAULT <expr>`.
8765    #[must_use]
8766    pub fn with_default(mut self, default: Value<'static>) -> Self {
8767        self.default = Some(default);
8768        self
8769    }
8770
8771    /// v7.9.21 — builder for runtime-evaluated defaults
8772    /// (`DEFAULT now()`, `DEFAULT CURRENT_TIMESTAMP`, …).
8773    /// `expr` is the Expr's `Display` form, re-parsed by the
8774    /// engine at each INSERT.
8775    #[must_use]
8776    pub fn with_runtime_default(mut self, expr: impl Into<String>) -> Self {
8777        self.runtime_default = Some(expr.into());
8778        self
8779    }
8780
8781    /// Builder-style helper to mark a column as `AUTO_INCREMENT`.
8782    #[must_use]
8783    pub const fn with_auto_increment(mut self) -> Self {
8784        self.auto_increment = true;
8785        self
8786    }
8787}
8788
8789impl TableSchema {
8790    pub fn new(name: impl Into<String>, columns: Vec<ColumnSchema>) -> Self {
8791        Self {
8792            name: name.into(),
8793            columns,
8794            hot_tier_bytes: None,
8795            foreign_keys: Vec::new(),
8796            uniqueness_constraints: Vec::new(),
8797            exclusion_constraints: Vec::new(),
8798            checks: Vec::new(),
8799            partition_role: None,
8800            policies: Vec::new(),
8801            row_security: false,
8802            force_row_security: false,
8803            owner: None,
8804            acl: Vec::new(),
8805        }
8806    }
8807}
8808
8809// =========================================================================
8810// Persistent binary format for the catalog.
8811//
8812// Layout (little-endian throughout):
8813//
8814//   [magic "SPGDB001" 8 bytes][version u8]
8815//   [table_count u32]
8816//   for each table:
8817//       [name_len u16][name bytes]
8818//       [col_count u16]
8819//       for each col:
8820//           [name_len u16][name bytes]
8821//           [type_tag u8 + optional payload]
8822//               1=Int 2=BigInt 3=Float 4=Text 5=Bool
8823//               6=Vector(u32 dim)
8824//               7=SmallInt
8825//               8=Varchar(u32 max)
8826//               9=Char(u32 size)
8827//               10=Numeric(u8 precision, u8 scale)
8828//               11=Date
8829//               12=Timestamp
8830//           [nullable u8]   0/1
8831//           [default_tag u8] 0=none 1=value (followed by [value_tag u8] + bytes)
8832//       [row_count u32]
8833//       for each row, for each col, one [value_tag u8] + value bytes:
8834//           tag 0 (Null)     → no body
8835//           tag 1 (Int)      → i32 LE
8836//           tag 2 (BigInt)   → i64 LE
8837//           tag 3 (Float)    → f64 LE
8838//           tag 4 (Text)     → u16 LE len + UTF-8 bytes
8839//           tag 5 (Bool)     → u8 0/1
8840//           tag 6 (Vector)   → u32 LE dim + dim×f32 LE
8841//           tag 7 (SmallInt) → i16 LE
8842//           tag 8 (Numeric)  → i128 LE (16 bytes) + u8 scale
8843//           tag 9 (Date)     → i32 LE (days since Unix epoch)
8844//           tag 10 (Timestamp) → i64 LE (microseconds since Unix epoch)
8845//
8846// Bumped to version 3 when NUMERIC was added; to version 4 when
8847// AUTO_INCREMENT (per-column flag) + NSW index `kind` byte landed;
8848// to version 5 when DATE / TIMESTAMP were added; to version 6 when
8849// NSW graph topology started travelling on disk (v2.7); to version 7
8850// when the NSW topology became multi-layer HNSW (v2.13); to version 8
8851// when row encoding switched to schema-driven dense layout (v3.0.2 —
8852// per-row NULL bitmap + per-column fixed-width body, no per-cell type
8853// tag).
8854// =========================================================================
8855
8856const FILE_MAGIC: &[u8; 8] = b"SPGDB001";
8857/// Current catalog snapshot format version emitted by [`Catalog::serialize`].
8858///
8859/// v9 (v5.2) extends v8 by serialising `BTree` index entries directly — every
8860/// `(IndexKey, Vec<RowLocator>)` pair travels on disk with the v5.1
8861/// `RowLocator::write_le` tag-prefixed codec. v8 `BTree` indices stored no
8862/// entries at all (the map was rebuilt from `Table::rows` on load); v9
8863/// preserves on-disk Cold locators so freezer-produced cold-tier index
8864/// entries survive a catalog snapshot round-trip. v8 readers are accepted
8865/// by version dispatch in [`Catalog::deserialize`] — every entry decodes
8866/// as `RowLocator::Hot(_)` via `add_index` rebuild, identical to v5.1
8867/// behaviour.
8868/// v6.7.2 — bumped from 10 to 11 to append per-table
8869/// `hot_tier_bytes: Option<u64>` after the per-table indices
8870/// section. v10 catalogs (v6.7.1) load with `hot_tier_bytes =
8871/// None` for every table (the deserialiser short-circuits when
8872/// version < 11). v11 snapshots written by a pre-v6.7.2 binary
8873/// fail loudly at the version check, matching the v6.1.2 /
8874/// v6.1.4 / v6.2.0 / v6.7.1 envelope-bump upgrade fences.
8875///
8876/// v6.8.0 — bumped from 11 to 12: per-index
8877/// `included_columns: Vec<u16>` appended at the tail of each
8878/// index payload. v11 (= v6.7.2) catalogs load with
8879/// `included_columns = Vec::new()` for every index — same
8880/// "older readers, append-only extension" pattern as the v6.7.2
8881/// hot_tier_bytes byte.
8882/// v7.13.0 — bumped from 22 to 23. mailrs round-5 G3 / G10.
8883/// Per-table appendix gains two new sections:
8884///   * `checks: Vec<String>` — CHECK predicate sources (Display
8885///     form of the AST Expr); re-parsed on INSERT/UPDATE to
8886///     enforce against candidate rows. Same persistence pattern
8887///     as `Index::partial_predicate`.
8888///   * Per `UniquenessConstraint`: trailing `nulls_not_distinct:
8889///     u8` flag for PG 15+ `UNIQUE NULLS NOT DISTINCT (cols)`
8890///     semantics.
8891/// v22 catalogs deserialise with empty `checks` and every UC
8892/// at `nulls_not_distinct = false`.
8893/// v24 introduces:
8894///   * Index kind tag 4 = trigram-GIN (`gin_trgm_ops`-flavoured
8895///     `USING gin` over a TEXT/VARCHAR column). Payload shape is
8896///     identical to tag-3 GIN (String → Vec<RowLocator>); the
8897///     keys are PG-compatible 3-byte trigram shingles instead of
8898///     tsvector lexemes. v23 catalogs deserialise unchanged — no
8899///     v23 writer ever emitted tag 4.
8900/// v25 introduces:
8901///   * Per `TriggerDef`: trailing `enabled: u8` flag (mailrs
8902///     round-9 A.2.b — `ALTER TABLE … { ENABLE | DISABLE }
8903///     TRIGGER …`). v24 catalogs deserialise with every trigger
8904///     `enabled = true`, matching pre-v7.16.1 behaviour.
8905/// v26 introduces (v7.17.0 Phase 1.1):
8906///   * Trailing SEQUENCE catalog block after triggers. Encoded
8907///     as `u32 count` followed by per-sequence:
8908///     `name`, `data_type: u8` (0=SmallInt,1=Int,2=BigInt),
8909///     `start i64`, `increment i64`, `min_value i64`,
8910///     `max_value i64`, `cache i64`, `cycle u8`,
8911///     `owned_by_tag u8` (0=NONE, 1=Column → `table`,`column`),
8912///     `last_value i64`, `is_called u8`. v25-and-below catalogs
8913///     deserialise with an empty sequences map.
8914/// v27 introduces (v7.17.0 Phase 1.2):
8915///   * Trailing VIEW catalog block after sequences. Encoded as
8916///     `u32 count` followed by per-view:
8917///     `name`, `column_count u16`, then column names, then
8918///     `body` long-string. v26-and-below catalogs deserialise
8919///     with an empty views map.
8920/// v28 introduces (v7.17.0 Phase 1.3):
8921///   * Trailing MATERIALIZED VIEW source registry block after
8922///     views. Encoded as `u32 count` followed by per-entry:
8923///     `name`, `body` long-string. The materialised rows live
8924///     as a regular Table of the same name (already covered by
8925///     the pre-existing tables block). v27-and-below catalogs
8926///     deserialise with an empty map.
8927/// v29 introduces (v7.17.0 Phase 1.4):
8928///   * Per-table user_enum_type appendix (after the CHECK
8929///     appendix). Layout: `u16 count` followed by per-binding
8930///     `[u16 col_pos][str enum_name]`. Only columns whose
8931///     `user_enum_type` is Some land here; the catalog stays
8932///     compact for the common no-enum case.
8933///   * Trailing ENUM types catalog block after materialized
8934///     views. Encoded as `u32 count` followed by per-entry:
8935///     `name`, `u16 label_count`, then `label_count` short
8936///     strings. v28-and-below catalogs deserialise with an
8937///     empty enum_types map and every column's
8938///     `user_enum_type = None`.
8939/// v30 introduces (v7.17.0 Phase 1.5):
8940///   * Per-table user_domain_type appendix (after the
8941///     user_enum_type appendix). Same shape as the enum one.
8942///   * Trailing DOMAIN types catalog block after the enum
8943///     block. Encoded as `u32 count` followed by per-entry:
8944///     `name`, `data_type` byte, `nullable u8`,
8945///     `default_present u8` + optional default string,
8946///     `u16 check_count` then `check_count` Display-form
8947///     CHECK strings. v29-and-below catalogs deserialise with
8948///     an empty domain_types map and `user_domain_type = None`.
8949/// v31 introduces (v7.17.0 Phase 1.6):
8950///   * Trailing user-schemas block after the DOMAIN block.
8951///     Encoded as `u32 count` followed by `count` schema-name
8952///     short strings. Built-in schemas (`public`, `pg_catalog`,
8953///     `information_schema`) are NOT serialised — they're
8954///     hardcoded in `is_builtin_schema`. v30-and-below catalogs
8955///     deserialise with an empty user-schemas set.
8956/// v32 introduces (v7.17.0 Phase 2.1):
8957///   * Per-table on_update_runtime appendix (after the
8958///     user_domain_type appendix). Layout: `u16 count` followed
8959///     by per-binding `[u16 col_pos][str expr_src]`. Only
8960///     columns whose `on_update_runtime` is Some land here;
8961///     the catalog stays compact when no MySQL-shaped table
8962///     uses the attribute. v31-and-below catalogs deserialise
8963///     with every column's `on_update_runtime = None`.
8964/// v33 introduces (v7.17.0 Phase 2.2):
8965///   * Index kind tag 5 = fulltext-GIN (MySQL `FULLTEXT KEY`
8966///     surface over a TEXT / VARCHAR column). Payload shape is
8967///     identical to tag-3 / tag-4 GIN (`String → Vec<RowLocator>`);
8968///     the keys are lower-cased word lexemes (same rule as
8969///     `to_tsvector('simple', text)`). v32 catalogs deserialise
8970///     unchanged — no v32 writer ever emitted tag 5, and FULLTEXT
8971///     KEY was silently dropped pre-v7.17 so no rebuild shim is
8972///     needed for round-tripped catalogs.
8973/// v34 introduces (v7.17.0 Phase 2.5):
8974///   * Per-table collation appendix (after the on_update_runtime
8975///     appendix). Sparse layout: only columns whose `collation`
8976///     is non-Binary land here. `u16 count` then per-binding
8977///     `[u16 col_pos][u8 collation_tag]` where the tag matches
8978///     `Collation::TAG_*`. Snapshots written by v33-and-below
8979///     readers deserialise every column with `collation =
8980///     Binary`, preserving the prior byte-wise compare
8981///     semantics. Unknown tags read back as Binary too — keeps
8982///     a forward-compat path if a future v35 adds variants
8983///     and someone rolls back to a v34 reader.
8984/// v35 introduces (v7.17.0 Phase 4.4):
8985///   * Per-table is_unsigned appendix (after the collation
8986///     appendix). Sparse layout: only `is_unsigned = true`
8987///     columns land. `u16 count` then per-binding `[u16 col_pos]`.
8988///     v34-and-below catalogs deserialise every column as
8989///     `is_unsigned = false`, preserving the prior silent-
8990///     accept behaviour for negative inserts on UNSIGNED columns.
8991/// v46 introduces (v7.23, mailrs round-14):
8992///   * Escaped short-string codec — `write_str` lengths >= 0xFFFF
8993///     emit `[u16 0xFFFF][u32 real_len]` so TEXT cells (mail bodies,
8994///     document text) above 64 KiB encode instead of panicking.
8995///     One-way upgrade: v45-and-below readers reject v46 catalogs
8996///     loudly via the version gate; v46 readers decode v45 catalogs
8997///     with the plain-u16 rules (0xFFFF is a legitimate length
8998///     there).
8999/// v47 introduces (v7.27, mailrs round-21):
9000///   * Escaped lengths for the REMAINING u16-length cell payloads —
9001///     BYTEA cells, TEXT[] elements, tsvector lexemes and tsquery
9002///     terms — the same `[u16 0xFFFF][u32 real_len]` escape v46
9003///     gave short strings. Round-14 fixed TEXT and missed these;
9004///     round-21 fired the BYTEA twin during a production migration.
9005///     One-way upgrade, same posture as v46.
9006/// v48 introduces (v7.37.5 β-P2, sentori cutover window):
9007///   * `INTERVAL` becomes a real column type. Catalog tag 34 in
9008///     `write_data_type`; per-row body is a fixed 16 bytes
9009///     (i64 micros + i32 days + i32 months, LE, PG-byte-equal
9010///     field order). The runtime-only days collapse is gone —
9011///     `'1 day'` and `'24 hours'` are stored distinctly. One-way
9012///     upgrade: v47 catalogs without INTERVAL columns deserialise
9013///     identically; v47 readers fed a v48 catalog that contains
9014///     INTERVAL hit the explicit "unknown data type tag: 34"
9015///     fence in `read_data_type`.
9016/// v49 introduces (v7.37.6-B, sentori Epic 2 P0):
9017///   * Per-table partition role appendix(declarative
9018///     `PARTITION BY RANGE` parent / range child / DEFAULT
9019///     child)。Layout, written **after** the inline_set_variants
9020///     appendix and **before** the per-table block close:
9021///       `[u8 role_tag]`
9022///         0 = `None`(普通表,后向兼容默认)
9023///         1 = `Parent`:  `[u8 kind_tag (0=Range)]`
9024///                        `[u16 key_col_count]` `(× u16 col_pos)`
9025///                        `[u16 tmpl_count]` `(× str source)`
9026///         2 = `Range`:   `[str parent_name]` `[Bound]` `[Bound]`
9027///         3 = `Default`: `[str parent_name]`
9028///     `PartitionBound` codec:
9029///       `[u8 bound_tag]` 0=MinValue 1=MaxValue 2=TimestampTz(`[i64 LE micros]`)
9030///     v48-and-below readers stop after the inline_set_variants
9031///     block — they don't see this appendix and deserialise every
9032///     table with `partition_role = None`. v49 writers always emit
9033///     `[0]` for plain tables, so the encoding stays one-byte-cheap.
9034/// v50 introduces (v7.37.7, sentori Epic 3 P1):
9035///   * Per-table `generated_stored_expr` appendix(stored generated
9036///     columns — `GENERATED ALWAYS AS (<expr>) STORED`)。Layout,
9037///     written **after** the partition_role appendix and before
9038///     the per-table block close:
9039///       `[u16 binding_count]`
9040///       `binding_count × { [u16 col_pos][str expr_source] }`
9041///     Sparse — only generated columns land here, so plain-shape
9042///     catalogs stay byte-for-byte identical save for the new
9043///     u16 zero count. v49-and-below readers stop after the
9044///     partition_role appendix; v50 readers default every column
9045///     to `generated_stored_expr = None` when this block is absent.
9046/// v51 introduces (v7.37.8, sentori Epic 5 P2):
9047///   * Per-index tag byte 6 = `GinJsonb`(real posting-list GIN
9048///     over a JSONB column). Payload shape mirrors tag-3 / 4 / 5:
9049///     `[u32 posting_list_count]` then `(str token, u32 locator_count,
9050///     locators …)` per posting list. Same `write_str` /
9051///     `RowLocator::write_le` codec as the rest of the GIN family.
9052///     v50 catalogs never wrote tag 6(the same DDL loaded as a
9053///     BTree fallback); v51 readers see tag 6 explicitly and dispatch
9054///     into `IndexKind::GinJsonb`.
9055/// v52 introduces (v7.37.42-T2 ζ-B composite + domain metasystem):
9056///   * Trailing COMPOSITE-types catalog block after the
9057///     user-schemas block. Encoded as `u32 count` followed by
9058///     per-entry: `name`, `u16 field_count`, then `field_count`
9059///     `[str field_name][data_type]` pairs (`write_data_type` is
9060///     reused). v51-and-below catalogs deserialise with an empty
9061///     composite_types map; v52 readers tolerate v51 catalogs by
9062///     stopping at the schema block (no composite block present
9063///     ⇒ empty map). Composite types are referenced by columns
9064///     via `ColumnSchema.user_composite_type`, mirroring the
9065///     `user_enum_type` / `user_domain_type` pattern. The block
9066///     lands here (not as a per-table appendix) so dropping the
9067///     composite type registers globally and DROP TYPE can find it
9068///     without a table scan.
9069/// v53 introduces (v7.37.16 Epic W — cross-checkpoint tombstone
9070///   durability):
9071///   * Trailing per-table MVCC appendix carrying, for every row,
9072///     its `RowHeader` (`xmin:u64`, `xmax:u64`, `flags:u8`) and its
9073///     stable `RowId` (`u64`), followed by the relation's
9074///     `next_rowid:u64`. Layout per table (after the v50
9075///     generated_stored_expr block, before the table loop closes):
9076///       `[u32 row_count]` (== `Table::rows().len()`, cross-check)
9077///       per row in physical order:
9078///         `[u64 xmin][u64 xmax][u8 flags][u64 rowid]`
9079///       `[u64 next_rowid]`
9080///     v52-and-below catalogs never wrote this block; their reader
9081///     stops after the last per-table appendix and
9082///     `deserialize_rows` leaves every row `RowHeader::frozen()`
9083///     with dense 1..=N ids — the exact pre-v53 contract. A v53
9084///     reader instead reconstructs headers + ids VERBATIM, so a
9085///     tombstone-redo naming a row inserted before the last
9086///     checkpoint resolves by `RowId` across the base-snapshot
9087///     boundary (closing the coupling the Epic W WAL slices deferred
9088///     to this format bump). Because the reader routes on `version`,
9089///     the block is strictly backward-compatible: old images load
9090///     byte-for-byte as before. `SPG_MVCC_INPLACE` is unaffected —
9091///     a gate-off database's rows are all frozen/alive, so
9092///     persisting + restoring their headers is observationally a
9093///     no-op.
9094/// v7.38 (read01 P5.05) — v54 appends a CRC32C over the whole preceding
9095/// image so a corrupted `base.spg` is caught on load instead of silently
9096/// deserialising garbage. Older images (v8..=53) carry no trailer and load
9097/// unchanged.
9098/// v7.39 (round 210) — v72 appends a per-table EXCLUDE-constraint appendix
9099/// (sparse: only tables carrying an EXCLUDE write it) at the very end of the
9100/// per-table block, after the column-ACL appendix. A v71 reader stops before
9101/// it and its tables read back with no exclusion constraints, which is what
9102/// they were.
9103/// v7.39 (round 220) — v73 appends a per-table identity-RESTART appendix
9104/// (sparse: [u16 count] then per entry [u16 col_pos][i64 LE floor]) after
9105/// the EXCLUDE appendix. A v72 reader stops before it; its columns read
9106/// back with no RESTART floor, losing only an un-consumed
9107/// `ALTER … RESTART WITH` across a restart.
9108/// r1039 — v90 adds index-key tags 4 (bytea) and 5 (the canonical
9109/// numeric key), so BYTEA and NUMERIC columns carry a real B-tree
9110/// instead of falling back to a scan. A v89 reader meeting either tag
9111/// reports a corrupt catalog rather than mis-reading it, which is the
9112/// same forward-compatibility story tag 3 (uuid) had at v36.
9113const FILE_VERSION: u8 = 92;
9114
9115/// v7.37 (round 833) — the codec version to decode a row that
9116/// [`encode_row_body_dense`] has just produced.
9117///
9118/// That encoder always writes the newest form, and every decoder gate is
9119/// a `codec_version >= N` feature test, so a freshly encoded row must be
9120/// read at the current version. Cold segments carry their own version in
9121/// their header and keep passing that; this is for in-process round
9122/// trips — sort runs on temp storage — where the bytes never outlive the
9123/// build that wrote them.
9124pub const CURRENT_ROW_CODEC_VERSION: u8 = FILE_VERSION;
9125/// First version that appends the trailing CRC32C integrity trailer.
9126const FILE_VERSION_CRC_TRAILER: u8 = 54;
9127/// Oldest format version [`Catalog::deserialize`] still accepts. v8 is the
9128/// v3.0.2 dense-row layout; pre-v8 catalogs require an offline migration.
9129const MIN_SUPPORTED_FILE_VERSION: u8 = 8;
9130
9131// IndexKey wire format (v9):
9132//   tag 0 = Int  → [i64 LE]
9133//   tag 1 = Text → [u16 LE len + UTF-8 bytes] (via write_str / read_str)
9134//   tag 2 = Bool → [u8 0/1]
9135const INDEX_KEY_TAG_INT: u8 = 0;
9136const INDEX_KEY_TAG_TEXT: u8 = 1;
9137const INDEX_KEY_TAG_BOOL: u8 = 2;
9138/// v7.17.0 — `IndexKey::Uuid([u8; 16])`. Body = raw 16 bytes
9139/// (RFC 4122 byte order). Persisted only in FILE_VERSION 36+
9140/// catalogs.
9141const INDEX_KEY_TAG_UUID: u8 = 3;
9142/// r1039 — `IndexKey::Bytes`. Body = [u32 LE len][raw bytes].
9143/// Persisted only in FILE_VERSION 90+ catalogs.
9144const INDEX_KEY_TAG_BYTES: u8 = 4;
9145/// r1039 — `IndexKey::Numeric`. Body = [u8 class][u8 neg][i32 LE exp]
9146/// [u32 LE digit count][one byte per decimal digit, 0..=9, MSD first].
9147/// Persisted only in FILE_VERSION 90+ catalogs.
9148const INDEX_KEY_TAG_NUMERIC: u8 = 5;
9149/// v7.38.1 (L12) — `IndexKey::Null`, a NULL component inside a
9150/// composite key. No body. Persisted only inside tag-7 multi-index
9151/// payloads, FILE_VERSION 91+.
9152const INDEX_KEY_TAG_NULL: u8 = 6;
9153
9154impl Catalog {
9155    /// Serialize the whole catalog (schema + every row) into a self-contained
9156    /// byte buffer. Format is documented above the impl block.
9157    pub fn serialize(&self) -> Vec<u8> {
9158        let mut out = Vec::with_capacity(64);
9159        out.extend_from_slice(FILE_MAGIC);
9160        out.push(FILE_VERSION);
9161        write_u32(
9162            &mut out,
9163            u32::try_from(self.tables.len()).expect("≤ 4G tables"),
9164        );
9165        for t in &self.tables {
9166            write_str(&mut out, &t.schema.name);
9167            write_u16(
9168                &mut out,
9169                u16::try_from(t.schema.columns.len()).expect("≤ 65k columns/table"),
9170            );
9171            for c in &t.schema.columns {
9172                write_str(&mut out, &c.name);
9173                write_data_type(&mut out, c.ty);
9174                out.push(u8::from(c.nullable));
9175                match &c.default {
9176                    None => out.push(0),
9177                    Some(v) => {
9178                        out.push(1);
9179                        write_value(&mut out, v);
9180                    }
9181                }
9182                out.push(u8::from(c.auto_increment));
9183            }
9184            write_u32(
9185                &mut out,
9186                u32::try_from(t.rows.len()).expect("≤ 4G rows/table"),
9187            );
9188            // v3.0.2 dense row encoding (FILE_VERSION 8): per-row NULL
9189            // bitmap, then tightly-packed bodies. Identical wire format
9190            // as before — extracted into `encode_row_body_dense` so cold-
9191            // tier segments (v5.1+) can share the encoding.
9192            for row in &t.rows {
9193                out.extend_from_slice(&encode_row_body_dense(row, &t.schema));
9194            }
9195            // Index definitions. Per-index payload:
9196            //   [name][col_pos u16][kind u8]
9197            //     kind 0 = B-tree           (no params — rebuilt on load)
9198            //     kind 1 = NSW graph        (u16 M + serialized graph)
9199            // For NSW the graph topology travels on disk so startup
9200            // doesn't re-run the O(n²M) rebuild — see v2.7 notes.
9201            write_u16(
9202                &mut out,
9203                u16::try_from(t.indices.len()).expect("≤ 65k indices/table"),
9204            );
9205            for idx in &t.indices {
9206                write_str(&mut out, &idx.name);
9207                write_u16(
9208                    &mut out,
9209                    u16::try_from(idx.column_position).expect("≤ 65k columns/table"),
9210                );
9211                match &idx.kind {
9212                    IndexKind::BTree(map) => {
9213                        out.push(0);
9214                        // v9: serialise the full PB map. Each entry's
9215                        // RowLocator list travels with the tag-prefixed
9216                        // codec from `row_locator::write_le`, so freezer-
9217                        // produced Cold locators survive a snapshot
9218                        // round-trip. v8 BTree wrote nothing here and
9219                        // rebuilt from rows — v9 readers tolerate v8 by
9220                        // version dispatch in `Catalog::deserialize`.
9221                        write_u32(
9222                            &mut out,
9223                            u32::try_from(map.len()).expect("≤ 4G index entries/index"),
9224                        );
9225                        for (key, locators) in map {
9226                            write_index_key(&mut out, key);
9227                            write_u32(
9228                                &mut out,
9229                                u32::try_from(locators.len()).expect("≤ 4G locators/key"),
9230                            );
9231                            for loc in locators {
9232                                loc.write_le(&mut out);
9233                            }
9234                        }
9235                    }
9236                    // v7.38.1 (L12) — tag byte 7 = BTreeMulti. Payload
9237                    // mirrors the tag-0 BTree encoding, with each key
9238                    // written as `[u16 arity]` followed by that many
9239                    // `write_index_key` components. FILE_VERSION 91+;
9240                    // older catalogs never carried a multi index, so no
9241                    // migration shim is needed.
9242                    IndexKind::BTreeMulti(map) => {
9243                        out.push(7);
9244                        write_u32(
9245                            &mut out,
9246                            u32::try_from(map.len()).expect("≤ 4G index entries/index"),
9247                        );
9248                        for (key, locators) in map {
9249                            write_u16(
9250                                &mut out,
9251                                u16::try_from(key.len()).expect("≤ 65k key components"),
9252                            );
9253                            for component in key.iter() {
9254                                write_index_key(&mut out, component);
9255                            }
9256                            write_u32(
9257                                &mut out,
9258                                u32::try_from(locators.len()).expect("≤ 4G locators/key"),
9259                            );
9260                            for loc in locators {
9261                                loc.write_le(&mut out);
9262                            }
9263                        }
9264                    }
9265                    IndexKind::Nsw(g) => {
9266                        out.push(1);
9267                        write_u16(&mut out, u16::try_from(g.m).expect("≤ 65k NSW neighbours"));
9268                        write_nsw_graph(&mut out, g);
9269                    }
9270                    IndexKind::Brin { column_type, .. } => {
9271                        // v6.7.1 — tag byte 2 = BRIN. Payload is the
9272                        // column type code (1 byte mapping to the
9273                        // shared DataType numeric encoding); no
9274                        // further data — BRIN summaries live in
9275                        // cold segments, not the catalog.
9276                        out.push(2);
9277                        write_data_type(&mut out, *column_type);
9278                    }
9279                    IndexKind::Gin(map) => {
9280                        // v7.12.3 — tag byte 3 = GIN. Payload mirrors
9281                        // the BTree encoding but with String (lexeme
9282                        // word) keys instead of IndexKey. Tag-prefixed
9283                        // RowLocator codec so freezer-produced Cold
9284                        // locators survive snapshot round-trip.
9285                        // FILE_VERSION 21+; v20 catalogs never wrote a
9286                        // GIN index (the AM degraded to BTree fallback
9287                        // pre-v7.12.3), so no migration shim is needed.
9288                        out.push(3);
9289                        write_u32(
9290                            &mut out,
9291                            u32::try_from(map.len()).expect("≤ 4G GIN posting lists"),
9292                        );
9293                        for (word, locators) in map {
9294                            write_str(&mut out, word);
9295                            write_u32(
9296                                &mut out,
9297                                u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9298                            );
9299                            for loc in locators {
9300                                loc.write_le(&mut out);
9301                            }
9302                        }
9303                    }
9304                    IndexKind::GinTrgm(map) => {
9305                        // v7.15.0 — tag byte 4 = GinTrgm
9306                        // (`gin_trgm_ops` GIN over a TEXT column).
9307                        // Payload shape is identical to tag-3 GIN —
9308                        // `String → Vec<RowLocator>` posting lists.
9309                        // The String keys are 3-byte trigrams instead
9310                        // of tsvector lexemes; the deserializer
9311                        // dispatches on the tag, not the key shape.
9312                        // FILE_VERSION 24+; v23 catalogs never wrote
9313                        // a trigram-GIN.
9314                        out.push(4);
9315                        write_u32(
9316                            &mut out,
9317                            u32::try_from(map.len()).expect("≤ 4G trigram-GIN posting lists"),
9318                        );
9319                        for (tri, locators) in map {
9320                            write_str(&mut out, tri);
9321                            write_u32(
9322                                &mut out,
9323                                u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9324                            );
9325                            for loc in locators {
9326                                loc.write_le(&mut out);
9327                            }
9328                        }
9329                    }
9330                    IndexKind::GinFulltext(map) => {
9331                        // v7.17.0 Phase 2.2 — tag byte 5 =
9332                        // GinFulltext (MySQL `FULLTEXT KEY` GIN
9333                        // over a TEXT/VARCHAR column). Payload
9334                        // shape mirrors tag-3 / tag-4 GIN —
9335                        // `String → Vec<RowLocator>` posting
9336                        // lists keyed by lower-cased word
9337                        // lexemes. FILE_VERSION 33+; v32 catalogs
9338                        // never wrote a fulltext-GIN (FULLTEXT
9339                        // KEY was silently dropped pre-v7.17).
9340                        out.push(5);
9341                        write_u32(
9342                            &mut out,
9343                            u32::try_from(map.len()).expect("≤ 4G fulltext-GIN posting lists"),
9344                        );
9345                        for (lex, locators) in map {
9346                            write_str(&mut out, lex);
9347                            write_u32(
9348                                &mut out,
9349                                u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9350                            );
9351                            for loc in locators {
9352                                loc.write_le(&mut out);
9353                            }
9354                        }
9355                    }
9356                    IndexKind::GinJsonb(map) => {
9357                        // v7.37.8 — tag byte 6 = GinJsonb
9358                        // (real posting-list GIN over a JSONB
9359                        // column; sentori Epic 5 P2). Payload
9360                        // shape mirrors tag-3 / 4 / 5 — keys are
9361                        // the canonical `(path, leaf)` tokens
9362                        // from `jsonb_gin::extract_tokens`.
9363                        // FILE_VERSION 51+; v50 catalogs never
9364                        // wrote a JSONB-GIN (the same DDL loaded
9365                        // as a BTree fallback).
9366                        out.push(6);
9367                        write_u32(
9368                            &mut out,
9369                            u32::try_from(map.len()).expect("≤ 4G JSONB-GIN posting lists"),
9370                        );
9371                        for (token, locators) in map {
9372                            write_str(&mut out, token);
9373                            write_u32(
9374                                &mut out,
9375                                u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9376                            );
9377                            for loc in locators {
9378                                loc.write_le(&mut out);
9379                            }
9380                        }
9381                    }
9382                }
9383                // v6.8.0 — included_columns appendix per index.
9384                // Layout: [u16 num_included][num × u16 column_position].
9385                // v11 readers stop before this u16 (deserialise loop
9386                // gated on version >= 12); v12+ readers always
9387                // consume it. Empty Vec serialises as a bare 0u16.
9388                write_u16(
9389                    &mut out,
9390                    u16::try_from(idx.included_columns.len()).expect("≤ 65k INCLUDE columns/index"),
9391                );
9392                for col_pos in &idx.included_columns {
9393                    write_u16(
9394                        &mut out,
9395                        u16::try_from(*col_pos).expect("≤ 65k columns/table"),
9396                    );
9397                }
9398                // v6.8.1 — partial_predicate appendix per index.
9399                // Layout: [u8 has_pred][u16 LE len][bytes (if has_pred)].
9400                // Same v12 gate as included_columns.
9401                match &idx.partial_predicate {
9402                    None => out.push(0),
9403                    Some(pred) => {
9404                        out.push(1);
9405                        write_str(&mut out, pred);
9406                    }
9407                }
9408                // v6.8.2 — expression appendix. Same shape as
9409                // partial_predicate.
9410                match &idx.expression {
9411                    None => out.push(0),
9412                    Some(expr) => {
9413                        out.push(1);
9414                        write_str(&mut out, expr);
9415                    }
9416                }
9417                // v7.9.29 — is_unique appendix (FILE_VERSION 16+).
9418                // Single byte 0/1. v15-and-below readers stop before
9419                // this byte; v16 readers always consume it. mailrs K1.
9420                out.push(u8::from(idx.is_unique));
9421                // v7.9.29 — extra_column_positions appendix.
9422                // Layout: [u16 count][count × u16 column_position].
9423                write_u16(
9424                    &mut out,
9425                    u16::try_from(idx.extra_column_positions.len())
9426                        .expect("≤ 65k extra cols / index"),
9427                );
9428                for cp in &idx.extra_column_positions {
9429                    write_u16(&mut out, u16::try_from(*cp).expect("≤ 65k columns/table"));
9430                }
9431                // v7.39 (read01 round 52) — nulls_not_distinct (FILE_VERSION
9432                // 62+). Appended at the end of the per-index block so the v16
9433                // layout above is untouched; v61-and-below readers stop before
9434                // this byte and default the flag to false (NULLS DISTINCT).
9435                out.push(u8::from(idx.nulls_not_distinct));
9436                // v7.39 (round 537) — the key column's ordering clause
9437                // (FILE_VERSION 83+).
9438                out.push(u8::from(idx.descending));
9439                out.push(match idx.nulls_first {
9440                    None => 0,
9441                    Some(true) => 1,
9442                    Some(false) => 2,
9443                });
9444                // v7.39 (round 538) — the key's explicit collation
9445                // (FILE_VERSION 84+).
9446                match &idx.collation {
9447                    Some(c) => {
9448                        out.push(1);
9449                        write_str(&mut out, c);
9450                    }
9451                    None => out.push(0),
9452                }
9453            }
9454            // v6.7.2 — per-table hot_tier_bytes Option<u64>.
9455            // Layout: [u8 has_value][u64 LE value (if has_value)].
9456            // v10 readers stop before this byte (deserialise loop
9457            // gated on version >= 11); v11+ readers always
9458            // consume it.
9459            match t.schema.hot_tier_bytes {
9460                None => out.push(0),
9461                Some(n) => {
9462                    out.push(1);
9463                    out.extend_from_slice(&n.to_le_bytes());
9464                }
9465            }
9466            // v7.6.1 — FOREIGN KEY appendix (catalog FILE_VERSION 13+).
9467            // Layout: [u16 LE fk_count]
9468            //   per fk:
9469            //     [u8 has_name] [str name (if has_name)]
9470            //     [u16 LE local_arity] [u16 LE local_pos]*arity
9471            //     [str parent_table]
9472            //     [u16 LE parent_arity] [u16 LE parent_pos]*arity
9473            //     [u8 on_delete_tag] [u8 on_update_tag]
9474            // Older catalogs (v12 and below) skip this block entirely;
9475            // their reader stops before this byte.
9476            write_u16(
9477                &mut out,
9478                u16::try_from(t.schema.foreign_keys.len()).expect("≤ 65k FKs/table"),
9479            );
9480            for fk in &t.schema.foreign_keys {
9481                match &fk.name {
9482                    None => out.push(0),
9483                    Some(n) => {
9484                        out.push(1);
9485                        write_str(&mut out, n);
9486                    }
9487                }
9488                write_u16(
9489                    &mut out,
9490                    u16::try_from(fk.local_columns.len()).expect("≤ 65k FK columns"),
9491                );
9492                for &p in &fk.local_columns {
9493                    write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9494                }
9495                write_str(&mut out, &fk.parent_table);
9496                write_u16(
9497                    &mut out,
9498                    u16::try_from(fk.parent_columns.len()).expect("≤ 65k FK parent columns"),
9499                );
9500                for &p in &fk.parent_columns {
9501                    write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9502                }
9503                out.push(fk.on_delete.tag());
9504                out.push(fk.on_update.tag());
9505                // v7.38 (read01, T29) — MATCH type tag (FILE_VERSION 55+).
9506                out.push(fk.match_type.tag());
9507                // v7.39 (round 288) — constraint timing (FILE_VERSION 79+).
9508                // One byte, bit 0 = DEFERRABLE, bit 1 = INITIALLY DEFERRED.
9509                out.push(u8::from(fk.deferrable) | (u8::from(fk.initially_deferred) << 1));
9510            }
9511            // v7.9.19 — UniquenessConstraint appendix (catalog
9512            // FILE_VERSION 15+). Layout per table after the FK
9513            // block:
9514            //   [u16 count]
9515            //     per constraint:
9516            //       [u8 is_primary_key]
9517            //       [u16 arity][u16 col_pos]*arity
9518            // Older catalogs (v14 and below) skip this block.
9519            write_u16(
9520                &mut out,
9521                u16::try_from(t.schema.uniqueness_constraints.len())
9522                    .expect("≤ 65k uniqueness constraints/table"),
9523            );
9524            for uc in &t.schema.uniqueness_constraints {
9525                out.push(u8::from(uc.is_primary_key));
9526                write_u16(
9527                    &mut out,
9528                    u16::try_from(uc.columns.len()).expect("≤ 65k cols in uniqueness constraint"),
9529                );
9530                for &p in &uc.columns {
9531                    write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9532                }
9533                // v7.13.0 — `nulls_not_distinct` flag
9534                // (FILE_VERSION 23+). Always written by writers at
9535                // version 23+; deserialise gates on `version >= 23`
9536                // so v22-and-below catalogs round-trip cleanly.
9537                out.push(u8::from(uc.nulls_not_distinct));
9538            }
9539            // v7.9.21 — runtime_default appendix per table.
9540            // Layout: [u16 count] then for each:
9541            //   [u16 col_pos][str expr]
9542            // Only columns whose runtime_default is Some land here;
9543            // catalog stays compact for the common literal-default
9544            // case.
9545            let mut rt_defaults: Vec<(usize, &str)> = Vec::new();
9546            for (i, c) in t.schema.columns.iter().enumerate() {
9547                if let Some(e) = &c.runtime_default {
9548                    rt_defaults.push((i, e.as_str()));
9549                }
9550            }
9551            write_u16(
9552                &mut out,
9553                u16::try_from(rt_defaults.len()).expect("≤ 65k runtime defaults/table"),
9554            );
9555            for (pos, expr) in rt_defaults {
9556                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9557                write_str(&mut out, expr);
9558            }
9559            // v7.13.0 — CHECK constraint appendix per table.
9560            // Layout: [u16 count] then `count` Display-form
9561            // expression strings. Re-parsed on every INSERT/UPDATE
9562            // by the engine. FILE_VERSION 23+ only; v22 readers
9563            // never reach this block because the writer also moves
9564            // to v23 in lock-step.
9565            write_u16(
9566                &mut out,
9567                u16::try_from(t.schema.checks.len()).expect("≤ 65k CHECK constraints/table"),
9568            );
9569            for c in &t.schema.checks {
9570                // v7.39 (read01 round 48) — the expr stays in this v23
9571                // appendix (byte layout unchanged for old readers); the
9572                // name rides the v60 constraint-name appendix at the tail.
9573                write_str(&mut out, c.expr.as_str());
9574            }
9575            // v7.17.0 Phase 1.4 — per-table user_enum_type
9576            // appendix. Layout: [u16 count] then
9577            // [u16 col_pos][str enum_name] per binding. Only
9578            // columns whose user_enum_type is Some land here.
9579            let mut enum_bindings: Vec<(usize, &str)> = Vec::new();
9580            for (i, c) in t.schema.columns.iter().enumerate() {
9581                if let Some(e) = &c.user_enum_type {
9582                    enum_bindings.push((i, e.as_str()));
9583                }
9584            }
9585            write_u16(
9586                &mut out,
9587                u16::try_from(enum_bindings.len()).expect("≤ 65k enum-typed columns/table"),
9588            );
9589            for (pos, ename) in enum_bindings {
9590                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9591                write_str(&mut out, ename);
9592            }
9593            // v7.17.0 Phase 1.5 — per-table user_domain_type
9594            // appendix. Same layout as the enum one. v29-and-
9595            // below readers stop after the enum appendix.
9596            let mut domain_bindings: Vec<(usize, &str)> = Vec::new();
9597            for (i, c) in t.schema.columns.iter().enumerate() {
9598                if let Some(d) = &c.user_domain_type {
9599                    domain_bindings.push((i, d.as_str()));
9600                }
9601            }
9602            write_u16(
9603                &mut out,
9604                u16::try_from(domain_bindings.len()).expect("≤ 65k domain-typed columns/table"),
9605            );
9606            for (pos, dname) in domain_bindings {
9607                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9608                write_str(&mut out, dname);
9609            }
9610            // v7.17.0 Phase 2.1 — per-table on_update_runtime
9611            // appendix. Sparse: only ON UPDATE-bound columns.
9612            let mut on_update_bindings: Vec<(usize, &str)> = Vec::new();
9613            for (i, c) in t.schema.columns.iter().enumerate() {
9614                if let Some(e) = &c.on_update_runtime {
9615                    on_update_bindings.push((i, e.as_str()));
9616                }
9617            }
9618            write_u16(
9619                &mut out,
9620                u16::try_from(on_update_bindings.len()).expect("≤ 65k ON UPDATE columns/table"),
9621            );
9622            for (pos, expr_src) in on_update_bindings {
9623                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9624                write_str(&mut out, expr_src);
9625            }
9626            // v7.17.0 Phase 2.5 — per-table collation appendix.
9627            // Sparse: only non-Binary columns land. Layout:
9628            // `[u16 count][u16 col_pos][u8 tag] × count`.
9629            let mut coll_bindings: Vec<(usize, u8)> = Vec::new();
9630            for (i, c) in t.schema.columns.iter().enumerate() {
9631                let tag = match c.collation {
9632                    Collation::Binary => continue,
9633                    Collation::CaseInsensitive => Collation::TAG_CASE_INSENSITIVE,
9634                };
9635                coll_bindings.push((i, tag));
9636            }
9637            write_u16(
9638                &mut out,
9639                u16::try_from(coll_bindings.len()).expect("≤ 65k collation bindings/table"),
9640            );
9641            for (pos, tag) in coll_bindings {
9642                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9643                out.push(tag);
9644            }
9645            // v7.17.0 Phase 4.4 — per-table is_unsigned appendix.
9646            // Sparse: only UNSIGNED columns land. Layout:
9647            // `[u16 count][u16 col_pos] × count`.
9648            let mut unsigned_bindings: Vec<usize> = Vec::new();
9649            for (i, c) in t.schema.columns.iter().enumerate() {
9650                if c.is_unsigned {
9651                    unsigned_bindings.push(i);
9652                }
9653            }
9654            write_u16(
9655                &mut out,
9656                u16::try_from(unsigned_bindings.len()).expect("≤ 65k UNSIGNED columns/table"),
9657            );
9658            for pos in unsigned_bindings {
9659                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9660            }
9661            // v7.17.0 Phase 3.P0-36 — per-table inline_enum_variants
9662            // appendix. Sparse: only ENUM columns land. Layout:
9663            // `[u16 count] then per binding [u16 col_pos]
9664            // [u16 variant_count] then variant strings`.
9665            // FILE_VERSION 41+; v40 readers never reach this block.
9666            let mut enum_inline_bindings: Vec<(usize, &[String])> = Vec::new();
9667            for (i, c) in t.schema.columns.iter().enumerate() {
9668                if let Some(vs) = &c.inline_enum_variants {
9669                    enum_inline_bindings.push((i, vs.as_slice()));
9670                }
9671            }
9672            write_u16(
9673                &mut out,
9674                u16::try_from(enum_inline_bindings.len()).expect("≤ 65k inline-ENUM columns/table"),
9675            );
9676            for (pos, variants) in enum_inline_bindings {
9677                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9678                write_u16(
9679                    &mut out,
9680                    u16::try_from(variants.len()).expect("≤ 65k variants/ENUM"),
9681                );
9682                for v in variants {
9683                    write_str(&mut out, v.as_str());
9684                }
9685            }
9686            // v7.17.0 Phase 3.P0-37 — per-table inline_set_variants
9687            // appendix. Same layout as the inline ENUM block.
9688            // FILE_VERSION 42+; v41 readers never reach this block.
9689            let mut set_inline_bindings: Vec<(usize, &[String])> = Vec::new();
9690            for (i, c) in t.schema.columns.iter().enumerate() {
9691                if let Some(vs) = &c.inline_set_variants {
9692                    set_inline_bindings.push((i, vs.as_slice()));
9693                }
9694            }
9695            write_u16(
9696                &mut out,
9697                u16::try_from(set_inline_bindings.len()).expect("≤ 65k inline-SET columns/table"),
9698            );
9699            for (pos, variants) in set_inline_bindings {
9700                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9701                write_u16(
9702                    &mut out,
9703                    u16::try_from(variants.len()).expect("≤ 65k variants/SET"),
9704                );
9705                for v in variants {
9706                    write_str(&mut out, v.as_str());
9707                }
9708            }
9709            // v7.37.6-B — partition role appendix(FILE_VERSION 49+)。
9710            // Layout 详见 FILE_VERSION 49 docstring。普通表 = 单字节 0。
9711            write_partition_role(&mut out, t.schema.partition_role.as_ref());
9712            // v7.37.7 — per-table generated_stored_expr appendix
9713            // (FILE_VERSION 50+). Sparse: only columns whose
9714            // generated_stored_expr is Some land here.
9715            let mut gen_bindings: Vec<(usize, &str)> = Vec::new();
9716            for (i, c) in t.schema.columns.iter().enumerate() {
9717                if let Some(src) = &c.generated_stored_expr {
9718                    gen_bindings.push((i, src.as_str()));
9719                }
9720            }
9721            write_u16(
9722                &mut out,
9723                u16::try_from(gen_bindings.len()).expect("≤ 65k GENERATED STORED columns/table"),
9724            );
9725            for (pos, src) in gen_bindings {
9726                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9727                write_str(&mut out, src);
9728            }
9729            // v7.38 (read01) — per-table default_text appendix
9730            // (FILE_VERSION 58+). Sparse: only columns whose default_text
9731            // is Some land here. Mirrors the generated_stored_expr shape.
9732            let mut default_texts: Vec<(usize, &str)> = Vec::new();
9733            for (i, c) in t.schema.columns.iter().enumerate() {
9734                if let Some(src) = &c.default_text {
9735                    default_texts.push((i, src.as_str()));
9736                }
9737            }
9738            write_u16(
9739                &mut out,
9740                u16::try_from(default_texts.len()).expect("≤ 65k defaulted columns/table"),
9741            );
9742            for (pos, src) in default_texts {
9743                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9744                write_str(&mut out, src);
9745            }
9746            // v7.39 (RLS) — per-table policy appendix + the two RLS flags
9747            // (FILE_VERSION 59+). Written after the default_text block and
9748            // before the MVCC row appendix, so a v58 reader stops before it.
9749            // Layout: [u8 row_security][u8 force] [u16 policy_count] then per
9750            // policy: [str name][u8 cmd][u8 permissive][u16 role_count]
9751            // (role_count × str) [u8 has_using](+str)[u8 has_check](+str).
9752            out.push(u8::from(t.schema.row_security));
9753            out.push(u8::from(t.schema.force_row_security));
9754            write_u16(
9755                &mut out,
9756                u16::try_from(t.schema.policies.len()).expect("≤ 65k policies/table"),
9757            );
9758            for p in &t.schema.policies {
9759                write_str(&mut out, &p.name);
9760                out.push(p.cmd.to_wire_byte());
9761                out.push(u8::from(p.permissive));
9762                write_u16(
9763                    &mut out,
9764                    u16::try_from(p.roles.len()).expect("≤ 65k roles/policy"),
9765                );
9766                for r in &p.roles {
9767                    write_str(&mut out, r);
9768                }
9769                match &p.using_expr {
9770                    Some(s) => {
9771                        out.push(1);
9772                        write_str(&mut out, s);
9773                    }
9774                    None => out.push(0),
9775                }
9776                match &p.with_check_expr {
9777                    Some(s) => {
9778                        out.push(1);
9779                        write_str(&mut out, s);
9780                    }
9781                    None => out.push(0),
9782                }
9783            }
9784            // v7.37.16 (Epic W) — per-row MVCC header + stable RowId
9785            // appendix (FILE_VERSION 53+). Persists xmin/xmax/flags +
9786            // RowId for every row so a tombstone naming a pre-checkpoint
9787            // row survives a serialize→deserialize base restore
9788            // (cross-checkpoint tombstone durability). `headers` /
9789            // `rowids` are lock-step parallel to `rows` (invariant held
9790            // at every mutation boundary), so the count is `rows.len()`
9791            // and the zipped walk visits them in physical row order —
9792            // the same order the rows block above was written in. v52
9793            // readers never reach this block (the writer also moves to
9794            // v53 in lock-step); a v53 reader restores headers + ids
9795            // verbatim instead of freezing + dense-assigning.
9796            debug_assert_eq!(
9797                t.rows.len(),
9798                t.headers.len(),
9799                "headers must be lock-step with rows at serialize"
9800            );
9801            debug_assert_eq!(
9802                t.rows.len(),
9803                t.rowids.len(),
9804                "rowids must be lock-step with rows at serialize"
9805            );
9806            write_u32(
9807                &mut out,
9808                u32::try_from(t.rows.len()).expect("≤ 4G rows/table"),
9809            );
9810            for (h, rid) in t.headers.iter().zip(t.rowids.iter()) {
9811                out.extend_from_slice(&h.xmin.to_le_bytes());
9812                out.extend_from_slice(&h.xmax.to_le_bytes());
9813                out.push(h.flags);
9814                out.extend_from_slice(&rid.0.to_le_bytes());
9815            }
9816            out.extend_from_slice(
9817                &t.next_rowid
9818                    .load(core::sync::atomic::Ordering::Relaxed)
9819                    .to_le_bytes(),
9820            );
9821            // v7.39 (read01 round 48) — constraint-name appendix
9822            // (FILE_VERSION 60+). Index-aligned to the CHECK and
9823            // uniqueness-constraint appendices written above, so the
9824            // existing byte layouts stay untouched and a v59 catalog still
9825            // decodes (its constraints just come back unnamed).
9826            // Layout: [u16 check_count] then per check
9827            //         [u8 has_name] ([str name] when has_name)
9828            //         [u16 uc_count] then per uc the same pair.
9829            write_u16(
9830                &mut out,
9831                u16::try_from(t.schema.checks.len()).expect("≤ 65k CHECK constraints/table"),
9832            );
9833            for c in &t.schema.checks {
9834                match &c.name {
9835                    Some(n) => {
9836                        out.push(1);
9837                        write_str(&mut out, n);
9838                    }
9839                    None => out.push(0),
9840                }
9841            }
9842            write_u16(
9843                &mut out,
9844                u16::try_from(t.schema.uniqueness_constraints.len())
9845                    .expect("≤ 65k uniqueness constraints/table"),
9846            );
9847            for uc in &t.schema.uniqueness_constraints {
9848                match &uc.name {
9849                    Some(n) => {
9850                        out.push(1);
9851                        write_str(&mut out, n);
9852                    }
9853                    None => out.push(0),
9854                }
9855            }
9856            // v7.39 (read01 round 56) — user_composite_type appendix
9857            // (FILE_VERSION 63+). Sparse, at the very end of the per-table
9858            // block: only composite-typed columns land here, so a v62 reader
9859            // stops before it and its composite columns stay plain JSON.
9860            let mut comp_bindings: Vec<(usize, &str)> = Vec::new();
9861            for (i, c) in t.schema.columns.iter().enumerate() {
9862                if let Some(n) = &c.user_composite_type {
9863                    comp_bindings.push((i, n.as_str()));
9864                }
9865            }
9866            write_u16(
9867                &mut out,
9868                u16::try_from(comp_bindings.len()).expect("≤ 65k composite-typed columns/table"),
9869            );
9870            for (pos, n) in comp_bindings {
9871                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9872                write_str(&mut out, n);
9873            }
9874            // v7.39 (read01 round 57) — owner + ACL appendix (FILE_VERSION
9875            // 64+), at the very end of the per-table block so a v63 reader
9876            // stops before it (its tables then read back owner-less, i.e.
9877            // owned by the login role, with no grants — which is exactly what
9878            // they were).
9879            match &t.schema.owner {
9880                Some(o) => {
9881                    out.push(1);
9882                    write_str(&mut out, o);
9883                }
9884                None => out.push(0),
9885            }
9886            write_u16(
9887                &mut out,
9888                u16::try_from(t.schema.acl.len()).expect("≤ 65k aclitems/table"),
9889            );
9890            for a in &t.schema.acl {
9891                write_str(&mut out, &a.grantee);
9892                write_u16(&mut out, a.privs);
9893                write_u16(&mut out, a.grantable);
9894                write_str(&mut out, &a.grantor);
9895            }
9896            // v7.39 (read01 round 59) — COLUMN acl appendix (FILE_VERSION 65+),
9897            // sparse: only columns that carry a grant land here, so a v64 reader
9898            // stops before it and its columns read back un-granted, which is
9899            // what they were.
9900            let granted: Vec<(usize, &ColumnSchema)> = t
9901                .schema
9902                .columns
9903                .iter()
9904                .enumerate()
9905                .filter(|(_, c)| !c.acl.is_empty())
9906                .collect();
9907            write_u16(
9908                &mut out,
9909                u16::try_from(granted.len()).expect("≤ 65k granted columns/table"),
9910            );
9911            for (pos, c) in granted {
9912                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9913                write_u16(
9914                    &mut out,
9915                    u16::try_from(c.acl.len()).expect("≤ 65k aclitems/column"),
9916                );
9917                for a in &c.acl {
9918                    write_str(&mut out, &a.grantee);
9919                    write_u16(&mut out, a.privs);
9920                    write_u16(&mut out, a.grantable);
9921                    write_str(&mut out, &a.grantor);
9922                }
9923            }
9924            // v7.39 (round 210) — EXCLUDE-constraint appendix (FILE_VERSION
9925            // 72+), at the very end of the per-table block so a v71 reader
9926            // stops before it and its tables read back with no exclusion
9927            // constraints. Layout: [u16 excl_count] then per constraint
9928            // [str name] [u8 has_method](+str) [u16 elem_count] then per
9929            // element [u16 col_pos][str op].
9930            write_u16(
9931                &mut out,
9932                u16::try_from(t.schema.exclusion_constraints.len())
9933                    .expect("≤ 65k exclusion constraints/table"),
9934            );
9935            for ex in &t.schema.exclusion_constraints {
9936                write_str(&mut out, &ex.name);
9937                match &ex.method {
9938                    Some(m) => {
9939                        out.push(1);
9940                        write_str(&mut out, m);
9941                    }
9942                    None => out.push(0),
9943                }
9944                write_u16(
9945                    &mut out,
9946                    u16::try_from(ex.elements.len()).expect("≤ 65k elements/exclusion"),
9947                );
9948                for (pos, op) in &ex.elements {
9949                    write_u16(&mut out, u16::try_from(*pos).expect("≤ 65k columns/table"));
9950                    write_str(&mut out, op);
9951                }
9952            }
9953            // v7.39 (round 220) — identity-RESTART appendix (FILE_VERSION
9954            // 73+), sparse: only columns carrying a RESTART floor land here.
9955            let restarts: Vec<(usize, i64)> = t
9956                .schema
9957                .columns
9958                .iter()
9959                .enumerate()
9960                .filter_map(|(i, c)| c.auto_restart.map(|n| (i, n)))
9961                .collect();
9962            write_u16(
9963                &mut out,
9964                u16::try_from(restarts.len()).expect("≤ 65k restart columns/table"),
9965            );
9966            for (pos, n) in restarts {
9967                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9968                out.extend_from_slice(&n.to_le_bytes());
9969            }
9970            // v7.39 (round 386, type-fidelity epic P1) — per-table
9971            // mysql_int_width appendix (FILE_VERSION 81+). Sparse: only
9972            // TINYINT / MEDIUMINT columns land. Layout:
9973            // `[u16 count]([u16 col_pos][u8 width_tag]) × count`
9974            // (tag 0 = Tiny, 1 = Medium). v80-and-below readers stop after
9975            // the identity-RESTART appendix, leaving every column at None.
9976            let int_widths: Vec<(usize, u8)> = t
9977                .schema
9978                .columns
9979                .iter()
9980                .enumerate()
9981                .filter_map(|(i, c)| {
9982                    c.mysql_int_width.map(|w| {
9983                        let tag = match w {
9984                            MysqlIntWidth::Tiny => 0u8,
9985                            MysqlIntWidth::Medium => 1u8,
9986                            MysqlIntWidth::Small => 2u8,
9987                            MysqlIntWidth::Int => 3u8,
9988                            MysqlIntWidth::Big => 4u8,
9989                        };
9990                        (i, tag)
9991                    })
9992                })
9993                .collect();
9994            write_u16(
9995                &mut out,
9996                u16::try_from(int_widths.len()).expect("≤ 65k narrow-int columns/table"),
9997            );
9998            for (pos, tag) in int_widths {
9999                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
10000                out.push(tag);
10001            }
10002            // v7.39 (round 424, type-fidelity epic) — per-table mysql_fsp
10003            // appendix (FILE_VERSION 82+). Sparse: only MySQL-declared
10004            // temporal columns land. Layout:
10005            // `[u16 count]([u16 col_pos][u8 fsp]) × count`, fsp in 0..=6.
10006            // v81-and-below readers stop after the int-width appendix,
10007            // leaving every column at None (PG microsecond behaviour).
10008            let fsps: Vec<(usize, u8)> = t
10009                .schema
10010                .columns
10011                .iter()
10012                .enumerate()
10013                .filter_map(|(i, c)| c.mysql_fsp.map(|p| (i, p)))
10014                .collect();
10015            write_u16(
10016                &mut out,
10017                u16::try_from(fsps.len()).expect("≤ 65k temporal columns/table"),
10018            );
10019            for (pos, fsp) in fsps {
10020                write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
10021                out.push(fsp);
10022            }
10023            // v7.39 (round 652) — CHECK-validated appendix (FILE_VERSION
10024            // 87+). Sparse the other way round from the ones above: the
10025            // common case is every constraint validated, so only the
10026            // NOT VALID ones are written, by their index into the CHECK
10027            // appendix. Layout: `[u16 count]([u16 check_idx]) × count`.
10028            let unvalidated: Vec<usize> = t
10029                .schema
10030                .checks
10031                .iter()
10032                .enumerate()
10033                .filter_map(|(i, c)| (!c.validated).then_some(i))
10034                .collect();
10035            write_u16(
10036                &mut out,
10037                u16::try_from(unvalidated.len()).expect("≤ 65k CHECK constraints/table"),
10038            );
10039            for idx in unvalidated {
10040                write_u16(&mut out, u16::try_from(idx).expect("≤ 65k CHECK/table"));
10041            }
10042            // v7.39 (round 677) — per-column collation names (FILE_VERSION
10043            // 88+). Sparse: only the columns that were written with an
10044            // explicit `COLLATE` appear, so a table that declares none pays
10045            // two bytes. Layout: `[u16 count]([u16 col_idx][str]) × count`.
10046            //
10047            // Without this the declaration survives CREATE TABLE and dies
10048            // at the next restart — measured: a column declared
10049            // `COLLATE "C"` reported attcollation 950 in the session that
10050            // created it and 100 after a reload.
10051            let collated: Vec<(usize, &str)> = t
10052                .schema
10053                .columns
10054                .iter()
10055                .enumerate()
10056                .filter_map(|(i, c)| c.collation_name.as_deref().map(|n| (i, n)))
10057                .collect();
10058            write_u16(
10059                &mut out,
10060                u16::try_from(collated.len()).expect("≤ 65k columns/table"),
10061            );
10062            for (idx, name) in collated {
10063                write_u16(&mut out, u16::try_from(idx).expect("≤ 65k columns/table"));
10064                write_str(&mut out, name);
10065            }
10066            // v7.39 (round 711) — PK/UNIQUE constraint timing (FILE_VERSION
10067            // 89+). Dense, one byte per uniqueness constraint in
10068            // declaration order, the same bit layout the FK block has
10069            // carried since round 288: bit 0 = DEFERRABLE, bit 1 =
10070            // INITIALLY DEFERRED. A v88 reader stops before it.
10071            write_u16(
10072                &mut out,
10073                u16::try_from(t.schema.uniqueness_constraints.len())
10074                    .expect("≤ 65k uniqueness constraints/table"),
10075            );
10076            for uc in &t.schema.uniqueness_constraints {
10077                out.push(u8::from(uc.deferrable) | (u8::from(uc.initially_deferred) << 1));
10078            }
10079        }
10080        // v7.12.4 — catalog-wide appendix: user-defined functions
10081        // then triggers. FILE_VERSION 22+ only. v21 and earlier
10082        // readers stop after the last table; v22 readers always
10083        // consume two `u32` counts (possibly zero).
10084        //
10085        // Function entry layout:
10086        //   [str name] [str args_repr] [str returns]
10087        //   [str language] [str body]
10088        // Trigger entry layout:
10089        //   [str name] [str table] [str timing]
10090        //   [u16 event_count] (event_count × str)
10091        //   [str for_each] [str function]
10092        write_u32(
10093            &mut out,
10094            u32::try_from(self.functions.len()).expect("≤ 4G functions"),
10095        );
10096        for fd in self.functions.values() {
10097            write_str(&mut out, &fd.name);
10098            write_str(&mut out, &fd.args_repr);
10099            write_str(&mut out, &fd.returns);
10100            write_str(&mut out, &fd.language);
10101            write_str_long(&mut out, &fd.body);
10102        }
10103        write_u32(
10104            &mut out,
10105            u32::try_from(self.triggers.len()).expect("≤ 4G triggers"),
10106        );
10107        for td in &self.triggers {
10108            write_str(&mut out, &td.name);
10109            write_str(&mut out, &td.table);
10110            write_str(&mut out, &td.timing);
10111            write_u16(
10112                &mut out,
10113                u16::try_from(td.events.len()).expect("≤ 65k events / trigger"),
10114            );
10115            for ev in &td.events {
10116                write_str(&mut out, ev);
10117            }
10118            write_str(&mut out, &td.for_each);
10119            write_str(&mut out, &td.function);
10120            // v7.13.0 — `UPDATE OF cols` filter
10121            // (FILE_VERSION 23+). v22 readers omit; v23 writers
10122            // always emit (possibly zero).
10123            write_u16(
10124                &mut out,
10125                u16::try_from(td.update_columns.len()).expect("≤ 65k cols / trigger"),
10126            );
10127            for c in &td.update_columns {
10128                write_str(&mut out, c);
10129            }
10130            // v7.16.1 — TriggerDef.enabled (FILE_VERSION 25+).
10131            out.push(u8::from(td.enabled));
10132            // v7.39 (round 138) — WHEN condition text (FILE_VERSION 70+).
10133            write_str(&mut out, &td.when_condition);
10134        }
10135        // v7.17.0 Phase 1.1 — SEQUENCE catalog block (FILE_VERSION 26+).
10136        write_u32(
10137            &mut out,
10138            u32::try_from(self.sequences.len()).expect("≤ 4G sequences"),
10139        );
10140        for seq in self.sequences.values() {
10141            write_str(&mut out, &seq.name);
10142            out.push(match seq.data_type {
10143                SequenceDataType::SmallInt => 0,
10144                SequenceDataType::Int => 1,
10145                SequenceDataType::BigInt => 2,
10146            });
10147            out.extend_from_slice(&seq.start.to_le_bytes());
10148            out.extend_from_slice(&seq.increment.to_le_bytes());
10149            out.extend_from_slice(&seq.min_value.to_le_bytes());
10150            out.extend_from_slice(&seq.max_value.to_le_bytes());
10151            out.extend_from_slice(&seq.cache.to_le_bytes());
10152            out.push(u8::from(seq.cycle));
10153            match &seq.owned_by {
10154                None => out.push(0),
10155                Some((table, column)) => {
10156                    out.push(1);
10157                    write_str(&mut out, table);
10158                    write_str(&mut out, column);
10159                }
10160            }
10161            out.extend_from_slice(&seq.last_value.to_le_bytes());
10162            out.push(u8::from(seq.is_called));
10163        }
10164        // v7.17.0 Phase 1.2 — VIEW catalog block (FILE_VERSION 27+).
10165        write_u32(
10166            &mut out,
10167            u32::try_from(self.views.len()).expect("≤ 4G views"),
10168        );
10169        for view in self.views.values() {
10170            write_str(&mut out, &view.name);
10171            write_u16(
10172                &mut out,
10173                u16::try_from(view.columns.len()).expect("≤ 65k cols / view"),
10174            );
10175            for c in &view.columns {
10176                write_str(&mut out, c);
10177            }
10178            write_str_long(&mut out, &view.body);
10179            // v7.39 (round 132, FILE_VERSION 69+) — WITH CHECK OPTION marker.
10180            out.push(view.check_option);
10181        }
10182        // v7.17.0 Phase 1.3 — MATERIALIZED VIEW source registry
10183        // (FILE_VERSION 28+). The backing rows live as a regular
10184        // table of the same name already in the tables block.
10185        write_u32(
10186            &mut out,
10187            u32::try_from(self.materialized_views.len()).expect("≤ 4G materialized views"),
10188        );
10189        for (name, body) in &self.materialized_views {
10190            write_str(&mut out, name);
10191            write_str_long(&mut out, body);
10192        }
10193        // v7.17.0 Phase 1.4 — ENUM types catalog block
10194        // (FILE_VERSION 29+).
10195        write_u32(
10196            &mut out,
10197            u32::try_from(self.enum_types.len()).expect("≤ 4G enum types"),
10198        );
10199        for e in self.enum_types.values() {
10200            write_str(&mut out, &e.name);
10201            write_u16(
10202                &mut out,
10203                u16::try_from(e.labels.len()).expect("≤ 65k labels / enum"),
10204            );
10205            for l in &e.labels {
10206                write_str(&mut out, l);
10207            }
10208        }
10209        // v7.17.0 Phase 1.5 — DOMAIN types catalog block
10210        // (FILE_VERSION 30+).
10211        write_u32(
10212            &mut out,
10213            u32::try_from(self.domain_types.len()).expect("≤ 4G domain types"),
10214        );
10215        for d in self.domain_types.values() {
10216            write_str(&mut out, &d.name);
10217            write_data_type(&mut out, d.base_type);
10218            out.push(u8::from(d.nullable));
10219            match &d.default {
10220                None => out.push(0),
10221                Some(s) => {
10222                    out.push(1);
10223                    write_str(&mut out, s);
10224                }
10225            }
10226            write_u16(
10227                &mut out,
10228                u16::try_from(d.checks.len()).expect("≤ 65k CHECKs / domain"),
10229            );
10230            for c in &d.checks {
10231                write_str(&mut out, &c.expr);
10232                // v7.39 (round 260) — the constraint name (FILE_VERSION 75+).
10233                write_str(&mut out, &c.name);
10234            }
10235            // v7.39 (round 259) — the parent domain (FILE_VERSION 74+).
10236            match &d.base_domain {
10237                None => out.push(0),
10238                Some(s) => {
10239                    out.push(1);
10240                    write_str(&mut out, s);
10241                }
10242            }
10243        }
10244        // v7.17.0 Phase 1.6 — user-schemas registry
10245        // (FILE_VERSION 31+). Built-ins are hardcoded in
10246        // `is_builtin_schema` and not persisted.
10247        write_u32(
10248            &mut out,
10249            u32::try_from(self.schemas.len()).expect("≤ 4G schemas"),
10250        );
10251        for name in &self.schemas {
10252            write_str(&mut out, name);
10253        }
10254        // v7.37.42-T2 ζ-B — COMPOSITE types catalog block
10255        // (FILE_VERSION 52+). Each entry: name, u16 field_count,
10256        // then field_count `[str field_name][data_type]` pairs.
10257        write_u32(
10258            &mut out,
10259            u32::try_from(self.composite_types.len()).expect("≤ 4G composite types"),
10260        );
10261        for c in self.composite_types.values() {
10262            write_str(&mut out, &c.name);
10263            write_u16(
10264                &mut out,
10265                u16::try_from(c.fields.len()).expect("≤ 65k fields / composite"),
10266            );
10267            for (i, (fname, fty)) in c.fields.iter().enumerate() {
10268                write_str(&mut out, fname);
10269                write_data_type(&mut out, *fty);
10270                // v7.39 (round 264) — the field's user type (v76+).
10271                match c.field_user_types.get(i).and_then(Option::as_ref) {
10272                    None => out.push(0),
10273                    Some(n) => {
10274                        out.push(1);
10275                        write_str(&mut out, n);
10276                    }
10277                }
10278            }
10279        }
10280        // v7.39 (read01 round 50) — COMMENT store (FILE_VERSION 61+).
10281        // Catalog-wide, written last (before the CRC trailer) so every older
10282        // reader stops before it. Layout: [u32 count] then [str key][str text].
10283        write_u32(
10284            &mut out,
10285            u32::try_from(self.comments.len()).expect("≤ 4G comments"),
10286        );
10287        for (k, v) in &self.comments {
10288            write_str(&mut out, k);
10289            write_str_long(&mut out, v);
10290        }
10291        // v7.39 (read01 round 60) — non-table ACLs (FILE_VERSION 66+), catalog-
10292        // wide and written last so a v65 reader stops before them. The sequence
10293        // block itself sits mid-image and cannot grow without breaking older
10294        // readers, so a sequence's owner + ACL rides here, keyed by name.
10295        let acl_out = |out: &mut Vec<u8>, acl: &[AclItem]| {
10296            write_u16(out, u16::try_from(acl.len()).expect("≤ 65k aclitems"));
10297            for a in acl {
10298                write_str(out, &a.grantee);
10299                write_u16(out, a.privs);
10300                write_u16(out, a.grantable);
10301                write_str(out, &a.grantor);
10302            }
10303        };
10304        let owned: Vec<&SequenceDef> = self
10305            .sequences
10306            .values()
10307            .filter(|s| s.owner.is_some() || !s.acl.is_empty())
10308            .collect();
10309        write_u32(
10310            &mut out,
10311            u32::try_from(owned.len()).expect("≤ 4G sequences"),
10312        );
10313        for seq in owned {
10314            write_str(&mut out, &seq.name);
10315            match &seq.owner {
10316                Some(o) => {
10317                    out.push(1);
10318                    write_str(&mut out, o);
10319                }
10320                None => out.push(0),
10321            }
10322            acl_out(&mut out, &seq.acl);
10323        }
10324        acl_out(&mut out, &self.schema_acl);
10325        acl_out(&mut out, &self.database_acl);
10326        // v7.39 (read01 round 61) — FUNCTION owner + ACL (FILE_VERSION 67+).
10327        // The function block sits mid-image like the sequence one, so this
10328        // rides the catalog-wide tail too, keyed by name.
10329        let fns: Vec<&FunctionDef> = self
10330            .functions
10331            .values()
10332            .filter(|f| f.owner.is_some() || !f.acl.is_empty())
10333            .collect();
10334        write_u32(&mut out, u32::try_from(fns.len()).expect("≤ 4G functions"));
10335        for f in fns {
10336            // v7.39 (read01 round 62) — keyed by SIGNATURE now: two overloads
10337            // have two ACLs.
10338            write_str(&mut out, &function_signature_key(&f.name, &f.args_repr));
10339            match &f.owner {
10340                Some(o) => {
10341                    out.push(1);
10342                    write_str(&mut out, o);
10343                }
10344                None => out.push(0),
10345            }
10346            acl_out(&mut out, &f.acl);
10347        }
10348        // v7.39 (round 139) — RULE catalog block (FILE_VERSION 71+), catalog-
10349        // wide and written last (right before the CRC trailer) so every older
10350        // reader stops cleanly before it. Layout: [u32 count] then per rule
10351        // [str name][str table][str event][u8 instead][str when]
10352        // [u16 cmd_count]([str cmd] × cmd_count).
10353        write_u32(
10354            &mut out,
10355            u32::try_from(self.rules.len()).expect("≤ 4G rules"),
10356        );
10357        for r in &self.rules {
10358            write_str(&mut out, &r.name);
10359            write_str(&mut out, &r.table);
10360            write_str(&mut out, &r.event);
10361            out.push(u8::from(r.instead));
10362            write_str(&mut out, &r.when_condition);
10363            write_u16(
10364                &mut out,
10365                u16::try_from(r.commands.len()).expect("≤ 65k commands / rule"),
10366            );
10367            for c in &r.commands {
10368                write_str(&mut out, c);
10369            }
10370        }
10371        // v7.39 (round 280) — extended-statistics block (FILE_VERSION
10372        // 77+), appended after the RULE block for the same reason: an
10373        // older reader stops cleanly before it. Layout: [u32 count]
10374        // then per object [str name][str table][u16 n]([str kind] × n)
10375        // [u16 m]([str column] × m).
10376        write_u32(
10377            &mut out,
10378            u32::try_from(self.statistics_ext.len()).expect("≤ 4G statistics objects"),
10379        );
10380        for st in &self.statistics_ext {
10381            write_str(&mut out, &st.name);
10382            write_str(&mut out, &st.table);
10383            write_u16(
10384                &mut out,
10385                u16::try_from(st.kinds.len()).expect("≤ 65k kinds"),
10386            );
10387            for k in &st.kinds {
10388                write_str(&mut out, k);
10389            }
10390            write_u16(
10391                &mut out,
10392                u16::try_from(st.columns.len()).expect("≤ 65k columns"),
10393            );
10394            for c in &st.columns {
10395                write_str(&mut out, c);
10396            }
10397        }
10398        // v7.39 (round 287) — large-object block (FILE_VERSION 78+),
10399        // appended after the statistics block for the same reason: an
10400        // older reader stops cleanly before it. Layout: [u32 count]
10401        // then per object [u32 oid][u32 len][len bytes].
10402        write_u32(
10403            &mut out,
10404            u32::try_from(self.large_objects.len()).expect("≤ 4G large objects"),
10405        );
10406        for (oid, bytes) in &self.large_objects {
10407            write_u32(&mut out, *oid);
10408            write_u32(
10409                &mut out,
10410                u32::try_from(bytes.len()).expect("≤ 4G per object"),
10411            );
10412            out.extend_from_slice(bytes);
10413        }
10414        // v7.39 (round 322, V46) — function-attribute block (FILE_VERSION
10415        // 80+), appended last for the same reason as every block before
10416        // it: an older reader stops cleanly ahead of it and simply sees
10417        // functions with PG's default attributes. Only functions that
10418        // declared something non-default are written. Layout: [u32 count]
10419        // then per function [str signature_key][u8 volatility][u8 flags]
10420        // [u8 parallel][f64 cost or NaN][f64 rows or NaN], where flags bit
10421        // 0 = strict, 1 = security definer, 2 = leakproof.
10422        let attr_fns: Vec<(&String, &FunctionDef)> = self
10423            .functions
10424            .iter()
10425            .filter(|(_, f)| {
10426                f.volatility != FN_VOLATILE
10427                    || f.strict
10428                    || f.security_definer
10429                    || f.leakproof
10430                    || f.parallel != FN_PARALLEL_UNSAFE
10431                    || f.cost.is_some()
10432                    || f.rows.is_some()
10433            })
10434            .collect();
10435        write_u32(
10436            &mut out,
10437            u32::try_from(attr_fns.len()).expect("≤ 4G functions"),
10438        );
10439        for (key, f) in attr_fns {
10440            write_str(&mut out, key);
10441            out.push(f.volatility);
10442            let flags = u8::from(f.strict)
10443                | (u8::from(f.security_definer) << 1)
10444                | (u8::from(f.leakproof) << 2);
10445            out.push(flags);
10446            out.push(f.parallel);
10447            out.extend_from_slice(&f.cost.unwrap_or(f64::NAN).to_le_bytes());
10448            out.extend_from_slice(&f.rows.unwrap_or(f64::NAN).to_le_bytes());
10449        }
10450        // v7.38 (read01 P5.05) — CRC32C trailer over the whole image so a
10451        // corrupted snapshot is rejected on load. FILE_VERSION is >= the
10452        // trailer version, so this always runs for freshly-written images.
10453        // v7.39 (round 547) — pg_db_role_setting (FILE_VERSION 85+),
10454        // catalog-wide and written LAST so a v84 reader stops before it.
10455        // Layout: [u32 scopes] then [str database][str role][u32 params]
10456        // then [str name][str value] per param.
10457        write_u32(
10458            &mut out,
10459            u32::try_from(self.db_role_settings.len()).expect("≤ 4G scopes"),
10460        );
10461        for ((db, role), params) in &self.db_role_settings {
10462            write_str(&mut out, db);
10463            write_str(&mut out, role);
10464            write_u32(&mut out, u32::try_from(params.len()).expect("≤ 4G params"));
10465            for (name, value) in params {
10466                write_str(&mut out, name);
10467                write_str(&mut out, value);
10468            }
10469        }
10470        // v7.39 (round 550) — replication slots (FILE_VERSION 86+),
10471        // written LAST so a v85 reader stops before them.
10472        write_u32(
10473            &mut out,
10474            u32::try_from(self.replication_slots.len()).expect("≤ 4G slots"),
10475        );
10476        for (name, (plugin, slot_type)) in &self.replication_slots {
10477            write_str(&mut out, name);
10478            write_str(&mut out, plugin);
10479            write_str(&mut out, slot_type);
10480        }
10481        // v7.38.18 (S1) — the database collation (FILE_VERSION 92+).
10482        // Absent on an older image, which reads back as `C`.
10483        match &self.db_collation {
10484            None => out.push(0),
10485            Some(c) => {
10486                out.push(1);
10487                write_str(&mut out, c);
10488            }
10489        }
10490        let crc = spg_crypto::crc32c::crc32c(&out);
10491        write_u32(&mut out, crc);
10492        out
10493    }
10494
10495    /// Deserialize a previously-serialized catalog. Rejects bad magic, version
10496    /// mismatch, unknown tags, truncation, and trailing bytes.
10497    pub fn deserialize(buf: &[u8]) -> Result<Self, StorageError> {
10498        let mut cur = Cursor::new(buf);
10499        let magic = cur.take(8)?;
10500        if magic != FILE_MAGIC {
10501            return Err(StorageError::Corrupt(format!(
10502                "bad magic: expected SPGDB001, got {magic:?}"
10503            )));
10504        }
10505        let version = cur.read_u8()?;
10506        if !(MIN_SUPPORTED_FILE_VERSION..=FILE_VERSION).contains(&version) {
10507            return Err(StorageError::Corrupt(format!(
10508                "unsupported file version: {version} (supported: {MIN_SUPPORTED_FILE_VERSION}..={FILE_VERSION})"
10509            )));
10510        }
10511        // v7.23/v7.27 — escape decoding is version-gated (see
10512        // STR_LEN_ESCAPE / Cursor::codec_version).
10513        cur.codec_version = version;
10514        let table_count = cur.read_u32()? as usize;
10515        let mut cat = Self::new();
10516        for _ in 0..table_count {
10517            deserialize_table(&mut cur, &mut cat, version)?;
10518        }
10519        // v7.37.15 (Phase C.1) — stamp dense stable RelIds on load.
10520        // Pre-V6 envelopes carry no ids; a dense 1..=N assignment is
10521        // sufficient while RelId is process-local bookkeeping (the V6
10522        // envelope, Phase C.6, will round-trip real ids). Sets the
10523        // allocator above the loaded ids so a post-load CREATE TABLE
10524        // never collides.
10525        for (i, t) in cat.tables.iter_mut().enumerate() {
10526            t.set_rel_id(row_header::RelId((i as u64) + 1));
10527        }
10528        cat.next_rel_id = cat.tables.len() as u64;
10529        // v7.12.4 — catalog-wide function + trigger appendix.
10530        // FILE_VERSION 22+ only; v21 and earlier catalogs stop
10531        // after the last table.
10532        if version >= 22 {
10533            let fn_count = cur.read_u32()? as usize;
10534            for _ in 0..fn_count {
10535                let name = cur.read_str()?;
10536                let args_repr = cur.read_str()?;
10537                let returns = cur.read_str()?;
10538                let language = cur.read_str()?;
10539                let body = cur.read_str_long()?;
10540                let key = function_signature_key(&name, &args_repr);
10541                cat.functions.insert(
10542                    key,
10543                    FunctionDef {
10544                        name,
10545                        args_repr,
10546                        returns,
10547                        language,
10548                        body,
10549                        owner: None,
10550                        acl: Vec::new(),
10551                        volatility: FN_VOLATILE,
10552                        strict: false,
10553                        security_definer: false,
10554                        leakproof: false,
10555                        parallel: FN_PARALLEL_UNSAFE,
10556                        cost: None,
10557                        rows: None,
10558                    },
10559                );
10560            }
10561            let trg_count = cur.read_u32()? as usize;
10562            for _ in 0..trg_count {
10563                let name = cur.read_str()?;
10564                let table = cur.read_str()?;
10565                let timing = cur.read_str()?;
10566                let ev_count = cur.read_u16()? as usize;
10567                let mut events = Vec::with_capacity(ev_count);
10568                for _ in 0..ev_count {
10569                    events.push(cur.read_str()?);
10570                }
10571                let for_each = cur.read_str()?;
10572                let function = cur.read_str()?;
10573                // v7.13.0 — trailing `UPDATE OF cols` filter
10574                // (FILE_VERSION 23+ only; v22 catalogs omit and
10575                // deserialise with an empty vec).
10576                let update_columns = if version >= 23 {
10577                    let n = cur.read_u16()? as usize;
10578                    let mut cols = Vec::with_capacity(n);
10579                    for _ in 0..n {
10580                        cols.push(cur.read_str()?);
10581                    }
10582                    cols
10583                } else {
10584                    Vec::new()
10585                };
10586                // v7.16.1 — TriggerDef.enabled (FILE_VERSION 25+).
10587                // v24-and-below catalogs deserialise with `true`
10588                // — pre-v7.16.1 every trigger always fired.
10589                let enabled = if version >= 25 {
10590                    cur.read_u8()? != 0
10591                } else {
10592                    true
10593                };
10594                // v7.39 (round 138) — WHEN condition text added at FILE_VERSION
10595                // 70; older catalogs read back empty (no WHEN filter).
10596                let when_condition = if version >= 70 {
10597                    cur.read_str()?
10598                } else {
10599                    String::new()
10600                };
10601                cat.triggers.push(TriggerDef {
10602                    name,
10603                    table,
10604                    timing,
10605                    events,
10606                    for_each,
10607                    function,
10608                    update_columns,
10609                    enabled,
10610                    when_condition,
10611                });
10612            }
10613        }
10614        // v7.17.0 Phase 1.1 — SEQUENCE block (FILE_VERSION 26+).
10615        // v25-and-below catalogs omit; we leave the map empty.
10616        if version >= 26 {
10617            let seq_count = cur.read_u32()? as usize;
10618            for _ in 0..seq_count {
10619                let name = cur.read_str()?;
10620                let data_type = match cur.read_u8()? {
10621                    0 => SequenceDataType::SmallInt,
10622                    1 => SequenceDataType::Int,
10623                    2 => SequenceDataType::BigInt,
10624                    other => {
10625                        return Err(StorageError::Corrupt(format!(
10626                            "unknown SEQUENCE data-type tag {other}"
10627                        )));
10628                    }
10629                };
10630                let start = cur.read_i64()?;
10631                let increment = cur.read_i64()?;
10632                let min_value = cur.read_i64()?;
10633                let max_value = cur.read_i64()?;
10634                let cache = cur.read_i64()?;
10635                let cycle = cur.read_u8()? != 0;
10636                let owned_by = match cur.read_u8()? {
10637                    0 => None,
10638                    1 => {
10639                        let t = cur.read_str()?;
10640                        let c = cur.read_str()?;
10641                        Some((t, c))
10642                    }
10643                    other => {
10644                        return Err(StorageError::Corrupt(format!(
10645                            "unknown SEQUENCE owned-by tag {other}"
10646                        )));
10647                    }
10648                };
10649                let last_value = cur.read_i64()?;
10650                let is_called = cur.read_u8()? != 0;
10651                cat.sequences.insert(
10652                    name.clone(),
10653                    SequenceDef {
10654                        name,
10655                        data_type,
10656                        start,
10657                        increment,
10658                        min_value,
10659                        max_value,
10660                        cache,
10661                        cycle,
10662                        owned_by,
10663                        last_value,
10664                        is_called,
10665                        owner: None,
10666                        acl: Vec::new(),
10667                    },
10668                );
10669            }
10670        }
10671        // v7.17.0 Phase 1.2 — VIEW block (FILE_VERSION 27+).
10672        // v26-and-below catalogs omit; we leave the map empty.
10673        if version >= 27 {
10674            let view_count = cur.read_u32()? as usize;
10675            for _ in 0..view_count {
10676                let name = cur.read_str()?;
10677                let col_count = cur.read_u16()? as usize;
10678                let mut columns = Vec::with_capacity(col_count);
10679                for _ in 0..col_count {
10680                    columns.push(cur.read_str()?);
10681                }
10682                let body = cur.read_str_long()?;
10683                // v7.39 (round 132) — check-option marker added at FILE_VERSION
10684                // 69; older catalogs default to 0 (no check option).
10685                let check_option = if version >= 69 { cur.read_u8()? } else { 0 };
10686                cat.views.insert(
10687                    name.clone(),
10688                    ViewDef {
10689                        name,
10690                        columns,
10691                        body,
10692                        check_option,
10693                    },
10694                );
10695            }
10696        }
10697        // v7.17.0 Phase 1.3 — MATERIALIZED VIEW source registry
10698        // (FILE_VERSION 28+). v27-and-below catalogs omit.
10699        if version >= 28 {
10700            let mv_count = cur.read_u32()? as usize;
10701            for _ in 0..mv_count {
10702                let name = cur.read_str()?;
10703                let body = cur.read_str_long()?;
10704                cat.materialized_views.insert(name, body);
10705            }
10706        }
10707        // v7.17.0 Phase 1.4 — ENUM types catalog block
10708        // (FILE_VERSION 29+).
10709        if version >= 29 {
10710            let etype_count = cur.read_u32()? as usize;
10711            for _ in 0..etype_count {
10712                let name = cur.read_str()?;
10713                let label_count = cur.read_u16()? as usize;
10714                let mut labels = Vec::with_capacity(label_count);
10715                for _ in 0..label_count {
10716                    labels.push(cur.read_str()?);
10717                }
10718                cat.enum_types
10719                    .insert(name.clone(), EnumDef { name, labels });
10720            }
10721        }
10722        // v7.17.0 Phase 1.5 — DOMAIN types catalog block
10723        // (FILE_VERSION 30+).
10724        if version >= 30 {
10725            let dtype_count = cur.read_u32()? as usize;
10726            for _ in 0..dtype_count {
10727                let name = cur.read_str()?;
10728                let base_type = cur.read_data_type()?;
10729                let nullable = cur.read_u8()? != 0;
10730                let default = match cur.read_u8()? {
10731                    0 => None,
10732                    1 => Some(cur.read_str()?),
10733                    other => {
10734                        return Err(StorageError::Corrupt(format!(
10735                            "unknown DOMAIN default tag {other}"
10736                        )));
10737                    }
10738                };
10739                let check_count = cur.read_u16()? as usize;
10740                let mut checks: Vec<DomainCheck> = Vec::with_capacity(check_count);
10741                for i in 0..check_count {
10742                    let expr = cur.read_str()?;
10743                    // v7.39 (round 260) — names arrived in FILE_VERSION 75.
10744                    // An older catalog gets PG's auto-naming applied to the
10745                    // checks it stored, which is what they would have been.
10746                    let cname = if version >= 75 {
10747                        cur.read_str()?
10748                    } else if i == 0 {
10749                        alloc::format!("{name}_check")
10750                    } else {
10751                        alloc::format!("{name}_check{i}")
10752                    };
10753                    checks.push(DomainCheck { name: cname, expr });
10754                }
10755                // v7.39 (round 259) — the parent domain. Absent before
10756                // FILE_VERSION 74; an older catalog reads as a domain over
10757                // a scalar, which is what it was.
10758                let base_domain = if version >= 74 {
10759                    match cur.read_u8()? {
10760                        0 => None,
10761                        1 => Some(cur.read_str()?),
10762                        other => {
10763                            return Err(StorageError::Corrupt(alloc::format!(
10764                                "domain base_domain tag {other}"
10765                            )));
10766                        }
10767                    }
10768                } else {
10769                    None
10770                };
10771                cat.domain_types.insert(
10772                    name.clone(),
10773                    DomainDef {
10774                        name,
10775                        base_type,
10776                        nullable,
10777                        default,
10778                        checks,
10779                        base_domain,
10780                    },
10781                );
10782            }
10783        }
10784        // v7.17.0 Phase 1.6 — user-schemas registry
10785        // (FILE_VERSION 31+).
10786        if version >= 31 {
10787            let sch_count = cur.read_u32()? as usize;
10788            for _ in 0..sch_count {
10789                let name = cur.read_str()?;
10790                cat.schemas.insert(name);
10791            }
10792        }
10793        // v7.37.42-T2 ζ-B — COMPOSITE types catalog block
10794        // (FILE_VERSION 52+). v51-and-below readers stop at the
10795        // user-schemas block; v52 readers fed a v51 catalog see no
10796        // composite block and default to an empty map.
10797        if version >= 52 {
10798            let ctype_count = cur.read_u32()? as usize;
10799            for _ in 0..ctype_count {
10800                let name = cur.read_str()?;
10801                let field_count = cur.read_u16()? as usize;
10802                let mut fields = Vec::with_capacity(field_count);
10803                let mut field_user_types: Vec<Option<String>> = Vec::with_capacity(field_count);
10804                for _ in 0..field_count {
10805                    let fname = cur.read_str()?;
10806                    let fty = cur.read_data_type()?;
10807                    // v7.39 (round 264) — present from FILE_VERSION 76.
10808                    let ut = if version >= 76 {
10809                        match cur.read_u8()? {
10810                            0 => None,
10811                            1 => Some(cur.read_str()?),
10812                            other => {
10813                                return Err(StorageError::Corrupt(alloc::format!(
10814                                    "composite field user-type tag {other}"
10815                                )));
10816                            }
10817                        }
10818                    } else {
10819                        None
10820                    };
10821                    fields.push((fname, fty));
10822                    field_user_types.push(ut);
10823                }
10824                cat.composite_types.insert(
10825                    name.clone(),
10826                    CompositeDef {
10827                        name,
10828                        fields,
10829                        field_user_types,
10830                    },
10831                );
10832            }
10833        }
10834        // v7.39 (read01 round 50) — COMMENT store (FILE_VERSION 61+).
10835        if version >= 61 {
10836            let comment_count = cur.read_u32()? as usize;
10837            for _ in 0..comment_count {
10838                let key = cur.read_str()?;
10839                let text = cur.read_str_long()?;
10840                cat.comments.insert(key, text);
10841            }
10842        }
10843        // v7.39 (read01 round 60) — non-table ACLs (FILE_VERSION 66+).
10844        if version >= 66 {
10845            let read_acl = |cur: &mut Cursor| -> Result<Vec<AclItem>, StorageError> {
10846                let n = cur.read_u16()? as usize;
10847                let mut acl = Vec::with_capacity(n);
10848                for _ in 0..n {
10849                    let grantee = cur.read_str()?;
10850                    let privs = cur.read_u16()?;
10851                    let grantable = cur.read_u16()?;
10852                    let grantor = cur.read_str()?;
10853                    acl.push(AclItem {
10854                        grantee,
10855                        privs,
10856                        grantable,
10857                        grantor,
10858                    });
10859                }
10860                Ok(acl)
10861            };
10862            let seq_count = cur.read_u32()? as usize;
10863            for _ in 0..seq_count {
10864                let name = cur.read_str()?;
10865                let owner = if cur.read_u8()? == 1 {
10866                    Some(cur.read_str()?)
10867                } else {
10868                    None
10869                };
10870                let acl = read_acl(&mut cur)?;
10871                if let Some(seq) = cat.sequences.get_mut(&name) {
10872                    seq.owner = owner;
10873                    seq.acl = acl;
10874                }
10875            }
10876            cat.schema_acl = read_acl(&mut cur)?;
10877            cat.database_acl = read_acl(&mut cur)?;
10878            // v7.39 (read01 round 61) — FUNCTION owner + ACL (v67+; keyed by
10879            // signature from v68, when overloads became possible).
10880            if version >= 67 {
10881                let fn_count = cur.read_u32()? as usize;
10882                for _ in 0..fn_count {
10883                    let name = cur.read_str()?;
10884                    let owner = if cur.read_u8()? == 1 {
10885                        Some(cur.read_str()?)
10886                    } else {
10887                        None
10888                    };
10889                    let acl = read_acl(&mut cur)?;
10890                    // v7.39 (round 315, V19) — the stored key was computed
10891                    // by whichever formula was current when the image was
10892                    // written. A miss is not "no such function": before the
10893                    // multi-word fix, `f(double precision)` keyed as
10894                    // `f(precision)`, so an older image's grants would land
10895                    // nowhere and vanish silently. Fall back to matching by
10896                    // the old formula, which re-attaches them.
10897                    let target = resolve_stored_function_key(&cat.functions, &name);
10898                    if let Some(k) = target
10899                        && let Some(f) = cat.functions.get_mut(&k)
10900                    {
10901                        f.owner = owner;
10902                        f.acl = acl;
10903                    }
10904                }
10905            }
10906        }
10907        // v7.39 (round 139) — RULE catalog block (FILE_VERSION 71+), read from
10908        // the tail right before the CRC trailer. Pre-71 images stop before it.
10909        if version >= 71 {
10910            let rule_count = cur.read_u32()? as usize;
10911            for _ in 0..rule_count {
10912                let name = cur.read_str()?;
10913                let table = cur.read_str()?;
10914                let event = cur.read_str()?;
10915                let instead = cur.read_u8()? != 0;
10916                let when_condition = cur.read_str()?;
10917                let cmd_count = cur.read_u16()? as usize;
10918                let mut commands = Vec::with_capacity(cmd_count);
10919                for _ in 0..cmd_count {
10920                    commands.push(cur.read_str()?);
10921                }
10922                cat.rules.push(RuleDef {
10923                    name,
10924                    table,
10925                    event,
10926                    instead,
10927                    when_condition,
10928                    commands,
10929                });
10930            }
10931        }
10932        // v7.39 (round 280) — extended-statistics block (FILE_VERSION
10933        // 77+). Pre-77 images stop before it.
10934        if version >= 77 {
10935            let count = cur.read_u32()? as usize;
10936            for _ in 0..count {
10937                let name = cur.read_str()?;
10938                let table = cur.read_str()?;
10939                let nk = cur.read_u16()? as usize;
10940                let mut kinds = Vec::with_capacity(nk);
10941                for _ in 0..nk {
10942                    kinds.push(cur.read_str()?);
10943                }
10944                let nc = cur.read_u16()? as usize;
10945                let mut columns = Vec::with_capacity(nc);
10946                for _ in 0..nc {
10947                    columns.push(cur.read_str()?);
10948                }
10949                cat.statistics_ext.push(StatisticsExtDef {
10950                    name,
10951                    table,
10952                    kinds,
10953                    columns,
10954                });
10955            }
10956        }
10957        // v7.39 (round 287) — large-object block (FILE_VERSION 78+).
10958        // Pre-78 images stop before it.
10959        if version >= 78 {
10960            let count = cur.read_u32()? as usize;
10961            for _ in 0..count {
10962                let oid = cur.read_u32()?;
10963                let len = cur.read_u32()? as usize;
10964                let bytes = cur.read_bytes(len)?;
10965                cat.large_objects.insert(oid, bytes);
10966            }
10967        }
10968        // v7.39 (round 322, V46) — function-attribute block (FILE_VERSION
10969        // 80+). Pre-80 images stop before it and keep PG's defaults.
10970        if version >= 80 {
10971            let count = cur.read_u32()? as usize;
10972            for _ in 0..count {
10973                let key = cur.read_str()?;
10974                let volatility = cur.read_u8()?;
10975                let flags = cur.read_u8()?;
10976                let parallel = cur.read_u8()?;
10977                let cost = f64::from_le_bytes(cur.read_bytes(8)?.try_into().unwrap_or([0; 8]));
10978                let rows = f64::from_le_bytes(cur.read_bytes(8)?.try_into().unwrap_or([0; 8]));
10979                if let Some(f) = cat.functions.get_mut(&key) {
10980                    f.volatility = volatility;
10981                    f.strict = flags & 1 != 0;
10982                    f.security_definer = flags & 2 != 0;
10983                    f.leakproof = flags & 4 != 0;
10984                    f.parallel = parallel;
10985                    f.cost = (!cost.is_nan()).then_some(cost);
10986                    f.rows = (!rows.is_nan()).then_some(rows);
10987                }
10988            }
10989        }
10990        // v7.39 (round 547) — pg_db_role_setting (FILE_VERSION 85+).
10991        // Pre-85 images stop before it and carry no GUC defaults.
10992        if version >= 85 {
10993            let scopes = cur.read_u32()? as usize;
10994            for _ in 0..scopes {
10995                let db = cur.read_str()?;
10996                let role = cur.read_str()?;
10997                let params = cur.read_u32()? as usize;
10998                let mut m: BTreeMap<String, String> = BTreeMap::new();
10999                for _ in 0..params {
11000                    let name = cur.read_str()?;
11001                    let value = cur.read_str()?;
11002                    m.insert(name, value);
11003                }
11004                if !m.is_empty() {
11005                    cat.db_role_settings.insert((db, role), m);
11006                }
11007            }
11008        }
11009        // v7.39 (round 550) — replication slots (FILE_VERSION 86+).
11010        if version >= 86 {
11011            let count = cur.read_u32()? as usize;
11012            for _ in 0..count {
11013                let name = cur.read_str()?;
11014                let plugin = cur.read_str()?;
11015                let slot_type = cur.read_str()?;
11016                cat.replication_slots.insert(name, (plugin, slot_type));
11017            }
11018        }
11019        // v7.38.18 (S1) — the database collation (FILE_VERSION 92+).
11020        if version >= 92 {
11021            match cur.read_u8()? {
11022                0 => {}
11023                1 => cat.db_collation = Some(cur.read_str()?),
11024                other => {
11025                    return Err(StorageError::Corrupt(format!(
11026                        "db_collation tag: unknown byte {other}"
11027                    )));
11028                }
11029            }
11030        }
11031        // v7.38.18 (S3) — a database created under a collation this
11032        // build cannot perform does not open.
11033        //
11034        // Falling back to bytes would answer with a different comparator
11035        // than every index key in it was built under, which is the one
11036        // failure this whole layer exists to prevent — and it would do
11037        // it silently, since a byte-ordered answer looks exactly like a
11038        // correct one. The check is a NAME classification here; the
11039        // engine, which owns the collator, verifies it can actually
11040        // perform the name before recording it.
11041        if let Some(c) = &cat.db_collation
11042            && c.trim().is_empty()
11043        {
11044            return Err(StorageError::Corrupt(format!(
11045                "database collation is recorded as {c:?}, which names nothing"
11046            )));
11047        }
11048        // v7.38.18 (S2) — and every table read back learns it, because a
11049        // table decides for itself which of its indexes key under a
11050        // collation. Done here rather than per-table in the loop above
11051        // because the byte that says so is written after the tables.
11052        let db_coll = cat.db_collation().to_string();
11053        for t in &mut cat.tables {
11054            t.set_db_collation(&db_coll);
11055        }
11056        // v7.38 (read01 P5.05) — v54+ images end with a CRC32C over every
11057        // preceding byte; verify it before accepting the snapshot. Older
11058        // images have no trailer and fall through to the trailing-byte check.
11059        if version >= FILE_VERSION_CRC_TRAILER {
11060            let crc_start = cur.pos;
11061            let stored = cur.read_u32()?;
11062            let computed = spg_crypto::crc32c::crc32c(&buf[..crc_start]);
11063            if computed != stored {
11064                return Err(StorageError::Corrupt(format!(
11065                    "base snapshot CRC mismatch: computed {computed:#010x}, stored {stored:#010x}"
11066                )));
11067            }
11068        }
11069        if cur.pos < buf.len() {
11070            return Err(StorageError::Corrupt(format!(
11071                "trailing bytes: {} unread",
11072                buf.len() - cur.pos
11073            )));
11074        }
11075        Ok(cat)
11076    }
11077}
11078
11079#[cfg(test)]
11080mod tests;