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.
1758pub fn mysql_compare_fold(s: &str) -> String {
1759 mysql_ci_fold(s)
1760}
1761
1762/// [`mysql_compare_fold`] for a `CHAR(n)` cell, whose trailing spaces
1763/// are padding rather than data.
1764///
1765/// Measured on both engines: over `'alpha'` and `'alpha '` in a
1766/// `CHAR(8)`, `WHERE s = 'alpha'` returns both rows and
1767/// `COUNT(DISTINCT s)` is 2 (four rows folding to two values) — MySQL
1768/// 9.7.2 and MariaDB 12.3.2 agree, unlike the VARCHAR case above.
1769pub fn mysql_compare_fold_char(s: &str) -> String {
1770 mysql_ci_fold(s.trim_end_matches(' '))
1771}
1772
1773/// The base letter(s) a lower-cased Latin character folds to, or `None`
1774/// when it is already a base / has no fold. Expansions (`ß` → `ss`) are
1775/// why this returns a string.
1776fn fold_latin_base(c: char) -> Option<&'static str> {
1777 Some(match c {
1778 'à' | 'á' | 'â' | 'ã' | 'ä' | 'å' | 'ā' | 'ă' | 'ą' => "a",
1779 'æ' => "ae",
1780 'ç' | 'ć' | 'č' | 'ĉ' | 'ċ' => "c",
1781 'ð' | 'ď' | 'đ' => "d",
1782 'è' | 'é' | 'ê' | 'ë' | 'ē' | 'ĕ' | 'ė' | 'ę' | 'ě' => "e",
1783 'ĝ' | 'ğ' | 'ġ' | 'ģ' => "g",
1784 'ì' | 'í' | 'î' | 'ï' | 'ĩ' | 'ī' | 'ĭ' | 'į' => "i",
1785 'ĵ' => "j",
1786 'ķ' => "k",
1787 'ł' | 'ĺ' | 'ļ' | 'ľ' => "l",
1788 'ñ' | 'ń' | 'ņ' | 'ň' => "n",
1789 'ò' | 'ó' | 'ô' | 'õ' | 'ö' | 'ø' | 'ō' | 'ŏ' | 'ő' => "o",
1790 'œ' => "oe",
1791 'ŕ' | 'ŗ' | 'ř' => "r",
1792 'ś' | 'š' | 'ŝ' | 'ş' => "s",
1793 'ß' => "ss",
1794 'ţ' | 'ť' | 'ŧ' => "t",
1795 'ù' | 'ú' | 'û' | 'ü' | 'ũ' | 'ū' | 'ŭ' | 'ů' | 'ű' | 'ų' => "u",
1796 'ý' | 'ÿ' => "y",
1797 'ź' | 'ž' | 'ż' => "z",
1798 _ => return None,
1799 })
1800}
1801
1802#[allow(clippy::derivable_impls)]
1803impl Default for Collation {
1804 fn default() -> Self {
1805 Self::Binary
1806 }
1807}
1808
1809impl Collation {
1810 /// Wire tag persisted in the FILE_VERSION 34+ catalog appendix.
1811 /// Stable: future variants append above the recognised range
1812 /// and unknown tags read back as `Binary` for forward-compat
1813 /// on rollback.
1814 pub const TAG_BINARY: u8 = 0;
1815 pub const TAG_CASE_INSENSITIVE: u8 = 1;
1816}
1817
1818/// v7.39 (RLS) — the command a policy applies to. `ALL` is the default and
1819/// covers every command; the others scope the policy to one statement kind.
1820/// Persisted as a single byte in the policy appendix (FILE_VERSION 59+).
1821#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1822pub enum PolicyCmd {
1823 All,
1824 Select,
1825 Insert,
1826 Update,
1827 Delete,
1828}
1829
1830impl PolicyCmd {
1831 /// PG `pg_policy.polcmd` single-char encoding.
1832 #[must_use]
1833 pub const fn as_pg_char(self) -> char {
1834 match self {
1835 Self::All => '*',
1836 Self::Select => 'r',
1837 Self::Insert => 'a',
1838 Self::Update => 'w',
1839 Self::Delete => 'd',
1840 }
1841 }
1842
1843 /// PG `pg_policies.cmd` word form.
1844 #[must_use]
1845 pub const fn as_pg_word(self) -> &'static str {
1846 match self {
1847 Self::All => "ALL",
1848 Self::Select => "SELECT",
1849 Self::Insert => "INSERT",
1850 Self::Update => "UPDATE",
1851 Self::Delete => "DELETE",
1852 }
1853 }
1854
1855 #[must_use]
1856 pub const fn to_wire_byte(self) -> u8 {
1857 match self {
1858 Self::All => 0,
1859 Self::Select => 1,
1860 Self::Insert => 2,
1861 Self::Update => 3,
1862 Self::Delete => 4,
1863 }
1864 }
1865
1866 #[must_use]
1867 pub const fn from_wire_byte(b: u8) -> Option<Self> {
1868 match b {
1869 0 => Some(Self::All),
1870 1 => Some(Self::Select),
1871 2 => Some(Self::Insert),
1872 3 => Some(Self::Update),
1873 4 => Some(Self::Delete),
1874 _ => None,
1875 }
1876 }
1877}
1878
1879/// v7.39 (RLS) — one `CREATE POLICY` object, stored per table. The `using_expr`
1880/// / `with_check_expr` hold the qualifying expression's `Display` form
1881/// (re-parsed and evaluated per row at enforcement time, exactly like
1882/// `TableSchema.checks`); `None` means the clause was absent. `roles` empty =
1883/// PUBLIC. Persisted in the policy appendix (FILE_VERSION 59+).
1884#[derive(Debug, Clone, PartialEq)]
1885pub struct PolicyDef {
1886 pub name: String,
1887 pub cmd: PolicyCmd,
1888 /// `true` = PERMISSIVE (default, OR-combined), `false` = RESTRICTIVE
1889 /// (AND-combined).
1890 pub permissive: bool,
1891 pub roles: Vec<String>,
1892 pub using_expr: Option<String>,
1893 pub with_check_expr: Option<String>,
1894}
1895
1896#[derive(Debug, Clone, PartialEq)]
1897pub struct TableSchema {
1898 pub name: String,
1899 pub columns: Vec<ColumnSchema>,
1900 /// v6.7.2 — per-table hot-tier byte budget override. `None`
1901 /// falls through to the global `SPG_HOT_TIER_BYTES` setting;
1902 /// `Some(n)` overrides it for this specific table. Set via
1903 /// `ALTER TABLE t SET hot_tier_bytes = X`. Persisted in
1904 /// catalog FILE_VERSION 11+.
1905 pub hot_tier_bytes: Option<u64>,
1906 /// v7.6.1 — FOREIGN KEY constraints declared on this table.
1907 /// Engine maintains this in lock-step with `spg-sql`'s parser
1908 /// AST; the storage layer carries the on-disk shape so a
1909 /// catalog snapshot round-trips without external mapping.
1910 /// Persisted in catalog FILE_VERSION 13+. Older catalogs
1911 /// deserialise with an empty vec.
1912 pub foreign_keys: Vec<ForeignKeyConstraint>,
1913 /// v7.9.19 — composite UNIQUE / PRIMARY KEY constraints
1914 /// declared at the table level. Each entry's leading column
1915 /// has a BTree index (created via the constraint), and INSERT
1916 /// path enforces the full-tuple uniqueness via a scan keyed
1917 /// by the leading column. Persisted in catalog FILE_VERSION
1918 /// 15+. Older catalogs (≤ 14) deserialise with an empty vec.
1919 pub uniqueness_constraints: Vec<UniquenessConstraint>,
1920 /// v7.39 (round 210) — `EXCLUDE` constraints declared at the table level.
1921 /// Enforced on INSERT/UPDATE by a full live-row scan re-checking each
1922 /// element's operator (no equality index can answer overlap). Persisted
1923 /// in catalog FILE_VERSION 72+; older catalogs deserialise with an empty
1924 /// vec.
1925 pub exclusion_constraints: Vec<ExclusionConstraint>,
1926 /// v7.13.0 — `CHECK (<expr>)` predicates declared on this
1927 /// table. Both column-level inline `CHECK (…)` and
1928 /// table-level `CHECK (…)` fold into this list. Each entry
1929 /// is the AST Expr's `Display` form, re-parsed on every
1930 /// INSERT/UPDATE and evaluated against the candidate row.
1931 /// A false / NULL result rejects the mutation (PG semantics).
1932 /// Persisted in catalog FILE_VERSION 23+. Older catalogs
1933 /// deserialise with an empty vec. v7.39 (read01 round 48) — each entry
1934 /// now carries the user's constraint name too (FILE_VERSION 60+).
1935 pub checks: Vec<CheckConstraint>,
1936 /// v7.37.6-B — declarative partition role(sentori Epic 2 P0).
1937 /// `None` = 普通表(后向兼容,< v49 catalog 默认 None)。
1938 /// `Some(Parent { … })` = `CREATE TABLE p (...) PARTITION BY RANGE (key_col)` 父表 —
1939 /// 父表自己 `rows` 永远空,INSERT 在引擎层路由到命中的 child。
1940 /// `Some(Range { … })` = `CREATE TABLE c PARTITION OF p FOR VALUES FROM (a) TO (b)` 范围子表。
1941 /// `Some(Default { … })` = `CREATE TABLE c PARTITION OF p DEFAULT` 兜底子表。
1942 /// 持久化于 FILE_VERSION 49+。
1943 pub partition_role: Option<PartitionRole>,
1944 /// v7.39 (RLS) — `CREATE POLICY` objects on this table, independent of the
1945 /// `row_security` flag (PG stores policies even on non-RLS tables; they
1946 /// only take effect once RLS is enabled). Persisted in the policy appendix
1947 /// (FILE_VERSION 59+). Older catalogs deserialise with an empty vec.
1948 pub policies: Vec<PolicyDef>,
1949 /// v7.39 (RLS) — `ALTER TABLE … ENABLE ROW LEVEL SECURITY`
1950 /// (PG `pg_class.relrowsecurity`). Fresh table = `false`.
1951 pub row_security: bool,
1952 /// v7.39 (RLS) — `ALTER TABLE … FORCE ROW LEVEL SECURITY`
1953 /// (PG `pg_class.relforcerowsecurity`); subjects the table owner to RLS
1954 /// too. Fresh table = `false`.
1955 pub force_row_security: bool,
1956 /// v7.39 (read01 round 57, ACL) — the role that owns this table: whoever
1957 /// ran CREATE TABLE (PG `pg_class.relowner`). The owner holds every
1958 /// privilege implicitly and is the only role that may ALTER / DROP it.
1959 /// `None` = an image written before FILE_VERSION 64, which predates roles
1960 /// entirely; those tables read back as owned by the login role.
1961 pub owner: Option<String>,
1962 /// v7.39 (read01 round 57, ACL) — explicit GRANTs on this table
1963 /// (PG `pg_class.relacl`). EMPTY means "never granted": PG leaves relacl
1964 /// NULL while only the owner's implicit privileges apply, and materialises
1965 /// the whole list — owner's default entry included — on the first GRANT.
1966 /// Once materialised it stays, even after every grant is revoked.
1967 pub acl: Vec<AclItem>,
1968}
1969
1970/// v7.39 (read01 round 57) — one PG `aclitem`: what `grantee` may do to a
1971/// table, and who granted it. Renders as `grantee=privs/grantor`, with an
1972/// EMPTY grantee meaning PUBLIC (`=r/owner`).
1973#[derive(Debug, Clone, PartialEq, Eq)]
1974pub struct AclItem {
1975 /// The role the privileges are held by. Empty string = PUBLIC.
1976 pub grantee: String,
1977 /// Bitmask over `priv_bits`: which privileges are held.
1978 pub privs: u16,
1979 /// Bitmask over `priv_bits`: which of them carry WITH GRANT OPTION
1980 /// (PG renders those with a trailing `*` — `r*`).
1981 pub grantable: u16,
1982 /// The role that ran the GRANT.
1983 pub grantor: String,
1984}
1985
1986/// v7.39 (read01 round 57) — the table-privilege bits, in PG's `aclitem`
1987/// rendering order (`arwdDxtm`). The order matters: `relacl` output is
1988/// byte-compared against PG.
1989pub mod priv_bits {
1990 pub const INSERT: u16 = 1 << 0; // a
1991 pub const SELECT: u16 = 1 << 1; // r
1992 pub const UPDATE: u16 = 1 << 2; // w
1993 pub const DELETE: u16 = 1 << 3; // d
1994 pub const TRUNCATE: u16 = 1 << 4; // D
1995 pub const REFERENCES: u16 = 1 << 5; // x
1996 pub const TRIGGER: u16 = 1 << 6; // t
1997 pub const MAINTAIN: u16 = 1 << 7; // m
1998 /// v7.39 (read01 round 60) — the non-table privileges. They share the
1999 /// bitmask because an aclitem is an aclitem whatever it hangs off; which
2000 /// bits are MEANINGFUL depends on the object (a sequence has r / w / U, a
2001 /// schema has U / C, a database has C / c / T).
2002 pub const USAGE: u16 = 1 << 8; // U
2003 pub const CREATE: u16 = 1 << 9; // C
2004 pub const CONNECT: u16 = 1 << 10; // c
2005 pub const TEMPORARY: u16 = 1 << 11; // T
2006 pub const EXECUTE: u16 = 1 << 12; // X
2007 /// Every TABLE privilege — what `GRANT ALL ON <table>` grants and what a
2008 /// table's owner holds.
2009 pub const ALL: u16 =
2010 INSERT | SELECT | UPDATE | DELETE | TRUNCATE | REFERENCES | TRIGGER | MAINTAIN;
2011 /// `GRANT ALL ON SEQUENCE` — PG renders a sequence owner's default as `rwU`.
2012 pub const ALL_SEQUENCE: u16 = SELECT | UPDATE | USAGE;
2013 /// `GRANT ALL ON SCHEMA` — `UC`.
2014 pub const ALL_SCHEMA: u16 = USAGE | CREATE;
2015 /// `GRANT ALL ON DATABASE` — `CTc`.
2016 pub const ALL_DATABASE: u16 = CREATE | CONNECT | TEMPORARY;
2017 /// `GRANT ALL ON FUNCTION` — just `X`.
2018 pub const ALL_FUNCTION: u16 = EXECUTE;
2019}
2020
2021/// v7.37.6-B — partition 三态(parent / range child / default child)。
2022#[derive(Debug, Clone, PartialEq, Eq)]
2023pub enum PartitionRole {
2024 Parent {
2025 kind: PartitionKind,
2026 /// 父表 columns 中 key 列的下标(单列 v7.37.6-B,
2027 /// `Vec` 为将来扩多列预留)。
2028 key_column_positions: Vec<usize>,
2029 /// `CREATE INDEX ON parent (…)` 的 Display-form 源串。
2030 /// child 创建时再 parse + 在 child 上 execute,这样 future
2031 /// child 也自动继承父表索引。fan-out 实施在引擎层。
2032 index_template_sources: Vec<String>,
2033 },
2034 Range {
2035 parent_name: String,
2036 /// 半开区间下界(`>=`,SQL `FROM (lower)`).
2037 lower: PartitionBound,
2038 /// 半开区间上界(`<`,SQL `TO (upper)`).
2039 upper: PartitionBound,
2040 },
2041 /// v7.37.16 (16.1) — LIST child:行属于本 child iff key ∈ values。
2042 /// `values` 在 child 创建时从 SQL `FOR VALUES IN (lit, …)` 求值;
2043 /// 跟 PG 一样,显式 NULL ∈ values 由 caller 单独处理(不在
2044 /// PartitionBound 内表达 NULL)。
2045 List {
2046 parent_name: String,
2047 values: Vec<PartitionBound>,
2048 },
2049 /// v7.39 (round 645) — PG 表继承的 CHILD:`CREATE TABLE c (…)
2050 /// INHERITS (p1, p2)`。跟分区 child 的三个本质区别(实测 PG18):
2051 /// * 父表**自己有行**(分区父表永远空),所以父表的联合体要含自身;
2052 /// * `INSERT INTO 父表` **不路由**到 child(分区会路由);
2053 /// * `DROP TABLE 父表` 不带 CASCADE **报错**(分区父表连子表一起删)。
2054 /// 多父继承合法,故 `parent_names` 是 Vec;`pg_inherits.inhseqno`
2055 /// 正是父表在这个列表里的位置(1-based)。
2056 Inherits {
2057 parent_names: Vec<String>,
2058 },
2059 /// v7.37.16 (16.2) — HASH child:行属于本 child iff
2060 /// `pg_compatible_hash(key) mod modulus == remainder`。
2061 /// PG 强制 `0 ≤ remainder < modulus`;parser/DDL 层先 gate。
2062 Hash {
2063 parent_name: String,
2064 modulus: u32,
2065 remainder: u32,
2066 },
2067 Default {
2068 parent_name: String,
2069 },
2070}
2071
2072/// v7.37.6-B — 分区策略。
2073///
2074/// - `Range`:半开区间 `[lower, upper)`(v7.37.6-B 初始)
2075/// - `List` (v7.37.16):枚举集合 — 行属于 partition iff key ∈ children list
2076/// - `Hash` (v7.37.16):`hash(key) mod modulus == remainder`
2077#[derive(Debug, Clone, Copy, PartialEq, Eq)]
2078pub enum PartitionKind {
2079 Range,
2080 List,
2081 Hash,
2082}
2083
2084/// v7.37.6-B — partition 边界 literal。
2085///
2086/// v7.37.6-B 仅 `TimestampTz`(i64 microseconds since epoch);
2087/// v7.37.16 (16.6) 加全 PG 内建可比类型,匹配 `Value` 的对应 variant
2088/// 以避免 LIST membership 比较时的类型转换。
2089///
2090/// `MinValue` / `MaxValue` 对应 SQL `MINVALUE` / `MAXVALUE`,仅
2091/// Range 策略有意义(LIST 无 minvalue/maxvalue 概念,HASH 不
2092/// 使用 PartitionBound)。
2093#[derive(Debug, Clone, PartialEq, Eq)]
2094pub enum PartitionBound {
2095 MinValue,
2096 MaxValue,
2097 TimestampTz(i64),
2098 /// v7.37.16 (16.6) — BIGINT partition key.
2099 BigInt(i64),
2100 /// v7.37.16 (16.6) — INTEGER partition key (also covers
2101 /// `SERIAL` since SPG decomposes it to INTEGER + sequence).
2102 Int(i32),
2103 /// v7.37.16 (16.6) — SMALLINT partition key.
2104 SmallInt(i16),
2105 /// v7.37.16 (16.6) — DATE partition key. Stored as days
2106 /// since the Unix epoch (matches `Value::Date`).
2107 Date(i32),
2108 /// v7.37.16 (16.6) — TEXT / VARCHAR partition key.
2109 Text(alloc::string::String),
2110}
2111
2112impl PartitionBound {
2113 /// v7.37.16 (16.6) — true iff this bound's underlying value
2114 /// equals `other`'s. Used for LIST partition membership
2115 /// checks. Returns false for `MinValue` / `MaxValue`
2116 /// (sentinels — never literal equality).
2117 #[must_use]
2118 pub fn equals_value(&self, other: &Value<'_>) -> bool {
2119 match (self, other) {
2120 (PartitionBound::TimestampTz(a), Value::Timestamp(b)) => a == b,
2121 (PartitionBound::BigInt(a), Value::BigInt(b)) => a == b,
2122 (PartitionBound::Int(a), Value::Int(b)) => a == b,
2123 (PartitionBound::SmallInt(a), Value::SmallInt(b)) => a == b,
2124 (PartitionBound::Date(a), Value::Date(b)) => a == b,
2125 (PartitionBound::Text(a), Value::Text(b)) => a.as_str() == b.as_ref(),
2126 _ => false,
2127 }
2128 }
2129}
2130
2131/// v7.9.19 — composite UNIQUE / PRIMARY KEY constraint persisted
2132/// on the table schema. The leading column always has a BTree
2133/// index (created at CREATE TABLE time); INSERT enforcement
2134/// scans that index for collisions on the full column tuple.
2135/// v7.39 (read01 round 48) — a `CHECK` constraint: the SQL name the user
2136/// gave it (via `ADD CONSTRAINT <name> CHECK (...)` or the inline
2137/// `CONSTRAINT <name> CHECK (...)` form) plus the predicate source. `None`
2138/// name = unnamed, in which case `pg_constraint` synthesises PG's
2139/// `<table>_<col>_check` form. Names are persisted in the constraint-name
2140/// appendix (FILE_VERSION 60+); older catalogs deserialise with `None`.
2141#[derive(Debug, Clone, PartialEq, Eq)]
2142pub struct CheckConstraint {
2143 pub name: Option<String>,
2144 /// The AST Expr's `Display` form, re-parsed on every INSERT/UPDATE.
2145 pub expr: String,
2146 /// v7.39 (round 652) — `false` for a constraint added `NOT VALID`: the
2147 /// rows already in the table were never scanned against it, and
2148 /// `pg_constraint.convalidated` says so. It does NOT weaken the check on
2149 /// new rows — INSERT and UPDATE enforce it either way, as in PG.
2150 /// `VALIDATE CONSTRAINT` does the deferred scan and flips it. Persisted
2151 /// by the FILE_VERSION 87 appendix; older catalogs deserialise as `true`,
2152 /// which is what every constraint they could hold actually was.
2153 pub validated: bool,
2154}
2155
2156#[derive(Debug, Clone, PartialEq, Eq)]
2157pub struct UniquenessConstraint {
2158 /// `true` when this constraint was declared as `PRIMARY KEY`
2159 /// (vs `UNIQUE`). Semantically PK implies NOT NULL on all
2160 /// referenced columns; the engine enforces that at CREATE
2161 /// TABLE time.
2162 pub is_primary_key: bool,
2163 /// Column positions on the parent table. ≥ 1 element. For
2164 /// single-column UNIQUE this is exactly one position; the
2165 /// BTree index alone enforces it.
2166 pub columns: Vec<usize>,
2167 /// v7.13.0 — `UNIQUE NULLS NOT DISTINCT` modifier
2168 /// (mailrs round-5 G10; PG 15+ surface). When `true`, two
2169 /// rows whose constrained columns are all NULL collide on
2170 /// the constraint. Default (`false`) is the SQL-standard
2171 /// `NULLS DISTINCT` behaviour where any NULL passes.
2172 /// Persisted in catalog FILE_VERSION 23+.
2173 pub nulls_not_distinct: bool,
2174 /// v7.39 (read01 round 48) — the constraint's SQL name when the user
2175 /// supplied one (`ADD CONSTRAINT <name> PRIMARY KEY/UNIQUE (...)`, or
2176 /// the inline `CONSTRAINT <name>` form). `None` = unnamed, in which
2177 /// case `pg_constraint` synthesises PG's `<table>_pkey` /
2178 /// `<table>_<col>_key` form. DROP CONSTRAINT resolves the stored name
2179 /// first and falls back to the synthesised one, so catalogs written
2180 /// before this field (< FILE_VERSION 60) keep working unchanged.
2181 pub name: Option<String>,
2182 /// v7.39 (round 711) — `[NOT] DEFERRABLE`. Round 621 taught the parser
2183 /// to CONSUME the clause on PK/UNIQUE (the FK path had stored it since
2184 /// round 288); this is the storing half. Persisted in the v89 timing
2185 /// appendix.
2186 pub deferrable: bool,
2187 /// `INITIALLY DEFERRED`: the check belongs to COMMIT, not the
2188 /// statement, unless `SET CONSTRAINTS … IMMEDIATE` pulls it in.
2189 pub initially_deferred: bool,
2190}
2191
2192/// v7.39 (round 210) — an `EXCLUDE` constraint. Forbids two distinct live
2193/// rows from satisfying, for EVERY element, `new.col <op> existing.col`
2194/// (e.g. `EXCLUDE USING gist (during WITH &&)` = no two `during` ranges
2195/// overlap). Unlike a uniqueness constraint the operator is not equality,
2196/// so enforcement is a full live-row scan re-checking the operator (a real
2197/// GiST index that answers overlap in O(log n) is a later perf phase). A
2198/// NULL in any element column exempts the row (matching PG / UNIQUE NULL
2199/// semantics). Persisted in catalog FILE_VERSION 72+.
2200#[derive(Debug, Clone, PartialEq, Eq)]
2201pub struct ExclusionConstraint {
2202 /// The constraint's SQL name. PG auto-names an unnamed EXCLUDE
2203 /// `<table>_<leading-col>_excl`; the engine synthesises that at CREATE
2204 /// TABLE time so this is always populated.
2205 pub name: String,
2206 /// Access method spelled after `USING` (`gist`, `spgist`, …), lower-cased.
2207 /// `None` = no `USING` clause. Purely cosmetic for enforcement; it round-
2208 /// trips into `pg_get_constraintdef`.
2209 pub method: Option<String>,
2210 /// One `(column-position, operator-spelling)` pair per element, in
2211 /// declaration order. The operator spelling is the wire token (`&&`,
2212 /// `=`, `@>`, `<@`, `&<`, `&>`) evaluated against each existing row.
2213 pub elements: Vec<(usize, String)>,
2214}
2215
2216/// v7.6.1 — Storage-layer mirror of `spg_sql::ast::ForeignKeyConstraint`.
2217/// The engine's CREATE TABLE path translates between the two; keeping
2218/// them separate preserves the no-deps boundary between
2219/// `spg-storage` and `spg-sql`.
2220#[derive(Debug, Clone, PartialEq, Eq)]
2221pub struct ForeignKeyConstraint {
2222 /// Optional user-supplied constraint name (`CONSTRAINT <name>`
2223 /// prefix). Used by `ALTER TABLE DROP CONSTRAINT <name>` in
2224 /// v7.6.8; ignored by enforcement.
2225 pub name: Option<String>,
2226 /// Positions of local columns in this table's column list.
2227 /// Same arity as `parent_columns`.
2228 pub local_columns: Vec<usize>,
2229 /// Referenced parent table name.
2230 pub parent_table: String,
2231 /// Positions of parent columns in the parent's column list.
2232 /// Engine resolves these at CREATE TABLE time (after the parent
2233 /// schema is known) so enforcement paths can skip the name
2234 /// lookup on every row.
2235 pub parent_columns: Vec<usize>,
2236 /// Referential action when a parent row is deleted.
2237 pub on_delete: FkAction,
2238 /// Referential action when a parent row's referenced columns
2239 /// are updated.
2240 pub on_update: FkAction,
2241 /// v7.38 (read01, T29) — `MATCH SIMPLE | FULL`. Defaults to `Simple`.
2242 pub match_type: MatchType,
2243 /// v7.39 (round 288) — `[NOT] DEFERRABLE`.
2244 pub deferrable: bool,
2245 /// `INITIALLY DEFERRED`: the check runs at COMMIT rather than at
2246 /// the statement, unless `SET CONSTRAINTS … IMMEDIATE` pulls it in.
2247 pub initially_deferred: bool,
2248}
2249
2250/// v7.38 (read01, T29) — FK MATCH type. Mirrors `spg_sql::ast::MatchType`.
2251#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
2252pub enum MatchType {
2253 #[default]
2254 Simple,
2255 Full,
2256}
2257
2258impl MatchType {
2259 /// On-disk tag byte (catalog appendix, `FILE_VERSION` 55+).
2260 pub const fn tag(self) -> u8 {
2261 match self {
2262 Self::Simple => 0,
2263 Self::Full => 1,
2264 }
2265 }
2266 pub const fn from_tag(b: u8) -> Option<Self> {
2267 Some(match b {
2268 0 => Self::Simple,
2269 1 => Self::Full,
2270 _ => return None,
2271 })
2272 }
2273}
2274
2275/// v7.6.1 — referential action tag. Mirrors `spg_sql::ast::FkAction`.
2276#[derive(Debug, Clone, Copy, PartialEq, Eq)]
2277pub enum FkAction {
2278 Restrict,
2279 Cascade,
2280 SetNull,
2281 SetDefault,
2282 NoAction,
2283}
2284
2285impl FkAction {
2286 /// On-disk tag byte (v13 catalog appendix).
2287 pub const fn tag(self) -> u8 {
2288 match self {
2289 Self::Restrict => 0,
2290 Self::Cascade => 1,
2291 Self::SetNull => 2,
2292 Self::SetDefault => 3,
2293 Self::NoAction => 4,
2294 }
2295 }
2296 pub const fn from_tag(b: u8) -> Option<Self> {
2297 Some(match b {
2298 0 => Self::Restrict,
2299 1 => Self::Cascade,
2300 2 => Self::SetNull,
2301 3 => Self::SetDefault,
2302 4 => Self::NoAction,
2303 _ => return None,
2304 })
2305 }
2306}
2307
2308impl TableSchema {
2309 pub fn column_position(&self, name: &str) -> Option<usize> {
2310 self.columns.iter().position(|c| c.name == name)
2311 }
2312}
2313
2314/// Key type accepted by secondary indices. Float / NULL / Vector values
2315/// can't participate in a B-tree index — `f64` is only `PartialOrd`, NULL
2316/// has SQL-three-valued semantics, and Vector belongs to the (future) HNSW
2317/// path. Index lookups on those columns fall back to full scan.
2318#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
2319pub enum IndexKey {
2320 Int(i64),
2321 Text(String),
2322 Bool(bool),
2323 /// v7.17.0 — `Value::Uuid` index key. Comparison is byte-wise
2324 /// (RFC 4122 byte order) so PRIMARY KEY UUID lookups land on
2325 /// the same fast-path as Int / Text.
2326 Uuid([u8; 16]),
2327 /// r1039 — `Value::Bytes` (bytea). PG orders bytea by plain byte
2328 /// comparison, shorter-prefix first (`'' < \x00 < \x0000 < \x01ff <
2329 /// \xff`, measured on 18.4), which is exactly `Vec<u8>`'s `Ord`.
2330 Bytes(Vec<u8>),
2331 /// r1039 — exact decimal, in the canonical form described on
2332 /// [`NumericKey`].
2333 ///
2334 /// r1040 — BOXED, and the box is load-bearing for every OTHER index.
2335 /// A `NumericKey` is 48 bytes against `Text(String)`'s 24, so inline
2336 /// it set the size of the whole enum and every B-tree node in every
2337 /// index grew with it: 32 bytes per key to 48, align 8 to 16.
2338 /// Measured through the release sweep, `SELECT pad FROM t ORDER BY
2339 /// id` over 400,000 rows — a walk of the primary key's index — went
2340 /// 39.4-40.6 ms to 42.3-44.1, in both leg orders. The indirection is
2341 /// charged to numeric keys, which are new, instead of to every index
2342 /// that existed already.
2343 Numeric(alloc::boxed::Box<NumericKey>),
2344 /// v7.38.1 (L12) — a NULL component INSIDE a composite key, and
2345 /// nothing else. `IndexKey::from_value(Value::Null)` still returns
2346 /// `None`, so single-column B-trees never hold one, and no probe
2347 /// path ever BUILDS one (`col = NULL` is not a match in SQL) — the
2348 /// variant is only reachable through a composite key's component
2349 /// list, where it exists so that a row like `(2, 3, NULL)` stays
2350 /// findable by a PREFIX probe on `(w, d)`. Declared last: slice
2351 /// `Ord` then sorts NULL components after every value, PG's
2352 /// NULLS LAST.
2353 Null,
2354}
2355
2356/// r1039 — an exact-decimal index key, canonical so that representation
2357/// equality IS value equality.
2358///
2359/// That property is the whole reason this is a struct rather than the
2360/// `(scaled, scale)` pair the value carries. `1.5` and `1.50` are the
2361/// same NUMERIC (PG18.4: `1.5::numeric = 1.50::numeric` is true) and
2362/// arrive here as `(15, 1)` and `(150, 2)`. A B-tree keyed on the raw
2363/// pair would file them apart, so `WHERE n = 1.5` would miss a row stored
2364/// as `1.50` — an index changing the answer, which is the one thing an
2365/// index may never do. `BigNumeric::cmp` carries the same warning and
2366/// declines to implement `Ord` for exactly this reason; a KEY cannot
2367/// decline, so it normalizes instead.
2368///
2369/// Canonical form: significant decimal digits with no leading and no
2370/// trailing zeros, most significant first, plus the decimal exponent of
2371/// the leading digit. Zero is the empty digit vector with `neg == false`
2372/// and `exp == 0`, so there is no `-0`.
2373///
2374/// Ordering is PG's, measured: `-Infinity < -1 < 0 < 1 < Infinity < NaN`,
2375/// and `NaN = NaN`.
2376#[derive(Debug, Clone, PartialEq, Eq)]
2377pub struct NumericKey {
2378 /// 0 = -Infinity, 1 = finite, 2 = +Infinity, 3 = NaN. Ordering the
2379 /// classes by this byte is what puts NaN on top, where PG keeps it.
2380 class: u8,
2381 /// Finite only, and never set for zero.
2382 neg: bool,
2383 /// Decimal exponent of the leading significant digit; 0 for zero.
2384 exp: i32,
2385 /// r1040 — the first [`HEAD_DIGITS`] significant digits, LEFT-ALIGNED
2386 /// (multiplied up so the leading digit always sits at 10^36). That
2387 /// alignment is what makes an integer comparison of two heads the same
2388 /// answer as a digit-by-digit one: `12` and `1` become 1.2e36 and
2389 /// 1.0e36, which order the way the digit strings do, where the bare
2390 /// integers 12 and 1 would not.
2391 ///
2392 /// Zero for the value zero and for every special.
2393 ///
2394 /// This started as a `Vec<u8>` of digits, which is correct and cost
2395 /// an allocation per key and a slice comparison per sort comparison.
2396 /// `ORDER BY <numeric>` builds one key per row and compares n log n
2397 /// times: 200,000 rows measured 65.4 ms against 39.6 for the f64
2398 /// projection that had been returning rows in the wrong order.
2399 head: u128,
2400 /// Significant digits past the 37th, one per byte, no trailing zeros.
2401 /// Empty for everything an `i128` mantissa can hold with room to
2402 /// spare — and an empty `Vec` does not allocate, which is the point.
2403 tail: Vec<u8>,
2404}
2405
2406/// Significant digits carried in [`NumericKey::head`]. 37 is the most
2407/// that can be left-aligned inside a `u128`: the largest such value is
2408/// 9.99…e36, and `u128::MAX` is 3.4e38.
2409const HEAD_DIGITS: u32 = 37;
2410/// `10^36` — where a left-aligned leading digit sits.
2411const HEAD_SCALE: u128 = 1_000_000_000_000_000_000_000_000_000_000_000_000;
2412
2413/// The `class` byte of [`NumericKey`], in PG's order.
2414const NUM_CLASS_NEG_INF: u8 = 0;
2415const NUM_CLASS_FINITE: u8 = 1;
2416const NUM_CLASS_POS_INF: u8 = 2;
2417const NUM_CLASS_NAN: u8 = 3;
2418
2419impl NumericKey {
2420 /// The key for a `Value::Numeric`'s three fields.
2421 ///
2422 /// Public because the ORDER BY key wants the same canonical form the
2423 /// index key uses: two sort keys that disagree about which of two
2424 /// NUMERICs is larger is the same class of defect as an index that
2425 /// disagrees with a scan, and one definition is how they stay honest.
2426 #[must_use]
2427 pub fn from_numeric(scaled: i128, scale: u16, kind: NumericKind) -> Self {
2428 match kind {
2429 NumericKind::Finite => {
2430 let mut buf = [0u8; 40];
2431 let n = digits_of_u128(scaled.unsigned_abs(), &mut buf);
2432 Self::finite(scaled < 0, &buf[..n], i32::from(scale))
2433 }
2434 NumericKind::NaN => Self::special(NUM_CLASS_NAN),
2435 NumericKind::PosInf => Self::special(NUM_CLASS_POS_INF),
2436 NumericKind::NegInf => Self::special(NUM_CLASS_NEG_INF),
2437 }
2438 }
2439
2440 /// The key for an exact integer — no scale, so no rounding.
2441 #[must_use]
2442 pub fn from_i128(n: i128) -> Self {
2443 let mut buf = [0u8; 40];
2444 let len = digits_of_u128(n.unsigned_abs(), &mut buf);
2445 Self::finite(n < 0, &buf[..len], 0)
2446 }
2447
2448 /// The key for a mantissa that overflowed `i128`. The two
2449 /// representations of one value land on one key.
2450 #[must_use]
2451 pub fn from_big(b: &crate::bignum::BigNumeric) -> Self {
2452 let (neg, limbs, scale) = b.parts();
2453 Self::finite(neg, &digits_of_limbs(limbs), i32::from(scale))
2454 }
2455
2456 /// The `f64` this key means, for the one comparison PG defines that
2457 /// way: `numeric` against `float8` demotes the numeric.
2458 ///
2459 /// Lossy by construction — that is the point, and it is why nothing
2460 /// else uses it.
2461 #[must_use]
2462 #[allow(clippy::cast_precision_loss)]
2463 pub fn to_f64(&self) -> f64 {
2464 match self.class {
2465 NUM_CLASS_NAN => return f64::NAN,
2466 NUM_CLASS_POS_INF => return f64::INFINITY,
2467 NUM_CLASS_NEG_INF => return f64::NEG_INFINITY,
2468 _ => {}
2469 }
2470 if self.head == 0 {
2471 return 0.0;
2472 }
2473 // `head` is `d.ddd… × 10^36`; the value is that leading digit and
2474 // its followers at `exp`. The tail is below f64's resolution by
2475 // construction (it starts at the 38th significant digit).
2476 let mantissa = self.head as f64 / HEAD_SCALE as f64;
2477 let out = mantissa * pow10_f64(self.exp);
2478 if self.neg { -out } else { out }
2479 }
2480
2481 /// The significant decimal digits, most significant first — the form
2482 /// the catalog codec writes, and the one `from_parts` reads back.
2483 #[must_use]
2484 pub fn digits(&self) -> Vec<u8> {
2485 let mut out = Vec::new();
2486 if self.head != 0 {
2487 let mut h = self.head;
2488 for _ in 0..HEAD_DIGITS {
2489 let d = u8::try_from(h / HEAD_SCALE).unwrap_or(0);
2490 out.push(d);
2491 h = (h % HEAD_SCALE) * 10;
2492 }
2493 while out.last() == Some(&0) {
2494 out.pop();
2495 }
2496 }
2497 out.extend_from_slice(&self.tail);
2498 out
2499 }
2500
2501 /// The wire parts, for the catalog codec.
2502 #[must_use]
2503 pub fn parts(&self) -> (u8, bool, i32) {
2504 (self.class, self.neg, self.exp)
2505 }
2506
2507 /// Rebuild from the wire parts. Returns `None` on parts that are not
2508 /// canonical, so a corrupt catalog cannot smuggle in a key whose `Eq`
2509 /// and `Ord` disagree.
2510 #[must_use]
2511 pub fn from_parts(class: u8, neg: bool, exp: i32, digits: &[u8]) -> Option<Self> {
2512 if class > NUM_CLASS_NAN || digits.iter().any(|d| *d > 9) {
2513 return None;
2514 }
2515 if class != NUM_CLASS_FINITE && (neg || exp != 0 || !digits.is_empty()) {
2516 return None;
2517 }
2518 if digits.is_empty() {
2519 if neg || exp != 0 {
2520 return None;
2521 }
2522 return Some(Self::special(class));
2523 }
2524 if digits[0] == 0 || digits[digits.len() - 1] == 0 {
2525 return None;
2526 }
2527 Some(Self {
2528 class,
2529 neg,
2530 exp,
2531 head: head_of(digits),
2532 tail: digits.iter().skip(HEAD_DIGITS as usize).copied().collect(),
2533 })
2534 }
2535
2536 /// Canonicalize `(-1)^neg · <digits as an integer> · 10^-scale`.
2537 ///
2538 /// `digits` is most-significant-first and may carry leading and
2539 /// trailing zeros; both are stripped, which is what makes `1.5` and
2540 /// `1.50` land on the same key.
2541 fn finite(neg: bool, digits: &[u8], scale: i32) -> Self {
2542 let lead = digits.iter().position(|d| *d != 0).unwrap_or(digits.len());
2543 let digits = &digits[lead..];
2544 if digits.is_empty() {
2545 return Self::special(NUM_CLASS_FINITE);
2546 }
2547 // The leading digit's exponent, taken BEFORE trailing zeros go:
2548 // dropping low-order digits does not move the leading one.
2549 let exp = i32::try_from(digits.len()).unwrap_or(i32::MAX) - 1 - scale;
2550 let mut end = digits.len();
2551 while end > 0 && digits[end - 1] == 0 {
2552 end -= 1;
2553 }
2554 let digits = &digits[..end];
2555 Self {
2556 class: NUM_CLASS_FINITE,
2557 neg,
2558 exp,
2559 head: head_of(digits),
2560 tail: digits.iter().skip(HEAD_DIGITS as usize).copied().collect(),
2561 }
2562 }
2563
2564 fn special(class: u8) -> Self {
2565 Self {
2566 class,
2567 neg: false,
2568 exp: 0,
2569 head: 0,
2570 tail: Vec::new(),
2571 }
2572 }
2573}
2574
2575/// The first [`HEAD_DIGITS`] of `digits`, left-aligned so the leading one
2576/// sits at `10^36`.
2577fn head_of(digits: &[u8]) -> u128 {
2578 let mut head: u128 = 0;
2579 let take = (HEAD_DIGITS as usize).min(digits.len());
2580 for d in &digits[..take] {
2581 head = head * 10 + u128::from(*d);
2582 }
2583 for _ in take..HEAD_DIGITS as usize {
2584 head *= 10;
2585 }
2586 head
2587}
2588
2589/// Decimal digits of `mag` into `buf`, most significant first; returns how
2590/// many were written. Zero writes none.
2591///
2592/// r1040 — split at `u64` on purpose. A `u128` divide is a called routine,
2593/// not an instruction, and this loop runs once per digit per key.
2594fn digits_of_u128(mag: u128, buf: &mut [u8; 40]) -> usize {
2595 if mag == 0 {
2596 return 0;
2597 }
2598 let mut rev = [0u8; 40];
2599 let mut n = 0usize;
2600 let mut big = mag;
2601 // Peel nineteen digits at a time — the most a `u64` holds — so the
2602 // wide divide runs at most twice.
2603 while big > u128::from(u64::MAX) {
2604 let mut chunk = u64::try_from(big % 10_000_000_000_000_000_000_u128).unwrap_or(0);
2605 big /= 10_000_000_000_000_000_000_u128;
2606 for _ in 0..19 {
2607 rev[n] = u8::try_from(chunk % 10).unwrap_or(0);
2608 chunk /= 10;
2609 n += 1;
2610 }
2611 }
2612 let mut small = u64::try_from(big).unwrap_or(0);
2613 while small > 0 {
2614 rev[n] = u8::try_from(small % 10).unwrap_or(0);
2615 small /= 10;
2616 n += 1;
2617 }
2618 for i in 0..n {
2619 buf[i] = rev[n - 1 - i];
2620 }
2621 n
2622}
2623
2624/// Decimal digits of a base-10^9 little-endian limb vector, most
2625/// significant first. Every limb but the leading one is padded to its
2626/// full nine digits — that padding is the whole point, since a limb of 5
2627/// in the middle of a number means `000000005`.
2628fn digits_of_limbs(limbs: &[u32]) -> Vec<u8> {
2629 let mut out = Vec::new();
2630 let mut buf = [0u8; 40];
2631 for (i, limb) in limbs.iter().enumerate().rev() {
2632 let n = digits_of_u128(u128::from(*limb), &mut buf);
2633 if i + 1 == limbs.len() {
2634 out.extend_from_slice(&buf[..n]);
2635 } else {
2636 out.extend(core::iter::repeat_n(0u8, 9 - n));
2637 out.extend_from_slice(&buf[..n]);
2638 }
2639 }
2640 out
2641}
2642
2643/// `10^e` as an `f64`, for any `e` a canonical key can carry.
2644#[allow(clippy::cast_precision_loss)]
2645fn pow10_f64(e: i32) -> f64 {
2646 let mut out = 1.0_f64;
2647 let mag = e.unsigned_abs();
2648 for _ in 0..mag {
2649 out *= 10.0;
2650 }
2651 if e < 0 { 1.0 / out } else { out }
2652}
2653
2654impl Ord for NumericKey {
2655 fn cmp(&self, other: &Self) -> core::cmp::Ordering {
2656 use core::cmp::Ordering;
2657 if self.class != other.class {
2658 return self.class.cmp(&other.class);
2659 }
2660 if self.class != NUM_CLASS_FINITE {
2661 // Each of the three specials is a single value, and PG holds
2662 // `'NaN'::numeric = 'NaN'::numeric` true.
2663 return Ordering::Equal;
2664 }
2665 // Zero first: it is stored with `neg == false` and `exp == 0`, so
2666 // the magnitude comparison below would put it above every value
2667 // smaller than 1 rather than between the negatives and positives.
2668 match (self.head == 0, other.head == 0) {
2669 (true, true) => return Ordering::Equal,
2670 (true, false) => {
2671 return if other.neg {
2672 Ordering::Greater
2673 } else {
2674 Ordering::Less
2675 };
2676 }
2677 (false, true) => {
2678 return if self.neg {
2679 Ordering::Less
2680 } else {
2681 Ordering::Greater
2682 };
2683 }
2684 (false, false) => {}
2685 }
2686 match (self.neg, other.neg) {
2687 (false, true) => return Ordering::Greater,
2688 (true, false) => return Ordering::Less,
2689 _ => {}
2690 }
2691 // Same sign, both non-zero: more integer digits is bigger, and at
2692 // equal exponent the left-aligned heads compare as one integer —
2693 // the alignment is what makes that the same answer as comparing
2694 // the digit strings. The tail only speaks when the first 37
2695 // significant digits are identical.
2696 let mag = self
2697 .exp
2698 .cmp(&other.exp)
2699 .then_with(|| self.head.cmp(&other.head))
2700 .then_with(|| self.tail.cmp(&other.tail));
2701 if self.neg { mag.reverse() } else { mag }
2702 }
2703}
2704
2705impl PartialOrd for NumericKey {
2706 fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
2707 Some(self.cmp(other))
2708 }
2709}
2710
2711impl IndexKey {
2712 /// v7.37.43 (INSUBQ B-4) — inline-friendly BigInt fast path.
2713 /// `try_count_star_pk_in_subquery_fast` (and any other hot loop
2714 /// probing an integer PK) already holds an `i64`; this builds the
2715 /// `IndexKey` without going through the generic `from_value`
2716 /// dispatch tree.
2717 #[inline]
2718 pub fn from_i64(n: i64) -> Self {
2719 Self::Int(n)
2720 }
2721
2722 /// r1039 — the key a value takes when the INDEXED COLUMN is `ty`, or
2723 /// `None` when it takes none (→ the caller falls back to a scan).
2724 ///
2725 /// Every key under one index comes from one column, so they all live
2726 /// in one key SPACE. A probe built in a different space finds nothing
2727 /// — and "nothing" is indistinguishable from "no matching rows",
2728 /// which is how round 564 and r1037 both turned an index into a wrong
2729 /// answer (a TEXT key sought against a DATE-keyed and a UUID-keyed
2730 /// index).
2731 ///
2732 /// The two spaces this round adds make that trap reachable again from
2733 /// a new direction: `WHERE n = 2` on a NUMERIC column produces
2734 /// `Value::Int`, and an integer key would look in a space nothing
2735 /// lives in. So NUMERIC columns take integers by converting them
2736 /// exactly, and refuse anything they cannot convert; BYTEA columns
2737 /// take only `Value::Bytes`; and no other column may be keyed in
2738 /// either of the two new spaces.
2739 ///
2740 /// Use this wherever the key comes from a LITERAL or from another
2741 /// table's value. [`IndexKey::from_value`] stays right for building
2742 /// the index itself, where the value is the column's own.
2743 pub fn from_value_for_column(v: &Value<'_>, ty: DataType) -> Option<Self> {
2744 match ty {
2745 DataType::Numeric { .. } => match v {
2746 Value::SmallInt(n) => Some(Self::exact_int_key(i128::from(*n))),
2747 Value::Int(n) => Some(Self::exact_int_key(i128::from(*n))),
2748 Value::BigInt(n) => Some(Self::exact_int_key(i128::from(*n))),
2749 Value::Numeric { .. } | Value::NumericBig(_) => Self::from_value(v),
2750 // Float included: `2.0::float8` and `2.0::numeric` are not
2751 // the same value to a B-tree, and rounding one into the
2752 // other's space is how a seek reaches the wrong row.
2753 _ => None,
2754 },
2755 DataType::Bytes => match v {
2756 Value::Bytes(b) => Some(Self::Bytes(b.to_vec())),
2757 _ => None,
2758 },
2759 _ => match Self::from_value(v) {
2760 Some(Self::Numeric(_) | Self::Bytes(_)) => None,
2761 other => other,
2762 },
2763 }
2764 }
2765
2766 /// An integer as a NUMERIC key. Exact by construction — no scale, no
2767 /// rounding — which is why the conversion is allowed at all.
2768 fn exact_int_key(n: i128) -> Self {
2769 Self::Numeric(alloc::boxed::Box::new(NumericKey::from_i128(n)))
2770 }
2771
2772 pub fn from_value(v: &Value<'_>) -> Option<Self> {
2773 match v {
2774 // v7.37.43 (INSUBQ B-4) — BigInt hits first (the dominant
2775 // INSUBQ shape probes PK as BigInt). Tiny micro-win.
2776 Value::BigInt(n) => Some(Self::Int(*n)),
2777 Value::SmallInt(n) => Some(Self::Int(i64::from(*n))),
2778 Value::Int(n) => Some(Self::Int(i64::from(*n))),
2779 Value::Text(s) => Some(Self::Text(s.clone().into_owned())),
2780 // v7.38 (read01, T11) — bpchar keys compare blank-insensitively.
2781 Value::BpChar(s) => Some(Self::Text(s.trim_end_matches(' ').to_string())),
2782 Value::Bool(b) => Some(Self::Bool(*b)),
2783 // Date/Timestamp use their integer storage repr as the
2784 // index key — same order semantics, same comparison.
2785 Value::Date(d) => Some(Self::Int(i64::from(*d))),
2786 Value::Timestamp(t) => Some(Self::Int(*t)),
2787 // v7.17.0: UUID indexable via byte-wise ordering. Lookup
2788 // on `id = '...'::uuid` resolves through the secondary
2789 // index rather than full-scan.
2790 Value::Uuid(b) => Some(Self::Uuid(*b)),
2791 // v7.17.0 Phase 3.P0-32: TIME indexable via i64 — same
2792 // order semantics as Date/Timestamp.
2793 Value::Time(us) => Some(Self::Int(*us)),
2794 // v7.17.0 Phase 3.P0-33: YEAR indexable as i64 — u16
2795 // widens losslessly and gives the natural calendar
2796 // ordering.
2797 Value::Year(y) => Some(Self::Int(i64::from(*y))),
2798 // v7.17.0 Phase 3.P0-34: TIMETZ indexable by its
2799 // UTC-equivalent microseconds (local wall - offset).
2800 // Without normalising, two values for the same
2801 // physical instant in different zones would sort
2802 // wrong. Matches PG's TIMETZ index behaviour.
2803 Value::TimeTz { us, offset_secs } => {
2804 Some(Self::Int(us - i64::from(*offset_secs) * 1_000_000))
2805 }
2806 // v7.17.0 Phase 3.P0-35: MONEY indexable as i64 cents
2807 // (no scaling needed — natural numeric ordering).
2808 Value::Money(c) => Some(Self::Int(*c)),
2809 // v7.17.0 Phase 3.P0-38: ranges are NOT indexable in
2810 // v7.17.0 — they'd need a custom comparator (PG uses
2811 // SP-GiST for this). Skip.
2812 Value::Range { .. } => None,
2813 // v7.17.0 Phase 3.P0-39: hstore is NOT indexable in
2814 // v7.17.0 — map columns need GIN with bespoke ops.
2815 Value::Hstore(_) => None,
2816 // r1039 — exact decimals index through the canonical
2817 // [`NumericKey`], which is what makes `1.5` and `1.50` one key.
2818 Value::NumericBig(b) => Some(Self::Numeric(alloc::boxed::Box::new(NumericKey::from_big(b)))),
2819 Value::Numeric {
2820 scaled,
2821 scale,
2822 kind,
2823 } => Some(Self::Numeric(alloc::boxed::Box::new(
2824 NumericKey::from_numeric(*scaled, *scale, *kind),
2825 ))),
2826 // r1039 — bytea orders by plain byte comparison, which is
2827 // `Vec<u8>`'s own.
2828 Value::Bytes(b) => Some(Self::Bytes(b.to_vec())),
2829 // v7.17.0 Phase 3.P0-40: 2D arrays aren't indexable.
2830 Value::IntArray2D(_)
2831 | Value::BigIntArray2D(_)
2832 | Value::TextArray2D(_)
2833 | Value::BoolArray2D(_) => None,
2834 // v7.37.5 β-P4: INTERVAL[] isn't indexable (PG uses
2835 // GIN/intarray for array-contains queries; SPG plans
2836 // that as a separate axis under v7.37.8 GIN-on-jsonb).
2837 Value::IntervalArray(_) => None,
2838 // v7.37.5 γ — none of the array-of-scalar family is
2839 // B-tree indexable. Same reason as IntervalArray: PG
2840 // serves array-contains / array-overlap queries via
2841 // GIN, and SPG's GIN axis lands in v7.37.8.
2842 Value::BoolArray(_)
2843 | Value::SmallIntArray(_)
2844 | Value::FloatArray(_)
2845 | Value::NumericArray(_)
2846 | Value::DateArray(_)
2847 | Value::TimestampArray(_)
2848 | Value::TimestamptzArray(_)
2849 | Value::UuidArray(_)
2850 | Value::JsonArray(_)
2851 | Value::JsonbArray(_)
2852 | Value::BytesArray(_)
2853 | Value::VarcharArray(_)
2854 | Value::CharArray(_)
2855 // v7.37.5 δ — multirange not indexable (PG uses GiST/
2856 // SP-GiST + a custom operator class; SPG plans the same
2857 // axis under v7.37.8 with ranges).
2858 | Value::Multirange { .. }
2859 // v7.37.5 ε — geometric scalars not B-tree indexable
2860 // (PG uses GiST/SP-GiST for these too; SPG plans the
2861 // same axis under v7.37.8).
2862 | Value::Point(_)
2863 | Value::Lseg(_, _)
2864 | Value::Path { .. }
2865 | Value::PgBox(_, _)
2866 | Value::Polygon(_)
2867 | Value::Line { .. }
2868 | Value::Circle { .. }
2869 // v7.37.5 ζ-A — network / bit / xml / "char" / money[].
2870 // INET / CIDR / MACADDR / MACADDR8 could be B-tree
2871 // indexable (PG does this), but the byte-wise compare
2872 // family-blind would mis-order IPv4 vs IPv6; left as
2873 // a follow-up under v7.37.8 GIN window.
2874 | Value::Inet { .. }
2875 | Value::Cidr { .. }
2876 | Value::Macaddr(_)
2877 | Value::Macaddr8(_)
2878 | Value::PgLsn(_)
2879 | Value::BitString { .. }
2880 | Value::Xml(_)
2881 | Value::Char1(_)
2882 | Value::MoneyArray(_)
2883 | Value::Composite(_)
2884 | Value::Tid(..)
2885 | Value::Xid(_)
2886 | Value::Cid(_)
2887 | Value::RegClass(..)
2888 | Value::RegProc(..)
2889 | Value::RegType(..) => None,
2890 // Interval isn't index-eligible (and can't reach this path
2891 // through column storage anyway). Float / Real stay out
2892 // because `f64` is only `PartialOrd`.
2893 Value::Null
2894 | Value::Float(_)
2895 | Value::Vector(_)
2896 | Value::Sq8Vector(_)
2897 | Value::HalfVector(_)
2898 | Value::Interval { .. }
2899 | Value::Json(_)
2900 | Value::TextArray(_)
2901 | Value::IntArray(_)
2902 | Value::BigIntArray(_)
2903 | Value::TsVector(_)
2904 | Value::TsQuery(_)
2905 | Value::Real(_) => None,
2906 }
2907 }
2908}
2909
2910/// A single-column secondary index. v2.0 carries either a B-tree map
2911/// (the default — used for equality / range lookups on scalar columns)
2912/// or a navigable-small-world graph (used for kNN over vector
2913/// columns).
2914#[derive(Debug, Clone)]
2915pub struct Index {
2916 pub name: String,
2917 pub column_position: usize,
2918 pub kind: IndexKind,
2919 /// v6.8.0 — column positions of `INCLUDE (col1, col2, …)`
2920 /// non-key columns. Carries the planner's "this query is
2921 /// covered by the index" signal; lookup paths still resolve
2922 /// via the `RowLocator` to fetch the row body, but EXPLAIN
2923 /// surfaces the covered-scan annotation so operators can
2924 /// confirm the planner sees the coverage.
2925 ///
2926 /// Empty `Vec` = no `INCLUDE` clause (the legacy shape). v12
2927 /// catalog snapshots deserialise with an empty vec.
2928 pub included_columns: Vec<usize>,
2929 /// v6.8.1 — partial-index predicate stored as its canonical
2930 /// Display form (the engine re-parses it on the maintenance
2931 /// path). `None` = unconditional index (the legacy shape).
2932 /// Persisted as `[u8 has_pred][u16 LE len][bytes]` on the
2933 /// catalog snapshot (FILE_VERSION 12, appended after
2934 /// `included_columns`).
2935 pub partial_predicate: Option<String>,
2936 /// v6.8.2 — expression-index key, stored as the expression's
2937 /// canonical Display form. `None` = bare column-reference
2938 /// index (the legacy shape). Persisted alongside
2939 /// `partial_predicate` on the v12 catalog snapshot.
2940 pub expression: Option<String>,
2941 /// v7.39 (read01 round 52) — `CREATE UNIQUE INDEX … NULLS NOT DISTINCT`
2942 /// (PG 15+): a NULL in the key no longer exempts the row, so two
2943 /// all-NULL keys collide. Default `false` = SQL-standard NULLS DISTINCT.
2944 /// Persisted in the index appendix (FILE_VERSION 62+); older catalogs
2945 /// deserialise with `false`.
2946 pub nulls_not_distinct: bool,
2947 /// v7.39 (round 537) — the key column's ordering clause, as written.
2948 ///
2949 /// SPG's index does not scan in a direction, so this changes no
2950 /// lookup; `pg_indexes.indexdef` is a reproduction of the DDL and
2951 /// dropping the clause made `CREATE INDEX i ON t (a DESC NULLS
2952 /// LAST)` read back as `(a)` — a dump lost it and a schema diff saw
2953 /// drift every run. `nulls_first` is `None` when the statement did
2954 /// not say, in which case PG's default applies and neither word is
2955 /// rendered.
2956 pub descending: bool,
2957 pub nulls_first: Option<bool>,
2958 /// v7.39 (round 538) — an explicit `COLLATE` on the key, as written.
2959 /// SPG orders text by bytes, so it changes no comparison; PG prints
2960 /// it because a named collation and an inherited one are different
2961 /// objects even where they sort identically.
2962 pub collation: Option<String>,
2963 /// v7.9.29 — `CREATE UNIQUE INDEX …`. When true the engine
2964 /// rejects INSERTs whose key already appears in this index
2965 /// (combined with `partial_predicate` when present — only
2966 /// rows matching the predicate enter the uniqueness check).
2967 /// Catalog FILE_VERSION 16+; older snapshots deserialise
2968 /// with `false`. mailrs K1.
2969 pub is_unique: bool,
2970 /// v7.9.29 — extra (non-leading) column positions for
2971 /// multi-column indexes (`CREATE INDEX … (a, b, c)`). The
2972 /// planner today still only uses the leading
2973 /// `column_position` for index seeks, but UNIQUE INDEX
2974 /// enforcement walks the full tuple so partial-unique
2975 /// invariants like CalDAV `(calendar_id, uid,
2976 /// recurrence_id)` are enforced correctly. Catalog
2977 /// FILE_VERSION 16+; older snapshots deserialise empty.
2978 pub extra_column_positions: Vec<usize>,
2979}
2980
2981/// Default neighbor degree (M) for the NSW graph. Picked at construction
2982/// time and persisted with the index.
2983pub const NSW_DEFAULT_M: usize = 16;
2984
2985/// v5.2.2: outcome of a successful [`Catalog::freeze_oldest_to_cold`]
2986/// call. The catalog state has already been mutated by the time this
2987/// is returned (hot rows dropped + segment registered + Cold locators
2988/// flipped). The caller's only remaining concern is `segment_bytes` —
2989/// persist them to disk under `<db>.spg/segments/seg_<id>.spg` so a
2990/// future restart can reload via the v5.1 `SPG_PRELOAD_COLD_SEGMENT`
2991/// path. (v5.3's manifest will subsume this manual step.)
2992#[derive(Debug, Clone)]
2993pub struct FreezeReport {
2994 /// Id allocated by [`Catalog::load_segment_bytes`] for the new
2995 /// cold-tier segment. Stable across the call's success path.
2996 pub segment_id: u32,
2997 /// Number of rows that moved hot → cold. Equals the `max_rows`
2998 /// the caller asked for (the API is strict on the count).
2999 pub frozen_rows: usize,
3000 /// Hot-tier bytes reclaimed by the freeze — the
3001 /// [`Table::hot_bytes`] delta before vs after. Useful to feed
3002 /// back into the freezer's budget check on the next tick.
3003 pub bytes_freed: u64,
3004 /// Encoded segment bytes, byte-identical to what
3005 /// [`encode_segment`] produced. The catalog already owns a
3006 /// copy inside `cold_segments`; this hand-off lets the caller
3007 /// persist them without re-encoding.
3008 pub segment_bytes: Vec<u8>,
3009}
3010
3011/// v6.7.4 — read-only output of [`Catalog::prepare_freeze_slice`].
3012/// Carries every row body + key in a contiguous hot-row range,
3013/// already encoded and sorted by PK so the coordinator's merge
3014/// step is a k-way merge over already-sorted streams.
3015///
3016/// `Vec<FreezeSlice>` from N independent workers feeds
3017/// [`Catalog::commit_freeze_slices`], which concats + encodes the
3018/// merged segment + atomically swaps the catalog state.
3019#[derive(Debug, Clone)]
3020pub struct FreezeSlice {
3021 /// Hot-row index range this slice covered (half-open, in the
3022 /// table's `rows: PersistentVec` ordering at call time). The
3023 /// commit step uses this to compute the union range that
3024 /// gets passed to [`Table::delete_rows`].
3025 pub row_range: core::ops::Range<usize>,
3026 /// `(pk_u64, encoded_row_body, IndexKey)` triples, sorted
3027 /// ascending by `pk_u64`. Per-slice sort happens inside
3028 /// `prepare_freeze_slice`; the coordinator does only a
3029 /// k-way merge to reach the global PK ordering
3030 /// [`encode_segment`] requires.
3031 pub rows: Vec<(u64, Vec<u8>, IndexKey)>,
3032}
3033
3034/// v6.7.3 — outcome of a [`Catalog::compact_cold_segments`] call.
3035/// The catalog state has already been mutated when this is returned:
3036/// the merged segment is loaded into `cold_segments`, the source
3037/// segment slots are tombstoned (`None`), and every BTree-index
3038/// `RowLocator::Cold` that previously pointed at a source now
3039/// points at the merged segment. The caller's remaining job is to
3040/// persist `merged_segment_bytes` under
3041/// `<db>.spg/segments/seg_<merged_segment_id>.spg` and update the
3042/// in-memory `segment_id → path` map (remove the source ids, add
3043/// the merged id) so the next CHECKPOINT writes a manifest that
3044/// no longer lists the retired sources.
3045///
3046/// On a no-op (fewer than 2 candidate segments under the threshold),
3047/// `merged_segment_id` is `None` and `sources` is empty; the
3048/// catalog was not mutated.
3049#[derive(Debug, Clone)]
3050pub struct CompactReport {
3051 /// Source segment ids that were merged + tombstoned.
3052 pub sources: Vec<u32>,
3053 /// Id allocated for the merged segment. `None` on no-op.
3054 pub merged_segment_id: Option<u32>,
3055 /// Encoded merged-segment bytes (empty on no-op).
3056 pub merged_segment_bytes: Vec<u8>,
3057 /// Number of rows that landed in the merged segment.
3058 pub merged_rows: usize,
3059 /// `Σ source.num_rows − merged_rows`. Rows present in source
3060 /// segment payloads but unreferenced by any live BTree
3061 /// `Cold` locator — DELETE'd-but-still-frozen rows that
3062 /// compaction GC'd during the merge.
3063 pub deleted_rows_pruned: usize,
3064 /// `Σ source.bytes() − merged.bytes()`. Estimate of on-disk
3065 /// space the merge will reclaim once the source segment files
3066 /// are GC'd. Saturating subtract — never negative.
3067 pub bytes_reclaimed_estimate: u64,
3068}
3069
3070#[derive(Debug, Clone)]
3071pub enum IndexKind {
3072 /// v4.40: structural-sharing B-tree over `IndexKey`. Replaces the v0.8
3073 /// `BTreeMap<IndexKey, Vec<usize>>` — `Index::clone` is now an `Arc`
3074 /// bump regardless of index size, so `Catalog::clone` inside the
3075 /// v4.34 auto-commit wrap stays O(1) even for tables with secondary
3076 /// indices (the case that bottlenecked v4.39 at 1M rows in the
3077 /// sweep).
3078 ///
3079 /// v5.1: value type widened from `Vec<usize>` to `Vec<RowLocator>` so
3080 /// a single key can point to a mix of hot-tier rows (`RowLocator::Hot`,
3081 /// equivalent to the pre-v5 `usize` row index) and cold-tier rows
3082 /// (`RowLocator::Cold { segment_id, page_offset }`) once the v5.2
3083 /// freezer starts producing them. Pre-v5.2 only `Hot` entries appear
3084 /// — the on-disk encoding stays at `FILE_VERSION` 8 (raw u64 row index)
3085 /// because every locator round-trips through `RowLocator::from_legacy_v8_u64`
3086 /// without information loss. `FILE_VERSION` 9 with tagged encoding lands
3087 /// alongside the first freezer commit (v5.1 step 2b / v5.2).
3088 BTree(PersistentBTreeMap<IndexKey, crate::posting::PostingList>),
3089 /// Navigable-small-world graph for vector kNN search.
3090 Nsw(NswGraph),
3091 /// v6.7.1 — BRIN (Block Range INdex). Pure metadata: BRIN
3092 /// indexes carry NO in-memory key→locator map. The (min,
3093 /// max) summaries live in each cold-tier segment's v2
3094 /// envelope sidecar; the BRIN entry in `Table.indices` only
3095 /// records THAT a BRIN index exists on this column so the
3096 /// segment encoder + planner can opt into the summary path.
3097 Brin {
3098 /// The cell type at `column_position` at CREATE INDEX time.
3099 /// Used by the planner to type-check WHERE-clause range
3100 /// predicates against the BRIN-indexed column.
3101 column_type: DataType,
3102 /// v7.38.11 — one `(min, max)` per [`BRIN_RANGE_ROWS`] slots of
3103 /// the hot tier, so a range predicate can skip the ranges that
3104 /// cannot contain a match.
3105 ///
3106 /// Maintenance is WIDEN-ONLY and that is the whole safety
3107 /// argument: an insert widens its range, an update widens, and
3108 /// a delete leaves the range alone. A range left wider than the
3109 /// rows it now covers is correct and merely less selective —
3110 /// which is exactly PG's contract for a lossy index, since the
3111 /// predicate is re-checked on every row the summary lets
3112 /// through. A summary may over-report; it can never
3113 /// under-report, so no matching row can be skipped.
3114 ///
3115 /// `None` for a range whose rows carry no comparable key (all
3116 /// NULL, say), and such a range is never skipped.
3117 summaries: alloc::vec::Vec<Option<(i64, i64)>>,
3118 },
3119 /// v7.12.3 — GIN inverted index over a `tsvector` column.
3120 ///
3121 /// Storage shape: `lexeme word → Vec<RowLocator>`. The posting
3122 /// list per word is appended in row-order, so range scans are
3123 /// O(matching rows) once the per-word lookup is done. Multi-
3124 /// term queries intersect / union posting lists.
3125 ///
3126 /// `IndexKey::from_value(TsVector)` returns `None` — GIN doesn't
3127 /// participate in `try_index_seek` (which is BTree-equality-keyed).
3128 /// The engine consults this index through `try_gin_lookup` on
3129 /// `WHERE col @@ tsquery` predicates instead.
3130 ///
3131 /// Backed by a `PersistentBTreeMap` so `Catalog::clone` (the
3132 /// per-write snapshot) stays O(1) — same structural-sharing
3133 /// invariant as BTree.
3134 Gin(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3135 /// v7.15.0 — `USING gin (col gin_trgm_ops)` over a `TEXT`
3136 /// column. Posting lists map `trigram` (PG-compatible 3-byte
3137 /// shingle on the lower-cased + space-padded input) to row
3138 /// locators. The planner uses this index to accelerate
3139 /// `WHERE col LIKE '…'` / `ILIKE '…'` / `similarity(col, q) >
3140 /// t` — every literal run of length ≥ 1 in the pattern
3141 /// produces a trigram set, the engine intersects the posting
3142 /// lists, and the LIKE / similarity predicate is re-evaluated
3143 /// per candidate row to filter the over-approximation.
3144 /// Persisted via tag-4 index payload in `FILE_VERSION` 24+.
3145 GinTrgm(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3146 /// v7.17.0 Phase 2.2 — MySQL `FULLTEXT KEY (col)` over a
3147 /// `TEXT` / `VARCHAR` column. Posting lists map
3148 /// `tsvector('simple') lexeme` to row locators. At insert /
3149 /// build time the engine derives the lexemes from the cell
3150 /// via the same lower-case tokenisation rule as
3151 /// `to_tsvector('simple', ...)` — the column itself stays a
3152 /// plain text type on disk (mysqldump round-trips would be
3153 /// broken otherwise). The planner uses this index to
3154 /// accelerate MySQL-shape `MATCH(col) AGAINST('term')`
3155 /// queries by mapping them onto the existing tsquery `@@`
3156 /// walker. Persisted via tag-5 index payload in
3157 /// `FILE_VERSION` 33+.
3158 GinFulltext(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3159 /// v7.37.8(sentori Epic 5 P2)— `USING gin (col)` over a
3160 /// `JSON` / `JSONB` column. Posting lists map a canonical
3161 /// `(path, leaf)` token(see [`crate::jsonb_gin::extract_tokens`])
3162 /// to row locators so the planner can resolve
3163 /// `<col> @> <jsonb_literal>` to a candidate row set via
3164 /// posting-list intersection + per-row `json::contains`
3165 /// re-verification. Pre-7.37.8 the same DDL loaded as a
3166 /// BTree fallback so `pg_dump` JSONB-GIN scripts kept loading
3167 /// without query-time acceleration. Persisted via tag-6 index
3168 /// payload in `FILE_VERSION` 51+.
3169 GinJsonb(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3170 /// v7.38.1 (L12) — a REAL multi-column B-tree: the key is the whole
3171 /// column tuple, `[leading, extras…]`, ordered lexicographically by
3172 /// slice `Ord`. That ordering is the entire design: every key
3173 /// sharing a prefix is contiguous, so an equality on a PREFIX of
3174 /// the columns is one `O(log N)` descent plus a bounded walk, and a
3175 /// full-tuple equality is a point `get`. The single-column `BTree`
3176 /// kind used to stand in for multi-column DDL by keying on the
3177 /// leading column only and carrying the rest as metadata — TPC-C's
3178 /// `customer (c_w_id, c_d_id, c_last, c_first)` then answered a
3179 /// three-column equality with every row of one warehouse and a
3180 /// per-row filter over 30 000 candidates.
3181 ///
3182 /// Rows where any component column is NULL (or of an unkeyable
3183 /// type) are NOT entered: this index serves `=` probes, and in SQL
3184 /// `col = v` never selects a NULL. Uniqueness keeps its own
3185 /// full-tuple walk with NULLS-DISTINCT semantics on the
3186 /// enforcement path, exactly as before.
3187 ///
3188 /// Persisted via tag-7 index payload in `FILE_VERSION` 91+.
3189 BTreeMulti(PersistentBTreeMap<alloc::boxed::Box<[IndexKey]>, crate::posting::PostingList>),
3190}
3191
3192impl IndexKind {
3193 /// v7.31 (memory campaign, C2) — bytes this index variant holds
3194 /// resident in RAM, computed by walking its OWN structure rather
3195 /// than a parametric guess made by the engine. Replaces the old
3196 /// `spg_admin::memory_stats` inline match, which charged NSW with
3197 /// a stale `m_max_0 * 8` per node (neighbour slots are `u32` = 4 B
3198 /// since v6.1.x, and most nodes never fill `m_max_0`) and lumped
3199 /// every GIN family index into a flat 1 KiB token — a gross
3200 /// undercount for the text-heavy posting lists that dominate
3201 /// mailrs' footprint. Per-entry container overhead uses the
3202 /// 3-word (24 B on 64-bit) `Vec`/`String` header as the charge.
3203 ///
3204 /// O(index entries): operator/monitoring surface (`memory_stats` /
3205 /// `spg_memory_stats`), not a query path.
3206 #[must_use]
3207 pub fn approx_resident_bytes(&self) -> u64 {
3208 const HEADER: usize = 24; // Vec/String 3-word header on 64-bit.
3209 let loc = core::mem::size_of::<RowLocator>();
3210 match self {
3211 IndexKind::BTree(map) => {
3212 let key = core::mem::size_of::<IndexKey>();
3213 map.iter()
3214 .map(|(_, locs)| (key + HEADER + locs.len() * loc) as u64)
3215 .sum()
3216 }
3217 // v7.38.1 (L12) — multi keys own a boxed slice of components.
3218 IndexKind::BTreeMulti(map) => {
3219 let key = core::mem::size_of::<IndexKey>();
3220 map.iter()
3221 .map(|(k, locs)| (HEADER + k.len() * key + HEADER + locs.len() * loc) as u64)
3222 .sum()
3223 }
3224 IndexKind::Nsw(g) => {
3225 // `levels` is one byte per node; each layer's adjacency
3226 // is a `Vec<u32>` per node whose actual length we walk
3227 // (the dense layer-0 list dominates, but upper layers
3228 // are sparse — the old estimate ignored that).
3229 let mut b = g.levels.len() as u64;
3230 for layer in &g.layers {
3231 for nbrs in layer.iter() {
3232 b += (HEADER + nbrs.len() * core::mem::size_of::<u32>()) as u64;
3233 }
3234 }
3235 b
3236 }
3237 // BRIN carries NO in-memory key→locator map (the (min,max)
3238 // summaries live in cold-segment sidecars on disk); the
3239 // resident footprint is just the column-type token.
3240 IndexKind::Brin { .. } => core::mem::size_of::<DataType>() as u64,
3241 IndexKind::Gin(map)
3242 | IndexKind::GinTrgm(map)
3243 | IndexKind::GinFulltext(map)
3244 | IndexKind::GinJsonb(map) => map
3245 .iter()
3246 .map(|(word, postings)| {
3247 (word.len() + HEADER + HEADER + postings.len() * loc) as u64
3248 })
3249 .sum(),
3250 }
3251 }
3252}
3253
3254/// Multi-layer HNSW graph (v2.13). Each node is assigned a `top_level`;
3255/// it appears in layers `0..=top_level`. Higher layers are sparser, so
3256/// search starts from the entry at the top layer, greedy-descends to
3257/// layer 0, and beam-searches there. Layer 0 keeps a larger neighbour
3258/// budget (`m_max_0 = 2 * m` per the HNSW paper); upper layers cap at
3259/// `m`. The struct name stays `NswGraph` so external users / on-disk
3260/// callers don't have to track a rename — the algorithm changed, the
3261/// data slot didn't.
3262#[derive(Debug, Clone)]
3263pub struct NswGraph {
3264 /// Max neighbours per node on layers ≥ 1.
3265 pub m: usize,
3266 /// Max neighbours on layer 0 (the dense bottom layer). HNSW
3267 /// convention: `m_max_0 = 2 * m`.
3268 pub m_max_0: usize,
3269 /// Entry point — the node that sits on the topmost layer. Search
3270 /// always starts here.
3271 pub entry: Option<usize>,
3272 /// Top layer of the entry node (== `layers.len() - 1` when populated).
3273 pub entry_level: u8,
3274 /// `levels[i]` = top layer of node `i`. Nodes whose vector cell is
3275 /// NULL / non-Vector have `levels[i] = 0` and no neighbour entries.
3276 ///
3277 /// v5.5.0: backed by `PersistentVec` so `NswGraph::clone` (and the
3278 /// `Catalog::clone` on every group-commit write that contains it) is O(1)
3279 /// structural-sharing instead of an O(N) element copy.
3280 pub levels: PersistentVec<u8>,
3281 /// `layers[l][i]` = neighbours of node `i` at layer `l`. Inner vec
3282 /// is empty when node `i` doesn't reach layer `l`.
3283 ///
3284 /// v5.5.0: the per-node middle dimension (the O(N) one) is a
3285 /// `PersistentVec`; the outer layer dimension stays a plain `Vec`
3286 /// (layer count ≤ 8, so its clone is O(1) in practice) and the inner
3287 /// neighbour list stays a `Vec` (bounded by `m_max_0`).
3288 ///
3289 /// v6.1.x: neighbour slot widened from `usize` (8 B on 64-bit) to
3290 /// `u32` (4 B). Row indices are catalog-bounded by `u32::MAX` (4G
3291 /// rows per table); the cast at the NSW boundary asserts this. At
3292 /// 1M dim-128 SQ8, layer 0 adjacency alone shrinks by ~128 MiB
3293 /// — the largest single contribution to the v6.0.5-measured
3294 /// 624 MiB ambition gap. On-disk format already used u32 LE, so
3295 /// this is a pure in-memory layout change; no `FILE_VERSION` bump.
3296 pub layers: Vec<PersistentVec<Vec<u32>>>,
3297}
3298
3299impl NswGraph {
3300 fn new(m: usize) -> Self {
3301 Self {
3302 m,
3303 m_max_0: m.saturating_mul(2),
3304 entry: None,
3305 entry_level: 0,
3306 levels: PersistentVec::new(),
3307 layers: alloc::vec![PersistentVec::new()],
3308 }
3309 }
3310
3311 /// Max-neighbour budget for layer `l`.
3312 pub const fn cap_for_layer(&self, layer: u8) -> usize {
3313 if layer == 0 { self.m_max_0 } else { self.m }
3314 }
3315}
3316
3317/// Deterministic level assignment, seeded on the row index so the same
3318/// insert order reproduces the same topology. Distribution is roughly
3319/// HNSW-flavoured with `mL ≈ 1/ln(M) ≈ 0.36` for M=16: each 4-bit
3320/// chunk that comes up zero promotes the node one layer (so P(level ≥
3321/// L) ≈ (1/16)^L).
3322#[allow(clippy::verbose_bit_mask)] // clippy suggests trailing_zeros(); we need an explicit MAX cap and a stable distribution shape.
3323pub fn nsw_assign_level(row_idx: usize) -> u8 {
3324 const MAX_LEVEL: u8 = 7; // 7 ⇒ ~16^7 ≈ 2.7e8 expected nodes between promotions; ample.
3325 // SplitMix-style mixer — cheap and seedable.
3326 let mut x = (row_idx as u64).wrapping_mul(0x9E37_79B9_7F4A_7C15);
3327 x ^= x >> 30;
3328 x = x.wrapping_mul(0xBF58_476D_1CE4_E5B9);
3329 x ^= x >> 27;
3330 x = x.wrapping_mul(0x94D0_49BB_1331_11EB);
3331 x ^= x >> 31;
3332 // Count contiguous low-end zero nibbles (4-bit chunks). Each zero
3333 // nibble has probability 1/16, mirroring HNSW's `mL ≈ 1/ln(M)` for
3334 // M=16. `trailing_zeros / 4` would lose the ordering when x = 0, so
3335 // a plain loop with a cap is clearer.
3336 let mut level: u8 = 0;
3337 while x & 0xF == 0 && level < MAX_LEVEL {
3338 level += 1;
3339 x >>= 4;
3340 }
3341 level
3342}
3343
3344/// v7.38.1 (L12) — the composite key `values` takes in a multi-column
3345/// B-tree over `[lead, extras…]`. A NULL component keys as
3346/// [`IndexKey::Null`] (declared to sort last, PG's NULLS LAST) so the
3347/// row stays findable by prefix probes on the columns before it. `None`
3348/// = some non-null component has no key form; the row is then not
3349/// entered, which is why creation gates every component column's type
3350/// through [`multi_component_type_ok`].
3351pub(crate) fn compose_multi_key(
3352 values: &[Value<'_>],
3353 lead: usize,
3354 extras: &[usize],
3355) -> Option<alloc::boxed::Box<[IndexKey]>> {
3356 let mut comps: Vec<IndexKey> = Vec::with_capacity(1 + extras.len());
3357 for pos in core::iter::once(lead).chain(extras.iter().copied()) {
3358 let v = values.get(pos)?;
3359 if matches!(v, Value::Null) {
3360 comps.push(IndexKey::Null);
3361 } else {
3362 comps.push(IndexKey::from_value(v)?);
3363 }
3364 }
3365 Some(comps.into_boxed_slice())
3366}
3367
3368/// v7.38.1 (L12) — component-type gate for multi-column B-trees: every
3369/// NON-NULL value of these types keys through `IndexKey::from_value`,
3370/// so a row can only be absent from the index when creation raced a
3371/// type this list does not name. Deliberately conservative — a type
3372/// outside the list simply keeps its index on the leading-column path.
3373pub(crate) fn multi_component_type_ok(ty: DataType) -> bool {
3374 matches!(
3375 ty,
3376 DataType::SmallInt
3377 | DataType::Int
3378 | DataType::BigInt
3379 | DataType::Text
3380 | DataType::Varchar(_)
3381 | DataType::Char(_)
3382 | DataType::Bool
3383 | DataType::Uuid
3384 | DataType::Date
3385 | DataType::Timestamp
3386 )
3387}
3388
3389impl Index {
3390 /// Any key this B-tree currently holds, or `None` if it holds none.
3391 ///
3392 /// A probe built from a query literal has to be the same SHAPE as the
3393 /// keys the maintenance side made, or `lookup_eq` misses every row and
3394 /// the caller reads the empty answer as "no rows match". One stored
3395 /// key settles it: an index keys one expression, whose values are one
3396 /// type.
3397 pub fn sample_key(&self) -> Option<&IndexKey> {
3398 match &self.kind {
3399 IndexKind::BTree(map) => map.iter().next().map(|(k, _)| k),
3400 _ => None,
3401 }
3402 }
3403
3404 fn new_btree(name: String, column_position: usize) -> Self {
3405 Self {
3406 name,
3407 column_position,
3408 kind: IndexKind::BTree(PersistentBTreeMap::new()),
3409 included_columns: Vec::new(),
3410 partial_predicate: None,
3411 expression: None,
3412 is_unique: false,
3413 nulls_not_distinct: false,
3414 descending: false,
3415 nulls_first: None,
3416 collation: None,
3417 extra_column_positions: Vec::new(),
3418 }
3419 }
3420
3421 /// v7.38.1 (L12) — a real multi-column B-tree shell. The caller
3422 /// sets `extra_column_positions` before the first row enters; the
3423 /// key arity is `1 + extras` from then on.
3424 fn new_btree_multi(name: String, column_position: usize) -> Self {
3425 Self {
3426 kind: IndexKind::BTreeMulti(PersistentBTreeMap::new()),
3427 ..Self::new_btree(name, column_position)
3428 }
3429 }
3430
3431 /// v7.38.1 (L12) — the composite key this row takes in a
3432 /// [`IndexKind::BTreeMulti`] index. NULL components key as
3433 /// [`IndexKey::Null`] so prefix probes still find the row; `None`
3434 /// only when a non-null component produces no key, which creation's
3435 /// component-type gate makes unreachable for well-formed indexes.
3436 pub fn multi_key_for_row(&self, values: &[Value<'_>]) -> Option<alloc::boxed::Box<[IndexKey]>> {
3437 compose_multi_key(values, self.column_position, &self.extra_column_positions)
3438 }
3439
3440 fn new_nsw(name: String, column_position: usize, m: usize) -> Self {
3441 Self {
3442 name,
3443 column_position,
3444 kind: IndexKind::Nsw(NswGraph::new(m)),
3445 included_columns: Vec::new(),
3446 partial_predicate: None,
3447 expression: None,
3448 is_unique: false,
3449 nulls_not_distinct: false,
3450 descending: false,
3451 nulls_first: None,
3452 collation: None,
3453 extra_column_positions: Vec::new(),
3454 }
3455 }
3456
3457 /// v6.7.1 — BRIN index constructor. BRIN carries no in-memory
3458 /// data; the `column_type` snapshot is used by the segment
3459 /// encoder + planner for type-checking range predicates.
3460 fn new_brin(name: String, column_position: usize, column_type: DataType) -> Self {
3461 Self {
3462 name,
3463 column_position,
3464 kind: IndexKind::Brin {
3465 column_type,
3466 summaries: alloc::vec::Vec::new(),
3467 },
3468 included_columns: Vec::new(),
3469 partial_predicate: None,
3470 expression: None,
3471 is_unique: false,
3472 nulls_not_distinct: false,
3473 descending: false,
3474 nulls_first: None,
3475 collation: None,
3476 extra_column_positions: Vec::new(),
3477 }
3478 }
3479
3480 /// v7.12.3 — GIN inverted-index constructor. Empty posting-list
3481 /// map; caller (typically [`Table::add_gin_index`] or
3482 /// [`Table::restore_gin_index`]) populates it from existing rows
3483 /// or from a deserialised snapshot.
3484 fn new_gin(name: String, column_position: usize) -> Self {
3485 Self {
3486 name,
3487 column_position,
3488 kind: IndexKind::Gin(PersistentBTreeMap::new()),
3489 included_columns: Vec::new(),
3490 partial_predicate: None,
3491 expression: None,
3492 is_unique: false,
3493 nulls_not_distinct: false,
3494 descending: false,
3495 nulls_first: None,
3496 collation: None,
3497 extra_column_positions: Vec::new(),
3498 }
3499 }
3500
3501 /// v7.15.0 — `gin_trgm_ops`-flavoured GIN constructor. Same
3502 /// shape as `new_gin` but the posting-list keys are 3-byte
3503 /// trigram shingles (`pg_trgm`-compatible) and the column
3504 /// type is `TEXT` / `VARCHAR` (not `TSVECTOR`).
3505 fn new_gin_trgm(name: String, column_position: usize) -> Self {
3506 Self {
3507 name,
3508 column_position,
3509 kind: IndexKind::GinTrgm(PersistentBTreeMap::new()),
3510 included_columns: Vec::new(),
3511 partial_predicate: None,
3512 expression: None,
3513 is_unique: false,
3514 nulls_not_distinct: false,
3515 descending: false,
3516 nulls_first: None,
3517 collation: None,
3518 extra_column_positions: Vec::new(),
3519 }
3520 }
3521
3522 /// v7.17.0 Phase 2.2 — MySQL `FULLTEXT KEY` GIN constructor.
3523 /// Same shape as `new_gin_trgm` but the posting-list keys
3524 /// are lower-cased word lexemes (`to_tsvector('simple', col)`
3525 /// equivalent) instead of trigrams, and the column type is
3526 /// `TEXT` / `VARCHAR` (not `TSVECTOR`).
3527 fn new_gin_fulltext(name: String, column_position: usize) -> Self {
3528 Self {
3529 name,
3530 column_position,
3531 kind: IndexKind::GinFulltext(PersistentBTreeMap::new()),
3532 included_columns: Vec::new(),
3533 partial_predicate: None,
3534 expression: None,
3535 is_unique: false,
3536 nulls_not_distinct: false,
3537 descending: false,
3538 nulls_first: None,
3539 collation: None,
3540 extra_column_positions: Vec::new(),
3541 }
3542 }
3543
3544 /// v7.37.8(sentori Epic 5 P2)— JSONB-GIN constructor. Same
3545 /// shape as the other GIN-family indexes; posting-list keys
3546 /// are the canonical `(path, leaf)` tokens emitted by
3547 /// `crate::jsonb_gin::extract_tokens`. Maintains posting
3548 /// lists from `Value::Json` cells(JSONB is a synonym for the
3549 /// same in-memory string-backed Value).
3550 fn new_gin_jsonb(name: String, column_position: usize) -> Self {
3551 Self {
3552 name,
3553 column_position,
3554 kind: IndexKind::GinJsonb(PersistentBTreeMap::new()),
3555 included_columns: Vec::new(),
3556 partial_predicate: None,
3557 expression: None,
3558 is_unique: false,
3559 nulls_not_distinct: false,
3560 descending: false,
3561 nulls_first: None,
3562 collation: None,
3563 extra_column_positions: Vec::new(),
3564 }
3565 }
3566
3567 /// v7.34.4 — descending-order iterator over `(IndexKey, locators)`
3568 /// pairs for a BTree index, with O(log N) descent to the rightmost
3569 /// leaf and lazy emission thereafter. Returns an empty iterator
3570 /// for non-BTree index kinds — callers handle both uniformly.
3571 /// Used by the ORDER BY `<indexed col>` DESC + LIMIT N executor
3572 /// path: walking only the first N matches off the rightmost leaf
3573 /// avoids the per-row materialisation + partial-sort cost on
3574 /// large tables (mailrs `content_worker` at 250 k rows).
3575 pub fn iter_desc(
3576 &self,
3577 ) -> alloc::boxed::Box<dyn Iterator<Item = (&IndexKey, &crate::posting::PostingList)> + '_>
3578 {
3579 match &self.kind {
3580 IndexKind::BTree(m) => alloc::boxed::Box::new(m.iter_rev()),
3581 // v7.38.1 (L12) — projecting the leading component of a
3582 // composite key preserves order: keys sort by the whole
3583 // tuple, so the leading component is non-increasing here
3584 // (non-decreasing in iter_asc), exactly what an ORDER BY
3585 // on the leading column needs.
3586 IndexKind::BTreeMulti(m) => {
3587 alloc::boxed::Box::new(m.iter_rev().map(|(k, l)| (&k[0], l)))
3588 }
3589 IndexKind::Nsw(_)
3590 | IndexKind::Brin { .. }
3591 | IndexKind::Gin(_)
3592 | IndexKind::GinTrgm(_)
3593 | IndexKind::GinFulltext(_)
3594 | IndexKind::GinJsonb(_) => alloc::boxed::Box::new(core::iter::empty()),
3595 }
3596 }
3597
3598 /// v7.34.4 — ascending-order iterator over `(IndexKey, locators)`
3599 /// pairs. Mirror of `iter_desc` for ORDER BY ... ASC + LIMIT N.
3600 pub fn iter_asc(
3601 &self,
3602 ) -> alloc::boxed::Box<dyn Iterator<Item = (&IndexKey, &crate::posting::PostingList)> + '_>
3603 {
3604 match &self.kind {
3605 IndexKind::BTree(m) => alloc::boxed::Box::new(m.iter()),
3606 // v7.38.1 (L12) — see iter_desc: the leading component of
3607 // a tuple-sorted walk is itself in order.
3608 IndexKind::BTreeMulti(m) => alloc::boxed::Box::new(m.iter().map(|(k, l)| (&k[0], l))),
3609 IndexKind::Nsw(_)
3610 | IndexKind::Brin { .. }
3611 | IndexKind::Gin(_)
3612 | IndexKind::GinTrgm(_)
3613 | IndexKind::GinFulltext(_)
3614 | IndexKind::GinJsonb(_) => alloc::boxed::Box::new(core::iter::empty()),
3615 }
3616 }
3617
3618 /// Look up the locators stored under `key` (B-tree only). Returns
3619 /// an empty slice when the key is absent or the index isn't a
3620 /// BTree — callers can treat both cases uniformly.
3621 ///
3622 /// v5.1: return type widened from `&[usize]` to `&[RowLocator]`.
3623 /// Pre-v5.2 callers can read the slice and `.as_hot().unwrap()`
3624 /// each entry (no `Cold` variants exist until the freezer lands);
3625 /// post-v5.2 callers dispatch hot vs. cold per locator.
3626 pub fn lookup_eq(&self, key: &IndexKey) -> &crate::posting::PostingList {
3627 match &self.kind {
3628 IndexKind::BTree(m) => m.get(key).map_or(&EMPTY_POSTINGS, |l| l),
3629 // BRIN / NSW / GIN / trigram-GIN / fulltext-GIN have
3630 // no IndexKey-keyed map; lookup is a no-op. GIN uses
3631 // [`Index::gin_lookup_word`] instead.
3632 IndexKind::Nsw(_)
3633 | IndexKind::Brin { .. }
3634 | IndexKind::Gin(_)
3635 | IndexKind::GinTrgm(_)
3636 | IndexKind::GinFulltext(_)
3637 | IndexKind::GinJsonb(_)
3638 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3639 }
3640 }
3641
3642 /// v7.37.43 (INSUBQ B-2) — specialised lookup for integer-PK probes.
3643 /// `try_count_star_pk_in_subquery_fast` already holds an `i64` (the
3644 /// inner survivor key); skip the `IndexKey::from_value` enum-dispatch
3645 /// trip and build the key inline. ~20 ns × N_survivors saved on
3646 /// the INSUBQ hot loop.
3647 #[inline]
3648 pub fn lookup_eq_i64(&self, n: i64) -> &crate::posting::PostingList {
3649 match &self.kind {
3650 IndexKind::BTree(m) => m.get(&IndexKey::Int(n)).map_or(&EMPTY_POSTINGS, |l| l),
3651 IndexKind::Nsw(_)
3652 | IndexKind::Brin { .. }
3653 | IndexKind::Gin(_)
3654 | IndexKind::GinTrgm(_)
3655 | IndexKind::GinFulltext(_)
3656 | IndexKind::GinJsonb(_)
3657 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3658 }
3659 }
3660
3661 /// v7.38 (perf, index range scan) — flatten the row locators for every key
3662 /// in `[lo, hi]` (bounds per `core::ops::Bound`) via the BTree's `O(log N +
3663 /// k)` range walk. Returns `None` once more than `cap` locators accumulate
3664 /// — a "this range isn't selective enough, seq-scan instead" signal that
3665 /// stops a wide range from materialising a near-full table's worth of rows
3666 /// through the index. BTree only (other kinds → None).
3667 pub fn lookup_range_capped(
3668 &self,
3669 lo: core::ops::Bound<&IndexKey>,
3670 hi: core::ops::Bound<&IndexKey>,
3671 cap: usize,
3672 ) -> Option<Vec<RowLocator>> {
3673 self.lookup_range_capped_by(lo, hi, cap, |_| true)
3674 }
3675
3676 /// v7.39 (round 490) — the same range walk, but the caller decides
3677 /// which locators are worth carrying, and the cap counts only those.
3678 ///
3679 /// A BTree index holds one locator per row VERSION. On a churned table
3680 /// the dead versions are still in there: round 490 measured a
3681 /// 1000-row range handing back 61 000 locators after 60
3682 /// delete-and-reinsert cycles with the background vacuum switched off.
3683 /// Every caller then dropped the dead ones — the mutation paths and the
3684 /// SELECT range path all test `is_row_visible` and `continue` — but only
3685 /// after they had been collected into a `Vec`, sorted, and walked.
3686 ///
3687 /// Handing the predicate down means the walk keeps ~1000, and the cap
3688 /// (which exists so an index walk never costs more than the scan it
3689 /// replaces) is once again measured in rows a caller will actually look
3690 /// at. Round 461 had to add the dead count to the budget to stop the
3691 /// seek being refused outright; with the filter here that compensation
3692 /// is no longer needed.
3693 pub fn lookup_range_capped_by(
3694 &self,
3695 lo: core::ops::Bound<&IndexKey>,
3696 hi: core::ops::Bound<&IndexKey>,
3697 cap: usize,
3698 keep: impl Fn(RowLocator) -> bool,
3699 ) -> Option<Vec<RowLocator>> {
3700 match &self.kind {
3701 IndexKind::BTree(m) => {
3702 let mut out: Vec<RowLocator> = Vec::new();
3703 for (_, locs) in m.range(lo, hi) {
3704 out.extend(locs.iter().copied().filter(|l| keep(*l)));
3705 if out.len() > cap {
3706 return None;
3707 }
3708 }
3709 Some(out)
3710 }
3711 IndexKind::Nsw(_)
3712 | IndexKind::Brin { .. }
3713 | IndexKind::Gin(_)
3714 | IndexKind::GinTrgm(_)
3715 | IndexKind::GinFulltext(_)
3716 | IndexKind::GinJsonb(_)
3717 | IndexKind::BTreeMulti(_) => None,
3718 }
3719 }
3720
3721 /// v7.38.1 (L12) — full-tuple point lookup on a [`IndexKind::BTreeMulti`]
3722 /// index. `key` must carry exactly as many components as the index
3723 /// has columns; anything else (including a probe against a
3724 /// non-multi index) finds nothing, and "nothing" here is safe
3725 /// because the caller falls back to a scan, never to an answer.
3726 pub fn lookup_eq_multi(&self, key: &[IndexKey]) -> &crate::posting::PostingList {
3727 match &self.kind {
3728 IndexKind::BTreeMulti(m) if key.len() == 1 + self.extra_column_positions.len() => {
3729 m.get_by(key).map_or(&EMPTY_POSTINGS, |l| l)
3730 }
3731 _ => &EMPTY_POSTINGS,
3732 }
3733 }
3734
3735 /// v7.38.1 (L12) — locators for every key whose leading components
3736 /// equal `prefix`, on a [`IndexKind::BTreeMulti`] index. Slice
3737 /// ordering keeps a prefix's keys contiguous, so this is one
3738 /// descent to `[prefix]` and a walk that stops at the first key
3739 /// leaving the prefix. Same cap/keep contract as
3740 /// [`Index::lookup_range_capped_by`]: `None` = not selective
3741 /// enough (or not a multi index), fall back.
3742 pub fn lookup_prefix_capped_by(
3743 &self,
3744 prefix: &[IndexKey],
3745 cap: usize,
3746 keep: impl Fn(RowLocator) -> bool,
3747 ) -> Option<Vec<RowLocator>> {
3748 let IndexKind::BTreeMulti(m) = &self.kind else {
3749 return None;
3750 };
3751 if prefix.is_empty() || prefix.len() > 1 + self.extra_column_positions.len() {
3752 return None;
3753 }
3754 let lo: alloc::boxed::Box<[IndexKey]> = prefix.to_vec().into_boxed_slice();
3755 let mut out: Vec<RowLocator> = Vec::new();
3756 for (k, locs) in m.range(core::ops::Bound::Included(&lo), core::ops::Bound::Unbounded) {
3757 if k.len() < prefix.len() || k[..prefix.len()] != *prefix {
3758 break;
3759 }
3760 out.extend(locs.iter().copied().filter(|l| keep(*l)));
3761 if out.len() > cap {
3762 return None;
3763 }
3764 }
3765 Some(out)
3766 }
3767
3768 /// v7.39 (round 560) — the index range as (key, locator) pairs.
3769 ///
3770 /// `lookup_range_capped_by` throws the KEY away and returns only
3771 /// locators, so a query whose projection is exactly the indexed
3772 /// column still goes to the row store for a value the walk already
3773 /// had in hand — paying per row for something the index knows.
3774 ///
3775 /// Uncapped on purpose: an index-only walk touches no row, so the
3776 /// selectivity ceiling that keeps a seek from being worse than the
3777 /// scan it replaces does not apply to it.
3778 ///
3779 /// v7.39 (round 562) — and it does not collect, either. This
3780 /// returned a `Vec<(IndexKey, RowLocator)>`: for a 100k-row range,
3781 /// 100k key clones into a `Vec::new()` that doubles its way up to
3782 /// several MB, all to be walked once and dropped. A profile of the
3783 /// server serving that query put 20% of the connection thread's CPU
3784 /// on the collect alone, with another 18% in the allocator beside
3785 /// it. The caller consumes the pairs in order and needs the key
3786 /// only by reference, so it can have the walk itself.
3787 pub fn range_keyed(
3788 &self,
3789 lo: core::ops::Bound<&IndexKey>,
3790 hi: core::ops::Bound<&IndexKey>,
3791 ) -> Option<impl Iterator<Item = (&IndexKey, RowLocator)> + '_> {
3792 match &self.kind {
3793 IndexKind::BTree(m) => Some(
3794 m.range(lo, hi)
3795 .flat_map(|(k, locs)| locs.iter().map(move |l| (k, *l))),
3796 ),
3797 IndexKind::Nsw(_)
3798 | IndexKind::Brin { .. }
3799 | IndexKind::Gin(_)
3800 | IndexKind::GinTrgm(_)
3801 | IndexKind::GinFulltext(_)
3802 | IndexKind::GinJsonb(_)
3803 | IndexKind::BTreeMulti(_) => None,
3804 }
3805 }
3806
3807 /// v7.12.3 — GIN posting-list lookup. Returns the row locators
3808 /// whose `tsvector` cell contains `word`. Empty when the word is
3809 /// absent from the index or this isn't a GIN index.
3810 pub fn gin_lookup_word(&self, word: &str) -> &crate::posting::PostingList {
3811 match &self.kind {
3812 // v7.17.0 Phase 2.2 — fulltext-GIN shares the same
3813 // lexeme-keyed posting list shape as the
3814 // tsvector-typed GIN, so the same lookup applies.
3815 IndexKind::Gin(m) | IndexKind::GinFulltext(m) => {
3816 m.get(&String::from(word)).map_or(&EMPTY_POSTINGS, |l| l)
3817 }
3818 IndexKind::BTree(_)
3819 | IndexKind::Nsw(_)
3820 | IndexKind::Brin { .. }
3821 | IndexKind::GinTrgm(_)
3822 | IndexKind::GinJsonb(_)
3823 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3824 }
3825 }
3826
3827 /// v7.15.0 — trigram-GIN posting-list lookup. Returns the row
3828 /// locators whose indexed `TEXT` cell contains the trigram
3829 /// `tri`. Empty when the trigram is absent or this isn't a
3830 /// trigram-GIN index.
3831 pub fn gin_trgm_lookup(&self, tri: &str) -> &crate::posting::PostingList {
3832 match &self.kind {
3833 IndexKind::GinTrgm(m) => m.get(&String::from(tri)).map_or(&EMPTY_POSTINGS, |l| l),
3834 IndexKind::BTree(_)
3835 | IndexKind::Nsw(_)
3836 | IndexKind::Brin { .. }
3837 | IndexKind::Gin(_)
3838 | IndexKind::GinFulltext(_)
3839 | IndexKind::GinJsonb(_)
3840 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3841 }
3842 }
3843
3844 /// v7.37.8(sentori Epic 5 P2)— JSONB-GIN posting-list lookup.
3845 /// Returns the row locators whose indexed JSONB cell carries
3846 /// the canonical `token`(see [`crate::jsonb_gin::extract_tokens`]).
3847 /// Empty when the token is absent or this isn't a JSONB-GIN
3848 /// index. Planners drive `<col> @> <jsonb_literal>` through here.
3849 pub fn gin_jsonb_lookup(&self, token: &str) -> &crate::posting::PostingList {
3850 match &self.kind {
3851 IndexKind::GinJsonb(m) => m.get(&String::from(token)).map_or(&EMPTY_POSTINGS, |l| l),
3852 IndexKind::BTree(_)
3853 | IndexKind::Nsw(_)
3854 | IndexKind::Brin { .. }
3855 | IndexKind::Gin(_)
3856 | IndexKind::GinTrgm(_)
3857 | IndexKind::GinFulltext(_)
3858 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3859 }
3860 }
3861
3862 /// Borrow the NSW graph (if this is an NSW index). Callers that need
3863 /// the graph for a kNN search go through here.
3864 pub const fn nsw(&self) -> Option<&NswGraph> {
3865 match &self.kind {
3866 IndexKind::Nsw(g) => Some(g),
3867 IndexKind::BTree(_)
3868 | IndexKind::Brin { .. }
3869 | IndexKind::Gin(_)
3870 | IndexKind::GinTrgm(_)
3871 | IndexKind::GinFulltext(_)
3872 | IndexKind::GinJsonb(_)
3873 | IndexKind::BTreeMulti(_) => None,
3874 }
3875 }
3876
3877 /// v6.7.1 — true when this index is a BRIN (block range) index.
3878 /// Used by the segment encoder to opt into BRIN sidecar emission
3879 /// at freeze time, and by the planner to opt into page-skipping
3880 /// on range predicates.
3881 pub const fn is_brin(&self) -> bool {
3882 matches!(self.kind, IndexKind::Brin { .. })
3883 }
3884
3885 /// v7.15.0 — true when this index is a trigram GIN
3886 /// (`gin_trgm_ops`-flavoured). Used by the LIKE planner to
3887 /// opt into trigram acceleration.
3888 pub const fn is_gin_trgm(&self) -> bool {
3889 matches!(self.kind, IndexKind::GinTrgm(_))
3890 }
3891
3892 /// v7.12.3 — true when this index is a GIN inverted index.
3893 /// Used by the planner to opt into posting-list acceleration on
3894 /// `WHERE col @@ tsquery` predicates.
3895 pub const fn is_gin(&self) -> bool {
3896 matches!(self.kind, IndexKind::Gin(_))
3897 }
3898
3899 /// v7.17.0 Phase 2.2 — true when this index is a fulltext
3900 /// GIN over a TEXT / VARCHAR column (MySQL `FULLTEXT KEY`
3901 /// surface). Used by the planner to opt the FULLTEXT-indexed
3902 /// column into MATCH AGAINST acceleration.
3903 pub const fn is_gin_fulltext(&self) -> bool {
3904 matches!(self.kind, IndexKind::GinFulltext(_))
3905 }
3906
3907 /// v7.37.8(sentori Epic 5 P2)— true when this index is a
3908 /// real JSONB-GIN(posting-list backed). Used by the planner
3909 /// to opt `<col> @> <jsonb_literal>` into posting-list seek.
3910 pub const fn is_gin_jsonb(&self) -> bool {
3911 matches!(self.kind, IndexKind::GinJsonb(_))
3912 }
3913}
3914
3915/// In-memory table: schema + a persistent row vector + secondary indices.
3916///
3917/// v4.39: `rows` is a [`PersistentVec`] (Bitmapped Vector Trie, 32-way) so
3918/// `Table::clone()` is `O(1)` — the whole reason for v4.39's existence is
3919/// to make `Catalog::clone()` cheap inside the v4.34 auto-commit wrap.
3920///
3921/// v5.2.1: `hot_bytes` tracks the encoded byte size of every row currently
3922/// in [`Self::rows`], summed over rows. Updated incrementally by `insert`
3923/// (+= encoded row size), `delete_rows` (-= removed rows' encoded sizes),
3924/// and `update_row` (-= old size, += new size). The value is what the
3925/// v5.2 freezer reads to decide when to demote cold rows — when the
3926/// catalog-wide sum crosses `SPG_HOT_TIER_BYTES` (default 4 GiB) the
3927/// freezer thread wakes. v5.2.1 ships measurement only; the freezer
3928/// itself lands in v5.2.2. Stored as `u64` so a single field clone in
3929/// `Catalog::clone` stays at the O(1) invariant v4.39 built.
3930/// v7.34 (crash-recovery P0 #2) — one row-level physical redo record.
3931/// Row-level redo replaces statement-based WAL replay (which re-executes
3932/// each SQL through the full engine — O(records × catalog_rows), the
3933/// superlinear recovery hang root-caused on the mailrs crash-recovery
3934/// P0). A `RowChange` is the exact storage mutation the engine applied
3935/// (`Table::insert` / `update_row` / `delete_rows`); replaying it on a
3936/// catalog restored from the matching checkpoint reproduces the state
3937/// WITHOUT re-validating uniqueness/FK/parse/plan — O(changed rows).
3938///
3939/// Positions are physical, not key-based: `serialize`/`deserialize`
3940/// preserve row order exactly (rows written + read back in `self.rows`
3941/// order) and the mutation ops are deterministic, so the same op sequence
3942/// replayed from the same checkpoint reproduces the same positions. This
3943/// matches PostgreSQL's physical redo and supports tables with no primary
3944/// key. (Caveat handled at replay integration: a post-checkpoint cold-tier
3945/// freeze shifts hot positions and must itself be logged or fenced by a
3946/// checkpoint — see `row-level-redo-design`.)
3947/// ## v7.37.15 (Epic W slice 1) — additive MVCC identity metadata
3948///
3949/// Each variant now also carries, additively, the stable
3950/// [`RowId`](row_header::RowId) of the affected row(s) and the
3951/// **writer version** (`xmin` for an insert, `xmax` for a
3952/// delete/update). This is the codec foundation for making
3953/// in-place MVCC tombstones durable across crash/upgrade recovery.
3954///
3955/// Two important properties for the durability path:
3956///
3957/// 1. **Replay resolution is UNCHANGED.** `apply_redo_run_on_table`
3958/// still resolves every change by physical `pos`/`positions`
3959/// exactly as before. The new metadata is *carried but unused*
3960/// by replay in this slice; resolving-by-`RowId` and
3961/// header-preserving replay are later slices.
3962/// 2. **Backward compatibility.** A redo payload written by
3963/// pre-Epic-W code carries no metadata; [`decode_redo_log`]
3964/// fills `rowid`/`rowids` with [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED)
3965/// (empty for `Delete`) and `writer_version` with `0`. See the
3966/// codec version gate in [`encode_redo_log`]/[`decode_redo_log`].
3967///
3968/// The `writer_version` is captured as `0` at the storage layer
3969/// (`Table::insert`/`delete_rows`/`update_row` don't have the
3970/// committing `TxId`), then **stamped with the real committing
3971/// version by the engine** after it drains the statement's changes
3972/// (Epic W slice 2 — [`RowChange::set_writer_version`], driven from
3973/// `Engine::writer_version_for_current_stmt`). All changes from one
3974/// statement share the one version. Replay still resolves by
3975/// physical position and does not read `writer_version` — that is a
3976/// later slice (header-preserving replay).
3977#[derive(Debug, Clone, PartialEq)]
3978pub enum RowChange {
3979 /// Append `row` to `table`.
3980 Insert {
3981 table: String,
3982 row: Row<'static>,
3983 /// Epic W: stable id the appended row will receive.
3984 /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) when
3985 /// decoded from a pre-Epic-W redo payload.
3986 rowid: row_header::RowId,
3987 /// Epic W: writer version (`xmin`). `0` until the writing
3988 /// `TxId` is threaded to the storage layer (later slice).
3989 writer_version: u64,
3990 },
3991 /// Replace the row at physical `pos` in `table` with `new_row`.
3992 Update {
3993 table: String,
3994 pos: usize,
3995 new_row: Vec<Value<'static>>,
3996 /// Epic W: stable id of the row at `pos`.
3997 /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) when
3998 /// decoded from a pre-Epic-W redo payload.
3999 rowid: row_header::RowId,
4000 /// Epic W: writer version (`xmax` of the superseded tuple).
4001 /// `0` until the writing `TxId` is threaded (later slice).
4002 writer_version: u64,
4003 },
4004 /// Remove the rows at the given physical `positions` from `table`.
4005 Delete {
4006 table: String,
4007 positions: Vec<usize>,
4008 /// Epic W: stable ids parallel to `positions` (same length,
4009 /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) for an
4010 /// out-of-bounds input position). **Empty** when decoded from
4011 /// a pre-Epic-W redo payload (no metadata was recorded).
4012 rowids: Vec<row_header::RowId>,
4013 /// Epic W: writer version (`xmax`). `0` until the writing
4014 /// `TxId` is threaded to the storage layer (later slice).
4015 writer_version: u64,
4016 },
4017 /// v7.37.15 (Epic W durable-tombstone slice) — an **in-place MVCC
4018 /// delete**: the row(s) named by `rowids` are NOT physically
4019 /// removed; their header `xmax` is stamped so newer snapshots stop
4020 /// seeing them (vacuum reclaims later). This is the redo shape of
4021 /// the gate-on (`SPG_MVCC_INPLACE`) DELETE / UPDATE-old-version /
4022 /// ON-CONFLICT paths, which call [`Table::mark_row_deleted`]
4023 /// instead of `delete_rows`.
4024 ///
4025 /// Unlike `Delete`, the target is named by **stable `RowId`**, not
4026 /// physical position: a tombstone keeps the slot, so position would
4027 /// be ambiguous after later compaction, and the header-preserving
4028 /// replay must re-find the exact row the writer tombstoned. On
4029 /// replay the id is matched against the ids the same redo run
4030 /// produced (an `Insert`'s `rowid`, or the table's ids snapshotted
4031 /// at run start); an id that cannot be resolved is skipped and
4032 /// counted (see `apply_redo_run_on_table`) — this is the documented
4033 /// cross-checkpoint limitation until the V6 envelope persists ids.
4034 Tombstone {
4035 table: String,
4036 /// Stable ids of the tombstoned rows (from `self.rowids()[pos]`
4037 /// at capture). Never empty for a recorded tombstone.
4038 rowids: Vec<row_header::RowId>,
4039 /// The version stamped into each target row's header `xmax`
4040 /// (the deleting statement's writer version).
4041 xmax: u64,
4042 },
4043}
4044
4045impl RowChange {
4046 /// v7.39 (round 736) — which table this change applies to.
4047 #[must_use]
4048 pub fn table_name(&self) -> &str {
4049 match self {
4050 Self::Insert { table, .. }
4051 | Self::Update { table, .. }
4052 | Self::Delete { table, .. }
4053 | Self::Tombstone { table, .. } => table,
4054 }
4055 }
4056
4057 /// v7.37.15 (Epic W slice 2) — stamp the committing writer
4058 /// version onto this change. Every change drained from a single
4059 /// statement shares one version (the statement's `xmin`/`xmax`),
4060 /// so the engine calls this on each drained change with the value
4061 /// from [`Engine::writer_version_for_current_stmt`]. Additive
4062 /// metadata only: replay still resolves by physical position and
4063 /// does not read `writer_version` (that is a later slice).
4064 pub fn set_writer_version(&mut self, v: u64) {
4065 match self {
4066 RowChange::Insert { writer_version, .. }
4067 | RowChange::Update { writer_version, .. }
4068 | RowChange::Delete { writer_version, .. } => *writer_version = v,
4069 // A tombstone captures `xmax` directly from the deleting
4070 // statement's version at record time (via
4071 // `mark_row_deleted`), so it already equals `v`. Keep the
4072 // "one statement, one version" invariant mechanical by
4073 // asserting agreement in debug builds rather than silently
4074 // overwriting a possibly-different value.
4075 RowChange::Tombstone { xmax, .. } => {
4076 debug_assert_eq!(
4077 *xmax, v,
4078 "tombstone xmax must match the statement writer version"
4079 );
4080 *xmax = v;
4081 }
4082 }
4083 }
4084}
4085
4086/// v7.37.15 (Epic W slice 1) — leading marker byte of the
4087/// metadata-carrying redo layout. A **pre-Epic-W** redo payload leads
4088/// with `FILE_VERSION` (8..=52 today, rising ~1 per release); this
4089/// marker is `0xFF` and can therefore never collide with a real
4090/// `FILE_VERSION`, so [`decode_redo_log`] tells the two layouts apart
4091/// by inspecting the first byte alone. The compile-time assertion
4092/// below makes the "never collide" invariant a hard build gate: if
4093/// `FILE_VERSION` ever climbs toward `0xFF` the build breaks and forces
4094/// a redesign long before an ambiguity could ship.
4095const REDO_META_MARKER: u8 = 0xFF;
4096/// v7.37.15 (Epic W slice 1) — version of the metadata-carrying redo
4097/// layout that follows [`REDO_META_MARKER`]. Bumped when the per-change
4098/// metadata shape changes; an unknown value is a hard decode error.
4099const REDO_META_VERSION: u8 = 1;
4100
4101/// v7.37.15 (Epic W durable-tombstone slice) — process-wide count of
4102/// [`RowChange::Tombstone`] targets that `apply_redo` could NOT resolve
4103/// to a row by `RowId`. A non-zero value is expected only across a
4104/// checkpoint boundary (the table's ids are reassigned on deserialize
4105/// and the V6 envelope does not yet persist them), where a tombstone
4106/// naming a pre-checkpoint row is left visible rather than mis-applied.
4107/// Surfaced for observability; never affects correctness of the resolved
4108/// tombstones. Read via [`unresolved_tombstone_count`].
4109static UNRESOLVED_TOMBSTONES: core::sync::atomic::AtomicU64 = core::sync::atomic::AtomicU64::new(0);
4110
4111/// v7.39 (flip crash-replay P0) — observability read for the replay
4112/// tombstones that could not be resolved to a row (each one is a
4113/// resurrected delete).
4114#[must_use]
4115pub fn unresolved_tombstones() -> u64 {
4116 UNRESOLVED_TOMBSTONES.load(core::sync::atomic::Ordering::Relaxed)
4117}
4118
4119/// v7.37.15 (Epic W durable-tombstone slice) — read the process-wide
4120/// count of redo tombstones that could not be resolved to a row by
4121/// `RowId` during `apply_redo`. See [`UNRESOLVED_TOMBSTONES`].
4122#[must_use]
4123pub fn unresolved_tombstone_count() -> u64 {
4124 UNRESOLVED_TOMBSTONES.load(core::sync::atomic::Ordering::Relaxed)
4125}
4126// Provably-unambiguous old/new distinction: the pre-Epic-W layout's
4127// first byte is `FILE_VERSION`, which must stay strictly below the
4128// marker forever.
4129const _: () = assert!(FILE_VERSION < REDO_META_MARKER);
4130
4131/// v7.34 (crash-recovery P0 #2), extended v7.37.15 (Epic W slice 1) —
4132/// encode a row-level redo log to bytes for a WAL record.
4133///
4134/// ## Layout (Epic W metadata-carrying form, always emitted now)
4135///
4136/// `[u8 REDO_META_MARKER=0xFF][u8 REDO_META_VERSION][u8 FILE_VERSION]
4137/// [u32 count]` then per change `[u8 op][str table]` and, per op:
4138/// - `Insert [u32 n][value×n][u64 rowid][u64 writer_version]`
4139/// - `Update [u32 pos][u32 n][value×n][u64 rowid][u64 writer_version]`
4140/// - `Delete [u32 n][u32 pos×n][u64 rowid×n][u64 writer_version]`
4141/// - `Tombstone [u32 n][u64 rowid×n][u64 xmax]` (op byte 3; only ever
4142/// emitted under the metadata-carrying layout — the pre-Epic-W layout
4143/// had no in-place tombstone, so a legacy stream can never carry it)
4144///
4145/// Positions are physical (u32 ≤ 4 G rows). The `FILE_VERSION` byte
4146/// still rides along (now the 3rd byte) so the value codec decodes
4147/// string / BYTEA escapes exactly as before.
4148///
4149/// ## Backward compatibility
4150///
4151/// The **pre-Epic-W** layout was `[u8 FILE_VERSION][u32 count]…` with
4152/// no per-change metadata. [`decode_redo_log`] still decodes that form
4153/// (first byte < `0xFF`) byte-for-byte identically — every WAL file
4154/// written by released code replays unchanged.
4155#[must_use]
4156pub fn encode_redo_log(changes: &[RowChange]) -> Vec<u8> {
4157 let mut out = Vec::new();
4158 out.push(REDO_META_MARKER);
4159 out.push(REDO_META_VERSION);
4160 out.push(FILE_VERSION);
4161 codec::write_u32(&mut out, changes.len() as u32);
4162 let write_values = |out: &mut Vec<u8>, vals: &[Value<'static>]| {
4163 codec::write_u32(out, vals.len() as u32);
4164 for v in vals {
4165 codec::write_value(out, v);
4166 }
4167 };
4168 for change in changes {
4169 match change {
4170 RowChange::Insert {
4171 table,
4172 row,
4173 rowid,
4174 writer_version,
4175 } => {
4176 out.push(0);
4177 codec::write_str(&mut out, table);
4178 write_values(&mut out, &row.values);
4179 codec::write_u64(&mut out, rowid.0);
4180 codec::write_u64(&mut out, *writer_version);
4181 }
4182 RowChange::Update {
4183 table,
4184 pos,
4185 new_row,
4186 rowid,
4187 writer_version,
4188 } => {
4189 out.push(1);
4190 codec::write_str(&mut out, table);
4191 codec::write_u32(&mut out, *pos as u32);
4192 write_values(&mut out, new_row);
4193 codec::write_u64(&mut out, rowid.0);
4194 codec::write_u64(&mut out, *writer_version);
4195 }
4196 RowChange::Delete {
4197 table,
4198 positions,
4199 rowids,
4200 writer_version,
4201 } => {
4202 out.push(2);
4203 codec::write_str(&mut out, table);
4204 codec::write_u32(&mut out, positions.len() as u32);
4205 for p in positions {
4206 codec::write_u32(&mut out, *p as u32);
4207 }
4208 // Epic W: one RowId per position (parallel). Capture
4209 // sites always produce `rowids.len() == positions.len()`;
4210 // this assertion pins that invariant at encode time so a
4211 // mismatch is a loud bug, not a silently short payload.
4212 debug_assert_eq!(
4213 rowids.len(),
4214 positions.len(),
4215 "redo Delete: rowids must be parallel to positions"
4216 );
4217 for rid in rowids {
4218 codec::write_u64(&mut out, rid.0);
4219 }
4220 codec::write_u64(&mut out, *writer_version);
4221 }
4222 RowChange::Tombstone {
4223 table,
4224 rowids,
4225 xmax,
4226 } => {
4227 out.push(3);
4228 codec::write_str(&mut out, table);
4229 codec::write_u32(&mut out, rowids.len() as u32);
4230 for rid in rowids {
4231 codec::write_u64(&mut out, rid.0);
4232 }
4233 codec::write_u64(&mut out, *xmax);
4234 }
4235 }
4236 }
4237 out
4238}
4239
4240/// v7.34, extended v7.37.15 (Epic W slice 1) — decode a row-level redo
4241/// log written by [`encode_redo_log`].
4242///
4243/// Decodes **both** the Epic W metadata-carrying layout (first byte
4244/// `REDO_META_MARKER = 0xFF`) and the pre-Epic-W layout (first byte is
4245/// `FILE_VERSION`, always `< 0xFF`). For the old layout the per-change
4246/// metadata is absent, so `rowid`/`rowids` come back
4247/// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) (empty for
4248/// `Delete`) and `writer_version` comes back `0`.
4249///
4250/// A truncated / corrupt buffer is a hard error — never a panic — the
4251/// embedding layer frames each record with its own length + CRC, so a
4252/// frame that decodes short is corruption, not a torn tail.
4253pub fn decode_redo_log(bytes: &[u8]) -> Result<Vec<RowChange>, StorageError> {
4254 let first = *bytes
4255 .first()
4256 .ok_or_else(|| StorageError::Corrupt("redo log: empty".into()))?;
4257 // Epic W: `0xFF` marker ⇒ metadata-carrying layout; anything else
4258 // is a pre-Epic-W `FILE_VERSION` byte (old layout, no metadata).
4259 let has_meta = first == REDO_META_MARKER;
4260 let (codec_version, header_len) = if has_meta {
4261 let meta_version = *bytes
4262 .get(1)
4263 .ok_or_else(|| StorageError::Corrupt("redo log: short header".into()))?;
4264 if meta_version != REDO_META_VERSION {
4265 return Err(StorageError::Corrupt(alloc::format!(
4266 "redo log: unknown metadata version {meta_version}"
4267 )));
4268 }
4269 let file_version = *bytes
4270 .get(2)
4271 .ok_or_else(|| StorageError::Corrupt("redo log: short header".into()))?;
4272 // header = [marker][meta_version][file_version]
4273 (file_version, 3usize)
4274 } else {
4275 // Old layout: the first byte IS the FILE_VERSION.
4276 (first, 1usize)
4277 };
4278 let mut cur = codec::Cursor::new(bytes).with_codec_version(codec_version);
4279 for _ in 0..header_len {
4280 cur.read_u8()?;
4281 }
4282 let count = cur.read_u32()? as usize;
4283 let mut read_values =
4284 |cur: &mut codec::Cursor<'_>| -> Result<Vec<Value<'static>>, StorageError> {
4285 let n = cur.read_u32()? as usize;
4286 let mut vals = Vec::with_capacity(n);
4287 for _ in 0..n {
4288 vals.push(cur.read_value()?);
4289 }
4290 Ok(vals)
4291 };
4292 let mut changes = Vec::with_capacity(count);
4293 for _ in 0..count {
4294 let op = cur.read_u8()?;
4295 let table = cur.read_str()?;
4296 let change = match op {
4297 0 => {
4298 let row = Row::new(read_values(&mut cur)?);
4299 let (rowid, writer_version) = if has_meta {
4300 (row_header::RowId(cur.read_u64()?), cur.read_u64()?)
4301 } else {
4302 (row_header::RowId::UNASSIGNED, 0)
4303 };
4304 RowChange::Insert {
4305 table,
4306 row,
4307 rowid,
4308 writer_version,
4309 }
4310 }
4311 1 => {
4312 let pos = cur.read_u32()? as usize;
4313 let new_row = read_values(&mut cur)?;
4314 let (rowid, writer_version) = if has_meta {
4315 (row_header::RowId(cur.read_u64()?), cur.read_u64()?)
4316 } else {
4317 (row_header::RowId::UNASSIGNED, 0)
4318 };
4319 RowChange::Update {
4320 table,
4321 pos,
4322 new_row,
4323 rowid,
4324 writer_version,
4325 }
4326 }
4327 2 => {
4328 let n = cur.read_u32()? as usize;
4329 let mut positions = Vec::with_capacity(n);
4330 for _ in 0..n {
4331 positions.push(cur.read_u32()? as usize);
4332 }
4333 let (rowids, writer_version) = if has_meta {
4334 let mut rowids = Vec::with_capacity(n);
4335 for _ in 0..n {
4336 rowids.push(row_header::RowId(cur.read_u64()?));
4337 }
4338 (rowids, cur.read_u64()?)
4339 } else {
4340 // Old layout carried no RowId metadata.
4341 (Vec::new(), 0)
4342 };
4343 RowChange::Delete {
4344 table,
4345 positions,
4346 rowids,
4347 writer_version,
4348 }
4349 }
4350 // Op 3 is the Epic W in-place tombstone — it only exists in
4351 // the metadata-carrying layout. Guarding on `has_meta` means
4352 // a legacy stream that happens to contain a `3` byte here is
4353 // reported as an unknown op (corruption), never mis-decoded.
4354 3 if has_meta => {
4355 let n = cur.read_u32()? as usize;
4356 let mut rowids = Vec::with_capacity(n);
4357 for _ in 0..n {
4358 rowids.push(row_header::RowId(cur.read_u64()?));
4359 }
4360 let xmax = cur.read_u64()?;
4361 RowChange::Tombstone {
4362 table,
4363 rowids,
4364 xmax,
4365 }
4366 }
4367 other => {
4368 return Err(StorageError::Corrupt(alloc::format!(
4369 "redo log: unknown op {other}"
4370 )));
4371 }
4372 };
4373 changes.push(change);
4374 }
4375 Ok(changes)
4376}
4377
4378/// v7.39 (pg_stat knife B) — per-table scan counters, bumped from
4379/// `&self` read paths. Clone (tx shadow catalogs clone tables) copies
4380/// the current values; the counters are volatile like PG's cumulative
4381/// stats.
4382#[derive(Debug, Default)]
4383pub struct ScanStats {
4384 pub seq_scan: core::sync::atomic::AtomicU64,
4385 pub seq_tup_read: core::sync::atomic::AtomicU64,
4386 pub idx_scan: core::sync::atomic::AtomicU64,
4387 pub idx_tup_fetch: core::sync::atomic::AtomicU64,
4388}
4389
4390impl Clone for ScanStats {
4391 fn clone(&self) -> Self {
4392 use core::sync::atomic::{AtomicU64, Ordering};
4393 Self {
4394 seq_scan: AtomicU64::new(self.seq_scan.load(Ordering::Relaxed)),
4395 seq_tup_read: AtomicU64::new(self.seq_tup_read.load(Ordering::Relaxed)),
4396 idx_scan: AtomicU64::new(self.idx_scan.load(Ordering::Relaxed)),
4397 idx_tup_fetch: AtomicU64::new(self.idx_tup_fetch.load(Ordering::Relaxed)),
4398 }
4399 }
4400}
4401
4402/// v7.39 (round 215) — the lower-bound sort key for a range value, used by
4403/// the range-exclusion index. The bound as an `i128` (unbounded lower =
4404/// `i128::MIN`, sorting first) plus an inclusivity rank (inclusive lower
4405/// sorts before exclusive at the same value, `[3` before `(3`). Returns
4406/// `None` for range kinds whose bound isn't an integer scalar (numrange's
4407/// numeric/bignum), for empty ranges, and for non-range values — the caller
4408/// then keeps the O(n) scan rather than risk an unsound order. Int4/Int8/
4409/// Date/Ts/TsTz all reduce here (tstzrange bounds are `Value::Timestamp`).
4410/// Maintenance (index build) and query (overlap probe) MUST agree on this
4411/// key, so both sides call exactly this function.
4412#[must_use]
4413pub fn range_excl_index_key(v: &Value<'_>) -> Option<(i128, u8)> {
4414 let Value::Range {
4415 lower,
4416 lower_inc,
4417 empty,
4418 ..
4419 } = v
4420 else {
4421 return None;
4422 };
4423 if *empty {
4424 return None;
4425 }
4426 let key = match lower {
4427 None => i128::MIN,
4428 Some(b) => match b.as_ref() {
4429 Value::SmallInt(n) => i128::from(*n),
4430 Value::Int(n) => i128::from(*n),
4431 Value::BigInt(n) => i128::from(*n),
4432 Value::Date(n) => i128::from(*n),
4433 Value::Timestamp(n) => i128::from(*n),
4434 _ => return None,
4435 },
4436 };
4437 Some((key, u8::from(!*lower_inc)))
4438}
4439
4440/// v7.39 (round 215) — a per-table range-exclusion index: an incrementally
4441/// maintained map from a range column's lower-bound key
4442/// ([`range_excl_index_key`]) to the physical row locators carrying that
4443/// bound. Lets EXCLUDE enforcement find the few candidate rows a new range
4444/// might overlap in O(log n) instead of scanning every row (measured O(N²),
4445/// r213). Because the stored ranges under a valid `EXCLUDE (col WITH &&)`
4446/// are pairwise disjoint, a candidate overlaps only its predecessor or the
4447/// successors whose lower bound precedes its upper — a handful of probes.
4448///
4449/// NOT persisted: rebuilt from the (persisted) exclusion constraints + rows
4450/// on catalog load, exactly like BRIN re-derives. Backed by a
4451/// `PersistentBTreeMap` so `Table::clone` (the per-write snapshot) stays
4452/// O(1). Locators to tombstoned rows are left in place and filtered by the
4453/// consumer via `is_deleted()` at query time — the established index pattern.
4454#[derive(Debug, Clone)]
4455pub struct ExclRangeIndex {
4456 /// The constrained range column's position in the table.
4457 pub column_position: usize,
4458 /// Lower-bound key → row locators. A key maps to a `Vec` because a
4459 /// tombstoned-then-reinserted bound can transiently collide; live rows
4460 /// under the constraint are disjoint so each key has one live locator.
4461 pub map: PersistentBTreeMap<(i128, u8), crate::posting::PostingList>,
4462}
4463
4464/// v7.38.2 (R2) — see [`Table::tx_write_track`]. Positions are the
4465/// insert-time slots (verified against the header's version at
4466/// extraction, so a shifted slot falls back to the scan); tombstones
4467/// carry the stable RowId, which is what the write-set wants anyway.
4468#[derive(Debug, Clone, Default)]
4469struct TxWriteTrack {
4470 version: u64,
4471 inserted: Vec<(usize, row_header::RowId)>,
4472 tombstoned: Vec<row_header::RowId>,
4473}
4474
4475/// v7.38.11 — hot-tier BRIN granularity: slots per summarised range.
4476///
4477/// 1024 keeps the summary vector three orders of magnitude smaller
4478/// than the table while staying fine enough that a one-day window over
4479/// a 90-day table skips ~99 % of it. A tuning constant, not a format:
4480/// summaries are rebuilt from the rows on load, so changing it costs
4481/// nothing on disk.
4482pub const BRIN_RANGE_ROWS: usize = 1024;
4483
4484/// The comparable scalar a BRIN summary tracks, or `None` for a value
4485/// with no ordering this index can use.
4486///
4487/// Deliberately narrow: only types whose ordering IS the i64 ordering
4488/// of this number. A type added here whose comparison is not that —
4489/// text under a collation, say — would make the summary under-report
4490/// and skip matching rows, which is the one failure this design must
4491/// not have.
4492#[must_use]
4493pub fn brin_scalar(v: &Value<'_>) -> Option<i64> {
4494 match v {
4495 Value::SmallInt(n) => Some(i64::from(*n)),
4496 Value::Int(n) => Some(i64::from(*n)),
4497 Value::BigInt(n) | Value::Timestamp(n) => Some(*n),
4498 Value::Date(d) => Some(i64::from(*d)),
4499 Value::Bool(b) => Some(i64::from(*b)),
4500 _ => None,
4501 }
4502}
4503
4504#[derive(Debug, Clone)]
4505pub struct Table {
4506 schema: TableSchema,
4507 /// v7.38.16 — names of the expression indexes whose B-tree currently
4508 /// holds keys derived from the EXPRESSION.
4509 ///
4510 /// Every catalog written before this version stored, under an
4511 /// expression index, the values of its leading column — keys no
4512 /// lookup could ever match, which is why every read path guarded
4513 /// itself with `expression.is_none()` and the index bought nothing
4514 /// while costing 1.9x a plain insert to maintain.
4515 ///
4516 /// Deliberately NOT persisted: a table read off disk starts with the
4517 /// set empty, so those old wrong keys can never answer a query. The
4518 /// engine, which owns the expression evaluator, refills it.
4519 expr_index_complete: alloc::collections::BTreeSet<String>,
4520 /// v7.37.15 (Phase C.1) — stable per-catalog relation identity.
4521 /// [`RelId::UNASSIGNED`](row_header::RelId::UNASSIGNED) until
4522 /// `Catalog::create_table` (or the deserialize dense-assign pass)
4523 /// stamps a real id. Keys the Phase C.4 row-lock table and the
4524 /// Phase C.5 `RelationStore`; survives `DROP TABLE` slot shifts.
4525 rel_id: row_header::RelId,
4526 rows: PersistentVec<Row<'static>>,
4527 /// v7.37.15 (Phase A.2) — per-row MVCC visibility headers
4528 /// parallel to `rows`. `headers.len() == rows.len()` is the
4529 /// load-bearing invariant; debug builds assert it on every
4530 /// scan boundary, release builds rely on it from
4531 /// disciplined insert / delete / update paths.
4532 ///
4533 /// Pre-v7.37.15-loaded tables (every row currently in the
4534 /// fleet) start as `RowHeader::frozen()` — `is_all_visible_fast()`
4535 /// returns `true`, so the per-row visibility gate Phase B
4536 /// adds is a no-op against any snapshot.
4537 ///
4538 /// Headers are NOT yet serialised into the envelope at this
4539 /// commit — on snapshot deserialize every row gets a fresh
4540 /// `RowHeader::frozen()`. Phase D adds the visibility-map
4541 /// + segment-freeze story which makes serialisation
4542 /// meaningful; until then the on-disk story is "the catalog
4543 /// is the set of visible rows."
4544 headers: PersistentVec<row_header::RowHeader>,
4545 /// v7.37.15 (Phase C.1) — stable per-relation row identity
4546 /// parallel to `rows` / `headers`. `rowids[i]` is the never-
4547 /// reused [`RowId`](row_header::RowId) of the row physically at
4548 /// slot `i`; `rowids.len() == rows.len()` joins the same load-
4549 /// bearing lock-step invariant as `headers`. Compaction (delete
4550 /// / vacuum) rebuilds all three vecs together so the id travels
4551 /// with the row while the slot shifts.
4552 ///
4553 /// Introduced additively: allocated + kept lock-step, but index
4554 /// locators still address rows by physical slot at this commit.
4555 /// Later phases migrate the lock table (C.4), HOT chains (D),
4556 /// and the WAL (Epic W) to address by `RowId`.
4557 ///
4558 /// Not yet serialised into the envelope — on load every row is
4559 /// assigned a fresh dense id `1..=len` (see `next_rowid`), which
4560 /// is sufficient while the id is process-local bookkeeping. The
4561 /// V6 envelope (Phase C.6) will persist ids so a WAL redo can
4562 /// name a row across restart.
4563 rowids: PersistentVec<row_header::RowId>,
4564 /// v7.37.15 (Phase C.1) — per-relation monotonic allocator for
4565 /// `rowids`. Starts at 1 (0 is the `RowId::UNASSIGNED` sentinel);
4566 /// every append takes `next_rowid` then increments. Never reused
4567 /// even after the row is deleted / vacuumed, so a stale lock /
4568 /// redo reference can be detected rather than silently aliasing a
4569 /// later row that reused the slot.
4570 ///
4571 /// 7.38.1 (S2.4, MATRIX #20 root cause) — the allocator is SHARED
4572 /// across every `clone()` of the relation (`Arc`), because the
4573 /// monotonic-never-reused promise is a LINEAGE invariant: each
4574 /// open transaction's shadow catalog is a clone, and when clones
4575 /// carried private counters two concurrent shadows minted the
4576 /// same id — duplicate rids in the base after both committed,
4577 /// aliasing every rid-addressed mechanism (locks, tombstones,
4578 /// redo, the rebase unique pre-check).
4579 next_rowid: alloc::sync::Arc<core::sync::atomic::AtomicU64>,
4580 /// v7.37.16 (autovacuum) — live count of tombstoned-but-present hot
4581 /// rows (`headers[i].xmax != XMAX_ALIVE`). Maintained incrementally:
4582 /// `mark_row_deleted` / `mark_rows_deleted` increment (the only
4583 /// tombstone producers), `delete_rows_no_index` recomputes over the
4584 /// survivors (it is the compaction hub every physical removal —
4585 /// including vacuum — flows through), and the v53 snapshot loader
4586 /// recounts verbatim-restored headers. Drives the engine's
4587 /// autovacuum threshold; not persisted (recomputed on load).
4588 dead_rows: u64,
4589 /// v7.39 (pg_stat knife A) — volatile per-table write counters
4590 /// backing `pg_stat_user_tables.n_tup_ins/upd/del`. Not persisted
4591 /// (PG's cumulative stats are shared-memory-volatile too — a
4592 /// restart zeroes them).
4593 stat_tup_ins: u64,
4594 stat_tup_upd: u64,
4595 stat_tup_del: u64,
4596 /// v7.39 (pg_stat knife B) — volatile scan counters
4597 /// (`seq_scan/seq_tup_read/idx_scan/idx_tup_fetch`). Atomics: the
4598 /// read paths that bump them hold only `&Table`.
4599 scan_stats: ScanStats,
4600 /// v7.39 (pg_stat knife C) — wall-clock stamps (unix µs, from the
4601 /// host ClockFn) for pg_stat_user_tables' last_autovacuum /
4602 /// last_analyze. Volatile, like PG's cumulative stats. SPG has no
4603 /// manual-VACUUM statement semantics, so last_vacuum stays NULL.
4604 last_autovacuum_us: Option<i64>,
4605 last_analyze_us: Option<i64>,
4606 indices: Vec<Index>,
4607 hot_bytes: u64,
4608 /// v6.7.0 — cached count of rows currently materialised in the
4609 /// cold tier via `RowLocator::Cold` entries across THIS table's
4610 /// indices. Populated by `ANALYZE` (walks every BTree index and
4611 /// counts Cold locators); the count survives until the next
4612 /// ANALYZE recomputes it. Surfaced via `spg_statistic.cold_row_count`
4613 /// and `spg_stat_segment.table_name`.
4614 ///
4615 /// Honest scope: this is a CACHED count, not a live one.
4616 /// Freezer / promote / DELETE don't currently update the cache
4617 /// incrementally — they invalidate it by setting the
4618 /// `cold_row_count_stale` flag, and the next ANALYZE re-walks.
4619 /// Incremental maintenance is a v6.7.x candidate if observation
4620 /// shows the ANALYZE walk cost dominates.
4621 cold_row_count: u64,
4622 /// v6.7.0 — set when the cached `cold_row_count` may be wrong
4623 /// because rows moved into / out of the cold tier since the last
4624 /// ANALYZE. The virtual-table surface reports the cached value
4625 /// regardless (operators run ANALYZE to refresh).
4626 cold_row_count_stale: bool,
4627 /// v7.34 (crash-recovery P0 #2) — row-level redo capture buffer.
4628 /// `None` (default, in-memory mode) captures nothing — zero overhead.
4629 /// `Some` (set by the engine when persistence is on, before a
4630 /// mutating call) makes `insert` / `update_row` / `delete_rows`
4631 /// record the physical [`RowChange`] they applied, which the engine
4632 /// drains after the statement and writes to the WAL in place of the
4633 /// SQL text. Transient: never serialized; a `Catalog::clone` between
4634 /// enable and drain copies it (cheap — empty in the steady state).
4635 redo_log: Option<Vec<RowChange>>,
4636 /// v7.39 (round 215) — per-`EXCLUDE`-constraint range-overlap indexes,
4637 /// one per single-`&&` constraint on an integer-keyable range column.
4638 /// Maintained incrementally on insert / update / rebuild (mirroring the
4639 /// BTree secondary indexes); NOT serialized — rebuilt from the schema's
4640 /// exclusion constraints on load. Empty for tables with no EXCLUDE
4641 /// constraint (the common case), so `Table::clone` pays nothing.
4642 excl_indexes: Vec<ExclRangeIndex>,
4643 /// v7.38.2 (R2) — incremental write-set track for the RC rebase.
4644 /// `extract_tx_writeset` used to full-scan every header per call —
4645 /// ~200 µs on a 20k-row table, per in-transaction statement, every
4646 /// time a concurrent COMMIT moved the epoch; on tpcb's 100k-row
4647 /// accounts that scan was the c2 concurrency cliff itself. The
4648 /// three version-marking funnels (`insert_with_xmin`,
4649 /// `mark_row_deleted`, `mark_rows_deleted`) record here instead.
4650 ///
4651 /// One track per table, keyed by the LAST writer version: a shadow
4652 /// belongs to one transaction, so a different version claiming the
4653 /// table simply replaces the track (on the committed base that
4654 /// makes memory bounded by the last writer's footprint). Extraction
4655 /// verifies every recorded position still carries the version —
4656 /// any mismatch (compaction, inherited track, pre-track rows)
4657 /// falls back to the full scan, so the fast path can be wrong
4658 /// about NOTHING, only slow.
4659 tx_write_track: Option<TxWriteTrack>,
4660 /// v7.39 (round 493) — the snapshot floor below which a deleted row
4661 /// version is invisible to everyone, as of the statement now running.
4662 ///
4663 /// Runtime only: never serialised, and `0` (the default) prunes
4664 /// nothing, so any path that forgets to set it is merely slower, not
4665 /// wrong. The engine sets it from `vacuum_oldest_active()` — the same
4666 /// floor `vacuum` itself takes — before the statement's inserts.
4667 prune_horizon: u64,
4668}
4669
4670/// Catalog: insertion-ordered `Vec<Table>` for stable iter / serialize,
4671/// plus a `BTreeMap<String, usize>` sidecar index so `get` / `get_mut`
4672/// run in O(log n) instead of the old linear scan with per-element
4673/// string compares.
4674///
4675/// A pure `BTreeMap<String, Table>` was tried in an interim version
4676/// of v3.1.2 and regressed the single-table catalog benches by ~10%
4677/// (the per-element `BTreeMap` overhead outweighs the lookup win
4678/// when n is small). The sidecar shape preserves the insertion-order
4679/// iteration the on-disk encoding relies on and keeps `last_mut`
4680/// (used by the deserialize hot path) cheap.
4681/// v7.39 (pg_stat blks knife) — catalog-wide cold-tier read counter
4682/// backing pg_stat_database.blks_read. Row-granular (SPG has no 8 KB
4683/// page notion): one cold-segment row resolution = one "block read",
4684/// one hot row access = one "block hit" — the hit RATIO monitoring
4685/// dashboards compute keeps its meaning. Volatile like PG's stats.
4686#[derive(Debug, Default)]
4687pub struct ColdReadStats {
4688 pub cold_reads: core::sync::atomic::AtomicU64,
4689}
4690
4691impl Clone for ColdReadStats {
4692 fn clone(&self) -> Self {
4693 Self {
4694 cold_reads: core::sync::atomic::AtomicU64::new(
4695 self.cold_reads.load(core::sync::atomic::Ordering::Relaxed),
4696 ),
4697 }
4698 }
4699}
4700
4701/// 7.38.1 S3.1 (D4) — the non-table catalog families that carry a
4702/// per-transaction dirty window (see `Catalog::dirty_nontable`). One
4703/// entry class per side-map the poisoned-commit merge reconciles.
4704#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
4705pub enum NonTableKind {
4706 Sequence,
4707 View,
4708 MaterializedView,
4709 EnumType,
4710 DomainType,
4711 CompositeType,
4712}
4713
4714#[derive(Debug, Clone, Default)]
4715pub struct Catalog {
4716 /// v7.39 (pg_stat blks knife) — see [`ColdReadStats`].
4717 pub cold_read_stats: ColdReadStats,
4718 tables: Vec<Table>,
4719 /// `name → tables[index]`. Kept in lock-step with `tables`.
4720 /// `create_table` is the only write path.
4721 by_name: BTreeMap<String, usize>,
4722 /// v7.39 (round 436) — the current session's temporary-table namespace.
4723 /// A temp table is stored under `<prefix><name>`, and every lookup tries
4724 /// that first: exactly PG's `pg_temp` search-path rule, and MySQL's
4725 /// "a TEMPORARY table shadows a permanent one of the same name".
4726 ///
4727 /// Process-local, never serialised: the engine sets it per session, and
4728 /// a catalog read back from disk starts with none. Kept here rather than
4729 /// at each of the ~170 engine call sites because `by_name` is private —
4730 /// this is the ONE place a table name becomes an index.
4731 temp_prefix: Option<String>,
4732 /// v7.39 (round 496) — the names of tables this catalog handle has had
4733 /// changed since the set was last cleared.
4734 ///
4735 /// Runtime only, never serialised. A transaction's shadow catalog
4736 /// clears it at BEGIN, so at COMMIT the set is exactly the tables the
4737 /// transaction changed — which is what lets a commit that cannot use
4738 /// the row-level merge install only those tables instead of the whole
4739 /// catalog, leaving another session's concurrent work in place.
4740 ///
4741 /// Recorded where the change actually happens (`get_mut`,
4742 /// `create_table`, `drop_table`) rather than from the statement
4743 /// classifier: round 494 tried classification for a correctness gate
4744 /// and it was wrong, because `SELECT lo_write(…)` reads as read-only.
4745 dirty_tables: alloc::collections::BTreeSet<String>,
4746 /// 7.38.1 S3.1 (D4) — the non-table twin of `dirty_tables`: which
4747 /// sequences / views / matviews / enum / domain / composite types
4748 /// THIS window created, altered, renamed or dropped. Counter
4749 /// advances (`nextval`) deliberately do NOT record — counter
4750 /// values merge via `sequence_counters` / `restore_sequence_
4751 /// counters`, and a tx that only consumed ids must not shadow a
4752 /// neighbour's ALTER SEQUENCE. Cleared by `clear_dirty_tables`
4753 /// (one window, both records).
4754 dirty_nontable: alloc::collections::BTreeSet<(NonTableKind, String)>,
4755 /// v7.37.15 (Phase C.1) — monotonic allocator for stable
4756 /// [`RelId`](row_header::RelId)s. Pre-incremented on each
4757 /// `create_table` so real ids start at 1 (0 is `UNASSIGNED`);
4758 /// never reused even after `DROP TABLE`, so a stale lock / redo
4759 /// reference is detectable. Process-local bookkeeping — not yet
4760 /// serialised; `deserialize` re-assigns dense ids on load (the
4761 /// V6 envelope, Phase C.6, will round-trip real ids).
4762 next_rel_id: u64,
4763 /// v5.1: in-memory cold-tier segments. Side-loaded via
4764 /// [`Catalog::load_segment_bytes`] — they live outside the
4765 /// catalog snapshot (caller persists them as separate files
4766 /// and re-loads on boot, until v5.3's `CatalogManifest` makes
4767 /// that wiring automatic). `RowLocator::Cold { segment_id, .. }`
4768 /// indexes this `Vec`. Cleared on `Catalog::new` / fresh
4769 /// `deserialize`.
4770 ///
4771 /// `Arc` wrap keeps `Catalog::clone` at O(N segments) bumps
4772 /// (rather than O(total segment bytes) memcpy) so the v4.42
4773 /// group-commit pre-image rollback invariant — clone is
4774 /// effectively free — survives the cold-tier addition.
4775 ///
4776 /// v6.7.3 — slots became `Option<…>` so cold-segment compaction
4777 /// can tombstone merged sources without breaking the
4778 /// `segment_id = index_into_vec` contract that on-disk
4779 /// `RowLocator::Cold { segment_id }` already serialized.
4780 /// `None` slot = the segment was retired by compaction; the
4781 /// physical file may still be on disk (next CHECKPOINT writes
4782 /// a manifest that no longer lists it, and the file becomes
4783 /// an orphan eligible for offline cleanup).
4784 cold_segments: Vec<Option<Arc<OwnedSegment>>>,
4785 /// v7.12.4 — user-defined functions (PL/pgSQL + SQL).
4786 /// Keyed by function name (PG overloading is out of scope).
4787 /// Bodies are stored as the raw source text the parser saw
4788 /// between `$$ ... $$`; the engine re-parses on each
4789 /// invocation. This keeps `spg-storage` free of `spg-sql`
4790 /// dependency — same pattern as partial-index predicates.
4791 functions: BTreeMap<String, FunctionDef>,
4792 /// v7.12.4 — triggers in insertion order. PG18-measured (round
4793 /// 753): PG fires same-event triggers in NAME order (a_trig
4794 /// before z_trig regardless of creation order); SPG fires in
4795 /// insertion order — a real divergence, ledgered as F31-B2.
4796 triggers: Vec<TriggerDef>,
4797 /// v7.39 (round 139) — query-rewrite RULEs, flat like triggers.
4798 rules: Vec<RuleDef>,
4799 /// v7.39 (round 280) — extended-statistics objects. Recorded so a
4800 /// pg_dump restores them and reflection reports them; the planner
4801 /// does not consult them yet.
4802 statistics_ext: Vec<StatisticsExtDef>,
4803 /// v7.39 (round 287) — server-side large objects, keyed by OID.
4804 /// PG stores them as 2 KB pages in `pg_largeobject`; the page split
4805 /// is a storage detail of ITS heap, so SPG holds the whole byte
4806 /// string and renders the pages on read. What must match is the
4807 /// observable surface: the OIDs, the bytes, and the page rows.
4808 large_objects: alloc::collections::BTreeMap<u32, Vec<u8>>,
4809 /// v7.17.0 — catalogued SEQUENCE objects (Phase 1.1). Each
4810 /// `nextval(name)` reaches in here, atomically increments
4811 /// `last_value` / flips `is_called`, returns the new value.
4812 /// Persisted in catalog FILE_VERSION 26+; older catalogs
4813 /// deserialise with an empty map.
4814 sequences: BTreeMap<String, SequenceDef>,
4815 /// v7.39 (read01 round 60) — the `public` schema's ACL (PG
4816 /// `pg_namespace.nspacl`). EMPTY = PG's default, which is not "nothing":
4817 /// PUBLIC holds USAGE and the owner holds USAGE + CREATE. Materialised on
4818 /// the first GRANT / REVOKE, exactly like a table's relacl.
4819 schema_acl: Vec<AclItem>,
4820 /// v7.39 (read01 round 60) — the database's ACL. EMPTY = PG's default:
4821 /// PUBLIC holds CONNECT + TEMPORARY, the owner holds all three.
4822 database_acl: Vec<AclItem>,
4823 /// v7.17.0 — catalogued VIEW objects (Phase 1.2). Each
4824 /// `SELECT FROM v` at engine exec-time looks up `v` here and
4825 /// prepends the view body as a synthetic CTE. Persisted in
4826 /// catalog FILE_VERSION 27+; older catalogs deserialise with
4827 /// an empty map.
4828 views: BTreeMap<String, ViewDef>,
4829 /// v7.17.0 — catalogued MATERIALIZED VIEW source registry
4830 /// (Phase 1.3). Maps name → SELECT source. The materialised
4831 /// rows themselves live as a regular `Table` with the same
4832 /// name; REFRESH re-parses + re-executes the source against
4833 /// the table. Persisted in catalog FILE_VERSION 28+;
4834 /// older catalogs deserialise with an empty map.
4835 materialized_views: BTreeMap<String, String>,
4836 /// v7.17.0 — catalogued user-defined ENUM types (Phase 1.4).
4837 /// Maps name → label list. Columns reference these by name
4838 /// via `ColumnSchema.user_enum_type`. Persisted in catalog
4839 /// FILE_VERSION 29+; older catalogs deserialise with an empty
4840 /// map.
4841 enum_types: BTreeMap<String, EnumDef>,
4842 /// v7.17.0 — catalogued user-defined DOMAIN types (Phase 1.5).
4843 /// Maps name → base + CHECK constraints. Columns reference
4844 /// these by name via `ColumnSchema.user_domain_type`.
4845 /// Persisted in catalog FILE_VERSION 30+; older catalogs
4846 /// deserialise with an empty map.
4847 domain_types: BTreeMap<String, DomainDef>,
4848 /// v7.39 (read01 round 50) — `COMMENT ON <kind> <obj> IS '…'` store.
4849 /// Keyed by a canonical `"<kind>:<name>"` string (`"table:t"`,
4850 /// `"column:t.c"`, `"index:i"`, `"view:v"`, …) so a new commentable
4851 /// object kind needs no schema change. `COMMENT … IS NULL` removes the
4852 /// entry. Persisted in catalog FILE_VERSION 61+; older catalogs
4853 /// deserialise with an empty map. Read back by obj_description /
4854 /// col_description and the pg_description view.
4855 comments: BTreeMap<String, String>,
4856 /// v7.39 (round 547) — PG's `pg_db_role_setting`: the GUC defaults
4857 /// `ALTER ROLE … SET` / `ALTER DATABASE … SET` record, applied when
4858 /// a session starts.
4859 ///
4860 /// Keyed exactly as PG keys it — `(database, role)` where an empty
4861 /// name is PG's oid 0, meaning "all". So `ALTER ROLE ALL SET` is
4862 /// `("", "")`, `ALTER DATABASE d SET` is `(d, "")`, `ALTER ROLE r
4863 /// SET` is `("", r)` and `ALTER ROLE r IN DATABASE d SET` is
4864 /// `(d, r)`. The value is that scope's parameter list.
4865 db_role_settings: BTreeMap<(String, String), BTreeMap<String, String>>,
4866 /// v7.39 (round 550) — replication slots, by name.
4867 ///
4868 /// A slot in PG is two things: a named record, and a reservation
4869 /// that holds WAL back. SPG keeps the record — which is what every
4870 /// setup script and monitoring query reads — and reports
4871 /// `wal_status = 'unreserved'`, PG's own word for a slot that no
4872 /// longer holds WAL. The whole family used to answer NULL and
4873 /// report success, so `pg_drop_replication_slot('nosuchslot')` said
4874 /// it worked and a setup script created nothing.
4875 ///
4876 /// Value: (plugin, slot_type). `plugin` is empty for a physical slot.
4877 replication_slots: BTreeMap<String, (String, String)>,
4878 /// v7.37.42-T2 ζ-B — catalogued user-defined COMPOSITE types
4879 /// (`CREATE TYPE name AS (field_name field_type, …)`). Columns
4880 /// reference these by name via
4881 /// `ColumnSchema.user_composite_type` (parallel to
4882 /// `user_enum_type` / `user_domain_type`). Persisted in catalog
4883 /// FILE_VERSION 52+; older catalogs deserialise with an empty
4884 /// map.
4885 composite_types: BTreeMap<String, CompositeDef>,
4886 /// v7.17.0 — schema-namespace registry (Phase 1.6). Tracks
4887 /// which schemas exist. `public`, `pg_catalog`, and
4888 /// `information_schema` are built-in and always present.
4889 /// Schema-qualified table references still strip the prefix
4890 /// at lookup time per v7.16-and-earlier — full
4891 /// schema-as-isolation is v7.18+ scope. Persisted in catalog
4892 /// FILE_VERSION 31+; older catalogs deserialise with just
4893 /// the built-ins.
4894 schemas: alloc::collections::BTreeSet<String>,
4895}
4896
4897/// v7.12.4 — catalogued user-defined function. `body` is the raw
4898/// source text between `$$ ... $$`; the engine re-parses it on
4899/// invocation. This keeps the storage codec stable when the
4900/// PL/pgSQL surface grows (no breaking-change risk on the disk
4901/// format).
4902// v7.39 (round 322, V46) — no longer `Eq`: COST / ROWS are f64, as in PG.
4903#[derive(Debug, Clone, PartialEq)]
4904pub struct FunctionDef {
4905 pub name: String,
4906 /// Display form of the argument list, e.g.
4907 /// `"(name TEXT, ts TIMESTAMP)"`. Empty `"()"` for the trigger
4908 /// function shape. Parser-side canonicalised before storage.
4909 pub args_repr: String,
4910 /// Display form of the return type, e.g. `"TRIGGER"` /
4911 /// `"INT"` / `"SETOF text"`. The engine special-cases
4912 /// `"TRIGGER"` (case-insensitive) to gate trigger-only
4913 /// semantics (NEW/OLD).
4914 pub returns: String,
4915 /// `LANGUAGE` clause, lowercased. `"plpgsql"` / `"sql"`.
4916 pub language: String,
4917 /// Source body of the function. PL/pgSQL: includes the
4918 /// surrounding `BEGIN ... END;`. SQL: includes the
4919 /// statement(s). The engine re-parses on invocation; bad
4920 /// bodies surface as a parse error at CALL time, not CREATE.
4921 pub body: String,
4922 /// v7.39 (read01 round 61) — the role that ran CREATE FUNCTION.
4923 pub owner: Option<String>,
4924 /// v7.39 (read01 round 61) — explicit GRANTs (PG `pg_proc.proacl`). EMPTY
4925 /// is NOT "nobody may call it": PG grants EXECUTE to PUBLIC by default, and
4926 /// leaves proacl NULL to say so. The list materialises on the first
4927 /// GRANT / REVOKE.
4928 pub acl: Vec<AclItem>,
4929 /// v7.39 (round 322, V46) — `IMMUTABLE` / `STRICT` / `PARALLEL SAFE` /
4930 /// `SECURITY DEFINER` / `LEAKPROOF` / `COST` / `ROWS`. `strict` is the
4931 /// only one with execution semantics today (a NULL argument yields a
4932 /// NULL result without running the body); the rest are recorded so
4933 /// `pg_get_functiondef` and `pg_proc` report what was declared.
4934 pub volatility: u8,
4935 pub strict: bool,
4936 pub security_definer: bool,
4937 pub leakproof: bool,
4938 pub parallel: u8,
4939 pub cost: Option<f64>,
4940 pub rows: Option<f64>,
4941}
4942
4943/// v7.39 (round 322, V46) — `FunctionDef.volatility` codes: PG's
4944/// `pg_proc.provolatile` letters.
4945pub const FN_VOLATILE: u8 = b'v';
4946pub const FN_IMMUTABLE: u8 = b'i';
4947pub const FN_STABLE: u8 = b's';
4948
4949/// v7.39 (round 322, V46) — `FunctionDef.parallel` codes: PG's
4950/// `pg_proc.proparallel` letters.
4951pub const FN_PARALLEL_UNSAFE: u8 = b'u';
4952pub const FN_PARALLEL_RESTRICTED: u8 = b'r';
4953pub const FN_PARALLEL_SAFE: u8 = b's';
4954
4955/// v7.39 (round 315, V19) — which catalogued function does a persisted
4956/// ACL key refer to?
4957///
4958/// The key was computed by whichever formula was current when the image
4959/// was written, and the multi-word fix changed that formula for bare
4960/// types like `double precision`. A miss therefore does NOT mean "no
4961/// such function": an older image's key would land nowhere and its owner
4962/// and grants would be dropped in silence. Exact match first, then the
4963/// pre-fix formula.
4964#[must_use]
4965pub fn resolve_stored_function_key(
4966 functions: &BTreeMap<String, FunctionDef>,
4967 stored: &str,
4968) -> Option<String> {
4969 if functions.contains_key(stored) {
4970 return Some(stored.to_string());
4971 }
4972 functions
4973 .values()
4974 .find(|f| function_signature_key_legacy(&f.name, &f.args_repr) == stored)
4975 .map(|f| function_signature_key(&f.name, &f.args_repr))
4976}
4977
4978/// v7.39 (round 344, V49) — re-exported from [`spg_sql`], which owns the
4979/// SQL type spellings. This crate carried a byte-identical copy because
4980/// the two were siblings that did not depend on each other; spg-sql is a
4981/// dependency-free leaf, so the dependency is acyclic and the publish
4982/// order already puts it first. One list, one place to keep it right.
4983pub use spg_sql::parser::is_multiword_type_phrase;
4984
4985/// v7.39 (round 315, V19) — the signature key as computed BEFORE the
4986/// multi-word fix, used only to recognise what an older image wrote.
4987///
4988/// The function catalogue recomputes its keys from the stored name and
4989/// argument text on load, so it needs no migration. The ACL block does
4990/// not: it persists the computed key as a string and matches on it. A
4991/// key that changed shape would simply fail to match, and the owner and
4992/// grants would be dropped without a word — so the loader falls back to
4993/// this when the stored key finds nothing.
4994#[must_use]
4995pub fn function_signature_key_legacy(name: &str, args_repr: &str) -> String {
4996 let inner = args_repr
4997 .trim()
4998 .trim_start_matches('(')
4999 .trim_end_matches(')');
5000 let types: Vec<String> = if inner.trim().is_empty() {
5001 Vec::new()
5002 } else {
5003 inner
5004 .split(',')
5005 .map(|part| {
5006 let mut words: Vec<&str> = part.split_whitespace().collect();
5007 if !words.is_empty()
5008 && (words[0].eq_ignore_ascii_case("OUT")
5009 || words[0].eq_ignore_ascii_case("INOUT"))
5010 {
5011 words.remove(0);
5012 }
5013 let ty = if words.len() >= 2 {
5014 words[1..].join(" ")
5015 } else {
5016 words.first().map_or(String::new(), |w| (*w).to_string())
5017 };
5018 normalize_type_name(&ty)
5019 })
5020 .collect()
5021 };
5022 format!("{}({})", name.to_ascii_lowercase(), types.join(","))
5023}
5024
5025pub fn function_signature_key(name: &str, args_repr: &str) -> String {
5026 let types = function_arg_types(args_repr);
5027 format!("{}({})", name.to_ascii_lowercase(), types.join(","))
5028}
5029
5030/// The declared argument TYPES of a function, out of its `args_repr`
5031/// (`"(x INT, y DOUBLE PRECISION)"` → `["int", "float"]`). An entry may be a
5032/// bare type with no name (`"(INT)"`).
5033#[must_use]
5034pub fn function_arg_types(args_repr: &str) -> Vec<String> {
5035 let inner = args_repr
5036 .trim()
5037 .trim_start_matches('(')
5038 .trim_end_matches(')');
5039 if inner.trim().is_empty() {
5040 return Vec::new();
5041 }
5042 inner
5043 .split(',')
5044 .map(|part| {
5045 let mut words: Vec<&str> = part.split_whitespace().collect();
5046 // `OUT x INT` / `INOUT x INT` — the mode is not part of the type.
5047 if !words.is_empty()
5048 && (words[0].eq_ignore_ascii_case("OUT") || words[0].eq_ignore_ascii_case("INOUT"))
5049 {
5050 words.remove(0);
5051 }
5052 // v7.39 (round 315, V19) — two or more words is USUALLY
5053 // `name TYPE`, but not when the type itself is spelled in
5054 // several words. `double precision` was read as a parameter
5055 // named "double" of type "precision", so it keyed differently
5056 // from `x double precision` — the same signature written two
5057 // ways did not resolve to the same function. Decide by asking
5058 // whether the whole phrase names a type first; only then is
5059 // the leading word a parameter name.
5060 let whole = words.join(" ");
5061 let ty = if words.len() >= 2 && !is_multiword_type_phrase(&whole) {
5062 words[1..].join(" ")
5063 } else {
5064 whole
5065 };
5066 normalize_type_name(&ty)
5067 })
5068 .collect()
5069}
5070
5071/// v7.39 (read01 round 65) — the declared argument NAMES of a function (`""` for
5072/// a bare type with no name).
5073#[must_use]
5074pub fn function_arg_names(args_repr: &str) -> Vec<String> {
5075 let inner = args_repr
5076 .trim()
5077 .trim_start_matches('(')
5078 .trim_end_matches(')');
5079 if inner.trim().is_empty() {
5080 return Vec::new();
5081 }
5082 inner
5083 .split(',')
5084 .map(|part| {
5085 let mut words: Vec<&str> = part.split_whitespace().collect();
5086 if !words.is_empty()
5087 && (words[0].eq_ignore_ascii_case("OUT") || words[0].eq_ignore_ascii_case("INOUT"))
5088 {
5089 words.remove(0);
5090 }
5091 if words.len() >= 2 {
5092 words[0].to_string()
5093 } else {
5094 String::new()
5095 }
5096 })
5097 .collect()
5098}
5099
5100/// Fold PG's type aliases so a signature key is stable across spellings.
5101/// Unknown names pass through lower-cased — consistency is what the key needs.
5102#[must_use]
5103pub fn normalize_type_name(ty: &str) -> String {
5104 let t = ty.trim().to_ascii_lowercase();
5105 // Peel a precision/length modifier: `numeric(10,2)`, `varchar(64)`.
5106 let base = t.split_once('(').map_or(t.as_str(), |(h, _)| h).trim();
5107 match base {
5108 "int" | "int4" | "integer" => "int",
5109 "bigint" | "int8" => "bigint",
5110 "smallint" | "int2" => "smallint",
5111 "text" | "varchar" | "character varying" | "char" | "character" | "bpchar" => "text",
5112 "bool" | "boolean" => "bool",
5113 "float" | "float8" | "double precision" => "float",
5114 "real" | "float4" => "real",
5115 "numeric" | "decimal" => "numeric",
5116 "timestamptz" | "timestamp with time zone" => "timestamptz",
5117 "timestamp" | "timestamp without time zone" => "timestamp",
5118 other => other,
5119 }
5120 .to_string()
5121}
5122
5123/// v7.12.4 — catalogued trigger. References its function by
5124/// name; the function must exist at TRIGGER creation time
5125/// (forward references are deferred to v7.12.5+).
5126#[derive(Debug, Clone, PartialEq, Eq)]
5127pub struct TriggerDef {
5128 pub name: String,
5129 /// Watched table. Trigger is dropped when the table drops.
5130 pub table: String,
5131 /// `"BEFORE"` / `"AFTER"` / `"INSTEAD OF"`. Stored as the
5132 /// uppercased keyword so deserialised catalogs round-trip
5133 /// without canonicalisation surprises.
5134 pub timing: String,
5135 /// Each entry is one of `"INSERT"` / `"UPDATE"` / `"DELETE"`
5136 /// / `"TRUNCATE"`. `INSERT OR UPDATE` parses to two entries.
5137 pub events: Vec<String>,
5138 /// `"ROW"` / `"STATEMENT"`. v7.12.4 ships `"ROW"` only;
5139 /// `"STATEMENT"` parses and persists but the executor
5140 /// refuses it at trigger fire time.
5141 pub for_each: String,
5142 /// Name of the PL/pgSQL function to invoke.
5143 pub function: String,
5144 /// v7.13.0 — `UPDATE OF col, col, …` column-list filter
5145 /// (mailrs round-5 G7). Non-empty means the trigger fires
5146 /// only when at least one of these columns appears in the
5147 /// UPDATE's SET list. Empty = no column filter. Stored in
5148 /// catalog FILE_VERSION 23+; older catalogs deserialise with
5149 /// an empty vec.
5150 pub update_columns: Vec<String>,
5151 /// v7.16.1 — whether the trigger fires when its watched
5152 /// event occurs. Toggled by `ALTER TABLE … { ENABLE |
5153 /// DISABLE } TRIGGER …`; pg_dump --disable-triggers wraps
5154 /// every data block with a DISABLE/ENABLE pair so the
5155 /// rows already-computed in prod don't get re-rewritten.
5156 /// Defaults to `true` at CREATE TRIGGER time. Stored in
5157 /// catalog FILE_VERSION 25+; older catalogs deserialise
5158 /// with `enabled = true`.
5159 pub enabled: bool,
5160 /// v7.39 (round 138) — the deparsed `WHEN ( condition )` predicate text
5161 /// (re-parsed at fire time to filter row triggers). Empty = no WHEN.
5162 /// Persisted from FILE_VERSION 70; older catalogs read back empty.
5163 pub when_condition: String,
5164}
5165
5166/// v7.39 (round 280) — one `CREATE STATISTICS` object.
5167#[derive(Debug, Clone, PartialEq, Eq)]
5168pub struct StatisticsExtDef {
5169 pub name: String,
5170 pub table: String,
5171 /// PG's single-letter kinds: `d` ndistinct, `f` dependencies,
5172 /// `m` mcv. PG's default set is all three.
5173 pub kinds: Vec<String>,
5174 pub columns: Vec<String>,
5175}
5176
5177/// v7.39 (round 139) — a catalogued query-rewrite RULE. Stored flat like
5178/// `TriggerDef`, keyed by `(name, table)`. Command / WHEN text is deparsed SQL
5179/// re-parsed at rewrite time (the same round-trip trick as
5180/// `TriggerDef.when_condition`). Persisted from FILE_VERSION 71.
5181#[derive(Debug, Clone, PartialEq, Eq)]
5182pub struct RuleDef {
5183 pub name: String,
5184 pub table: String,
5185 /// Event keyword, uppercased: `INSERT` / `UPDATE` / `DELETE` / `SELECT`.
5186 pub event: String,
5187 /// `true` = `DO INSTEAD`, `false` = `DO ALSO`.
5188 pub instead: bool,
5189 /// Deparsed `WHERE` predicate text; empty = unconditional.
5190 pub when_condition: String,
5191 /// Deparsed DO command statements; empty = `NOTHING`.
5192 pub commands: Vec<String>,
5193}
5194
5195/// v7.17.0 — catalogued SEQUENCE. PG semantics: a counter object
5196/// returning monotonically increasing values via `nextval(name)`.
5197/// `last_value` is the most recent value handed out; `is_called`
5198/// is false until the first `nextval`/`setval`. Stored separately
5199/// from tables in the catalog.
5200#[derive(Debug, Clone, PartialEq, Eq)]
5201pub struct SequenceDef {
5202 pub name: String,
5203 /// Data type — narrows the i64 range. PG default BIGINT.
5204 pub data_type: SequenceDataType,
5205 pub start: i64,
5206 pub increment: i64,
5207 pub min_value: i64,
5208 pub max_value: i64,
5209 pub cache: i64,
5210 pub cycle: bool,
5211 /// `OWNED BY` target — `(table, column)` or NONE.
5212 pub owned_by: Option<(String, String)>,
5213 /// Most recently handed-out value. Meaningless when
5214 /// `is_called == false`; in that case the NEXT `nextval`
5215 /// will return `start`.
5216 pub last_value: i64,
5217 pub is_called: bool,
5218 /// v7.39 (read01 round 60) — the role that ran CREATE SEQUENCE. `None` = an
5219 /// image written before FILE_VERSION 66, which predates sequence owners.
5220 pub owner: Option<String>,
5221 /// v7.39 (read01 round 60) — explicit GRANTs on this sequence. A sequence's
5222 /// meaningful privileges are SELECT (`currval`), UPDATE (`setval`) and
5223 /// USAGE (`nextval`).
5224 pub acl: Vec<AclItem>,
5225}
5226
5227/// v7.17.0 — sequence integer width.
5228#[derive(Debug, Clone, Copy, PartialEq, Eq)]
5229pub enum SequenceDataType {
5230 SmallInt,
5231 Int,
5232 BigInt,
5233}
5234
5235/// v7.17.0 Phase 1.6 — built-in schema names that every Catalog
5236/// understands without an explicit CREATE SCHEMA. Used by
5237/// [`Catalog::schema_exists`] and the engine's schema-qualified
5238/// lookup path.
5239#[must_use]
5240pub fn is_builtin_schema(name: &str) -> bool {
5241 name.eq_ignore_ascii_case("public")
5242 || name.eq_ignore_ascii_case("pg_catalog")
5243 || name.eq_ignore_ascii_case("information_schema")
5244}
5245
5246/// v7.17.0 — parse a PG-canonical UUID text representation into the
5247/// 16-byte network-order layout used by `Value::Uuid`. Accepted input
5248/// shapes (all case-insensitive):
5249/// * Canonical hyphenated 8-4-4-4-12 (`550e8400-e29b-41d4-a716-446655440000`)
5250/// * Unhyphenated 32-char hex (`550e8400e29b41d4a716446655440000`)
5251/// * Either form wrapped in `{ ... }`
5252///
5253/// Returns `None` for any malformed input (wrong length, non-hex
5254/// characters, misplaced hyphens). The caller surfaces a SQL error
5255/// at coercion time — silent acceptance of garbage would mask
5256/// application bugs and is exactly the divergence from PG that
5257/// breaks the 0-change cutover promise.
5258#[must_use]
5259pub fn parse_uuid_str(input: &str) -> Option<[u8; 16]> {
5260 let s = input.trim();
5261 // Strip surrounding braces if present.
5262 let s = if let Some(inner) = s.strip_prefix('{').and_then(|x| x.strip_suffix('}')) {
5263 inner
5264 } else {
5265 s
5266 };
5267 // Two valid shapes after braces are stripped: 32 hex chars or
5268 // the canonical 36-char hyphenated form.
5269 let hex: String = match s.len() {
5270 32 => s.to_ascii_lowercase(),
5271 36 => {
5272 // Hyphens must be exactly at positions 8, 13, 18, 23.
5273 let b = s.as_bytes();
5274 if b[8] != b'-' || b[13] != b'-' || b[18] != b'-' || b[23] != b'-' {
5275 return None;
5276 }
5277 let mut out = String::with_capacity(32);
5278 out.push_str(&s[0..8]);
5279 out.push_str(&s[9..13]);
5280 out.push_str(&s[14..18]);
5281 out.push_str(&s[19..23]);
5282 out.push_str(&s[24..36]);
5283 out.make_ascii_lowercase();
5284 out
5285 }
5286 _ => return None,
5287 };
5288 let bytes = hex.as_bytes();
5289 let mut out = [0u8; 16];
5290 for i in 0..16 {
5291 let hi = hex_nibble(bytes[i * 2])?;
5292 let lo = hex_nibble(bytes[i * 2 + 1])?;
5293 out[i] = (hi << 4) | lo;
5294 }
5295 Some(out)
5296}
5297
5298fn hex_nibble(b: u8) -> Option<u8> {
5299 match b {
5300 b'0'..=b'9' => Some(b - b'0'),
5301 b'a'..=b'f' => Some(10 + b - b'a'),
5302 b'A'..=b'F' => Some(10 + b - b'A'),
5303 _ => None,
5304 }
5305}
5306
5307/// v7.17.0 — render a `Value::Uuid` payload as the canonical
5308/// lowercase 8-4-4-4-12 hyphenated form PG `text` cast surfaces.
5309#[must_use]
5310pub fn format_uuid(b: &[u8; 16]) -> String {
5311 const HEX: &[u8; 16] = b"0123456789abcdef";
5312 let mut out = String::with_capacity(36);
5313 for (i, byte) in b.iter().enumerate() {
5314 if matches!(i, 4 | 6 | 8 | 10) {
5315 out.push('-');
5316 }
5317 out.push(HEX[(byte >> 4) as usize] as char);
5318 out.push(HEX[(byte & 0x0f) as usize] as char);
5319 }
5320 out
5321}
5322
5323/// v7.17.0 Phase 1.5 — catalogued user-defined DOMAIN. A domain
5324/// is a named CHECK-constrained alias over a built-in type;
5325/// columns bound to it inherit the base type plus the CHECK
5326/// predicates + NOT NULL + DEFAULT at INSERT/UPDATE time.
5327/// v7.37.17 (Phase E RC rebase) — the write-set one writer version left
5328/// on a table, addressed by stable [`row_header::RowId`]s so it can be
5329/// replayed onto a fresher clone of the relation whose physical slots
5330/// differ. Produced by [`Table::extract_tx_writeset`], consumed by
5331/// [`Table::replay_tx_writeset`].
5332#[derive(Debug, Clone, Default)]
5333pub struct TxWriteSet {
5334 /// INSERTs and UPDATE-new-versions (`header.xmin == v`).
5335 pub inserted: Vec<(row_header::RowId, Row<'static>)>,
5336 /// DELETE / UPDATE-old-version targets (`header.xmax == v`).
5337 pub tombstoned: Vec<row_header::RowId>,
5338}
5339
5340impl TxWriteSet {
5341 #[must_use]
5342 pub fn is_empty(&self) -> bool {
5343 self.inserted.is_empty() && self.tombstoned.is_empty()
5344 }
5345}
5346
5347/// v7.39 (round 260) — one named CHECK on a domain. PG auto-names an
5348/// unnamed one `<domain>_check`, then `_check1`, `_check2`, … (probed).
5349#[derive(Debug, Clone, PartialEq, Eq)]
5350pub struct DomainCheck {
5351 pub name: String,
5352 /// The predicate source, referencing the pseudo-column `VALUE`.
5353 pub expr: String,
5354}
5355
5356/// `default` / `checks` are stored as Display-form source so
5357/// `spg-storage` stays free of `spg-sql` dependency — same
5358/// pattern as FunctionDef / ViewDef.
5359#[derive(Debug, Clone, PartialEq, Eq)]
5360pub struct DomainDef {
5361 pub name: String,
5362 pub base_type: DataType,
5363 pub nullable: bool,
5364 pub default: Option<String>,
5365 /// v7.39 (round 260) — each CHECK carries its constraint NAME, so
5366 /// `ALTER DOMAIN … DROP CONSTRAINT <name>` can find it and the
5367 /// violation message can report the constraint that actually failed.
5368 /// PG's auto-naming for an unnamed check is `<domain>_check`, then
5369 /// `_check1`, `_check2`, … (probed).
5370 pub checks: Vec<DomainCheck>,
5371 /// v7.39 (round 258/259) — when this domain was declared over ANOTHER
5372 /// domain (`CREATE DOMAIN child AS parent CHECK (…)`), the parent's
5373 /// name. `base_type` is the ultimate scalar type either way, so
5374 /// without this the parent's constraints were invisible and a value
5375 /// violating them was silently accepted. PG checks the whole chain,
5376 /// base-first, and an `ALTER DOMAIN` on the parent takes effect for
5377 /// the child immediately (probed) — so the chain is walked at check
5378 /// time rather than copied at CREATE time. Catalog FILE_VERSION 74+.
5379 pub base_domain: Option<String>,
5380}
5381
5382/// v7.17.0 Phase 1.4 — catalogued user-defined ENUM type. The
5383/// label vector is order-preserving (PG enum ordering follows the
5384/// declared order). At INSERT/UPDATE on a column bound to this
5385/// enum, the engine looks up the value against `labels` and
5386/// rejects non-members.
5387#[derive(Debug, Clone, PartialEq, Eq)]
5388pub struct EnumDef {
5389 pub name: String,
5390 pub labels: Vec<String>,
5391}
5392
5393/// v7.37.42-T2 ζ-B — catalogued user-defined COMPOSITE type
5394/// (`CREATE TYPE name AS (field_name field_type, ...)`). Order
5395/// matters: PG composite literals are positional, and SPG mirrors
5396/// that. Stored as ordered `(name, DataType)` pairs to keep the
5397/// codec straightforward and to allow eventual `Value::Composite`
5398/// bodies to encode positionally. Persisted in catalog FILE_VERSION
5399/// 52+; older catalogs deserialise with an empty composite_types
5400/// map. Composite types can be used as a column type by spelling
5401/// the composite's name; the resolution from
5402/// `ColumnSchema.user_composite_type = Some(name)` happens at the
5403/// engine boundary (parallel to `user_enum_type` /
5404/// `user_domain_type`). The dense storage shape — JSON-text body
5405/// keyed by the composite's field list — keeps the codec free of
5406/// recursive `Value` bodies until the full Value::Composite arena
5407/// migration in a later phase.
5408#[derive(Debug, Clone, PartialEq, Eq)]
5409pub struct CompositeDef {
5410 pub name: String,
5411 /// Ordered `(field_name, field_type)` pairs. PG composite
5412 /// literals are positional, so order is part of the type's
5413 /// identity.
5414 pub fields: Vec<(String, DataType)>,
5415 /// v7.39 (round 264) — parallel to `fields`: the USER type name of
5416 /// each field when it is itself a composite (or another named user
5417 /// type). `DataType` has no room for one, so a nested composite
5418 /// field resolved to the parser's Text placeholder and the inner
5419 /// record stayed TEXT — `(x).inner.street` errored, `pg_typeof`
5420 /// said text, and `row_to_json` nested a string instead of an
5421 /// object. Same shape as `ColumnSchema.user_composite_type` and
5422 /// `DomainDef.base_domain`. Catalog FILE_VERSION 76+; an older
5423 /// catalog reads all-None, which is what it meant.
5424 pub field_user_types: Vec<Option<String>>,
5425}
5426
5427/// v7.17.0 Phase 1.2 — catalogued VIEW. The body is stored as the
5428/// raw source text the parser saw between `AS` and the statement
5429/// terminator; the engine re-parses on each invocation. Same
5430/// pattern as `FunctionDef` — keeps `spg-storage` free of
5431/// `spg-sql` dependency.
5432#[derive(Debug, Clone, PartialEq, Eq)]
5433pub struct ViewDef {
5434 pub name: String,
5435 /// Optional `(col, col, …)` rename list. Empty when the body's
5436 /// projected names are used directly.
5437 pub columns: Vec<String>,
5438 /// Raw SELECT source. Display-rendered at storage time so the
5439 /// catalog round-trips a deterministic form regardless of
5440 /// whitespace / comments in the original input. Re-parsed at
5441 /// SELECT-from-view time to materialise as a synthetic CTE.
5442 pub body: String,
5443 /// v7.39 (round 132) — `WITH CHECK OPTION`: 0 = none, 1 = LOCAL,
5444 /// 2 = CASCADED. A storage-local u8 (no dependency on the SQL AST).
5445 /// Persisted from FILE_VERSION 69; older catalogs read back as 0.
5446 pub check_option: u8,
5447}
5448
5449impl SequenceDataType {
5450 /// PG default min/max per AS clause.
5451 pub fn default_bounds(self, increment_positive: bool) -> (i64, i64) {
5452 match self {
5453 Self::SmallInt => {
5454 if increment_positive {
5455 (1, i64::from(i16::MAX))
5456 } else {
5457 (i64::from(i16::MIN), -1)
5458 }
5459 }
5460 Self::Int => {
5461 if increment_positive {
5462 (1, i64::from(i32::MAX))
5463 } else {
5464 (i64::from(i32::MIN), -1)
5465 }
5466 }
5467 Self::BigInt => {
5468 if increment_positive {
5469 (1, i64::MAX)
5470 } else {
5471 (i64::MIN, -1)
5472 }
5473 }
5474 }
5475 }
5476}
5477
5478impl Catalog {
5479 /// v7.37.15 (Phase D) — fleet-wide vacuum pass. Walks every
5480 /// user table and reclaims rows whose delete-commit version is
5481 /// older than `oldest_active_snapshot`. Returns an aggregated
5482 /// report with per-table breakdown so hosts can emit metrics.
5483 ///
5484 /// `dry_run = true` reports the work without doing it. Use it
5485 /// to estimate the cost before scheduling a real pass.
5486 pub fn vacuum_all(
5487 &mut self,
5488 oldest_active_snapshot: u64,
5489 dry_run: bool,
5490 ) -> vacuum::VacuumReport {
5491 let mut total = vacuum::VacuumReport::default();
5492 // Snapshot the table names so we don't hold an immutable
5493 // borrow during the get_mut loop.
5494 let names: Vec<String> = self
5495 .tables
5496 .iter()
5497 .map(|t| t.schema().name.clone())
5498 .collect();
5499 for name in names {
5500 let Some(t) = self.get_mut(&name) else {
5501 continue;
5502 };
5503 let r = t.vacuum(oldest_active_snapshot, dry_run);
5504 if r.rows_reclaimed > 0 {
5505 total.per_table.push((name, r.rows_reclaimed));
5506 }
5507 total.rows_reclaimed += r.rows_reclaimed;
5508 total.rows_examined += r.rows_examined;
5509 }
5510 total
5511 }
5512
5513 pub const fn new() -> Self {
5514 Self {
5515 cold_read_stats: ColdReadStats {
5516 cold_reads: core::sync::atomic::AtomicU64::new(0),
5517 },
5518 tables: Vec::new(),
5519 by_name: BTreeMap::new(),
5520 temp_prefix: None,
5521 dirty_tables: alloc::collections::BTreeSet::new(),
5522 dirty_nontable: alloc::collections::BTreeSet::new(),
5523 next_rel_id: 0,
5524 cold_segments: Vec::new(),
5525 functions: BTreeMap::new(),
5526 triggers: Vec::new(),
5527 rules: Vec::new(),
5528 statistics_ext: Vec::new(),
5529 large_objects: alloc::collections::BTreeMap::new(),
5530 sequences: BTreeMap::new(),
5531 schema_acl: Vec::new(),
5532 database_acl: Vec::new(),
5533 views: BTreeMap::new(),
5534 materialized_views: BTreeMap::new(),
5535 enum_types: BTreeMap::new(),
5536 domain_types: BTreeMap::new(),
5537 comments: BTreeMap::new(),
5538 db_role_settings: BTreeMap::new(),
5539 replication_slots: BTreeMap::new(),
5540 composite_types: BTreeMap::new(),
5541 schemas: alloc::collections::BTreeSet::new(),
5542 }
5543 }
5544
5545 /// v7.12.4 — read-only view of catalogued user-defined
5546 /// functions. Engine callers go through here to look up the
5547 /// function body before re-parsing it for invocation.
5548 pub const fn functions(&self) -> &BTreeMap<String, FunctionDef> {
5549 &self.functions
5550 }
5551
5552 /// v7.12.4 — register a new user-defined function. With
5553 /// `or_replace = false`, errors if the name is taken. The
5554 /// engine validates the body before passing it here.
5555 pub fn create_function(
5556 &mut self,
5557 def: FunctionDef,
5558 or_replace: bool,
5559 ) -> Result<(), StorageError> {
5560 // v7.39 (read01 round 62) — functions are keyed by SIGNATURE, not by
5561 // name: `f(int)` and `f(text)` are two functions, as in PG. Keying by
5562 // name alone made a second overload an "already exists" error — so a
5563 // pg_dump carrying an overload set could not restore — and, worse, a
5564 // call to one overload silently ran the other.
5565 let key = function_signature_key(&def.name, &def.args_repr);
5566 if !or_replace && self.functions.contains_key(&key) {
5567 return Err(StorageError::Corrupt(format!(
5568 "function {:?} already exists (drop or use CREATE OR REPLACE)",
5569 def.name
5570 )));
5571 }
5572 self.functions.insert(key, def);
5573 Ok(())
5574 }
5575
5576 /// v7.39 (read01 round 62) — every overload of `name`.
5577 #[must_use]
5578 pub fn functions_named(&self, name: &str) -> Vec<&FunctionDef> {
5579 self.functions
5580 .values()
5581 .filter(|f| f.name.eq_ignore_ascii_case(name))
5582 .collect()
5583 }
5584
5585 /// v7.39 (read01 round 62) — one overload, by its signature key.
5586 #[must_use]
5587 pub fn function_by_key(&self, key: &str) -> Option<&FunctionDef> {
5588 self.functions.get(key)
5589 }
5590
5591 /// v7.39 (read01 round 62) — drop ONE overload. `true` if it was there.
5592 pub fn drop_function_by_key(&mut self, key: &str) -> bool {
5593 self.functions.remove(key).is_some()
5594 }
5595
5596 /// v7.12.4 — remove a user-defined function by name. Returns
5597 /// `true` if a function was removed, `false` if none matched.
5598 /// Caller decides whether to surface `if_exists` semantics.
5599 /// v7.39 (read01 round 62) — with no signature, PG drops the function only
5600 /// when the name is unambiguous. SPG mirrors that: this removes EVERY
5601 /// overload of `name`, and the caller (ddl.rs) refuses the ambiguous case
5602 /// before getting here.
5603 pub fn drop_function(&mut self, name: &str) -> bool {
5604 let keys: Vec<String> = self
5605 .functions
5606 .iter()
5607 .filter(|(_, f)| f.name.eq_ignore_ascii_case(name))
5608 .map(|(k, _)| k.clone())
5609 .collect();
5610 let hit = !keys.is_empty();
5611 for k in keys {
5612 self.functions.remove(&k);
5613 }
5614 hit
5615 }
5616
5617 /// v7.17.0 — read-only handle to catalogued sequences.
5618 /// v7.39 (read01 round 60) — the `public` schema's ACL (PG nspacl).
5619 #[must_use]
5620 pub fn schema_acl(&self) -> &[AclItem] {
5621 &self.schema_acl
5622 }
5623
5624 pub fn schema_acl_mut(&mut self) -> &mut Vec<AclItem> {
5625 &mut self.schema_acl
5626 }
5627
5628 /// v7.39 (read01 round 60) — the database's ACL.
5629 #[must_use]
5630 pub fn database_acl(&self) -> &[AclItem] {
5631 &self.database_acl
5632 }
5633
5634 pub fn database_acl_mut(&mut self) -> &mut Vec<AclItem> {
5635 &mut self.database_acl
5636 }
5637
5638 /// v7.39 (read01 round 60) — mutable sequence access, for GRANT.
5639 /// v7.39 (round 469) — resolves the session's temporary sequence
5640 /// first, like its read-only twin. `nextval` and `setval` reach the
5641 /// map through here, so a temporary sequence shadowing a permanent one
5642 /// advances the temporary one — measured against PG18, where the
5643 /// permanent sequence's counter is untouched while the temp exists.
5644 pub fn sequence_mut(&mut self, name: &str) -> Option<&mut SequenceDef> {
5645 let key = self.sequence_key(name);
5646 self.sequences.get_mut(&key)
5647 }
5648
5649 /// v7.39 (read01 round 61) — mutable function access, for GRANT.
5650 pub fn function_mut(&mut self, name: &str) -> Option<&mut FunctionDef> {
5651 self.functions.get_mut(name)
5652 }
5653
5654 /// Every catalogued sequence, temp ones included under their mangled
5655 /// storage names. Listing code filters these through
5656 /// [`Self::listed_name`]; anything resolving ONE name by its logical
5657 /// spelling wants [`Self::sequence`] instead.
5658 pub const fn sequences_all(&self) -> &BTreeMap<String, SequenceDef> {
5659 &self.sequences
5660 }
5661
5662 /// v7.39 (round 469) — resolve one sequence by its logical name, the
5663 /// session's temporary one winning over a permanent one of the same
5664 /// name. The same rule [`Self::resolve_index`] applies to tables.
5665 #[must_use]
5666 pub fn sequence(&self, name: &str) -> Option<&SequenceDef> {
5667 if let Some(mangled) = self.temp_name_for(name)
5668 && let Some(def) = self.sequences.get(&mangled)
5669 {
5670 return Some(def);
5671 }
5672 self.sequences.get(name)
5673 }
5674
5675 /// Does a sequence of this logical name exist for this session?
5676 #[must_use]
5677 pub fn has_sequence(&self, name: &str) -> bool {
5678 self.sequence(name).is_some()
5679 }
5680
5681 /// The storage key a sequence of this logical name resolves to — the
5682 /// session's temp mangling when it has one, else the name itself.
5683 #[must_use]
5684 pub fn sequence_key(&self, name: &str) -> String {
5685 if let Some(mangled) = self.temp_name_for(name)
5686 && self.sequences.contains_key(&mangled)
5687 {
5688 return mangled;
5689 }
5690 name.into()
5691 }
5692
5693 /// v7.17.0 — register a new SEQUENCE. Errors if `name`
5694 /// collides with an existing sequence and `if_not_exists`
5695 /// is false.
5696 pub fn create_sequence(
5697 &mut self,
5698 def: SequenceDef,
5699 if_not_exists: bool,
5700 ) -> Result<(), StorageError> {
5701 if self.sequences.contains_key(&def.name) {
5702 if if_not_exists {
5703 return Ok(());
5704 }
5705 // v7.39 (read01 round 47) — a sequence is a relation to PG (42P07).
5706 return Err(StorageError::Corrupt(format!(
5707 "relation {:?} already exists",
5708 def.name
5709 )));
5710 }
5711 self.mark_nontable_dirty(NonTableKind::Sequence, &def.name);
5712 self.sequences.insert(def.name.clone(), def);
5713 Ok(())
5714 }
5715
5716 /// v7.17.0 — remove a SEQUENCE by name. Returns `true` if a
5717 /// sequence was removed, `false` if none matched. Caller
5718 /// surfaces IF EXISTS semantics.
5719 /// v7.39 (read01 round 49) — `ALTER SEQUENCE old RENAME TO new`.
5720 /// Errors when `old` is missing or `new` is taken; the SequenceDef's own
5721 /// `name` field is rewritten so it stays self-describing.
5722 pub fn rename_sequence(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
5723 if !self.sequences.contains_key(old) {
5724 return Err(StorageError::Corrupt(format!(
5725 "relation {old:?} does not exist"
5726 )));
5727 }
5728 if self.sequences.contains_key(new) {
5729 return Err(StorageError::Corrupt(format!(
5730 "relation {new:?} already exists"
5731 )));
5732 }
5733 self.mark_nontable_dirty(NonTableKind::Sequence, old);
5734 self.mark_nontable_dirty(NonTableKind::Sequence, new);
5735 if let Some(mut def) = self.sequences.remove(old) {
5736 def.name = new.to_string();
5737 self.sequences.insert(new.to_string(), def);
5738 }
5739 Ok(())
5740 }
5741
5742 pub fn drop_sequence(&mut self, name: &str) -> bool {
5743 self.mark_nontable_dirty(NonTableKind::Sequence, name);
5744 self.sequences.remove(name).is_some()
5745 }
5746
5747 /// v7.17.0 — atomic nextval. Increments `last_value` per
5748 /// `increment`, returns the new value, sets `is_called`.
5749 /// Returns an error on CYCLE-less overflow.
5750 /// v7.39 (round 497) — the counter state of every sequence, for
5751 /// carrying across a commit install.
5752 ///
5753 /// A sequence's VALUE is not transactional in PG: `nextval` advances
5754 /// shared state that a rollback does not give back, because two
5755 /// sessions must never receive the same number. SPG keeps sequences in
5756 /// the catalog, and a transaction works on a catalog CLONE, so
5757 /// installing that clone at COMMIT would restore whatever the counter
5758 /// was at BEGIN. These two let the install put the live counters back.
5759 #[must_use]
5760 pub fn sequence_counters(&self) -> Vec<(String, i64, bool)> {
5761 self.sequences
5762 .iter()
5763 .map(|(k, d)| (k.clone(), d.last_value, d.is_called))
5764 .collect()
5765 }
5766
5767 /// Restore counters saved by [`Self::sequence_counters`], for the
5768 /// sequences that still exist. A sequence the transaction CREATED is
5769 /// absent from the saved set and keeps the value it was given.
5770 pub fn restore_sequence_counters(&mut self, saved: &[(String, i64, bool)]) {
5771 for (k, last, called) in saved {
5772 if let Some(d) = self.sequences.get_mut(k) {
5773 d.last_value = *last;
5774 d.is_called = *called;
5775 }
5776 }
5777 }
5778
5779 pub fn sequence_next_value(&mut self, name: &str) -> Result<i64, StorageError> {
5780 let key = self.sequence_key(name);
5781 let Some(seq) = self.sequences.get_mut(&key) else {
5782 return Err(StorageError::TableNotFound { name: name.into() });
5783 };
5784 // PG semantics: when !is_called (fresh sequence or
5785 // setval(_, false)), the next nextval returns the stored
5786 // `last_value`. When is_called, it advances by `increment`
5787 // and CYCLE-wraps on overflow.
5788 let candidate = if seq.is_called {
5789 let next = seq.last_value.checked_add(seq.increment).ok_or_else(|| {
5790 StorageError::Corrupt(format!("sequence {name:?} arithmetic overflow"))
5791 })?;
5792 if seq.increment > 0 {
5793 if next > seq.max_value {
5794 if seq.cycle {
5795 seq.min_value
5796 } else {
5797 // v7.39 (round 220) — PG's 2200H wording, not a
5798 // Corrupt-classed error.
5799 return Err(StorageError::SequenceExhausted {
5800 name: name.into(),
5801 limit: seq.max_value,
5802 is_max: true,
5803 });
5804 }
5805 } else {
5806 next
5807 }
5808 } else if next < seq.min_value {
5809 if seq.cycle {
5810 seq.max_value
5811 } else {
5812 return Err(StorageError::SequenceExhausted {
5813 name: name.into(),
5814 limit: seq.min_value,
5815 is_max: false,
5816 });
5817 }
5818 } else {
5819 next
5820 }
5821 } else {
5822 seq.last_value
5823 };
5824 seq.last_value = candidate;
5825 seq.is_called = true;
5826 Ok(candidate)
5827 }
5828
5829 /// v7.17.0 — currval. Errors if the session has never called
5830 /// nextval on this sequence (PG semantics). At the catalog
5831 /// level we approximate "session" with "is_called persisted";
5832 /// the engine session-tracking layer can wrap this for the
5833 /// strict per-session semantics later.
5834 pub fn sequence_current_value(&self, name: &str) -> Result<i64, StorageError> {
5835 let Some(seq) = self.sequences.get(name) else {
5836 return Err(StorageError::TableNotFound { name: name.into() });
5837 };
5838 if !seq.is_called {
5839 return Err(StorageError::Corrupt(format!(
5840 "currval of sequence {name:?} is not yet defined in this session"
5841 )));
5842 }
5843 Ok(seq.last_value)
5844 }
5845
5846 /// v7.17.0 — setval(name, value [, is_called]). PG returns
5847 /// `value` regardless. `is_called=true` means the NEXT
5848 /// nextval will return `value + increment`; `is_called=false`
5849 /// means the next nextval will return `value`.
5850 pub fn sequence_set_value(
5851 &mut self,
5852 name: &str,
5853 value: i64,
5854 is_called: bool,
5855 ) -> Result<i64, StorageError> {
5856 let key = self.sequence_key(name);
5857 let Some(seq) = self.sequences.get_mut(&key) else {
5858 return Err(StorageError::TableNotFound { name: name.into() });
5859 };
5860 // v7.39 (round 244) — PG refuses a value outside the sequence's
5861 // range (22003); SPG accepted it silently, leaving last_value out
5862 // of bounds.
5863 if value < seq.min_value || value > seq.max_value {
5864 return Err(StorageError::Unsupported(format!(
5865 "setval: value {value} is out of bounds for sequence \"{name}\" ({}..{})",
5866 seq.min_value, seq.max_value
5867 )));
5868 }
5869 seq.last_value = value;
5870 seq.is_called = is_called;
5871 Ok(value)
5872 }
5873
5874 /// v7.17.0 Phase 1.2 — read-only handle to catalogued views. Temp ones
5875 /// are in here under their mangled storage names; listing code filters
5876 /// through [`Self::listed_name`], and anything resolving ONE name by
5877 /// its logical spelling wants [`Self::view`].
5878 pub const fn views_all(&self) -> &BTreeMap<String, ViewDef> {
5879 &self.views
5880 }
5881
5882 /// v7.39 (round 469) — resolve one view by its logical name, the
5883 /// session's temporary one winning over a permanent one of the same
5884 /// name.
5885 #[must_use]
5886 pub fn view(&self, name: &str) -> Option<&ViewDef> {
5887 if let Some(mangled) = self.temp_name_for(name)
5888 && let Some(def) = self.views.get(&mangled)
5889 {
5890 return Some(def);
5891 }
5892 self.views.get(name)
5893 }
5894
5895 /// Does a view of this logical name exist for this session?
5896 #[must_use]
5897 pub fn has_view(&self, name: &str) -> bool {
5898 self.view(name).is_some()
5899 }
5900
5901 /// The storage key a view of this logical name resolves to.
5902 #[must_use]
5903 pub fn view_key(&self, name: &str) -> String {
5904 if let Some(mangled) = self.temp_name_for(name)
5905 && self.views.contains_key(&mangled)
5906 {
5907 return mangled;
5908 }
5909 name.into()
5910 }
5911
5912 /// v7.17.0 Phase 1.2 — install a VIEW. `or_replace=true`
5913 /// overwrites an existing entry; `if_not_exists=true` is a
5914 /// silent no-op when the name is taken. Errors if both flags
5915 /// are off and the name collides.
5916 pub fn create_view(
5917 &mut self,
5918 def: ViewDef,
5919 or_replace: bool,
5920 if_not_exists: bool,
5921 ) -> Result<(), StorageError> {
5922 if self.views.contains_key(&def.name) {
5923 if or_replace {
5924 self.mark_nontable_dirty(NonTableKind::View, &def.name);
5925 self.mark_nontable_dirty(NonTableKind::View, &def.name);
5926 self.views.insert(def.name.clone(), def);
5927 return Ok(());
5928 }
5929 if if_not_exists {
5930 return Ok(());
5931 }
5932 // v7.39 (read01 round 47) — a view is a relation to PG (42P07).
5933 return Err(StorageError::Corrupt(format!(
5934 "relation {:?} already exists",
5935 def.name
5936 )));
5937 }
5938 // Reject name collision with tables / sequences — same
5939 // namespace per PG.
5940 if self.by_name.contains_key(&def.name) {
5941 return Err(StorageError::Corrupt(format!(
5942 "view {:?} would shadow an existing table",
5943 def.name
5944 )));
5945 }
5946 if self.sequences.contains_key(&def.name) {
5947 return Err(StorageError::Corrupt(format!(
5948 "view {:?} would shadow an existing sequence",
5949 def.name
5950 )));
5951 }
5952 self.views.insert(def.name.clone(), def);
5953 Ok(())
5954 }
5955
5956 /// v7.17.0 Phase 1.2 — remove a view by name. Returns true if
5957 /// a view was removed.
5958 pub fn drop_view(&mut self, name: &str) -> bool {
5959 self.mark_nontable_dirty(NonTableKind::View, name);
5960 self.views.remove(name).is_some()
5961 }
5962
5963 /// v7.17.0 Phase 1.3 — read-only handle to the materialised-
5964 /// view source registry. Each entry pairs with a regular
5965 /// table of the same name that holds the cached rows.
5966 pub const fn materialized_views(&self) -> &BTreeMap<String, String> {
5967 &self.materialized_views
5968 }
5969
5970 /// v7.17.0 Phase 1.3 — register a source for a materialised
5971 /// view. Caller has already created the backing table.
5972 pub fn register_materialized_view(&mut self, name: String, body: String) {
5973 self.mark_nontable_dirty(NonTableKind::MaterializedView, &name);
5974 self.materialized_views.insert(name, body);
5975 }
5976
5977 /// v7.17.0 Phase 1.3 — drop the source registry entry. Returns
5978 /// true if a source was unregistered. Caller separately drops
5979 /// the backing table.
5980 pub fn drop_materialized_view_source(&mut self, name: &str) -> bool {
5981 self.mark_nontable_dirty(NonTableKind::MaterializedView, name);
5982 self.materialized_views.remove(name).is_some()
5983 }
5984
5985 /// v7.17.0 Phase 1.4 — read-only handle to user-defined ENUM
5986 /// catalog.
5987 pub const fn enum_types(&self) -> &BTreeMap<String, EnumDef> {
5988 &self.enum_types
5989 }
5990
5991 /// v7.17.0 Phase 1.4 — install a new ENUM type. Errors if
5992 /// `name` collides with an existing enum (no IF NOT EXISTS
5993 /// per PG semantics for CREATE TYPE).
5994 pub fn create_enum_type(&mut self, def: EnumDef) -> Result<(), StorageError> {
5995 if self.enum_types.contains_key(&def.name) {
5996 return Err(StorageError::Corrupt(format!(
5997 "type {:?} already exists",
5998 def.name
5999 )));
6000 }
6001 self.mark_nontable_dirty(NonTableKind::EnumType, &def.name);
6002 self.enum_types.insert(def.name.clone(), def);
6003 Ok(())
6004 }
6005
6006 /// v7.17.0 Phase 1.4 — drop an ENUM type by name. Returns
6007 /// true if a type was removed.
6008 /// v7.37 D.55 — `ALTER TYPE … ADD VALUE`. Appends `label` to an existing
6009 /// enum's ordered label list, or inserts it before/after an existing label.
6010 /// `if_not_exists` makes a duplicate a no-op; otherwise a duplicate errors.
6011 /// Returns `Ok(true)` if a label was added, `Ok(false)` if it already existed
6012 /// (only possible under `if_not_exists`).
6013 /// v7.39 (read01 round 49) — `ALTER TYPE t RENAME VALUE 'old' TO 'new'`.
6014 /// The parser used to swallow this form as a no-op, so the rename was
6015 /// accepted and silently ignored. Renaming in place keeps the label's
6016 /// sort position, which is what PG does (enumsortorder is untouched).
6017 pub fn rename_enum_value(
6018 &mut self,
6019 type_name: &str,
6020 old: &str,
6021 new: &str,
6022 ) -> Result<(), StorageError> {
6023 let def = self
6024 .enum_types
6025 .get_mut(type_name)
6026 .ok_or_else(|| StorageError::Corrupt(format!("type {type_name:?} does not exist")))?;
6027 if def.labels.iter().any(|l| l == new) {
6028 return Err(StorageError::Corrupt(format!(
6029 "enum label {new:?} already exists"
6030 )));
6031 }
6032 let at = def.labels.iter().position(|l| l == old).ok_or_else(|| {
6033 StorageError::Corrupt(format!("{old:?} is not an existing enum label"))
6034 })?;
6035 def.labels[at] = new.to_string();
6036 Ok(())
6037 }
6038
6039 /// v7.39 (read01 round 50) — set (or, with `None`, remove) the comment on
6040 /// an object. `key` is the canonical `"<kind>:<name>"` form.
6041 pub fn set_comment(&mut self, key: &str, text: Option<&str>) {
6042 match text {
6043 Some(t) => {
6044 self.comments.insert(key.to_string(), t.to_string());
6045 }
6046 None => {
6047 self.comments.remove(key);
6048 }
6049 }
6050 }
6051
6052 /// v7.39 (read01 round 50) — the comment on an object, if any.
6053 #[must_use]
6054 pub fn comment(&self, key: &str) -> Option<&str> {
6055 self.comments.get(key).map(String::as_str)
6056 }
6057
6058 /// v7.39 (round 547) — record a GUC default for a scope. An empty
6059 /// database or role name is PG's oid 0 ("all"). `None` value
6060 /// removes just that parameter, as PG's RESET does.
6061 pub fn set_db_role_setting(
6062 &mut self,
6063 database: &str,
6064 role: &str,
6065 param: &str,
6066 value: Option<&str>,
6067 ) {
6068 let key = (database.to_string(), role.to_string());
6069 match value {
6070 Some(v) => {
6071 self.db_role_settings
6072 .entry(key)
6073 .or_default()
6074 .insert(param.to_ascii_lowercase(), v.to_string());
6075 }
6076 None => {
6077 if let Some(m) = self.db_role_settings.get_mut(&key) {
6078 m.remove(¶m.to_ascii_lowercase());
6079 if m.is_empty() {
6080 self.db_role_settings.remove(&key);
6081 }
6082 }
6083 }
6084 }
6085 }
6086
6087 /// v7.39 (round 550) — create a replication slot. `Err` carries
6088 /// PG's own message for a duplicate.
6089 ///
6090 /// # Errors
6091 /// When a slot of that name already exists.
6092 pub fn create_replication_slot(
6093 &mut self,
6094 name: &str,
6095 plugin: &str,
6096 slot_type: &str,
6097 ) -> Result<(), String> {
6098 if self.replication_slots.contains_key(name) {
6099 return Err(alloc::format!("replication slot \"{name}\" already exists"));
6100 }
6101 self.replication_slots.insert(
6102 name.to_string(),
6103 (plugin.to_string(), slot_type.to_string()),
6104 );
6105 Ok(())
6106 }
6107
6108 /// # Errors
6109 /// When no slot of that name exists — PG's message, and the case
6110 /// that used to report success.
6111 pub fn drop_replication_slot(&mut self, name: &str) -> Result<(), String> {
6112 if self.replication_slots.remove(name).is_none() {
6113 return Err(alloc::format!("replication slot \"{name}\" does not exist"));
6114 }
6115 Ok(())
6116 }
6117
6118 #[must_use]
6119 pub const fn replication_slots(&self) -> &BTreeMap<String, (String, String)> {
6120 &self.replication_slots
6121 }
6122
6123 /// PG's RESET ALL: drops this scope's whole entry, leaving the
6124 /// other scopes alone — measured on PG18, where `ALTER ROLE r RESET
6125 /// ALL` left the ALL, the database and the role-in-database rows.
6126 pub fn reset_db_role_settings(&mut self, database: &str, role: &str) {
6127 self.db_role_settings
6128 .remove(&(database.to_string(), role.to_string()));
6129 }
6130
6131 #[must_use]
6132 pub const fn db_role_settings(&self) -> &BTreeMap<(String, String), BTreeMap<String, String>> {
6133 &self.db_role_settings
6134 }
6135
6136 /// v7.39 (read01 round 50) — every `(key, text)` pair, for the
6137 /// pg_description view.
6138 #[must_use]
6139 pub const fn comments(&self) -> &BTreeMap<String, String> {
6140 &self.comments
6141 }
6142
6143 /// v7.39 (read01 round 50) — drop every comment whose key names `obj`
6144 /// (the object itself and, for a table, its columns). Called when the
6145 /// object is dropped so a later object of the same name doesn't inherit
6146 /// a stale comment.
6147 pub fn drop_comments_for(&mut self, kind: &str, name: &str) {
6148 let exact = alloc::format!("{kind}:{name}");
6149 let col_prefix = alloc::format!("column:{name}.");
6150 self.comments
6151 .retain(|k, _| *k != exact && !k.starts_with(&col_prefix));
6152 }
6153
6154 pub fn add_enum_value(
6155 &mut self,
6156 type_name: &str,
6157 label: &str,
6158 if_not_exists: bool,
6159 position: Option<(bool, String)>,
6160 ) -> Result<bool, StorageError> {
6161 self.mark_nontable_dirty(NonTableKind::EnumType, type_name);
6162 let def = self
6163 .enum_types
6164 .get_mut(type_name)
6165 .ok_or_else(|| StorageError::Corrupt(format!("type {type_name:?} does not exist")))?;
6166 if def.labels.iter().any(|l| l == label) {
6167 if if_not_exists {
6168 return Ok(false);
6169 }
6170 // v7.39 (read01 round 49) — PG wording (42710 at the wire).
6171 return Err(StorageError::Corrupt(format!(
6172 "enum label {label:?} already exists"
6173 )));
6174 }
6175 match position {
6176 None => def.labels.push(label.to_string()),
6177 Some((is_before, anchor)) => {
6178 let at = def
6179 .labels
6180 .iter()
6181 .position(|l| l == &anchor)
6182 .ok_or_else(|| {
6183 StorageError::Corrupt(format!(
6184 "enum label {anchor:?} does not exist in type {type_name:?}"
6185 ))
6186 })?;
6187 let idx = if is_before { at } else { at + 1 };
6188 def.labels.insert(idx, label.to_string());
6189 }
6190 }
6191 Ok(true)
6192 }
6193
6194 pub fn drop_enum_type(&mut self, name: &str) -> bool {
6195 self.mark_nontable_dirty(NonTableKind::EnumType, name);
6196 self.enum_types.remove(name).is_some()
6197 }
6198
6199 /// v7.17.0 Phase 1.5 — read-only handle to DOMAIN catalog.
6200 pub const fn domain_types(&self) -> &BTreeMap<String, DomainDef> {
6201 &self.domain_types
6202 }
6203
6204 /// v7.17.0 Phase 1.5 — install a DOMAIN. Errors on collision
6205 /// with an existing domain.
6206 pub fn create_domain_type(&mut self, def: DomainDef) -> Result<(), StorageError> {
6207 if self.domain_types.contains_key(&def.name) {
6208 return Err(StorageError::Corrupt(format!(
6209 "domain {:?} already exists",
6210 def.name
6211 )));
6212 }
6213 self.mark_nontable_dirty(NonTableKind::DomainType, &def.name);
6214 self.domain_types.insert(def.name.clone(), def);
6215 Ok(())
6216 }
6217
6218 /// v7.17.0 Phase 1.5 — drop a DOMAIN by name.
6219 pub fn drop_domain_type(&mut self, name: &str) -> bool {
6220 self.mark_nontable_dirty(NonTableKind::DomainType, name);
6221 self.domain_types.remove(name).is_some()
6222 }
6223
6224 /// v7.37.42-T2 ζ-B — read-only handle to user-defined COMPOSITE
6225 /// catalog. Used by the engine to resolve
6226 /// `ColumnSchema.user_composite_type` lookups + by
6227 /// information_schema-style introspection.
6228 pub const fn composite_types(&self) -> &BTreeMap<String, CompositeDef> {
6229 &self.composite_types
6230 }
6231
6232 /// v7.37.42-T2 ζ-B — install a new COMPOSITE type. Errors if
6233 /// `name` already exists in the composite registry (PG forbids
6234 /// IF NOT EXISTS on CREATE TYPE composite; the engine surfaces
6235 /// the collision with the existing name).
6236 pub fn create_composite_type(&mut self, def: CompositeDef) -> Result<(), StorageError> {
6237 if self.composite_types.contains_key(&def.name) {
6238 return Err(StorageError::Corrupt(format!(
6239 "type {:?} already exists",
6240 def.name
6241 )));
6242 }
6243 self.mark_nontable_dirty(NonTableKind::CompositeType, &def.name);
6244 self.composite_types.insert(def.name.clone(), def);
6245 Ok(())
6246 }
6247
6248 /// v7.37.42-T2 ζ-B — drop a COMPOSITE type by name. Returns
6249 /// true if a type was removed.
6250 pub fn drop_composite_type(&mut self, name: &str) -> bool {
6251 self.mark_nontable_dirty(NonTableKind::CompositeType, name);
6252 self.composite_types.remove(name).is_some()
6253 }
6254
6255 /// v7.17.0 Phase 1.6 — read-only handle to the user-created
6256 /// schema registry. Built-in schemas (`public`, `pg_catalog`,
6257 /// `information_schema`) are NOT included here; use
6258 /// [`schema_exists`](Self::schema_exists) for the full
6259 /// check.
6260 pub const fn user_schemas(&self) -> &alloc::collections::BTreeSet<String> {
6261 &self.schemas
6262 }
6263
6264 /// v7.17.0 Phase 1.6 — schema-name resolver. Returns true
6265 /// for built-in schemas + every user-CREATEd one. Used by
6266 /// CREATE SCHEMA collision checks and (future) by
6267 /// information_schema.schemata.
6268 pub fn schema_exists(&self, name: &str) -> bool {
6269 is_builtin_schema(name) || self.schemas.contains(name)
6270 }
6271
6272 /// v7.17.0 Phase 1.6 — register a new schema. Errors if the
6273 /// name already exists and `if_not_exists=false`. Built-in
6274 /// names cannot be redeclared.
6275 pub fn create_schema(&mut self, name: String, if_not_exists: bool) -> Result<(), StorageError> {
6276 if is_builtin_schema(&name) {
6277 if if_not_exists {
6278 return Ok(());
6279 }
6280 return Err(StorageError::Corrupt(format!(
6281 "schema {name:?} is built-in and cannot be redeclared"
6282 )));
6283 }
6284 if self.schemas.contains(&name) {
6285 if if_not_exists {
6286 return Ok(());
6287 }
6288 return Err(StorageError::Corrupt(format!(
6289 "schema {name:?} already exists"
6290 )));
6291 }
6292 self.schemas.insert(name);
6293 Ok(())
6294 }
6295
6296 /// v7.17.0 Phase 1.6 — drop a user-created schema. Returns
6297 /// true if a schema was removed. Built-in names always
6298 /// return false (cannot be dropped). Tables that previously
6299 /// used the schema as a prefix keep their bare name and stay
6300 /// queryable — this is the "prefix routing, not isolation"
6301 /// posture documented in v7.17 Phase 1.6.
6302 pub fn drop_schema(&mut self, name: &str) -> Result<bool, StorageError> {
6303 if is_builtin_schema(name) {
6304 return Err(StorageError::Corrupt(format!(
6305 "schema {name:?} is built-in and cannot be dropped"
6306 )));
6307 }
6308 Ok(self.schemas.remove(name))
6309 }
6310
6311 /// v7.17.0 — ALTER SEQUENCE option merge. Caller-provided
6312 /// updates overwrite the matching fields; unset fields keep
6313 /// their stored values. RESTART variants update last_value
6314 /// directly per PG: `RESTART` resets to current `start`;
6315 /// `RESTART WITH n` resets to `n`.
6316 #[allow(clippy::too_many_arguments)]
6317 pub fn alter_sequence(
6318 &mut self,
6319 name: &str,
6320 increment: Option<i64>,
6321 min_value: Option<i64>,
6322 max_value: Option<i64>,
6323 start: Option<i64>,
6324 restart: Option<Option<i64>>,
6325 cache: Option<i64>,
6326 cycle: Option<bool>,
6327 owned_by: Option<Option<(String, String)>>,
6328 ) -> Result<(), StorageError> {
6329 self.mark_nontable_dirty(NonTableKind::Sequence, name);
6330 let Some(seq) = self.sequences.get_mut(name) else {
6331 return Err(StorageError::TableNotFound { name: name.into() });
6332 };
6333 if let Some(v) = increment {
6334 seq.increment = v;
6335 }
6336 if let Some(v) = min_value {
6337 seq.min_value = v;
6338 }
6339 if let Some(v) = max_value {
6340 seq.max_value = v;
6341 }
6342 if let Some(v) = start {
6343 seq.start = v;
6344 }
6345 if let Some(restart_value) = restart {
6346 seq.last_value = restart_value.unwrap_or(seq.start);
6347 seq.is_called = false;
6348 }
6349 if let Some(v) = cache {
6350 seq.cache = v;
6351 }
6352 if let Some(v) = cycle {
6353 seq.cycle = v;
6354 }
6355 if let Some(v) = owned_by {
6356 seq.owned_by = v;
6357 }
6358 Ok(())
6359 }
6360
6361 /// v7.12.4 — read-only slice of all catalogued triggers.
6362 /// Engine row-write paths filter this by (table, event,
6363 /// timing) and fire matches in slice order.
6364 pub fn triggers(&self) -> &[TriggerDef] {
6365 &self.triggers
6366 }
6367
6368 /// v7.15.0 — mutable handle to the trigger slice for
6369 /// `ALTER TABLE … RENAME COLUMN`, which rewrites every
6370 /// `update_columns` entry that referenced the renamed
6371 /// column.
6372 pub fn triggers_mut(&mut self) -> &mut Vec<TriggerDef> {
6373 &mut self.triggers
6374 }
6375
6376 /// v7.12.4 — register a new trigger. With `or_replace = false`,
6377 /// errors when a trigger with the same name already exists on
6378 /// the same table (PG scoping rule — trigger names are
6379 /// per-table, not global). Trigger function must already
6380 /// exist in the catalog at registration time.
6381 pub fn create_trigger(
6382 &mut self,
6383 def: TriggerDef,
6384 or_replace: bool,
6385 ) -> Result<(), StorageError> {
6386 // v7.39 (round 137) — a trigger may target a base table (BEFORE / AFTER)
6387 // or a view (INSTEAD OF). The engine enforces the timing↔target rule;
6388 // storage only requires the relation to exist as one or the other.
6389 if !self.by_name.contains_key(&def.table) && !self.views.contains_key(&def.table) {
6390 return Err(StorageError::TableNotFound {
6391 name: def.table.clone(),
6392 });
6393 }
6394 // v7.39 (read01 round 62) — functions are keyed by SIGNATURE now. A
6395 // trigger names its function by NAME (a trigger function takes no
6396 // arguments), so the existence check goes through the name index.
6397 if self.functions_named(&def.function).is_empty() {
6398 // v7.39 (round 710) — PG's wording: the FUNCTION is what does
6399 // not exist (`function nosuch_fn() does not exist`), and the
6400 // old message rode `Corrupt`'s on-disk banner besides.
6401 return Err(StorageError::Corrupt(format!(
6402 "function {}() does not exist",
6403 def.function
6404 )));
6405 }
6406 let dup = self
6407 .triggers
6408 .iter()
6409 .position(|t| t.name == def.name && t.table == def.table);
6410 match (dup, or_replace) {
6411 (Some(_), false) => Err(StorageError::Corrupt(format!(
6412 "trigger {:?} already exists on table {:?}",
6413 def.name, def.table
6414 ))),
6415 (Some(i), true) => {
6416 self.triggers[i] = def;
6417 Ok(())
6418 }
6419 (None, _) => {
6420 self.triggers.push(def);
6421 Ok(())
6422 }
6423 }
6424 }
6425
6426 /// v7.12.4 — remove a trigger by `(name, table)`. Returns
6427 /// `true` if one was removed.
6428 pub fn drop_trigger(&mut self, name: &str, table: &str) -> bool {
6429 let before = self.triggers.len();
6430 self.triggers
6431 .retain(|t| !(t.name == name && t.table == table));
6432 before != self.triggers.len()
6433 }
6434
6435 /// v7.39 (round 139) — the catalogued query-rewrite RULEs.
6436 pub fn rules(&self) -> &[RuleDef] {
6437 &self.rules
6438 }
6439
6440 /// v7.39 (round 280) — the catalogued extended-statistics objects.
6441 #[must_use]
6442 pub fn statistics_ext(&self) -> &[StatisticsExtDef] {
6443 &self.statistics_ext
6444 }
6445
6446 /// v7.39 (round 287) — every large object, ascending by OID.
6447 #[must_use]
6448 pub fn large_objects(&self) -> &alloc::collections::BTreeMap<u32, Vec<u8>> {
6449 &self.large_objects
6450 }
6451
6452 /// The bytes of one large object, or `None` when no such OID exists.
6453 #[must_use]
6454 pub fn large_object(&self, oid: u32) -> Option<&[u8]> {
6455 self.large_objects.get(&oid).map(Vec::as_slice)
6456 }
6457
6458 /// Create a large object. `oid` of 0 means "pick one" — PG's
6459 /// `lo_create(0)` / `lo_creat(-1)` spelling. Errors when the
6460 /// requested OID is taken.
6461 pub fn create_large_object(&mut self, oid: u32, bytes: Vec<u8>) -> Result<u32, String> {
6462 let id = if oid == 0 {
6463 self.next_large_object_oid()
6464 } else {
6465 oid
6466 };
6467 if self.large_objects.contains_key(&id) {
6468 return Err(format!("large object {id} already exists"));
6469 }
6470 self.large_objects.insert(id, bytes);
6471 Ok(id)
6472 }
6473
6474 /// Overwrite `len` bytes at `offset` (0-based), growing the object
6475 /// with zero bytes if the write starts past the end — PG's
6476 /// `lo_put` semantics.
6477 pub fn put_large_object(&mut self, oid: u32, offset: usize, data: &[u8]) -> Result<(), String> {
6478 let Some(buf) = self.large_objects.get_mut(&oid) else {
6479 return Err(format!("large object {oid} does not exist"));
6480 };
6481 let end = offset.saturating_add(data.len());
6482 if buf.len() < end {
6483 buf.resize(end, 0);
6484 }
6485 buf[offset..end].copy_from_slice(data);
6486 Ok(())
6487 }
6488
6489 /// v7.39 (round 306) — `lo_truncate`. PG's truncate sets the object
6490 /// to exactly `len` bytes in BOTH directions: it shortens, and it
6491 /// GROWS with zero fill when `len` exceeds the current size
6492 /// (measured — `lo_truncate(fd, 8)` over a 4-byte object leaves
6493 /// eight bytes, the last four zero).
6494 pub fn truncate_large_object(&mut self, oid: u32, len: usize) -> Result<(), String> {
6495 let Some(buf) = self.large_objects.get_mut(&oid) else {
6496 return Err(format!("large object {oid} does not exist"));
6497 };
6498 buf.resize(len, 0);
6499 Ok(())
6500 }
6501
6502 /// Remove a large object. `false` when the OID was not there.
6503 pub fn unlink_large_object(&mut self, oid: u32) -> bool {
6504 self.large_objects.remove(&oid).is_some()
6505 }
6506
6507 /// The next free OID in PG's user band.
6508 /// v7.39 (round 343, V40) — large objects have their own oid band.
6509 /// It used to start at 16_384, which is where user TABLES start, so
6510 /// the first large object and the first table shared an oid — and
6511 /// `pg_largeobject_metadata.oid` is joinable against `pg_class.oid`,
6512 /// so a join across them matched a row that has nothing to do with
6513 /// it. (PG cannot collide: every oid there comes off one counter.)
6514 /// An object already stored keeps the oid it was given; only new
6515 /// ones land in the band.
6516 fn next_large_object_oid(&self) -> u32 {
6517 self.large_objects
6518 .keys()
6519 .next_back()
6520 .map_or(500_000, |m| m.saturating_add(1))
6521 }
6522
6523 /// Register one. `Err(name)` when the name is taken.
6524 pub fn create_statistics_ext(&mut self, def: StatisticsExtDef) -> Result<(), String> {
6525 if self.statistics_ext.iter().any(|s| s.name == def.name) {
6526 return Err(def.name);
6527 }
6528 self.statistics_ext.push(def);
6529 Ok(())
6530 }
6531
6532 /// Drop one by name; false when absent.
6533 pub fn drop_statistics_ext(&mut self, name: &str) -> bool {
6534 let before = self.statistics_ext.len();
6535 self.statistics_ext.retain(|s| s.name != name);
6536 before != self.statistics_ext.len()
6537 }
6538
6539 /// v7.39 (round 139) — register a RULE. Its target relation (table or view)
6540 /// must exist; `or_replace` overwrites a same-(name,table) rule.
6541 pub fn create_rule(&mut self, def: RuleDef, or_replace: bool) -> Result<(), StorageError> {
6542 if !self.by_name.contains_key(&def.table) && !self.views.contains_key(&def.table) {
6543 return Err(StorageError::TableNotFound {
6544 name: def.table.clone(),
6545 });
6546 }
6547 let dup = self
6548 .rules
6549 .iter()
6550 .position(|r| r.name == def.name && r.table == def.table);
6551 match (dup, or_replace) {
6552 (Some(_), false) => Err(StorageError::Corrupt(format!(
6553 "rule {:?} for relation {:?} already exists",
6554 def.name, def.table
6555 ))),
6556 (Some(i), true) => {
6557 self.rules[i] = def;
6558 Ok(())
6559 }
6560 (None, _) => {
6561 self.rules.push(def);
6562 Ok(())
6563 }
6564 }
6565 }
6566
6567 /// v7.39 (round 139) — drop a RULE by `(name, table)`.
6568 pub fn drop_rule(&mut self, name: &str, table: &str) -> bool {
6569 let before = self.rules.len();
6570 self.rules.retain(|r| !(r.name == name && r.table == table));
6571 before != self.rules.len()
6572 }
6573
6574 pub fn create_table(&mut self, schema: TableSchema) -> Result<(), StorageError> {
6575 if self.by_name.contains_key(&schema.name) {
6576 return Err(StorageError::DuplicateTable {
6577 name: schema.name.clone(),
6578 });
6579 }
6580 let idx = self.tables.len();
6581 let name = schema.name.clone();
6582 self.tables.push(Table::new(schema));
6583 self.by_name.insert(name.clone(), idx);
6584 // v7.39 (round 496) — see `dirty_tables`.
6585 self.dirty_tables.insert(name);
6586 // v7.37.15 (Phase C.1) — stamp the new relation with a stable,
6587 // monotonic, never-reused RelId. Pre-increment so ids start at
6588 // 1 (0 = UNASSIGNED); a later DROP TABLE frees the slot but not
6589 // the id.
6590 self.next_rel_id += 1;
6591 let rid = row_header::RelId(self.next_rel_id);
6592 self.tables[idx].set_rel_id(rid);
6593 Ok(())
6594 }
6595
6596 /// v7.39 (round 436) — the session's temporary table of this name wins
6597 /// over a permanent one, as `pg_temp` does in PG's search path and as
6598 /// MySQL's TEMPORARY shadowing does. Every name → index resolution in
6599 /// this catalog goes through here.
6600 fn resolve_index(&self, name: &str) -> Option<usize> {
6601 if let Some(prefix) = &self.temp_prefix {
6602 let mut mangled = String::with_capacity(prefix.len() + name.len());
6603 mangled.push_str(prefix);
6604 mangled.push_str(name);
6605 if let Some(idx) = self.by_name.get(&mangled) {
6606 return Some(*idx);
6607 }
6608 }
6609 self.by_name.get(name).copied()
6610 }
6611
6612 /// v7.39 (round 436) — install the calling session's temp namespace.
6613 /// `None` disables temp resolution entirely (a session that never made
6614 /// one pays a single `Option` check per lookup).
6615 pub fn set_temp_prefix(&mut self, prefix: Option<String>) {
6616 self.temp_prefix = prefix;
6617 }
6618
6619 /// The mangled storage name a temp table of `name` takes in this
6620 /// session, or `None` when the session has no temp namespace.
6621 #[must_use]
6622 pub fn temp_name_for(&self, name: &str) -> Option<String> {
6623 self.temp_prefix
6624 .as_ref()
6625 .map(|p| alloc::format!("{p}{name}"))
6626 }
6627
6628 pub fn get(&self, name: &str) -> Option<&Table> {
6629 let idx = self.resolve_index(name)?;
6630 self.tables.get(idx)
6631 }
6632
6633 pub fn get_mut(&mut self, name: &str) -> Option<&mut Table> {
6634 let idx = self.resolve_index(name)?;
6635 // v7.39 (round 496) — the choke point for changing a table, so the
6636 // record is taken here. Over-approximate on purpose: a caller that
6637 // takes the handle and writes nothing merely carries that table
6638 // through a commit, which is the old behaviour.
6639 let recorded = self.tables.get(idx).map(|t| t.schema().name.clone());
6640 if let Some(n) = recorded {
6641 self.dirty_tables.insert(n);
6642 }
6643 self.tables.get_mut(idx)
6644 }
6645
6646 /// v7.39 (round 496) — the tables changed through this handle since
6647 /// [`Self::clear_dirty_tables`]. See `dirty_tables`.
6648 #[must_use]
6649 pub fn dirty_tables(&self) -> &alloc::collections::BTreeSet<String> {
6650 &self.dirty_tables
6651 }
6652
6653 /// r1059 — mark one table dirty without taking its handle. The
6654 /// rebase/merge paths replace a tx's shadow with a fresh base
6655 /// clone and must carry the tx's OWN dirty window across (the
6656 /// base's set is an ever-growing history, never cleared).
6657 pub fn mark_table_dirty(&mut self, name: &str) {
6658 self.dirty_tables.insert(name.into());
6659 }
6660
6661 /// v7.39 (round 496) — start a fresh recording window. A transaction's
6662 /// shadow calls this at BEGIN so the set means "changed by this tx".
6663 /// 7.38.1 S3.1 — one window covers both records (tables and the
6664 /// non-table families).
6665 pub fn clear_dirty_tables(&mut self) {
6666 self.dirty_tables.clear();
6667 self.dirty_nontable.clear();
6668 }
6669
6670 /// 7.38.1 S3.1 (D4) — record a non-table object as changed by this
6671 /// window. Called from every create/alter/rename/drop of the six
6672 /// [`NonTableKind`] families; a rename records BOTH names.
6673 fn mark_nontable_dirty(&mut self, kind: NonTableKind, name: &str) {
6674 self.dirty_nontable.insert((kind, name.into()));
6675 }
6676
6677 /// 7.38.1 S3.1 (D4) — reconcile the six non-table families with
6678 /// `base` (the latest committed catalog): every entry this window
6679 /// did NOT touch is taken from base — existence, definition and
6680 /// absence alike — so a neighbour's CREATE / ALTER / DROP of a
6681 /// sequence, view, matview, enum, domain or composite type
6682 /// survives a poisoned transaction's COMMIT. Entries this window
6683 /// DID touch keep the shadow's version (the tx's own DDL wins its
6684 /// own objects, exactly like the dirty-table merge above it).
6685 pub fn merge_nontable_objects_from(&mut self, base: &Catalog) {
6686 use NonTableKind as K;
6687 fn merge_map<V: Clone>(
6688 kind: NonTableKind,
6689 dirty: &alloc::collections::BTreeSet<(NonTableKind, String)>,
6690 mine: &mut BTreeMap<String, V>,
6691 theirs: &BTreeMap<String, V>,
6692 ) {
6693 let names: alloc::vec::Vec<String> =
6694 mine.keys().chain(theirs.keys()).cloned().collect();
6695 for n in names {
6696 if dirty.contains(&(kind, n.clone())) {
6697 continue;
6698 }
6699 match theirs.get(&n) {
6700 Some(v) => {
6701 mine.insert(n, v.clone());
6702 }
6703 None => {
6704 mine.remove(&n);
6705 }
6706 }
6707 }
6708 }
6709 let dirty = self.dirty_nontable.clone();
6710 merge_map(K::Sequence, &dirty, &mut self.sequences, &base.sequences);
6711 merge_map(K::View, &dirty, &mut self.views, &base.views);
6712 merge_map(
6713 K::MaterializedView,
6714 &dirty,
6715 &mut self.materialized_views,
6716 &base.materialized_views,
6717 );
6718 merge_map(K::EnumType, &dirty, &mut self.enum_types, &base.enum_types);
6719 merge_map(
6720 K::DomainType,
6721 &dirty,
6722 &mut self.domain_types,
6723 &base.domain_types,
6724 );
6725 merge_map(
6726 K::CompositeType,
6727 &dirty,
6728 &mut self.composite_types,
6729 &base.composite_types,
6730 );
6731 }
6732
6733 /// v7.39 (round 496) — put `table` in at `name`, replacing any table
6734 /// already there and keeping the rest of the catalog untouched.
6735 ///
6736 /// The commit-time table-granularity merge needs exactly this: take
6737 /// the latest committed catalog, then overwrite only the tables the
6738 /// transaction changed.
6739 pub fn install_table(&mut self, name: &str, table: Table) {
6740 match self.by_name.get(name).copied() {
6741 Some(idx) => self.tables[idx] = table,
6742 None => {
6743 let idx = self.tables.len();
6744 self.tables.push(table);
6745 self.by_name.insert(name.into(), idx);
6746 }
6747 }
6748 self.dirty_tables.insert(name.into());
6749 }
6750
6751 /// v7.37.42 (docker-fair SCALARSQ attack) — resolve a table name to
6752 /// its insertion-order index ONCE, so callers that need to fetch the
6753 /// same table many times (per-row PK probes in correlated scalar
6754 /// subqueries) can avoid the per-call `BTreeMap<String, usize>` string
6755 /// descent. The returned index is stable for the lifetime of the
6756 /// catalog snapshot the caller holds (same engine read guard).
6757 pub fn tables_position_of(&self, name: &str) -> Option<usize> {
6758 self.resolve_index(name)
6759 }
6760
6761 /// Direct positional fetch counterpart to [`tables_position_of`].
6762 /// `idx` must come from `tables_position_of` against the same catalog
6763 /// snapshot — out-of-range returns `None`.
6764 pub fn tables_at(&self, idx: usize) -> Option<&Table> {
6765 self.tables.get(idx)
6766 }
6767
6768 /// v7.34 (crash-recovery P0 #2) — replay a row-level redo log onto
6769 /// this catalog (the [`RowChange`] physical-redo apply primitive that
6770 /// row-level WAL recovery will use in place of statement re-execution).
6771 /// Applies each change in order via the same `Table` mutators the
6772 /// engine used — no uniqueness/FK/parse/plan: the original execution
6773 /// already validated, replay trusts and applies. Positions are
6774 /// physical and only valid when replayed from the matching checkpoint
6775 /// baseline in original order (see [`RowChange`] docs).
6776 ///
6777 /// A change naming an absent table, or whose position is out of range,
6778 /// is a corrupt/misaligned log and surfaces as an error rather than a
6779 /// silent skip.
6780 pub fn apply_redo(&mut self, changes: &[RowChange]) -> Result<(), StorageError> {
6781 // v7.37.5 (mailrs crash-recovery Ask 3) — true batched replay.
6782 // Pre-v7.37.5 each `RowChange::Delete` record ran a fresh
6783 // O(N) PersistentVec rebuild + O(N × indices × log N)
6784 // `rebuild_indices()` — 5000 records × 100k rows × 13 indices
6785 // ≈ 27 min on the mailrs prod-shape WAL.
6786 //
6787 // The strategy: group consecutive changes by table, and for
6788 // each run, compose all the row-level mutations through a
6789 // single "live" tracking vector + a per-table operation log,
6790 // then apply rows + indices ONCE at the end. The result:
6791 // - DELETE blow-up: O(records × rows × indices × log rows)
6792 // → O(rows × indices × log rows) — one rebuild per run.
6793 // - Row-position semantics preserved: positions in a later
6794 // `Delete` / `Update` record reference the layout produced
6795 // by every earlier change; we walk the live-vector
6796 // forward as each change is processed so positions
6797 // translate correctly to the ORIGINAL row index space.
6798 //
6799 // For correctness, even with this batching `apply_redo`
6800 // remains in-order: a single per-table run only batches
6801 // a contiguous slice of changes targeting that table; a
6802 // mid-run change targeting a DIFFERENT table forces a
6803 // flush of the current run.
6804 let mut runs: alloc::vec::Vec<(String, alloc::vec::Vec<&RowChange>)> =
6805 alloc::vec::Vec::new();
6806 for change in changes {
6807 // v7.39 (flip crash-replay P0) — a replayed tombstone carries
6808 // the xmax the CRASHED process allocated, but this process's
6809 // version cursor restarted; without advancing it past every
6810 // replayed version, `Snapshot::visible`'s "deletion is in the
6811 // future" branch (xmax > snapshot.version) resurrects every
6812 // replayed delete. Same recovery contract as the snapshot
6813 // loader (`observe_persisted_version`, the pg_control-style
6814 // nextXid recovery).
6815 if let RowChange::Tombstone { xmax, .. } = change {
6816 row_header::observe_persisted_version(*xmax);
6817 }
6818 let table = match change {
6819 RowChange::Insert { table, .. }
6820 | RowChange::Update { table, .. }
6821 | RowChange::Delete { table, .. }
6822 | RowChange::Tombstone { table, .. } => table.clone(),
6823 };
6824 if runs.last().map(|(t, _)| t.as_str()) != Some(table.as_str()) {
6825 runs.push((table, alloc::vec::Vec::new()));
6826 }
6827 runs.last_mut().unwrap().1.push(change);
6828 }
6829 for (table_name, run) in runs {
6830 self.apply_redo_run_on_table(&table_name, &run)?;
6831 }
6832 Ok(())
6833 }
6834
6835 /// v7.37.5 — apply a contiguous slice of `RowChange`s all
6836 /// targeting the same `table_name`. Composes row mutations
6837 /// through a single live-tracking vector + a single tail
6838 /// for appended `Insert`s + a single in-place edit set for
6839 /// `Update`s, then writes the final row layout to
6840 /// `self.rows` and rebuilds indices ONCE.
6841 fn apply_redo_run_on_table(
6842 &mut self,
6843 table_name: &str,
6844 run: &[&RowChange],
6845 ) -> Result<(), StorageError> {
6846 // Look up the table once; the unchecked unwrap is safe
6847 // because the caller just resolved `table_name` for each
6848 // change.
6849 let table = self.get_mut(table_name).ok_or_else(|| {
6850 StorageError::Corrupt(alloc::format!("redo: unknown table {table_name:?}"))
6851 })?;
6852 // Live-tracking over both pre-existing rows and tail-
6853 // appended Insert rows. `live[i] = true` initially for
6854 // every existing row. Appended Inserts extend with `true`.
6855 // A `Delete` flips entries to `false` (using the position
6856 // mapping that walks live indices in order). An `Update`
6857 // edits in place — collected into an overlay map keyed by
6858 // ORIGINAL row position so later Updates win.
6859 let original_rows: alloc::vec::Vec<Row<'static>> = table.rows().iter().cloned().collect();
6860 let mut live: alloc::vec::Vec<bool> = alloc::vec![true; original_rows.len()];
6861 let mut tail: alloc::vec::Vec<Row<'static>> = alloc::vec::Vec::new();
6862 // Overlay: index into ORIGINAL row space (existing rows
6863 // 0..original_rows.len()) or into tail (offset
6864 // original_rows.len()). Map -> new values.
6865 let mut overlay: alloc::collections::BTreeMap<usize, alloc::vec::Vec<Value<'static>>> =
6866 alloc::collections::BTreeMap::new();
6867 // v7.37.15 (Epic W durable-tombstone slice) — extra bookkeeping
6868 // ONLY when this run actually carries an in-place `Tombstone`.
6869 // A tombstone keeps its row physically present but stamps `xmax`
6870 // on the header; the run finalizer `set_rows_and_rebuild_indices`
6871 // freezes every header (and reassigns ids), so we must re-stamp
6872 // in a post-pass keyed by RowId. When the run has no tombstone
6873 // (every default gate-off replay) this is all skipped and the
6874 // path below stays byte-for-byte the legacy one.
6875 let has_tomb = run.iter().any(|c| matches!(c, RowChange::Tombstone { .. }));
6876 // Ids of the pre-existing rows, snapshotted parallel to
6877 // `original_rows`, and ids of the tail rows filled from each
6878 // `Insert`'s carried `rowid`. Together they let a tombstone name
6879 // the exact row the writer stamped, independent of the ids the
6880 // finalizer will hand out. (When `!has_tomb`, both stay empty.)
6881 // v7.39 (flip crash-replay P0) — ids are tracked UNCONDITIONALLY
6882 // now: the finalizer preserves them so a later WAL record's
6883 // tombstone can still name rows this record produced.
6884 let orig_rowids: alloc::vec::Vec<row_header::RowId> =
6885 table.rowids().iter().copied().collect();
6886 // Headers snapshotted in lock-step: the finalizer preserves
6887 // them so earlier records' tombstone stamps survive.
6888 let orig_headers: alloc::vec::Vec<row_header::RowHeader> =
6889 table.headers().iter().copied().collect();
6890 let mut tail_rowids: alloc::vec::Vec<row_header::RowId> = alloc::vec::Vec::new();
6891 // (RowId, xmax) of every row this run tombstones.
6892 let mut tomb_targets: alloc::vec::Vec<(row_header::RowId, u64)> = alloc::vec::Vec::new();
6893 // Helper: given a "current" position (i.e. position in
6894 // the post-prior-deletes layout), translate to the
6895 // ABSOLUTE position in the unified live + tail space
6896 // by walking the live vector + tail. Returns None when
6897 // the position is out of range.
6898 fn translate(live: &[bool], tail_len: usize, current_pos: usize) -> Option<usize> {
6899 // Walk live[..] counting live entries until we hit
6900 // current_pos. Then if not yet matched, dip into tail.
6901 let mut seen = 0usize;
6902 for (i, &alive) in live.iter().enumerate() {
6903 if alive {
6904 if seen == current_pos {
6905 return Some(i);
6906 }
6907 seen += 1;
6908 }
6909 }
6910 // Position lives in tail. tail_len rows in the tail
6911 // are all live (we haven't deleted any tail rows in
6912 // this simplification; if we did, we'd extend `live`).
6913 let off = current_pos - seen;
6914 if off < tail_len {
6915 Some(live.len() + off)
6916 } else {
6917 None
6918 }
6919 }
6920 for change in run {
6921 match *change {
6922 RowChange::Insert { row, rowid, .. } => {
6923 // Validate against schema before recording the
6924 // change so a corrupt log surfaces as an error
6925 // rather than silently mis-applying.
6926 if row.len() != table.schema().columns.len() {
6927 return Err(StorageError::ArityMismatch {
6928 expected: table.schema().columns.len(),
6929 actual: row.len(),
6930 });
6931 }
6932 tail.push(row.clone());
6933 // Keep the id lock-step with `tail` so a later
6934 // tombstone (this run or a later WAL record) can
6935 // find the row by the id the writer captured.
6936 tail_rowids.push(*rowid);
6937 }
6938 RowChange::Update { pos, new_row, .. } => {
6939 if new_row.len() != table.schema().columns.len() {
6940 return Err(StorageError::ArityMismatch {
6941 expected: table.schema().columns.len(),
6942 actual: new_row.len(),
6943 });
6944 }
6945 let abs = translate(&live, tail.len(), *pos).ok_or_else(|| {
6946 StorageError::Corrupt(alloc::format!(
6947 "redo: update_row position {pos} out of bounds in table {table_name:?}",
6948 ))
6949 })?;
6950 // Tail edits are applied directly to `tail`
6951 // (we own it); existing-row edits land in
6952 // the overlay map keyed by original index.
6953 if abs < live.len() {
6954 overlay.insert(abs, new_row.clone());
6955 } else {
6956 tail[abs - live.len()] = Row::new(new_row.clone());
6957 }
6958 }
6959 RowChange::Delete { positions, .. } => {
6960 // De-dup + sort so the translate walk stays
6961 // monotone (the second translate doesn't have
6962 // to redo work the first one did, in principle;
6963 // we keep it simple here and re-walk per
6964 // position). Bounds-filter silently mirrors
6965 // `Table::delete_rows`.
6966 let mut sorted: alloc::vec::Vec<usize> = positions.clone();
6967 sorted.sort_unstable();
6968 sorted.dedup();
6969 // Walk live[] once per Delete record to
6970 // translate all positions in this record's
6971 // post-prior-deletes layout to absolute
6972 // indices. We MUST defer the live[] flip
6973 // until after all positions are translated
6974 // so two positions in the same record
6975 // (e.g. [3, 7]) reference the same layout.
6976 let mut to_flip_live: alloc::vec::Vec<usize> = alloc::vec::Vec::new();
6977 let mut to_flip_tail: alloc::vec::Vec<usize> = alloc::vec::Vec::new();
6978 // Two-pointer walk: live[i] scanned monotonically,
6979 // sorted positions consumed in order.
6980 let mut seen = 0usize;
6981 let mut sp = sorted.iter().peekable();
6982 for (i, &alive) in live.iter().enumerate() {
6983 if !alive {
6984 continue;
6985 }
6986 while let Some(&&p) = sp.peek() {
6987 if seen == p {
6988 to_flip_live.push(i);
6989 sp.next();
6990 } else {
6991 break;
6992 }
6993 }
6994 if sp.peek().is_none() {
6995 break;
6996 }
6997 seen += 1;
6998 }
6999 // Remaining positions fall into the tail.
7000 for &p in sp {
7001 // p >= seen and refers to the (p - seen)-th
7002 // entry in tail. Filter out-of-bounds.
7003 let off = p - seen;
7004 if off < tail.len() {
7005 to_flip_tail.push(off);
7006 }
7007 }
7008 for i in to_flip_live {
7009 live[i] = false;
7010 // Any pending overlay edit for this
7011 // index is moot — the row is gone.
7012 overlay.remove(&i);
7013 }
7014 // Tail deletes: remove in REVERSE order so
7015 // shifting indices stay valid.
7016 to_flip_tail.sort_unstable();
7017 to_flip_tail.dedup();
7018 for off in to_flip_tail.into_iter().rev() {
7019 tail.remove(off);
7020 {
7021 // Keep the id vector lock-step with `tail`.
7022 tail_rowids.remove(off);
7023 }
7024 // Re-key tail-relative overlay entries that
7025 // were past `off` — in practice tail edits
7026 // are applied directly so the overlay map
7027 // only holds existing-row keys; nothing to
7028 // do here.
7029 }
7030 }
7031 RowChange::Tombstone { rowids, xmax, .. } => {
7032 // An in-place tombstone leaves the row physically
7033 // present — it does not touch `live` / `tail` /
7034 // `overlay`. Record the (id, xmax) targets; the
7035 // post-finalizer pass re-stamps `xmax` onto the
7036 // matching row's (otherwise-frozen) header.
7037 for rid in rowids {
7038 tomb_targets.push((*rid, *xmax));
7039 }
7040 }
7041 }
7042 }
7043 // Compose the final row layout: keep existing rows where
7044 // live[i] = true, applying overlay edits in place; then
7045 // append the surviving tail.
7046 let mut new_rows: PersistentVec<Row> = PersistentVec::new();
7047 let mut new_hot_bytes: u64 = 0;
7048 let schema_snapshot = table.schema().clone();
7049 // Parallel to `new_rows` (only built when `has_tomb`): the RowId
7050 // of each row in its FINAL slot, so the post-pass can map a
7051 // tombstone target id → the slot to re-stamp `xmax` on.
7052 let mut final_rowids: alloc::vec::Vec<row_header::RowId> = alloc::vec::Vec::new();
7053 let mut final_headers: alloc::vec::Vec<row_header::RowHeader> = alloc::vec::Vec::new();
7054 for (i, row) in original_rows.into_iter().enumerate() {
7055 if !live[i] {
7056 continue;
7057 }
7058 let final_row = if let Some(new_values) = overlay.remove(&i) {
7059 Row::new(new_values)
7060 } else {
7061 row
7062 };
7063 new_hot_bytes = new_hot_bytes
7064 .saturating_add(row_body_encoded_len(&final_row, &schema_snapshot) as u64);
7065 new_rows.push_mut(final_row);
7066 final_rowids.push(
7067 orig_rowids
7068 .get(i)
7069 .copied()
7070 .unwrap_or(row_header::RowId::UNASSIGNED),
7071 );
7072 final_headers.push(
7073 orig_headers
7074 .get(i)
7075 .copied()
7076 .unwrap_or_else(row_header::RowHeader::frozen),
7077 );
7078 }
7079 for (off, row) in tail.into_iter().enumerate() {
7080 new_hot_bytes =
7081 new_hot_bytes.saturating_add(row_body_encoded_len(&row, &schema_snapshot) as u64);
7082 new_rows.push_mut(row);
7083 final_rowids.push(
7084 tail_rowids
7085 .get(off)
7086 .copied()
7087 .unwrap_or(row_header::RowId::UNASSIGNED),
7088 );
7089 final_headers.push(row_header::RowHeader::frozen());
7090 }
7091 // v7.39 (flip crash-replay P0) — id-preserving finalizer, so a
7092 // LATER WAL record's tombstone still resolves rows this record
7093 // produced (per-statement replay used to reassign ids between
7094 // records, orphaning every cross-record tombstone target).
7095 table.set_rows_and_rebuild_indices_with_rowids(
7096 new_rows,
7097 new_hot_bytes,
7098 &final_rowids,
7099 &final_headers,
7100 );
7101 // v7.37.15 (Epic W durable-tombstone slice) — header-preserving
7102 // re-stamp. `set_rows_and_rebuild_indices` above froze every
7103 // header, so any row this run tombstoned is currently all-
7104 // visible again. Re-apply the `xmax` stamp by matching the
7105 // tombstone's target RowId against the final-slot id map. This
7106 // is what makes a gate-on DELETE durable across replay without
7107 // changing the on-disk snapshot format (headers/ids are still
7108 // NOT serialised — that is the deferred V6 coupling; see below).
7109 if has_tomb && !tomb_targets.is_empty() {
7110 let mut id_to_slot: alloc::collections::BTreeMap<row_header::RowId, usize> =
7111 alloc::collections::BTreeMap::new();
7112 for (slot, rid) in final_rowids.iter().enumerate() {
7113 if *rid != row_header::RowId::UNASSIGNED {
7114 id_to_slot.insert(*rid, slot);
7115 }
7116 }
7117 let table = self.get_mut(table_name).ok_or_else(|| {
7118 StorageError::Corrupt(alloc::format!("redo: unknown table {table_name:?}"))
7119 })?;
7120 for (rid, xmax) in &tomb_targets {
7121 match id_to_slot.get(rid) {
7122 Some(&slot) => {
7123 // First-deleter-wins + bounds handled inside.
7124 let _ = table.mark_row_deleted(slot, *xmax);
7125 }
7126 None => {
7127 // The target row was not produced by THIS redo
7128 // run and its id was not in the run-start
7129 // snapshot — the documented cross-checkpoint
7130 // limitation: after a checkpoint restore the
7131 // table's ids are reassigned (not yet persisted
7132 // in the envelope), so a tombstone naming a
7133 // pre-checkpoint row cannot be resolved by id.
7134 // Skipping leaves the row visible (identical to
7135 // the pre-Epic-W non-durable behaviour); it is
7136 // never a correctness regression, only an
7137 // unclosed durability gap the V6 envelope slice
7138 // closes. Counted for observability.
7139 UNRESOLVED_TOMBSTONES.fetch_add(1, core::sync::atomic::Ordering::Relaxed);
7140 }
7141 }
7142 }
7143 }
7144 Ok(())
7145 }
7146
7147 fn table_for_redo(&mut self, name: &str) -> Result<&mut Table, StorageError> {
7148 self.get_mut(name)
7149 .ok_or_else(|| StorageError::Corrupt(alloc::format!("redo: unknown table {name:?}")))
7150 }
7151
7152 /// v7.34 (crash-recovery P0 #2) — enable row-level redo capture on
7153 /// every table (the engine calls this before a mutating statement
7154 /// when persistence is on; idempotent, keeps any in-flight capture).
7155 pub fn enable_redo_all(&mut self) {
7156 for t in &mut self.tables {
7157 t.enable_redo();
7158 }
7159 }
7160
7161 /// v7.34 — drain the row-level redo captured across all tables, in
7162 /// table order then per-table apply order, and stop capturing. The
7163 /// engine calls this after a successful mutating statement and writes
7164 /// the returned [`RowChange`]s to the WAL in place of the SQL text.
7165 pub fn drain_redo(&mut self) -> Vec<RowChange> {
7166 let mut all = Vec::new();
7167 for t in &mut self.tables {
7168 all.extend(t.take_redo());
7169 }
7170 all
7171 }
7172
7173 pub fn table_count(&self) -> usize {
7174 self.tables.len()
7175 }
7176
7177 /// v7.14.0 — remove a table by name. Returns `true` when the
7178 /// table existed (and is now gone), `false` when it didn't.
7179 /// Used by `DROP TABLE` from pg_dump / mysqldump preambles
7180 /// where the dump re-creates schema and starts with
7181 /// `DROP TABLE IF EXISTS`.
7182 pub fn drop_table(&mut self, name: &str) -> bool {
7183 // v7.39 (round 436) — resolve through the session's temp namespace
7184 // first, exactly as a read would: MariaDB's plain `DROP TABLE tmp`
7185 // drops the TEMPORARY one and leaves a permanent namesake standing
7186 // (measured). Removing by the raw name would have dropped the
7187 // permanent table out from under every other session.
7188 let key = match self.temp_prefix.as_ref() {
7189 Some(p) => {
7190 let mangled = alloc::format!("{p}{name}");
7191 if self.by_name.contains_key(&mangled) {
7192 mangled
7193 } else {
7194 name.into()
7195 }
7196 }
7197 None => name.into(),
7198 };
7199 let Some(idx) = self.by_name.remove(&key) else {
7200 return false;
7201 };
7202 // v7.39 (round 496) — see `dirty_tables`. Recorded under the
7203 // RESOLVED key, which is what a commit-time merge looks up.
7204 self.dirty_tables.insert(key.clone());
7205 // swap_remove invalidates the trailing index → rebuild
7206 // by_name for affected entries.
7207 self.tables.swap_remove(idx);
7208 // Re-stamp moved table's index slot in by_name.
7209 if idx < self.tables.len() {
7210 let moved_name = self.tables[idx].schema.name.clone();
7211 self.by_name.insert(moved_name, idx);
7212 }
7213 true
7214 }
7215
7216 /// v7.16.2 — rename a table (mailrs round-10 A.5). Updates
7217 /// the schema name, the catalog name → index map, and
7218 /// rewrites every reference dangling at the table name:
7219 /// * every FK on every OTHER table whose `parent_table`
7220 /// pointed at the old name now points at the new
7221 /// name, so FK enforcement keeps working
7222 /// * every trigger watching the table updates its `table`
7223 /// field
7224 /// Returns `Ok` on success; `Err(StorageError::TableNotFound)`
7225 /// when the old name isn't in the catalog and
7226 /// `Err(StorageError::DuplicateTable)` when the new name is
7227 /// already taken.
7228 pub fn rename_table(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
7229 if old == new {
7230 return Ok(());
7231 }
7232 if self.by_name.contains_key(new) {
7233 return Err(StorageError::Corrupt(format!(
7234 "rename_table: target name {new:?} already exists"
7235 )));
7236 }
7237 let idx = self
7238 .by_name
7239 .remove(old)
7240 .ok_or_else(|| StorageError::TableNotFound { name: old.into() })?;
7241 self.tables[idx].schema.name = new.to_string();
7242 self.by_name.insert(new.to_string(), idx);
7243 for t in &mut self.tables {
7244 for fk in &mut t.schema.foreign_keys {
7245 if fk.parent_table == old {
7246 fk.parent_table = new.to_string();
7247 }
7248 }
7249 }
7250 for trig in &mut self.triggers {
7251 if trig.table == old {
7252 trig.table = new.to_string();
7253 }
7254 }
7255 Ok(())
7256 }
7257
7258 /// v7.16.2 — rename an index by name. Walks every table
7259 /// since the index lives on its owning table; updates the
7260 /// name in place. Errors with `IndexNotFound` when no
7261 /// index matches. mailrs round-10 A.5.
7262 pub fn rename_index(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
7263 if old == new {
7264 return Ok(());
7265 }
7266 // Reject the new name if it already exists anywhere.
7267 for t in &self.tables {
7268 if t.indices.iter().any(|i| i.name == new) {
7269 return Err(StorageError::Corrupt(format!(
7270 "rename_index: target name {new:?} already exists"
7271 )));
7272 }
7273 }
7274 for t in &mut self.tables {
7275 for i in &mut t.indices {
7276 if i.name == old {
7277 i.name = new.to_string();
7278 return Ok(());
7279 }
7280 }
7281 }
7282 Err(StorageError::IndexNotFound { name: old.into() })
7283 }
7284
7285 /// v7.14.0 — remove a named index across the catalog.
7286 /// Returns `true` when found + dropped.
7287 pub fn drop_named_index(&mut self, name: &str) -> bool {
7288 for t in &mut self.tables {
7289 let before = t.indices.len();
7290 t.indices.retain(|i| i.name != name);
7291 if t.indices.len() != before {
7292 return true;
7293 }
7294 }
7295 false
7296 }
7297
7298 /// Borrow-free copy of every table's name in catalog order
7299 /// (= insertion order, matching the on-disk encoding).
7300 pub fn table_names(&self) -> Vec<String> {
7301 self.tables.iter().map(|t| t.schema.name.clone()).collect()
7302 }
7303
7304 /// v7.39 (round 436) — the marker every session's temporary-table
7305 /// namespace starts with. Public so the catalog synths can tell a
7306 /// temp table from an ordinary one without knowing the session id.
7307 pub const TEMP_NAME_MARKER: &'static str = "__spg_temp_";
7308
7309 /// v7.39 (round 437) — how a stored table name should appear to the
7310 /// CALLING session in a catalog listing (SHOW TABLES, pg_class,
7311 /// information_schema, …):
7312 /// * an ordinary table → its own name
7313 /// * this session's temporary table → its logical name, prefix stripped
7314 /// * another session's temporary table → `None`, i.e. not listed
7315 ///
7316 /// Measured on both oracles: MariaDB 11 and PG 18 each list the calling
7317 /// session's own temporary tables and neither lists anybody else's.
7318 /// Round 436 stored temp tables under a prefix without teaching the
7319 /// listings about it, so the mangled names leaked to every client.
7320 #[must_use]
7321 pub fn listed_name<'a>(&self, stored: &'a str) -> Option<&'a str> {
7322 if !stored.starts_with(Self::TEMP_NAME_MARKER) {
7323 return Some(stored);
7324 }
7325 let prefix = self.temp_prefix.as_ref()?;
7326 stored.strip_prefix(prefix.as_str())
7327 }
7328
7329 /// The listing names of every table this session may see, in catalog
7330 /// order. See [`Catalog::listed_name`].
7331 #[must_use]
7332 pub fn visible_table_names(&self) -> Vec<String> {
7333 self.tables
7334 .iter()
7335 .filter_map(|t| self.listed_name(&t.schema.name).map(String::from))
7336 .collect()
7337 }
7338
7339 /// v5.1: register a cold-tier segment that already lives in
7340 /// memory (caller did the file read). Returns the
7341 /// `segment_id` that `RowLocator::Cold { segment_id, .. }`
7342 /// will reference — currently this is just the index into
7343 /// `cold_segments`, but treat it as an opaque token.
7344 ///
7345 /// Storage is `no_std`, so file I/O is the caller's
7346 /// responsibility — `spg-server` reads the file and forwards
7347 /// the bytes here. The bytes stay resident in the catalog
7348 /// for the life of the `Catalog`, parsed only once.
7349 pub fn load_segment_bytes(&mut self, bytes: Vec<u8>) -> Result<u32, StorageError> {
7350 let id = u32::try_from(self.cold_segments.len()).map_err(|_| {
7351 StorageError::Corrupt("cold segment count would exceed u32::MAX".into())
7352 })?;
7353 let seg = OwnedSegment::from_bytes(bytes)
7354 .map_err(|e| StorageError::Corrupt(format!("cold segment parse failed: {e}")))?;
7355 self.cold_segments.push(Some(Arc::new(seg)));
7356 Ok(id)
7357 }
7358
7359 /// v6.7.3 — register a cold-tier segment at a specific id. Used
7360 /// by the spg-server manifest-boot path so segments whose
7361 /// neighbouring ids were retired by compaction still get back
7362 /// the same `segment_id` they had pre-restart (the
7363 /// `RowLocator::Cold { segment_id }` baked into the BTree-index
7364 /// snapshot persists across restart and must continue to
7365 /// resolve).
7366 ///
7367 /// Pads the Vec with `None` slots up to `target_id` if needed.
7368 /// Errors when the target slot is already occupied (would
7369 /// stomp another segment), the parse fails, or `target_id`
7370 /// exceeds `u32::MAX`.
7371 pub fn load_segment_bytes_at(
7372 &mut self,
7373 target_id: u32,
7374 bytes: Vec<u8>,
7375 ) -> Result<(), StorageError> {
7376 let seg = OwnedSegment::from_bytes(bytes)
7377 .map_err(|e| StorageError::Corrupt(format!("cold segment parse failed: {e}")))?;
7378 let idx = target_id as usize;
7379 while self.cold_segments.len() <= idx {
7380 self.cold_segments.push(None);
7381 }
7382 if self.cold_segments[idx].is_some() {
7383 return Err(StorageError::Corrupt(format!(
7384 "load_segment_bytes_at: segment_id {target_id} already occupied"
7385 )));
7386 }
7387 self.cold_segments[idx] = Some(Arc::new(seg));
7388 Ok(())
7389 }
7390
7391 /// v6.7.3 — retire a cold-tier segment slot (compaction-driven).
7392 /// The physical file is the caller's concern (typically kept
7393 /// on disk until the next CHECKPOINT writes a manifest that
7394 /// no longer lists it); this just flips the in-memory slot
7395 /// to `None` so later cold lookups for `segment_id` resolve
7396 /// as "unknown" instead of returning a stale row.
7397 ///
7398 /// No-op when the slot is already `None`. Errors only when
7399 /// `segment_id` is out of bounds.
7400 pub fn tombstone_segment(&mut self, segment_id: u32) -> Result<(), StorageError> {
7401 let idx = segment_id as usize;
7402 if idx >= self.cold_segments.len() {
7403 return Err(StorageError::Corrupt(format!(
7404 "tombstone_segment: segment_id {segment_id} out of bounds (len={})",
7405 self.cold_segments.len()
7406 )));
7407 }
7408 self.cold_segments[idx] = None;
7409 Ok(())
7410 }
7411
7412 /// Number of *active* (non-tombstoned) cold segments.
7413 #[must_use]
7414 pub fn cold_segment_count(&self) -> usize {
7415 self.cold_segments.iter().filter(|s| s.is_some()).count()
7416 }
7417
7418 /// v7.37.42 (docker-fair SCALARSQ attack 3) — short-circuit guard
7419 /// for scan loops that conditionally walk the cold tier. Returns
7420 /// `false` when the catalog has never loaded a cold segment (or all
7421 /// segments are tombstoned), so callers can skip the per-table cold
7422 /// PK-index walk entirely on hot-only databases. O(N segments);
7423 /// typical N is small (single-digit) so the check is sub-µs.
7424 #[must_use]
7425 pub fn has_any_cold_segments(&self) -> bool {
7426 self.cold_segments.iter().any(Option::is_some)
7427 }
7428
7429 /// Slot count including tombstones (= the next id the
7430 /// no-arg `load_segment_bytes` would allocate).
7431 #[must_use]
7432 pub fn cold_segment_slot_count(&self) -> usize {
7433 self.cold_segments.len()
7434 }
7435
7436 /// v6.2.7 — list every *active* cold-tier segment id known to
7437 /// this catalog (skips compaction tombstones since v6.7.3).
7438 /// Used by EXPLAIN ANALYZE to annotate scan nodes with the
7439 /// segments they could have walked.
7440 #[must_use]
7441 pub fn cold_segment_ids_global(&self) -> Vec<u32> {
7442 self.cold_segments
7443 .iter()
7444 .enumerate()
7445 .filter_map(|(i, s)| s.as_ref().map(|_| i as u32))
7446 .collect()
7447 }
7448
7449 /// v5.2.1: sum of `Table::hot_bytes` across every table. The v5.2
7450 /// freezer compares this against `SPG_HOT_TIER_BYTES` (parsed at
7451 /// server startup; default 4 GiB) and wakes when the budget is
7452 /// crossed. Pre-freezer (v5.2.1) this is measurement-only — the
7453 /// counter exposes whether the budget is being approached without
7454 /// triggering any demotion.
7455 #[must_use]
7456 pub fn hot_tier_bytes(&self) -> u64 {
7457 self.tables
7458 .iter()
7459 .map(Table::hot_bytes)
7460 .fold(0u64, u64::saturating_add)
7461 }
7462
7463 /// v5.2.2: freeze the **first** `max_rows` rows of `table_name`'s
7464 /// hot tier into a brand-new cold-tier segment. The named `BTree`
7465 /// index supplies the per-row PK (its column must be an integer
7466 /// type — v5.2.2 only supports `IndexKey::Int` PKs, matching the
7467 /// `index_key_as_u64` constraint used by the cold-tier lookup
7468 /// path). On success returns a [`FreezeReport`] with the
7469 /// freshly-allocated segment id, the count of rows that moved,
7470 /// the encoded segment bytes (so the caller can persist them to
7471 /// disk for later reload via `SPG_PRELOAD_COLD_SEGMENT`), and the
7472 /// hot-tier byte delta that was reclaimed.
7473 ///
7474 /// **Semantics**:
7475 /// 1. The first `max_rows` rows (by hot-tier position — same as
7476 /// insertion order under v4.39 `PersistentVec`) are read.
7477 /// 2. Rows are sorted ascending by PK and serialised into a new
7478 /// segment via [`encode_segment`].
7479 /// 3. The hot rows are dropped via [`Table::delete_rows`]; the
7480 /// `rebuild_indices` it triggers regenerates `Hot` locators
7481 /// for every remaining row (their positions shift down by
7482 /// `max_rows`). Existing `Cold` locators in this index — from
7483 /// a previous freeze — are also rebuilt **but with empty
7484 /// payload** since rebuild reads only `self.rows`; this
7485 /// routine re-registers them at the end of the call so the
7486 /// user-visible state preserves all prior cold locators.
7487 /// 4. The new segment is loaded into `self.cold_segments` via
7488 /// [`Catalog::load_segment_bytes`] (allocating a fresh
7489 /// `segment_id`). New `Cold` locators are registered on the
7490 /// named index — one per frozen row.
7491 ///
7492 /// **v5.2.2 limits** (relaxed in later sub-versions):
7493 /// - INSERT-only flow: subsequent UPDATE/DELETE on a frozen row
7494 /// returns a stale-locator error (no promote-on-write until
7495 /// v5.2.3).
7496 /// - Single-table scope: callers iterate tables themselves.
7497 /// - All-or-nothing: returns `Err` and leaves catalog unchanged
7498 /// if any step fails before the atomic swap point.
7499 ///
7500 /// Errors:
7501 /// - [`StorageError::Corrupt`] for missing table/index, non-`BTree`
7502 /// index, non-integer PK column, `max_rows == 0`, or
7503 /// `max_rows > row_count`.
7504 /// - The encoder's [`SegmentError`] surfaces as `Corrupt` (the
7505 /// only realistic source is "a single row is larger than the
7506 /// page size"; SPG schemas don't hit it in practice).
7507 pub fn freeze_oldest_to_cold(
7508 &mut self,
7509 table_name: &str,
7510 index_name: &str,
7511 max_rows: usize,
7512 ) -> Result<FreezeReport, StorageError> {
7513 // --- validation phase: never mutates ---------------------
7514 if max_rows == 0 {
7515 return Err(StorageError::Corrupt(
7516 "freeze_oldest_to_cold: max_rows must be > 0".into(),
7517 ));
7518 }
7519 let table = self.get(table_name).ok_or_else(|| {
7520 StorageError::Corrupt(format!(
7521 "freeze_oldest_to_cold: table {table_name:?} not found"
7522 ))
7523 })?;
7524 if max_rows > table.rows.len() {
7525 return Err(StorageError::Corrupt(format!(
7526 "freeze_oldest_to_cold: max_rows {max_rows} > row_count {}",
7527 table.rows.len()
7528 )));
7529 }
7530 let idx = table
7531 .indices
7532 .iter()
7533 .find(|i| i.name == index_name)
7534 .ok_or_else(|| {
7535 StorageError::Corrupt(format!(
7536 "freeze_oldest_to_cold: index {index_name:?} not found on {table_name:?}"
7537 ))
7538 })?;
7539 if !matches!(idx.kind, IndexKind::BTree(_)) {
7540 return Err(StorageError::Corrupt(format!(
7541 "freeze_oldest_to_cold: index {index_name:?} is NSW; only BTree indices may freeze"
7542 )));
7543 }
7544 let column_position = idx.column_position;
7545
7546 // --- segment build phase: reads only --------------------
7547 let schema = table.schema.clone();
7548 let mut to_freeze: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(max_rows);
7549 for row_idx in 0..max_rows {
7550 let row = table.rows.get(row_idx).expect("bounds-checked above");
7551 let key = IndexKey::from_value(&row.values[column_position]).ok_or_else(|| {
7552 StorageError::Corrupt(format!(
7553 "freeze_oldest_to_cold: row {row_idx} has NULL / non-key value in index column"
7554 ))
7555 })?;
7556 let pk_u64 = index_key_as_u64(&key).ok_or_else(|| {
7557 StorageError::Corrupt(format!(
7558 "freeze_oldest_to_cold: index {index_name:?} column type is non-integer; \
7559 v5.2.2 cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
7560 ))
7561 })?;
7562 to_freeze.push((pk_u64, encode_row_body_dense(row, &schema), key));
7563 }
7564 // encode_segment requires ascending u64 keys. Sort by PK
7565 // before encoding; the caller's row-position order is not
7566 // necessarily PK order (e.g. workloads that insert random
7567 // PKs).
7568 to_freeze.sort_by_key(|(k, _, _)| *k);
7569 // Reject duplicate PKs — encode_segment also rejects them
7570 // (`SegmentError::UnsortedKey`), but the resulting error
7571 // message there is misleading. Surface a clearer one.
7572 for w in to_freeze.windows(2) {
7573 if w[0].0 == w[1].0 {
7574 return Err(StorageError::Corrupt(format!(
7575 "freeze_oldest_to_cold: duplicate PK {} in freeze batch",
7576 w[0].0
7577 )));
7578 }
7579 }
7580 // Snapshot the (key, locator) pairs that will be registered
7581 // post-swap. Cloning the IndexKey out before the move makes
7582 // the registration loop borrow-free.
7583 let post_swap_keys: Vec<IndexKey> = to_freeze.iter().map(|(_, _, k)| k.clone()).collect();
7584 // Segment encode is now infallible w.r.t. ordering. Map the
7585 // `SegmentError` into a `StorageError::Corrupt` so the
7586 // public surface stays one error type.
7587 let seg_rows: Vec<(u64, Vec<u8>)> = to_freeze
7588 .into_iter()
7589 .map(|(k, body, _)| (k, body))
7590 .collect();
7591 let frozen_rows = seg_rows.len();
7592 let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
7593 .map_err(|e| StorageError::Corrupt(format!("freeze_oldest_to_cold: encode: {e}")))?;
7594
7595 // --- atomic swap phase: mutations only past this point ---
7596 // v5.2.3 made `Table::rebuild_indices` preserve every Cold
7597 // locator across the per-table rebuild, so `delete_rows`
7598 // below no longer wipes prior-freeze cold entries. The pre-
7599 // v5.2.3 capture-then-re-register that used to live here
7600 // was removed in v5.3.1 — keeping it would double-count
7601 // every prior-frozen key's Cold locator on each subsequent
7602 // freeze.
7603 let bytes_before = self.get(table_name).expect("just validated").hot_bytes();
7604 let positions: Vec<usize> = (0..max_rows).collect();
7605 let t_mut = self
7606 .get_mut(table_name)
7607 .expect("just validated; still present");
7608 let removed = t_mut.delete_rows(&positions);
7609 debug_assert_eq!(removed, max_rows, "delete_rows count matches request");
7610 let bytes_after = t_mut.hot_bytes();
7611 let bytes_freed = bytes_before.saturating_sub(bytes_after);
7612
7613 let segment_id = self
7614 .load_segment_bytes(seg_bytes.clone())
7615 .map_err(|e| StorageError::Corrupt(format!("freeze_oldest_to_cold: load: {e}")))?;
7616 let new_cold = post_swap_keys.into_iter().map(|k| {
7617 (
7618 k,
7619 RowLocator::Cold {
7620 segment_id,
7621 page_offset: 0,
7622 },
7623 )
7624 });
7625 let t_mut = self.get_mut(table_name).expect("still present");
7626 t_mut.register_cold_locators(index_name, new_cold)?;
7627 // r944 — a freeze has to say that it froze something.
7628 //
7629 // `has_cold_rows_fast()` reads the cached count, and neither
7630 // freeze path touched it, so afterwards it answered "no cold
7631 // rows" while cold rows existed. That predicate gates four join
7632 // paths, and a gate that wrongly declines the cold-aware path
7633 // drops the frozen rows from the answer.
7634 //
7635 // Marking it stale rather than adding to it: stale reads as
7636 // true, which is the safe direction, and this function cannot
7637 // know the exact total (rows may already have been cold). ANALYZE
7638 // recomputes the number.
7639 t_mut.mark_cold_row_count_stale();
7640
7641 Ok(FreezeReport {
7642 segment_id,
7643 frozen_rows,
7644 bytes_freed,
7645 segment_bytes: seg_bytes,
7646 })
7647 }
7648
7649 /// v5.1: borrow the cold segment at `segment_id`. Used by the
7650 /// spg-server preload path to enumerate (key, locator) pairs
7651 /// after loading a segment, so it can call
7652 /// [`Table::register_cold_locators`] without re-parsing the
7653 /// bytes.
7654 #[must_use]
7655 pub fn cold_segment(&self, segment_id: u32) -> Option<&OwnedSegment> {
7656 self.cold_segments
7657 .get(segment_id as usize)
7658 .and_then(|s| s.as_deref())
7659 }
7660
7661 /// v5.1: resolve a single `RowLocator::Cold` to its underlying
7662 /// `Row`. Decoupled from [`Catalog::lookup_by_pk`] so callers
7663 /// iterating a multi-locator slice (e.g. the engine's index
7664 /// seek path) can dispatch per locator instead of getting back
7665 /// only the first row for a key. Returns `None` when the
7666 /// segment isn't registered, the key isn't `u64`-coercible, or
7667 /// the segment doesn't actually carry the key (bloom or page-
7668 /// index reject).
7669 pub fn resolve_cold_locator(
7670 &self,
7671 table_name: &str,
7672 segment_id: u32,
7673 key: &IndexKey,
7674 ) -> Option<Row<'static>> {
7675 let t = self.get(table_name)?;
7676 let u64_key = index_key_as_u64(key)?;
7677 let seg = self.cold_segments.get(segment_id as usize)?.as_ref()?;
7678 let payload = seg.lookup(u64_key)?;
7679 let (row, _) = decode_row_body_dense(&payload, &t.schema, seg.codec_version()).ok()?;
7680 // v7.39 (pg_stat blks knife) — one cold-tier "block read".
7681 self.cold_read_stats
7682 .cold_reads
7683 .fetch_add(1, core::sync::atomic::Ordering::Relaxed);
7684 Some(row)
7685 }
7686
7687 /// v5.1: indexed PK lookup that dispatches per locator,
7688 /// returning the first matching row from either the hot tier
7689 /// (`Table::rows`) or a registered cold segment.
7690 ///
7691 /// The cold path requires the index column to be coercible to
7692 /// a `u64` (the segment's PK type) and the segment payload to
7693 /// be a [`encode_row_body_dense`]-encoded row body for the
7694 /// same schema. v5.1 ships this for BIGINT / INT / SMALLINT
7695 /// PKs; other types fall through to hot-only behavior.
7696 ///
7697 /// Returns `None` if (a) the table or index doesn't exist,
7698 /// (b) the key isn't in the index at all, or (c) the key was
7699 /// resolved to a stale locator (Hot index out of range, Cold
7700 /// segment id unknown, segment lookup miss). Does not surface
7701 /// segment-decode errors — those would indicate corrupted
7702 /// cold-tier files and should be caught at
7703 /// [`Catalog::load_segment_bytes`] time.
7704 pub fn lookup_by_pk(&self, table: &str, index_name: &str, key: &IndexKey) -> Option<Row<'_>> {
7705 let t = self.get(table)?;
7706 let idx = t.indices.iter().find(|i| i.name == index_name)?;
7707 let locators = idx.lookup_eq(key);
7708 let cold_u64_key = index_key_as_u64(key);
7709 for loc in locators {
7710 match *loc {
7711 RowLocator::Hot(i) => {
7712 if let Some(row) = t.rows.get(i) {
7713 return Some(row.clone());
7714 }
7715 }
7716 RowLocator::Cold {
7717 segment_id,
7718 page_offset: _,
7719 } => {
7720 let Some(u64_key) = cold_u64_key else {
7721 // Key type not coercible to u64 — cold tier
7722 // only handles BIGINT/INT/SMALLINT in v5.1.
7723 continue;
7724 };
7725 let Some(seg) = self
7726 .cold_segments
7727 .get(segment_id as usize)
7728 .and_then(|s| s.as_deref())
7729 else {
7730 // v6.7.3 — `None` slot = compaction
7731 // retired this segment; the live locator
7732 // on a freshly-compacted index points to
7733 // the merged segment_id, so a Cold hit
7734 // here against a tombstone means the BTree
7735 // entry hasn't been swapped yet (mid-
7736 // compaction reader race) or the caller is
7737 // looking up a stale snapshot. Skip — the
7738 // next locator in the list, if any, is
7739 // typically the merged segment.
7740 continue;
7741 };
7742 let Some(payload) = seg.lookup(u64_key) else {
7743 continue;
7744 };
7745 let (row, _) =
7746 decode_row_body_dense(&payload, &t.schema, seg.codec_version()).ok()?;
7747 return Some(row);
7748 }
7749 }
7750 }
7751 None
7752 }
7753
7754 /// v5.2.3: promote a frozen row back to the hot tier so an
7755 /// UPDATE / DELETE can mutate it. Reads the cold-tier row body
7756 /// (decoded from its registered segment), pushes it into
7757 /// `table.rows` via [`Table::insert`] (which also adds a fresh
7758 /// `Hot(new_idx)` locator on `index_name`), then retires the
7759 /// shadowed `Cold` locator via
7760 /// [`Table::remove_cold_locators_for_key`]. The cold-tier row
7761 /// in the segment file becomes garbage — recoverable when a
7762 /// future cold-segment compaction job lands.
7763 ///
7764 /// Returns:
7765 /// - `Ok(Some(new_hot_idx))` when the key resolved through a
7766 /// cold locator and the promote completed. `new_hot_idx` is
7767 /// the position the row now occupies in `table.rows`.
7768 /// - `Ok(None)` when the key has no Cold locator on the index
7769 /// (already hot, or wasn't present at all). Callers treat this
7770 /// as "nothing to do here, fall back to the hot-only path".
7771 ///
7772 /// Errors when the table / index doesn't exist, the index isn't
7773 /// `BTree`, the cold segment is missing / can't decode the row,
7774 /// or the inferred row body fails `Table::insert` validation.
7775 pub fn promote_cold_row(
7776 &mut self,
7777 table_name: &str,
7778 index_name: &str,
7779 key: &IndexKey,
7780 ) -> Result<Option<usize>, StorageError> {
7781 let cold_loc = self.find_cold_locator(table_name, index_name, key)?;
7782 let Some((segment_id, _page_offset)) = cold_loc else {
7783 return Ok(None);
7784 };
7785 let u64_key = index_key_as_u64(key).ok_or_else(|| {
7786 StorageError::Corrupt(
7787 "promote_cold_row: key type not coercible to u64 (cold tier requires integer PK)"
7788 .into(),
7789 )
7790 })?;
7791 // Read the row body from the segment. Borrow the segment +
7792 // schema short-term so we can then take `&mut self` for the
7793 // hot-side insert.
7794 let schema = self
7795 .get(table_name)
7796 .ok_or_else(|| {
7797 StorageError::Corrupt(format!("promote_cold_row: table {table_name:?} not found"))
7798 })?
7799 .schema
7800 .clone();
7801 let seg = self
7802 .cold_segments
7803 .get(segment_id as usize)
7804 .and_then(|s| s.as_ref())
7805 .ok_or_else(|| {
7806 StorageError::Corrupt(format!(
7807 "promote_cold_row: segment {segment_id} not registered on catalog"
7808 ))
7809 })?;
7810 let payload = seg.lookup(u64_key).ok_or_else(|| {
7811 StorageError::Corrupt(format!(
7812 "promote_cold_row: key {u64_key} resolves to segment {segment_id} \
7813 but the segment's bloom/page lookup didn't return a row"
7814 ))
7815 })?;
7816 let (row, _consumed) = decode_row_body_dense(&payload, &schema, seg.codec_version())?;
7817 // Insert the promoted row into the hot tier. `Table::insert`
7818 // appends to `self.rows`, adds a `Hot(new_idx)` locator to
7819 // every BTree index covering the row's keyed columns, and
7820 // increments `hot_bytes`.
7821 let t = self
7822 .get_mut(table_name)
7823 .expect("table existed at lookup time");
7824 t.insert(row)?;
7825 let new_hot_idx =
7826 t.rows.len().checked_sub(1).ok_or_else(|| {
7827 StorageError::Corrupt("promote_cold_row: empty after insert".into())
7828 })?;
7829 // The hot insert added Hot(new_idx) alongside the still-
7830 // present Cold locator. Drop the Cold entry so future
7831 // lookups return only the fresh hot row.
7832 t.remove_cold_locators_for_key(index_name, key)?;
7833 Ok(Some(new_hot_idx))
7834 }
7835
7836 /// v5.2.3: shadow a frozen row's index entry. Used by DELETE
7837 /// when the row to remove lives in a cold-tier segment — the
7838 /// row body stays in the segment file (becoming garbage) but
7839 /// every `Cold` locator for `key` on `index_name` is removed
7840 /// so PK lookups stop returning it.
7841 ///
7842 /// Returns the number of cold locators retired (0 when the key
7843 /// has no cold entries — the DELETE fell on a hot row or a
7844 /// key that was already absent). Errors when the table /
7845 /// index doesn't exist or the index isn't `BTree`.
7846 ///
7847 /// Cold-segment compaction (which merges shadowed-heavy
7848 /// segments and reclaims their disk footprint) lands in a
7849 /// later v5.x sub-version; until then, repeated UPDATE/DELETE
7850 /// of cold rows can amplify cold-segment disk usage by up to
7851 /// 1-2× — still well under typical LSM-tree shadowing because
7852 /// SPG segments are bulk-baked, not write-merged.
7853 pub fn shadow_cold_row(
7854 &mut self,
7855 table_name: &str,
7856 index_name: &str,
7857 key: &IndexKey,
7858 ) -> Result<usize, StorageError> {
7859 let t = self.get_mut(table_name).ok_or_else(|| {
7860 StorageError::Corrupt(format!("shadow_cold_row: table {table_name:?} not found"))
7861 })?;
7862 t.remove_cold_locators_for_key(index_name, key)
7863 }
7864
7865 /// v6.7.4 — read-only slice preparation for the parallel
7866 /// freezer. Walks rows in `row_range`, builds the
7867 /// `(pk_u64, encoded_body, IndexKey)` triples that the
7868 /// coordinator's k-way merge consumes, sorts the slice by
7869 /// `pk_u64`, and returns a [`FreezeSlice`].
7870 ///
7871 /// Caller invariants:
7872 /// - `row_range.end <= table.rows.len()` (caller's job to
7873 /// compute the partition).
7874 /// - All slices passed to `commit_freeze_slices` must cover a
7875 /// contiguous half-open range `[0, total_max_rows)` with no
7876 /// gaps and no overlaps. The coordinator validates this
7877 /// invariant before committing.
7878 ///
7879 /// `&self`-only — multiple workers can run this concurrently
7880 /// against the same `Catalog` reference under the engine's
7881 /// write lock (workers don't mutate; the coordinator does).
7882 pub fn prepare_freeze_slice(
7883 &self,
7884 table_name: &str,
7885 index_name: &str,
7886 row_range: core::ops::Range<usize>,
7887 ) -> Result<FreezeSlice, StorageError> {
7888 let table = self.get(table_name).ok_or_else(|| {
7889 StorageError::Corrupt(format!(
7890 "prepare_freeze_slice: table {table_name:?} not found"
7891 ))
7892 })?;
7893 let idx = table
7894 .indices
7895 .iter()
7896 .find(|i| i.name == index_name)
7897 .ok_or_else(|| {
7898 StorageError::Corrupt(format!(
7899 "prepare_freeze_slice: index {index_name:?} not found on {table_name:?}"
7900 ))
7901 })?;
7902 if !matches!(idx.kind, IndexKind::BTree(_)) {
7903 return Err(StorageError::Corrupt(format!(
7904 "prepare_freeze_slice: index {index_name:?} is NSW; only BTree indices may freeze"
7905 )));
7906 }
7907 if row_range.end > table.rows.len() {
7908 return Err(StorageError::Corrupt(format!(
7909 "prepare_freeze_slice: row_range end {} > row_count {}",
7910 row_range.end,
7911 table.rows.len()
7912 )));
7913 }
7914 let column_position = idx.column_position;
7915 let schema = table.schema.clone();
7916 let mut rows: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(row_range.len());
7917 for row_idx in row_range.clone() {
7918 let row = table.rows.get(row_idx).expect("bounds-checked above");
7919 let key = IndexKey::from_value(&row.values[column_position]).ok_or_else(|| {
7920 StorageError::Corrupt(format!(
7921 "prepare_freeze_slice: row {row_idx} has NULL / non-key value in index column"
7922 ))
7923 })?;
7924 let pk_u64 = index_key_as_u64(&key).ok_or_else(|| {
7925 StorageError::Corrupt(format!(
7926 "prepare_freeze_slice: index {index_name:?} column type is non-integer; \
7927 v5.2.2 cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
7928 ))
7929 })?;
7930 rows.push((pk_u64, encode_row_body_dense(row, &schema), key));
7931 }
7932 rows.sort_by_key(|(k, _, _)| *k);
7933 Ok(FreezeSlice { row_range, rows })
7934 }
7935
7936 /// v6.7.4 — coordinator commit step. Merges N
7937 /// [`FreezeSlice`]s into one segment via the standard
7938 /// [`encode_segment`] path, atomically swaps the catalog
7939 /// state (delete the union row range + register Cold
7940 /// locators + load the segment).
7941 ///
7942 /// Validates that the slices cover a contiguous, gap-free,
7943 /// overlap-free half-open range starting at index 0 (the
7944 /// freezer always freezes "oldest first" — same semantics as
7945 /// the single-threaded [`Catalog::freeze_oldest_to_cold`]).
7946 ///
7947 /// Empty `slices` → no-op success (returns a zero-row report
7948 /// without mutating). Total row count = `Σ slice.rows.len()`.
7949 pub fn commit_freeze_slices(
7950 &mut self,
7951 table_name: &str,
7952 index_name: &str,
7953 slices: Vec<FreezeSlice>,
7954 ) -> Result<FreezeReport, StorageError> {
7955 // --- validation phase: never mutates ---------------------
7956 let table = self.get(table_name).ok_or_else(|| {
7957 StorageError::Corrupt(format!(
7958 "commit_freeze_slices: table {table_name:?} not found"
7959 ))
7960 })?;
7961 let idx = table
7962 .indices
7963 .iter()
7964 .find(|i| i.name == index_name)
7965 .ok_or_else(|| {
7966 StorageError::Corrupt(format!(
7967 "commit_freeze_slices: index {index_name:?} not found on {table_name:?}"
7968 ))
7969 })?;
7970 if !matches!(idx.kind, IndexKind::BTree(_)) {
7971 return Err(StorageError::Corrupt(format!(
7972 "commit_freeze_slices: index {index_name:?} is NSW; only BTree indices may freeze"
7973 )));
7974 }
7975 // Validate slice coverage: contiguous from 0, no gaps, no
7976 // overlaps. Allow the caller to pass slices in any order —
7977 // sort by row_range.start first.
7978 let mut ordered = slices;
7979 ordered.sort_by_key(|s| s.row_range.start);
7980 // Drop fully-empty slices that fell out of an uneven
7981 // partition; they carry no data but contribute to the
7982 // contiguity check, so keep them in line.
7983 let mut expected_start = 0usize;
7984 for s in &ordered {
7985 if s.row_range.start != expected_start {
7986 return Err(StorageError::Corrupt(format!(
7987 "commit_freeze_slices: gap/overlap at row {}; expected start {}",
7988 s.row_range.start, expected_start
7989 )));
7990 }
7991 expected_start = s.row_range.end;
7992 }
7993 let max_rows = expected_start;
7994 if max_rows > table.rows.len() {
7995 return Err(StorageError::Corrupt(format!(
7996 "commit_freeze_slices: total row range {} exceeds row_count {}",
7997 max_rows,
7998 table.rows.len()
7999 )));
8000 }
8001 if max_rows == 0 {
8002 return Ok(FreezeReport {
8003 segment_id: u32::MAX,
8004 frozen_rows: 0,
8005 bytes_freed: 0,
8006 segment_bytes: Vec::new(),
8007 });
8008 }
8009
8010 // --- segment build phase: reads only --------------------
8011 // K-way merge of already-sorted slices. Each slice's rows
8012 // are ascending by pk_u64; we keep a per-slice cursor and
8013 // pull the next-smallest head until every cursor drains.
8014 let total_rows: usize = ordered.iter().map(|s| s.rows.len()).sum();
8015 if total_rows != max_rows {
8016 return Err(StorageError::Corrupt(format!(
8017 "commit_freeze_slices: total slice rows {total_rows} ≠ row_range coverage {max_rows}"
8018 )));
8019 }
8020 let mut cursors: Vec<usize> = alloc::vec![0; ordered.len()];
8021 let mut merged: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(total_rows);
8022 loop {
8023 // Pick the slice whose head row has the smallest key
8024 // and isn't yet exhausted.
8025 let mut pick: Option<usize> = None;
8026 for (i, c) in cursors.iter().enumerate() {
8027 let slice = &ordered[i];
8028 if *c >= slice.rows.len() {
8029 continue;
8030 }
8031 match pick {
8032 None => pick = Some(i),
8033 Some(j) => {
8034 if slice.rows[*c].0 < ordered[j].rows[cursors[j]].0 {
8035 pick = Some(i);
8036 }
8037 }
8038 }
8039 }
8040 let Some(i) = pick else { break };
8041 let row = ordered[i].rows[cursors[i]].clone();
8042 cursors[i] += 1;
8043 merged.push(row);
8044 }
8045 // Reject duplicate PKs — same error as the single-threaded
8046 // path so callers get a uniform surface.
8047 for w in merged.windows(2) {
8048 if w[0].0 == w[1].0 {
8049 return Err(StorageError::Corrupt(format!(
8050 "commit_freeze_slices: duplicate PK {} across slices",
8051 w[0].0
8052 )));
8053 }
8054 }
8055 let post_swap_keys: Vec<IndexKey> = merged.iter().map(|(_, _, k)| k.clone()).collect();
8056 let seg_rows: Vec<(u64, Vec<u8>)> =
8057 merged.into_iter().map(|(k, body, _)| (k, body)).collect();
8058 let frozen_rows = seg_rows.len();
8059 let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
8060 .map_err(|e| StorageError::Corrupt(format!("commit_freeze_slices: encode: {e}")))?;
8061
8062 // --- atomic swap phase: mutations only past this point ---
8063 let bytes_before = self.get(table_name).expect("just validated").hot_bytes();
8064 let positions: Vec<usize> = (0..max_rows).collect();
8065 let t_mut = self
8066 .get_mut(table_name)
8067 .expect("just validated; still present");
8068 let removed = t_mut.delete_rows(&positions);
8069 debug_assert_eq!(removed, max_rows, "delete_rows count matches request");
8070 let bytes_after = t_mut.hot_bytes();
8071 let bytes_freed = bytes_before.saturating_sub(bytes_after);
8072
8073 let segment_id = self
8074 .load_segment_bytes(seg_bytes.clone())
8075 .map_err(|e| StorageError::Corrupt(format!("commit_freeze_slices: load: {e}")))?;
8076 let new_cold = post_swap_keys.into_iter().map(|k| {
8077 (
8078 k,
8079 RowLocator::Cold {
8080 segment_id,
8081 page_offset: 0,
8082 },
8083 )
8084 });
8085 let t_mut = self.get_mut(table_name).expect("still present");
8086 t_mut.register_cold_locators(index_name, new_cold)?;
8087 // r944 — a freeze has to say that it froze something.
8088 //
8089 // `has_cold_rows_fast()` reads the cached count, and neither
8090 // freeze path touched it, so afterwards it answered "no cold
8091 // rows" while cold rows existed. That predicate gates four join
8092 // paths, and a gate that wrongly declines the cold-aware path
8093 // drops the frozen rows from the answer.
8094 //
8095 // Marking it stale rather than adding to it: stale reads as
8096 // true, which is the safe direction, and this function cannot
8097 // know the exact total (rows may already have been cold). ANALYZE
8098 // recomputes the number.
8099 t_mut.mark_cold_row_count_stale();
8100
8101 Ok(FreezeReport {
8102 segment_id,
8103 frozen_rows,
8104 bytes_freed,
8105 segment_bytes: seg_bytes,
8106 })
8107 }
8108
8109 /// v6.7.3 — compact every cold segment on `(table, index)` whose
8110 /// `OwnedSegment::bytes().len()` is below `target_segment_bytes`
8111 /// into a single larger merged segment. Rows present in source
8112 /// segment payloads but no longer referenced by any
8113 /// `RowLocator::Cold` on the index (DELETE'd + frozen rows
8114 /// retired via [`Catalog::shadow_cold_row`]) are GC'd in the
8115 /// merge.
8116 ///
8117 /// **Semantics**:
8118 /// 1. Walk the BTree index to collect every Cold locator that
8119 /// targets a small (< threshold) segment. Each such
8120 /// `(key, segment_id)` becomes a row in the merged segment;
8121 /// payload is looked up from the source segment in-place.
8122 /// 2. Encode the collected rows into one new segment via
8123 /// [`encode_segment`]; register it via
8124 /// [`Catalog::load_segment_bytes`] (allocating a fresh
8125 /// `merged_segment_id` at the end of `cold_segments`).
8126 /// 3. Rewrite the BTree index in one pass: every
8127 /// `RowLocator::Cold { segment_id ∈ sources }` becomes
8128 /// `RowLocator::Cold { segment_id = merged_id, page_offset = 0 }`.
8129 /// Hot locators are untouched.
8130 /// 4. Tombstone every source slot via
8131 /// [`Catalog::tombstone_segment`]. Source segment payloads
8132 /// are no longer reachable through the catalog; the on-disk
8133 /// files are the caller's concern.
8134 ///
8135 /// On fewer than 2 candidate segments the catalog is **not**
8136 /// mutated and a no-op report (`merged_segment_id: None`,
8137 /// `sources: []`) is returned. This is the routine case — a
8138 /// freshly-frozen table has at most 1 small segment, no merge
8139 /// possible.
8140 ///
8141 /// Atomicity: every mutating step runs after the read-only
8142 /// gather phase, so a panic before the merge encode leaves the
8143 /// catalog unchanged. The mutation block itself (load + rewrite +
8144 /// tombstone) takes only `&mut self` — callers serialise the
8145 /// engine write lock outside this function.
8146 ///
8147 /// Errors when the table / index doesn't exist, the index isn't
8148 /// `BTree`, the index column type isn't u64-coercible (cold-tier
8149 /// pre-condition), or a source segment fails its in-place
8150 /// row-body lookup (would indicate prior catalog corruption).
8151 pub fn compact_cold_segments(
8152 &mut self,
8153 table_name: &str,
8154 index_name: &str,
8155 target_segment_bytes: u64,
8156 ) -> Result<CompactReport, StorageError> {
8157 // --- validation phase ----------------------------------
8158 let t = self.get(table_name).ok_or_else(|| {
8159 StorageError::Corrupt(format!(
8160 "compact_cold_segments: table {table_name:?} not found"
8161 ))
8162 })?;
8163 let idx = t
8164 .indices
8165 .iter()
8166 .find(|i| i.name == index_name)
8167 .ok_or_else(|| {
8168 StorageError::Corrupt(format!(
8169 "compact_cold_segments: index {index_name:?} not found on {table_name:?}"
8170 ))
8171 })?;
8172 let map = match &idx.kind {
8173 IndexKind::BTree(m) => m,
8174 IndexKind::Nsw(_)
8175 | IndexKind::Brin { .. }
8176 | IndexKind::Gin(_)
8177 | IndexKind::GinTrgm(_)
8178 | IndexKind::GinFulltext(_)
8179 | IndexKind::GinJsonb(_)
8180 | IndexKind::BTreeMulti(_) => {
8181 return Err(StorageError::Corrupt(format!(
8182 "compact_cold_segments: index {index_name:?} is not BTree; \
8183 compaction applies only to BTree cold-tier indices"
8184 )));
8185 }
8186 };
8187
8188 // --- gather phase --------------------------------------
8189 // Step A: every segment_id this BTree index Cold-references.
8190 let mut referenced_ids: BTreeSet<u32> = BTreeSet::new();
8191 for (_key, locators) in map.iter() {
8192 for loc in locators {
8193 if let RowLocator::Cold { segment_id, .. } = loc {
8194 referenced_ids.insert(*segment_id);
8195 }
8196 }
8197 }
8198 // Step B: keep only the small + still-active ones.
8199 let candidate_set: BTreeSet<u32> = referenced_ids
8200 .into_iter()
8201 .filter(|id| {
8202 self.cold_segments
8203 .get(*id as usize)
8204 .and_then(|s| s.as_deref())
8205 .is_some_and(|s| (s.bytes().len() as u64) < target_segment_bytes)
8206 })
8207 .collect();
8208 if candidate_set.len() < 2 {
8209 return Ok(CompactReport {
8210 sources: Vec::new(),
8211 merged_segment_id: None,
8212 merged_segment_bytes: Vec::new(),
8213 merged_rows: 0,
8214 deleted_rows_pruned: 0,
8215 bytes_reclaimed_estimate: 0,
8216 });
8217 }
8218 // Step C: pre-count source rows for the deleted-pruned metric.
8219 let mut source_row_count: usize = 0;
8220 let mut source_byte_total: u64 = 0;
8221 for &id in &candidate_set {
8222 let seg = self.cold_segments[id as usize]
8223 .as_ref()
8224 .expect("candidate selected only when slot is Some");
8225 source_row_count = source_row_count.saturating_add(seg.meta().num_rows as usize);
8226 source_byte_total = source_byte_total.saturating_add(seg.bytes().len() as u64);
8227 }
8228 // Step D: collect (key, body) pairs from every live Cold
8229 // locator pointing at a candidate. dedupe by key — one
8230 // BTree key resolves to at most one cold payload (the
8231 // freezer + promote/shadow flow keeps Cold locators
8232 // unique per key).
8233 let mut collected: BTreeMap<u64, (Vec<u8>, IndexKey)> = BTreeMap::new();
8234 for (key, locators) in map.iter() {
8235 for loc in locators {
8236 let RowLocator::Cold { segment_id, .. } = loc else {
8237 continue;
8238 };
8239 if !candidate_set.contains(segment_id) {
8240 continue;
8241 }
8242 let u64_key = index_key_as_u64(key).ok_or_else(|| {
8243 StorageError::Corrupt(format!(
8244 "compact_cold_segments: index {index_name:?} has non-integer Cold key; \
8245 cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
8246 ))
8247 })?;
8248 let seg = self.cold_segments[*segment_id as usize]
8249 .as_ref()
8250 .expect("candidate slot guaranteed Some above");
8251 let payload = seg.lookup(u64_key).ok_or_else(|| {
8252 StorageError::Corrupt(format!(
8253 "compact_cold_segments: BTree {index_name:?} points key={u64_key} \
8254 at segment {segment_id} but the segment lookup missed"
8255 ))
8256 })?;
8257 collected.insert(u64_key, (payload, key.clone()));
8258 break;
8259 }
8260 }
8261 let merged_rows = collected.len();
8262 let deleted_rows_pruned = source_row_count.saturating_sub(merged_rows);
8263
8264 // Step E: encode the merged segment. `BTreeMap<u64, _>`
8265 // iteration is ascending by key, which is what
8266 // `encode_segment` requires.
8267 let seg_rows: Vec<(u64, Vec<u8>)> = collected
8268 .iter()
8269 .map(|(k, (body, _))| (*k, body.clone()))
8270 .collect();
8271 let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
8272 .map_err(|e| StorageError::Corrupt(format!("compact_cold_segments: encode: {e}")))?;
8273 let merged_bytes_len = seg_bytes.len() as u64;
8274
8275 // --- atomic mutation phase ------------------------------
8276 let merged_segment_id = self
8277 .load_segment_bytes(seg_bytes.clone())
8278 .map_err(|e| StorageError::Corrupt(format!("compact_cold_segments: load: {e}")))?;
8279
8280 // Rewrite the BTree index: every Cold locator pointing at
8281 // a candidate source becomes a Cold locator pointing at
8282 // the merged segment. Use a flat collect-then-replace
8283 // pattern so we never hold a `&self` borrow across the
8284 // `&mut self` write.
8285 let entries: Vec<(IndexKey, crate::posting::PostingList)> = {
8286 let t = self
8287 .get(table_name)
8288 .expect("table existed at the start of this fn");
8289 let idx = t
8290 .indices
8291 .iter()
8292 .find(|i| i.name == index_name)
8293 .expect("index existed at the start of this fn");
8294 let IndexKind::BTree(map) = &idx.kind else {
8295 unreachable!("validated above");
8296 };
8297 map.iter().map(|(k, v)| (k.clone(), v.clone())).collect()
8298 };
8299 let t_mut = self
8300 .get_mut(table_name)
8301 .expect("table existed at the start of this fn");
8302 let idx_mut = t_mut
8303 .indices
8304 .iter_mut()
8305 .find(|i| i.name == index_name)
8306 .expect("index existed at the start of this fn");
8307 let IndexKind::BTree(map_mut) = &mut idx_mut.kind else {
8308 unreachable!("validated above");
8309 };
8310 for (key, locators) in entries {
8311 let mut new_locs = crate::posting::PostingList::new();
8312 let mut changed = false;
8313 for loc in &locators {
8314 match *loc {
8315 RowLocator::Cold {
8316 segment_id,
8317 page_offset: _,
8318 } if candidate_set.contains(&segment_id) => {
8319 let replacement = RowLocator::Cold {
8320 segment_id: merged_segment_id,
8321 page_offset: 0,
8322 };
8323 if !new_locs.contains(replacement) {
8324 new_locs.push(replacement);
8325 }
8326 changed = true;
8327 }
8328 other => new_locs.push(other),
8329 }
8330 }
8331 if changed {
8332 map_mut.insert_mut(key, new_locs);
8333 }
8334 }
8335
8336 // Tombstone every source slot. Last step — failures here
8337 // would leave the segment double-referenced in both
8338 // memory + manifest, but `tombstone_segment` only errors
8339 // on out-of-bounds, which we've already validated.
8340 for &id in &candidate_set {
8341 self.tombstone_segment(id)?;
8342 }
8343
8344 let bytes_reclaimed_estimate = source_byte_total.saturating_sub(merged_bytes_len);
8345 Ok(CompactReport {
8346 sources: candidate_set.into_iter().collect(),
8347 merged_segment_id: Some(merged_segment_id),
8348 merged_segment_bytes: seg_bytes,
8349 merged_rows,
8350 deleted_rows_pruned,
8351 bytes_reclaimed_estimate,
8352 })
8353 }
8354
8355 /// Internal helper: scan `(table, index)` for a `Cold` locator
8356 /// keyed by `key`. Returns `Ok(Some((segment_id, page_offset)))`
8357 /// when found, `Ok(None)` when the key has only hot entries
8358 /// or no entries at all, `Err` on the same input-validation
8359 /// errors as the public `promote_cold_row` / `shadow_cold_row`.
8360 fn find_cold_locator(
8361 &self,
8362 table_name: &str,
8363 index_name: &str,
8364 key: &IndexKey,
8365 ) -> Result<Option<(u32, u32)>, StorageError> {
8366 let t = self.get(table_name).ok_or_else(|| {
8367 StorageError::Corrupt(format!("find_cold_locator: table {table_name:?} not found"))
8368 })?;
8369 let idx = t
8370 .indices
8371 .iter()
8372 .find(|i| i.name == index_name)
8373 .ok_or_else(|| {
8374 StorageError::Corrupt(format!(
8375 "find_cold_locator: index {index_name:?} not found on {table_name:?}"
8376 ))
8377 })?;
8378 if !matches!(idx.kind, IndexKind::BTree(_)) {
8379 return Err(StorageError::Corrupt(format!(
8380 "find_cold_locator: index {index_name:?} is NSW; promote-on-write only applies to BTree indices"
8381 )));
8382 }
8383 for loc in idx.lookup_eq(key) {
8384 if let RowLocator::Cold {
8385 segment_id,
8386 page_offset,
8387 } = *loc
8388 {
8389 return Ok(Some((segment_id, page_offset)));
8390 }
8391 }
8392 Ok(None)
8393 }
8394}
8395
8396/// Coerce an [`IndexKey`] to the `u64` that v5.1 cold-tier
8397/// segments use as their on-disk PK. Returns `None` for keys that
8398/// aren't representable as `u64` — Text PKs need a hash mapping
8399/// the segment writer baked in (deferred to v5.2+), Bool PKs are
8400/// almost never wide enough to be sharded into a cold tier.
8401fn index_key_as_u64(key: &IndexKey) -> Option<u64> {
8402 match key {
8403 // Reinterpret the i64 bit pattern as u64. Cold-tier segments
8404 // are sorted by this u64 view, so the chosen interpretation
8405 // only has to match between insert (bake_segment / freezer)
8406 // and lookup — using cast_unsigned keeps both sides honest
8407 // and silences clippy::cast_sign_loss.
8408 IndexKey::Int(n) => Some(n.cast_unsigned()),
8409 // Text / Bool / Uuid / Bytes / Numeric PKs aren't representable
8410 // as u64 and so can't participate in the u64-sorted cold-tier
8411 // segment PK layout. Same deferral story as Text — lookup falls
8412 // through the in-memory btree.
8413 IndexKey::Text(_)
8414 | IndexKey::Bool(_)
8415 | IndexKey::Uuid(_)
8416 | IndexKey::Bytes(_)
8417 | IndexKey::Numeric(_)
8418 | IndexKey::Null => None,
8419 }
8420}
8421
8422#[derive(Debug, Clone, PartialEq, Eq)]
8423#[non_exhaustive]
8424pub enum StorageError {
8425 DuplicateTable {
8426 name: String,
8427 },
8428 TableNotFound {
8429 name: String,
8430 },
8431 ArityMismatch {
8432 expected: usize,
8433 actual: usize,
8434 },
8435 TypeMismatch {
8436 column: String,
8437 expected: DataType,
8438 actual: DataType,
8439 position: usize,
8440 },
8441 NullInNotNull {
8442 column: String,
8443 },
8444 /// Index with this name already exists on the table.
8445 DuplicateIndex {
8446 name: String,
8447 },
8448 /// Column referenced by an index doesn't exist on the table.
8449 ColumnNotFound {
8450 column: String,
8451 },
8452 /// On-disk format failed to parse — corrupted file, wrong magic, truncated
8453 /// payload, or unknown tag bytes.
8454 Corrupt(String),
8455 /// v6.0.4 — ALTER INDEX targeted an index name that doesn't
8456 /// exist on any table in this catalog.
8457 IndexNotFound {
8458 name: String,
8459 },
8460 /// v6.0.4 — operation requested isn't supported on this index
8461 /// kind / column type (e.g. ALTER INDEX REBUILD on a `BTree`
8462 /// index, or REBUILD WITH (encoding=…) on a non-vector column).
8463 Unsupported(String),
8464 /// v7.39 (round 220) — a CYCLE-less sequence ran past its bound.
8465 /// PG's 2200H phrasing: `nextval: reached maximum value of
8466 /// sequence "s" (n)` (`is_max: false` = the MINVALUE direction).
8467 SequenceExhausted {
8468 name: String,
8469 limit: i64,
8470 is_max: bool,
8471 },
8472}
8473
8474impl fmt::Display for StorageError {
8475 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
8476 match self {
8477 // v7.39 (read01 round 47) — PG's 42P07 wording.
8478 Self::DuplicateTable { name } => write!(f, "relation \"{name}\" already exists"),
8479 // v7.39 (read01 round 47) — PG's wording for a missing relation
8480 // (42P01). DROP TABLE says "table" and raises its own error at
8481 // the engine; every other path (SELECT / ALTER / …) says
8482 // "relation", which is what this carries.
8483 Self::TableNotFound { name } => write!(f, "relation \"{name}\" does not exist"),
8484 Self::ArityMismatch { expected, actual } => write!(
8485 f,
8486 "row arity mismatch: expected {expected} columns, got {actual}"
8487 ),
8488 Self::TypeMismatch {
8489 column,
8490 expected,
8491 actual,
8492 position,
8493 } => write!(
8494 f,
8495 "type mismatch in column {column:?} (position {position}): expected {expected}, got {actual}"
8496 ),
8497 Self::NullInNotNull { column } => {
8498 // v7.39 (SQLSTATE fidelity) — PG's 23502 phrasing (the
8499 // relation-qualified long form is added by engine call
8500 // sites that know the table name).
8501 write!(
8502 f,
8503 "null value in column \"{column}\" violates not-null constraint"
8504 )
8505 }
8506 // v7.39 (read01 round 47) — an index is a relation to PG (42P07).
8507 Self::DuplicateIndex { name } => write!(f, "relation \"{name}\" already exists"),
8508 // v7.39 (round 701) — PG's wording, and the same fix `EvalError::
8509 // ColumnNotFound` took in read01 round 81 with the same reason:
8510 // "column not found: x" matches none of the wire layer's `does
8511 // not exist` patterns, so a missing column reached the client as
8512 // the generic error class. The eval-side variant was changed and
8513 // the storage-side one was not, so which sentence you got
8514 // depended on which layer noticed — `CREATE INDEX ix ON t(nope)`
8515 // came out of storage and kept the old spelling.
8516 Self::ColumnNotFound { column } => write!(f, "column \"{column}\" does not exist"),
8517 Self::Corrupt(detail) => write!(f, "corrupt on-disk format: {detail}"),
8518 Self::IndexNotFound { name } => write!(f, "index \"{name}\" does not exist"),
8519 Self::Unsupported(detail) => write!(f, "unsupported: {detail}"),
8520 // v7.39 (round 220) — PG's exact 2200H wording.
8521 Self::SequenceExhausted {
8522 name,
8523 limit,
8524 is_max,
8525 } => write!(
8526 f,
8527 "nextval: reached {} value of sequence \"{name}\" ({limit})",
8528 if *is_max { "maximum" } else { "minimum" }
8529 ),
8530 }
8531 }
8532}
8533
8534impl ColumnSchema {
8535 pub fn new(name: impl Into<String>, ty: DataType, nullable: bool) -> Self {
8536 Self {
8537 name: name.into(),
8538 ty,
8539 nullable,
8540 collation_name: None,
8541 default: None,
8542 runtime_default: None,
8543 auto_increment: false,
8544 user_enum_type: None,
8545 user_domain_type: None,
8546 user_composite_type: None,
8547 acl: Vec::new(),
8548 on_update_runtime: None,
8549 collation: Collation::Binary,
8550 is_unsigned: false,
8551 inline_enum_variants: None,
8552 inline_set_variants: None,
8553 generated_stored_expr: None,
8554 identity_always: false,
8555 default_text: None,
8556 auto_restart: None,
8557 scalar_row_source: false,
8558 mysql_int_width: None,
8559 mysql_fsp: None,
8560 }
8561 }
8562
8563 /// v7.38.14 — the SAME column, re-described.
8564 ///
8565 /// `ColumnSchema::new` is for SYNTHESISING a column: a catalog row, an
8566 /// admin view, a computed output. It sets twenty-two fields to their
8567 /// defaults, which is right when there is no source column to speak of.
8568 ///
8569 /// It is wrong, and quietly so, when there IS one -- a join's combined
8570 /// schema, an aggregate's synthetic keys, a derived table's output. Those
8571 /// sites re-describe an existing column under a new name or type, and
8572 /// have each been written as `new(..)` followed by hand-picking a few
8573 /// attributes to copy across. They all pick differently and none picks
8574 /// them all.
8575 ///
8576 /// Five fields have been lost through that shape so far -- enum identity,
8577 /// MySQL fsp, the PG collation name, `ProjectedItem::fold_exempt`, and
8578 /// the `collation` enum -- and v7.38.14 alone found four sites dropping
8579 /// the last of those. The failure is never loud: `collation` defaults to
8580 /// `Binary`, which downstream reads as "byte-wise ON PURPOSE" rather than
8581 /// as "unknown", so a dropped declaration presents as a deliberate one.
8582 ///
8583 /// This constructor copies everything by construction. A field added to
8584 /// `ColumnSchema` therefore reaches every re-describe site without anyone
8585 /// having to remember, which is the property the hand-written copy lists
8586 /// never had.
8587 ///
8588 /// The two fields a re-describe legitimately changes -- name and
8589 /// nullability -- are parameters. Callers that also retype the column
8590 /// assign `ty` afterwards.
8591 #[must_use]
8592 pub fn rederive(source: &Self, name: impl Into<String>, nullable: bool) -> Self {
8593 Self {
8594 name: name.into(),
8595 nullable,
8596 ..source.clone()
8597 }
8598 }
8599
8600 /// Builder-style helper to attach a default value to an otherwise
8601 /// plain column schema. Used by the engine when CREATE TABLE
8602 /// specifies `column TYPE DEFAULT <expr>`.
8603 #[must_use]
8604 pub fn with_default(mut self, default: Value<'static>) -> Self {
8605 self.default = Some(default);
8606 self
8607 }
8608
8609 /// v7.9.21 — builder for runtime-evaluated defaults
8610 /// (`DEFAULT now()`, `DEFAULT CURRENT_TIMESTAMP`, …).
8611 /// `expr` is the Expr's `Display` form, re-parsed by the
8612 /// engine at each INSERT.
8613 #[must_use]
8614 pub fn with_runtime_default(mut self, expr: impl Into<String>) -> Self {
8615 self.runtime_default = Some(expr.into());
8616 self
8617 }
8618
8619 /// Builder-style helper to mark a column as `AUTO_INCREMENT`.
8620 #[must_use]
8621 pub const fn with_auto_increment(mut self) -> Self {
8622 self.auto_increment = true;
8623 self
8624 }
8625}
8626
8627impl TableSchema {
8628 pub fn new(name: impl Into<String>, columns: Vec<ColumnSchema>) -> Self {
8629 Self {
8630 name: name.into(),
8631 columns,
8632 hot_tier_bytes: None,
8633 foreign_keys: Vec::new(),
8634 uniqueness_constraints: Vec::new(),
8635 exclusion_constraints: Vec::new(),
8636 checks: Vec::new(),
8637 partition_role: None,
8638 policies: Vec::new(),
8639 row_security: false,
8640 force_row_security: false,
8641 owner: None,
8642 acl: Vec::new(),
8643 }
8644 }
8645}
8646
8647// =========================================================================
8648// Persistent binary format for the catalog.
8649//
8650// Layout (little-endian throughout):
8651//
8652// [magic "SPGDB001" 8 bytes][version u8]
8653// [table_count u32]
8654// for each table:
8655// [name_len u16][name bytes]
8656// [col_count u16]
8657// for each col:
8658// [name_len u16][name bytes]
8659// [type_tag u8 + optional payload]
8660// 1=Int 2=BigInt 3=Float 4=Text 5=Bool
8661// 6=Vector(u32 dim)
8662// 7=SmallInt
8663// 8=Varchar(u32 max)
8664// 9=Char(u32 size)
8665// 10=Numeric(u8 precision, u8 scale)
8666// 11=Date
8667// 12=Timestamp
8668// [nullable u8] 0/1
8669// [default_tag u8] 0=none 1=value (followed by [value_tag u8] + bytes)
8670// [row_count u32]
8671// for each row, for each col, one [value_tag u8] + value bytes:
8672// tag 0 (Null) → no body
8673// tag 1 (Int) → i32 LE
8674// tag 2 (BigInt) → i64 LE
8675// tag 3 (Float) → f64 LE
8676// tag 4 (Text) → u16 LE len + UTF-8 bytes
8677// tag 5 (Bool) → u8 0/1
8678// tag 6 (Vector) → u32 LE dim + dim×f32 LE
8679// tag 7 (SmallInt) → i16 LE
8680// tag 8 (Numeric) → i128 LE (16 bytes) + u8 scale
8681// tag 9 (Date) → i32 LE (days since Unix epoch)
8682// tag 10 (Timestamp) → i64 LE (microseconds since Unix epoch)
8683//
8684// Bumped to version 3 when NUMERIC was added; to version 4 when
8685// AUTO_INCREMENT (per-column flag) + NSW index `kind` byte landed;
8686// to version 5 when DATE / TIMESTAMP were added; to version 6 when
8687// NSW graph topology started travelling on disk (v2.7); to version 7
8688// when the NSW topology became multi-layer HNSW (v2.13); to version 8
8689// when row encoding switched to schema-driven dense layout (v3.0.2 —
8690// per-row NULL bitmap + per-column fixed-width body, no per-cell type
8691// tag).
8692// =========================================================================
8693
8694const FILE_MAGIC: &[u8; 8] = b"SPGDB001";
8695/// Current catalog snapshot format version emitted by [`Catalog::serialize`].
8696///
8697/// v9 (v5.2) extends v8 by serialising `BTree` index entries directly — every
8698/// `(IndexKey, Vec<RowLocator>)` pair travels on disk with the v5.1
8699/// `RowLocator::write_le` tag-prefixed codec. v8 `BTree` indices stored no
8700/// entries at all (the map was rebuilt from `Table::rows` on load); v9
8701/// preserves on-disk Cold locators so freezer-produced cold-tier index
8702/// entries survive a catalog snapshot round-trip. v8 readers are accepted
8703/// by version dispatch in [`Catalog::deserialize`] — every entry decodes
8704/// as `RowLocator::Hot(_)` via `add_index` rebuild, identical to v5.1
8705/// behaviour.
8706/// v6.7.2 — bumped from 10 to 11 to append per-table
8707/// `hot_tier_bytes: Option<u64>` after the per-table indices
8708/// section. v10 catalogs (v6.7.1) load with `hot_tier_bytes =
8709/// None` for every table (the deserialiser short-circuits when
8710/// version < 11). v11 snapshots written by a pre-v6.7.2 binary
8711/// fail loudly at the version check, matching the v6.1.2 /
8712/// v6.1.4 / v6.2.0 / v6.7.1 envelope-bump upgrade fences.
8713///
8714/// v6.8.0 — bumped from 11 to 12: per-index
8715/// `included_columns: Vec<u16>` appended at the tail of each
8716/// index payload. v11 (= v6.7.2) catalogs load with
8717/// `included_columns = Vec::new()` for every index — same
8718/// "older readers, append-only extension" pattern as the v6.7.2
8719/// hot_tier_bytes byte.
8720/// v7.13.0 — bumped from 22 to 23. mailrs round-5 G3 / G10.
8721/// Per-table appendix gains two new sections:
8722/// * `checks: Vec<String>` — CHECK predicate sources (Display
8723/// form of the AST Expr); re-parsed on INSERT/UPDATE to
8724/// enforce against candidate rows. Same persistence pattern
8725/// as `Index::partial_predicate`.
8726/// * Per `UniquenessConstraint`: trailing `nulls_not_distinct:
8727/// u8` flag for PG 15+ `UNIQUE NULLS NOT DISTINCT (cols)`
8728/// semantics.
8729/// v22 catalogs deserialise with empty `checks` and every UC
8730/// at `nulls_not_distinct = false`.
8731/// v24 introduces:
8732/// * Index kind tag 4 = trigram-GIN (`gin_trgm_ops`-flavoured
8733/// `USING gin` over a TEXT/VARCHAR column). Payload shape is
8734/// identical to tag-3 GIN (String → Vec<RowLocator>); the
8735/// keys are PG-compatible 3-byte trigram shingles instead of
8736/// tsvector lexemes. v23 catalogs deserialise unchanged — no
8737/// v23 writer ever emitted tag 4.
8738/// v25 introduces:
8739/// * Per `TriggerDef`: trailing `enabled: u8` flag (mailrs
8740/// round-9 A.2.b — `ALTER TABLE … { ENABLE | DISABLE }
8741/// TRIGGER …`). v24 catalogs deserialise with every trigger
8742/// `enabled = true`, matching pre-v7.16.1 behaviour.
8743/// v26 introduces (v7.17.0 Phase 1.1):
8744/// * Trailing SEQUENCE catalog block after triggers. Encoded
8745/// as `u32 count` followed by per-sequence:
8746/// `name`, `data_type: u8` (0=SmallInt,1=Int,2=BigInt),
8747/// `start i64`, `increment i64`, `min_value i64`,
8748/// `max_value i64`, `cache i64`, `cycle u8`,
8749/// `owned_by_tag u8` (0=NONE, 1=Column → `table`,`column`),
8750/// `last_value i64`, `is_called u8`. v25-and-below catalogs
8751/// deserialise with an empty sequences map.
8752/// v27 introduces (v7.17.0 Phase 1.2):
8753/// * Trailing VIEW catalog block after sequences. Encoded as
8754/// `u32 count` followed by per-view:
8755/// `name`, `column_count u16`, then column names, then
8756/// `body` long-string. v26-and-below catalogs deserialise
8757/// with an empty views map.
8758/// v28 introduces (v7.17.0 Phase 1.3):
8759/// * Trailing MATERIALIZED VIEW source registry block after
8760/// views. Encoded as `u32 count` followed by per-entry:
8761/// `name`, `body` long-string. The materialised rows live
8762/// as a regular Table of the same name (already covered by
8763/// the pre-existing tables block). v27-and-below catalogs
8764/// deserialise with an empty map.
8765/// v29 introduces (v7.17.0 Phase 1.4):
8766/// * Per-table user_enum_type appendix (after the CHECK
8767/// appendix). Layout: `u16 count` followed by per-binding
8768/// `[u16 col_pos][str enum_name]`. Only columns whose
8769/// `user_enum_type` is Some land here; the catalog stays
8770/// compact for the common no-enum case.
8771/// * Trailing ENUM types catalog block after materialized
8772/// views. Encoded as `u32 count` followed by per-entry:
8773/// `name`, `u16 label_count`, then `label_count` short
8774/// strings. v28-and-below catalogs deserialise with an
8775/// empty enum_types map and every column's
8776/// `user_enum_type = None`.
8777/// v30 introduces (v7.17.0 Phase 1.5):
8778/// * Per-table user_domain_type appendix (after the
8779/// user_enum_type appendix). Same shape as the enum one.
8780/// * Trailing DOMAIN types catalog block after the enum
8781/// block. Encoded as `u32 count` followed by per-entry:
8782/// `name`, `data_type` byte, `nullable u8`,
8783/// `default_present u8` + optional default string,
8784/// `u16 check_count` then `check_count` Display-form
8785/// CHECK strings. v29-and-below catalogs deserialise with
8786/// an empty domain_types map and `user_domain_type = None`.
8787/// v31 introduces (v7.17.0 Phase 1.6):
8788/// * Trailing user-schemas block after the DOMAIN block.
8789/// Encoded as `u32 count` followed by `count` schema-name
8790/// short strings. Built-in schemas (`public`, `pg_catalog`,
8791/// `information_schema`) are NOT serialised — they're
8792/// hardcoded in `is_builtin_schema`. v30-and-below catalogs
8793/// deserialise with an empty user-schemas set.
8794/// v32 introduces (v7.17.0 Phase 2.1):
8795/// * Per-table on_update_runtime appendix (after the
8796/// user_domain_type appendix). Layout: `u16 count` followed
8797/// by per-binding `[u16 col_pos][str expr_src]`. Only
8798/// columns whose `on_update_runtime` is Some land here;
8799/// the catalog stays compact when no MySQL-shaped table
8800/// uses the attribute. v31-and-below catalogs deserialise
8801/// with every column's `on_update_runtime = None`.
8802/// v33 introduces (v7.17.0 Phase 2.2):
8803/// * Index kind tag 5 = fulltext-GIN (MySQL `FULLTEXT KEY`
8804/// surface over a TEXT / VARCHAR column). Payload shape is
8805/// identical to tag-3 / tag-4 GIN (`String → Vec<RowLocator>`);
8806/// the keys are lower-cased word lexemes (same rule as
8807/// `to_tsvector('simple', text)`). v32 catalogs deserialise
8808/// unchanged — no v32 writer ever emitted tag 5, and FULLTEXT
8809/// KEY was silently dropped pre-v7.17 so no rebuild shim is
8810/// needed for round-tripped catalogs.
8811/// v34 introduces (v7.17.0 Phase 2.5):
8812/// * Per-table collation appendix (after the on_update_runtime
8813/// appendix). Sparse layout: only columns whose `collation`
8814/// is non-Binary land here. `u16 count` then per-binding
8815/// `[u16 col_pos][u8 collation_tag]` where the tag matches
8816/// `Collation::TAG_*`. Snapshots written by v33-and-below
8817/// readers deserialise every column with `collation =
8818/// Binary`, preserving the prior byte-wise compare
8819/// semantics. Unknown tags read back as Binary too — keeps
8820/// a forward-compat path if a future v35 adds variants
8821/// and someone rolls back to a v34 reader.
8822/// v35 introduces (v7.17.0 Phase 4.4):
8823/// * Per-table is_unsigned appendix (after the collation
8824/// appendix). Sparse layout: only `is_unsigned = true`
8825/// columns land. `u16 count` then per-binding `[u16 col_pos]`.
8826/// v34-and-below catalogs deserialise every column as
8827/// `is_unsigned = false`, preserving the prior silent-
8828/// accept behaviour for negative inserts on UNSIGNED columns.
8829/// v46 introduces (v7.23, mailrs round-14):
8830/// * Escaped short-string codec — `write_str` lengths >= 0xFFFF
8831/// emit `[u16 0xFFFF][u32 real_len]` so TEXT cells (mail bodies,
8832/// document text) above 64 KiB encode instead of panicking.
8833/// One-way upgrade: v45-and-below readers reject v46 catalogs
8834/// loudly via the version gate; v46 readers decode v45 catalogs
8835/// with the plain-u16 rules (0xFFFF is a legitimate length
8836/// there).
8837/// v47 introduces (v7.27, mailrs round-21):
8838/// * Escaped lengths for the REMAINING u16-length cell payloads —
8839/// BYTEA cells, TEXT[] elements, tsvector lexemes and tsquery
8840/// terms — the same `[u16 0xFFFF][u32 real_len]` escape v46
8841/// gave short strings. Round-14 fixed TEXT and missed these;
8842/// round-21 fired the BYTEA twin during a production migration.
8843/// One-way upgrade, same posture as v46.
8844/// v48 introduces (v7.37.5 β-P2, sentori cutover window):
8845/// * `INTERVAL` becomes a real column type. Catalog tag 34 in
8846/// `write_data_type`; per-row body is a fixed 16 bytes
8847/// (i64 micros + i32 days + i32 months, LE, PG-byte-equal
8848/// field order). The runtime-only days collapse is gone —
8849/// `'1 day'` and `'24 hours'` are stored distinctly. One-way
8850/// upgrade: v47 catalogs without INTERVAL columns deserialise
8851/// identically; v47 readers fed a v48 catalog that contains
8852/// INTERVAL hit the explicit "unknown data type tag: 34"
8853/// fence in `read_data_type`.
8854/// v49 introduces (v7.37.6-B, sentori Epic 2 P0):
8855/// * Per-table partition role appendix(declarative
8856/// `PARTITION BY RANGE` parent / range child / DEFAULT
8857/// child)。Layout, written **after** the inline_set_variants
8858/// appendix and **before** the per-table block close:
8859/// `[u8 role_tag]`
8860/// 0 = `None`(普通表,后向兼容默认)
8861/// 1 = `Parent`: `[u8 kind_tag (0=Range)]`
8862/// `[u16 key_col_count]` `(× u16 col_pos)`
8863/// `[u16 tmpl_count]` `(× str source)`
8864/// 2 = `Range`: `[str parent_name]` `[Bound]` `[Bound]`
8865/// 3 = `Default`: `[str parent_name]`
8866/// `PartitionBound` codec:
8867/// `[u8 bound_tag]` 0=MinValue 1=MaxValue 2=TimestampTz(`[i64 LE micros]`)
8868/// v48-and-below readers stop after the inline_set_variants
8869/// block — they don't see this appendix and deserialise every
8870/// table with `partition_role = None`. v49 writers always emit
8871/// `[0]` for plain tables, so the encoding stays one-byte-cheap.
8872/// v50 introduces (v7.37.7, sentori Epic 3 P1):
8873/// * Per-table `generated_stored_expr` appendix(stored generated
8874/// columns — `GENERATED ALWAYS AS (<expr>) STORED`)。Layout,
8875/// written **after** the partition_role appendix and before
8876/// the per-table block close:
8877/// `[u16 binding_count]`
8878/// `binding_count × { [u16 col_pos][str expr_source] }`
8879/// Sparse — only generated columns land here, so plain-shape
8880/// catalogs stay byte-for-byte identical save for the new
8881/// u16 zero count. v49-and-below readers stop after the
8882/// partition_role appendix; v50 readers default every column
8883/// to `generated_stored_expr = None` when this block is absent.
8884/// v51 introduces (v7.37.8, sentori Epic 5 P2):
8885/// * Per-index tag byte 6 = `GinJsonb`(real posting-list GIN
8886/// over a JSONB column). Payload shape mirrors tag-3 / 4 / 5:
8887/// `[u32 posting_list_count]` then `(str token, u32 locator_count,
8888/// locators …)` per posting list. Same `write_str` /
8889/// `RowLocator::write_le` codec as the rest of the GIN family.
8890/// v50 catalogs never wrote tag 6(the same DDL loaded as a
8891/// BTree fallback); v51 readers see tag 6 explicitly and dispatch
8892/// into `IndexKind::GinJsonb`.
8893/// v52 introduces (v7.37.42-T2 ζ-B composite + domain metasystem):
8894/// * Trailing COMPOSITE-types catalog block after the
8895/// user-schemas block. Encoded as `u32 count` followed by
8896/// per-entry: `name`, `u16 field_count`, then `field_count`
8897/// `[str field_name][data_type]` pairs (`write_data_type` is
8898/// reused). v51-and-below catalogs deserialise with an empty
8899/// composite_types map; v52 readers tolerate v51 catalogs by
8900/// stopping at the schema block (no composite block present
8901/// ⇒ empty map). Composite types are referenced by columns
8902/// via `ColumnSchema.user_composite_type`, mirroring the
8903/// `user_enum_type` / `user_domain_type` pattern. The block
8904/// lands here (not as a per-table appendix) so dropping the
8905/// composite type registers globally and DROP TYPE can find it
8906/// without a table scan.
8907/// v53 introduces (v7.37.16 Epic W — cross-checkpoint tombstone
8908/// durability):
8909/// * Trailing per-table MVCC appendix carrying, for every row,
8910/// its `RowHeader` (`xmin:u64`, `xmax:u64`, `flags:u8`) and its
8911/// stable `RowId` (`u64`), followed by the relation's
8912/// `next_rowid:u64`. Layout per table (after the v50
8913/// generated_stored_expr block, before the table loop closes):
8914/// `[u32 row_count]` (== `Table::rows().len()`, cross-check)
8915/// per row in physical order:
8916/// `[u64 xmin][u64 xmax][u8 flags][u64 rowid]`
8917/// `[u64 next_rowid]`
8918/// v52-and-below catalogs never wrote this block; their reader
8919/// stops after the last per-table appendix and
8920/// `deserialize_rows` leaves every row `RowHeader::frozen()`
8921/// with dense 1..=N ids — the exact pre-v53 contract. A v53
8922/// reader instead reconstructs headers + ids VERBATIM, so a
8923/// tombstone-redo naming a row inserted before the last
8924/// checkpoint resolves by `RowId` across the base-snapshot
8925/// boundary (closing the coupling the Epic W WAL slices deferred
8926/// to this format bump). Because the reader routes on `version`,
8927/// the block is strictly backward-compatible: old images load
8928/// byte-for-byte as before. `SPG_MVCC_INPLACE` is unaffected —
8929/// a gate-off database's rows are all frozen/alive, so
8930/// persisting + restoring their headers is observationally a
8931/// no-op.
8932/// v7.38 (read01 P5.05) — v54 appends a CRC32C over the whole preceding
8933/// image so a corrupted `base.spg` is caught on load instead of silently
8934/// deserialising garbage. Older images (v8..=53) carry no trailer and load
8935/// unchanged.
8936/// v7.39 (round 210) — v72 appends a per-table EXCLUDE-constraint appendix
8937/// (sparse: only tables carrying an EXCLUDE write it) at the very end of the
8938/// per-table block, after the column-ACL appendix. A v71 reader stops before
8939/// it and its tables read back with no exclusion constraints, which is what
8940/// they were.
8941/// v7.39 (round 220) — v73 appends a per-table identity-RESTART appendix
8942/// (sparse: [u16 count] then per entry [u16 col_pos][i64 LE floor]) after
8943/// the EXCLUDE appendix. A v72 reader stops before it; its columns read
8944/// back with no RESTART floor, losing only an un-consumed
8945/// `ALTER … RESTART WITH` across a restart.
8946/// r1039 — v90 adds index-key tags 4 (bytea) and 5 (the canonical
8947/// numeric key), so BYTEA and NUMERIC columns carry a real B-tree
8948/// instead of falling back to a scan. A v89 reader meeting either tag
8949/// reports a corrupt catalog rather than mis-reading it, which is the
8950/// same forward-compatibility story tag 3 (uuid) had at v36.
8951const FILE_VERSION: u8 = 91;
8952
8953/// v7.37 (round 833) — the codec version to decode a row that
8954/// [`encode_row_body_dense`] has just produced.
8955///
8956/// That encoder always writes the newest form, and every decoder gate is
8957/// a `codec_version >= N` feature test, so a freshly encoded row must be
8958/// read at the current version. Cold segments carry their own version in
8959/// their header and keep passing that; this is for in-process round
8960/// trips — sort runs on temp storage — where the bytes never outlive the
8961/// build that wrote them.
8962pub const CURRENT_ROW_CODEC_VERSION: u8 = FILE_VERSION;
8963/// First version that appends the trailing CRC32C integrity trailer.
8964const FILE_VERSION_CRC_TRAILER: u8 = 54;
8965/// Oldest format version [`Catalog::deserialize`] still accepts. v8 is the
8966/// v3.0.2 dense-row layout; pre-v8 catalogs require an offline migration.
8967const MIN_SUPPORTED_FILE_VERSION: u8 = 8;
8968
8969// IndexKey wire format (v9):
8970// tag 0 = Int → [i64 LE]
8971// tag 1 = Text → [u16 LE len + UTF-8 bytes] (via write_str / read_str)
8972// tag 2 = Bool → [u8 0/1]
8973const INDEX_KEY_TAG_INT: u8 = 0;
8974const INDEX_KEY_TAG_TEXT: u8 = 1;
8975const INDEX_KEY_TAG_BOOL: u8 = 2;
8976/// v7.17.0 — `IndexKey::Uuid([u8; 16])`. Body = raw 16 bytes
8977/// (RFC 4122 byte order). Persisted only in FILE_VERSION 36+
8978/// catalogs.
8979const INDEX_KEY_TAG_UUID: u8 = 3;
8980/// r1039 — `IndexKey::Bytes`. Body = [u32 LE len][raw bytes].
8981/// Persisted only in FILE_VERSION 90+ catalogs.
8982const INDEX_KEY_TAG_BYTES: u8 = 4;
8983/// r1039 — `IndexKey::Numeric`. Body = [u8 class][u8 neg][i32 LE exp]
8984/// [u32 LE digit count][one byte per decimal digit, 0..=9, MSD first].
8985/// Persisted only in FILE_VERSION 90+ catalogs.
8986const INDEX_KEY_TAG_NUMERIC: u8 = 5;
8987/// v7.38.1 (L12) — `IndexKey::Null`, a NULL component inside a
8988/// composite key. No body. Persisted only inside tag-7 multi-index
8989/// payloads, FILE_VERSION 91+.
8990const INDEX_KEY_TAG_NULL: u8 = 6;
8991
8992impl Catalog {
8993 /// Serialize the whole catalog (schema + every row) into a self-contained
8994 /// byte buffer. Format is documented above the impl block.
8995 pub fn serialize(&self) -> Vec<u8> {
8996 let mut out = Vec::with_capacity(64);
8997 out.extend_from_slice(FILE_MAGIC);
8998 out.push(FILE_VERSION);
8999 write_u32(
9000 &mut out,
9001 u32::try_from(self.tables.len()).expect("≤ 4G tables"),
9002 );
9003 for t in &self.tables {
9004 write_str(&mut out, &t.schema.name);
9005 write_u16(
9006 &mut out,
9007 u16::try_from(t.schema.columns.len()).expect("≤ 65k columns/table"),
9008 );
9009 for c in &t.schema.columns {
9010 write_str(&mut out, &c.name);
9011 write_data_type(&mut out, c.ty);
9012 out.push(u8::from(c.nullable));
9013 match &c.default {
9014 None => out.push(0),
9015 Some(v) => {
9016 out.push(1);
9017 write_value(&mut out, v);
9018 }
9019 }
9020 out.push(u8::from(c.auto_increment));
9021 }
9022 write_u32(
9023 &mut out,
9024 u32::try_from(t.rows.len()).expect("≤ 4G rows/table"),
9025 );
9026 // v3.0.2 dense row encoding (FILE_VERSION 8): per-row NULL
9027 // bitmap, then tightly-packed bodies. Identical wire format
9028 // as before — extracted into `encode_row_body_dense` so cold-
9029 // tier segments (v5.1+) can share the encoding.
9030 for row in &t.rows {
9031 out.extend_from_slice(&encode_row_body_dense(row, &t.schema));
9032 }
9033 // Index definitions. Per-index payload:
9034 // [name][col_pos u16][kind u8]
9035 // kind 0 = B-tree (no params — rebuilt on load)
9036 // kind 1 = NSW graph (u16 M + serialized graph)
9037 // For NSW the graph topology travels on disk so startup
9038 // doesn't re-run the O(n²M) rebuild — see v2.7 notes.
9039 write_u16(
9040 &mut out,
9041 u16::try_from(t.indices.len()).expect("≤ 65k indices/table"),
9042 );
9043 for idx in &t.indices {
9044 write_str(&mut out, &idx.name);
9045 write_u16(
9046 &mut out,
9047 u16::try_from(idx.column_position).expect("≤ 65k columns/table"),
9048 );
9049 match &idx.kind {
9050 IndexKind::BTree(map) => {
9051 out.push(0);
9052 // v9: serialise the full PB map. Each entry's
9053 // RowLocator list travels with the tag-prefixed
9054 // codec from `row_locator::write_le`, so freezer-
9055 // produced Cold locators survive a snapshot
9056 // round-trip. v8 BTree wrote nothing here and
9057 // rebuilt from rows — v9 readers tolerate v8 by
9058 // version dispatch in `Catalog::deserialize`.
9059 write_u32(
9060 &mut out,
9061 u32::try_from(map.len()).expect("≤ 4G index entries/index"),
9062 );
9063 for (key, locators) in map {
9064 write_index_key(&mut out, key);
9065 write_u32(
9066 &mut out,
9067 u32::try_from(locators.len()).expect("≤ 4G locators/key"),
9068 );
9069 for loc in locators {
9070 loc.write_le(&mut out);
9071 }
9072 }
9073 }
9074 // v7.38.1 (L12) — tag byte 7 = BTreeMulti. Payload
9075 // mirrors the tag-0 BTree encoding, with each key
9076 // written as `[u16 arity]` followed by that many
9077 // `write_index_key` components. FILE_VERSION 91+;
9078 // older catalogs never carried a multi index, so no
9079 // migration shim is needed.
9080 IndexKind::BTreeMulti(map) => {
9081 out.push(7);
9082 write_u32(
9083 &mut out,
9084 u32::try_from(map.len()).expect("≤ 4G index entries/index"),
9085 );
9086 for (key, locators) in map {
9087 write_u16(
9088 &mut out,
9089 u16::try_from(key.len()).expect("≤ 65k key components"),
9090 );
9091 for component in key.iter() {
9092 write_index_key(&mut out, component);
9093 }
9094 write_u32(
9095 &mut out,
9096 u32::try_from(locators.len()).expect("≤ 4G locators/key"),
9097 );
9098 for loc in locators {
9099 loc.write_le(&mut out);
9100 }
9101 }
9102 }
9103 IndexKind::Nsw(g) => {
9104 out.push(1);
9105 write_u16(&mut out, u16::try_from(g.m).expect("≤ 65k NSW neighbours"));
9106 write_nsw_graph(&mut out, g);
9107 }
9108 IndexKind::Brin { column_type, .. } => {
9109 // v6.7.1 — tag byte 2 = BRIN. Payload is the
9110 // column type code (1 byte mapping to the
9111 // shared DataType numeric encoding); no
9112 // further data — BRIN summaries live in
9113 // cold segments, not the catalog.
9114 out.push(2);
9115 write_data_type(&mut out, *column_type);
9116 }
9117 IndexKind::Gin(map) => {
9118 // v7.12.3 — tag byte 3 = GIN. Payload mirrors
9119 // the BTree encoding but with String (lexeme
9120 // word) keys instead of IndexKey. Tag-prefixed
9121 // RowLocator codec so freezer-produced Cold
9122 // locators survive snapshot round-trip.
9123 // FILE_VERSION 21+; v20 catalogs never wrote a
9124 // GIN index (the AM degraded to BTree fallback
9125 // pre-v7.12.3), so no migration shim is needed.
9126 out.push(3);
9127 write_u32(
9128 &mut out,
9129 u32::try_from(map.len()).expect("≤ 4G GIN posting lists"),
9130 );
9131 for (word, locators) in map {
9132 write_str(&mut out, word);
9133 write_u32(
9134 &mut out,
9135 u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9136 );
9137 for loc in locators {
9138 loc.write_le(&mut out);
9139 }
9140 }
9141 }
9142 IndexKind::GinTrgm(map) => {
9143 // v7.15.0 — tag byte 4 = GinTrgm
9144 // (`gin_trgm_ops` GIN over a TEXT column).
9145 // Payload shape is identical to tag-3 GIN —
9146 // `String → Vec<RowLocator>` posting lists.
9147 // The String keys are 3-byte trigrams instead
9148 // of tsvector lexemes; the deserializer
9149 // dispatches on the tag, not the key shape.
9150 // FILE_VERSION 24+; v23 catalogs never wrote
9151 // a trigram-GIN.
9152 out.push(4);
9153 write_u32(
9154 &mut out,
9155 u32::try_from(map.len()).expect("≤ 4G trigram-GIN posting lists"),
9156 );
9157 for (tri, locators) in map {
9158 write_str(&mut out, tri);
9159 write_u32(
9160 &mut out,
9161 u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9162 );
9163 for loc in locators {
9164 loc.write_le(&mut out);
9165 }
9166 }
9167 }
9168 IndexKind::GinFulltext(map) => {
9169 // v7.17.0 Phase 2.2 — tag byte 5 =
9170 // GinFulltext (MySQL `FULLTEXT KEY` GIN
9171 // over a TEXT/VARCHAR column). Payload
9172 // shape mirrors tag-3 / tag-4 GIN —
9173 // `String → Vec<RowLocator>` posting
9174 // lists keyed by lower-cased word
9175 // lexemes. FILE_VERSION 33+; v32 catalogs
9176 // never wrote a fulltext-GIN (FULLTEXT
9177 // KEY was silently dropped pre-v7.17).
9178 out.push(5);
9179 write_u32(
9180 &mut out,
9181 u32::try_from(map.len()).expect("≤ 4G fulltext-GIN posting lists"),
9182 );
9183 for (lex, locators) in map {
9184 write_str(&mut out, lex);
9185 write_u32(
9186 &mut out,
9187 u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9188 );
9189 for loc in locators {
9190 loc.write_le(&mut out);
9191 }
9192 }
9193 }
9194 IndexKind::GinJsonb(map) => {
9195 // v7.37.8 — tag byte 6 = GinJsonb
9196 // (real posting-list GIN over a JSONB
9197 // column; sentori Epic 5 P2). Payload
9198 // shape mirrors tag-3 / 4 / 5 — keys are
9199 // the canonical `(path, leaf)` tokens
9200 // from `jsonb_gin::extract_tokens`.
9201 // FILE_VERSION 51+; v50 catalogs never
9202 // wrote a JSONB-GIN (the same DDL loaded
9203 // as a BTree fallback).
9204 out.push(6);
9205 write_u32(
9206 &mut out,
9207 u32::try_from(map.len()).expect("≤ 4G JSONB-GIN posting lists"),
9208 );
9209 for (token, locators) in map {
9210 write_str(&mut out, token);
9211 write_u32(
9212 &mut out,
9213 u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9214 );
9215 for loc in locators {
9216 loc.write_le(&mut out);
9217 }
9218 }
9219 }
9220 }
9221 // v6.8.0 — included_columns appendix per index.
9222 // Layout: [u16 num_included][num × u16 column_position].
9223 // v11 readers stop before this u16 (deserialise loop
9224 // gated on version >= 12); v12+ readers always
9225 // consume it. Empty Vec serialises as a bare 0u16.
9226 write_u16(
9227 &mut out,
9228 u16::try_from(idx.included_columns.len()).expect("≤ 65k INCLUDE columns/index"),
9229 );
9230 for col_pos in &idx.included_columns {
9231 write_u16(
9232 &mut out,
9233 u16::try_from(*col_pos).expect("≤ 65k columns/table"),
9234 );
9235 }
9236 // v6.8.1 — partial_predicate appendix per index.
9237 // Layout: [u8 has_pred][u16 LE len][bytes (if has_pred)].
9238 // Same v12 gate as included_columns.
9239 match &idx.partial_predicate {
9240 None => out.push(0),
9241 Some(pred) => {
9242 out.push(1);
9243 write_str(&mut out, pred);
9244 }
9245 }
9246 // v6.8.2 — expression appendix. Same shape as
9247 // partial_predicate.
9248 match &idx.expression {
9249 None => out.push(0),
9250 Some(expr) => {
9251 out.push(1);
9252 write_str(&mut out, expr);
9253 }
9254 }
9255 // v7.9.29 — is_unique appendix (FILE_VERSION 16+).
9256 // Single byte 0/1. v15-and-below readers stop before
9257 // this byte; v16 readers always consume it. mailrs K1.
9258 out.push(u8::from(idx.is_unique));
9259 // v7.9.29 — extra_column_positions appendix.
9260 // Layout: [u16 count][count × u16 column_position].
9261 write_u16(
9262 &mut out,
9263 u16::try_from(idx.extra_column_positions.len())
9264 .expect("≤ 65k extra cols / index"),
9265 );
9266 for cp in &idx.extra_column_positions {
9267 write_u16(&mut out, u16::try_from(*cp).expect("≤ 65k columns/table"));
9268 }
9269 // v7.39 (read01 round 52) — nulls_not_distinct (FILE_VERSION
9270 // 62+). Appended at the end of the per-index block so the v16
9271 // layout above is untouched; v61-and-below readers stop before
9272 // this byte and default the flag to false (NULLS DISTINCT).
9273 out.push(u8::from(idx.nulls_not_distinct));
9274 // v7.39 (round 537) — the key column's ordering clause
9275 // (FILE_VERSION 83+).
9276 out.push(u8::from(idx.descending));
9277 out.push(match idx.nulls_first {
9278 None => 0,
9279 Some(true) => 1,
9280 Some(false) => 2,
9281 });
9282 // v7.39 (round 538) — the key's explicit collation
9283 // (FILE_VERSION 84+).
9284 match &idx.collation {
9285 Some(c) => {
9286 out.push(1);
9287 write_str(&mut out, c);
9288 }
9289 None => out.push(0),
9290 }
9291 }
9292 // v6.7.2 — per-table hot_tier_bytes Option<u64>.
9293 // Layout: [u8 has_value][u64 LE value (if has_value)].
9294 // v10 readers stop before this byte (deserialise loop
9295 // gated on version >= 11); v11+ readers always
9296 // consume it.
9297 match t.schema.hot_tier_bytes {
9298 None => out.push(0),
9299 Some(n) => {
9300 out.push(1);
9301 out.extend_from_slice(&n.to_le_bytes());
9302 }
9303 }
9304 // v7.6.1 — FOREIGN KEY appendix (catalog FILE_VERSION 13+).
9305 // Layout: [u16 LE fk_count]
9306 // per fk:
9307 // [u8 has_name] [str name (if has_name)]
9308 // [u16 LE local_arity] [u16 LE local_pos]*arity
9309 // [str parent_table]
9310 // [u16 LE parent_arity] [u16 LE parent_pos]*arity
9311 // [u8 on_delete_tag] [u8 on_update_tag]
9312 // Older catalogs (v12 and below) skip this block entirely;
9313 // their reader stops before this byte.
9314 write_u16(
9315 &mut out,
9316 u16::try_from(t.schema.foreign_keys.len()).expect("≤ 65k FKs/table"),
9317 );
9318 for fk in &t.schema.foreign_keys {
9319 match &fk.name {
9320 None => out.push(0),
9321 Some(n) => {
9322 out.push(1);
9323 write_str(&mut out, n);
9324 }
9325 }
9326 write_u16(
9327 &mut out,
9328 u16::try_from(fk.local_columns.len()).expect("≤ 65k FK columns"),
9329 );
9330 for &p in &fk.local_columns {
9331 write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9332 }
9333 write_str(&mut out, &fk.parent_table);
9334 write_u16(
9335 &mut out,
9336 u16::try_from(fk.parent_columns.len()).expect("≤ 65k FK parent columns"),
9337 );
9338 for &p in &fk.parent_columns {
9339 write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9340 }
9341 out.push(fk.on_delete.tag());
9342 out.push(fk.on_update.tag());
9343 // v7.38 (read01, T29) — MATCH type tag (FILE_VERSION 55+).
9344 out.push(fk.match_type.tag());
9345 // v7.39 (round 288) — constraint timing (FILE_VERSION 79+).
9346 // One byte, bit 0 = DEFERRABLE, bit 1 = INITIALLY DEFERRED.
9347 out.push(u8::from(fk.deferrable) | (u8::from(fk.initially_deferred) << 1));
9348 }
9349 // v7.9.19 — UniquenessConstraint appendix (catalog
9350 // FILE_VERSION 15+). Layout per table after the FK
9351 // block:
9352 // [u16 count]
9353 // per constraint:
9354 // [u8 is_primary_key]
9355 // [u16 arity][u16 col_pos]*arity
9356 // Older catalogs (v14 and below) skip this block.
9357 write_u16(
9358 &mut out,
9359 u16::try_from(t.schema.uniqueness_constraints.len())
9360 .expect("≤ 65k uniqueness constraints/table"),
9361 );
9362 for uc in &t.schema.uniqueness_constraints {
9363 out.push(u8::from(uc.is_primary_key));
9364 write_u16(
9365 &mut out,
9366 u16::try_from(uc.columns.len()).expect("≤ 65k cols in uniqueness constraint"),
9367 );
9368 for &p in &uc.columns {
9369 write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9370 }
9371 // v7.13.0 — `nulls_not_distinct` flag
9372 // (FILE_VERSION 23+). Always written by writers at
9373 // version 23+; deserialise gates on `version >= 23`
9374 // so v22-and-below catalogs round-trip cleanly.
9375 out.push(u8::from(uc.nulls_not_distinct));
9376 }
9377 // v7.9.21 — runtime_default appendix per table.
9378 // Layout: [u16 count] then for each:
9379 // [u16 col_pos][str expr]
9380 // Only columns whose runtime_default is Some land here;
9381 // catalog stays compact for the common literal-default
9382 // case.
9383 let mut rt_defaults: Vec<(usize, &str)> = Vec::new();
9384 for (i, c) in t.schema.columns.iter().enumerate() {
9385 if let Some(e) = &c.runtime_default {
9386 rt_defaults.push((i, e.as_str()));
9387 }
9388 }
9389 write_u16(
9390 &mut out,
9391 u16::try_from(rt_defaults.len()).expect("≤ 65k runtime defaults/table"),
9392 );
9393 for (pos, expr) in rt_defaults {
9394 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9395 write_str(&mut out, expr);
9396 }
9397 // v7.13.0 — CHECK constraint appendix per table.
9398 // Layout: [u16 count] then `count` Display-form
9399 // expression strings. Re-parsed on every INSERT/UPDATE
9400 // by the engine. FILE_VERSION 23+ only; v22 readers
9401 // never reach this block because the writer also moves
9402 // to v23 in lock-step.
9403 write_u16(
9404 &mut out,
9405 u16::try_from(t.schema.checks.len()).expect("≤ 65k CHECK constraints/table"),
9406 );
9407 for c in &t.schema.checks {
9408 // v7.39 (read01 round 48) — the expr stays in this v23
9409 // appendix (byte layout unchanged for old readers); the
9410 // name rides the v60 constraint-name appendix at the tail.
9411 write_str(&mut out, c.expr.as_str());
9412 }
9413 // v7.17.0 Phase 1.4 — per-table user_enum_type
9414 // appendix. Layout: [u16 count] then
9415 // [u16 col_pos][str enum_name] per binding. Only
9416 // columns whose user_enum_type is Some land here.
9417 let mut enum_bindings: Vec<(usize, &str)> = Vec::new();
9418 for (i, c) in t.schema.columns.iter().enumerate() {
9419 if let Some(e) = &c.user_enum_type {
9420 enum_bindings.push((i, e.as_str()));
9421 }
9422 }
9423 write_u16(
9424 &mut out,
9425 u16::try_from(enum_bindings.len()).expect("≤ 65k enum-typed columns/table"),
9426 );
9427 for (pos, ename) in enum_bindings {
9428 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9429 write_str(&mut out, ename);
9430 }
9431 // v7.17.0 Phase 1.5 — per-table user_domain_type
9432 // appendix. Same layout as the enum one. v29-and-
9433 // below readers stop after the enum appendix.
9434 let mut domain_bindings: Vec<(usize, &str)> = Vec::new();
9435 for (i, c) in t.schema.columns.iter().enumerate() {
9436 if let Some(d) = &c.user_domain_type {
9437 domain_bindings.push((i, d.as_str()));
9438 }
9439 }
9440 write_u16(
9441 &mut out,
9442 u16::try_from(domain_bindings.len()).expect("≤ 65k domain-typed columns/table"),
9443 );
9444 for (pos, dname) in domain_bindings {
9445 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9446 write_str(&mut out, dname);
9447 }
9448 // v7.17.0 Phase 2.1 — per-table on_update_runtime
9449 // appendix. Sparse: only ON UPDATE-bound columns.
9450 let mut on_update_bindings: Vec<(usize, &str)> = Vec::new();
9451 for (i, c) in t.schema.columns.iter().enumerate() {
9452 if let Some(e) = &c.on_update_runtime {
9453 on_update_bindings.push((i, e.as_str()));
9454 }
9455 }
9456 write_u16(
9457 &mut out,
9458 u16::try_from(on_update_bindings.len()).expect("≤ 65k ON UPDATE columns/table"),
9459 );
9460 for (pos, expr_src) in on_update_bindings {
9461 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9462 write_str(&mut out, expr_src);
9463 }
9464 // v7.17.0 Phase 2.5 — per-table collation appendix.
9465 // Sparse: only non-Binary columns land. Layout:
9466 // `[u16 count][u16 col_pos][u8 tag] × count`.
9467 let mut coll_bindings: Vec<(usize, u8)> = Vec::new();
9468 for (i, c) in t.schema.columns.iter().enumerate() {
9469 let tag = match c.collation {
9470 Collation::Binary => continue,
9471 Collation::CaseInsensitive => Collation::TAG_CASE_INSENSITIVE,
9472 };
9473 coll_bindings.push((i, tag));
9474 }
9475 write_u16(
9476 &mut out,
9477 u16::try_from(coll_bindings.len()).expect("≤ 65k collation bindings/table"),
9478 );
9479 for (pos, tag) in coll_bindings {
9480 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9481 out.push(tag);
9482 }
9483 // v7.17.0 Phase 4.4 — per-table is_unsigned appendix.
9484 // Sparse: only UNSIGNED columns land. Layout:
9485 // `[u16 count][u16 col_pos] × count`.
9486 let mut unsigned_bindings: Vec<usize> = Vec::new();
9487 for (i, c) in t.schema.columns.iter().enumerate() {
9488 if c.is_unsigned {
9489 unsigned_bindings.push(i);
9490 }
9491 }
9492 write_u16(
9493 &mut out,
9494 u16::try_from(unsigned_bindings.len()).expect("≤ 65k UNSIGNED columns/table"),
9495 );
9496 for pos in unsigned_bindings {
9497 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9498 }
9499 // v7.17.0 Phase 3.P0-36 — per-table inline_enum_variants
9500 // appendix. Sparse: only ENUM columns land. Layout:
9501 // `[u16 count] then per binding [u16 col_pos]
9502 // [u16 variant_count] then variant strings`.
9503 // FILE_VERSION 41+; v40 readers never reach this block.
9504 let mut enum_inline_bindings: Vec<(usize, &[String])> = Vec::new();
9505 for (i, c) in t.schema.columns.iter().enumerate() {
9506 if let Some(vs) = &c.inline_enum_variants {
9507 enum_inline_bindings.push((i, vs.as_slice()));
9508 }
9509 }
9510 write_u16(
9511 &mut out,
9512 u16::try_from(enum_inline_bindings.len()).expect("≤ 65k inline-ENUM columns/table"),
9513 );
9514 for (pos, variants) in enum_inline_bindings {
9515 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9516 write_u16(
9517 &mut out,
9518 u16::try_from(variants.len()).expect("≤ 65k variants/ENUM"),
9519 );
9520 for v in variants {
9521 write_str(&mut out, v.as_str());
9522 }
9523 }
9524 // v7.17.0 Phase 3.P0-37 — per-table inline_set_variants
9525 // appendix. Same layout as the inline ENUM block.
9526 // FILE_VERSION 42+; v41 readers never reach this block.
9527 let mut set_inline_bindings: Vec<(usize, &[String])> = Vec::new();
9528 for (i, c) in t.schema.columns.iter().enumerate() {
9529 if let Some(vs) = &c.inline_set_variants {
9530 set_inline_bindings.push((i, vs.as_slice()));
9531 }
9532 }
9533 write_u16(
9534 &mut out,
9535 u16::try_from(set_inline_bindings.len()).expect("≤ 65k inline-SET columns/table"),
9536 );
9537 for (pos, variants) in set_inline_bindings {
9538 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9539 write_u16(
9540 &mut out,
9541 u16::try_from(variants.len()).expect("≤ 65k variants/SET"),
9542 );
9543 for v in variants {
9544 write_str(&mut out, v.as_str());
9545 }
9546 }
9547 // v7.37.6-B — partition role appendix(FILE_VERSION 49+)。
9548 // Layout 详见 FILE_VERSION 49 docstring。普通表 = 单字节 0。
9549 write_partition_role(&mut out, t.schema.partition_role.as_ref());
9550 // v7.37.7 — per-table generated_stored_expr appendix
9551 // (FILE_VERSION 50+). Sparse: only columns whose
9552 // generated_stored_expr is Some land here.
9553 let mut gen_bindings: Vec<(usize, &str)> = Vec::new();
9554 for (i, c) in t.schema.columns.iter().enumerate() {
9555 if let Some(src) = &c.generated_stored_expr {
9556 gen_bindings.push((i, src.as_str()));
9557 }
9558 }
9559 write_u16(
9560 &mut out,
9561 u16::try_from(gen_bindings.len()).expect("≤ 65k GENERATED STORED columns/table"),
9562 );
9563 for (pos, src) in gen_bindings {
9564 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9565 write_str(&mut out, src);
9566 }
9567 // v7.38 (read01) — per-table default_text appendix
9568 // (FILE_VERSION 58+). Sparse: only columns whose default_text
9569 // is Some land here. Mirrors the generated_stored_expr shape.
9570 let mut default_texts: Vec<(usize, &str)> = Vec::new();
9571 for (i, c) in t.schema.columns.iter().enumerate() {
9572 if let Some(src) = &c.default_text {
9573 default_texts.push((i, src.as_str()));
9574 }
9575 }
9576 write_u16(
9577 &mut out,
9578 u16::try_from(default_texts.len()).expect("≤ 65k defaulted columns/table"),
9579 );
9580 for (pos, src) in default_texts {
9581 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9582 write_str(&mut out, src);
9583 }
9584 // v7.39 (RLS) — per-table policy appendix + the two RLS flags
9585 // (FILE_VERSION 59+). Written after the default_text block and
9586 // before the MVCC row appendix, so a v58 reader stops before it.
9587 // Layout: [u8 row_security][u8 force] [u16 policy_count] then per
9588 // policy: [str name][u8 cmd][u8 permissive][u16 role_count]
9589 // (role_count × str) [u8 has_using](+str)[u8 has_check](+str).
9590 out.push(u8::from(t.schema.row_security));
9591 out.push(u8::from(t.schema.force_row_security));
9592 write_u16(
9593 &mut out,
9594 u16::try_from(t.schema.policies.len()).expect("≤ 65k policies/table"),
9595 );
9596 for p in &t.schema.policies {
9597 write_str(&mut out, &p.name);
9598 out.push(p.cmd.to_wire_byte());
9599 out.push(u8::from(p.permissive));
9600 write_u16(
9601 &mut out,
9602 u16::try_from(p.roles.len()).expect("≤ 65k roles/policy"),
9603 );
9604 for r in &p.roles {
9605 write_str(&mut out, r);
9606 }
9607 match &p.using_expr {
9608 Some(s) => {
9609 out.push(1);
9610 write_str(&mut out, s);
9611 }
9612 None => out.push(0),
9613 }
9614 match &p.with_check_expr {
9615 Some(s) => {
9616 out.push(1);
9617 write_str(&mut out, s);
9618 }
9619 None => out.push(0),
9620 }
9621 }
9622 // v7.37.16 (Epic W) — per-row MVCC header + stable RowId
9623 // appendix (FILE_VERSION 53+). Persists xmin/xmax/flags +
9624 // RowId for every row so a tombstone naming a pre-checkpoint
9625 // row survives a serialize→deserialize base restore
9626 // (cross-checkpoint tombstone durability). `headers` /
9627 // `rowids` are lock-step parallel to `rows` (invariant held
9628 // at every mutation boundary), so the count is `rows.len()`
9629 // and the zipped walk visits them in physical row order —
9630 // the same order the rows block above was written in. v52
9631 // readers never reach this block (the writer also moves to
9632 // v53 in lock-step); a v53 reader restores headers + ids
9633 // verbatim instead of freezing + dense-assigning.
9634 debug_assert_eq!(
9635 t.rows.len(),
9636 t.headers.len(),
9637 "headers must be lock-step with rows at serialize"
9638 );
9639 debug_assert_eq!(
9640 t.rows.len(),
9641 t.rowids.len(),
9642 "rowids must be lock-step with rows at serialize"
9643 );
9644 write_u32(
9645 &mut out,
9646 u32::try_from(t.rows.len()).expect("≤ 4G rows/table"),
9647 );
9648 for (h, rid) in t.headers.iter().zip(t.rowids.iter()) {
9649 out.extend_from_slice(&h.xmin.to_le_bytes());
9650 out.extend_from_slice(&h.xmax.to_le_bytes());
9651 out.push(h.flags);
9652 out.extend_from_slice(&rid.0.to_le_bytes());
9653 }
9654 out.extend_from_slice(
9655 &t.next_rowid
9656 .load(core::sync::atomic::Ordering::Relaxed)
9657 .to_le_bytes(),
9658 );
9659 // v7.39 (read01 round 48) — constraint-name appendix
9660 // (FILE_VERSION 60+). Index-aligned to the CHECK and
9661 // uniqueness-constraint appendices written above, so the
9662 // existing byte layouts stay untouched and a v59 catalog still
9663 // decodes (its constraints just come back unnamed).
9664 // Layout: [u16 check_count] then per check
9665 // [u8 has_name] ([str name] when has_name)
9666 // [u16 uc_count] then per uc the same pair.
9667 write_u16(
9668 &mut out,
9669 u16::try_from(t.schema.checks.len()).expect("≤ 65k CHECK constraints/table"),
9670 );
9671 for c in &t.schema.checks {
9672 match &c.name {
9673 Some(n) => {
9674 out.push(1);
9675 write_str(&mut out, n);
9676 }
9677 None => out.push(0),
9678 }
9679 }
9680 write_u16(
9681 &mut out,
9682 u16::try_from(t.schema.uniqueness_constraints.len())
9683 .expect("≤ 65k uniqueness constraints/table"),
9684 );
9685 for uc in &t.schema.uniqueness_constraints {
9686 match &uc.name {
9687 Some(n) => {
9688 out.push(1);
9689 write_str(&mut out, n);
9690 }
9691 None => out.push(0),
9692 }
9693 }
9694 // v7.39 (read01 round 56) — user_composite_type appendix
9695 // (FILE_VERSION 63+). Sparse, at the very end of the per-table
9696 // block: only composite-typed columns land here, so a v62 reader
9697 // stops before it and its composite columns stay plain JSON.
9698 let mut comp_bindings: Vec<(usize, &str)> = Vec::new();
9699 for (i, c) in t.schema.columns.iter().enumerate() {
9700 if let Some(n) = &c.user_composite_type {
9701 comp_bindings.push((i, n.as_str()));
9702 }
9703 }
9704 write_u16(
9705 &mut out,
9706 u16::try_from(comp_bindings.len()).expect("≤ 65k composite-typed columns/table"),
9707 );
9708 for (pos, n) in comp_bindings {
9709 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9710 write_str(&mut out, n);
9711 }
9712 // v7.39 (read01 round 57) — owner + ACL appendix (FILE_VERSION
9713 // 64+), at the very end of the per-table block so a v63 reader
9714 // stops before it (its tables then read back owner-less, i.e.
9715 // owned by the login role, with no grants — which is exactly what
9716 // they were).
9717 match &t.schema.owner {
9718 Some(o) => {
9719 out.push(1);
9720 write_str(&mut out, o);
9721 }
9722 None => out.push(0),
9723 }
9724 write_u16(
9725 &mut out,
9726 u16::try_from(t.schema.acl.len()).expect("≤ 65k aclitems/table"),
9727 );
9728 for a in &t.schema.acl {
9729 write_str(&mut out, &a.grantee);
9730 write_u16(&mut out, a.privs);
9731 write_u16(&mut out, a.grantable);
9732 write_str(&mut out, &a.grantor);
9733 }
9734 // v7.39 (read01 round 59) — COLUMN acl appendix (FILE_VERSION 65+),
9735 // sparse: only columns that carry a grant land here, so a v64 reader
9736 // stops before it and its columns read back un-granted, which is
9737 // what they were.
9738 let granted: Vec<(usize, &ColumnSchema)> = t
9739 .schema
9740 .columns
9741 .iter()
9742 .enumerate()
9743 .filter(|(_, c)| !c.acl.is_empty())
9744 .collect();
9745 write_u16(
9746 &mut out,
9747 u16::try_from(granted.len()).expect("≤ 65k granted columns/table"),
9748 );
9749 for (pos, c) in granted {
9750 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9751 write_u16(
9752 &mut out,
9753 u16::try_from(c.acl.len()).expect("≤ 65k aclitems/column"),
9754 );
9755 for a in &c.acl {
9756 write_str(&mut out, &a.grantee);
9757 write_u16(&mut out, a.privs);
9758 write_u16(&mut out, a.grantable);
9759 write_str(&mut out, &a.grantor);
9760 }
9761 }
9762 // v7.39 (round 210) — EXCLUDE-constraint appendix (FILE_VERSION
9763 // 72+), at the very end of the per-table block so a v71 reader
9764 // stops before it and its tables read back with no exclusion
9765 // constraints. Layout: [u16 excl_count] then per constraint
9766 // [str name] [u8 has_method](+str) [u16 elem_count] then per
9767 // element [u16 col_pos][str op].
9768 write_u16(
9769 &mut out,
9770 u16::try_from(t.schema.exclusion_constraints.len())
9771 .expect("≤ 65k exclusion constraints/table"),
9772 );
9773 for ex in &t.schema.exclusion_constraints {
9774 write_str(&mut out, &ex.name);
9775 match &ex.method {
9776 Some(m) => {
9777 out.push(1);
9778 write_str(&mut out, m);
9779 }
9780 None => out.push(0),
9781 }
9782 write_u16(
9783 &mut out,
9784 u16::try_from(ex.elements.len()).expect("≤ 65k elements/exclusion"),
9785 );
9786 for (pos, op) in &ex.elements {
9787 write_u16(&mut out, u16::try_from(*pos).expect("≤ 65k columns/table"));
9788 write_str(&mut out, op);
9789 }
9790 }
9791 // v7.39 (round 220) — identity-RESTART appendix (FILE_VERSION
9792 // 73+), sparse: only columns carrying a RESTART floor land here.
9793 let restarts: Vec<(usize, i64)> = t
9794 .schema
9795 .columns
9796 .iter()
9797 .enumerate()
9798 .filter_map(|(i, c)| c.auto_restart.map(|n| (i, n)))
9799 .collect();
9800 write_u16(
9801 &mut out,
9802 u16::try_from(restarts.len()).expect("≤ 65k restart columns/table"),
9803 );
9804 for (pos, n) in restarts {
9805 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9806 out.extend_from_slice(&n.to_le_bytes());
9807 }
9808 // v7.39 (round 386, type-fidelity epic P1) — per-table
9809 // mysql_int_width appendix (FILE_VERSION 81+). Sparse: only
9810 // TINYINT / MEDIUMINT columns land. Layout:
9811 // `[u16 count]([u16 col_pos][u8 width_tag]) × count`
9812 // (tag 0 = Tiny, 1 = Medium). v80-and-below readers stop after
9813 // the identity-RESTART appendix, leaving every column at None.
9814 let int_widths: Vec<(usize, u8)> = t
9815 .schema
9816 .columns
9817 .iter()
9818 .enumerate()
9819 .filter_map(|(i, c)| {
9820 c.mysql_int_width.map(|w| {
9821 let tag = match w {
9822 MysqlIntWidth::Tiny => 0u8,
9823 MysqlIntWidth::Medium => 1u8,
9824 MysqlIntWidth::Small => 2u8,
9825 MysqlIntWidth::Int => 3u8,
9826 MysqlIntWidth::Big => 4u8,
9827 };
9828 (i, tag)
9829 })
9830 })
9831 .collect();
9832 write_u16(
9833 &mut out,
9834 u16::try_from(int_widths.len()).expect("≤ 65k narrow-int columns/table"),
9835 );
9836 for (pos, tag) in int_widths {
9837 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9838 out.push(tag);
9839 }
9840 // v7.39 (round 424, type-fidelity epic) — per-table mysql_fsp
9841 // appendix (FILE_VERSION 82+). Sparse: only MySQL-declared
9842 // temporal columns land. Layout:
9843 // `[u16 count]([u16 col_pos][u8 fsp]) × count`, fsp in 0..=6.
9844 // v81-and-below readers stop after the int-width appendix,
9845 // leaving every column at None (PG microsecond behaviour).
9846 let fsps: Vec<(usize, u8)> = t
9847 .schema
9848 .columns
9849 .iter()
9850 .enumerate()
9851 .filter_map(|(i, c)| c.mysql_fsp.map(|p| (i, p)))
9852 .collect();
9853 write_u16(
9854 &mut out,
9855 u16::try_from(fsps.len()).expect("≤ 65k temporal columns/table"),
9856 );
9857 for (pos, fsp) in fsps {
9858 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9859 out.push(fsp);
9860 }
9861 // v7.39 (round 652) — CHECK-validated appendix (FILE_VERSION
9862 // 87+). Sparse the other way round from the ones above: the
9863 // common case is every constraint validated, so only the
9864 // NOT VALID ones are written, by their index into the CHECK
9865 // appendix. Layout: `[u16 count]([u16 check_idx]) × count`.
9866 let unvalidated: Vec<usize> = t
9867 .schema
9868 .checks
9869 .iter()
9870 .enumerate()
9871 .filter_map(|(i, c)| (!c.validated).then_some(i))
9872 .collect();
9873 write_u16(
9874 &mut out,
9875 u16::try_from(unvalidated.len()).expect("≤ 65k CHECK constraints/table"),
9876 );
9877 for idx in unvalidated {
9878 write_u16(&mut out, u16::try_from(idx).expect("≤ 65k CHECK/table"));
9879 }
9880 // v7.39 (round 677) — per-column collation names (FILE_VERSION
9881 // 88+). Sparse: only the columns that were written with an
9882 // explicit `COLLATE` appear, so a table that declares none pays
9883 // two bytes. Layout: `[u16 count]([u16 col_idx][str]) × count`.
9884 //
9885 // Without this the declaration survives CREATE TABLE and dies
9886 // at the next restart — measured: a column declared
9887 // `COLLATE "C"` reported attcollation 950 in the session that
9888 // created it and 100 after a reload.
9889 let collated: Vec<(usize, &str)> = t
9890 .schema
9891 .columns
9892 .iter()
9893 .enumerate()
9894 .filter_map(|(i, c)| c.collation_name.as_deref().map(|n| (i, n)))
9895 .collect();
9896 write_u16(
9897 &mut out,
9898 u16::try_from(collated.len()).expect("≤ 65k columns/table"),
9899 );
9900 for (idx, name) in collated {
9901 write_u16(&mut out, u16::try_from(idx).expect("≤ 65k columns/table"));
9902 write_str(&mut out, name);
9903 }
9904 // v7.39 (round 711) — PK/UNIQUE constraint timing (FILE_VERSION
9905 // 89+). Dense, one byte per uniqueness constraint in
9906 // declaration order, the same bit layout the FK block has
9907 // carried since round 288: bit 0 = DEFERRABLE, bit 1 =
9908 // INITIALLY DEFERRED. A v88 reader stops before it.
9909 write_u16(
9910 &mut out,
9911 u16::try_from(t.schema.uniqueness_constraints.len())
9912 .expect("≤ 65k uniqueness constraints/table"),
9913 );
9914 for uc in &t.schema.uniqueness_constraints {
9915 out.push(u8::from(uc.deferrable) | (u8::from(uc.initially_deferred) << 1));
9916 }
9917 }
9918 // v7.12.4 — catalog-wide appendix: user-defined functions
9919 // then triggers. FILE_VERSION 22+ only. v21 and earlier
9920 // readers stop after the last table; v22 readers always
9921 // consume two `u32` counts (possibly zero).
9922 //
9923 // Function entry layout:
9924 // [str name] [str args_repr] [str returns]
9925 // [str language] [str body]
9926 // Trigger entry layout:
9927 // [str name] [str table] [str timing]
9928 // [u16 event_count] (event_count × str)
9929 // [str for_each] [str function]
9930 write_u32(
9931 &mut out,
9932 u32::try_from(self.functions.len()).expect("≤ 4G functions"),
9933 );
9934 for fd in self.functions.values() {
9935 write_str(&mut out, &fd.name);
9936 write_str(&mut out, &fd.args_repr);
9937 write_str(&mut out, &fd.returns);
9938 write_str(&mut out, &fd.language);
9939 write_str_long(&mut out, &fd.body);
9940 }
9941 write_u32(
9942 &mut out,
9943 u32::try_from(self.triggers.len()).expect("≤ 4G triggers"),
9944 );
9945 for td in &self.triggers {
9946 write_str(&mut out, &td.name);
9947 write_str(&mut out, &td.table);
9948 write_str(&mut out, &td.timing);
9949 write_u16(
9950 &mut out,
9951 u16::try_from(td.events.len()).expect("≤ 65k events / trigger"),
9952 );
9953 for ev in &td.events {
9954 write_str(&mut out, ev);
9955 }
9956 write_str(&mut out, &td.for_each);
9957 write_str(&mut out, &td.function);
9958 // v7.13.0 — `UPDATE OF cols` filter
9959 // (FILE_VERSION 23+). v22 readers omit; v23 writers
9960 // always emit (possibly zero).
9961 write_u16(
9962 &mut out,
9963 u16::try_from(td.update_columns.len()).expect("≤ 65k cols / trigger"),
9964 );
9965 for c in &td.update_columns {
9966 write_str(&mut out, c);
9967 }
9968 // v7.16.1 — TriggerDef.enabled (FILE_VERSION 25+).
9969 out.push(u8::from(td.enabled));
9970 // v7.39 (round 138) — WHEN condition text (FILE_VERSION 70+).
9971 write_str(&mut out, &td.when_condition);
9972 }
9973 // v7.17.0 Phase 1.1 — SEQUENCE catalog block (FILE_VERSION 26+).
9974 write_u32(
9975 &mut out,
9976 u32::try_from(self.sequences.len()).expect("≤ 4G sequences"),
9977 );
9978 for seq in self.sequences.values() {
9979 write_str(&mut out, &seq.name);
9980 out.push(match seq.data_type {
9981 SequenceDataType::SmallInt => 0,
9982 SequenceDataType::Int => 1,
9983 SequenceDataType::BigInt => 2,
9984 });
9985 out.extend_from_slice(&seq.start.to_le_bytes());
9986 out.extend_from_slice(&seq.increment.to_le_bytes());
9987 out.extend_from_slice(&seq.min_value.to_le_bytes());
9988 out.extend_from_slice(&seq.max_value.to_le_bytes());
9989 out.extend_from_slice(&seq.cache.to_le_bytes());
9990 out.push(u8::from(seq.cycle));
9991 match &seq.owned_by {
9992 None => out.push(0),
9993 Some((table, column)) => {
9994 out.push(1);
9995 write_str(&mut out, table);
9996 write_str(&mut out, column);
9997 }
9998 }
9999 out.extend_from_slice(&seq.last_value.to_le_bytes());
10000 out.push(u8::from(seq.is_called));
10001 }
10002 // v7.17.0 Phase 1.2 — VIEW catalog block (FILE_VERSION 27+).
10003 write_u32(
10004 &mut out,
10005 u32::try_from(self.views.len()).expect("≤ 4G views"),
10006 );
10007 for view in self.views.values() {
10008 write_str(&mut out, &view.name);
10009 write_u16(
10010 &mut out,
10011 u16::try_from(view.columns.len()).expect("≤ 65k cols / view"),
10012 );
10013 for c in &view.columns {
10014 write_str(&mut out, c);
10015 }
10016 write_str_long(&mut out, &view.body);
10017 // v7.39 (round 132, FILE_VERSION 69+) — WITH CHECK OPTION marker.
10018 out.push(view.check_option);
10019 }
10020 // v7.17.0 Phase 1.3 — MATERIALIZED VIEW source registry
10021 // (FILE_VERSION 28+). The backing rows live as a regular
10022 // table of the same name already in the tables block.
10023 write_u32(
10024 &mut out,
10025 u32::try_from(self.materialized_views.len()).expect("≤ 4G materialized views"),
10026 );
10027 for (name, body) in &self.materialized_views {
10028 write_str(&mut out, name);
10029 write_str_long(&mut out, body);
10030 }
10031 // v7.17.0 Phase 1.4 — ENUM types catalog block
10032 // (FILE_VERSION 29+).
10033 write_u32(
10034 &mut out,
10035 u32::try_from(self.enum_types.len()).expect("≤ 4G enum types"),
10036 );
10037 for e in self.enum_types.values() {
10038 write_str(&mut out, &e.name);
10039 write_u16(
10040 &mut out,
10041 u16::try_from(e.labels.len()).expect("≤ 65k labels / enum"),
10042 );
10043 for l in &e.labels {
10044 write_str(&mut out, l);
10045 }
10046 }
10047 // v7.17.0 Phase 1.5 — DOMAIN types catalog block
10048 // (FILE_VERSION 30+).
10049 write_u32(
10050 &mut out,
10051 u32::try_from(self.domain_types.len()).expect("≤ 4G domain types"),
10052 );
10053 for d in self.domain_types.values() {
10054 write_str(&mut out, &d.name);
10055 write_data_type(&mut out, d.base_type);
10056 out.push(u8::from(d.nullable));
10057 match &d.default {
10058 None => out.push(0),
10059 Some(s) => {
10060 out.push(1);
10061 write_str(&mut out, s);
10062 }
10063 }
10064 write_u16(
10065 &mut out,
10066 u16::try_from(d.checks.len()).expect("≤ 65k CHECKs / domain"),
10067 );
10068 for c in &d.checks {
10069 write_str(&mut out, &c.expr);
10070 // v7.39 (round 260) — the constraint name (FILE_VERSION 75+).
10071 write_str(&mut out, &c.name);
10072 }
10073 // v7.39 (round 259) — the parent domain (FILE_VERSION 74+).
10074 match &d.base_domain {
10075 None => out.push(0),
10076 Some(s) => {
10077 out.push(1);
10078 write_str(&mut out, s);
10079 }
10080 }
10081 }
10082 // v7.17.0 Phase 1.6 — user-schemas registry
10083 // (FILE_VERSION 31+). Built-ins are hardcoded in
10084 // `is_builtin_schema` and not persisted.
10085 write_u32(
10086 &mut out,
10087 u32::try_from(self.schemas.len()).expect("≤ 4G schemas"),
10088 );
10089 for name in &self.schemas {
10090 write_str(&mut out, name);
10091 }
10092 // v7.37.42-T2 ζ-B — COMPOSITE types catalog block
10093 // (FILE_VERSION 52+). Each entry: name, u16 field_count,
10094 // then field_count `[str field_name][data_type]` pairs.
10095 write_u32(
10096 &mut out,
10097 u32::try_from(self.composite_types.len()).expect("≤ 4G composite types"),
10098 );
10099 for c in self.composite_types.values() {
10100 write_str(&mut out, &c.name);
10101 write_u16(
10102 &mut out,
10103 u16::try_from(c.fields.len()).expect("≤ 65k fields / composite"),
10104 );
10105 for (i, (fname, fty)) in c.fields.iter().enumerate() {
10106 write_str(&mut out, fname);
10107 write_data_type(&mut out, *fty);
10108 // v7.39 (round 264) — the field's user type (v76+).
10109 match c.field_user_types.get(i).and_then(Option::as_ref) {
10110 None => out.push(0),
10111 Some(n) => {
10112 out.push(1);
10113 write_str(&mut out, n);
10114 }
10115 }
10116 }
10117 }
10118 // v7.39 (read01 round 50) — COMMENT store (FILE_VERSION 61+).
10119 // Catalog-wide, written last (before the CRC trailer) so every older
10120 // reader stops before it. Layout: [u32 count] then [str key][str text].
10121 write_u32(
10122 &mut out,
10123 u32::try_from(self.comments.len()).expect("≤ 4G comments"),
10124 );
10125 for (k, v) in &self.comments {
10126 write_str(&mut out, k);
10127 write_str_long(&mut out, v);
10128 }
10129 // v7.39 (read01 round 60) — non-table ACLs (FILE_VERSION 66+), catalog-
10130 // wide and written last so a v65 reader stops before them. The sequence
10131 // block itself sits mid-image and cannot grow without breaking older
10132 // readers, so a sequence's owner + ACL rides here, keyed by name.
10133 let acl_out = |out: &mut Vec<u8>, acl: &[AclItem]| {
10134 write_u16(out, u16::try_from(acl.len()).expect("≤ 65k aclitems"));
10135 for a in acl {
10136 write_str(out, &a.grantee);
10137 write_u16(out, a.privs);
10138 write_u16(out, a.grantable);
10139 write_str(out, &a.grantor);
10140 }
10141 };
10142 let owned: Vec<&SequenceDef> = self
10143 .sequences
10144 .values()
10145 .filter(|s| s.owner.is_some() || !s.acl.is_empty())
10146 .collect();
10147 write_u32(
10148 &mut out,
10149 u32::try_from(owned.len()).expect("≤ 4G sequences"),
10150 );
10151 for seq in owned {
10152 write_str(&mut out, &seq.name);
10153 match &seq.owner {
10154 Some(o) => {
10155 out.push(1);
10156 write_str(&mut out, o);
10157 }
10158 None => out.push(0),
10159 }
10160 acl_out(&mut out, &seq.acl);
10161 }
10162 acl_out(&mut out, &self.schema_acl);
10163 acl_out(&mut out, &self.database_acl);
10164 // v7.39 (read01 round 61) — FUNCTION owner + ACL (FILE_VERSION 67+).
10165 // The function block sits mid-image like the sequence one, so this
10166 // rides the catalog-wide tail too, keyed by name.
10167 let fns: Vec<&FunctionDef> = self
10168 .functions
10169 .values()
10170 .filter(|f| f.owner.is_some() || !f.acl.is_empty())
10171 .collect();
10172 write_u32(&mut out, u32::try_from(fns.len()).expect("≤ 4G functions"));
10173 for f in fns {
10174 // v7.39 (read01 round 62) — keyed by SIGNATURE now: two overloads
10175 // have two ACLs.
10176 write_str(&mut out, &function_signature_key(&f.name, &f.args_repr));
10177 match &f.owner {
10178 Some(o) => {
10179 out.push(1);
10180 write_str(&mut out, o);
10181 }
10182 None => out.push(0),
10183 }
10184 acl_out(&mut out, &f.acl);
10185 }
10186 // v7.39 (round 139) — RULE catalog block (FILE_VERSION 71+), catalog-
10187 // wide and written last (right before the CRC trailer) so every older
10188 // reader stops cleanly before it. Layout: [u32 count] then per rule
10189 // [str name][str table][str event][u8 instead][str when]
10190 // [u16 cmd_count]([str cmd] × cmd_count).
10191 write_u32(
10192 &mut out,
10193 u32::try_from(self.rules.len()).expect("≤ 4G rules"),
10194 );
10195 for r in &self.rules {
10196 write_str(&mut out, &r.name);
10197 write_str(&mut out, &r.table);
10198 write_str(&mut out, &r.event);
10199 out.push(u8::from(r.instead));
10200 write_str(&mut out, &r.when_condition);
10201 write_u16(
10202 &mut out,
10203 u16::try_from(r.commands.len()).expect("≤ 65k commands / rule"),
10204 );
10205 for c in &r.commands {
10206 write_str(&mut out, c);
10207 }
10208 }
10209 // v7.39 (round 280) — extended-statistics block (FILE_VERSION
10210 // 77+), appended after the RULE block for the same reason: an
10211 // older reader stops cleanly before it. Layout: [u32 count]
10212 // then per object [str name][str table][u16 n]([str kind] × n)
10213 // [u16 m]([str column] × m).
10214 write_u32(
10215 &mut out,
10216 u32::try_from(self.statistics_ext.len()).expect("≤ 4G statistics objects"),
10217 );
10218 for st in &self.statistics_ext {
10219 write_str(&mut out, &st.name);
10220 write_str(&mut out, &st.table);
10221 write_u16(
10222 &mut out,
10223 u16::try_from(st.kinds.len()).expect("≤ 65k kinds"),
10224 );
10225 for k in &st.kinds {
10226 write_str(&mut out, k);
10227 }
10228 write_u16(
10229 &mut out,
10230 u16::try_from(st.columns.len()).expect("≤ 65k columns"),
10231 );
10232 for c in &st.columns {
10233 write_str(&mut out, c);
10234 }
10235 }
10236 // v7.39 (round 287) — large-object block (FILE_VERSION 78+),
10237 // appended after the statistics block for the same reason: an
10238 // older reader stops cleanly before it. Layout: [u32 count]
10239 // then per object [u32 oid][u32 len][len bytes].
10240 write_u32(
10241 &mut out,
10242 u32::try_from(self.large_objects.len()).expect("≤ 4G large objects"),
10243 );
10244 for (oid, bytes) in &self.large_objects {
10245 write_u32(&mut out, *oid);
10246 write_u32(
10247 &mut out,
10248 u32::try_from(bytes.len()).expect("≤ 4G per object"),
10249 );
10250 out.extend_from_slice(bytes);
10251 }
10252 // v7.39 (round 322, V46) — function-attribute block (FILE_VERSION
10253 // 80+), appended last for the same reason as every block before
10254 // it: an older reader stops cleanly ahead of it and simply sees
10255 // functions with PG's default attributes. Only functions that
10256 // declared something non-default are written. Layout: [u32 count]
10257 // then per function [str signature_key][u8 volatility][u8 flags]
10258 // [u8 parallel][f64 cost or NaN][f64 rows or NaN], where flags bit
10259 // 0 = strict, 1 = security definer, 2 = leakproof.
10260 let attr_fns: Vec<(&String, &FunctionDef)> = self
10261 .functions
10262 .iter()
10263 .filter(|(_, f)| {
10264 f.volatility != FN_VOLATILE
10265 || f.strict
10266 || f.security_definer
10267 || f.leakproof
10268 || f.parallel != FN_PARALLEL_UNSAFE
10269 || f.cost.is_some()
10270 || f.rows.is_some()
10271 })
10272 .collect();
10273 write_u32(
10274 &mut out,
10275 u32::try_from(attr_fns.len()).expect("≤ 4G functions"),
10276 );
10277 for (key, f) in attr_fns {
10278 write_str(&mut out, key);
10279 out.push(f.volatility);
10280 let flags = u8::from(f.strict)
10281 | (u8::from(f.security_definer) << 1)
10282 | (u8::from(f.leakproof) << 2);
10283 out.push(flags);
10284 out.push(f.parallel);
10285 out.extend_from_slice(&f.cost.unwrap_or(f64::NAN).to_le_bytes());
10286 out.extend_from_slice(&f.rows.unwrap_or(f64::NAN).to_le_bytes());
10287 }
10288 // v7.38 (read01 P5.05) — CRC32C trailer over the whole image so a
10289 // corrupted snapshot is rejected on load. FILE_VERSION is >= the
10290 // trailer version, so this always runs for freshly-written images.
10291 // v7.39 (round 547) — pg_db_role_setting (FILE_VERSION 85+),
10292 // catalog-wide and written LAST so a v84 reader stops before it.
10293 // Layout: [u32 scopes] then [str database][str role][u32 params]
10294 // then [str name][str value] per param.
10295 write_u32(
10296 &mut out,
10297 u32::try_from(self.db_role_settings.len()).expect("≤ 4G scopes"),
10298 );
10299 for ((db, role), params) in &self.db_role_settings {
10300 write_str(&mut out, db);
10301 write_str(&mut out, role);
10302 write_u32(&mut out, u32::try_from(params.len()).expect("≤ 4G params"));
10303 for (name, value) in params {
10304 write_str(&mut out, name);
10305 write_str(&mut out, value);
10306 }
10307 }
10308 // v7.39 (round 550) — replication slots (FILE_VERSION 86+),
10309 // written LAST so a v85 reader stops before them.
10310 write_u32(
10311 &mut out,
10312 u32::try_from(self.replication_slots.len()).expect("≤ 4G slots"),
10313 );
10314 for (name, (plugin, slot_type)) in &self.replication_slots {
10315 write_str(&mut out, name);
10316 write_str(&mut out, plugin);
10317 write_str(&mut out, slot_type);
10318 }
10319 let crc = spg_crypto::crc32c::crc32c(&out);
10320 write_u32(&mut out, crc);
10321 out
10322 }
10323
10324 /// Deserialize a previously-serialized catalog. Rejects bad magic, version
10325 /// mismatch, unknown tags, truncation, and trailing bytes.
10326 pub fn deserialize(buf: &[u8]) -> Result<Self, StorageError> {
10327 let mut cur = Cursor::new(buf);
10328 let magic = cur.take(8)?;
10329 if magic != FILE_MAGIC {
10330 return Err(StorageError::Corrupt(format!(
10331 "bad magic: expected SPGDB001, got {magic:?}"
10332 )));
10333 }
10334 let version = cur.read_u8()?;
10335 if !(MIN_SUPPORTED_FILE_VERSION..=FILE_VERSION).contains(&version) {
10336 return Err(StorageError::Corrupt(format!(
10337 "unsupported file version: {version} (supported: {MIN_SUPPORTED_FILE_VERSION}..={FILE_VERSION})"
10338 )));
10339 }
10340 // v7.23/v7.27 — escape decoding is version-gated (see
10341 // STR_LEN_ESCAPE / Cursor::codec_version).
10342 cur.codec_version = version;
10343 let table_count = cur.read_u32()? as usize;
10344 let mut cat = Self::new();
10345 for _ in 0..table_count {
10346 deserialize_table(&mut cur, &mut cat, version)?;
10347 }
10348 // v7.37.15 (Phase C.1) — stamp dense stable RelIds on load.
10349 // Pre-V6 envelopes carry no ids; a dense 1..=N assignment is
10350 // sufficient while RelId is process-local bookkeeping (the V6
10351 // envelope, Phase C.6, will round-trip real ids). Sets the
10352 // allocator above the loaded ids so a post-load CREATE TABLE
10353 // never collides.
10354 for (i, t) in cat.tables.iter_mut().enumerate() {
10355 t.set_rel_id(row_header::RelId((i as u64) + 1));
10356 }
10357 cat.next_rel_id = cat.tables.len() as u64;
10358 // v7.12.4 — catalog-wide function + trigger appendix.
10359 // FILE_VERSION 22+ only; v21 and earlier catalogs stop
10360 // after the last table.
10361 if version >= 22 {
10362 let fn_count = cur.read_u32()? as usize;
10363 for _ in 0..fn_count {
10364 let name = cur.read_str()?;
10365 let args_repr = cur.read_str()?;
10366 let returns = cur.read_str()?;
10367 let language = cur.read_str()?;
10368 let body = cur.read_str_long()?;
10369 let key = function_signature_key(&name, &args_repr);
10370 cat.functions.insert(
10371 key,
10372 FunctionDef {
10373 name,
10374 args_repr,
10375 returns,
10376 language,
10377 body,
10378 owner: None,
10379 acl: Vec::new(),
10380 volatility: FN_VOLATILE,
10381 strict: false,
10382 security_definer: false,
10383 leakproof: false,
10384 parallel: FN_PARALLEL_UNSAFE,
10385 cost: None,
10386 rows: None,
10387 },
10388 );
10389 }
10390 let trg_count = cur.read_u32()? as usize;
10391 for _ in 0..trg_count {
10392 let name = cur.read_str()?;
10393 let table = cur.read_str()?;
10394 let timing = cur.read_str()?;
10395 let ev_count = cur.read_u16()? as usize;
10396 let mut events = Vec::with_capacity(ev_count);
10397 for _ in 0..ev_count {
10398 events.push(cur.read_str()?);
10399 }
10400 let for_each = cur.read_str()?;
10401 let function = cur.read_str()?;
10402 // v7.13.0 — trailing `UPDATE OF cols` filter
10403 // (FILE_VERSION 23+ only; v22 catalogs omit and
10404 // deserialise with an empty vec).
10405 let update_columns = if version >= 23 {
10406 let n = cur.read_u16()? as usize;
10407 let mut cols = Vec::with_capacity(n);
10408 for _ in 0..n {
10409 cols.push(cur.read_str()?);
10410 }
10411 cols
10412 } else {
10413 Vec::new()
10414 };
10415 // v7.16.1 — TriggerDef.enabled (FILE_VERSION 25+).
10416 // v24-and-below catalogs deserialise with `true`
10417 // — pre-v7.16.1 every trigger always fired.
10418 let enabled = if version >= 25 {
10419 cur.read_u8()? != 0
10420 } else {
10421 true
10422 };
10423 // v7.39 (round 138) — WHEN condition text added at FILE_VERSION
10424 // 70; older catalogs read back empty (no WHEN filter).
10425 let when_condition = if version >= 70 {
10426 cur.read_str()?
10427 } else {
10428 String::new()
10429 };
10430 cat.triggers.push(TriggerDef {
10431 name,
10432 table,
10433 timing,
10434 events,
10435 for_each,
10436 function,
10437 update_columns,
10438 enabled,
10439 when_condition,
10440 });
10441 }
10442 }
10443 // v7.17.0 Phase 1.1 — SEQUENCE block (FILE_VERSION 26+).
10444 // v25-and-below catalogs omit; we leave the map empty.
10445 if version >= 26 {
10446 let seq_count = cur.read_u32()? as usize;
10447 for _ in 0..seq_count {
10448 let name = cur.read_str()?;
10449 let data_type = match cur.read_u8()? {
10450 0 => SequenceDataType::SmallInt,
10451 1 => SequenceDataType::Int,
10452 2 => SequenceDataType::BigInt,
10453 other => {
10454 return Err(StorageError::Corrupt(format!(
10455 "unknown SEQUENCE data-type tag {other}"
10456 )));
10457 }
10458 };
10459 let start = cur.read_i64()?;
10460 let increment = cur.read_i64()?;
10461 let min_value = cur.read_i64()?;
10462 let max_value = cur.read_i64()?;
10463 let cache = cur.read_i64()?;
10464 let cycle = cur.read_u8()? != 0;
10465 let owned_by = match cur.read_u8()? {
10466 0 => None,
10467 1 => {
10468 let t = cur.read_str()?;
10469 let c = cur.read_str()?;
10470 Some((t, c))
10471 }
10472 other => {
10473 return Err(StorageError::Corrupt(format!(
10474 "unknown SEQUENCE owned-by tag {other}"
10475 )));
10476 }
10477 };
10478 let last_value = cur.read_i64()?;
10479 let is_called = cur.read_u8()? != 0;
10480 cat.sequences.insert(
10481 name.clone(),
10482 SequenceDef {
10483 name,
10484 data_type,
10485 start,
10486 increment,
10487 min_value,
10488 max_value,
10489 cache,
10490 cycle,
10491 owned_by,
10492 last_value,
10493 is_called,
10494 owner: None,
10495 acl: Vec::new(),
10496 },
10497 );
10498 }
10499 }
10500 // v7.17.0 Phase 1.2 — VIEW block (FILE_VERSION 27+).
10501 // v26-and-below catalogs omit; we leave the map empty.
10502 if version >= 27 {
10503 let view_count = cur.read_u32()? as usize;
10504 for _ in 0..view_count {
10505 let name = cur.read_str()?;
10506 let col_count = cur.read_u16()? as usize;
10507 let mut columns = Vec::with_capacity(col_count);
10508 for _ in 0..col_count {
10509 columns.push(cur.read_str()?);
10510 }
10511 let body = cur.read_str_long()?;
10512 // v7.39 (round 132) — check-option marker added at FILE_VERSION
10513 // 69; older catalogs default to 0 (no check option).
10514 let check_option = if version >= 69 { cur.read_u8()? } else { 0 };
10515 cat.views.insert(
10516 name.clone(),
10517 ViewDef {
10518 name,
10519 columns,
10520 body,
10521 check_option,
10522 },
10523 );
10524 }
10525 }
10526 // v7.17.0 Phase 1.3 — MATERIALIZED VIEW source registry
10527 // (FILE_VERSION 28+). v27-and-below catalogs omit.
10528 if version >= 28 {
10529 let mv_count = cur.read_u32()? as usize;
10530 for _ in 0..mv_count {
10531 let name = cur.read_str()?;
10532 let body = cur.read_str_long()?;
10533 cat.materialized_views.insert(name, body);
10534 }
10535 }
10536 // v7.17.0 Phase 1.4 — ENUM types catalog block
10537 // (FILE_VERSION 29+).
10538 if version >= 29 {
10539 let etype_count = cur.read_u32()? as usize;
10540 for _ in 0..etype_count {
10541 let name = cur.read_str()?;
10542 let label_count = cur.read_u16()? as usize;
10543 let mut labels = Vec::with_capacity(label_count);
10544 for _ in 0..label_count {
10545 labels.push(cur.read_str()?);
10546 }
10547 cat.enum_types
10548 .insert(name.clone(), EnumDef { name, labels });
10549 }
10550 }
10551 // v7.17.0 Phase 1.5 — DOMAIN types catalog block
10552 // (FILE_VERSION 30+).
10553 if version >= 30 {
10554 let dtype_count = cur.read_u32()? as usize;
10555 for _ in 0..dtype_count {
10556 let name = cur.read_str()?;
10557 let base_type = cur.read_data_type()?;
10558 let nullable = cur.read_u8()? != 0;
10559 let default = match cur.read_u8()? {
10560 0 => None,
10561 1 => Some(cur.read_str()?),
10562 other => {
10563 return Err(StorageError::Corrupt(format!(
10564 "unknown DOMAIN default tag {other}"
10565 )));
10566 }
10567 };
10568 let check_count = cur.read_u16()? as usize;
10569 let mut checks: Vec<DomainCheck> = Vec::with_capacity(check_count);
10570 for i in 0..check_count {
10571 let expr = cur.read_str()?;
10572 // v7.39 (round 260) — names arrived in FILE_VERSION 75.
10573 // An older catalog gets PG's auto-naming applied to the
10574 // checks it stored, which is what they would have been.
10575 let cname = if version >= 75 {
10576 cur.read_str()?
10577 } else if i == 0 {
10578 alloc::format!("{name}_check")
10579 } else {
10580 alloc::format!("{name}_check{i}")
10581 };
10582 checks.push(DomainCheck { name: cname, expr });
10583 }
10584 // v7.39 (round 259) — the parent domain. Absent before
10585 // FILE_VERSION 74; an older catalog reads as a domain over
10586 // a scalar, which is what it was.
10587 let base_domain = if version >= 74 {
10588 match cur.read_u8()? {
10589 0 => None,
10590 1 => Some(cur.read_str()?),
10591 other => {
10592 return Err(StorageError::Corrupt(alloc::format!(
10593 "domain base_domain tag {other}"
10594 )));
10595 }
10596 }
10597 } else {
10598 None
10599 };
10600 cat.domain_types.insert(
10601 name.clone(),
10602 DomainDef {
10603 name,
10604 base_type,
10605 nullable,
10606 default,
10607 checks,
10608 base_domain,
10609 },
10610 );
10611 }
10612 }
10613 // v7.17.0 Phase 1.6 — user-schemas registry
10614 // (FILE_VERSION 31+).
10615 if version >= 31 {
10616 let sch_count = cur.read_u32()? as usize;
10617 for _ in 0..sch_count {
10618 let name = cur.read_str()?;
10619 cat.schemas.insert(name);
10620 }
10621 }
10622 // v7.37.42-T2 ζ-B — COMPOSITE types catalog block
10623 // (FILE_VERSION 52+). v51-and-below readers stop at the
10624 // user-schemas block; v52 readers fed a v51 catalog see no
10625 // composite block and default to an empty map.
10626 if version >= 52 {
10627 let ctype_count = cur.read_u32()? as usize;
10628 for _ in 0..ctype_count {
10629 let name = cur.read_str()?;
10630 let field_count = cur.read_u16()? as usize;
10631 let mut fields = Vec::with_capacity(field_count);
10632 let mut field_user_types: Vec<Option<String>> = Vec::with_capacity(field_count);
10633 for _ in 0..field_count {
10634 let fname = cur.read_str()?;
10635 let fty = cur.read_data_type()?;
10636 // v7.39 (round 264) — present from FILE_VERSION 76.
10637 let ut = if version >= 76 {
10638 match cur.read_u8()? {
10639 0 => None,
10640 1 => Some(cur.read_str()?),
10641 other => {
10642 return Err(StorageError::Corrupt(alloc::format!(
10643 "composite field user-type tag {other}"
10644 )));
10645 }
10646 }
10647 } else {
10648 None
10649 };
10650 fields.push((fname, fty));
10651 field_user_types.push(ut);
10652 }
10653 cat.composite_types.insert(
10654 name.clone(),
10655 CompositeDef {
10656 name,
10657 fields,
10658 field_user_types,
10659 },
10660 );
10661 }
10662 }
10663 // v7.39 (read01 round 50) — COMMENT store (FILE_VERSION 61+).
10664 if version >= 61 {
10665 let comment_count = cur.read_u32()? as usize;
10666 for _ in 0..comment_count {
10667 let key = cur.read_str()?;
10668 let text = cur.read_str_long()?;
10669 cat.comments.insert(key, text);
10670 }
10671 }
10672 // v7.39 (read01 round 60) — non-table ACLs (FILE_VERSION 66+).
10673 if version >= 66 {
10674 let read_acl = |cur: &mut Cursor| -> Result<Vec<AclItem>, StorageError> {
10675 let n = cur.read_u16()? as usize;
10676 let mut acl = Vec::with_capacity(n);
10677 for _ in 0..n {
10678 let grantee = cur.read_str()?;
10679 let privs = cur.read_u16()?;
10680 let grantable = cur.read_u16()?;
10681 let grantor = cur.read_str()?;
10682 acl.push(AclItem {
10683 grantee,
10684 privs,
10685 grantable,
10686 grantor,
10687 });
10688 }
10689 Ok(acl)
10690 };
10691 let seq_count = cur.read_u32()? as usize;
10692 for _ in 0..seq_count {
10693 let name = cur.read_str()?;
10694 let owner = if cur.read_u8()? == 1 {
10695 Some(cur.read_str()?)
10696 } else {
10697 None
10698 };
10699 let acl = read_acl(&mut cur)?;
10700 if let Some(seq) = cat.sequences.get_mut(&name) {
10701 seq.owner = owner;
10702 seq.acl = acl;
10703 }
10704 }
10705 cat.schema_acl = read_acl(&mut cur)?;
10706 cat.database_acl = read_acl(&mut cur)?;
10707 // v7.39 (read01 round 61) — FUNCTION owner + ACL (v67+; keyed by
10708 // signature from v68, when overloads became possible).
10709 if version >= 67 {
10710 let fn_count = cur.read_u32()? as usize;
10711 for _ in 0..fn_count {
10712 let name = cur.read_str()?;
10713 let owner = if cur.read_u8()? == 1 {
10714 Some(cur.read_str()?)
10715 } else {
10716 None
10717 };
10718 let acl = read_acl(&mut cur)?;
10719 // v7.39 (round 315, V19) — the stored key was computed
10720 // by whichever formula was current when the image was
10721 // written. A miss is not "no such function": before the
10722 // multi-word fix, `f(double precision)` keyed as
10723 // `f(precision)`, so an older image's grants would land
10724 // nowhere and vanish silently. Fall back to matching by
10725 // the old formula, which re-attaches them.
10726 let target = resolve_stored_function_key(&cat.functions, &name);
10727 if let Some(k) = target
10728 && let Some(f) = cat.functions.get_mut(&k)
10729 {
10730 f.owner = owner;
10731 f.acl = acl;
10732 }
10733 }
10734 }
10735 }
10736 // v7.39 (round 139) — RULE catalog block (FILE_VERSION 71+), read from
10737 // the tail right before the CRC trailer. Pre-71 images stop before it.
10738 if version >= 71 {
10739 let rule_count = cur.read_u32()? as usize;
10740 for _ in 0..rule_count {
10741 let name = cur.read_str()?;
10742 let table = cur.read_str()?;
10743 let event = cur.read_str()?;
10744 let instead = cur.read_u8()? != 0;
10745 let when_condition = cur.read_str()?;
10746 let cmd_count = cur.read_u16()? as usize;
10747 let mut commands = Vec::with_capacity(cmd_count);
10748 for _ in 0..cmd_count {
10749 commands.push(cur.read_str()?);
10750 }
10751 cat.rules.push(RuleDef {
10752 name,
10753 table,
10754 event,
10755 instead,
10756 when_condition,
10757 commands,
10758 });
10759 }
10760 }
10761 // v7.39 (round 280) — extended-statistics block (FILE_VERSION
10762 // 77+). Pre-77 images stop before it.
10763 if version >= 77 {
10764 let count = cur.read_u32()? as usize;
10765 for _ in 0..count {
10766 let name = cur.read_str()?;
10767 let table = cur.read_str()?;
10768 let nk = cur.read_u16()? as usize;
10769 let mut kinds = Vec::with_capacity(nk);
10770 for _ in 0..nk {
10771 kinds.push(cur.read_str()?);
10772 }
10773 let nc = cur.read_u16()? as usize;
10774 let mut columns = Vec::with_capacity(nc);
10775 for _ in 0..nc {
10776 columns.push(cur.read_str()?);
10777 }
10778 cat.statistics_ext.push(StatisticsExtDef {
10779 name,
10780 table,
10781 kinds,
10782 columns,
10783 });
10784 }
10785 }
10786 // v7.39 (round 287) — large-object block (FILE_VERSION 78+).
10787 // Pre-78 images stop before it.
10788 if version >= 78 {
10789 let count = cur.read_u32()? as usize;
10790 for _ in 0..count {
10791 let oid = cur.read_u32()?;
10792 let len = cur.read_u32()? as usize;
10793 let bytes = cur.read_bytes(len)?;
10794 cat.large_objects.insert(oid, bytes);
10795 }
10796 }
10797 // v7.39 (round 322, V46) — function-attribute block (FILE_VERSION
10798 // 80+). Pre-80 images stop before it and keep PG's defaults.
10799 if version >= 80 {
10800 let count = cur.read_u32()? as usize;
10801 for _ in 0..count {
10802 let key = cur.read_str()?;
10803 let volatility = cur.read_u8()?;
10804 let flags = cur.read_u8()?;
10805 let parallel = cur.read_u8()?;
10806 let cost = f64::from_le_bytes(cur.read_bytes(8)?.try_into().unwrap_or([0; 8]));
10807 let rows = f64::from_le_bytes(cur.read_bytes(8)?.try_into().unwrap_or([0; 8]));
10808 if let Some(f) = cat.functions.get_mut(&key) {
10809 f.volatility = volatility;
10810 f.strict = flags & 1 != 0;
10811 f.security_definer = flags & 2 != 0;
10812 f.leakproof = flags & 4 != 0;
10813 f.parallel = parallel;
10814 f.cost = (!cost.is_nan()).then_some(cost);
10815 f.rows = (!rows.is_nan()).then_some(rows);
10816 }
10817 }
10818 }
10819 // v7.39 (round 547) — pg_db_role_setting (FILE_VERSION 85+).
10820 // Pre-85 images stop before it and carry no GUC defaults.
10821 if version >= 85 {
10822 let scopes = cur.read_u32()? as usize;
10823 for _ in 0..scopes {
10824 let db = cur.read_str()?;
10825 let role = cur.read_str()?;
10826 let params = cur.read_u32()? as usize;
10827 let mut m: BTreeMap<String, String> = BTreeMap::new();
10828 for _ in 0..params {
10829 let name = cur.read_str()?;
10830 let value = cur.read_str()?;
10831 m.insert(name, value);
10832 }
10833 if !m.is_empty() {
10834 cat.db_role_settings.insert((db, role), m);
10835 }
10836 }
10837 }
10838 // v7.39 (round 550) — replication slots (FILE_VERSION 86+).
10839 if version >= 86 {
10840 let count = cur.read_u32()? as usize;
10841 for _ in 0..count {
10842 let name = cur.read_str()?;
10843 let plugin = cur.read_str()?;
10844 let slot_type = cur.read_str()?;
10845 cat.replication_slots.insert(name, (plugin, slot_type));
10846 }
10847 }
10848 // v7.38 (read01 P5.05) — v54+ images end with a CRC32C over every
10849 // preceding byte; verify it before accepting the snapshot. Older
10850 // images have no trailer and fall through to the trailing-byte check.
10851 if version >= FILE_VERSION_CRC_TRAILER {
10852 let crc_start = cur.pos;
10853 let stored = cur.read_u32()?;
10854 let computed = spg_crypto::crc32c::crc32c(&buf[..crc_start]);
10855 if computed != stored {
10856 return Err(StorageError::Corrupt(format!(
10857 "base snapshot CRC mismatch: computed {computed:#010x}, stored {stored:#010x}"
10858 )));
10859 }
10860 }
10861 if cur.pos < buf.len() {
10862 return Err(StorageError::Corrupt(format!(
10863 "trailing bytes: {} unread",
10864 buf.len() - cur.pos
10865 )));
10866 }
10867 Ok(cat)
10868 }
10869}
10870
10871#[cfg(test)]
10872mod tests;