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/// v7.38.19 — whether an `interval` is finite, and if not, which way.
640///
641/// PostgreSQL has no NaN interval — measured, not assumed: `'nan'::interval`
642/// is a syntax error on 18.4 while `'infinity'` and `'-infinity'` parse —
643/// so this carries three states where `NumericKind` carries four.
644#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Default)]
645pub enum IntervalKind {
646 #[default]
647 Finite,
648 NegInf,
649 PosInf,
650}
651
652impl IntervalKind {
653 /// PostgreSQL's own representation of the two infinities, measured
654 /// off the wire rather than read out of its source.
655 ///
656 /// ```text
657 /// COPY (SELECT 'infinity'::interval) TO STDOUT (FORMAT binary)
658 /// … 7fffffffffffffff 7fffffff 7fffffff
659 /// COPY (SELECT '-infinity'::interval) TO STDOUT (FORMAT binary)
660 /// … 8000000000000000 80000000 80000000
661 /// COPY (SELECT '1 day'::interval) TO STDOUT (FORMAT binary)
662 /// … 0000000000000000 00000001 00000000
663 /// ```
664 ///
665 /// All three fields at their extreme, which is why SPG can carry an
666 /// explicit `kind` in memory -- so the compiler names every site
667 /// that has to decide what infinity means there -- and still write
668 /// sixteen bytes on disk and on the wire. No finite interval reaches
669 /// the triple: PostgreSQL reserves it, so no value PostgreSQL ever
670 /// produced holds it either, and a file written before this version
671 /// cannot contain one.
672 #[must_use]
673 pub const fn from_fields(months: i32, days: i32, micros: i64) -> Self {
674 if micros == i64::MAX && days == i32::MAX && months == i32::MAX {
675 Self::PosInf
676 } else if micros == i64::MIN && days == i32::MIN && months == i32::MIN {
677 Self::NegInf
678 } else {
679 Self::Finite
680 }
681 }
682
683 /// The three fields this kind is written as. `Finite` hands back
684 /// what it was given.
685 #[must_use]
686 pub const fn to_fields(self, months: i32, days: i32, micros: i64) -> (i32, i32, i64) {
687 match self {
688 Self::Finite => (months, days, micros),
689 Self::PosInf => (i32::MAX, i32::MAX, i64::MAX),
690 Self::NegInf => (i32::MIN, i32::MIN, i64::MIN),
691 }
692 }
693
694 #[must_use]
695 pub const fn is_finite(self) -> bool {
696 matches!(self, Self::Finite)
697 }
698
699 /// Where this kind sits in the total order.
700 ///
701 /// v7.38.19 — PostgreSQL 18.4, measured: `'-infinity' < '-100 years'`
702 /// and `'infinity' > '100 years'` are both true, and `'infinity' =
703 /// 'infinity'` is true. So the rank decides first and the numbers
704 /// only speak between two finite values.
705 ///
706 /// Every comparison of two intervals asks THIS -- the ordering
707 /// comparator, the value comparator and the binary operators each
708 /// had their own copy of the span arithmetic, and three copies of a
709 /// question is how they come to disagree.
710 #[must_use]
711 pub const fn rank(self) -> i8 {
712 match self {
713 Self::NegInf => -1,
714 Self::Finite => 0,
715 Self::PosInf => 1,
716 }
717 }
718}
719
720/// A row-cell value, including SQL `NULL`. `Float` uses `f64`; NaN compares
721/// non-equal to itself (PG behaviour) — `PartialEq` is derived so callers
722/// must opt into NaN-aware comparison if they need stronger guarantees.
723///
724/// v7.37.42-arena Phase 1: parameterised on `'arena` so heap-bearing
725/// variants (Text/Json/Xml/Bytes/Vector/BitString.bytes) can borrow from
726/// a per-query bump arena (`Cow::Borrowed(&'arena ...)`). Persistent /
727/// catalog Values use `Value<'static>` (alias `ValueOwned`) with
728/// `Cow::Owned(...)`. Phase 1 keeps Range/Multirange recursive `Box<Value>`
729/// at `'static` (owned) — arena migration deferred to a later phase.
730/// Array-of-Option<String> variants (TextArray etc.) also stay owned in
731/// Phase 1; their nested shape is awkward for the simple Cow lift and the
732/// SCALARSQ hot path doesn't touch them.
733/// v7.38 (read01, T6) — the IEEE-style class of a NUMERIC value. `Finite` is the
734/// ordinary fixed-point case; the specials mirror PG's `'NaN'` / `'Infinity'` /
735/// `'-Infinity'`. Derived `PartialEq` gives `NaN == NaN` — correct for NUMERIC
736/// (unlike float's NaN ≠ NaN); the total order (`-Inf < finite < +Inf < NaN`)
737/// lives in the comparison paths, not in `Ord`.
738#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Hash)]
739pub enum NumericKind {
740 #[default]
741 Finite,
742 NaN,
743 PosInf,
744 NegInf,
745}
746
747#[derive(Debug, Clone, PartialEq)]
748#[non_exhaustive]
749pub enum Value<'arena> {
750 SmallInt(i16),
751 Int(i32),
752 BigInt(i64),
753 Float(f64),
754 /// v7.38 (read01, T-float4) — PG `real` (32-bit IEEE float).
755 Real(f32),
756 Text(Cow<'arena, str>),
757 Bool(bool),
758 Vector(Cow<'arena, [f32]>),
759 /// v6.0.1: 8-bit scalar-quantised vector cell. Lives in
760 /// columns declared `VECTOR(N) USING SQ8`. Layout per cell:
761 /// `Sq8Vector { min: f32, max: f32, bytes: Vec<u8> }` —
762 /// 4× compression vs `Vector(Vec<f32>)`. The wire layer
763 /// dequantises to `f32` on SELECT; INSERT path quantises
764 /// incoming `Vector(Vec<f32>)` cells into this variant.
765 Sq8Vector(crate::quantize::Sq8Vector),
766 /// v6.0.3: IEEE-754 binary16 vector cell. Lives in columns
767 /// declared `VECTOR(N) USING HALF`. Stores raw u16 LE bits
768 /// (2× compression vs `Vector(Vec<f32>)`). Wire / display
769 /// paths dequantise to f32 bit-exactly; INSERT path converts
770 /// incoming f32 vectors at the engine boundary.
771 HalfVector(crate::halfvec::HalfVector),
772 /// Exact fixed-point decimal. `scaled` holds the value as
773 /// `actual * 10^scale` so the storage type is always integral —
774 /// arithmetic never falls back to floating-point. v7.38 (read01, T6) —
775 /// `kind` classifies the value as finite (the common case, using
776 /// `scaled`/`scale`) or one of PG's NUMERIC specials (NaN / ±Infinity),
777 /// which ignore `scaled`/`scale` (canonicalized to 0).
778 Numeric {
779 scaled: i128,
780 /// v7.39 (round 271) — widened from u8. PG's numeric carries a
781 /// display scale up to 16383; at u8 a literal with 256 decimal
782 /// places could not be represented at all, and the conversion
783 /// aborted the query with an internal error.
784 scale: u16,
785 kind: NumericKind,
786 },
787 /// v7.38 (read01, T3) — an exact NUMERIC whose mantissa overflows `i128`
788 /// (PG's NUMERIC is unbounded). Boxed so the common finite case keeps its
789 /// small footprint; specials never take this form (they stay `Numeric`).
790 NumericBig(alloc::boxed::Box<crate::bignum::BigNumeric>),
791 /// Days since the Unix epoch (1970-01-01). Negative for earlier dates.
792 Date(i32),
793 /// Microseconds since the Unix epoch (1970-01-01T00:00:00Z).
794 Timestamp(i64),
795 /// Calendar span: `months` + `days` + `micros`. Three fields are
796 /// required for PG byte-equal: `'1 day'` ≠ `'24 hours'` (DST,
797 /// month-boundary, and the on-wire `pg_type` `interval` are all
798 /// `i64 micros + i32 days + i32 months`). v7.37.5 β widened from
799 /// `{months, micros}`; column storage lands in the same window.
800 Interval {
801 months: i32,
802 days: i32,
803 micros: i64,
804 /// v7.38.19 — finite, or one of the two infinities.
805 ///
806 /// PostgreSQL 17 gave `interval` an infinite value and SPG had
807 /// none, so `'infinity'::interval` was refused outright and the
808 /// subtraction error the ledger described was one symptom of
809 /// that, not the defect.
810 ///
811 /// A field beside the numbers rather than a sentinel inside
812 /// them, which is the shape `Value::Numeric` already uses for
813 /// exactly this question — and a field on THIS variant rather
814 /// than a new one, so the compiler names every site that has to
815 /// decide what infinity means there. A new variant would have
816 /// compiled everywhere on the first try and let a `_` arm
817 /// answer for it at one of a hundred and five of them.
818 kind: IntervalKind,
819 },
820 /// v4.9 `JSON` — raw JSON text. No structural validation
821 /// happens at the storage layer; whatever the parser hands us
822 /// round-trips verbatim. Equality is byte-wise.
823 Json(Cow<'arena, str>),
824 /// v7.10.4 `BYTEA` — raw binary blob. Equality is byte-wise.
825 /// Layout matches `Text`'s length-prefixed shape (`[u32 LE
826 /// len][bytes]`) under tag 18; the engine accepts PG hex
827 /// literals (`'\xDEADBEEF'`) and escape literals at the
828 /// coercion boundary.
829 Bytes(Cow<'arena, [u8]>),
830 /// v7.10.9 `TEXT[]` — single-dimension TEXT array with
831 /// optional NULL elements. Equality is element-wise. PG's
832 /// NULL-element comparison semantics: NULL ≠ NULL inside
833 /// arrays under `=`, so `[NULL] != [NULL]` (the engine
834 /// honours this).
835 TextArray(Vec<Option<String>>),
836 /// v7.11.12 `INT[]` — single-dimension i32 array with optional
837 /// NULL elements. Codec mirrors TextArray with i32 LE per
838 /// element instead of length-prefixed UTF-8.
839 IntArray(Vec<Option<i32>>),
840 /// v7.11.12 `BIGINT[]` — single-dimension i64 array with optional
841 /// NULL elements.
842 BigIntArray(Vec<Option<i64>>),
843 /// v7.37.5 β-P4 `INTERVAL[]` — single-dimension array of
844 /// `IntervalSpan { months, days, micros }` with optional NULL
845 /// elements. PG external form quotes each non-NULL element
846 /// (`{"1 day","24:00:00",NULL}`) because interval text contains
847 /// spaces and colons. Storage codec follows the BigIntArray
848 /// shape with a 16-byte per-element body.
849 IntervalArray(Vec<Option<IntervalSpan>>),
850 /// v7.37.5 γ — single-dimension arrays of the remaining PG
851 /// scalar types. Each carries `Vec<Option<T>>` with the
852 /// scalar's natural Rust shape; element NULLs are first-class
853 /// (per PG: `{1,NULL,3}` is a 3-element array, not a 2-element
854 /// one). Codec follows the IntervalArray shape — `[u16 count]
855 /// [per elem: u8 null + (non-null) scalar body]`.
856 BoolArray(Vec<Option<bool>>),
857 SmallIntArray(Vec<Option<i16>>),
858 FloatArray(Vec<Option<f64>>),
859 /// PG `NUMERIC[]` — `(scaled: i128, scale: u16)` per element.
860 NumericArray(Vec<Option<(i128, u16)>>),
861 DateArray(Vec<Option<i32>>),
862 TimestampArray(Vec<Option<i64>>),
863 TimestamptzArray(Vec<Option<i64>>),
864 UuidArray(Vec<Option<[u8; 16]>>),
865 JsonArray(Vec<Option<String>>),
866 JsonbArray(Vec<Option<String>>),
867 BytesArray(Vec<Option<Vec<u8>>>),
868 VarcharArray(Vec<Option<String>>),
869 CharArray(Vec<Option<String>>),
870 /// v7.37.5 δ — PG 14+ multirange. `ranges` is a Vec of
871 /// non-overlapping bounds spans of the shared `kind`. PG's
872 /// canonical text form is `{[a,b),[c,d),...}` (comma-separated
873 /// ranges in braces; `{}` for the empty multirange). SPG's
874 /// constructor enforces no overlap/coalescing — for now the
875 /// engine trusts the caller (mirrors PG's `_construct_array`
876 /// pattern). Catalog tag 49 + 1-byte RangeKind on the dense
877 /// type-tag side; schema-less path is unreachable (multirange
878 /// is column-typed only).
879 Multirange {
880 kind: RangeKind,
881 ranges: Vec<RangeSpan>,
882 },
883 /// v7.37.5 ε — PG geometry scalars. Per-type Vec/struct shape;
884 /// codec body shape is described on the matching DataType
885 /// variant. PG canonical text forms:
886 /// Point `(x,y)`
887 /// Lseg `[(x1,y1),(x2,y2)]`
888 /// Path open `[(x,y),(x,y),...]` / closed `((x,y),(x,y),...)`
889 /// Box `(ux,uy),(lx,ly)` (PG normalises to upper-right + lower-left)
890 /// Polygon `((x,y),(x,y),...)` (implicit closed)
891 /// Line `{a,b,c}` (Ax + By + C = 0)
892 /// Circle `<(x,y),r>`
893 Point(Point2D),
894 Lseg(Point2D, Point2D),
895 /// `closed = true` is `((p,p,...))`; `false` is `[(p,p,...)]`.
896 Path {
897 points: Vec<Point2D>,
898 closed: bool,
899 },
900 /// PG `box` — stored as `(upper_right, lower_left)` (PG's
901 /// normalised order). The engine accepts both endpoint
902 /// orderings at parse time and normalises here.
903 PgBox(Point2D, Point2D),
904 Polygon(Vec<Point2D>),
905 Line {
906 a: f64,
907 b: f64,
908 c: f64,
909 },
910 Circle {
911 center: Point2D,
912 radius: f64,
913 },
914 /// v7.37.5 ζ-A — PG `inet`. `family = 4` (IPv4) or `6` (IPv6).
915 /// `bits` is the netmask bit count (0..=32 for IPv4, 0..=128
916 /// for IPv6). `addr` is right-padded with zeros when family=4
917 /// (first 4 bytes are the address).
918 Inet {
919 family: u8,
920 bits: u8,
921 addr: [u8; 16],
922 },
923 /// v7.37.5 ζ-A — PG `cidr`. Same shape as Inet; CIDR's
924 /// invariant (host bits zero) is enforced at parse / coerce.
925 Cidr {
926 family: u8,
927 bits: u8,
928 addr: [u8; 16],
929 },
930 /// v7.37.5 ζ-A — PG `macaddr`. 6 bytes (XX:XX:XX:XX:XX:XX).
931 Macaddr([u8; 6]),
932 /// v7.37.5 ζ-A — PG `macaddr8`. 8 bytes (EUI-64).
933 Macaddr8([u8; 8]),
934 /// v7.39 (read01 pg_lsn.c) — PG `pg_lsn`, a 64-bit WAL location.
935 PgLsn(u64),
936 /// v7.39 (read01 ruleutils.c) — PG `regclass`: an OID-typed relation
937 /// reference that renders as the relation name. SPG carries BOTH
938 /// (the synthetic oid for catalog joins, the name for display) so
939 /// `conrelid = 't'::regclass` and `'t'::regclass::text` agree.
940 /// Eval-only (no column storage).
941 RegClass(i64, alloc::boxed::Box<str>),
942 /// v7.39 (round 342, V65) — PG `regproc`: an OID-typed FUNCTION
943 /// reference that renders as the function name. Same dual shape
944 /// [`Value::RegClass`] carries, and for the same reason: without the
945 /// oid half, `pg_proc.oid = 'f'::regproc` cannot join, and a callee
946 /// cannot tell `pg_get_functiondef('f'::regproc)` — which PG answers
947 /// — from `pg_get_functiondef('f')` — which PG rejects.
948 /// Eval-only (no column storage).
949 RegProc(i64, alloc::boxed::Box<str>),
950 /// v7.39 (round 648) — PG `regtype`: an OID-typed TYPE reference
951 /// that renders as the type name. The third of the shape
952 /// [`Value::RegClass`] and [`Value::RegProc`] carry, and the one
953 /// that was missing it: `::regtype` produced a plain `Value::Text`
954 /// holding the canonical name, so `'text'::regtype::oid` tried to
955 /// parse the NAME as a number and answered `invalid input syntax
956 /// for type oid: "text"` where PG answers 25. `pg_typeof` on one
957 /// said `text` rather than `regtype` for the same reason.
958 ///
959 /// Eval-only (no column storage).
960 RegType(i64, alloc::boxed::Box<str>),
961 /// v7.39 (round 512) — PG `xid` and `cid`, the transaction and command
962 /// ids the `xmin` / `xmax` / `cmin` / `cmax` system columns carry.
963 ///
964 /// Their own types rather than integers, because PG deliberately gives
965 /// them almost no operators: measured on PG18, `xmin + 1` is "operator
966 /// does not exist: xid + integer", `xmin > 0` likewise, `xmin::bigint`
967 /// is "cannot cast type xid to bigint", and there is no `max(xid)`.
968 /// Carrying them as BigInt would quietly allow all four.
969 ///
970 /// Eval-only (no column storage).
971 Xid(u32),
972 Cid(u32),
973 /// v7.39 (round 511) — PG `tid`, the physical row identity `ctid`
974 /// carries: a block number and a one-based offset inside it, rendered
975 /// `(block,offset)`.
976 ///
977 /// It is a real type rather than a two-field record because the idiom
978 /// that makes `ctid` worth having — `DELETE … WHERE ctid NOT IN (SELECT
979 /// min(ctid) … GROUP BY key)` — needs `min()` over it, and PG has no
980 /// `min(record)`. Ordering is by block then offset, so `(0,2) < (0,9) <
981 /// (0,10)`; a text form would order those `(0,10) < (0,2) < (0,9)` and
982 /// the dedup would keep the wrong row.
983 ///
984 /// Eval-only (no column storage).
985 Tid(u32, u32),
986 /// v7.37.5 ζ-A — PG `bit` / `bit varying`. `nbits` is the
987 /// actual bit count; `bytes` is the packed representation
988 /// (big-endian within each byte; final byte right-padded
989 /// with 0s if `nbits % 8 != 0`).
990 BitString {
991 nbits: u32,
992 bytes: Cow<'arena, [u8]>,
993 },
994 /// v7.37.5 ζ-A — PG `xml`. Stored verbatim as a string; no
995 /// parse-time validation (matches the SPG JSON convention).
996 Xml(Cow<'arena, str>),
997 /// v7.37.5 ζ-A — PG `"char"` (internal single-byte type,
998 /// distinct from CHAR(n)).
999 Char1(u8),
1000 /// v7.38 (read01, T11) — PG `bpchar` / CHAR(n): blank-padded fixed-length
1001 /// string. Stored space-padded to the declared width (as PG does + for wire
1002 /// display); length / comparison / ::text / concat all ignore the trailing
1003 /// blanks (handled at those sites).
1004 BpChar(Cow<'arena, str>),
1005 /// v7.37.5 ζ-A — PG `money[]`.
1006 MoneyArray(Vec<Option<i64>>),
1007 /// v7.12.0 `tsvector` — sorted-by-word, deduped lexeme set with
1008 /// positions + weights. The engine enforces sort/dedup on
1009 /// construction; consumers can rely on `lexemes.windows(2)`
1010 /// being strictly ascending by `word`.
1011 TsVector(Vec<TsLexeme>),
1012 /// v7.12.0 `tsquery` — boolean / phrase parse tree over
1013 /// lexemes. Engine builds via `to_tsquery` family.
1014 TsQuery(TsQueryAst),
1015 /// v7.17.0 `uuid` — 128-bit identifier. Stored as 16 bytes
1016 /// (big-endian / network-byte order, same as RFC 4122).
1017 /// Display normalises to canonical lowercase 8-4-4-4-12
1018 /// hyphenated form. Equality is byte-wise.
1019 Uuid([u8; 16]),
1020 /// v7.17.0 Phase 3.P0-32 — PG `time` (without time zone) —
1021 /// i64 microseconds since 00:00:00. Range 0..86_400_000_000.
1022 /// Display: `HH:MM:SS` zero-padded, with optional `.ffffff`
1023 /// suffix when fractional is non-zero.
1024 Time(i64),
1025 /// v7.17.0 Phase 3.P0-33 — MySQL `YEAR` — u16 in range
1026 /// 1901..=2155 plus the special zero-year sentinel 0.
1027 /// Display always 4 digits zero-padded (`0000` for the
1028 /// sentinel; `1985`/`2007` otherwise).
1029 Year(u16),
1030 /// v7.17.0 Phase 3.P0-34 — PG `time with time zone` — i64
1031 /// microseconds since 00:00:00 in the LOCAL wall clock PLUS
1032 /// an i32 offset-from-UTC in seconds. PG preserves the
1033 /// offset on output, so the wall-clock value is NOT shifted
1034 /// to UTC at storage time. Offset range: ±50400 seconds
1035 /// (±14 hours).
1036 TimeTz {
1037 us: i64,
1038 offset_secs: i32,
1039 },
1040 /// v7.17.0 Phase 3.P0-35 — PG `money` — i64 cents
1041 /// (locale-independent storage; the en_US locale renders on
1042 /// display via `$N,NNN.CC`).
1043 Money(i64),
1044 /// v7.17.0 Phase 3.P0-39 — PG `hstore` value: flat
1045 /// `text => text` map with NULL value support. Insertion
1046 /// order preserved on input; duplicate keys take last-write-
1047 /// wins at parse time.
1048 Hstore(Vec<(String, Option<String>)>),
1049 /// v7.17.0 Phase 3.P0-40 — 2D INT matrix (row-major).
1050 IntArray2D(Vec<Vec<Option<i32>>>),
1051 /// v7.17.0 Phase 3.P0-40 — 2D BIGINT matrix (row-major).
1052 BigIntArray2D(Vec<Vec<Option<i64>>>),
1053 /// v7.17.0 Phase 3.P0-40 — 2D TEXT matrix (row-major).
1054 TextArray2D(Vec<Vec<Option<String>>>),
1055 /// v7.39 (read01 round 75) — see `DataType::BoolArray2D`.
1056 BoolArray2D(Vec<Vec<Option<bool>>>),
1057 /// v7.17.0 Phase 3.P0-38 — PG range value. One shape covers
1058 /// all six builtin range types; `kind` pins the element type
1059 /// (must match the column's `DataType::Range(kind)`).
1060 /// `lower` / `upper` are `None` for the unbounded sides;
1061 /// `lower_inc` / `upper_inc` mirror the canonical PG
1062 /// `[` / `(` / `]` / `)` bracket inclusivity. `empty=true`
1063 /// supersedes all other fields (the empty range has no
1064 /// bounds).
1065 Range {
1066 kind: RangeKind,
1067 // v7.37.42-arena Phase 1: Range bounds stay owned ('static).
1068 // Recursive arena lifetimes are awkward to migrate at this
1069 // phase and the SCALARSQ hot path doesn't construct ranges.
1070 lower: Option<alloc::boxed::Box<Value<'static>>>,
1071 upper: Option<alloc::boxed::Box<Value<'static>>>,
1072 lower_inc: bool,
1073 upper_inc: bool,
1074 empty: bool,
1075 },
1076 /// v7.38 (read01, T9) — a composite / record value (a `row(...)`
1077 /// constructor or a whole-row reference). Fields are `(name, value)`; the
1078 /// names are `f1..fN` for an anonymous `row(...)` or the source column
1079 /// names for a table row. Transient — flows through row_to_json / to_json
1080 /// and the composite text form `(a,b)`; not a storable column type here.
1081 Composite(alloc::vec::Vec<(alloc::string::String, Value<'static>)>),
1082 Null,
1083}
1084
1085/// Owned `Value` — heap-bearing variants are `Cow::Owned`. Used everywhere
1086/// a Value must outlive a query-scoped arena (catalog defaults, persistent
1087/// storage, public APIs).
1088pub type ValueOwned = Value<'static>;
1089
1090/// v7.37.5 ε — PG `point` building block. Shared by every other
1091/// geometric type (lseg / path / box / polygon / circle all
1092/// reduce to compositions of `Point2D`). Packed `{x: f64, y: f64}`,
1093/// 16 B, on-disk LE field order matches the PG binary point
1094/// format byte-for-byte (so a future binary BIND path lands
1095/// without rearrangement).
1096#[derive(Debug, Clone, Copy, PartialEq)]
1097pub struct Point2D {
1098 pub x: f64,
1099 pub y: f64,
1100}
1101
1102/// v7.37.5 δ — single-range bounds without the kind tag. Used as
1103/// the element type of `Value::Multirange { kind, ranges }` so a
1104/// multirange carries one shared `RangeKind` plus N bounds-only
1105/// spans (saves 1 byte/elem vs duplicating the kind). The five
1106/// other fields mirror `Value::Range` exactly.
1107#[derive(Debug, Clone, PartialEq)]
1108pub struct RangeSpan {
1109 // v7.37.42-arena Phase 1: stays owned ('static) — same rationale as
1110 // Range bounds above.
1111 pub lower: Option<alloc::boxed::Box<Value<'static>>>,
1112 pub upper: Option<alloc::boxed::Box<Value<'static>>>,
1113 pub lower_inc: bool,
1114 pub upper_inc: bool,
1115 pub empty: bool,
1116}
1117
1118/// v7.37.5 β-P4 — element type for `Value::IntervalArray`. Mirrors
1119/// the `{months, days, micros}` shape of scalar `Value::Interval`,
1120/// broken out as a named struct so `IntervalArray`'s element type
1121/// is concrete (24 bytes, packed) instead of an enum-boxed Value.
1122/// All three dimensions are independent — `IntervalSpan { days: 1,
1123/// .. }` is distinct from `IntervalSpan { micros: 86_400_000_000,
1124/// .. }` per PG byte-equal.
1125#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1126pub struct IntervalSpan {
1127 pub months: i32,
1128 pub days: i32,
1129 pub micros: i64,
1130 /// v7.38.19 — see [`IntervalKind`].
1131 pub kind: IntervalKind,
1132}
1133
1134impl<'arena> Value<'arena> {
1135 /// Type tag, or `None` for `NULL` (unknown at value level).
1136 pub fn data_type(&self) -> Option<DataType> {
1137 match self {
1138 Self::SmallInt(_) => Some(DataType::SmallInt),
1139 Self::Int(_) => Some(DataType::Int),
1140 Self::BigInt(_) => Some(DataType::BigInt),
1141 Self::Float(_) => Some(DataType::Float),
1142 Self::Real(_) => Some(DataType::Real),
1143 // `Text` covers both unbounded TEXT and bounded VARCHAR/CHAR
1144 // — the constraint lives on the column schema, not the value.
1145 Self::Text(_) => Some(DataType::Text),
1146 Self::Bool(_) => Some(DataType::Bool),
1147 Self::Vector(v) => Some(DataType::Vector {
1148 dim: u32::try_from(v.len()).expect("vector dim ≤ u32"),
1149 encoding: VecEncoding::F32,
1150 }),
1151 Self::Sq8Vector(q) => Some(DataType::Vector {
1152 dim: u32::try_from(q.bytes.len()).expect("vector dim ≤ u32"),
1153 encoding: VecEncoding::Sq8,
1154 }),
1155 Self::HalfVector(h) => Some(DataType::Vector {
1156 dim: u32::try_from(h.dim()).expect("vector dim ≤ u32"),
1157 encoding: VecEncoding::F16,
1158 }),
1159 // `Value::Numeric` doesn't carry its precision (the column
1160 // schema does); we surface precision=0 as "unknown" and let
1161 // the engine reconcile against the column type at coercion
1162 // time.
1163 // v7.39 (round 273) — a VALUE's display scale is unsigned and
1164 // never exceeds PG's 16383 ceiling, so it always fits the
1165 // signed declared-scale field this describes itself with.
1166 Self::Numeric { scale, .. } => Some(DataType::Numeric {
1167 precision: 0,
1168 scale: i16::try_from(*scale).unwrap_or(i16::MAX),
1169 }),
1170 Self::NumericBig(b) => Some(DataType::Numeric {
1171 precision: 0,
1172 scale: i16::try_from(b.scale()).unwrap_or(i16::MAX),
1173 }),
1174 Self::Date(_) => Some(DataType::Date),
1175 Self::Timestamp(_) => Some(DataType::Timestamp),
1176 Self::Interval { .. } => Some(DataType::Interval),
1177 Self::Json(_) => Some(DataType::Json),
1178 Self::Bytes(_) => Some(DataType::Bytes),
1179 Self::TextArray(_) => Some(DataType::TextArray),
1180 Self::IntArray(_) => Some(DataType::IntArray),
1181 Self::BigIntArray(_) => Some(DataType::BigIntArray),
1182 Self::IntervalArray(_) => Some(DataType::IntervalArray),
1183 Self::BoolArray(_) => Some(DataType::BoolArray),
1184 Self::SmallIntArray(_) => Some(DataType::SmallIntArray),
1185 Self::FloatArray(_) => Some(DataType::FloatArray),
1186 Self::NumericArray(_) => Some(DataType::NumericArray),
1187 Self::DateArray(_) => Some(DataType::DateArray),
1188 Self::TimestampArray(_) => Some(DataType::TimestampArray),
1189 Self::TimestamptzArray(_) => Some(DataType::TimestamptzArray),
1190 Self::UuidArray(_) => Some(DataType::UuidArray),
1191 Self::JsonArray(_) => Some(DataType::JsonArray),
1192 Self::JsonbArray(_) => Some(DataType::JsonbArray),
1193 Self::BytesArray(_) => Some(DataType::BytesArray),
1194 Self::VarcharArray(_) => Some(DataType::VarcharArray),
1195 Self::CharArray(_) => Some(DataType::CharArray),
1196 Self::Multirange { kind, .. } => Some(DataType::Multirange(*kind)),
1197 Self::Point(_) => Some(DataType::Point),
1198 Self::Lseg(_, _) => Some(DataType::Lseg),
1199 Self::Path { .. } => Some(DataType::Path),
1200 Self::PgBox(_, _) => Some(DataType::PgBox),
1201 Self::Polygon(_) => Some(DataType::Polygon),
1202 Self::Line { .. } => Some(DataType::Line),
1203 Self::Circle { .. } => Some(DataType::Circle),
1204 Self::Inet { .. } => Some(DataType::Inet),
1205 Self::Cidr { .. } => Some(DataType::Cidr),
1206 Self::Macaddr(_) => Some(DataType::Macaddr),
1207 Self::Macaddr8(_) => Some(DataType::Macaddr8),
1208 Self::PgLsn(_) => Some(DataType::PgLsn),
1209 // BitString could be either Bit or BitVarying; column
1210 // schema decides. Default to BitVarying when called
1211 // schema-less (rare; storage path is always
1212 // schema-aware so this only matters for diagnostics).
1213 Self::BitString { .. } => Some(DataType::BitVarying(0)),
1214 Self::Xml(_) => Some(DataType::Xml),
1215 Self::Char1(_) => Some(DataType::Char1),
1216 // BpChar reports its declared width from the padded length.
1217 Self::BpChar(s) => Some(DataType::Char(
1218 u32::try_from(s.chars().count()).unwrap_or(0),
1219 )),
1220 Self::MoneyArray(_) => Some(DataType::MoneyArray),
1221 Self::TsVector(_) => Some(DataType::TsVector),
1222 Self::TsQuery(_) => Some(DataType::TsQuery),
1223 Self::Uuid(_) => Some(DataType::Uuid),
1224 Self::Time(_) => Some(DataType::Time),
1225 Self::Year(_) => Some(DataType::Year),
1226 Self::TimeTz { .. } => Some(DataType::TimeTz),
1227 Self::Money(_) => Some(DataType::Money),
1228 Self::Range { kind, .. } => Some(DataType::Range(*kind)),
1229 Self::Hstore(_) => Some(DataType::Hstore),
1230 Self::IntArray2D(_) => Some(DataType::IntArray2D),
1231 Self::BigIntArray2D(_) => Some(DataType::BigIntArray2D),
1232 Self::TextArray2D(_) => Some(DataType::TextArray2D),
1233 Self::BoolArray2D(_) => Some(DataType::BoolArray2D),
1234 // v7.38 (read01, T9) — a transient composite/record has no storable
1235 // column DataType (it flows through row_to_json / to_json).
1236 Self::Composite(_) => None,
1237 // v7.39 (read01 ruleutils.c) — regclass is eval-only (dual
1238 // oid+name shape); no column storage type.
1239 // v7.39 (round 640) — `xid` became a column type, so its value
1240 // has a DataType to answer with. `cid` and `tid` are equally
1241 // legal column types on PG (measured: `CREATE TABLE t (a cid,
1242 // b tid)` is accepted), but SPG's grammar has no keyword for
1243 // them yet; they stay eval-only rather than half-declared.
1244 Self::Xid(_) => Some(DataType::Xid),
1245 Self::RegClass(..)
1246 | Self::RegProc(..)
1247 | Self::RegType(..)
1248 | Self::Tid(..)
1249 | Self::Cid(_) => None,
1250 Self::Null => None,
1251 }
1252 }
1253
1254 pub const fn is_null(&self) -> bool {
1255 matches!(self, Self::Null)
1256 }
1257
1258 /// v7.37.42-arena Phase 1: lift any `Value<'arena>` (possibly
1259 /// borrowing from a bump arena) into a fully-owned `Value<'static>`.
1260 /// Used at boundaries that must outlive the per-query arena
1261 /// (catalog write, public QueryResult emit, sqlx materialise).
1262 ///
1263 /// For the recursive Range/Multirange variants — bounds are already
1264 /// `Box<Value<'static>>` per Phase 1 design, so we just rebuild the
1265 /// outer enum at `'static`.
1266 pub fn into_owned(self) -> Value<'static> {
1267 match self {
1268 Value::SmallInt(n) => Value::SmallInt(n),
1269 Value::Int(n) => Value::Int(n),
1270 Value::BigInt(n) => Value::BigInt(n),
1271 Value::Float(f) => Value::Float(f),
1272 Value::Real(f) => Value::Real(f),
1273 Value::Text(s) => Value::Text(Cow::Owned(s.into_owned())),
1274 Value::Bool(b) => Value::Bool(b),
1275 Value::Vector(v) => Value::Vector(Cow::Owned(v.into_owned())),
1276 Value::Sq8Vector(q) => Value::Sq8Vector(q),
1277 Value::HalfVector(h) => Value::HalfVector(h),
1278 Value::Numeric {
1279 scaled,
1280 scale,
1281 kind,
1282 } => Value::Numeric {
1283 scaled,
1284 scale,
1285 kind,
1286 },
1287 Value::NumericBig(b) => Value::NumericBig(b),
1288 Value::Date(d) => Value::Date(d),
1289 Value::Timestamp(t) => Value::Timestamp(t),
1290 Value::Interval {
1291 months,
1292 days,
1293 micros,
1294 kind,
1295 } => Value::Interval {
1296 months,
1297 days,
1298 micros,
1299 kind,
1300 },
1301 Value::Json(s) => Value::Json(Cow::Owned(s.into_owned())),
1302 Value::Bytes(b) => Value::Bytes(Cow::Owned(b.into_owned())),
1303 Value::TextArray(v) => Value::TextArray(v),
1304 Value::IntArray(v) => Value::IntArray(v),
1305 Value::BigIntArray(v) => Value::BigIntArray(v),
1306 Value::IntervalArray(v) => Value::IntervalArray(v),
1307 Value::BoolArray(v) => Value::BoolArray(v),
1308 Value::SmallIntArray(v) => Value::SmallIntArray(v),
1309 Value::FloatArray(v) => Value::FloatArray(v),
1310 Value::NumericArray(v) => Value::NumericArray(v),
1311 Value::DateArray(v) => Value::DateArray(v),
1312 Value::TimestampArray(v) => Value::TimestampArray(v),
1313 Value::TimestamptzArray(v) => Value::TimestamptzArray(v),
1314 Value::UuidArray(v) => Value::UuidArray(v),
1315 Value::JsonArray(v) => Value::JsonArray(v),
1316 Value::JsonbArray(v) => Value::JsonbArray(v),
1317 Value::BytesArray(v) => Value::BytesArray(v),
1318 Value::VarcharArray(v) => Value::VarcharArray(v),
1319 Value::CharArray(v) => Value::CharArray(v),
1320 Value::Multirange { kind, ranges } => Value::Multirange { kind, ranges },
1321 // v7.38 (read01, T9) — Composite fields are already `Value<'static>`.
1322 Value::Composite(fields) => Value::Composite(fields),
1323 Value::RegClass(oid, name) => Value::RegClass(oid, name),
1324 Value::Tid(b, o) => Value::Tid(b, o),
1325 Value::Xid(x) => Value::Xid(x),
1326 Value::Cid(c) => Value::Cid(c),
1327 Value::RegProc(oid, name) => Value::RegProc(oid, name),
1328 Value::RegType(oid, name) => Value::RegType(oid, name),
1329 Value::Point(p) => Value::Point(p),
1330 Value::Lseg(a, b) => Value::Lseg(a, b),
1331 Value::Path { points, closed } => Value::Path { points, closed },
1332 Value::PgBox(a, b) => Value::PgBox(a, b),
1333 Value::Polygon(p) => Value::Polygon(p),
1334 Value::Line { a, b, c } => Value::Line { a, b, c },
1335 Value::Circle { center, radius } => Value::Circle { center, radius },
1336 Value::Inet { family, bits, addr } => Value::Inet { family, bits, addr },
1337 Value::Cidr { family, bits, addr } => Value::Cidr { family, bits, addr },
1338 Value::Macaddr(m) => Value::Macaddr(m),
1339 Value::Macaddr8(m) => Value::Macaddr8(m),
1340 Value::PgLsn(l) => Value::PgLsn(l),
1341 Value::BitString { nbits, bytes } => Value::BitString {
1342 nbits,
1343 bytes: Cow::Owned(bytes.into_owned()),
1344 },
1345 Value::Xml(s) => Value::Xml(Cow::Owned(s.into_owned())),
1346 Value::Char1(c) => Value::Char1(c),
1347 Value::BpChar(s) => Value::BpChar(Cow::Owned(s.into_owned())),
1348 Value::MoneyArray(v) => Value::MoneyArray(v),
1349 Value::TsVector(v) => Value::TsVector(v),
1350 Value::TsQuery(q) => Value::TsQuery(q),
1351 Value::Uuid(u) => Value::Uuid(u),
1352 Value::Time(t) => Value::Time(t),
1353 Value::Year(y) => Value::Year(y),
1354 Value::TimeTz { us, offset_secs } => Value::TimeTz { us, offset_secs },
1355 Value::Money(m) => Value::Money(m),
1356 Value::Range {
1357 kind,
1358 lower,
1359 upper,
1360 lower_inc,
1361 upper_inc,
1362 empty,
1363 } => Value::Range {
1364 kind,
1365 lower,
1366 upper,
1367 lower_inc,
1368 upper_inc,
1369 empty,
1370 },
1371 Value::Hstore(h) => Value::Hstore(h),
1372 Value::IntArray2D(a) => Value::IntArray2D(a),
1373 Value::BigIntArray2D(a) => Value::BigIntArray2D(a),
1374 Value::TextArray2D(a) => Value::TextArray2D(a),
1375 Value::BoolArray2D(a) => Value::BoolArray2D(a),
1376 Value::Null => Value::Null,
1377 }
1378 }
1379
1380 /// v7.37.42-arena Phase 4 — copy heap payloads into the supplied
1381 /// bump arena, yielding a `Value<'a>` whose Cow-variant payloads
1382 /// are arena-borrowed (or stay as small owned scalars for the
1383 /// `Copy`-able variants).
1384 ///
1385 /// Used at the catalog ↔ ephemeral boundary: a `ColumnSchema.default`
1386 /// is `Value<'static>` but INSERT-time eval may want it stamped into
1387 /// the per-statement arena alongside other arena-built scalars.
1388 ///
1389 /// Allocates only into the supplied arena; the input `&self` keeps
1390 /// its own storage. For `Copy`-able / nested-owned variants the
1391 /// implementation falls back to `clone()` (the nested heap blocks
1392 /// stay on the global allocator, which is fine — the boundary
1393 /// requirement is just "no aliasing of caller-owned strings").
1394 pub fn clone_into<'a>(&self, arena: &'a bumpalo::Bump) -> Value<'a> {
1395 match self {
1396 Value::Text(s) => Value::Text(Cow::Borrowed(arena.alloc_str(s))),
1397 Value::Json(s) => Value::Json(Cow::Borrowed(arena.alloc_str(s))),
1398 Value::Xml(s) => Value::Xml(Cow::Borrowed(arena.alloc_str(s))),
1399 Value::BpChar(s) => Value::BpChar(Cow::Borrowed(arena.alloc_str(s))),
1400 Value::Bytes(b) => {
1401 let slot = arena.alloc_slice_copy::<u8>(b);
1402 Value::Bytes(Cow::Borrowed(slot))
1403 }
1404 Value::Vector(v) => {
1405 let slot = arena.alloc_slice_copy::<f32>(v);
1406 Value::Vector(Cow::Borrowed(slot))
1407 }
1408 Value::BitString { nbits, bytes } => {
1409 let slot = arena.alloc_slice_copy::<u8>(bytes);
1410 Value::BitString {
1411 nbits: *nbits,
1412 bytes: Cow::Borrowed(slot),
1413 }
1414 }
1415 // Copy-able scalars + variants whose nested heap blocks are
1416 // `'static` regardless of `'arena` (TextArray, JsonArray,
1417 // Hstore, TsVector, Range bounds, …). Clone the heap block
1418 // via the standard `into_owned()` path then lift the
1419 // resulting `Value<'static>` to `Value<'a>` via the Cow
1420 // variance — `'static` covers any lifetime.
1421 other => other.clone().into_owned(),
1422 }
1423 }
1424}
1425
1426impl Value<'static> {
1427 /// v7.37.42-arena Phase 1 — owned-Text constructor. The variant now
1428 /// holds `Cow<'arena, str>`, so the previous `Value::Text(String)`
1429 /// shape no longer compiles directly. This helper preserves the
1430 /// historical ergonomics: `Value::text("foo")` or
1431 /// `Value::text(String::from("foo"))`.
1432 pub fn text<S: Into<String>>(s: S) -> Self {
1433 Value::Text(Cow::Owned(s.into()))
1434 }
1435
1436 /// v7.38 (read01, T6) — a finite NUMERIC from its fixed-point parts.
1437 pub const fn numeric(scaled: i128, scale: u16) -> Self {
1438 Value::Numeric {
1439 scaled,
1440 scale,
1441 kind: NumericKind::Finite,
1442 }
1443 }
1444
1445 /// v7.38 (read01, T6) — a special NUMERIC (NaN / ±Infinity). The fixed-point
1446 /// fields are canonicalized to 0 so equal specials compare byte-identical.
1447 pub const fn numeric_special(kind: NumericKind) -> Self {
1448 Value::Numeric {
1449 scaled: 0,
1450 scale: 0,
1451 kind,
1452 }
1453 }
1454
1455 /// v7.37.42-arena Phase 1 — owned-Json constructor (mirrors `text`).
1456 pub fn json<S: Into<String>>(s: S) -> Self {
1457 Value::Json(Cow::Owned(s.into()))
1458 }
1459
1460 /// v7.37.42-arena Phase 1 — owned-Xml constructor.
1461 pub fn xml<S: Into<String>>(s: S) -> Self {
1462 Value::Xml(Cow::Owned(s.into()))
1463 }
1464
1465 /// v7.37.42-arena Phase 1 — owned-Bytes constructor.
1466 pub fn bytes<B: Into<Vec<u8>>>(b: B) -> Self {
1467 Value::Bytes(Cow::Owned(b.into()))
1468 }
1469
1470 /// v7.37.42-arena Phase 1 — owned-Vector constructor.
1471 pub fn vector<V: Into<Vec<f32>>>(v: V) -> Self {
1472 Value::Vector(Cow::Owned(v.into()))
1473 }
1474
1475 /// v7.37.42-arena Phase 1 — owned-BitString constructor.
1476 pub fn bit_string<B: Into<Vec<u8>>>(nbits: u32, bytes: B) -> Self {
1477 Value::BitString {
1478 nbits,
1479 bytes: Cow::Owned(bytes.into()),
1480 }
1481 }
1482}
1483
1484/// One table row — values are positional and must match
1485/// `TableSchema.columns` in length and (modulo NULL) in `DataType`.
1486///
1487/// v7.37.42-arena Phase 1: parameterised on `'arena` so per-query rows
1488/// can borrow from a bump arena. The owned shape (`Row<'static>`, alias
1489/// `RowOwned`) is what catalog storage, public APIs, and tests use.
1490#[derive(Debug, Clone, PartialEq)]
1491pub struct Row<'arena> {
1492 pub values: Vec<Value<'arena>>,
1493}
1494
1495/// Owned `Row` — values are `Value<'static>`. Used everywhere a row must
1496/// outlive a query-scoped arena.
1497pub type RowOwned = Row<'static>;
1498
1499impl<'arena> Row<'arena> {
1500 pub const fn new(values: Vec<Value<'arena>>) -> Self {
1501 Self { values }
1502 }
1503
1504 pub fn len(&self) -> usize {
1505 self.values.len()
1506 }
1507
1508 pub fn is_empty(&self) -> bool {
1509 self.values.is_empty()
1510 }
1511}
1512
1513impl<'arena> Row<'arena> {
1514 /// v7.37.42-arena Phase 4 — copy every cell into the supplied bump
1515 /// arena, yielding a `Row<'a>` whose Cow-payloads are arena-borrowed.
1516 /// Boundary helper for catalog defaults → DML eval handoff and
1517 /// arena-local row scratch.
1518 pub fn clone_into<'a>(&self, arena: &'a bumpalo::Bump) -> Row<'a> {
1519 Row {
1520 values: self.values.iter().map(|v| v.clone_into(arena)).collect(),
1521 }
1522 }
1523
1524 /// v7.37.42-arena Phase 4 — lift this `Row<'arena>` to a fully-owned
1525 /// `Row<'static>` for catalog write / WAL serialisation. Equivalent
1526 /// to `Row::from_arena(self)` but consumes by value at any lifetime
1527 /// (callers can write `row.into_owned()` mirroring `Value::into_owned`).
1528 pub fn into_owned(self) -> Row<'static> {
1529 Row {
1530 values: self.values.into_iter().map(Value::into_owned).collect(),
1531 }
1532 }
1533}
1534
1535impl Row<'static> {
1536 /// v7.37.42-arena Phase 1 — lift any `Row<'arena>` (possibly arena-
1537 /// borrowed) into a fully-owned `Row<'static>`. Mirrors
1538 /// `Value::into_owned`.
1539 pub fn from_arena(row: Row<'_>) -> Self {
1540 Self {
1541 values: row.values.into_iter().map(Value::into_owned).collect(),
1542 }
1543 }
1544}
1545
1546/// Each bool is an independent, separately-persisted column attribute
1547/// (`nullable`, `auto_increment`, `is_unsigned`, `identity_always`) that the
1548/// catalog appendix reads and writes by name. Packing them into a bitflags
1549/// word would buy nothing and would put a decoding step between the on-disk
1550/// format and every reader of the schema.
1551#[allow(clippy::struct_excessive_bools)]
1552#[derive(Debug, Clone, PartialEq)]
1553pub struct ColumnSchema {
1554 pub name: String,
1555 pub ty: DataType,
1556 pub nullable: bool,
1557 /// Optional `DEFAULT` value, frozen at CREATE TABLE time. `None`
1558 /// means "no default" (so omitted columns become NULL, or error
1559 /// out when the column is NOT NULL). Literal defaults take this
1560 /// path.
1561 ///
1562 /// v7.37.42-arena Phase 1: explicitly `Value<'static>` — catalog
1563 /// defaults must outlive any per-query arena.
1564 pub default: Option<Value<'static>>,
1565 /// v7.9.21 — for DEFAULT expressions that need INSERT-time
1566 /// evaluation (e.g. `DEFAULT now()`, `DEFAULT CURRENT_TIMESTAMP`),
1567 /// the Display form of the expression. The engine re-parses
1568 /// it on each INSERT default-fill, evaluates against an empty
1569 /// row context, and coerces to the column type. mailrs G4.
1570 /// Persisted in catalog FILE_VERSION 15+; older catalogs
1571 /// deserialise with None.
1572 pub runtime_default: Option<String>,
1573 /// MySQL-style `AUTO_INCREMENT`. When set, an INSERT that leaves
1574 /// this column unbound (or sets it to NULL) gets the next integer
1575 /// computed from the column's current max + 1.
1576 /// v7.39 (round 676) — the collation NAME as written, when the column
1577 /// carried an explicit `COLLATE`.
1578 ///
1579 /// `spg_sql::Collation` cannot carry it: it is a two-variant MySQL enum
1580 /// and `from_collation_name` folds `C`, `POSIX`, `en_US` and `default`
1581 /// all into `Binary`. Without the name `pg_attribute.attcollation` can
1582 /// only ever report the type's default, which is what F36 records as
1583 /// "the declaration is taken and ignored".
1584 ///
1585 /// None means the column was written without a `COLLATE` clause and
1586 /// takes its type's collation. Persisted through the v88 appendix,
1587 /// which costs two bytes for a table that declares none.
1588 pub collation_name: Option<String>,
1589 pub auto_increment: bool,
1590 /// v7.17.0 Phase 1.4 — when the column is bound to a user-
1591 /// defined ENUM type (the parser saw an unknown type ident
1592 /// and the engine resolved it against `catalog.enum_types`),
1593 /// this carries the enum name so INSERT/UPDATE can validate
1594 /// the cell value against the enum's labels. `ty` is
1595 /// `DataType::Text` in that case. Persisted in catalog
1596 /// FILE_VERSION 29+; older catalogs deserialise with None.
1597 pub user_enum_type: Option<String>,
1598 /// v7.17.0 Phase 1.5 — when the column is bound to a user-
1599 /// defined DOMAIN (the parser saw an unknown type ident and
1600 /// the engine resolved it against `catalog.domain_types`),
1601 /// this carries the domain name. `ty` is the domain's base
1602 /// type; INSERT/UPDATE re-evaluates the domain's CHECK list
1603 /// + NOT NULL against the cell value. Persisted in catalog
1604 /// FILE_VERSION 30+; older catalogs deserialise with None.
1605 pub user_domain_type: Option<String>,
1606 /// v7.39 (read01 round 56) — when the column is bound to a user-defined
1607 /// COMPOSITE type. `ty` stays `DataType::Jsonb` (the on-disk form), but the
1608 /// engine REHYDRATES the stored JSON into a `Value::Composite` on read, so
1609 /// field access `(p).x`, `= ROW(…)`, ordering and the canonical `(2,b)`
1610 /// text form all work — they were already implemented on Value::Composite;
1611 /// what was missing was that the column never recorded WHICH composite type
1612 /// it holds (this field's doc comment existed for two releases, the field
1613 /// itself did not). Persisted in the composite-column appendix
1614 /// (FILE_VERSION 63+); older catalogs deserialise with None.
1615 pub user_composite_type: Option<String>,
1616 /// v7.39 (read01 round 59) — column-level privileges (PG
1617 /// `pg_attribute.attacl`). `GRANT SELECT (pub) ON t TO dan` lands here and
1618 /// does NOT touch the table's `relacl`. Empty = no column grant, which is
1619 /// every column until one is made.
1620 pub acl: Vec<AclItem>,
1621 /// v7.17.0 Phase 2.1 — MySQL `ON UPDATE CURRENT_TIMESTAMP`
1622 /// column attribute. When `Some(expr_src)`, an UPDATE that
1623 /// does NOT bind this column overrides the new value with
1624 /// the engine-evaluated expression (always `now()` in
1625 /// v7.17.0). Stored as Display-form source so storage
1626 /// stays free of spg-sql; the engine re-parses at UPDATE
1627 /// time. Persisted in catalog FILE_VERSION 32+; older
1628 /// catalogs deserialise with None — preserves the existing
1629 /// "silent ignore" behaviour for snapshots written before
1630 /// the upgrade.
1631 pub on_update_runtime: Option<String>,
1632 /// v7.17.0 Phase 2.5 — text collation. Pre-2.5 SPG accepted
1633 /// `COLLATE <name>` clauses but discarded the name, so a
1634 /// column declared `COLLATE "case_insensitive"` (or any
1635 /// MySQL `_ci` collation) still compared byte-wise — a
1636 /// Tier-S silent failure where `WHERE name = 'foo'` never
1637 /// matched stored `'Foo'`. This carries the parser-derived
1638 /// classification so the engine's WHERE evaluator can route
1639 /// text equality through a case-aware compare. `Binary` (the
1640 /// default) preserves the prior byte-wise behaviour. Only
1641 /// CaseInsensitive lands in the catalog appendix — Binary
1642 /// columns stay implicit, keeping snapshots compact.
1643 /// Persisted in catalog FILE_VERSION 34+; older catalogs
1644 /// deserialise every column as `Binary`.
1645 pub collation: Collation,
1646 /// v7.17.0 Phase 4.4 — MySQL `UNSIGNED` modifier flag. Drives
1647 /// engine-side INSERT / UPDATE range enforcement (rejects
1648 /// negative values on UNSIGNED int columns). Pre-4.4 the
1649 /// parser consumed and discarded the keyword silently, so
1650 /// every UNSIGNED column quietly accepted negatives — a
1651 /// Tier-A correctness drift. Sparse: only UNSIGNED columns
1652 /// land in the catalog appendix; the default `false` keeps
1653 /// snapshots compact for the common signed-int path.
1654 /// Persisted in catalog FILE_VERSION 35+; older catalogs
1655 /// deserialise every column as `is_unsigned = false`.
1656 pub is_unsigned: bool,
1657 /// v7.17.0 Phase 3.P0-36 — MySQL inline `ENUM('a','b','c')`
1658 /// value list. Distinct from `user_enum_type` (which points
1659 /// to a separately CREATE TYPE'd PG enum); this carries the
1660 /// column-local list MySQL DDL declares inline. When `Some`,
1661 /// `ty` is `DataType::Text` and INSERT/UPDATE validates the
1662 /// cell value against this list. Variant ORDER is preserved
1663 /// (MySQL uses it for `ORDER BY col`). Sparse: only ENUM
1664 /// columns land in the catalog appendix.
1665 /// Persisted in catalog FILE_VERSION 41+; older catalogs
1666 /// deserialise with None — preserves silent-drop behaviour
1667 /// for snapshots written before P0-36.
1668 pub inline_enum_variants: Option<Vec<String>>,
1669 /// v7.17.0 Phase 3.P0-37 — MySQL inline `SET('a','b','c')`
1670 /// variant list. Storage is TEXT (canonical comma-joined in
1671 /// definition order, de-duplicated). INSERT/UPDATE validates
1672 /// every comma-separated token against this list. Sparse:
1673 /// only SET columns land in the catalog appendix.
1674 /// Persisted in catalog FILE_VERSION 42+; older catalogs
1675 /// deserialise with None.
1676 pub inline_set_variants: Option<Vec<String>>,
1677 /// v7.37.7(sentori Epic 3 P1)— `GENERATED ALWAYS AS (<expr>)
1678 /// STORED` computed-column source. When `Some`, INSERT / UPDATE
1679 /// recompute the cell against the candidate row(re-parse the
1680 /// stored Display form and evaluate)and overwrite any
1681 /// user-supplied value, matching PG's stored-generated-column
1682 /// semantics. `None` (the default) preserves the regular
1683 /// "column value is whatever the caller passed" path.
1684 /// Persisted in catalog FILE_VERSION 50+; older catalogs
1685 /// deserialise with None.
1686 pub generated_stored_expr: Option<String>,
1687 /// v7.38 (read01) — `GENERATED ALWAYS AS IDENTITY`. Both identity
1688 /// flavours set `auto_increment`; this additionally marks the ALWAYS
1689 /// flavour, whose explicit INSERT value PG rejects ("cannot insert a
1690 /// non-DEFAULT value into column …") unless `OVERRIDING SYSTEM VALUE`.
1691 /// `false` (serial / `BY DEFAULT`) keeps the permissive path. In-memory
1692 /// only for now — not yet in the catalog appendix, so a reloaded table
1693 /// deserialises as `false` (the pre-existing permissive behaviour).
1694 pub identity_always: bool,
1695 /// v7.38 (read01) — the DEFAULT expression's source text, deparsed to
1696 /// PG-compatible form at CREATE TABLE time (e.g. `0`, `(3 + 4)`,
1697 /// `'hi'::text`, `now()`, `CURRENT_DATE`). Distinct from `default`
1698 /// (the coerced value the INSERT path fills) and `runtime_default`
1699 /// (the recompute-per-row Display form): those lose the source
1700 /// spelling, so `information_schema.columns.column_default` /
1701 /// `pg_attrdef` / `pg_get_expr` reported the coerced render
1702 /// (`0.00` for `numeric(10,2) DEFAULT 0`) instead of PG's `0`.
1703 /// `None` for a column with no explicit default. Persisted in catalog
1704 /// FILE_VERSION 58+; older catalogs deserialise with None.
1705 pub default_text: Option<String>,
1706 /// v7.39 (round 220) — `ALTER TABLE … ALTER COLUMN … RESTART [WITH n]`
1707 /// on an identity column. SPG's identity allocation is a max+1 scan;
1708 /// this floor lifts the next allocated value to at least `n`
1709 /// (`max(max+1, n)`) — exactly what a dump-restore RESTART needs, and
1710 /// safer than PG for a backward RESTART (no duplicate-key landmine).
1711 /// Persisted in the FILE_VERSION 73+ sparse appendix; older catalogs
1712 /// deserialise with None.
1713 pub auto_restart: Option<i64>,
1714 /// v7.39 (read01 round 78) — this column is the ONLY column of a FROM item
1715 /// that calls a function returning a BASE type, so the item's row type IS
1716 /// this column: a whole-row reference collapses to the value
1717 /// (`SELECT j FROM jsonb_array_elements('[1]') AS j` → `1`, PG). Runtime
1718 /// only — a catalogued table column is never one, and it is not persisted.
1719 pub scalar_row_source: bool,
1720 /// v7.39 (round 386, type-fidelity epic P1) — the declared MySQL narrow
1721 /// integer width (TINYINT / MEDIUMINT) whose range the storage `ty`
1722 /// (SmallInt / Int) is too wide to enforce. `None` for every other
1723 /// column. Drives the epic-P2 write-path range check. Persisted in the
1724 /// FILE_VERSION 81+ sparse appendix; older catalogs deserialise as None.
1725 pub mysql_int_width: Option<MysqlIntWidth>,
1726 /// v7.39 (round 424, type-fidelity epic) — the declared MySQL
1727 /// fractional-seconds precision of a temporal column: `DATETIME(3)` is
1728 /// `Some(3)`, a BARE `DATETIME` / `TIME` / `TIMESTAMP` is `Some(0)`
1729 /// (MySQL's default is zero — the fraction is dropped on write), and
1730 /// `None` means "not a MySQL-declared temporal column", which is every
1731 /// PG column and leaves microsecond behaviour untouched.
1732 ///
1733 /// Drives write-path truncation (toward zero) and render padding
1734 /// (exactly this many digits, `.000` when the fraction is zero).
1735 /// Persisted in the FILE_VERSION 82+ sparse appendix; older catalogs
1736 /// deserialise as None.
1737 pub mysql_fsp: Option<u8>,
1738}
1739
1740/// v7.17.0 Phase 2.5 — column-level text collation. Drives the
1741/// engine's WHERE / GROUP BY equality routing for `Value::Text`.
1742/// Only two variants are modelled in v7.17:
1743/// * `Binary` — byte-wise comparison (the SPG default;
1744/// matches PG `COLLATE "C"` / `pg_catalog.default`
1745/// and MySQL `*_bin`).
1746/// * `CaseInsensitive` — ASCII case-folded comparison (like
1747/// MySQL `*_ci` collations; PG has NO built-in
1748/// collation of this name — round-761 audit: a
1749/// nondeterministic ICU collation must be CREATEd
1750/// there first). Non-ASCII bytes
1751/// still compare byte-wise; full ICU folding is
1752/// out of v7.17 scope.
1753/// New variants append at the end — older catalogs read missing
1754/// columns as `Binary`.
1755#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1756pub enum Collation {
1757 Binary,
1758 CaseInsensitive,
1759}
1760
1761/// v7.39 (round 386, type-fidelity epic P1) — the declared MySQL narrow
1762/// integer type for a column whose storage `DataType` cannot express it.
1763/// MySQL `TINYINT` (i8, -128..127) collapses to `DataType::SmallInt` (i16)
1764/// and `MEDIUMINT` (24-bit) to `DataType::Int` (i32) — both wider than the
1765/// declared type, so a range check against `ty` alone accepts out-of-range
1766/// values (`INSERT 128 INTO TINYINT` is stored silently where MariaDB
1767/// strict raises ERROR 1264). This annotation records the lost width so the
1768/// write path (epic P2) can enforce the real bounds. `SMALLINT` / `INT` /
1769/// `BIGINT` need no marker — their storage `DataType` is already faithful.
1770/// Sparse: only TINYINT / MEDIUMINT columns carry it; persisted in the
1771/// FILE_VERSION 81+ appendix, older catalogs deserialise as None.
1772#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1773pub enum MysqlIntWidth {
1774 /// MySQL `TINYINT` — signed -128..127, unsigned 0..255. Storage i16.
1775 Tiny,
1776 /// MySQL `SMALLINT UNSIGNED` — 0..65535. Storage widened to i32 (a
1777 /// signed SMALLINT keeps `DataType::SmallInt` and carries no marker).
1778 Small,
1779 /// MySQL `MEDIUMINT` — signed -8388608..8388607, unsigned 0..16777215.
1780 /// Storage i32.
1781 Medium,
1782 /// MySQL `INT UNSIGNED` — 0..4294967295. Storage widened to i64 (a
1783 /// signed INT keeps `DataType::Int` and carries no marker).
1784 Int,
1785 /// v7.39 (round 471, epic P4b) — MySQL `BIGINT UNSIGNED` —
1786 /// 0..18446744073709551615. i64 stops at 2^63-1, so the storage tag is
1787 /// widened to `Numeric` (i128-backed, scale 0), which already compares,
1788 /// orders, indexes and renders as an exact integer. A signed BIGINT
1789 /// keeps `DataType::BigInt` and carries no marker.
1790 Big,
1791}
1792
1793/// v7.39 (round 363, M4 P1) — MySQL's default accent- and
1794/// case-insensitive fold (`utf8mb4_uca1400_ai_ci`).
1795///
1796/// This is the primitive M4 rests on: a session on the MySQL dialect
1797/// compares, groups, sorts and de-duplicates text by its FOLDED form, so
1798/// `Foo` = `foo` = `FOO` and, because the default collation is accent-
1799/// insensitive too, `Bär` = `bar`. The later stages (read path, then the
1800/// UNIQUE / index write path) all route through here so they cannot fold
1801/// differently from one another.
1802///
1803/// The fold is more than case + strip-combining: MariaDB EXPANDS some
1804/// letters — `ß` → `ss`, `æ` → `ae`, `œ` → `oe` — which is why the result
1805/// is built as a `String` rather than mapped char-for-char. Every mapping
1806/// below was measured on MariaDB 11 (`'Bär'='bar'` is 1, `'straße'=
1807/// 'strasse'` is 1, `'a'='æ'` is 0, `'s'='ß'` is 0). Characters with no
1808/// entry keep their lower-cased self, so ASCII and unknown scripts pass
1809/// through unchanged.
1810#[must_use]
1811pub fn mysql_ci_fold(s: &str) -> String {
1812 let mut out = String::with_capacity(s.len());
1813 for ch in s.chars() {
1814 // Lower-case first (`À` → `à`, `Æ` → `æ`), then fold the base.
1815 for lc in ch.to_lowercase() {
1816 match fold_latin_base(lc) {
1817 Some(base) => out.push_str(base),
1818 None => out.push(lc),
1819 }
1820 }
1821 }
1822 out
1823}
1824
1825/// The fold used to COMPARE / GROUP / de-dup text on the MySQL dialect:
1826/// case- and accent-insensitive, and **trailing spaces significant**.
1827///
1828/// v7.38.17 — this used to strip trailing spaces first, and its comment
1829/// said why: "measured on MariaDB 11". MariaDB's default collation is
1830/// PAD SPACE, so that measurement was right about MariaDB. SPG
1831/// advertises `8.0.0-spg-v…` on the MySQL wire, and MySQL 8.0's default
1832/// `utf8mb4_0900_ai_ci` is **NO PAD**. The rule had been calibrated
1833/// against the engine we do not claim to be.
1834///
1835/// Measured today, MySQL 9.7.2 against MariaDB 12.3.2, each in its own
1836/// default collation, over rows `'alpha'` and `'alpha '`:
1837///
1838/// | | MySQL | MariaDB |
1839/// |---|---|---|
1840/// | `WHERE s = 'alpha'` | 1 | 1,2 |
1841/// | `s IN ('alpha','beta')` | 1,3,4 | 1,2,3,4 |
1842/// | `COUNT(DISTINCT s)` | 3 | 2 |
1843/// | `GROUP BY s` groups | 3 | 2 |
1844/// | `JOIN ON v.s = r.s` | 1/10, 2/20 | all four pairs |
1845///
1846/// SPG answered MariaDB's four and MySQL's join — the same question
1847/// decided differently by two paths, which is the shape v7.38.13,
1848/// v7.38.14 and v7.38.16 were each spent on.
1849///
1850/// `CHAR(n)` is a separate question and keeps its old answer: BOTH
1851/// engines ignore a CHAR's trailing spaces, because that is a property
1852/// of the TYPE rather than of the collation. Use
1853/// [`mysql_compare_fold_char`] for a `BpChar` cell.
1854///
1855/// Only literal spaces ever padded — a tab is significant either way —
1856/// and neither function is used by `LIKE`, whose pattern treats a
1857/// trailing space literally.
1858/// Whether a collation of this NAME orders by bytes.
1859///
1860/// v7.38.18 (S0) — pure string classification, and it lives here because
1861/// storage has to ask it: an index whose column collates by a locale
1862/// cannot key on the raw text, and the write path is here. The engine's
1863/// `collate::is_byte_wise` delegates to this one, for the reason the SQL
1864/// type spellings have one owner.
1865///
1866/// `C`, `POSIX`, MySQL's `binary` and every `_bin` family member. The
1867/// encoding suffix rides along: PG publishes `C.utf8` beside `C`.
1868pub fn collation_is_byte_wise(collation: &str) -> bool {
1869 let name = collation.trim();
1870 let base = name.split(['.', '@']).next().unwrap_or(name);
1871 base.eq_ignore_ascii_case("C")
1872 || base.eq_ignore_ascii_case("POSIX")
1873 || base.eq_ignore_ascii_case("binary")
1874 || base
1875 .rsplit_once('_')
1876 .is_some_and(|(_, tail)| tail.eq_ignore_ascii_case("bin"))
1877}
1878
1879/// v7.38.18 (S0/S2) — does an index on a column of this collation key
1880/// by an ICU SORT KEY rather than by the raw text?
1881///
1882/// True for a locale collation (`en_US.utf8`, `de_DE`), which orders by
1883/// rules a byte comparison cannot express.
1884///
1885/// False for byte-wise names, and false for MySQL's folding collations
1886/// (`utf8mb4_0900_ai_ci` and family). Those fold rather than collate,
1887/// and the engine has folded them since v7.37 — routing them here made
1888/// an indexed `s = 'ALPHA'` over the MySQL wire answer nothing where
1889/// MySQL 9.7.1 answers one row, because ICU at PG's strength does not
1890/// call `ALPHA` and `alpha` equal.
1891///
1892/// One owner for the same reason the byte-wise question has one: the
1893/// engine builds the PROBE and this crate builds the ENTRIES, and a
1894/// probe built in another space finds nothing — which reads exactly
1895/// like "no matching rows".
1896pub fn collation_uses_sort_key(collation: &str) -> bool {
1897 if collation_is_byte_wise(collation) {
1898 return false;
1899 }
1900 let name = collation.trim();
1901 let base = name.split(['.', '@']).next().unwrap_or(name);
1902 let lower = base.to_ascii_lowercase();
1903 !(lower.ends_with("_ci") || lower.ends_with("_cs"))
1904}
1905
1906pub fn mysql_compare_fold(s: &str) -> String {
1907 mysql_ci_fold(s)
1908}
1909
1910/// The comparison form of one text value under the MySQL default
1911/// collation, or `None` for a value that is not text.
1912///
1913/// v7.38.18 — one function, applied to each side SEPARATELY, because
1914/// the pair is not the unit. Several sites matched
1915/// `(Text, Text) | (BpChar, BpChar)` and folded a pair; a CHAR compared
1916/// against a VARCHAR or against a literal is neither shape, so it fell
1917/// through and was compared by bytes — with the CHAR still carrying its
1918/// padding. `CASE c WHEN 'ALPHA'` on a `CHAR(8)` holding `'alpha'`
1919/// answered ELSE where MySQL 9.7.2 answers the branch.
1920///
1921/// Folding per value also states the rule correctly: whether trailing
1922/// spaces count is a property of EACH side's own type, so a pair whose
1923/// sides differ has two answers rather than one.
1924pub fn mysql_fold_value(v: &Value<'_>) -> Option<String> {
1925 match v {
1926 Value::BpChar(s) => Some(mysql_compare_fold_char(s)),
1927 Value::Text(s) => Some(mysql_compare_fold(s)),
1928 _ => None,
1929 }
1930}
1931
1932/// [`mysql_compare_fold`] for a `CHAR(n)` cell, whose trailing spaces
1933/// are padding rather than data.
1934///
1935/// Measured on both engines: over `'alpha'` and `'alpha '` in a
1936/// `CHAR(8)`, `WHERE s = 'alpha'` returns both rows and
1937/// `COUNT(DISTINCT s)` is 2 (four rows folding to two values) — MySQL
1938/// 9.7.2 and MariaDB 12.3.2 agree, unlike the VARCHAR case above.
1939pub fn mysql_compare_fold_char(s: &str) -> String {
1940 mysql_ci_fold(s.trim_end_matches(' '))
1941}
1942
1943/// The base letter(s) a lower-cased Latin character folds to, or `None`
1944/// when it is already a base / has no fold. Expansions (`ß` → `ss`) are
1945/// why this returns a string.
1946fn fold_latin_base(c: char) -> Option<&'static str> {
1947 Some(match c {
1948 'à' | 'á' | 'â' | 'ã' | 'ä' | 'å' | 'ā' | 'ă' | 'ą' => "a",
1949 'æ' => "ae",
1950 'ç' | 'ć' | 'č' | 'ĉ' | 'ċ' => "c",
1951 'ð' | 'ď' | 'đ' => "d",
1952 'è' | 'é' | 'ê' | 'ë' | 'ē' | 'ĕ' | 'ė' | 'ę' | 'ě' => "e",
1953 'ĝ' | 'ğ' | 'ġ' | 'ģ' => "g",
1954 'ì' | 'í' | 'î' | 'ï' | 'ĩ' | 'ī' | 'ĭ' | 'į' => "i",
1955 'ĵ' => "j",
1956 'ķ' => "k",
1957 'ł' | 'ĺ' | 'ļ' | 'ľ' => "l",
1958 'ñ' | 'ń' | 'ņ' | 'ň' => "n",
1959 'ò' | 'ó' | 'ô' | 'õ' | 'ö' | 'ø' | 'ō' | 'ŏ' | 'ő' => "o",
1960 'œ' => "oe",
1961 'ŕ' | 'ŗ' | 'ř' => "r",
1962 'ś' | 'š' | 'ŝ' | 'ş' => "s",
1963 'ß' => "ss",
1964 'ţ' | 'ť' | 'ŧ' => "t",
1965 'ù' | 'ú' | 'û' | 'ü' | 'ũ' | 'ū' | 'ŭ' | 'ů' | 'ű' | 'ų' => "u",
1966 'ý' | 'ÿ' => "y",
1967 'ź' | 'ž' | 'ż' => "z",
1968 _ => return None,
1969 })
1970}
1971
1972#[allow(clippy::derivable_impls)]
1973impl Default for Collation {
1974 fn default() -> Self {
1975 Self::Binary
1976 }
1977}
1978
1979impl Collation {
1980 /// Wire tag persisted in the FILE_VERSION 34+ catalog appendix.
1981 /// Stable: future variants append above the recognised range
1982 /// and unknown tags read back as `Binary` for forward-compat
1983 /// on rollback.
1984 pub const TAG_BINARY: u8 = 0;
1985 pub const TAG_CASE_INSENSITIVE: u8 = 1;
1986}
1987
1988/// v7.39 (RLS) — the command a policy applies to. `ALL` is the default and
1989/// covers every command; the others scope the policy to one statement kind.
1990/// Persisted as a single byte in the policy appendix (FILE_VERSION 59+).
1991#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1992pub enum PolicyCmd {
1993 All,
1994 Select,
1995 Insert,
1996 Update,
1997 Delete,
1998}
1999
2000impl PolicyCmd {
2001 /// PG `pg_policy.polcmd` single-char encoding.
2002 #[must_use]
2003 pub const fn as_pg_char(self) -> char {
2004 match self {
2005 Self::All => '*',
2006 Self::Select => 'r',
2007 Self::Insert => 'a',
2008 Self::Update => 'w',
2009 Self::Delete => 'd',
2010 }
2011 }
2012
2013 /// PG `pg_policies.cmd` word form.
2014 #[must_use]
2015 pub const fn as_pg_word(self) -> &'static str {
2016 match self {
2017 Self::All => "ALL",
2018 Self::Select => "SELECT",
2019 Self::Insert => "INSERT",
2020 Self::Update => "UPDATE",
2021 Self::Delete => "DELETE",
2022 }
2023 }
2024
2025 #[must_use]
2026 pub const fn to_wire_byte(self) -> u8 {
2027 match self {
2028 Self::All => 0,
2029 Self::Select => 1,
2030 Self::Insert => 2,
2031 Self::Update => 3,
2032 Self::Delete => 4,
2033 }
2034 }
2035
2036 #[must_use]
2037 pub const fn from_wire_byte(b: u8) -> Option<Self> {
2038 match b {
2039 0 => Some(Self::All),
2040 1 => Some(Self::Select),
2041 2 => Some(Self::Insert),
2042 3 => Some(Self::Update),
2043 4 => Some(Self::Delete),
2044 _ => None,
2045 }
2046 }
2047}
2048
2049/// v7.39 (RLS) — one `CREATE POLICY` object, stored per table. The `using_expr`
2050/// / `with_check_expr` hold the qualifying expression's `Display` form
2051/// (re-parsed and evaluated per row at enforcement time, exactly like
2052/// `TableSchema.checks`); `None` means the clause was absent. `roles` empty =
2053/// PUBLIC. Persisted in the policy appendix (FILE_VERSION 59+).
2054#[derive(Debug, Clone, PartialEq)]
2055pub struct PolicyDef {
2056 pub name: String,
2057 pub cmd: PolicyCmd,
2058 /// `true` = PERMISSIVE (default, OR-combined), `false` = RESTRICTIVE
2059 /// (AND-combined).
2060 pub permissive: bool,
2061 pub roles: Vec<String>,
2062 pub using_expr: Option<String>,
2063 pub with_check_expr: Option<String>,
2064}
2065
2066#[derive(Debug, Clone, PartialEq)]
2067pub struct TableSchema {
2068 pub name: String,
2069 pub columns: Vec<ColumnSchema>,
2070 /// v6.7.2 — per-table hot-tier byte budget override. `None`
2071 /// falls through to the global `SPG_HOT_TIER_BYTES` setting;
2072 /// `Some(n)` overrides it for this specific table. Set via
2073 /// `ALTER TABLE t SET hot_tier_bytes = X`. Persisted in
2074 /// catalog FILE_VERSION 11+.
2075 pub hot_tier_bytes: Option<u64>,
2076 /// v7.6.1 — FOREIGN KEY constraints declared on this table.
2077 /// Engine maintains this in lock-step with `spg-sql`'s parser
2078 /// AST; the storage layer carries the on-disk shape so a
2079 /// catalog snapshot round-trips without external mapping.
2080 /// Persisted in catalog FILE_VERSION 13+. Older catalogs
2081 /// deserialise with an empty vec.
2082 pub foreign_keys: Vec<ForeignKeyConstraint>,
2083 /// v7.9.19 — composite UNIQUE / PRIMARY KEY constraints
2084 /// declared at the table level. Each entry's leading column
2085 /// has a BTree index (created via the constraint), and INSERT
2086 /// path enforces the full-tuple uniqueness via a scan keyed
2087 /// by the leading column. Persisted in catalog FILE_VERSION
2088 /// 15+. Older catalogs (≤ 14) deserialise with an empty vec.
2089 pub uniqueness_constraints: Vec<UniquenessConstraint>,
2090 /// v7.39 (round 210) — `EXCLUDE` constraints declared at the table level.
2091 /// Enforced on INSERT/UPDATE by a full live-row scan re-checking each
2092 /// element's operator (no equality index can answer overlap). Persisted
2093 /// in catalog FILE_VERSION 72+; older catalogs deserialise with an empty
2094 /// vec.
2095 pub exclusion_constraints: Vec<ExclusionConstraint>,
2096 /// v7.13.0 — `CHECK (<expr>)` predicates declared on this
2097 /// table. Both column-level inline `CHECK (…)` and
2098 /// table-level `CHECK (…)` fold into this list. Each entry
2099 /// is the AST Expr's `Display` form, re-parsed on every
2100 /// INSERT/UPDATE and evaluated against the candidate row.
2101 /// A false / NULL result rejects the mutation (PG semantics).
2102 /// Persisted in catalog FILE_VERSION 23+. Older catalogs
2103 /// deserialise with an empty vec. v7.39 (read01 round 48) — each entry
2104 /// now carries the user's constraint name too (FILE_VERSION 60+).
2105 pub checks: Vec<CheckConstraint>,
2106 /// v7.37.6-B — declarative partition role(sentori Epic 2 P0).
2107 /// `None` = 普通表(后向兼容,< v49 catalog 默认 None)。
2108 /// `Some(Parent { … })` = `CREATE TABLE p (...) PARTITION BY RANGE (key_col)` 父表 —
2109 /// 父表自己 `rows` 永远空,INSERT 在引擎层路由到命中的 child。
2110 /// `Some(Range { … })` = `CREATE TABLE c PARTITION OF p FOR VALUES FROM (a) TO (b)` 范围子表。
2111 /// `Some(Default { … })` = `CREATE TABLE c PARTITION OF p DEFAULT` 兜底子表。
2112 /// 持久化于 FILE_VERSION 49+。
2113 pub partition_role: Option<PartitionRole>,
2114 /// v7.39 (RLS) — `CREATE POLICY` objects on this table, independent of the
2115 /// `row_security` flag (PG stores policies even on non-RLS tables; they
2116 /// only take effect once RLS is enabled). Persisted in the policy appendix
2117 /// (FILE_VERSION 59+). Older catalogs deserialise with an empty vec.
2118 pub policies: Vec<PolicyDef>,
2119 /// v7.39 (RLS) — `ALTER TABLE … ENABLE ROW LEVEL SECURITY`
2120 /// (PG `pg_class.relrowsecurity`). Fresh table = `false`.
2121 pub row_security: bool,
2122 /// v7.39 (RLS) — `ALTER TABLE … FORCE ROW LEVEL SECURITY`
2123 /// (PG `pg_class.relforcerowsecurity`); subjects the table owner to RLS
2124 /// too. Fresh table = `false`.
2125 pub force_row_security: bool,
2126 /// v7.39 (read01 round 57, ACL) — the role that owns this table: whoever
2127 /// ran CREATE TABLE (PG `pg_class.relowner`). The owner holds every
2128 /// privilege implicitly and is the only role that may ALTER / DROP it.
2129 /// `None` = an image written before FILE_VERSION 64, which predates roles
2130 /// entirely; those tables read back as owned by the login role.
2131 pub owner: Option<String>,
2132 /// v7.39 (read01 round 57, ACL) — explicit GRANTs on this table
2133 /// (PG `pg_class.relacl`). EMPTY means "never granted": PG leaves relacl
2134 /// NULL while only the owner's implicit privileges apply, and materialises
2135 /// the whole list — owner's default entry included — on the first GRANT.
2136 /// Once materialised it stays, even after every grant is revoked.
2137 pub acl: Vec<AclItem>,
2138}
2139
2140/// v7.39 (read01 round 57) — one PG `aclitem`: what `grantee` may do to a
2141/// table, and who granted it. Renders as `grantee=privs/grantor`, with an
2142/// EMPTY grantee meaning PUBLIC (`=r/owner`).
2143#[derive(Debug, Clone, PartialEq, Eq)]
2144pub struct AclItem {
2145 /// The role the privileges are held by. Empty string = PUBLIC.
2146 pub grantee: String,
2147 /// Bitmask over `priv_bits`: which privileges are held.
2148 pub privs: u16,
2149 /// Bitmask over `priv_bits`: which of them carry WITH GRANT OPTION
2150 /// (PG renders those with a trailing `*` — `r*`).
2151 pub grantable: u16,
2152 /// The role that ran the GRANT.
2153 pub grantor: String,
2154}
2155
2156/// v7.39 (read01 round 57) — the table-privilege bits, in PG's `aclitem`
2157/// rendering order (`arwdDxtm`). The order matters: `relacl` output is
2158/// byte-compared against PG.
2159pub mod priv_bits {
2160 pub const INSERT: u16 = 1 << 0; // a
2161 pub const SELECT: u16 = 1 << 1; // r
2162 pub const UPDATE: u16 = 1 << 2; // w
2163 pub const DELETE: u16 = 1 << 3; // d
2164 pub const TRUNCATE: u16 = 1 << 4; // D
2165 pub const REFERENCES: u16 = 1 << 5; // x
2166 pub const TRIGGER: u16 = 1 << 6; // t
2167 pub const MAINTAIN: u16 = 1 << 7; // m
2168 /// v7.39 (read01 round 60) — the non-table privileges. They share the
2169 /// bitmask because an aclitem is an aclitem whatever it hangs off; which
2170 /// bits are MEANINGFUL depends on the object (a sequence has r / w / U, a
2171 /// schema has U / C, a database has C / c / T).
2172 pub const USAGE: u16 = 1 << 8; // U
2173 pub const CREATE: u16 = 1 << 9; // C
2174 pub const CONNECT: u16 = 1 << 10; // c
2175 pub const TEMPORARY: u16 = 1 << 11; // T
2176 pub const EXECUTE: u16 = 1 << 12; // X
2177 /// Every TABLE privilege — what `GRANT ALL ON <table>` grants and what a
2178 /// table's owner holds.
2179 pub const ALL: u16 =
2180 INSERT | SELECT | UPDATE | DELETE | TRUNCATE | REFERENCES | TRIGGER | MAINTAIN;
2181 /// `GRANT ALL ON SEQUENCE` — PG renders a sequence owner's default as `rwU`.
2182 pub const ALL_SEQUENCE: u16 = SELECT | UPDATE | USAGE;
2183 /// `GRANT ALL ON SCHEMA` — `UC`.
2184 pub const ALL_SCHEMA: u16 = USAGE | CREATE;
2185 /// `GRANT ALL ON DATABASE` — `CTc`.
2186 pub const ALL_DATABASE: u16 = CREATE | CONNECT | TEMPORARY;
2187 /// `GRANT ALL ON FUNCTION` — just `X`.
2188 pub const ALL_FUNCTION: u16 = EXECUTE;
2189}
2190
2191/// v7.37.6-B — partition 三态(parent / range child / default child)。
2192#[derive(Debug, Clone, PartialEq, Eq)]
2193pub enum PartitionRole {
2194 Parent {
2195 kind: PartitionKind,
2196 /// 父表 columns 中 key 列的下标(单列 v7.37.6-B,
2197 /// `Vec` 为将来扩多列预留)。
2198 key_column_positions: Vec<usize>,
2199 /// `CREATE INDEX ON parent (…)` 的 Display-form 源串。
2200 /// child 创建时再 parse + 在 child 上 execute,这样 future
2201 /// child 也自动继承父表索引。fan-out 实施在引擎层。
2202 index_template_sources: Vec<String>,
2203 },
2204 Range {
2205 parent_name: String,
2206 /// 半开区间下界(`>=`,SQL `FROM (lower)`).
2207 lower: PartitionBound,
2208 /// 半开区间上界(`<`,SQL `TO (upper)`).
2209 upper: PartitionBound,
2210 },
2211 /// v7.37.16 (16.1) — LIST child:行属于本 child iff key ∈ values。
2212 /// `values` 在 child 创建时从 SQL `FOR VALUES IN (lit, …)` 求值;
2213 /// 跟 PG 一样,显式 NULL ∈ values 由 caller 单独处理(不在
2214 /// PartitionBound 内表达 NULL)。
2215 List {
2216 parent_name: String,
2217 values: Vec<PartitionBound>,
2218 },
2219 /// v7.39 (round 645) — PG 表继承的 CHILD:`CREATE TABLE c (…)
2220 /// INHERITS (p1, p2)`。跟分区 child 的三个本质区别(实测 PG18):
2221 /// * 父表**自己有行**(分区父表永远空),所以父表的联合体要含自身;
2222 /// * `INSERT INTO 父表` **不路由**到 child(分区会路由);
2223 /// * `DROP TABLE 父表` 不带 CASCADE **报错**(分区父表连子表一起删)。
2224 /// 多父继承合法,故 `parent_names` 是 Vec;`pg_inherits.inhseqno`
2225 /// 正是父表在这个列表里的位置(1-based)。
2226 Inherits {
2227 parent_names: Vec<String>,
2228 },
2229 /// v7.37.16 (16.2) — HASH child:行属于本 child iff
2230 /// `pg_compatible_hash(key) mod modulus == remainder`。
2231 /// PG 强制 `0 ≤ remainder < modulus`;parser/DDL 层先 gate。
2232 Hash {
2233 parent_name: String,
2234 modulus: u32,
2235 remainder: u32,
2236 },
2237 Default {
2238 parent_name: String,
2239 },
2240}
2241
2242/// v7.37.6-B — 分区策略。
2243///
2244/// - `Range`:半开区间 `[lower, upper)`(v7.37.6-B 初始)
2245/// - `List` (v7.37.16):枚举集合 — 行属于 partition iff key ∈ children list
2246/// - `Hash` (v7.37.16):`hash(key) mod modulus == remainder`
2247#[derive(Debug, Clone, Copy, PartialEq, Eq)]
2248pub enum PartitionKind {
2249 Range,
2250 List,
2251 Hash,
2252}
2253
2254/// v7.37.6-B — partition 边界 literal。
2255///
2256/// v7.37.6-B 仅 `TimestampTz`(i64 microseconds since epoch);
2257/// v7.37.16 (16.6) 加全 PG 内建可比类型,匹配 `Value` 的对应 variant
2258/// 以避免 LIST membership 比较时的类型转换。
2259///
2260/// `MinValue` / `MaxValue` 对应 SQL `MINVALUE` / `MAXVALUE`,仅
2261/// Range 策略有意义(LIST 无 minvalue/maxvalue 概念,HASH 不
2262/// 使用 PartitionBound)。
2263#[derive(Debug, Clone, PartialEq, Eq)]
2264pub enum PartitionBound {
2265 MinValue,
2266 MaxValue,
2267 TimestampTz(i64),
2268 /// v7.37.16 (16.6) — BIGINT partition key.
2269 BigInt(i64),
2270 /// v7.37.16 (16.6) — INTEGER partition key (also covers
2271 /// `SERIAL` since SPG decomposes it to INTEGER + sequence).
2272 Int(i32),
2273 /// v7.37.16 (16.6) — SMALLINT partition key.
2274 SmallInt(i16),
2275 /// v7.37.16 (16.6) — DATE partition key. Stored as days
2276 /// since the Unix epoch (matches `Value::Date`).
2277 Date(i32),
2278 /// v7.37.16 (16.6) — TEXT / VARCHAR partition key.
2279 Text(alloc::string::String),
2280}
2281
2282impl PartitionBound {
2283 /// v7.37.16 (16.6) — true iff this bound's underlying value
2284 /// equals `other`'s. Used for LIST partition membership
2285 /// checks. Returns false for `MinValue` / `MaxValue`
2286 /// (sentinels — never literal equality).
2287 #[must_use]
2288 pub fn equals_value(&self, other: &Value<'_>) -> bool {
2289 match (self, other) {
2290 (PartitionBound::TimestampTz(a), Value::Timestamp(b)) => a == b,
2291 (PartitionBound::BigInt(a), Value::BigInt(b)) => a == b,
2292 (PartitionBound::Int(a), Value::Int(b)) => a == b,
2293 (PartitionBound::SmallInt(a), Value::SmallInt(b)) => a == b,
2294 (PartitionBound::Date(a), Value::Date(b)) => a == b,
2295 (PartitionBound::Text(a), Value::Text(b)) => a.as_str() == b.as_ref(),
2296 _ => false,
2297 }
2298 }
2299}
2300
2301/// v7.9.19 — composite UNIQUE / PRIMARY KEY constraint persisted
2302/// on the table schema. The leading column always has a BTree
2303/// index (created at CREATE TABLE time); INSERT enforcement
2304/// scans that index for collisions on the full column tuple.
2305/// v7.39 (read01 round 48) — a `CHECK` constraint: the SQL name the user
2306/// gave it (via `ADD CONSTRAINT <name> CHECK (...)` or the inline
2307/// `CONSTRAINT <name> CHECK (...)` form) plus the predicate source. `None`
2308/// name = unnamed, in which case `pg_constraint` synthesises PG's
2309/// `<table>_<col>_check` form. Names are persisted in the constraint-name
2310/// appendix (FILE_VERSION 60+); older catalogs deserialise with `None`.
2311#[derive(Debug, Clone, PartialEq, Eq)]
2312pub struct CheckConstraint {
2313 pub name: Option<String>,
2314 /// The AST Expr's `Display` form, re-parsed on every INSERT/UPDATE.
2315 pub expr: String,
2316 /// v7.39 (round 652) — `false` for a constraint added `NOT VALID`: the
2317 /// rows already in the table were never scanned against it, and
2318 /// `pg_constraint.convalidated` says so. It does NOT weaken the check on
2319 /// new rows — INSERT and UPDATE enforce it either way, as in PG.
2320 /// `VALIDATE CONSTRAINT` does the deferred scan and flips it. Persisted
2321 /// by the FILE_VERSION 87 appendix; older catalogs deserialise as `true`,
2322 /// which is what every constraint they could hold actually was.
2323 pub validated: bool,
2324}
2325
2326#[derive(Debug, Clone, PartialEq, Eq)]
2327pub struct UniquenessConstraint {
2328 /// `true` when this constraint was declared as `PRIMARY KEY`
2329 /// (vs `UNIQUE`). Semantically PK implies NOT NULL on all
2330 /// referenced columns; the engine enforces that at CREATE
2331 /// TABLE time.
2332 pub is_primary_key: bool,
2333 /// Column positions on the parent table. ≥ 1 element. For
2334 /// single-column UNIQUE this is exactly one position; the
2335 /// BTree index alone enforces it.
2336 pub columns: Vec<usize>,
2337 /// v7.13.0 — `UNIQUE NULLS NOT DISTINCT` modifier
2338 /// (mailrs round-5 G10; PG 15+ surface). When `true`, two
2339 /// rows whose constrained columns are all NULL collide on
2340 /// the constraint. Default (`false`) is the SQL-standard
2341 /// `NULLS DISTINCT` behaviour where any NULL passes.
2342 /// Persisted in catalog FILE_VERSION 23+.
2343 pub nulls_not_distinct: bool,
2344 /// v7.39 (read01 round 48) — the constraint's SQL name when the user
2345 /// supplied one (`ADD CONSTRAINT <name> PRIMARY KEY/UNIQUE (...)`, or
2346 /// the inline `CONSTRAINT <name>` form). `None` = unnamed, in which
2347 /// case `pg_constraint` synthesises PG's `<table>_pkey` /
2348 /// `<table>_<col>_key` form. DROP CONSTRAINT resolves the stored name
2349 /// first and falls back to the synthesised one, so catalogs written
2350 /// before this field (< FILE_VERSION 60) keep working unchanged.
2351 pub name: Option<String>,
2352 /// v7.39 (round 711) — `[NOT] DEFERRABLE`. Round 621 taught the parser
2353 /// to CONSUME the clause on PK/UNIQUE (the FK path had stored it since
2354 /// round 288); this is the storing half. Persisted in the v89 timing
2355 /// appendix.
2356 pub deferrable: bool,
2357 /// `INITIALLY DEFERRED`: the check belongs to COMMIT, not the
2358 /// statement, unless `SET CONSTRAINTS … IMMEDIATE` pulls it in.
2359 pub initially_deferred: bool,
2360}
2361
2362/// v7.39 (round 210) — an `EXCLUDE` constraint. Forbids two distinct live
2363/// rows from satisfying, for EVERY element, `new.col <op> existing.col`
2364/// (e.g. `EXCLUDE USING gist (during WITH &&)` = no two `during` ranges
2365/// overlap). Unlike a uniqueness constraint the operator is not equality,
2366/// so enforcement is a full live-row scan re-checking the operator (a real
2367/// GiST index that answers overlap in O(log n) is a later perf phase). A
2368/// NULL in any element column exempts the row (matching PG / UNIQUE NULL
2369/// semantics). Persisted in catalog FILE_VERSION 72+.
2370#[derive(Debug, Clone, PartialEq, Eq)]
2371pub struct ExclusionConstraint {
2372 /// The constraint's SQL name. PG auto-names an unnamed EXCLUDE
2373 /// `<table>_<leading-col>_excl`; the engine synthesises that at CREATE
2374 /// TABLE time so this is always populated.
2375 pub name: String,
2376 /// Access method spelled after `USING` (`gist`, `spgist`, …), lower-cased.
2377 /// `None` = no `USING` clause. Purely cosmetic for enforcement; it round-
2378 /// trips into `pg_get_constraintdef`.
2379 pub method: Option<String>,
2380 /// One `(column-position, operator-spelling)` pair per element, in
2381 /// declaration order. The operator spelling is the wire token (`&&`,
2382 /// `=`, `@>`, `<@`, `&<`, `&>`) evaluated against each existing row.
2383 pub elements: Vec<(usize, String)>,
2384}
2385
2386/// v7.6.1 — Storage-layer mirror of `spg_sql::ast::ForeignKeyConstraint`.
2387/// The engine's CREATE TABLE path translates between the two; keeping
2388/// them separate preserves the no-deps boundary between
2389/// `spg-storage` and `spg-sql`.
2390#[derive(Debug, Clone, PartialEq, Eq)]
2391pub struct ForeignKeyConstraint {
2392 /// Optional user-supplied constraint name (`CONSTRAINT <name>`
2393 /// prefix). Used by `ALTER TABLE DROP CONSTRAINT <name>` in
2394 /// v7.6.8; ignored by enforcement.
2395 pub name: Option<String>,
2396 /// Positions of local columns in this table's column list.
2397 /// Same arity as `parent_columns`.
2398 pub local_columns: Vec<usize>,
2399 /// Referenced parent table name.
2400 pub parent_table: String,
2401 /// Positions of parent columns in the parent's column list.
2402 /// Engine resolves these at CREATE TABLE time (after the parent
2403 /// schema is known) so enforcement paths can skip the name
2404 /// lookup on every row.
2405 pub parent_columns: Vec<usize>,
2406 /// Referential action when a parent row is deleted.
2407 pub on_delete: FkAction,
2408 /// Referential action when a parent row's referenced columns
2409 /// are updated.
2410 pub on_update: FkAction,
2411 /// v7.38 (read01, T29) — `MATCH SIMPLE | FULL`. Defaults to `Simple`.
2412 pub match_type: MatchType,
2413 /// v7.39 (round 288) — `[NOT] DEFERRABLE`.
2414 pub deferrable: bool,
2415 /// `INITIALLY DEFERRED`: the check runs at COMMIT rather than at
2416 /// the statement, unless `SET CONSTRAINTS … IMMEDIATE` pulls it in.
2417 pub initially_deferred: bool,
2418}
2419
2420/// v7.38 (read01, T29) — FK MATCH type. Mirrors `spg_sql::ast::MatchType`.
2421#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
2422pub enum MatchType {
2423 #[default]
2424 Simple,
2425 Full,
2426}
2427
2428impl MatchType {
2429 /// On-disk tag byte (catalog appendix, `FILE_VERSION` 55+).
2430 pub const fn tag(self) -> u8 {
2431 match self {
2432 Self::Simple => 0,
2433 Self::Full => 1,
2434 }
2435 }
2436 pub const fn from_tag(b: u8) -> Option<Self> {
2437 Some(match b {
2438 0 => Self::Simple,
2439 1 => Self::Full,
2440 _ => return None,
2441 })
2442 }
2443}
2444
2445/// v7.6.1 — referential action tag. Mirrors `spg_sql::ast::FkAction`.
2446#[derive(Debug, Clone, Copy, PartialEq, Eq)]
2447pub enum FkAction {
2448 Restrict,
2449 Cascade,
2450 SetNull,
2451 SetDefault,
2452 NoAction,
2453}
2454
2455impl FkAction {
2456 /// On-disk tag byte (v13 catalog appendix).
2457 pub const fn tag(self) -> u8 {
2458 match self {
2459 Self::Restrict => 0,
2460 Self::Cascade => 1,
2461 Self::SetNull => 2,
2462 Self::SetDefault => 3,
2463 Self::NoAction => 4,
2464 }
2465 }
2466 pub const fn from_tag(b: u8) -> Option<Self> {
2467 Some(match b {
2468 0 => Self::Restrict,
2469 1 => Self::Cascade,
2470 2 => Self::SetNull,
2471 3 => Self::SetDefault,
2472 4 => Self::NoAction,
2473 _ => return None,
2474 })
2475 }
2476}
2477
2478impl TableSchema {
2479 pub fn column_position(&self, name: &str) -> Option<usize> {
2480 self.columns.iter().position(|c| c.name == name)
2481 }
2482}
2483
2484/// Key type accepted by secondary indices. Float / NULL / Vector values
2485/// can't participate in a B-tree index — `f64` is only `PartialOrd`, NULL
2486/// has SQL-three-valued semantics, and Vector belongs to the (future) HNSW
2487/// path. Index lookups on those columns fall back to full scan.
2488#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
2489pub enum IndexKey {
2490 Int(i64),
2491 Text(String),
2492 Bool(bool),
2493 /// v7.17.0 — `Value::Uuid` index key. Comparison is byte-wise
2494 /// (RFC 4122 byte order) so PRIMARY KEY UUID lookups land on
2495 /// the same fast-path as Int / Text.
2496 Uuid([u8; 16]),
2497 /// r1039 — `Value::Bytes` (bytea). PG orders bytea by plain byte
2498 /// comparison, shorter-prefix first (`'' < \x00 < \x0000 < \x01ff <
2499 /// \xff`, measured on 18.4), which is exactly `Vec<u8>`'s `Ord`.
2500 Bytes(Vec<u8>),
2501 /// r1039 — exact decimal, in the canonical form described on
2502 /// [`NumericKey`].
2503 ///
2504 /// r1040 — BOXED, and the box is load-bearing for every OTHER index.
2505 /// A `NumericKey` is 48 bytes against `Text(String)`'s 24, so inline
2506 /// it set the size of the whole enum and every B-tree node in every
2507 /// index grew with it: 32 bytes per key to 48, align 8 to 16.
2508 /// Measured through the release sweep, `SELECT pad FROM t ORDER BY
2509 /// id` over 400,000 rows — a walk of the primary key's index — went
2510 /// 39.4-40.6 ms to 42.3-44.1, in both leg orders. The indirection is
2511 /// charged to numeric keys, which are new, instead of to every index
2512 /// that existed already.
2513 Numeric(alloc::boxed::Box<NumericKey>),
2514 /// v7.38.1 (L12) — a NULL component INSIDE a composite key, and
2515 /// nothing else. `IndexKey::from_value(Value::Null)` still returns
2516 /// `None`, so single-column B-trees never hold one, and no probe
2517 /// path ever BUILDS one (`col = NULL` is not a match in SQL) — the
2518 /// variant is only reachable through a composite key's component
2519 /// list, where it exists so that a row like `(2, 3, NULL)` stays
2520 /// findable by a PREFIX probe on `(w, d)`. Declared last: slice
2521 /// `Ord` then sorts NULL components after every value, PG's
2522 /// NULLS LAST.
2523 Null,
2524}
2525
2526/// r1039 — an exact-decimal index key, canonical so that representation
2527/// equality IS value equality.
2528///
2529/// That property is the whole reason this is a struct rather than the
2530/// `(scaled, scale)` pair the value carries. `1.5` and `1.50` are the
2531/// same NUMERIC (PG18.4: `1.5::numeric = 1.50::numeric` is true) and
2532/// arrive here as `(15, 1)` and `(150, 2)`. A B-tree keyed on the raw
2533/// pair would file them apart, so `WHERE n = 1.5` would miss a row stored
2534/// as `1.50` — an index changing the answer, which is the one thing an
2535/// index may never do. `BigNumeric::cmp` carries the same warning and
2536/// declines to implement `Ord` for exactly this reason; a KEY cannot
2537/// decline, so it normalizes instead.
2538///
2539/// Canonical form: significant decimal digits with no leading and no
2540/// trailing zeros, most significant first, plus the decimal exponent of
2541/// the leading digit. Zero is the empty digit vector with `neg == false`
2542/// and `exp == 0`, so there is no `-0`.
2543///
2544/// Ordering is PG's, measured: `-Infinity < -1 < 0 < 1 < Infinity < NaN`,
2545/// and `NaN = NaN`.
2546#[derive(Debug, Clone, PartialEq, Eq)]
2547pub struct NumericKey {
2548 /// 0 = -Infinity, 1 = finite, 2 = +Infinity, 3 = NaN. Ordering the
2549 /// classes by this byte is what puts NaN on top, where PG keeps it.
2550 class: u8,
2551 /// Finite only, and never set for zero.
2552 neg: bool,
2553 /// Decimal exponent of the leading significant digit; 0 for zero.
2554 exp: i32,
2555 /// r1040 — the first [`HEAD_DIGITS`] significant digits, LEFT-ALIGNED
2556 /// (multiplied up so the leading digit always sits at 10^36). That
2557 /// alignment is what makes an integer comparison of two heads the same
2558 /// answer as a digit-by-digit one: `12` and `1` become 1.2e36 and
2559 /// 1.0e36, which order the way the digit strings do, where the bare
2560 /// integers 12 and 1 would not.
2561 ///
2562 /// Zero for the value zero and for every special.
2563 ///
2564 /// This started as a `Vec<u8>` of digits, which is correct and cost
2565 /// an allocation per key and a slice comparison per sort comparison.
2566 /// `ORDER BY <numeric>` builds one key per row and compares n log n
2567 /// times: 200,000 rows measured 65.4 ms against 39.6 for the f64
2568 /// projection that had been returning rows in the wrong order.
2569 head: u128,
2570 /// Significant digits past the 37th, one per byte, no trailing zeros.
2571 /// Empty for everything an `i128` mantissa can hold with room to
2572 /// spare — and an empty `Vec` does not allocate, which is the point.
2573 tail: Vec<u8>,
2574}
2575
2576/// Significant digits carried in [`NumericKey::head`]. 37 is the most
2577/// that can be left-aligned inside a `u128`: the largest such value is
2578/// 9.99…e36, and `u128::MAX` is 3.4e38.
2579const HEAD_DIGITS: u32 = 37;
2580/// `10^36` — where a left-aligned leading digit sits.
2581const HEAD_SCALE: u128 = 1_000_000_000_000_000_000_000_000_000_000_000_000;
2582
2583/// The `class` byte of [`NumericKey`], in PG's order.
2584const NUM_CLASS_NEG_INF: u8 = 0;
2585const NUM_CLASS_FINITE: u8 = 1;
2586const NUM_CLASS_POS_INF: u8 = 2;
2587const NUM_CLASS_NAN: u8 = 3;
2588
2589impl NumericKey {
2590 /// The key for a `Value::Numeric`'s three fields.
2591 ///
2592 /// Public because the ORDER BY key wants the same canonical form the
2593 /// index key uses: two sort keys that disagree about which of two
2594 /// NUMERICs is larger is the same class of defect as an index that
2595 /// disagrees with a scan, and one definition is how they stay honest.
2596 #[must_use]
2597 pub fn from_numeric(scaled: i128, scale: u16, kind: NumericKind) -> Self {
2598 match kind {
2599 NumericKind::Finite => {
2600 let mut buf = [0u8; 40];
2601 let n = digits_of_u128(scaled.unsigned_abs(), &mut buf);
2602 Self::finite(scaled < 0, &buf[..n], i32::from(scale))
2603 }
2604 NumericKind::NaN => Self::special(NUM_CLASS_NAN),
2605 NumericKind::PosInf => Self::special(NUM_CLASS_POS_INF),
2606 NumericKind::NegInf => Self::special(NUM_CLASS_NEG_INF),
2607 }
2608 }
2609
2610 /// The key for an exact integer — no scale, so no rounding.
2611 #[must_use]
2612 pub fn from_i128(n: i128) -> Self {
2613 let mut buf = [0u8; 40];
2614 let len = digits_of_u128(n.unsigned_abs(), &mut buf);
2615 Self::finite(n < 0, &buf[..len], 0)
2616 }
2617
2618 /// The key for a mantissa that overflowed `i128`. The two
2619 /// representations of one value land on one key.
2620 #[must_use]
2621 pub fn from_big(b: &crate::bignum::BigNumeric) -> Self {
2622 let (neg, limbs, scale) = b.parts();
2623 Self::finite(neg, &digits_of_limbs(limbs), i32::from(scale))
2624 }
2625
2626 /// The `f64` this key means, for the one comparison PG defines that
2627 /// way: `numeric` against `float8` demotes the numeric.
2628 ///
2629 /// Lossy by construction — that is the point, and it is why nothing
2630 /// else uses it.
2631 #[must_use]
2632 #[allow(clippy::cast_precision_loss)]
2633 pub fn to_f64(&self) -> f64 {
2634 match self.class {
2635 NUM_CLASS_NAN => return f64::NAN,
2636 NUM_CLASS_POS_INF => return f64::INFINITY,
2637 NUM_CLASS_NEG_INF => return f64::NEG_INFINITY,
2638 _ => {}
2639 }
2640 if self.head == 0 {
2641 return 0.0;
2642 }
2643 // `head` is `d.ddd… × 10^36`; the value is that leading digit and
2644 // its followers at `exp`. The tail is below f64's resolution by
2645 // construction (it starts at the 38th significant digit).
2646 let mantissa = self.head as f64 / HEAD_SCALE as f64;
2647 let out = mantissa * pow10_f64(self.exp);
2648 if self.neg { -out } else { out }
2649 }
2650
2651 /// The significant decimal digits, most significant first — the form
2652 /// the catalog codec writes, and the one `from_parts` reads back.
2653 #[must_use]
2654 pub fn digits(&self) -> Vec<u8> {
2655 let mut out = Vec::new();
2656 if self.head != 0 {
2657 let mut h = self.head;
2658 for _ in 0..HEAD_DIGITS {
2659 let d = u8::try_from(h / HEAD_SCALE).unwrap_or(0);
2660 out.push(d);
2661 h = (h % HEAD_SCALE) * 10;
2662 }
2663 while out.last() == Some(&0) {
2664 out.pop();
2665 }
2666 }
2667 out.extend_from_slice(&self.tail);
2668 out
2669 }
2670
2671 /// The wire parts, for the catalog codec.
2672 #[must_use]
2673 pub fn parts(&self) -> (u8, bool, i32) {
2674 (self.class, self.neg, self.exp)
2675 }
2676
2677 /// Rebuild from the wire parts. Returns `None` on parts that are not
2678 /// canonical, so a corrupt catalog cannot smuggle in a key whose `Eq`
2679 /// and `Ord` disagree.
2680 #[must_use]
2681 pub fn from_parts(class: u8, neg: bool, exp: i32, digits: &[u8]) -> Option<Self> {
2682 if class > NUM_CLASS_NAN || digits.iter().any(|d| *d > 9) {
2683 return None;
2684 }
2685 if class != NUM_CLASS_FINITE && (neg || exp != 0 || !digits.is_empty()) {
2686 return None;
2687 }
2688 if digits.is_empty() {
2689 if neg || exp != 0 {
2690 return None;
2691 }
2692 return Some(Self::special(class));
2693 }
2694 if digits[0] == 0 || digits[digits.len() - 1] == 0 {
2695 return None;
2696 }
2697 Some(Self {
2698 class,
2699 neg,
2700 exp,
2701 head: head_of(digits),
2702 tail: digits.iter().skip(HEAD_DIGITS as usize).copied().collect(),
2703 })
2704 }
2705
2706 /// Canonicalize `(-1)^neg · <digits as an integer> · 10^-scale`.
2707 ///
2708 /// `digits` is most-significant-first and may carry leading and
2709 /// trailing zeros; both are stripped, which is what makes `1.5` and
2710 /// `1.50` land on the same key.
2711 fn finite(neg: bool, digits: &[u8], scale: i32) -> Self {
2712 let lead = digits.iter().position(|d| *d != 0).unwrap_or(digits.len());
2713 let digits = &digits[lead..];
2714 if digits.is_empty() {
2715 return Self::special(NUM_CLASS_FINITE);
2716 }
2717 // The leading digit's exponent, taken BEFORE trailing zeros go:
2718 // dropping low-order digits does not move the leading one.
2719 let exp = i32::try_from(digits.len()).unwrap_or(i32::MAX) - 1 - scale;
2720 let mut end = digits.len();
2721 while end > 0 && digits[end - 1] == 0 {
2722 end -= 1;
2723 }
2724 let digits = &digits[..end];
2725 Self {
2726 class: NUM_CLASS_FINITE,
2727 neg,
2728 exp,
2729 head: head_of(digits),
2730 tail: digits.iter().skip(HEAD_DIGITS as usize).copied().collect(),
2731 }
2732 }
2733
2734 fn special(class: u8) -> Self {
2735 Self {
2736 class,
2737 neg: false,
2738 exp: 0,
2739 head: 0,
2740 tail: Vec::new(),
2741 }
2742 }
2743}
2744
2745/// The first [`HEAD_DIGITS`] of `digits`, left-aligned so the leading one
2746/// sits at `10^36`.
2747fn head_of(digits: &[u8]) -> u128 {
2748 let mut head: u128 = 0;
2749 let take = (HEAD_DIGITS as usize).min(digits.len());
2750 for d in &digits[..take] {
2751 head = head * 10 + u128::from(*d);
2752 }
2753 for _ in take..HEAD_DIGITS as usize {
2754 head *= 10;
2755 }
2756 head
2757}
2758
2759/// Decimal digits of `mag` into `buf`, most significant first; returns how
2760/// many were written. Zero writes none.
2761///
2762/// r1040 — split at `u64` on purpose. A `u128` divide is a called routine,
2763/// not an instruction, and this loop runs once per digit per key.
2764fn digits_of_u128(mag: u128, buf: &mut [u8; 40]) -> usize {
2765 if mag == 0 {
2766 return 0;
2767 }
2768 let mut rev = [0u8; 40];
2769 let mut n = 0usize;
2770 let mut big = mag;
2771 // Peel nineteen digits at a time — the most a `u64` holds — so the
2772 // wide divide runs at most twice.
2773 while big > u128::from(u64::MAX) {
2774 let mut chunk = u64::try_from(big % 10_000_000_000_000_000_000_u128).unwrap_or(0);
2775 big /= 10_000_000_000_000_000_000_u128;
2776 for _ in 0..19 {
2777 rev[n] = u8::try_from(chunk % 10).unwrap_or(0);
2778 chunk /= 10;
2779 n += 1;
2780 }
2781 }
2782 let mut small = u64::try_from(big).unwrap_or(0);
2783 while small > 0 {
2784 rev[n] = u8::try_from(small % 10).unwrap_or(0);
2785 small /= 10;
2786 n += 1;
2787 }
2788 for i in 0..n {
2789 buf[i] = rev[n - 1 - i];
2790 }
2791 n
2792}
2793
2794/// Decimal digits of a base-10^9 little-endian limb vector, most
2795/// significant first. Every limb but the leading one is padded to its
2796/// full nine digits — that padding is the whole point, since a limb of 5
2797/// in the middle of a number means `000000005`.
2798fn digits_of_limbs(limbs: &[u32]) -> Vec<u8> {
2799 let mut out = Vec::new();
2800 let mut buf = [0u8; 40];
2801 for (i, limb) in limbs.iter().enumerate().rev() {
2802 let n = digits_of_u128(u128::from(*limb), &mut buf);
2803 if i + 1 == limbs.len() {
2804 out.extend_from_slice(&buf[..n]);
2805 } else {
2806 out.extend(core::iter::repeat_n(0u8, 9 - n));
2807 out.extend_from_slice(&buf[..n]);
2808 }
2809 }
2810 out
2811}
2812
2813/// `10^e` as an `f64`, for any `e` a canonical key can carry.
2814#[allow(clippy::cast_precision_loss)]
2815fn pow10_f64(e: i32) -> f64 {
2816 let mut out = 1.0_f64;
2817 let mag = e.unsigned_abs();
2818 for _ in 0..mag {
2819 out *= 10.0;
2820 }
2821 if e < 0 { 1.0 / out } else { out }
2822}
2823
2824impl Ord for NumericKey {
2825 fn cmp(&self, other: &Self) -> core::cmp::Ordering {
2826 use core::cmp::Ordering;
2827 if self.class != other.class {
2828 return self.class.cmp(&other.class);
2829 }
2830 if self.class != NUM_CLASS_FINITE {
2831 // Each of the three specials is a single value, and PG holds
2832 // `'NaN'::numeric = 'NaN'::numeric` true.
2833 return Ordering::Equal;
2834 }
2835 // Zero first: it is stored with `neg == false` and `exp == 0`, so
2836 // the magnitude comparison below would put it above every value
2837 // smaller than 1 rather than between the negatives and positives.
2838 match (self.head == 0, other.head == 0) {
2839 (true, true) => return Ordering::Equal,
2840 (true, false) => {
2841 return if other.neg {
2842 Ordering::Greater
2843 } else {
2844 Ordering::Less
2845 };
2846 }
2847 (false, true) => {
2848 return if self.neg {
2849 Ordering::Less
2850 } else {
2851 Ordering::Greater
2852 };
2853 }
2854 (false, false) => {}
2855 }
2856 match (self.neg, other.neg) {
2857 (false, true) => return Ordering::Greater,
2858 (true, false) => return Ordering::Less,
2859 _ => {}
2860 }
2861 // Same sign, both non-zero: more integer digits is bigger, and at
2862 // equal exponent the left-aligned heads compare as one integer —
2863 // the alignment is what makes that the same answer as comparing
2864 // the digit strings. The tail only speaks when the first 37
2865 // significant digits are identical.
2866 let mag = self
2867 .exp
2868 .cmp(&other.exp)
2869 .then_with(|| self.head.cmp(&other.head))
2870 .then_with(|| self.tail.cmp(&other.tail));
2871 if self.neg { mag.reverse() } else { mag }
2872 }
2873}
2874
2875impl PartialOrd for NumericKey {
2876 fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
2877 Some(self.cmp(other))
2878 }
2879}
2880
2881impl IndexKey {
2882 /// v7.37.43 (INSUBQ B-4) — inline-friendly BigInt fast path.
2883 /// `try_count_star_pk_in_subquery_fast` (and any other hot loop
2884 /// probing an integer PK) already holds an `i64`; this builds the
2885 /// `IndexKey` without going through the generic `from_value`
2886 /// dispatch tree.
2887 #[inline]
2888 pub fn from_i64(n: i64) -> Self {
2889 Self::Int(n)
2890 }
2891
2892 /// r1039 — the key a value takes when the INDEXED COLUMN is `ty`, or
2893 /// `None` when it takes none (→ the caller falls back to a scan).
2894 ///
2895 /// Every key under one index comes from one column, so they all live
2896 /// in one key SPACE. A probe built in a different space finds nothing
2897 /// — and "nothing" is indistinguishable from "no matching rows",
2898 /// which is how round 564 and r1037 both turned an index into a wrong
2899 /// answer (a TEXT key sought against a DATE-keyed and a UUID-keyed
2900 /// index).
2901 ///
2902 /// The two spaces this round adds make that trap reachable again from
2903 /// a new direction: `WHERE n = 2` on a NUMERIC column produces
2904 /// `Value::Int`, and an integer key would look in a space nothing
2905 /// lives in. So NUMERIC columns take integers by converting them
2906 /// exactly, and refuse anything they cannot convert; BYTEA columns
2907 /// take only `Value::Bytes`; and no other column may be keyed in
2908 /// either of the two new spaces.
2909 ///
2910 /// Use this wherever the key comes from a LITERAL or from another
2911 /// table's value. [`IndexKey::from_value`] stays right for building
2912 /// the index itself, where the value is the column's own.
2913 pub fn from_value_for_column(v: &Value<'_>, ty: DataType) -> Option<Self> {
2914 match ty {
2915 DataType::Numeric { .. } => match v {
2916 Value::SmallInt(n) => Some(Self::exact_int_key(i128::from(*n))),
2917 Value::Int(n) => Some(Self::exact_int_key(i128::from(*n))),
2918 Value::BigInt(n) => Some(Self::exact_int_key(i128::from(*n))),
2919 Value::Numeric { .. } | Value::NumericBig(_) => Self::from_value(v),
2920 // Float included: `2.0::float8` and `2.0::numeric` are not
2921 // the same value to a B-tree, and rounding one into the
2922 // other's space is how a seek reaches the wrong row.
2923 _ => None,
2924 },
2925 DataType::Bytes => match v {
2926 Value::Bytes(b) => Some(Self::Bytes(b.to_vec())),
2927 _ => None,
2928 },
2929 _ => match Self::from_value(v) {
2930 Some(Self::Numeric(_) | Self::Bytes(_)) => None,
2931 other => other,
2932 },
2933 }
2934 }
2935
2936 /// An integer as a NUMERIC key. Exact by construction — no scale, no
2937 /// rounding — which is why the conversion is allowed at all.
2938 fn exact_int_key(n: i128) -> Self {
2939 Self::Numeric(alloc::boxed::Box::new(NumericKey::from_i128(n)))
2940 }
2941
2942 pub fn from_value(v: &Value<'_>) -> Option<Self> {
2943 match v {
2944 // v7.37.43 (INSUBQ B-4) — BigInt hits first (the dominant
2945 // INSUBQ shape probes PK as BigInt). Tiny micro-win.
2946 Value::BigInt(n) => Some(Self::Int(*n)),
2947 Value::SmallInt(n) => Some(Self::Int(i64::from(*n))),
2948 Value::Int(n) => Some(Self::Int(i64::from(*n))),
2949 Value::Text(s) => Some(Self::Text(s.clone().into_owned())),
2950 // v7.38 (read01, T11) — bpchar keys compare blank-insensitively.
2951 Value::BpChar(s) => Some(Self::Text(s.trim_end_matches(' ').to_string())),
2952 Value::Bool(b) => Some(Self::Bool(*b)),
2953 // Date/Timestamp use their integer storage repr as the
2954 // index key — same order semantics, same comparison.
2955 Value::Date(d) => Some(Self::Int(i64::from(*d))),
2956 Value::Timestamp(t) => Some(Self::Int(*t)),
2957 // v7.17.0: UUID indexable via byte-wise ordering. Lookup
2958 // on `id = '...'::uuid` resolves through the secondary
2959 // index rather than full-scan.
2960 Value::Uuid(b) => Some(Self::Uuid(*b)),
2961 // v7.17.0 Phase 3.P0-32: TIME indexable via i64 — same
2962 // order semantics as Date/Timestamp.
2963 Value::Time(us) => Some(Self::Int(*us)),
2964 // v7.17.0 Phase 3.P0-33: YEAR indexable as i64 — u16
2965 // widens losslessly and gives the natural calendar
2966 // ordering.
2967 Value::Year(y) => Some(Self::Int(i64::from(*y))),
2968 // v7.17.0 Phase 3.P0-34: TIMETZ indexable by its
2969 // UTC-equivalent microseconds (local wall - offset).
2970 // Without normalising, two values for the same
2971 // physical instant in different zones would sort
2972 // wrong. Matches PG's TIMETZ index behaviour.
2973 Value::TimeTz { us, offset_secs } => {
2974 Some(Self::Int(us - i64::from(*offset_secs) * 1_000_000))
2975 }
2976 // v7.17.0 Phase 3.P0-35: MONEY indexable as i64 cents
2977 // (no scaling needed — natural numeric ordering).
2978 Value::Money(c) => Some(Self::Int(*c)),
2979 // v7.17.0 Phase 3.P0-38: ranges are NOT indexable in
2980 // v7.17.0 — they'd need a custom comparator (PG uses
2981 // SP-GiST for this). Skip.
2982 Value::Range { .. } => None,
2983 // v7.17.0 Phase 3.P0-39: hstore is NOT indexable in
2984 // v7.17.0 — map columns need GIN with bespoke ops.
2985 Value::Hstore(_) => None,
2986 // r1039 — exact decimals index through the canonical
2987 // [`NumericKey`], which is what makes `1.5` and `1.50` one key.
2988 Value::NumericBig(b) => Some(Self::Numeric(alloc::boxed::Box::new(NumericKey::from_big(b)))),
2989 Value::Numeric {
2990 scaled,
2991 scale,
2992 kind,
2993 } => Some(Self::Numeric(alloc::boxed::Box::new(
2994 NumericKey::from_numeric(*scaled, *scale, *kind),
2995 ))),
2996 // r1039 — bytea orders by plain byte comparison, which is
2997 // `Vec<u8>`'s own.
2998 Value::Bytes(b) => Some(Self::Bytes(b.to_vec())),
2999 // v7.17.0 Phase 3.P0-40: 2D arrays aren't indexable.
3000 Value::IntArray2D(_)
3001 | Value::BigIntArray2D(_)
3002 | Value::TextArray2D(_)
3003 | Value::BoolArray2D(_) => None,
3004 // v7.37.5 β-P4: INTERVAL[] isn't indexable (PG uses
3005 // GIN/intarray for array-contains queries; SPG plans
3006 // that as a separate axis under v7.37.8 GIN-on-jsonb).
3007 Value::IntervalArray(_) => None,
3008 // v7.37.5 γ — none of the array-of-scalar family is
3009 // B-tree indexable. Same reason as IntervalArray: PG
3010 // serves array-contains / array-overlap queries via
3011 // GIN, and SPG's GIN axis lands in v7.37.8.
3012 Value::BoolArray(_)
3013 | Value::SmallIntArray(_)
3014 | Value::FloatArray(_)
3015 | Value::NumericArray(_)
3016 | Value::DateArray(_)
3017 | Value::TimestampArray(_)
3018 | Value::TimestamptzArray(_)
3019 | Value::UuidArray(_)
3020 | Value::JsonArray(_)
3021 | Value::JsonbArray(_)
3022 | Value::BytesArray(_)
3023 | Value::VarcharArray(_)
3024 | Value::CharArray(_)
3025 // v7.37.5 δ — multirange not indexable (PG uses GiST/
3026 // SP-GiST + a custom operator class; SPG plans the same
3027 // axis under v7.37.8 with ranges).
3028 | Value::Multirange { .. }
3029 // v7.37.5 ε — geometric scalars not B-tree indexable
3030 // (PG uses GiST/SP-GiST for these too; SPG plans the
3031 // same axis under v7.37.8).
3032 | Value::Point(_)
3033 | Value::Lseg(_, _)
3034 | Value::Path { .. }
3035 | Value::PgBox(_, _)
3036 | Value::Polygon(_)
3037 | Value::Line { .. }
3038 | Value::Circle { .. }
3039 // v7.37.5 ζ-A — network / bit / xml / "char" / money[].
3040 // INET / CIDR / MACADDR / MACADDR8 could be B-tree
3041 // indexable (PG does this), but the byte-wise compare
3042 // family-blind would mis-order IPv4 vs IPv6; left as
3043 // a follow-up under v7.37.8 GIN window.
3044 | Value::Inet { .. }
3045 | Value::Cidr { .. }
3046 | Value::Macaddr(_)
3047 | Value::Macaddr8(_)
3048 | Value::PgLsn(_)
3049 | Value::BitString { .. }
3050 | Value::Xml(_)
3051 | Value::Char1(_)
3052 | Value::MoneyArray(_)
3053 | Value::Composite(_)
3054 | Value::Tid(..)
3055 | Value::Xid(_)
3056 | Value::Cid(_)
3057 | Value::RegClass(..)
3058 | Value::RegProc(..)
3059 | Value::RegType(..) => None,
3060 // Interval isn't index-eligible (and can't reach this path
3061 // through column storage anyway). Float / Real stay out
3062 // because `f64` is only `PartialOrd`.
3063 Value::Null
3064 | Value::Float(_)
3065 | Value::Vector(_)
3066 | Value::Sq8Vector(_)
3067 | Value::HalfVector(_)
3068 | Value::Interval { .. }
3069 | Value::Json(_)
3070 | Value::TextArray(_)
3071 | Value::IntArray(_)
3072 | Value::BigIntArray(_)
3073 | Value::TsVector(_)
3074 | Value::TsQuery(_)
3075 | Value::Real(_) => None,
3076 }
3077 }
3078}
3079
3080/// A single-column secondary index. v2.0 carries either a B-tree map
3081/// (the default — used for equality / range lookups on scalar columns)
3082/// or a navigable-small-world graph (used for kNN over vector
3083/// columns).
3084#[derive(Debug, Clone)]
3085pub struct Index {
3086 pub name: String,
3087 pub column_position: usize,
3088 pub kind: IndexKind,
3089 /// v6.8.0 — column positions of `INCLUDE (col1, col2, …)`
3090 /// non-key columns. Carries the planner's "this query is
3091 /// covered by the index" signal; lookup paths still resolve
3092 /// via the `RowLocator` to fetch the row body, but EXPLAIN
3093 /// surfaces the covered-scan annotation so operators can
3094 /// confirm the planner sees the coverage.
3095 ///
3096 /// Empty `Vec` = no `INCLUDE` clause (the legacy shape). v12
3097 /// catalog snapshots deserialise with an empty vec.
3098 pub included_columns: Vec<usize>,
3099 /// v6.8.1 — partial-index predicate stored as its canonical
3100 /// Display form (the engine re-parses it on the maintenance
3101 /// path). `None` = unconditional index (the legacy shape).
3102 /// Persisted as `[u8 has_pred][u16 LE len][bytes]` on the
3103 /// catalog snapshot (FILE_VERSION 12, appended after
3104 /// `included_columns`).
3105 pub partial_predicate: Option<String>,
3106 /// v6.8.2 — expression-index key, stored as the expression's
3107 /// canonical Display form. `None` = bare column-reference
3108 /// index (the legacy shape). Persisted alongside
3109 /// `partial_predicate` on the v12 catalog snapshot.
3110 pub expression: Option<String>,
3111 /// v7.39 (read01 round 52) — `CREATE UNIQUE INDEX … NULLS NOT DISTINCT`
3112 /// (PG 15+): a NULL in the key no longer exempts the row, so two
3113 /// all-NULL keys collide. Default `false` = SQL-standard NULLS DISTINCT.
3114 /// Persisted in the index appendix (FILE_VERSION 62+); older catalogs
3115 /// deserialise with `false`.
3116 pub nulls_not_distinct: bool,
3117 /// v7.39 (round 537) — the key column's ordering clause, as written.
3118 ///
3119 /// SPG's index does not scan in a direction, so this changes no
3120 /// lookup; `pg_indexes.indexdef` is a reproduction of the DDL and
3121 /// dropping the clause made `CREATE INDEX i ON t (a DESC NULLS
3122 /// LAST)` read back as `(a)` — a dump lost it and a schema diff saw
3123 /// drift every run. `nulls_first` is `None` when the statement did
3124 /// not say, in which case PG's default applies and neither word is
3125 /// rendered.
3126 pub descending: bool,
3127 pub nulls_first: Option<bool>,
3128 /// v7.39 (round 538) — an explicit `COLLATE` on the key, as written.
3129 /// SPG orders text by bytes, so it changes no comparison; PG prints
3130 /// it because a named collation and an inherited one are different
3131 /// objects even where they sort identically.
3132 pub collation: Option<String>,
3133 /// v7.9.29 — `CREATE UNIQUE INDEX …`. When true the engine
3134 /// rejects INSERTs whose key already appears in this index
3135 /// (combined with `partial_predicate` when present — only
3136 /// rows matching the predicate enter the uniqueness check).
3137 /// Catalog FILE_VERSION 16+; older snapshots deserialise
3138 /// with `false`. mailrs K1.
3139 pub is_unique: bool,
3140 /// v7.9.29 — extra (non-leading) column positions for
3141 /// multi-column indexes (`CREATE INDEX … (a, b, c)`). The
3142 /// planner today still only uses the leading
3143 /// `column_position` for index seeks, but UNIQUE INDEX
3144 /// enforcement walks the full tuple so partial-unique
3145 /// invariants like CalDAV `(calendar_id, uid,
3146 /// recurrence_id)` are enforced correctly. Catalog
3147 /// FILE_VERSION 16+; older snapshots deserialise empty.
3148 pub extra_column_positions: Vec<usize>,
3149}
3150
3151/// Default neighbor degree (M) for the NSW graph. Picked at construction
3152/// time and persisted with the index.
3153pub const NSW_DEFAULT_M: usize = 16;
3154
3155/// v5.2.2: outcome of a successful [`Catalog::freeze_oldest_to_cold`]
3156/// call. The catalog state has already been mutated by the time this
3157/// is returned (hot rows dropped + segment registered + Cold locators
3158/// flipped). The caller's only remaining concern is `segment_bytes` —
3159/// persist them to disk under `<db>.spg/segments/seg_<id>.spg` so a
3160/// future restart can reload via the v5.1 `SPG_PRELOAD_COLD_SEGMENT`
3161/// path. (v5.3's manifest will subsume this manual step.)
3162#[derive(Debug, Clone)]
3163pub struct FreezeReport {
3164 /// Id allocated by [`Catalog::load_segment_bytes`] for the new
3165 /// cold-tier segment. Stable across the call's success path.
3166 pub segment_id: u32,
3167 /// Number of rows that moved hot → cold. Equals the `max_rows`
3168 /// the caller asked for (the API is strict on the count).
3169 pub frozen_rows: usize,
3170 /// Hot-tier bytes reclaimed by the freeze — the
3171 /// [`Table::hot_bytes`] delta before vs after. Useful to feed
3172 /// back into the freezer's budget check on the next tick.
3173 pub bytes_freed: u64,
3174 /// Encoded segment bytes, byte-identical to what
3175 /// [`encode_segment`] produced. The catalog already owns a
3176 /// copy inside `cold_segments`; this hand-off lets the caller
3177 /// persist them without re-encoding.
3178 pub segment_bytes: Vec<u8>,
3179}
3180
3181/// v6.7.4 — read-only output of [`Catalog::prepare_freeze_slice`].
3182/// Carries every row body + key in a contiguous hot-row range,
3183/// already encoded and sorted by PK so the coordinator's merge
3184/// step is a k-way merge over already-sorted streams.
3185///
3186/// `Vec<FreezeSlice>` from N independent workers feeds
3187/// [`Catalog::commit_freeze_slices`], which concats + encodes the
3188/// merged segment + atomically swaps the catalog state.
3189#[derive(Debug, Clone)]
3190pub struct FreezeSlice {
3191 /// Hot-row index range this slice covered (half-open, in the
3192 /// table's `rows: PersistentVec` ordering at call time). The
3193 /// commit step uses this to compute the union range that
3194 /// gets passed to [`Table::delete_rows`].
3195 pub row_range: core::ops::Range<usize>,
3196 /// `(pk_u64, encoded_row_body, IndexKey)` triples, sorted
3197 /// ascending by `pk_u64`. Per-slice sort happens inside
3198 /// `prepare_freeze_slice`; the coordinator does only a
3199 /// k-way merge to reach the global PK ordering
3200 /// [`encode_segment`] requires.
3201 pub rows: Vec<(u64, Vec<u8>, IndexKey)>,
3202}
3203
3204/// v6.7.3 — outcome of a [`Catalog::compact_cold_segments`] call.
3205/// The catalog state has already been mutated when this is returned:
3206/// the merged segment is loaded into `cold_segments`, the source
3207/// segment slots are tombstoned (`None`), and every BTree-index
3208/// `RowLocator::Cold` that previously pointed at a source now
3209/// points at the merged segment. The caller's remaining job is to
3210/// persist `merged_segment_bytes` under
3211/// `<db>.spg/segments/seg_<merged_segment_id>.spg` and update the
3212/// in-memory `segment_id → path` map (remove the source ids, add
3213/// the merged id) so the next CHECKPOINT writes a manifest that
3214/// no longer lists the retired sources.
3215///
3216/// On a no-op (fewer than 2 candidate segments under the threshold),
3217/// `merged_segment_id` is `None` and `sources` is empty; the
3218/// catalog was not mutated.
3219#[derive(Debug, Clone)]
3220pub struct CompactReport {
3221 /// Source segment ids that were merged + tombstoned.
3222 pub sources: Vec<u32>,
3223 /// Id allocated for the merged segment. `None` on no-op.
3224 pub merged_segment_id: Option<u32>,
3225 /// Encoded merged-segment bytes (empty on no-op).
3226 pub merged_segment_bytes: Vec<u8>,
3227 /// Number of rows that landed in the merged segment.
3228 pub merged_rows: usize,
3229 /// `Σ source.num_rows − merged_rows`. Rows present in source
3230 /// segment payloads but unreferenced by any live BTree
3231 /// `Cold` locator — DELETE'd-but-still-frozen rows that
3232 /// compaction GC'd during the merge.
3233 pub deleted_rows_pruned: usize,
3234 /// `Σ source.bytes() − merged.bytes()`. Estimate of on-disk
3235 /// space the merge will reclaim once the source segment files
3236 /// are GC'd. Saturating subtract — never negative.
3237 pub bytes_reclaimed_estimate: u64,
3238}
3239
3240#[derive(Debug, Clone)]
3241pub enum IndexKind {
3242 /// v4.40: structural-sharing B-tree over `IndexKey`. Replaces the v0.8
3243 /// `BTreeMap<IndexKey, Vec<usize>>` — `Index::clone` is now an `Arc`
3244 /// bump regardless of index size, so `Catalog::clone` inside the
3245 /// v4.34 auto-commit wrap stays O(1) even for tables with secondary
3246 /// indices (the case that bottlenecked v4.39 at 1M rows in the
3247 /// sweep).
3248 ///
3249 /// v5.1: value type widened from `Vec<usize>` to `Vec<RowLocator>` so
3250 /// a single key can point to a mix of hot-tier rows (`RowLocator::Hot`,
3251 /// equivalent to the pre-v5 `usize` row index) and cold-tier rows
3252 /// (`RowLocator::Cold { segment_id, page_offset }`) once the v5.2
3253 /// freezer starts producing them. Pre-v5.2 only `Hot` entries appear
3254 /// — the on-disk encoding stays at `FILE_VERSION` 8 (raw u64 row index)
3255 /// because every locator round-trips through `RowLocator::from_legacy_v8_u64`
3256 /// without information loss. `FILE_VERSION` 9 with tagged encoding lands
3257 /// alongside the first freezer commit (v5.1 step 2b / v5.2).
3258 BTree(PersistentBTreeMap<IndexKey, crate::posting::PostingList>),
3259 /// Navigable-small-world graph for vector kNN search.
3260 Nsw(NswGraph),
3261 /// v6.7.1 — BRIN (Block Range INdex). Pure metadata: BRIN
3262 /// indexes carry NO in-memory key→locator map. The (min,
3263 /// max) summaries live in each cold-tier segment's v2
3264 /// envelope sidecar; the BRIN entry in `Table.indices` only
3265 /// records THAT a BRIN index exists on this column so the
3266 /// segment encoder + planner can opt into the summary path.
3267 Brin {
3268 /// The cell type at `column_position` at CREATE INDEX time.
3269 /// Used by the planner to type-check WHERE-clause range
3270 /// predicates against the BRIN-indexed column.
3271 column_type: DataType,
3272 /// v7.38.11 — one `(min, max)` per [`BRIN_RANGE_ROWS`] slots of
3273 /// the hot tier, so a range predicate can skip the ranges that
3274 /// cannot contain a match.
3275 ///
3276 /// Maintenance is WIDEN-ONLY and that is the whole safety
3277 /// argument: an insert widens its range, an update widens, and
3278 /// a delete leaves the range alone. A range left wider than the
3279 /// rows it now covers is correct and merely less selective —
3280 /// which is exactly PG's contract for a lossy index, since the
3281 /// predicate is re-checked on every row the summary lets
3282 /// through. A summary may over-report; it can never
3283 /// under-report, so no matching row can be skipped.
3284 ///
3285 /// `None` for a range whose rows carry no comparable key (all
3286 /// NULL, say), and such a range is never skipped.
3287 summaries: alloc::vec::Vec<Option<(i64, i64)>>,
3288 },
3289 /// v7.12.3 — GIN inverted index over a `tsvector` column.
3290 ///
3291 /// Storage shape: `lexeme word → Vec<RowLocator>`. The posting
3292 /// list per word is appended in row-order, so range scans are
3293 /// O(matching rows) once the per-word lookup is done. Multi-
3294 /// term queries intersect / union posting lists.
3295 ///
3296 /// `IndexKey::from_value(TsVector)` returns `None` — GIN doesn't
3297 /// participate in `try_index_seek` (which is BTree-equality-keyed).
3298 /// The engine consults this index through `try_gin_lookup` on
3299 /// `WHERE col @@ tsquery` predicates instead.
3300 ///
3301 /// Backed by a `PersistentBTreeMap` so `Catalog::clone` (the
3302 /// per-write snapshot) stays O(1) — same structural-sharing
3303 /// invariant as BTree.
3304 Gin(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3305 /// v7.15.0 — `USING gin (col gin_trgm_ops)` over a `TEXT`
3306 /// column. Posting lists map `trigram` (PG-compatible 3-byte
3307 /// shingle on the lower-cased + space-padded input) to row
3308 /// locators. The planner uses this index to accelerate
3309 /// `WHERE col LIKE '…'` / `ILIKE '…'` / `similarity(col, q) >
3310 /// t` — every literal run of length ≥ 1 in the pattern
3311 /// produces a trigram set, the engine intersects the posting
3312 /// lists, and the LIKE / similarity predicate is re-evaluated
3313 /// per candidate row to filter the over-approximation.
3314 /// Persisted via tag-4 index payload in `FILE_VERSION` 24+.
3315 GinTrgm(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3316 /// v7.17.0 Phase 2.2 — MySQL `FULLTEXT KEY (col)` over a
3317 /// `TEXT` / `VARCHAR` column. Posting lists map
3318 /// `tsvector('simple') lexeme` to row locators. At insert /
3319 /// build time the engine derives the lexemes from the cell
3320 /// via the same lower-case tokenisation rule as
3321 /// `to_tsvector('simple', ...)` — the column itself stays a
3322 /// plain text type on disk (mysqldump round-trips would be
3323 /// broken otherwise). The planner uses this index to
3324 /// accelerate MySQL-shape `MATCH(col) AGAINST('term')`
3325 /// queries by mapping them onto the existing tsquery `@@`
3326 /// walker. Persisted via tag-5 index payload in
3327 /// `FILE_VERSION` 33+.
3328 GinFulltext(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3329 /// v7.37.8(sentori Epic 5 P2)— `USING gin (col)` over a
3330 /// `JSON` / `JSONB` column. Posting lists map a canonical
3331 /// `(path, leaf)` token(see [`crate::jsonb_gin::extract_tokens`])
3332 /// to row locators so the planner can resolve
3333 /// `<col> @> <jsonb_literal>` to a candidate row set via
3334 /// posting-list intersection + per-row `json::contains`
3335 /// re-verification. Pre-7.37.8 the same DDL loaded as a
3336 /// BTree fallback so `pg_dump` JSONB-GIN scripts kept loading
3337 /// without query-time acceleration. Persisted via tag-6 index
3338 /// payload in `FILE_VERSION` 51+.
3339 GinJsonb(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3340 /// v7.38.1 (L12) — a REAL multi-column B-tree: the key is the whole
3341 /// column tuple, `[leading, extras…]`, ordered lexicographically by
3342 /// slice `Ord`. That ordering is the entire design: every key
3343 /// sharing a prefix is contiguous, so an equality on a PREFIX of
3344 /// the columns is one `O(log N)` descent plus a bounded walk, and a
3345 /// full-tuple equality is a point `get`. The single-column `BTree`
3346 /// kind used to stand in for multi-column DDL by keying on the
3347 /// leading column only and carrying the rest as metadata — TPC-C's
3348 /// `customer (c_w_id, c_d_id, c_last, c_first)` then answered a
3349 /// three-column equality with every row of one warehouse and a
3350 /// per-row filter over 30 000 candidates.
3351 ///
3352 /// Rows where any component column is NULL (or of an unkeyable
3353 /// type) are NOT entered: this index serves `=` probes, and in SQL
3354 /// `col = v` never selects a NULL. Uniqueness keeps its own
3355 /// full-tuple walk with NULLS-DISTINCT semantics on the
3356 /// enforcement path, exactly as before.
3357 ///
3358 /// Persisted via tag-7 index payload in `FILE_VERSION` 91+.
3359 BTreeMulti(PersistentBTreeMap<alloc::boxed::Box<[IndexKey]>, crate::posting::PostingList>),
3360}
3361
3362impl IndexKind {
3363 /// v7.31 (memory campaign, C2) — bytes this index variant holds
3364 /// resident in RAM, computed by walking its OWN structure rather
3365 /// than a parametric guess made by the engine. Replaces the old
3366 /// `spg_admin::memory_stats` inline match, which charged NSW with
3367 /// a stale `m_max_0 * 8` per node (neighbour slots are `u32` = 4 B
3368 /// since v6.1.x, and most nodes never fill `m_max_0`) and lumped
3369 /// every GIN family index into a flat 1 KiB token — a gross
3370 /// undercount for the text-heavy posting lists that dominate
3371 /// mailrs' footprint. Per-entry container overhead uses the
3372 /// 3-word (24 B on 64-bit) `Vec`/`String` header as the charge.
3373 ///
3374 /// O(index entries): operator/monitoring surface (`memory_stats` /
3375 /// `spg_memory_stats`), not a query path.
3376 #[must_use]
3377 pub fn approx_resident_bytes(&self) -> u64 {
3378 const HEADER: usize = 24; // Vec/String 3-word header on 64-bit.
3379 let loc = core::mem::size_of::<RowLocator>();
3380 match self {
3381 IndexKind::BTree(map) => {
3382 let key = core::mem::size_of::<IndexKey>();
3383 map.iter()
3384 .map(|(_, locs)| (key + HEADER + locs.len() * loc) as u64)
3385 .sum()
3386 }
3387 // v7.38.1 (L12) — multi keys own a boxed slice of components.
3388 IndexKind::BTreeMulti(map) => {
3389 let key = core::mem::size_of::<IndexKey>();
3390 map.iter()
3391 .map(|(k, locs)| (HEADER + k.len() * key + HEADER + locs.len() * loc) as u64)
3392 .sum()
3393 }
3394 IndexKind::Nsw(g) => {
3395 // `levels` is one byte per node; each layer's adjacency
3396 // is a `Vec<u32>` per node whose actual length we walk
3397 // (the dense layer-0 list dominates, but upper layers
3398 // are sparse — the old estimate ignored that).
3399 let mut b = g.levels.len() as u64;
3400 for layer in &g.layers {
3401 for nbrs in layer.iter() {
3402 b += (HEADER + nbrs.len() * core::mem::size_of::<u32>()) as u64;
3403 }
3404 }
3405 b
3406 }
3407 // BRIN carries NO in-memory key→locator map (the (min,max)
3408 // summaries live in cold-segment sidecars on disk); the
3409 // resident footprint is just the column-type token.
3410 IndexKind::Brin { .. } => core::mem::size_of::<DataType>() as u64,
3411 IndexKind::Gin(map)
3412 | IndexKind::GinTrgm(map)
3413 | IndexKind::GinFulltext(map)
3414 | IndexKind::GinJsonb(map) => map
3415 .iter()
3416 .map(|(word, postings)| {
3417 (word.len() + HEADER + HEADER + postings.len() * loc) as u64
3418 })
3419 .sum(),
3420 }
3421 }
3422}
3423
3424/// Multi-layer HNSW graph (v2.13). Each node is assigned a `top_level`;
3425/// it appears in layers `0..=top_level`. Higher layers are sparser, so
3426/// search starts from the entry at the top layer, greedy-descends to
3427/// layer 0, and beam-searches there. Layer 0 keeps a larger neighbour
3428/// budget (`m_max_0 = 2 * m` per the HNSW paper); upper layers cap at
3429/// `m`. The struct name stays `NswGraph` so external users / on-disk
3430/// callers don't have to track a rename — the algorithm changed, the
3431/// data slot didn't.
3432#[derive(Debug, Clone)]
3433pub struct NswGraph {
3434 /// Max neighbours per node on layers ≥ 1.
3435 pub m: usize,
3436 /// Max neighbours on layer 0 (the dense bottom layer). HNSW
3437 /// convention: `m_max_0 = 2 * m`.
3438 pub m_max_0: usize,
3439 /// Entry point — the node that sits on the topmost layer. Search
3440 /// always starts here.
3441 pub entry: Option<usize>,
3442 /// Top layer of the entry node (== `layers.len() - 1` when populated).
3443 pub entry_level: u8,
3444 /// `levels[i]` = top layer of node `i`. Nodes whose vector cell is
3445 /// NULL / non-Vector have `levels[i] = 0` and no neighbour entries.
3446 ///
3447 /// v5.5.0: backed by `PersistentVec` so `NswGraph::clone` (and the
3448 /// `Catalog::clone` on every group-commit write that contains it) is O(1)
3449 /// structural-sharing instead of an O(N) element copy.
3450 pub levels: PersistentVec<u8>,
3451 /// `layers[l][i]` = neighbours of node `i` at layer `l`. Inner vec
3452 /// is empty when node `i` doesn't reach layer `l`.
3453 ///
3454 /// v5.5.0: the per-node middle dimension (the O(N) one) is a
3455 /// `PersistentVec`; the outer layer dimension stays a plain `Vec`
3456 /// (layer count ≤ 8, so its clone is O(1) in practice) and the inner
3457 /// neighbour list stays a `Vec` (bounded by `m_max_0`).
3458 ///
3459 /// v6.1.x: neighbour slot widened from `usize` (8 B on 64-bit) to
3460 /// `u32` (4 B). Row indices are catalog-bounded by `u32::MAX` (4G
3461 /// rows per table); the cast at the NSW boundary asserts this. At
3462 /// 1M dim-128 SQ8, layer 0 adjacency alone shrinks by ~128 MiB
3463 /// — the largest single contribution to the v6.0.5-measured
3464 /// 624 MiB ambition gap. On-disk format already used u32 LE, so
3465 /// this is a pure in-memory layout change; no `FILE_VERSION` bump.
3466 pub layers: Vec<PersistentVec<Vec<u32>>>,
3467}
3468
3469impl NswGraph {
3470 fn new(m: usize) -> Self {
3471 Self {
3472 m,
3473 m_max_0: m.saturating_mul(2),
3474 entry: None,
3475 entry_level: 0,
3476 levels: PersistentVec::new(),
3477 layers: alloc::vec![PersistentVec::new()],
3478 }
3479 }
3480
3481 /// Max-neighbour budget for layer `l`.
3482 pub const fn cap_for_layer(&self, layer: u8) -> usize {
3483 if layer == 0 { self.m_max_0 } else { self.m }
3484 }
3485}
3486
3487/// Deterministic level assignment, seeded on the row index so the same
3488/// insert order reproduces the same topology. Distribution is roughly
3489/// HNSW-flavoured with `mL ≈ 1/ln(M) ≈ 0.36` for M=16: each 4-bit
3490/// chunk that comes up zero promotes the node one layer (so P(level ≥
3491/// L) ≈ (1/16)^L).
3492#[allow(clippy::verbose_bit_mask)] // clippy suggests trailing_zeros(); we need an explicit MAX cap and a stable distribution shape.
3493pub fn nsw_assign_level(row_idx: usize) -> u8 {
3494 const MAX_LEVEL: u8 = 7; // 7 ⇒ ~16^7 ≈ 2.7e8 expected nodes between promotions; ample.
3495 // SplitMix-style mixer — cheap and seedable.
3496 let mut x = (row_idx as u64).wrapping_mul(0x9E37_79B9_7F4A_7C15);
3497 x ^= x >> 30;
3498 x = x.wrapping_mul(0xBF58_476D_1CE4_E5B9);
3499 x ^= x >> 27;
3500 x = x.wrapping_mul(0x94D0_49BB_1331_11EB);
3501 x ^= x >> 31;
3502 // Count contiguous low-end zero nibbles (4-bit chunks). Each zero
3503 // nibble has probability 1/16, mirroring HNSW's `mL ≈ 1/ln(M)` for
3504 // M=16. `trailing_zeros / 4` would lose the ordering when x = 0, so
3505 // a plain loop with a cap is clearer.
3506 let mut level: u8 = 0;
3507 while x & 0xF == 0 && level < MAX_LEVEL {
3508 level += 1;
3509 x >>= 4;
3510 }
3511 level
3512}
3513
3514/// v7.38.1 (L12) — the composite key `values` takes in a multi-column
3515/// B-tree over `[lead, extras…]`. A NULL component keys as
3516/// [`IndexKey::Null`] (declared to sort last, PG's NULLS LAST) so the
3517/// row stays findable by prefix probes on the columns before it. `None`
3518/// = some non-null component has no key form; the row is then not
3519/// entered, which is why creation gates every component column's type
3520/// through [`multi_component_type_ok`].
3521pub(crate) fn compose_multi_key(
3522 values: &[Value<'_>],
3523 lead: usize,
3524 extras: &[usize],
3525) -> Option<alloc::boxed::Box<[IndexKey]>> {
3526 let mut comps: Vec<IndexKey> = Vec::with_capacity(1 + extras.len());
3527 for pos in core::iter::once(lead).chain(extras.iter().copied()) {
3528 let v = values.get(pos)?;
3529 if matches!(v, Value::Null) {
3530 comps.push(IndexKey::Null);
3531 } else {
3532 comps.push(IndexKey::from_value(v)?);
3533 }
3534 }
3535 Some(comps.into_boxed_slice())
3536}
3537
3538/// v7.38.1 (L12) — component-type gate for multi-column B-trees: every
3539/// NON-NULL value of these types keys through `IndexKey::from_value`,
3540/// so a row can only be absent from the index when creation raced a
3541/// type this list does not name. Deliberately conservative — a type
3542/// outside the list simply keeps its index on the leading-column path.
3543pub(crate) fn multi_component_type_ok(ty: DataType) -> bool {
3544 matches!(
3545 ty,
3546 DataType::SmallInt
3547 | DataType::Int
3548 | DataType::BigInt
3549 | DataType::Text
3550 | DataType::Varchar(_)
3551 | DataType::Char(_)
3552 | DataType::Bool
3553 | DataType::Uuid
3554 | DataType::Date
3555 | DataType::Timestamp
3556 )
3557}
3558
3559impl Index {
3560 /// Any key this B-tree currently holds, or `None` if it holds none.
3561 ///
3562 /// A probe built from a query literal has to be the same SHAPE as the
3563 /// keys the maintenance side made, or `lookup_eq` misses every row and
3564 /// the caller reads the empty answer as "no rows match". One stored
3565 /// key settles it: an index keys one expression, whose values are one
3566 /// type.
3567 pub fn sample_key(&self) -> Option<&IndexKey> {
3568 match &self.kind {
3569 IndexKind::BTree(map) => map.iter().next().map(|(k, _)| k),
3570 _ => None,
3571 }
3572 }
3573
3574 /// v7.38.19 — the largest integer key this index holds.
3575 ///
3576 /// For the one question it answers — what number comes next for a
3577 /// `serial` column — a tree already knows, and knew all along.
3578 /// [`Table::next_auto_value`] read every row instead:
3579 ///
3580 /// ```text
3581 /// rows in the table one INSERT PostgreSQL 18
3582 /// 1,000 1.831 ms 1.245
3583 /// 10,000 1.814 1.289
3584 /// 50,000 2.703 1.386
3585 /// 200,000 3.666 1.375
3586 /// ```
3587 ///
3588 /// Theirs is flat because a sequence is a counter. Ours grew with
3589 /// the table, so an ingest workload got slower the longer it ran.
3590 ///
3591 /// A dead row version's key is still in the tree, so this can be
3592 /// HIGHER than the maximum over live rows. That is the safe
3593 /// direction — it hands out a value no row has ever held — and it
3594 /// is the direction PostgreSQL goes too, which never reuses a
3595 /// number a deleted row was given.
3596 ///
3597 /// `None` = no B-tree, or its keys are not integers, and the caller
3598 /// falls back to the scan.
3599 pub fn max_int_key(&self) -> Option<i64> {
3600 let IndexKind::BTree(map) = &self.kind else {
3601 return None;
3602 };
3603 match map.iter_rev().next()? {
3604 (IndexKey::Int(n), _) => Some(*n),
3605 _ => None,
3606 }
3607 }
3608
3609 fn new_btree(name: String, column_position: usize) -> Self {
3610 Self {
3611 name,
3612 column_position,
3613 kind: IndexKind::BTree(PersistentBTreeMap::new()),
3614 included_columns: Vec::new(),
3615 partial_predicate: None,
3616 expression: None,
3617 is_unique: false,
3618 nulls_not_distinct: false,
3619 descending: false,
3620 nulls_first: None,
3621 collation: None,
3622 extra_column_positions: Vec::new(),
3623 }
3624 }
3625
3626 /// v7.38.1 (L12) — a real multi-column B-tree shell. The caller
3627 /// sets `extra_column_positions` before the first row enters; the
3628 /// key arity is `1 + extras` from then on.
3629 fn new_btree_multi(name: String, column_position: usize) -> Self {
3630 Self {
3631 kind: IndexKind::BTreeMulti(PersistentBTreeMap::new()),
3632 ..Self::new_btree(name, column_position)
3633 }
3634 }
3635
3636 /// v7.38.1 (L12) — the composite key this row takes in a
3637 /// [`IndexKind::BTreeMulti`] index. NULL components key as
3638 /// [`IndexKey::Null`] so prefix probes still find the row; `None`
3639 /// only when a non-null component produces no key, which creation's
3640 /// component-type gate makes unreachable for well-formed indexes.
3641 pub fn multi_key_for_row(&self, values: &[Value<'_>]) -> Option<alloc::boxed::Box<[IndexKey]>> {
3642 compose_multi_key(values, self.column_position, &self.extra_column_positions)
3643 }
3644
3645 fn new_nsw(name: String, column_position: usize, m: usize) -> Self {
3646 Self {
3647 name,
3648 column_position,
3649 kind: IndexKind::Nsw(NswGraph::new(m)),
3650 included_columns: Vec::new(),
3651 partial_predicate: None,
3652 expression: None,
3653 is_unique: false,
3654 nulls_not_distinct: false,
3655 descending: false,
3656 nulls_first: None,
3657 collation: None,
3658 extra_column_positions: Vec::new(),
3659 }
3660 }
3661
3662 /// v6.7.1 — BRIN index constructor. BRIN carries no in-memory
3663 /// data; the `column_type` snapshot is used by the segment
3664 /// encoder + planner for type-checking range predicates.
3665 fn new_brin(name: String, column_position: usize, column_type: DataType) -> Self {
3666 Self {
3667 name,
3668 column_position,
3669 kind: IndexKind::Brin {
3670 column_type,
3671 summaries: alloc::vec::Vec::new(),
3672 },
3673 included_columns: Vec::new(),
3674 partial_predicate: None,
3675 expression: None,
3676 is_unique: false,
3677 nulls_not_distinct: false,
3678 descending: false,
3679 nulls_first: None,
3680 collation: None,
3681 extra_column_positions: Vec::new(),
3682 }
3683 }
3684
3685 /// v7.12.3 — GIN inverted-index constructor. Empty posting-list
3686 /// map; caller (typically [`Table::add_gin_index`] or
3687 /// [`Table::restore_gin_index`]) populates it from existing rows
3688 /// or from a deserialised snapshot.
3689 fn new_gin(name: String, column_position: usize) -> Self {
3690 Self {
3691 name,
3692 column_position,
3693 kind: IndexKind::Gin(PersistentBTreeMap::new()),
3694 included_columns: Vec::new(),
3695 partial_predicate: None,
3696 expression: None,
3697 is_unique: false,
3698 nulls_not_distinct: false,
3699 descending: false,
3700 nulls_first: None,
3701 collation: None,
3702 extra_column_positions: Vec::new(),
3703 }
3704 }
3705
3706 /// v7.15.0 — `gin_trgm_ops`-flavoured GIN constructor. Same
3707 /// shape as `new_gin` but the posting-list keys are 3-byte
3708 /// trigram shingles (`pg_trgm`-compatible) and the column
3709 /// type is `TEXT` / `VARCHAR` (not `TSVECTOR`).
3710 fn new_gin_trgm(name: String, column_position: usize) -> Self {
3711 Self {
3712 name,
3713 column_position,
3714 kind: IndexKind::GinTrgm(PersistentBTreeMap::new()),
3715 included_columns: Vec::new(),
3716 partial_predicate: None,
3717 expression: None,
3718 is_unique: false,
3719 nulls_not_distinct: false,
3720 descending: false,
3721 nulls_first: None,
3722 collation: None,
3723 extra_column_positions: Vec::new(),
3724 }
3725 }
3726
3727 /// v7.17.0 Phase 2.2 — MySQL `FULLTEXT KEY` GIN constructor.
3728 /// Same shape as `new_gin_trgm` but the posting-list keys
3729 /// are lower-cased word lexemes (`to_tsvector('simple', col)`
3730 /// equivalent) instead of trigrams, and the column type is
3731 /// `TEXT` / `VARCHAR` (not `TSVECTOR`).
3732 fn new_gin_fulltext(name: String, column_position: usize) -> Self {
3733 Self {
3734 name,
3735 column_position,
3736 kind: IndexKind::GinFulltext(PersistentBTreeMap::new()),
3737 included_columns: Vec::new(),
3738 partial_predicate: None,
3739 expression: None,
3740 is_unique: false,
3741 nulls_not_distinct: false,
3742 descending: false,
3743 nulls_first: None,
3744 collation: None,
3745 extra_column_positions: Vec::new(),
3746 }
3747 }
3748
3749 /// v7.37.8(sentori Epic 5 P2)— JSONB-GIN constructor. Same
3750 /// shape as the other GIN-family indexes; posting-list keys
3751 /// are the canonical `(path, leaf)` tokens emitted by
3752 /// `crate::jsonb_gin::extract_tokens`. Maintains posting
3753 /// lists from `Value::Json` cells(JSONB is a synonym for the
3754 /// same in-memory string-backed Value).
3755 fn new_gin_jsonb(name: String, column_position: usize) -> Self {
3756 Self {
3757 name,
3758 column_position,
3759 kind: IndexKind::GinJsonb(PersistentBTreeMap::new()),
3760 included_columns: Vec::new(),
3761 partial_predicate: None,
3762 expression: None,
3763 is_unique: false,
3764 nulls_not_distinct: false,
3765 descending: false,
3766 nulls_first: None,
3767 collation: None,
3768 extra_column_positions: Vec::new(),
3769 }
3770 }
3771
3772 /// v7.34.4 — descending-order iterator over `(IndexKey, locators)`
3773 /// pairs for a BTree index, with O(log N) descent to the rightmost
3774 /// leaf and lazy emission thereafter. Returns an empty iterator
3775 /// for non-BTree index kinds — callers handle both uniformly.
3776 /// Used by the ORDER BY `<indexed col>` DESC + LIMIT N executor
3777 /// path: walking only the first N matches off the rightmost leaf
3778 /// avoids the per-row materialisation + partial-sort cost on
3779 /// large tables (mailrs `content_worker` at 250 k rows).
3780 pub fn iter_desc(
3781 &self,
3782 ) -> alloc::boxed::Box<dyn Iterator<Item = (&IndexKey, &crate::posting::PostingList)> + '_>
3783 {
3784 match &self.kind {
3785 IndexKind::BTree(m) => alloc::boxed::Box::new(m.iter_rev()),
3786 // v7.38.1 (L12) — projecting the leading component of a
3787 // composite key preserves order: keys sort by the whole
3788 // tuple, so the leading component is non-increasing here
3789 // (non-decreasing in iter_asc), exactly what an ORDER BY
3790 // on the leading column needs.
3791 IndexKind::BTreeMulti(m) => {
3792 alloc::boxed::Box::new(m.iter_rev().map(|(k, l)| (&k[0], l)))
3793 }
3794 IndexKind::Nsw(_)
3795 | IndexKind::Brin { .. }
3796 | IndexKind::Gin(_)
3797 | IndexKind::GinTrgm(_)
3798 | IndexKind::GinFulltext(_)
3799 | IndexKind::GinJsonb(_) => alloc::boxed::Box::new(core::iter::empty()),
3800 }
3801 }
3802
3803 /// v7.34.4 — ascending-order iterator over `(IndexKey, locators)`
3804 /// pairs. Mirror of `iter_desc` for ORDER BY ... ASC + LIMIT N.
3805 pub fn iter_asc(
3806 &self,
3807 ) -> alloc::boxed::Box<dyn Iterator<Item = (&IndexKey, &crate::posting::PostingList)> + '_>
3808 {
3809 match &self.kind {
3810 IndexKind::BTree(m) => alloc::boxed::Box::new(m.iter()),
3811 // v7.38.1 (L12) — see iter_desc: the leading component of
3812 // a tuple-sorted walk is itself in order.
3813 IndexKind::BTreeMulti(m) => alloc::boxed::Box::new(m.iter().map(|(k, l)| (&k[0], l))),
3814 IndexKind::Nsw(_)
3815 | IndexKind::Brin { .. }
3816 | IndexKind::Gin(_)
3817 | IndexKind::GinTrgm(_)
3818 | IndexKind::GinFulltext(_)
3819 | IndexKind::GinJsonb(_) => alloc::boxed::Box::new(core::iter::empty()),
3820 }
3821 }
3822
3823 /// Look up the locators stored under `key` (B-tree only). Returns
3824 /// an empty slice when the key is absent or the index isn't a
3825 /// BTree — callers can treat both cases uniformly.
3826 ///
3827 /// v5.1: return type widened from `&[usize]` to `&[RowLocator]`.
3828 /// Pre-v5.2 callers can read the slice and `.as_hot().unwrap()`
3829 /// each entry (no `Cold` variants exist until the freezer lands);
3830 /// post-v5.2 callers dispatch hot vs. cold per locator.
3831 pub fn lookup_eq(&self, key: &IndexKey) -> &crate::posting::PostingList {
3832 match &self.kind {
3833 IndexKind::BTree(m) => m.get(key).map_or(&EMPTY_POSTINGS, |l| l),
3834 // BRIN / NSW / GIN / trigram-GIN / fulltext-GIN have
3835 // no IndexKey-keyed map; lookup is a no-op. GIN uses
3836 // [`Index::gin_lookup_word`] instead.
3837 IndexKind::Nsw(_)
3838 | IndexKind::Brin { .. }
3839 | IndexKind::Gin(_)
3840 | IndexKind::GinTrgm(_)
3841 | IndexKind::GinFulltext(_)
3842 | IndexKind::GinJsonb(_)
3843 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3844 }
3845 }
3846
3847 /// v7.37.43 (INSUBQ B-2) — specialised lookup for integer-PK probes.
3848 /// `try_count_star_pk_in_subquery_fast` already holds an `i64` (the
3849 /// inner survivor key); skip the `IndexKey::from_value` enum-dispatch
3850 /// trip and build the key inline. ~20 ns × N_survivors saved on
3851 /// the INSUBQ hot loop.
3852 #[inline]
3853 pub fn lookup_eq_i64(&self, n: i64) -> &crate::posting::PostingList {
3854 match &self.kind {
3855 IndexKind::BTree(m) => m.get(&IndexKey::Int(n)).map_or(&EMPTY_POSTINGS, |l| l),
3856 IndexKind::Nsw(_)
3857 | IndexKind::Brin { .. }
3858 | IndexKind::Gin(_)
3859 | IndexKind::GinTrgm(_)
3860 | IndexKind::GinFulltext(_)
3861 | IndexKind::GinJsonb(_)
3862 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3863 }
3864 }
3865
3866 /// v7.38 (perf, index range scan) — flatten the row locators for every key
3867 /// in `[lo, hi]` (bounds per `core::ops::Bound`) via the BTree's `O(log N +
3868 /// k)` range walk. Returns `None` once more than `cap` locators accumulate
3869 /// — a "this range isn't selective enough, seq-scan instead" signal that
3870 /// stops a wide range from materialising a near-full table's worth of rows
3871 /// through the index. BTree only (other kinds → None).
3872 pub fn lookup_range_capped(
3873 &self,
3874 lo: core::ops::Bound<&IndexKey>,
3875 hi: core::ops::Bound<&IndexKey>,
3876 cap: usize,
3877 ) -> Option<Vec<RowLocator>> {
3878 self.lookup_range_capped_by(lo, hi, cap, |_| true)
3879 }
3880
3881 /// v7.39 (round 490) — the same range walk, but the caller decides
3882 /// which locators are worth carrying, and the cap counts only those.
3883 ///
3884 /// A BTree index holds one locator per row VERSION. On a churned table
3885 /// the dead versions are still in there: round 490 measured a
3886 /// 1000-row range handing back 61 000 locators after 60
3887 /// delete-and-reinsert cycles with the background vacuum switched off.
3888 /// Every caller then dropped the dead ones — the mutation paths and the
3889 /// SELECT range path all test `is_row_visible` and `continue` — but only
3890 /// after they had been collected into a `Vec`, sorted, and walked.
3891 ///
3892 /// Handing the predicate down means the walk keeps ~1000, and the cap
3893 /// (which exists so an index walk never costs more than the scan it
3894 /// replaces) is once again measured in rows a caller will actually look
3895 /// at. Round 461 had to add the dead count to the budget to stop the
3896 /// seek being refused outright; with the filter here that compensation
3897 /// is no longer needed.
3898 pub fn lookup_range_capped_by(
3899 &self,
3900 lo: core::ops::Bound<&IndexKey>,
3901 hi: core::ops::Bound<&IndexKey>,
3902 cap: usize,
3903 keep: impl Fn(RowLocator) -> bool,
3904 ) -> Option<Vec<RowLocator>> {
3905 match &self.kind {
3906 IndexKind::BTree(m) => {
3907 let mut out: Vec<RowLocator> = Vec::new();
3908 for (_, locs) in m.range(lo, hi) {
3909 out.extend(locs.iter().copied().filter(|l| keep(*l)));
3910 if out.len() > cap {
3911 return None;
3912 }
3913 }
3914 Some(out)
3915 }
3916 IndexKind::Nsw(_)
3917 | IndexKind::Brin { .. }
3918 | IndexKind::Gin(_)
3919 | IndexKind::GinTrgm(_)
3920 | IndexKind::GinFulltext(_)
3921 | IndexKind::GinJsonb(_)
3922 | IndexKind::BTreeMulti(_) => None,
3923 }
3924 }
3925
3926 /// v7.38.1 (L12) — full-tuple point lookup on a [`IndexKind::BTreeMulti`]
3927 /// index. `key` must carry exactly as many components as the index
3928 /// has columns; anything else (including a probe against a
3929 /// non-multi index) finds nothing, and "nothing" here is safe
3930 /// because the caller falls back to a scan, never to an answer.
3931 pub fn lookup_eq_multi(&self, key: &[IndexKey]) -> &crate::posting::PostingList {
3932 match &self.kind {
3933 IndexKind::BTreeMulti(m) if key.len() == 1 + self.extra_column_positions.len() => {
3934 m.get_by(key).map_or(&EMPTY_POSTINGS, |l| l)
3935 }
3936 _ => &EMPTY_POSTINGS,
3937 }
3938 }
3939
3940 /// v7.38.1 (L12) — locators for every key whose leading components
3941 /// equal `prefix`, on a [`IndexKind::BTreeMulti`] index. Slice
3942 /// ordering keeps a prefix's keys contiguous, so this is one
3943 /// descent to `[prefix]` and a walk that stops at the first key
3944 /// leaving the prefix. Same cap/keep contract as
3945 /// [`Index::lookup_range_capped_by`]: `None` = not selective
3946 /// enough (or not a multi index), fall back.
3947 pub fn lookup_prefix_capped_by(
3948 &self,
3949 prefix: &[IndexKey],
3950 cap: usize,
3951 keep: impl Fn(RowLocator) -> bool,
3952 ) -> Option<Vec<RowLocator>> {
3953 let IndexKind::BTreeMulti(m) = &self.kind else {
3954 return None;
3955 };
3956 if prefix.is_empty() || prefix.len() > 1 + self.extra_column_positions.len() {
3957 return None;
3958 }
3959 let lo: alloc::boxed::Box<[IndexKey]> = prefix.to_vec().into_boxed_slice();
3960 let mut out: Vec<RowLocator> = Vec::new();
3961 for (k, locs) in m.range(core::ops::Bound::Included(&lo), core::ops::Bound::Unbounded) {
3962 if k.len() < prefix.len() || k[..prefix.len()] != *prefix {
3963 break;
3964 }
3965 out.extend(locs.iter().copied().filter(|l| keep(*l)));
3966 if out.len() > cap {
3967 return None;
3968 }
3969 }
3970 Some(out)
3971 }
3972
3973 /// v7.38.19 — a RANGE on the composite tree's leading column.
3974 ///
3975 /// Tuples order lexicographically, so every key whose first
3976 /// component is `x` sorts at or after the one-element tuple `[x]`
3977 /// and before `[x']` for any larger `x'`. That makes a leading-
3978 /// column range one contiguous run, walked exactly like the
3979 /// single-column range walk — the only difference is that the
3980 /// comparison is against `k[0]` rather than the whole key.
3981 ///
3982 /// Without this, `WHERE project_id > 90` on a table whose only
3983 /// index was `(project_id, kind)` read every row: 4.067 ms against
3984 /// PostgreSQL 18's 0.220, on a predicate matching nothing. The same
3985 /// query with a single-column index took 0.165, which is what says
3986 /// the range was never the problem.
3987 pub fn lookup_leading_range_capped_by(
3988 &self,
3989 lo: core::ops::Bound<&IndexKey>,
3990 hi: core::ops::Bound<&IndexKey>,
3991 cap: usize,
3992 keep: impl Fn(RowLocator) -> bool,
3993 ) -> Option<Vec<RowLocator>> {
3994 let IndexKind::BTreeMulti(m) = &self.kind else {
3995 return None;
3996 };
3997 // The start of the run. An EXCLUDED lower bound cannot be
3998 // handed to the map as-is: `[x]` sorts BEFORE `[x, y]`, so
3999 // excluding `[x]` would still admit every tuple that begins
4000 // with `x`. Start at `[x]` included and drop those tuples by
4001 // the per-key test below, which compares the component.
4002 let lo_key: Option<alloc::boxed::Box<[IndexKey]>> = match lo {
4003 core::ops::Bound::Included(k) | core::ops::Bound::Excluded(k) => {
4004 Some(alloc::vec![k.clone()].into_boxed_slice())
4005 }
4006 core::ops::Bound::Unbounded => None,
4007 };
4008 let start = match &lo_key {
4009 Some(k) => core::ops::Bound::Included(k),
4010 None => core::ops::Bound::Unbounded,
4011 };
4012 let mut out: Vec<RowLocator> = Vec::new();
4013 for (k, locs) in m.range(start, core::ops::Bound::Unbounded) {
4014 let Some(first) = k.first() else { continue };
4015 match lo {
4016 core::ops::Bound::Excluded(b) if first == b => continue,
4017 _ => {}
4018 }
4019 match hi {
4020 core::ops::Bound::Included(b) if first > b => break,
4021 core::ops::Bound::Excluded(b) if first >= b => break,
4022 _ => {}
4023 }
4024 out.extend(locs.iter().copied().filter(|l| keep(*l)));
4025 if out.len() > cap {
4026 return None;
4027 }
4028 }
4029 Some(out)
4030 }
4031
4032 /// v7.39 (round 560) — the index range as (key, locator) pairs.
4033 ///
4034 /// `lookup_range_capped_by` throws the KEY away and returns only
4035 /// locators, so a query whose projection is exactly the indexed
4036 /// column still goes to the row store for a value the walk already
4037 /// had in hand — paying per row for something the index knows.
4038 ///
4039 /// Uncapped on purpose: an index-only walk touches no row, so the
4040 /// selectivity ceiling that keeps a seek from being worse than the
4041 /// scan it replaces does not apply to it.
4042 ///
4043 /// v7.39 (round 562) — and it does not collect, either. This
4044 /// returned a `Vec<(IndexKey, RowLocator)>`: for a 100k-row range,
4045 /// 100k key clones into a `Vec::new()` that doubles its way up to
4046 /// several MB, all to be walked once and dropped. A profile of the
4047 /// server serving that query put 20% of the connection thread's CPU
4048 /// on the collect alone, with another 18% in the allocator beside
4049 /// it. The caller consumes the pairs in order and needs the key
4050 /// only by reference, so it can have the walk itself.
4051 pub fn range_keyed(
4052 &self,
4053 lo: core::ops::Bound<&IndexKey>,
4054 hi: core::ops::Bound<&IndexKey>,
4055 ) -> Option<impl Iterator<Item = (&IndexKey, RowLocator)> + '_> {
4056 match &self.kind {
4057 IndexKind::BTree(m) => Some(
4058 m.range(lo, hi)
4059 .flat_map(|(k, locs)| locs.iter().map(move |l| (k, *l))),
4060 ),
4061 IndexKind::Nsw(_)
4062 | IndexKind::Brin { .. }
4063 | IndexKind::Gin(_)
4064 | IndexKind::GinTrgm(_)
4065 | IndexKind::GinFulltext(_)
4066 | IndexKind::GinJsonb(_)
4067 | IndexKind::BTreeMulti(_) => None,
4068 }
4069 }
4070
4071 /// v7.12.3 — GIN posting-list lookup. Returns the row locators
4072 /// whose `tsvector` cell contains `word`. Empty when the word is
4073 /// absent from the index or this isn't a GIN index.
4074 pub fn gin_lookup_word(&self, word: &str) -> &crate::posting::PostingList {
4075 match &self.kind {
4076 // v7.17.0 Phase 2.2 — fulltext-GIN shares the same
4077 // lexeme-keyed posting list shape as the
4078 // tsvector-typed GIN, so the same lookup applies.
4079 IndexKind::Gin(m) | IndexKind::GinFulltext(m) => {
4080 m.get(&String::from(word)).map_or(&EMPTY_POSTINGS, |l| l)
4081 }
4082 IndexKind::BTree(_)
4083 | IndexKind::Nsw(_)
4084 | IndexKind::Brin { .. }
4085 | IndexKind::GinTrgm(_)
4086 | IndexKind::GinJsonb(_)
4087 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
4088 }
4089 }
4090
4091 /// v7.15.0 — trigram-GIN posting-list lookup. Returns the row
4092 /// locators whose indexed `TEXT` cell contains the trigram
4093 /// `tri`. Empty when the trigram is absent or this isn't a
4094 /// trigram-GIN index.
4095 pub fn gin_trgm_lookup(&self, tri: &str) -> &crate::posting::PostingList {
4096 match &self.kind {
4097 IndexKind::GinTrgm(m) => m.get(&String::from(tri)).map_or(&EMPTY_POSTINGS, |l| l),
4098 IndexKind::BTree(_)
4099 | IndexKind::Nsw(_)
4100 | IndexKind::Brin { .. }
4101 | IndexKind::Gin(_)
4102 | IndexKind::GinFulltext(_)
4103 | IndexKind::GinJsonb(_)
4104 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
4105 }
4106 }
4107
4108 /// v7.37.8(sentori Epic 5 P2)— JSONB-GIN posting-list lookup.
4109 /// Returns the row locators whose indexed JSONB cell carries
4110 /// the canonical `token`(see [`crate::jsonb_gin::extract_tokens`]).
4111 /// Empty when the token is absent or this isn't a JSONB-GIN
4112 /// index. Planners drive `<col> @> <jsonb_literal>` through here.
4113 pub fn gin_jsonb_lookup(&self, token: &str) -> &crate::posting::PostingList {
4114 match &self.kind {
4115 IndexKind::GinJsonb(m) => m.get(&String::from(token)).map_or(&EMPTY_POSTINGS, |l| l),
4116 IndexKind::BTree(_)
4117 | IndexKind::Nsw(_)
4118 | IndexKind::Brin { .. }
4119 | IndexKind::Gin(_)
4120 | IndexKind::GinTrgm(_)
4121 | IndexKind::GinFulltext(_)
4122 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
4123 }
4124 }
4125
4126 /// Borrow the NSW graph (if this is an NSW index). Callers that need
4127 /// the graph for a kNN search go through here.
4128 pub const fn nsw(&self) -> Option<&NswGraph> {
4129 match &self.kind {
4130 IndexKind::Nsw(g) => Some(g),
4131 IndexKind::BTree(_)
4132 | IndexKind::Brin { .. }
4133 | IndexKind::Gin(_)
4134 | IndexKind::GinTrgm(_)
4135 | IndexKind::GinFulltext(_)
4136 | IndexKind::GinJsonb(_)
4137 | IndexKind::BTreeMulti(_) => None,
4138 }
4139 }
4140
4141 /// v6.7.1 — true when this index is a BRIN (block range) index.
4142 /// Used by the segment encoder to opt into BRIN sidecar emission
4143 /// at freeze time, and by the planner to opt into page-skipping
4144 /// on range predicates.
4145 pub const fn is_brin(&self) -> bool {
4146 matches!(self.kind, IndexKind::Brin { .. })
4147 }
4148
4149 /// v7.15.0 — true when this index is a trigram GIN
4150 /// (`gin_trgm_ops`-flavoured). Used by the LIKE planner to
4151 /// opt into trigram acceleration.
4152 pub const fn is_gin_trgm(&self) -> bool {
4153 matches!(self.kind, IndexKind::GinTrgm(_))
4154 }
4155
4156 /// v7.12.3 — true when this index is a GIN inverted index.
4157 /// Used by the planner to opt into posting-list acceleration on
4158 /// `WHERE col @@ tsquery` predicates.
4159 pub const fn is_gin(&self) -> bool {
4160 matches!(self.kind, IndexKind::Gin(_))
4161 }
4162
4163 /// v7.17.0 Phase 2.2 — true when this index is a fulltext
4164 /// GIN over a TEXT / VARCHAR column (MySQL `FULLTEXT KEY`
4165 /// surface). Used by the planner to opt the FULLTEXT-indexed
4166 /// column into MATCH AGAINST acceleration.
4167 pub const fn is_gin_fulltext(&self) -> bool {
4168 matches!(self.kind, IndexKind::GinFulltext(_))
4169 }
4170
4171 /// v7.37.8(sentori Epic 5 P2)— true when this index is a
4172 /// real JSONB-GIN(posting-list backed). Used by the planner
4173 /// to opt `<col> @> <jsonb_literal>` into posting-list seek.
4174 pub const fn is_gin_jsonb(&self) -> bool {
4175 matches!(self.kind, IndexKind::GinJsonb(_))
4176 }
4177}
4178
4179/// In-memory table: schema + a persistent row vector + secondary indices.
4180///
4181/// v4.39: `rows` is a [`PersistentVec`] (Bitmapped Vector Trie, 32-way) so
4182/// `Table::clone()` is `O(1)` — the whole reason for v4.39's existence is
4183/// to make `Catalog::clone()` cheap inside the v4.34 auto-commit wrap.
4184///
4185/// v5.2.1: `hot_bytes` tracks the encoded byte size of every row currently
4186/// in [`Self::rows`], summed over rows. Updated incrementally by `insert`
4187/// (+= encoded row size), `delete_rows` (-= removed rows' encoded sizes),
4188/// and `update_row` (-= old size, += new size). The value is what the
4189/// v5.2 freezer reads to decide when to demote cold rows — when the
4190/// catalog-wide sum crosses `SPG_HOT_TIER_BYTES` (default 4 GiB) the
4191/// freezer thread wakes. v5.2.1 ships measurement only; the freezer
4192/// itself lands in v5.2.2. Stored as `u64` so a single field clone in
4193/// `Catalog::clone` stays at the O(1) invariant v4.39 built.
4194/// v7.34 (crash-recovery P0 #2) — one row-level physical redo record.
4195/// Row-level redo replaces statement-based WAL replay (which re-executes
4196/// each SQL through the full engine — O(records × catalog_rows), the
4197/// superlinear recovery hang root-caused on the mailrs crash-recovery
4198/// P0). A `RowChange` is the exact storage mutation the engine applied
4199/// (`Table::insert` / `update_row` / `delete_rows`); replaying it on a
4200/// catalog restored from the matching checkpoint reproduces the state
4201/// WITHOUT re-validating uniqueness/FK/parse/plan — O(changed rows).
4202///
4203/// Positions are physical, not key-based: `serialize`/`deserialize`
4204/// preserve row order exactly (rows written + read back in `self.rows`
4205/// order) and the mutation ops are deterministic, so the same op sequence
4206/// replayed from the same checkpoint reproduces the same positions. This
4207/// matches PostgreSQL's physical redo and supports tables with no primary
4208/// key. (Caveat handled at replay integration: a post-checkpoint cold-tier
4209/// freeze shifts hot positions and must itself be logged or fenced by a
4210/// checkpoint — see `row-level-redo-design`.)
4211/// ## v7.37.15 (Epic W slice 1) — additive MVCC identity metadata
4212///
4213/// Each variant now also carries, additively, the stable
4214/// [`RowId`](row_header::RowId) of the affected row(s) and the
4215/// **writer version** (`xmin` for an insert, `xmax` for a
4216/// delete/update). This is the codec foundation for making
4217/// in-place MVCC tombstones durable across crash/upgrade recovery.
4218///
4219/// Two important properties for the durability path:
4220///
4221/// 1. **Replay resolution is UNCHANGED.** `apply_redo_run_on_table`
4222/// still resolves every change by physical `pos`/`positions`
4223/// exactly as before. The new metadata is *carried but unused*
4224/// by replay in this slice; resolving-by-`RowId` and
4225/// header-preserving replay are later slices.
4226/// 2. **Backward compatibility.** A redo payload written by
4227/// pre-Epic-W code carries no metadata; [`decode_redo_log`]
4228/// fills `rowid`/`rowids` with [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED)
4229/// (empty for `Delete`) and `writer_version` with `0`. See the
4230/// codec version gate in [`encode_redo_log`]/[`decode_redo_log`].
4231///
4232/// The `writer_version` is captured as `0` at the storage layer
4233/// (`Table::insert`/`delete_rows`/`update_row` don't have the
4234/// committing `TxId`), then **stamped with the real committing
4235/// version by the engine** after it drains the statement's changes
4236/// (Epic W slice 2 — [`RowChange::set_writer_version`], driven from
4237/// `Engine::writer_version_for_current_stmt`). All changes from one
4238/// statement share the one version. Replay still resolves by
4239/// physical position and does not read `writer_version` — that is a
4240/// later slice (header-preserving replay).
4241#[derive(Debug, Clone, PartialEq)]
4242pub enum RowChange {
4243 /// Append `row` to `table`.
4244 Insert {
4245 table: String,
4246 row: Row<'static>,
4247 /// Epic W: stable id the appended row will receive.
4248 /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) when
4249 /// decoded from a pre-Epic-W redo payload.
4250 rowid: row_header::RowId,
4251 /// Epic W: writer version (`xmin`). `0` until the writing
4252 /// `TxId` is threaded to the storage layer (later slice).
4253 writer_version: u64,
4254 },
4255 /// Replace the row at physical `pos` in `table` with `new_row`.
4256 Update {
4257 table: String,
4258 pos: usize,
4259 new_row: Vec<Value<'static>>,
4260 /// Epic W: stable id of the row at `pos`.
4261 /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) when
4262 /// decoded from a pre-Epic-W redo payload.
4263 rowid: row_header::RowId,
4264 /// Epic W: writer version (`xmax` of the superseded tuple).
4265 /// `0` until the writing `TxId` is threaded (later slice).
4266 writer_version: u64,
4267 },
4268 /// Remove the rows at the given physical `positions` from `table`.
4269 Delete {
4270 table: String,
4271 positions: Vec<usize>,
4272 /// Epic W: stable ids parallel to `positions` (same length,
4273 /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) for an
4274 /// out-of-bounds input position). **Empty** when decoded from
4275 /// a pre-Epic-W redo payload (no metadata was recorded).
4276 rowids: Vec<row_header::RowId>,
4277 /// Epic W: writer version (`xmax`). `0` until the writing
4278 /// `TxId` is threaded to the storage layer (later slice).
4279 writer_version: u64,
4280 },
4281 /// v7.37.15 (Epic W durable-tombstone slice) — an **in-place MVCC
4282 /// delete**: the row(s) named by `rowids` are NOT physically
4283 /// removed; their header `xmax` is stamped so newer snapshots stop
4284 /// seeing them (vacuum reclaims later). This is the redo shape of
4285 /// the gate-on (`SPG_MVCC_INPLACE`) DELETE / UPDATE-old-version /
4286 /// ON-CONFLICT paths, which call [`Table::mark_row_deleted`]
4287 /// instead of `delete_rows`.
4288 ///
4289 /// Unlike `Delete`, the target is named by **stable `RowId`**, not
4290 /// physical position: a tombstone keeps the slot, so position would
4291 /// be ambiguous after later compaction, and the header-preserving
4292 /// replay must re-find the exact row the writer tombstoned. On
4293 /// replay the id is matched against the ids the same redo run
4294 /// produced (an `Insert`'s `rowid`, or the table's ids snapshotted
4295 /// at run start); an id that cannot be resolved is skipped and
4296 /// counted (see `apply_redo_run_on_table`) — this is the documented
4297 /// cross-checkpoint limitation until the V6 envelope persists ids.
4298 Tombstone {
4299 table: String,
4300 /// Stable ids of the tombstoned rows (from `self.rowids()[pos]`
4301 /// at capture). Never empty for a recorded tombstone.
4302 rowids: Vec<row_header::RowId>,
4303 /// The version stamped into each target row's header `xmax`
4304 /// (the deleting statement's writer version).
4305 xmax: u64,
4306 },
4307}
4308
4309impl RowChange {
4310 /// v7.39 (round 736) — which table this change applies to.
4311 #[must_use]
4312 pub fn table_name(&self) -> &str {
4313 match self {
4314 Self::Insert { table, .. }
4315 | Self::Update { table, .. }
4316 | Self::Delete { table, .. }
4317 | Self::Tombstone { table, .. } => table,
4318 }
4319 }
4320
4321 /// v7.37.15 (Epic W slice 2) — stamp the committing writer
4322 /// version onto this change. Every change drained from a single
4323 /// statement shares one version (the statement's `xmin`/`xmax`),
4324 /// so the engine calls this on each drained change with the value
4325 /// from [`Engine::writer_version_for_current_stmt`]. Additive
4326 /// metadata only: replay still resolves by physical position and
4327 /// does not read `writer_version` (that is a later slice).
4328 pub fn set_writer_version(&mut self, v: u64) {
4329 match self {
4330 RowChange::Insert { writer_version, .. }
4331 | RowChange::Update { writer_version, .. }
4332 | RowChange::Delete { writer_version, .. } => *writer_version = v,
4333 // A tombstone captures `xmax` directly from the deleting
4334 // statement's version at record time (via
4335 // `mark_row_deleted`), so it already equals `v`. Keep the
4336 // "one statement, one version" invariant mechanical by
4337 // asserting agreement in debug builds rather than silently
4338 // overwriting a possibly-different value.
4339 RowChange::Tombstone { xmax, .. } => {
4340 debug_assert_eq!(
4341 *xmax, v,
4342 "tombstone xmax must match the statement writer version"
4343 );
4344 *xmax = v;
4345 }
4346 }
4347 }
4348}
4349
4350/// v7.37.15 (Epic W slice 1) — leading marker byte of the
4351/// metadata-carrying redo layout. A **pre-Epic-W** redo payload leads
4352/// with `FILE_VERSION` (8..=52 today, rising ~1 per release); this
4353/// marker is `0xFF` and can therefore never collide with a real
4354/// `FILE_VERSION`, so [`decode_redo_log`] tells the two layouts apart
4355/// by inspecting the first byte alone. The compile-time assertion
4356/// below makes the "never collide" invariant a hard build gate: if
4357/// `FILE_VERSION` ever climbs toward `0xFF` the build breaks and forces
4358/// a redesign long before an ambiguity could ship.
4359const REDO_META_MARKER: u8 = 0xFF;
4360/// v7.37.15 (Epic W slice 1) — version of the metadata-carrying redo
4361/// layout that follows [`REDO_META_MARKER`]. Bumped when the per-change
4362/// metadata shape changes; an unknown value is a hard decode error.
4363const REDO_META_VERSION: u8 = 1;
4364
4365/// v7.37.15 (Epic W durable-tombstone slice) — process-wide count of
4366/// [`RowChange::Tombstone`] targets that `apply_redo` could NOT resolve
4367/// to a row by `RowId`. A non-zero value is expected only across a
4368/// checkpoint boundary (the table's ids are reassigned on deserialize
4369/// and the V6 envelope does not yet persist them), where a tombstone
4370/// naming a pre-checkpoint row is left visible rather than mis-applied.
4371/// Surfaced for observability; never affects correctness of the resolved
4372/// tombstones. Read via [`unresolved_tombstone_count`].
4373static UNRESOLVED_TOMBSTONES: core::sync::atomic::AtomicU64 = core::sync::atomic::AtomicU64::new(0);
4374
4375/// v7.39 (flip crash-replay P0) — observability read for the replay
4376/// tombstones that could not be resolved to a row (each one is a
4377/// resurrected delete).
4378#[must_use]
4379pub fn unresolved_tombstones() -> u64 {
4380 UNRESOLVED_TOMBSTONES.load(core::sync::atomic::Ordering::Relaxed)
4381}
4382
4383/// v7.37.15 (Epic W durable-tombstone slice) — read the process-wide
4384/// count of redo tombstones that could not be resolved to a row by
4385/// `RowId` during `apply_redo`. See [`UNRESOLVED_TOMBSTONES`].
4386#[must_use]
4387pub fn unresolved_tombstone_count() -> u64 {
4388 UNRESOLVED_TOMBSTONES.load(core::sync::atomic::Ordering::Relaxed)
4389}
4390// Provably-unambiguous old/new distinction: the pre-Epic-W layout's
4391// first byte is `FILE_VERSION`, which must stay strictly below the
4392// marker forever.
4393const _: () = assert!(FILE_VERSION < REDO_META_MARKER);
4394
4395/// v7.34 (crash-recovery P0 #2), extended v7.37.15 (Epic W slice 1) —
4396/// encode a row-level redo log to bytes for a WAL record.
4397///
4398/// ## Layout (Epic W metadata-carrying form, always emitted now)
4399///
4400/// `[u8 REDO_META_MARKER=0xFF][u8 REDO_META_VERSION][u8 FILE_VERSION]
4401/// [u32 count]` then per change `[u8 op][str table]` and, per op:
4402/// - `Insert [u32 n][value×n][u64 rowid][u64 writer_version]`
4403/// - `Update [u32 pos][u32 n][value×n][u64 rowid][u64 writer_version]`
4404/// - `Delete [u32 n][u32 pos×n][u64 rowid×n][u64 writer_version]`
4405/// - `Tombstone [u32 n][u64 rowid×n][u64 xmax]` (op byte 3; only ever
4406/// emitted under the metadata-carrying layout — the pre-Epic-W layout
4407/// had no in-place tombstone, so a legacy stream can never carry it)
4408///
4409/// Positions are physical (u32 ≤ 4 G rows). The `FILE_VERSION` byte
4410/// still rides along (now the 3rd byte) so the value codec decodes
4411/// string / BYTEA escapes exactly as before.
4412///
4413/// ## Backward compatibility
4414///
4415/// The **pre-Epic-W** layout was `[u8 FILE_VERSION][u32 count]…` with
4416/// no per-change metadata. [`decode_redo_log`] still decodes that form
4417/// (first byte < `0xFF`) byte-for-byte identically — every WAL file
4418/// written by released code replays unchanged.
4419#[must_use]
4420pub fn encode_redo_log(changes: &[RowChange]) -> Vec<u8> {
4421 let mut out = Vec::new();
4422 out.push(REDO_META_MARKER);
4423 out.push(REDO_META_VERSION);
4424 out.push(FILE_VERSION);
4425 codec::write_u32(&mut out, changes.len() as u32);
4426 let write_values = |out: &mut Vec<u8>, vals: &[Value<'static>]| {
4427 codec::write_u32(out, vals.len() as u32);
4428 for v in vals {
4429 codec::write_value(out, v);
4430 }
4431 };
4432 for change in changes {
4433 match change {
4434 RowChange::Insert {
4435 table,
4436 row,
4437 rowid,
4438 writer_version,
4439 } => {
4440 out.push(0);
4441 codec::write_str(&mut out, table);
4442 write_values(&mut out, &row.values);
4443 codec::write_u64(&mut out, rowid.0);
4444 codec::write_u64(&mut out, *writer_version);
4445 }
4446 RowChange::Update {
4447 table,
4448 pos,
4449 new_row,
4450 rowid,
4451 writer_version,
4452 } => {
4453 out.push(1);
4454 codec::write_str(&mut out, table);
4455 codec::write_u32(&mut out, *pos as u32);
4456 write_values(&mut out, new_row);
4457 codec::write_u64(&mut out, rowid.0);
4458 codec::write_u64(&mut out, *writer_version);
4459 }
4460 RowChange::Delete {
4461 table,
4462 positions,
4463 rowids,
4464 writer_version,
4465 } => {
4466 out.push(2);
4467 codec::write_str(&mut out, table);
4468 codec::write_u32(&mut out, positions.len() as u32);
4469 for p in positions {
4470 codec::write_u32(&mut out, *p as u32);
4471 }
4472 // Epic W: one RowId per position (parallel). Capture
4473 // sites always produce `rowids.len() == positions.len()`;
4474 // this assertion pins that invariant at encode time so a
4475 // mismatch is a loud bug, not a silently short payload.
4476 debug_assert_eq!(
4477 rowids.len(),
4478 positions.len(),
4479 "redo Delete: rowids must be parallel to positions"
4480 );
4481 for rid in rowids {
4482 codec::write_u64(&mut out, rid.0);
4483 }
4484 codec::write_u64(&mut out, *writer_version);
4485 }
4486 RowChange::Tombstone {
4487 table,
4488 rowids,
4489 xmax,
4490 } => {
4491 out.push(3);
4492 codec::write_str(&mut out, table);
4493 codec::write_u32(&mut out, rowids.len() as u32);
4494 for rid in rowids {
4495 codec::write_u64(&mut out, rid.0);
4496 }
4497 codec::write_u64(&mut out, *xmax);
4498 }
4499 }
4500 }
4501 out
4502}
4503
4504/// v7.34, extended v7.37.15 (Epic W slice 1) — decode a row-level redo
4505/// log written by [`encode_redo_log`].
4506///
4507/// Decodes **both** the Epic W metadata-carrying layout (first byte
4508/// `REDO_META_MARKER = 0xFF`) and the pre-Epic-W layout (first byte is
4509/// `FILE_VERSION`, always `< 0xFF`). For the old layout the per-change
4510/// metadata is absent, so `rowid`/`rowids` come back
4511/// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) (empty for
4512/// `Delete`) and `writer_version` comes back `0`.
4513///
4514/// A truncated / corrupt buffer is a hard error — never a panic — the
4515/// embedding layer frames each record with its own length + CRC, so a
4516/// frame that decodes short is corruption, not a torn tail.
4517pub fn decode_redo_log(bytes: &[u8]) -> Result<Vec<RowChange>, StorageError> {
4518 let first = *bytes
4519 .first()
4520 .ok_or_else(|| StorageError::Corrupt("redo log: empty".into()))?;
4521 // Epic W: `0xFF` marker ⇒ metadata-carrying layout; anything else
4522 // is a pre-Epic-W `FILE_VERSION` byte (old layout, no metadata).
4523 let has_meta = first == REDO_META_MARKER;
4524 let (codec_version, header_len) = if has_meta {
4525 let meta_version = *bytes
4526 .get(1)
4527 .ok_or_else(|| StorageError::Corrupt("redo log: short header".into()))?;
4528 if meta_version != REDO_META_VERSION {
4529 return Err(StorageError::Corrupt(alloc::format!(
4530 "redo log: unknown metadata version {meta_version}"
4531 )));
4532 }
4533 let file_version = *bytes
4534 .get(2)
4535 .ok_or_else(|| StorageError::Corrupt("redo log: short header".into()))?;
4536 // header = [marker][meta_version][file_version]
4537 (file_version, 3usize)
4538 } else {
4539 // Old layout: the first byte IS the FILE_VERSION.
4540 (first, 1usize)
4541 };
4542 let mut cur = codec::Cursor::new(bytes).with_codec_version(codec_version);
4543 for _ in 0..header_len {
4544 cur.read_u8()?;
4545 }
4546 let count = cur.read_u32()? as usize;
4547 let mut read_values =
4548 |cur: &mut codec::Cursor<'_>| -> Result<Vec<Value<'static>>, StorageError> {
4549 let n = cur.read_u32()? as usize;
4550 let mut vals = Vec::with_capacity(n);
4551 for _ in 0..n {
4552 vals.push(cur.read_value()?);
4553 }
4554 Ok(vals)
4555 };
4556 let mut changes = Vec::with_capacity(count);
4557 for _ in 0..count {
4558 let op = cur.read_u8()?;
4559 let table = cur.read_str()?;
4560 let change = match op {
4561 0 => {
4562 let row = Row::new(read_values(&mut cur)?);
4563 let (rowid, writer_version) = if has_meta {
4564 (row_header::RowId(cur.read_u64()?), cur.read_u64()?)
4565 } else {
4566 (row_header::RowId::UNASSIGNED, 0)
4567 };
4568 RowChange::Insert {
4569 table,
4570 row,
4571 rowid,
4572 writer_version,
4573 }
4574 }
4575 1 => {
4576 let pos = cur.read_u32()? as usize;
4577 let new_row = read_values(&mut cur)?;
4578 let (rowid, writer_version) = if has_meta {
4579 (row_header::RowId(cur.read_u64()?), cur.read_u64()?)
4580 } else {
4581 (row_header::RowId::UNASSIGNED, 0)
4582 };
4583 RowChange::Update {
4584 table,
4585 pos,
4586 new_row,
4587 rowid,
4588 writer_version,
4589 }
4590 }
4591 2 => {
4592 let n = cur.read_u32()? as usize;
4593 let mut positions = Vec::with_capacity(n);
4594 for _ in 0..n {
4595 positions.push(cur.read_u32()? as usize);
4596 }
4597 let (rowids, writer_version) = if has_meta {
4598 let mut rowids = Vec::with_capacity(n);
4599 for _ in 0..n {
4600 rowids.push(row_header::RowId(cur.read_u64()?));
4601 }
4602 (rowids, cur.read_u64()?)
4603 } else {
4604 // Old layout carried no RowId metadata.
4605 (Vec::new(), 0)
4606 };
4607 RowChange::Delete {
4608 table,
4609 positions,
4610 rowids,
4611 writer_version,
4612 }
4613 }
4614 // Op 3 is the Epic W in-place tombstone — it only exists in
4615 // the metadata-carrying layout. Guarding on `has_meta` means
4616 // a legacy stream that happens to contain a `3` byte here is
4617 // reported as an unknown op (corruption), never mis-decoded.
4618 3 if has_meta => {
4619 let n = cur.read_u32()? as usize;
4620 let mut rowids = Vec::with_capacity(n);
4621 for _ in 0..n {
4622 rowids.push(row_header::RowId(cur.read_u64()?));
4623 }
4624 let xmax = cur.read_u64()?;
4625 RowChange::Tombstone {
4626 table,
4627 rowids,
4628 xmax,
4629 }
4630 }
4631 other => {
4632 return Err(StorageError::Corrupt(alloc::format!(
4633 "redo log: unknown op {other}"
4634 )));
4635 }
4636 };
4637 changes.push(change);
4638 }
4639 Ok(changes)
4640}
4641
4642/// v7.39 (pg_stat knife B) — per-table scan counters, bumped from
4643/// `&self` read paths. Clone (tx shadow catalogs clone tables) copies
4644/// the current values; the counters are volatile like PG's cumulative
4645/// stats.
4646#[derive(Debug, Default)]
4647pub struct ScanStats {
4648 pub seq_scan: core::sync::atomic::AtomicU64,
4649 pub seq_tup_read: core::sync::atomic::AtomicU64,
4650 pub idx_scan: core::sync::atomic::AtomicU64,
4651 pub idx_tup_fetch: core::sync::atomic::AtomicU64,
4652}
4653
4654impl Clone for ScanStats {
4655 fn clone(&self) -> Self {
4656 use core::sync::atomic::{AtomicU64, Ordering};
4657 Self {
4658 seq_scan: AtomicU64::new(self.seq_scan.load(Ordering::Relaxed)),
4659 seq_tup_read: AtomicU64::new(self.seq_tup_read.load(Ordering::Relaxed)),
4660 idx_scan: AtomicU64::new(self.idx_scan.load(Ordering::Relaxed)),
4661 idx_tup_fetch: AtomicU64::new(self.idx_tup_fetch.load(Ordering::Relaxed)),
4662 }
4663 }
4664}
4665
4666/// v7.39 (round 215) — the lower-bound sort key for a range value, used by
4667/// the range-exclusion index. The bound as an `i128` (unbounded lower =
4668/// `i128::MIN`, sorting first) plus an inclusivity rank (inclusive lower
4669/// sorts before exclusive at the same value, `[3` before `(3`). Returns
4670/// `None` for range kinds whose bound isn't an integer scalar (numrange's
4671/// numeric/bignum), for empty ranges, and for non-range values — the caller
4672/// then keeps the O(n) scan rather than risk an unsound order. Int4/Int8/
4673/// Date/Ts/TsTz all reduce here (tstzrange bounds are `Value::Timestamp`).
4674/// Maintenance (index build) and query (overlap probe) MUST agree on this
4675/// key, so both sides call exactly this function.
4676#[must_use]
4677pub fn range_excl_index_key(v: &Value<'_>) -> Option<(i128, u8)> {
4678 let Value::Range {
4679 lower,
4680 lower_inc,
4681 empty,
4682 ..
4683 } = v
4684 else {
4685 return None;
4686 };
4687 if *empty {
4688 return None;
4689 }
4690 let key = match lower {
4691 None => i128::MIN,
4692 Some(b) => match b.as_ref() {
4693 Value::SmallInt(n) => i128::from(*n),
4694 Value::Int(n) => i128::from(*n),
4695 Value::BigInt(n) => i128::from(*n),
4696 Value::Date(n) => i128::from(*n),
4697 Value::Timestamp(n) => i128::from(*n),
4698 _ => return None,
4699 },
4700 };
4701 Some((key, u8::from(!*lower_inc)))
4702}
4703
4704/// v7.39 (round 215) — a per-table range-exclusion index: an incrementally
4705/// maintained map from a range column's lower-bound key
4706/// ([`range_excl_index_key`]) to the physical row locators carrying that
4707/// bound. Lets EXCLUDE enforcement find the few candidate rows a new range
4708/// might overlap in O(log n) instead of scanning every row (measured O(N²),
4709/// r213). Because the stored ranges under a valid `EXCLUDE (col WITH &&)`
4710/// are pairwise disjoint, a candidate overlaps only its predecessor or the
4711/// successors whose lower bound precedes its upper — a handful of probes.
4712///
4713/// NOT persisted: rebuilt from the (persisted) exclusion constraints + rows
4714/// on catalog load, exactly like BRIN re-derives. Backed by a
4715/// `PersistentBTreeMap` so `Table::clone` (the per-write snapshot) stays
4716/// O(1). Locators to tombstoned rows are left in place and filtered by the
4717/// consumer via `is_deleted()` at query time — the established index pattern.
4718#[derive(Debug, Clone)]
4719pub struct ExclRangeIndex {
4720 /// The constrained range column's position in the table.
4721 pub column_position: usize,
4722 /// Lower-bound key → row locators. A key maps to a `Vec` because a
4723 /// tombstoned-then-reinserted bound can transiently collide; live rows
4724 /// under the constraint are disjoint so each key has one live locator.
4725 pub map: PersistentBTreeMap<(i128, u8), crate::posting::PostingList>,
4726}
4727
4728/// v7.38.2 (R2) — see [`Table::tx_write_track`]. Positions are the
4729/// insert-time slots (verified against the header's version at
4730/// extraction, so a shifted slot falls back to the scan); tombstones
4731/// carry the stable RowId, which is what the write-set wants anyway.
4732#[derive(Debug, Clone, Default)]
4733struct TxWriteTrack {
4734 version: u64,
4735 inserted: Vec<(usize, row_header::RowId)>,
4736 tombstoned: Vec<row_header::RowId>,
4737}
4738
4739/// v7.38.11 — hot-tier BRIN granularity: slots per summarised range.
4740///
4741/// 1024 keeps the summary vector three orders of magnitude smaller
4742/// than the table while staying fine enough that a one-day window over
4743/// a 90-day table skips ~99 % of it. A tuning constant, not a format:
4744/// summaries are rebuilt from the rows on load, so changing it costs
4745/// nothing on disk.
4746pub const BRIN_RANGE_ROWS: usize = 1024;
4747
4748/// The comparable scalar a BRIN summary tracks, or `None` for a value
4749/// with no ordering this index can use.
4750///
4751/// Deliberately narrow: only types whose ordering IS the i64 ordering
4752/// of this number. A type added here whose comparison is not that —
4753/// text under a collation, say — would make the summary under-report
4754/// and skip matching rows, which is the one failure this design must
4755/// not have.
4756#[must_use]
4757pub fn brin_scalar(v: &Value<'_>) -> Option<i64> {
4758 match v {
4759 Value::SmallInt(n) => Some(i64::from(*n)),
4760 Value::Int(n) => Some(i64::from(*n)),
4761 Value::BigInt(n) | Value::Timestamp(n) => Some(*n),
4762 Value::Date(d) => Some(i64::from(*d)),
4763 Value::Bool(b) => Some(i64::from(*b)),
4764 _ => None,
4765 }
4766}
4767
4768#[derive(Debug, Clone)]
4769pub struct Table {
4770 schema: TableSchema,
4771 /// v7.38.18 (S2) — the DATABASE's collation, copied in by the
4772 /// catalog that owns this table.
4773 ///
4774 /// A text column that declares no collation inherits it, which is
4775 /// what PostgreSQL does and what `information_schema.columns`
4776 /// reports as NULL. Runtime only, never serialised: it belongs to
4777 /// the catalog, and a table that has been handed around outside one
4778 /// falls back to `C`, which is the answer for every database written
4779 /// before this existed.
4780 db_collation: Option<String>,
4781 /// v7.38.16 — names of the expression indexes whose B-tree currently
4782 /// holds keys derived from the EXPRESSION.
4783 ///
4784 /// Every catalog written before this version stored, under an
4785 /// expression index, the values of its leading column — keys no
4786 /// lookup could ever match, which is why every read path guarded
4787 /// itself with `expression.is_none()` and the index bought nothing
4788 /// while costing 1.9x a plain insert to maintain.
4789 ///
4790 /// Deliberately NOT persisted: a table read off disk starts with the
4791 /// set empty, so those old wrong keys can never answer a query. The
4792 /// engine, which owns the expression evaluator, refills it.
4793 expr_index_complete: alloc::collections::BTreeSet<String>,
4794 /// v7.37.15 (Phase C.1) — stable per-catalog relation identity.
4795 /// [`RelId::UNASSIGNED`](row_header::RelId::UNASSIGNED) until
4796 /// `Catalog::create_table` (or the deserialize dense-assign pass)
4797 /// stamps a real id. Keys the Phase C.4 row-lock table and the
4798 /// Phase C.5 `RelationStore`; survives `DROP TABLE` slot shifts.
4799 rel_id: row_header::RelId,
4800 rows: PersistentVec<Row<'static>>,
4801 /// v7.37.15 (Phase A.2) — per-row MVCC visibility headers
4802 /// parallel to `rows`. `headers.len() == rows.len()` is the
4803 /// load-bearing invariant; debug builds assert it on every
4804 /// scan boundary, release builds rely on it from
4805 /// disciplined insert / delete / update paths.
4806 ///
4807 /// Pre-v7.37.15-loaded tables (every row currently in the
4808 /// fleet) start as `RowHeader::frozen()` — `is_all_visible_fast()`
4809 /// returns `true`, so the per-row visibility gate Phase B
4810 /// adds is a no-op against any snapshot.
4811 ///
4812 /// Headers are NOT yet serialised into the envelope at this
4813 /// commit — on snapshot deserialize every row gets a fresh
4814 /// `RowHeader::frozen()`. Phase D adds the visibility-map
4815 /// + segment-freeze story which makes serialisation
4816 /// meaningful; until then the on-disk story is "the catalog
4817 /// is the set of visible rows."
4818 headers: PersistentVec<row_header::RowHeader>,
4819 /// v7.37.15 (Phase C.1) — stable per-relation row identity
4820 /// parallel to `rows` / `headers`. `rowids[i]` is the never-
4821 /// reused [`RowId`](row_header::RowId) of the row physically at
4822 /// slot `i`; `rowids.len() == rows.len()` joins the same load-
4823 /// bearing lock-step invariant as `headers`. Compaction (delete
4824 /// / vacuum) rebuilds all three vecs together so the id travels
4825 /// with the row while the slot shifts.
4826 ///
4827 /// Introduced additively: allocated + kept lock-step, but index
4828 /// locators still address rows by physical slot at this commit.
4829 /// Later phases migrate the lock table (C.4), HOT chains (D),
4830 /// and the WAL (Epic W) to address by `RowId`.
4831 ///
4832 /// Not yet serialised into the envelope — on load every row is
4833 /// assigned a fresh dense id `1..=len` (see `next_rowid`), which
4834 /// is sufficient while the id is process-local bookkeeping. The
4835 /// V6 envelope (Phase C.6) will persist ids so a WAL redo can
4836 /// name a row across restart.
4837 rowids: PersistentVec<row_header::RowId>,
4838 /// v7.37.15 (Phase C.1) — per-relation monotonic allocator for
4839 /// `rowids`. Starts at 1 (0 is the `RowId::UNASSIGNED` sentinel);
4840 /// every append takes `next_rowid` then increments. Never reused
4841 /// even after the row is deleted / vacuumed, so a stale lock /
4842 /// redo reference can be detected rather than silently aliasing a
4843 /// later row that reused the slot.
4844 ///
4845 /// 7.38.1 (S2.4, MATRIX #20 root cause) — the allocator is SHARED
4846 /// across every `clone()` of the relation (`Arc`), because the
4847 /// monotonic-never-reused promise is a LINEAGE invariant: each
4848 /// open transaction's shadow catalog is a clone, and when clones
4849 /// carried private counters two concurrent shadows minted the
4850 /// same id — duplicate rids in the base after both committed,
4851 /// aliasing every rid-addressed mechanism (locks, tombstones,
4852 /// redo, the rebase unique pre-check).
4853 next_rowid: alloc::sync::Arc<core::sync::atomic::AtomicU64>,
4854 /// v7.37.16 (autovacuum) — live count of tombstoned-but-present hot
4855 /// rows (`headers[i].xmax != XMAX_ALIVE`). Maintained incrementally:
4856 /// `mark_row_deleted` / `mark_rows_deleted` increment (the only
4857 /// tombstone producers), `delete_rows_no_index` recomputes over the
4858 /// survivors (it is the compaction hub every physical removal —
4859 /// including vacuum — flows through), and the v53 snapshot loader
4860 /// recounts verbatim-restored headers. Drives the engine's
4861 /// autovacuum threshold; not persisted (recomputed on load).
4862 dead_rows: u64,
4863 /// v7.39 (pg_stat knife A) — volatile per-table write counters
4864 /// backing `pg_stat_user_tables.n_tup_ins/upd/del`. Not persisted
4865 /// (PG's cumulative stats are shared-memory-volatile too — a
4866 /// restart zeroes them).
4867 stat_tup_ins: u64,
4868 stat_tup_upd: u64,
4869 stat_tup_del: u64,
4870 /// v7.39 (pg_stat knife B) — volatile scan counters
4871 /// (`seq_scan/seq_tup_read/idx_scan/idx_tup_fetch`). Atomics: the
4872 /// read paths that bump them hold only `&Table`.
4873 scan_stats: ScanStats,
4874 /// v7.39 (pg_stat knife C) — wall-clock stamps (unix µs, from the
4875 /// host ClockFn) for pg_stat_user_tables' last_autovacuum /
4876 /// last_analyze. Volatile, like PG's cumulative stats. SPG has no
4877 /// manual-VACUUM statement semantics, so last_vacuum stays NULL.
4878 last_autovacuum_us: Option<i64>,
4879 last_analyze_us: Option<i64>,
4880 indices: Vec<Index>,
4881 hot_bytes: u64,
4882 /// v6.7.0 — cached count of rows currently materialised in the
4883 /// cold tier via `RowLocator::Cold` entries across THIS table's
4884 /// indices. Populated by `ANALYZE` (walks every BTree index and
4885 /// counts Cold locators); the count survives until the next
4886 /// ANALYZE recomputes it. Surfaced via `spg_statistic.cold_row_count`
4887 /// and `spg_stat_segment.table_name`.
4888 ///
4889 /// Honest scope: this is a CACHED count, not a live one.
4890 /// Freezer / promote / DELETE don't currently update the cache
4891 /// incrementally — they invalidate it by setting the
4892 /// `cold_row_count_stale` flag, and the next ANALYZE re-walks.
4893 /// Incremental maintenance is a v6.7.x candidate if observation
4894 /// shows the ANALYZE walk cost dominates.
4895 cold_row_count: u64,
4896 /// v6.7.0 — set when the cached `cold_row_count` may be wrong
4897 /// because rows moved into / out of the cold tier since the last
4898 /// ANALYZE. The virtual-table surface reports the cached value
4899 /// regardless (operators run ANALYZE to refresh).
4900 cold_row_count_stale: bool,
4901 /// v7.34 (crash-recovery P0 #2) — row-level redo capture buffer.
4902 /// `None` (default, in-memory mode) captures nothing — zero overhead.
4903 /// `Some` (set by the engine when persistence is on, before a
4904 /// mutating call) makes `insert` / `update_row` / `delete_rows`
4905 /// record the physical [`RowChange`] they applied, which the engine
4906 /// drains after the statement and writes to the WAL in place of the
4907 /// SQL text. Transient: never serialized; a `Catalog::clone` between
4908 /// enable and drain copies it (cheap — empty in the steady state).
4909 redo_log: Option<Vec<RowChange>>,
4910 /// v7.39 (round 215) — per-`EXCLUDE`-constraint range-overlap indexes,
4911 /// one per single-`&&` constraint on an integer-keyable range column.
4912 /// Maintained incrementally on insert / update / rebuild (mirroring the
4913 /// BTree secondary indexes); NOT serialized — rebuilt from the schema's
4914 /// exclusion constraints on load. Empty for tables with no EXCLUDE
4915 /// constraint (the common case), so `Table::clone` pays nothing.
4916 excl_indexes: Vec<ExclRangeIndex>,
4917 /// v7.38.2 (R2) — incremental write-set track for the RC rebase.
4918 /// `extract_tx_writeset` used to full-scan every header per call —
4919 /// ~200 µs on a 20k-row table, per in-transaction statement, every
4920 /// time a concurrent COMMIT moved the epoch; on tpcb's 100k-row
4921 /// accounts that scan was the c2 concurrency cliff itself. The
4922 /// three version-marking funnels (`insert_with_xmin`,
4923 /// `mark_row_deleted`, `mark_rows_deleted`) record here instead.
4924 ///
4925 /// One track per table, keyed by the LAST writer version: a shadow
4926 /// belongs to one transaction, so a different version claiming the
4927 /// table simply replaces the track (on the committed base that
4928 /// makes memory bounded by the last writer's footprint). Extraction
4929 /// verifies every recorded position still carries the version —
4930 /// any mismatch (compaction, inherited track, pre-track rows)
4931 /// falls back to the full scan, so the fast path can be wrong
4932 /// about NOTHING, only slow.
4933 tx_write_track: Option<TxWriteTrack>,
4934 /// v7.39 (round 493) — the snapshot floor below which a deleted row
4935 /// version is invisible to everyone, as of the statement now running.
4936 ///
4937 /// Runtime only: never serialised, and `0` (the default) prunes
4938 /// nothing, so any path that forgets to set it is merely slower, not
4939 /// wrong. The engine sets it from `vacuum_oldest_active()` — the same
4940 /// floor `vacuum` itself takes — before the statement's inserts.
4941 prune_horizon: u64,
4942}
4943
4944/// Catalog: insertion-ordered `Vec<Table>` for stable iter / serialize,
4945/// plus a `BTreeMap<String, usize>` sidecar index so `get` / `get_mut`
4946/// run in O(log n) instead of the old linear scan with per-element
4947/// string compares.
4948///
4949/// A pure `BTreeMap<String, Table>` was tried in an interim version
4950/// of v3.1.2 and regressed the single-table catalog benches by ~10%
4951/// (the per-element `BTreeMap` overhead outweighs the lookup win
4952/// when n is small). The sidecar shape preserves the insertion-order
4953/// iteration the on-disk encoding relies on and keeps `last_mut`
4954/// (used by the deserialize hot path) cheap.
4955/// v7.39 (pg_stat blks knife) — catalog-wide cold-tier read counter
4956/// backing pg_stat_database.blks_read. Row-granular (SPG has no 8 KB
4957/// page notion): one cold-segment row resolution = one "block read",
4958/// one hot row access = one "block hit" — the hit RATIO monitoring
4959/// dashboards compute keeps its meaning. Volatile like PG's stats.
4960#[derive(Debug, Default)]
4961pub struct ColdReadStats {
4962 pub cold_reads: core::sync::atomic::AtomicU64,
4963}
4964
4965impl Clone for ColdReadStats {
4966 fn clone(&self) -> Self {
4967 Self {
4968 cold_reads: core::sync::atomic::AtomicU64::new(
4969 self.cold_reads.load(core::sync::atomic::Ordering::Relaxed),
4970 ),
4971 }
4972 }
4973}
4974
4975/// 7.38.1 S3.1 (D4) — the non-table catalog families that carry a
4976/// per-transaction dirty window (see `Catalog::dirty_nontable`). One
4977/// entry class per side-map the poisoned-commit merge reconciles.
4978#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
4979pub enum NonTableKind {
4980 Sequence,
4981 View,
4982 MaterializedView,
4983 EnumType,
4984 DomainType,
4985 CompositeType,
4986}
4987
4988#[derive(Debug, Clone, Default)]
4989pub struct Catalog {
4990 /// v7.39 (pg_stat blks knife) — see [`ColdReadStats`].
4991 pub cold_read_stats: ColdReadStats,
4992 tables: Vec<Table>,
4993 /// `name → tables[index]`. Kept in lock-step with `tables`.
4994 /// `create_table` is the only write path.
4995 by_name: BTreeMap<String, usize>,
4996 /// v7.39 (round 436) — the current session's temporary-table namespace.
4997 /// A temp table is stored under `<prefix><name>`, and every lookup tries
4998 /// that first: exactly PG's `pg_temp` search-path rule, and MySQL's
4999 /// "a TEMPORARY table shadows a permanent one of the same name".
5000 ///
5001 /// Process-local, never serialised: the engine sets it per session, and
5002 /// a catalog read back from disk starts with none. Kept here rather than
5003 /// at each of the ~170 engine call sites because `by_name` is private —
5004 /// this is the ONE place a table name becomes an index.
5005 temp_prefix: Option<String>,
5006 /// v7.39 (round 496) — the names of tables this catalog handle has had
5007 /// changed since the set was last cleared.
5008 ///
5009 /// Runtime only, never serialised. A transaction's shadow catalog
5010 /// clears it at BEGIN, so at COMMIT the set is exactly the tables the
5011 /// transaction changed — which is what lets a commit that cannot use
5012 /// the row-level merge install only those tables instead of the whole
5013 /// catalog, leaving another session's concurrent work in place.
5014 ///
5015 /// Recorded where the change actually happens (`get_mut`,
5016 /// `create_table`, `drop_table`) rather than from the statement
5017 /// classifier: round 494 tried classification for a correctness gate
5018 /// and it was wrong, because `SELECT lo_write(…)` reads as read-only.
5019 dirty_tables: alloc::collections::BTreeSet<String>,
5020 /// 7.38.1 S3.1 (D4) — the non-table twin of `dirty_tables`: which
5021 /// sequences / views / matviews / enum / domain / composite types
5022 /// THIS window created, altered, renamed or dropped. Counter
5023 /// advances (`nextval`) deliberately do NOT record — counter
5024 /// values merge via `sequence_counters` / `restore_sequence_
5025 /// counters`, and a tx that only consumed ids must not shadow a
5026 /// neighbour's ALTER SEQUENCE. Cleared by `clear_dirty_tables`
5027 /// (one window, both records).
5028 dirty_nontable: alloc::collections::BTreeSet<(NonTableKind, String)>,
5029 /// v7.37.15 (Phase C.1) — monotonic allocator for stable
5030 /// [`RelId`](row_header::RelId)s. Pre-incremented on each
5031 /// `create_table` so real ids start at 1 (0 is `UNASSIGNED`);
5032 /// never reused even after `DROP TABLE`, so a stale lock / redo
5033 /// reference is detectable. Process-local bookkeeping — not yet
5034 /// serialised; `deserialize` re-assigns dense ids on load (the
5035 /// V6 envelope, Phase C.6, will round-trip real ids).
5036 next_rel_id: u64,
5037 /// v5.1: in-memory cold-tier segments. Side-loaded via
5038 /// [`Catalog::load_segment_bytes`] — they live outside the
5039 /// catalog snapshot (caller persists them as separate files
5040 /// and re-loads on boot, until v5.3's `CatalogManifest` makes
5041 /// that wiring automatic). `RowLocator::Cold { segment_id, .. }`
5042 /// indexes this `Vec`. Cleared on `Catalog::new` / fresh
5043 /// `deserialize`.
5044 ///
5045 /// `Arc` wrap keeps `Catalog::clone` at O(N segments) bumps
5046 /// (rather than O(total segment bytes) memcpy) so the v4.42
5047 /// group-commit pre-image rollback invariant — clone is
5048 /// effectively free — survives the cold-tier addition.
5049 ///
5050 /// v6.7.3 — slots became `Option<…>` so cold-segment compaction
5051 /// can tombstone merged sources without breaking the
5052 /// `segment_id = index_into_vec` contract that on-disk
5053 /// `RowLocator::Cold { segment_id }` already serialized.
5054 /// `None` slot = the segment was retired by compaction; the
5055 /// physical file may still be on disk (next CHECKPOINT writes
5056 /// a manifest that no longer lists it, and the file becomes
5057 /// an orphan eligible for offline cleanup).
5058 cold_segments: Vec<Option<Arc<OwnedSegment>>>,
5059 /// v7.12.4 — user-defined functions (PL/pgSQL + SQL).
5060 /// Keyed by function name (PG overloading is out of scope).
5061 /// Bodies are stored as the raw source text the parser saw
5062 /// between `$$ ... $$`; the engine re-parses on each
5063 /// invocation. This keeps `spg-storage` free of `spg-sql`
5064 /// dependency — same pattern as partial-index predicates.
5065 functions: BTreeMap<String, FunctionDef>,
5066 /// v7.12.4 — triggers in insertion order. PG18-measured (round
5067 /// 753): PG fires same-event triggers in NAME order (a_trig
5068 /// before z_trig regardless of creation order); SPG fires in
5069 /// insertion order — a real divergence, ledgered as F31-B2.
5070 triggers: Vec<TriggerDef>,
5071 /// v7.39 (round 139) — query-rewrite RULEs, flat like triggers.
5072 rules: Vec<RuleDef>,
5073 /// v7.39 (round 280) — extended-statistics objects. Recorded so a
5074 /// pg_dump restores them and reflection reports them; the planner
5075 /// does not consult them yet.
5076 statistics_ext: Vec<StatisticsExtDef>,
5077 /// v7.39 (round 287) — server-side large objects, keyed by OID.
5078 /// PG stores them as 2 KB pages in `pg_largeobject`; the page split
5079 /// is a storage detail of ITS heap, so SPG holds the whole byte
5080 /// string and renders the pages on read. What must match is the
5081 /// observable surface: the OIDs, the bytes, and the page rows.
5082 large_objects: alloc::collections::BTreeMap<u32, Vec<u8>>,
5083 /// v7.17.0 — catalogued SEQUENCE objects (Phase 1.1). Each
5084 /// `nextval(name)` reaches in here, atomically increments
5085 /// `last_value` / flips `is_called`, returns the new value.
5086 /// Persisted in catalog FILE_VERSION 26+; older catalogs
5087 /// deserialise with an empty map.
5088 sequences: BTreeMap<String, SequenceDef>,
5089 /// v7.39 (read01 round 60) — the `public` schema's ACL (PG
5090 /// `pg_namespace.nspacl`). EMPTY = PG's default, which is not "nothing":
5091 /// PUBLIC holds USAGE and the owner holds USAGE + CREATE. Materialised on
5092 /// the first GRANT / REVOKE, exactly like a table's relacl.
5093 schema_acl: Vec<AclItem>,
5094 /// v7.39 (read01 round 60) — the database's ACL. EMPTY = PG's default:
5095 /// PUBLIC holds CONNECT + TEMPORARY, the owner holds all three.
5096 database_acl: Vec<AclItem>,
5097 /// v7.17.0 — catalogued VIEW objects (Phase 1.2). Each
5098 /// `SELECT FROM v` at engine exec-time looks up `v` here and
5099 /// prepends the view body as a synthetic CTE. Persisted in
5100 /// catalog FILE_VERSION 27+; older catalogs deserialise with
5101 /// an empty map.
5102 views: BTreeMap<String, ViewDef>,
5103 /// v7.17.0 — catalogued MATERIALIZED VIEW source registry
5104 /// (Phase 1.3). Maps name → SELECT source. The materialised
5105 /// rows themselves live as a regular `Table` with the same
5106 /// name; REFRESH re-parses + re-executes the source against
5107 /// the table. Persisted in catalog FILE_VERSION 28+;
5108 /// older catalogs deserialise with an empty map.
5109 materialized_views: BTreeMap<String, String>,
5110 /// v7.17.0 — catalogued user-defined ENUM types (Phase 1.4).
5111 /// Maps name → label list. Columns reference these by name
5112 /// via `ColumnSchema.user_enum_type`. Persisted in catalog
5113 /// FILE_VERSION 29+; older catalogs deserialise with an empty
5114 /// map.
5115 enum_types: BTreeMap<String, EnumDef>,
5116 /// v7.17.0 — catalogued user-defined DOMAIN types (Phase 1.5).
5117 /// Maps name → base + CHECK constraints. Columns reference
5118 /// these by name via `ColumnSchema.user_domain_type`.
5119 /// Persisted in catalog FILE_VERSION 30+; older catalogs
5120 /// deserialise with an empty map.
5121 domain_types: BTreeMap<String, DomainDef>,
5122 /// v7.39 (read01 round 50) — `COMMENT ON <kind> <obj> IS '…'` store.
5123 /// Keyed by a canonical `"<kind>:<name>"` string (`"table:t"`,
5124 /// `"column:t.c"`, `"index:i"`, `"view:v"`, …) so a new commentable
5125 /// object kind needs no schema change. `COMMENT … IS NULL` removes the
5126 /// entry. Persisted in catalog FILE_VERSION 61+; older catalogs
5127 /// deserialise with an empty map. Read back by obj_description /
5128 /// col_description and the pg_description view.
5129 comments: BTreeMap<String, String>,
5130 /// v7.39 (round 547) — PG's `pg_db_role_setting`: the GUC defaults
5131 /// `ALTER ROLE … SET` / `ALTER DATABASE … SET` record, applied when
5132 /// a session starts.
5133 ///
5134 /// Keyed exactly as PG keys it — `(database, role)` where an empty
5135 /// name is PG's oid 0, meaning "all". So `ALTER ROLE ALL SET` is
5136 /// `("", "")`, `ALTER DATABASE d SET` is `(d, "")`, `ALTER ROLE r
5137 /// SET` is `("", r)` and `ALTER ROLE r IN DATABASE d SET` is
5138 /// `(d, r)`. The value is that scope's parameter list.
5139 db_role_settings: BTreeMap<(String, String), BTreeMap<String, String>>,
5140 /// v7.39 (round 550) — replication slots, by name.
5141 ///
5142 /// A slot in PG is two things: a named record, and a reservation
5143 /// that holds WAL back. SPG keeps the record — which is what every
5144 /// setup script and monitoring query reads — and reports
5145 /// `wal_status = 'unreserved'`, PG's own word for a slot that no
5146 /// longer holds WAL. The whole family used to answer NULL and
5147 /// report success, so `pg_drop_replication_slot('nosuchslot')` said
5148 /// it worked and a setup script created nothing.
5149 ///
5150 /// Value: (plugin, slot_type). `plugin` is empty for a physical slot.
5151 replication_slots: BTreeMap<String, (String, String)>,
5152 /// v7.38.18 (S1) — the collation this database was CREATED with, and
5153 /// the one every text column that declares none is compared under.
5154 ///
5155 /// `None` means `C`, which is what every database written by every
5156 /// earlier version was built with — so an upgrade changes no answer
5157 /// and rebuilds no index. That is the whole migration story, and it
5158 /// is why this is an `Option` rather than a `String` defaulting to
5159 /// `"C"`.
5160 ///
5161 /// Set once, at creation, and never after. PostgreSQL refuses
5162 /// `ALTER DATABASE … LC_COLLATE` and the reason is the one that
5163 /// matters here too: every index key in this database was built
5164 /// under this collation, so it cannot move out from under them.
5165 /// See `docs/DESIGN-2026-08-23-collation.md`.
5166 db_collation: Option<String>,
5167 /// v7.38.19 — every name a `CREATE DATABASE` has asked for.
5168 ///
5169 /// SPG serves one database and answers to any name, so the statement
5170 /// has always been a no-op for naming. `pg_database` then listed one
5171 /// row -- whatever name the current session connected with -- so a
5172 /// database that had just been created, and could be connected to,
5173 /// was absent from the catalogue. `psql \l`, a migration tool asking
5174 /// "does this database exist", and a backup script that enumerates
5175 /// all read that table.
5176 ///
5177 /// Reported by sentori against 7.38.18. Runtime only, like
5178 /// `db_collation`: the statement is audited whenever it records a
5179 /// name, so replay rebuilds the set.
5180 created_databases: alloc::collections::BTreeSet<String>,
5181 /// v7.37.42-T2 ζ-B — catalogued user-defined COMPOSITE types
5182 /// (`CREATE TYPE name AS (field_name field_type, …)`). Columns
5183 /// reference these by name via
5184 /// `ColumnSchema.user_composite_type` (parallel to
5185 /// `user_enum_type` / `user_domain_type`). Persisted in catalog
5186 /// FILE_VERSION 52+; older catalogs deserialise with an empty
5187 /// map.
5188 composite_types: BTreeMap<String, CompositeDef>,
5189 /// v7.17.0 — schema-namespace registry (Phase 1.6). Tracks
5190 /// which schemas exist. `public`, `pg_catalog`, and
5191 /// `information_schema` are built-in and always present.
5192 /// Schema-qualified table references still strip the prefix
5193 /// at lookup time per v7.16-and-earlier — full
5194 /// schema-as-isolation is v7.18+ scope. Persisted in catalog
5195 /// FILE_VERSION 31+; older catalogs deserialise with just
5196 /// the built-ins.
5197 schemas: alloc::collections::BTreeSet<String>,
5198}
5199
5200/// v7.12.4 — catalogued user-defined function. `body` is the raw
5201/// source text between `$$ ... $$`; the engine re-parses it on
5202/// invocation. This keeps the storage codec stable when the
5203/// PL/pgSQL surface grows (no breaking-change risk on the disk
5204/// format).
5205// v7.39 (round 322, V46) — no longer `Eq`: COST / ROWS are f64, as in PG.
5206#[derive(Debug, Clone, PartialEq)]
5207pub struct FunctionDef {
5208 pub name: String,
5209 /// Display form of the argument list, e.g.
5210 /// `"(name TEXT, ts TIMESTAMP)"`. Empty `"()"` for the trigger
5211 /// function shape. Parser-side canonicalised before storage.
5212 pub args_repr: String,
5213 /// Display form of the return type, e.g. `"TRIGGER"` /
5214 /// `"INT"` / `"SETOF text"`. The engine special-cases
5215 /// `"TRIGGER"` (case-insensitive) to gate trigger-only
5216 /// semantics (NEW/OLD).
5217 pub returns: String,
5218 /// `LANGUAGE` clause, lowercased. `"plpgsql"` / `"sql"`.
5219 pub language: String,
5220 /// Source body of the function. PL/pgSQL: includes the
5221 /// surrounding `BEGIN ... END;`. SQL: includes the
5222 /// statement(s). The engine re-parses on invocation; bad
5223 /// bodies surface as a parse error at CALL time, not CREATE.
5224 pub body: String,
5225 /// v7.39 (read01 round 61) — the role that ran CREATE FUNCTION.
5226 pub owner: Option<String>,
5227 /// v7.39 (read01 round 61) — explicit GRANTs (PG `pg_proc.proacl`). EMPTY
5228 /// is NOT "nobody may call it": PG grants EXECUTE to PUBLIC by default, and
5229 /// leaves proacl NULL to say so. The list materialises on the first
5230 /// GRANT / REVOKE.
5231 pub acl: Vec<AclItem>,
5232 /// v7.39 (round 322, V46) — `IMMUTABLE` / `STRICT` / `PARALLEL SAFE` /
5233 /// `SECURITY DEFINER` / `LEAKPROOF` / `COST` / `ROWS`. `strict` is the
5234 /// only one with execution semantics today (a NULL argument yields a
5235 /// NULL result without running the body); the rest are recorded so
5236 /// `pg_get_functiondef` and `pg_proc` report what was declared.
5237 pub volatility: u8,
5238 pub strict: bool,
5239 pub security_definer: bool,
5240 pub leakproof: bool,
5241 pub parallel: u8,
5242 pub cost: Option<f64>,
5243 pub rows: Option<f64>,
5244}
5245
5246/// v7.39 (round 322, V46) — `FunctionDef.volatility` codes: PG's
5247/// `pg_proc.provolatile` letters.
5248pub const FN_VOLATILE: u8 = b'v';
5249pub const FN_IMMUTABLE: u8 = b'i';
5250pub const FN_STABLE: u8 = b's';
5251
5252/// v7.39 (round 322, V46) — `FunctionDef.parallel` codes: PG's
5253/// `pg_proc.proparallel` letters.
5254pub const FN_PARALLEL_UNSAFE: u8 = b'u';
5255pub const FN_PARALLEL_RESTRICTED: u8 = b'r';
5256pub const FN_PARALLEL_SAFE: u8 = b's';
5257
5258/// v7.39 (round 315, V19) — which catalogued function does a persisted
5259/// ACL key refer to?
5260///
5261/// The key was computed by whichever formula was current when the image
5262/// was written, and the multi-word fix changed that formula for bare
5263/// types like `double precision`. A miss therefore does NOT mean "no
5264/// such function": an older image's key would land nowhere and its owner
5265/// and grants would be dropped in silence. Exact match first, then the
5266/// pre-fix formula.
5267#[must_use]
5268pub fn resolve_stored_function_key(
5269 functions: &BTreeMap<String, FunctionDef>,
5270 stored: &str,
5271) -> Option<String> {
5272 if functions.contains_key(stored) {
5273 return Some(stored.to_string());
5274 }
5275 functions
5276 .values()
5277 .find(|f| function_signature_key_legacy(&f.name, &f.args_repr) == stored)
5278 .map(|f| function_signature_key(&f.name, &f.args_repr))
5279}
5280
5281/// v7.39 (round 344, V49) — re-exported from [`spg_sql`], which owns the
5282/// SQL type spellings. This crate carried a byte-identical copy because
5283/// the two were siblings that did not depend on each other; spg-sql is a
5284/// dependency-free leaf, so the dependency is acyclic and the publish
5285/// order already puts it first. One list, one place to keep it right.
5286pub use spg_sql::parser::is_multiword_type_phrase;
5287
5288/// v7.39 (round 315, V19) — the signature key as computed BEFORE the
5289/// multi-word fix, used only to recognise what an older image wrote.
5290///
5291/// The function catalogue recomputes its keys from the stored name and
5292/// argument text on load, so it needs no migration. The ACL block does
5293/// not: it persists the computed key as a string and matches on it. A
5294/// key that changed shape would simply fail to match, and the owner and
5295/// grants would be dropped without a word — so the loader falls back to
5296/// this when the stored key finds nothing.
5297#[must_use]
5298pub fn function_signature_key_legacy(name: &str, args_repr: &str) -> String {
5299 let inner = args_repr
5300 .trim()
5301 .trim_start_matches('(')
5302 .trim_end_matches(')');
5303 let types: Vec<String> = if inner.trim().is_empty() {
5304 Vec::new()
5305 } else {
5306 inner
5307 .split(',')
5308 .map(|part| {
5309 let mut words: Vec<&str> = part.split_whitespace().collect();
5310 if !words.is_empty()
5311 && (words[0].eq_ignore_ascii_case("OUT")
5312 || words[0].eq_ignore_ascii_case("INOUT"))
5313 {
5314 words.remove(0);
5315 }
5316 let ty = if words.len() >= 2 {
5317 words[1..].join(" ")
5318 } else {
5319 words.first().map_or(String::new(), |w| (*w).to_string())
5320 };
5321 normalize_type_name(&ty)
5322 })
5323 .collect()
5324 };
5325 format!("{}({})", name.to_ascii_lowercase(), types.join(","))
5326}
5327
5328pub fn function_signature_key(name: &str, args_repr: &str) -> String {
5329 let types = function_arg_types(args_repr);
5330 format!("{}({})", name.to_ascii_lowercase(), types.join(","))
5331}
5332
5333/// The declared argument TYPES of a function, out of its `args_repr`
5334/// (`"(x INT, y DOUBLE PRECISION)"` → `["int", "float"]`). An entry may be a
5335/// bare type with no name (`"(INT)"`).
5336#[must_use]
5337pub fn function_arg_types(args_repr: &str) -> Vec<String> {
5338 let inner = args_repr
5339 .trim()
5340 .trim_start_matches('(')
5341 .trim_end_matches(')');
5342 if inner.trim().is_empty() {
5343 return Vec::new();
5344 }
5345 inner
5346 .split(',')
5347 .map(|part| {
5348 let mut words: Vec<&str> = part.split_whitespace().collect();
5349 // `OUT x INT` / `INOUT x INT` — the mode is not part of the type.
5350 if !words.is_empty()
5351 && (words[0].eq_ignore_ascii_case("OUT") || words[0].eq_ignore_ascii_case("INOUT"))
5352 {
5353 words.remove(0);
5354 }
5355 // v7.39 (round 315, V19) — two or more words is USUALLY
5356 // `name TYPE`, but not when the type itself is spelled in
5357 // several words. `double precision` was read as a parameter
5358 // named "double" of type "precision", so it keyed differently
5359 // from `x double precision` — the same signature written two
5360 // ways did not resolve to the same function. Decide by asking
5361 // whether the whole phrase names a type first; only then is
5362 // the leading word a parameter name.
5363 let whole = words.join(" ");
5364 let ty = if words.len() >= 2 && !is_multiword_type_phrase(&whole) {
5365 words[1..].join(" ")
5366 } else {
5367 whole
5368 };
5369 normalize_type_name(&ty)
5370 })
5371 .collect()
5372}
5373
5374/// v7.39 (read01 round 65) — the declared argument NAMES of a function (`""` for
5375/// a bare type with no name).
5376#[must_use]
5377pub fn function_arg_names(args_repr: &str) -> Vec<String> {
5378 let inner = args_repr
5379 .trim()
5380 .trim_start_matches('(')
5381 .trim_end_matches(')');
5382 if inner.trim().is_empty() {
5383 return Vec::new();
5384 }
5385 inner
5386 .split(',')
5387 .map(|part| {
5388 let mut words: Vec<&str> = part.split_whitespace().collect();
5389 if !words.is_empty()
5390 && (words[0].eq_ignore_ascii_case("OUT") || words[0].eq_ignore_ascii_case("INOUT"))
5391 {
5392 words.remove(0);
5393 }
5394 if words.len() >= 2 {
5395 words[0].to_string()
5396 } else {
5397 String::new()
5398 }
5399 })
5400 .collect()
5401}
5402
5403/// Fold PG's type aliases so a signature key is stable across spellings.
5404/// Unknown names pass through lower-cased — consistency is what the key needs.
5405#[must_use]
5406pub fn normalize_type_name(ty: &str) -> String {
5407 let t = ty.trim().to_ascii_lowercase();
5408 // Peel a precision/length modifier: `numeric(10,2)`, `varchar(64)`.
5409 let base = t.split_once('(').map_or(t.as_str(), |(h, _)| h).trim();
5410 match base {
5411 "int" | "int4" | "integer" => "int",
5412 "bigint" | "int8" => "bigint",
5413 "smallint" | "int2" => "smallint",
5414 "text" | "varchar" | "character varying" | "char" | "character" | "bpchar" => "text",
5415 "bool" | "boolean" => "bool",
5416 "float" | "float8" | "double precision" => "float",
5417 "real" | "float4" => "real",
5418 "numeric" | "decimal" => "numeric",
5419 "timestamptz" | "timestamp with time zone" => "timestamptz",
5420 "timestamp" | "timestamp without time zone" => "timestamp",
5421 other => other,
5422 }
5423 .to_string()
5424}
5425
5426/// v7.12.4 — catalogued trigger. References its function by
5427/// name; the function must exist at TRIGGER creation time
5428/// (forward references are deferred to v7.12.5+).
5429#[derive(Debug, Clone, PartialEq, Eq)]
5430pub struct TriggerDef {
5431 pub name: String,
5432 /// Watched table. Trigger is dropped when the table drops.
5433 pub table: String,
5434 /// `"BEFORE"` / `"AFTER"` / `"INSTEAD OF"`. Stored as the
5435 /// uppercased keyword so deserialised catalogs round-trip
5436 /// without canonicalisation surprises.
5437 pub timing: String,
5438 /// Each entry is one of `"INSERT"` / `"UPDATE"` / `"DELETE"`
5439 /// / `"TRUNCATE"`. `INSERT OR UPDATE` parses to two entries.
5440 pub events: Vec<String>,
5441 /// `"ROW"` / `"STATEMENT"`. v7.12.4 ships `"ROW"` only;
5442 /// `"STATEMENT"` parses and persists but the executor
5443 /// refuses it at trigger fire time.
5444 pub for_each: String,
5445 /// Name of the PL/pgSQL function to invoke.
5446 pub function: String,
5447 /// v7.13.0 — `UPDATE OF col, col, …` column-list filter
5448 /// (mailrs round-5 G7). Non-empty means the trigger fires
5449 /// only when at least one of these columns appears in the
5450 /// UPDATE's SET list. Empty = no column filter. Stored in
5451 /// catalog FILE_VERSION 23+; older catalogs deserialise with
5452 /// an empty vec.
5453 pub update_columns: Vec<String>,
5454 /// v7.16.1 — whether the trigger fires when its watched
5455 /// event occurs. Toggled by `ALTER TABLE … { ENABLE |
5456 /// DISABLE } TRIGGER …`; pg_dump --disable-triggers wraps
5457 /// every data block with a DISABLE/ENABLE pair so the
5458 /// rows already-computed in prod don't get re-rewritten.
5459 /// Defaults to `true` at CREATE TRIGGER time. Stored in
5460 /// catalog FILE_VERSION 25+; older catalogs deserialise
5461 /// with `enabled = true`.
5462 pub enabled: bool,
5463 /// v7.39 (round 138) — the deparsed `WHEN ( condition )` predicate text
5464 /// (re-parsed at fire time to filter row triggers). Empty = no WHEN.
5465 /// Persisted from FILE_VERSION 70; older catalogs read back empty.
5466 pub when_condition: String,
5467}
5468
5469/// v7.39 (round 280) — one `CREATE STATISTICS` object.
5470#[derive(Debug, Clone, PartialEq, Eq)]
5471pub struct StatisticsExtDef {
5472 pub name: String,
5473 pub table: String,
5474 /// PG's single-letter kinds: `d` ndistinct, `f` dependencies,
5475 /// `m` mcv. PG's default set is all three.
5476 pub kinds: Vec<String>,
5477 pub columns: Vec<String>,
5478}
5479
5480/// v7.39 (round 139) — a catalogued query-rewrite RULE. Stored flat like
5481/// `TriggerDef`, keyed by `(name, table)`. Command / WHEN text is deparsed SQL
5482/// re-parsed at rewrite time (the same round-trip trick as
5483/// `TriggerDef.when_condition`). Persisted from FILE_VERSION 71.
5484#[derive(Debug, Clone, PartialEq, Eq)]
5485pub struct RuleDef {
5486 pub name: String,
5487 pub table: String,
5488 /// Event keyword, uppercased: `INSERT` / `UPDATE` / `DELETE` / `SELECT`.
5489 pub event: String,
5490 /// `true` = `DO INSTEAD`, `false` = `DO ALSO`.
5491 pub instead: bool,
5492 /// Deparsed `WHERE` predicate text; empty = unconditional.
5493 pub when_condition: String,
5494 /// Deparsed DO command statements; empty = `NOTHING`.
5495 pub commands: Vec<String>,
5496}
5497
5498/// v7.17.0 — catalogued SEQUENCE. PG semantics: a counter object
5499/// returning monotonically increasing values via `nextval(name)`.
5500/// `last_value` is the most recent value handed out; `is_called`
5501/// is false until the first `nextval`/`setval`. Stored separately
5502/// from tables in the catalog.
5503#[derive(Debug, Clone, PartialEq, Eq)]
5504pub struct SequenceDef {
5505 pub name: String,
5506 /// Data type — narrows the i64 range. PG default BIGINT.
5507 pub data_type: SequenceDataType,
5508 pub start: i64,
5509 pub increment: i64,
5510 pub min_value: i64,
5511 pub max_value: i64,
5512 pub cache: i64,
5513 pub cycle: bool,
5514 /// `OWNED BY` target — `(table, column)` or NONE.
5515 pub owned_by: Option<(String, String)>,
5516 /// Most recently handed-out value. Meaningless when
5517 /// `is_called == false`; in that case the NEXT `nextval`
5518 /// will return `start`.
5519 pub last_value: i64,
5520 pub is_called: bool,
5521 /// v7.39 (read01 round 60) — the role that ran CREATE SEQUENCE. `None` = an
5522 /// image written before FILE_VERSION 66, which predates sequence owners.
5523 pub owner: Option<String>,
5524 /// v7.39 (read01 round 60) — explicit GRANTs on this sequence. A sequence's
5525 /// meaningful privileges are SELECT (`currval`), UPDATE (`setval`) and
5526 /// USAGE (`nextval`).
5527 pub acl: Vec<AclItem>,
5528}
5529
5530/// v7.17.0 — sequence integer width.
5531#[derive(Debug, Clone, Copy, PartialEq, Eq)]
5532pub enum SequenceDataType {
5533 SmallInt,
5534 Int,
5535 BigInt,
5536}
5537
5538/// v7.17.0 Phase 1.6 — built-in schema names that every Catalog
5539/// understands without an explicit CREATE SCHEMA. Used by
5540/// [`Catalog::schema_exists`] and the engine's schema-qualified
5541/// lookup path.
5542#[must_use]
5543pub fn is_builtin_schema(name: &str) -> bool {
5544 name.eq_ignore_ascii_case("public")
5545 || name.eq_ignore_ascii_case("pg_catalog")
5546 || name.eq_ignore_ascii_case("information_schema")
5547}
5548
5549/// v7.17.0 — parse a PG-canonical UUID text representation into the
5550/// 16-byte network-order layout used by `Value::Uuid`. Accepted input
5551/// shapes (all case-insensitive):
5552/// * Canonical hyphenated 8-4-4-4-12 (`550e8400-e29b-41d4-a716-446655440000`)
5553/// * Unhyphenated 32-char hex (`550e8400e29b41d4a716446655440000`)
5554/// * Either form wrapped in `{ ... }`
5555///
5556/// Returns `None` for any malformed input (wrong length, non-hex
5557/// characters, misplaced hyphens). The caller surfaces a SQL error
5558/// at coercion time — silent acceptance of garbage would mask
5559/// application bugs and is exactly the divergence from PG that
5560/// breaks the 0-change cutover promise.
5561#[must_use]
5562pub fn parse_uuid_str(input: &str) -> Option<[u8; 16]> {
5563 let s = input.trim();
5564 // Strip surrounding braces if present.
5565 let s = if let Some(inner) = s.strip_prefix('{').and_then(|x| x.strip_suffix('}')) {
5566 inner
5567 } else {
5568 s
5569 };
5570 // Two valid shapes after braces are stripped: 32 hex chars or
5571 // the canonical 36-char hyphenated form.
5572 let hex: String = match s.len() {
5573 32 => s.to_ascii_lowercase(),
5574 36 => {
5575 // Hyphens must be exactly at positions 8, 13, 18, 23.
5576 let b = s.as_bytes();
5577 if b[8] != b'-' || b[13] != b'-' || b[18] != b'-' || b[23] != b'-' {
5578 return None;
5579 }
5580 let mut out = String::with_capacity(32);
5581 out.push_str(&s[0..8]);
5582 out.push_str(&s[9..13]);
5583 out.push_str(&s[14..18]);
5584 out.push_str(&s[19..23]);
5585 out.push_str(&s[24..36]);
5586 out.make_ascii_lowercase();
5587 out
5588 }
5589 _ => return None,
5590 };
5591 let bytes = hex.as_bytes();
5592 let mut out = [0u8; 16];
5593 for i in 0..16 {
5594 let hi = hex_nibble(bytes[i * 2])?;
5595 let lo = hex_nibble(bytes[i * 2 + 1])?;
5596 out[i] = (hi << 4) | lo;
5597 }
5598 Some(out)
5599}
5600
5601fn hex_nibble(b: u8) -> Option<u8> {
5602 match b {
5603 b'0'..=b'9' => Some(b - b'0'),
5604 b'a'..=b'f' => Some(10 + b - b'a'),
5605 b'A'..=b'F' => Some(10 + b - b'A'),
5606 _ => None,
5607 }
5608}
5609
5610/// v7.17.0 — render a `Value::Uuid` payload as the canonical
5611/// lowercase 8-4-4-4-12 hyphenated form PG `text` cast surfaces.
5612#[must_use]
5613pub fn format_uuid(b: &[u8; 16]) -> String {
5614 const HEX: &[u8; 16] = b"0123456789abcdef";
5615 let mut out = String::with_capacity(36);
5616 for (i, byte) in b.iter().enumerate() {
5617 if matches!(i, 4 | 6 | 8 | 10) {
5618 out.push('-');
5619 }
5620 out.push(HEX[(byte >> 4) as usize] as char);
5621 out.push(HEX[(byte & 0x0f) as usize] as char);
5622 }
5623 out
5624}
5625
5626/// v7.17.0 Phase 1.5 — catalogued user-defined DOMAIN. A domain
5627/// is a named CHECK-constrained alias over a built-in type;
5628/// columns bound to it inherit the base type plus the CHECK
5629/// predicates + NOT NULL + DEFAULT at INSERT/UPDATE time.
5630/// v7.37.17 (Phase E RC rebase) — the write-set one writer version left
5631/// on a table, addressed by stable [`row_header::RowId`]s so it can be
5632/// replayed onto a fresher clone of the relation whose physical slots
5633/// differ. Produced by [`Table::extract_tx_writeset`], consumed by
5634/// [`Table::replay_tx_writeset`].
5635#[derive(Debug, Clone, Default)]
5636pub struct TxWriteSet {
5637 /// INSERTs and UPDATE-new-versions (`header.xmin == v`).
5638 pub inserted: Vec<(row_header::RowId, Row<'static>)>,
5639 /// DELETE / UPDATE-old-version targets (`header.xmax == v`).
5640 pub tombstoned: Vec<row_header::RowId>,
5641}
5642
5643impl TxWriteSet {
5644 #[must_use]
5645 pub fn is_empty(&self) -> bool {
5646 self.inserted.is_empty() && self.tombstoned.is_empty()
5647 }
5648}
5649
5650/// v7.39 (round 260) — one named CHECK on a domain. PG auto-names an
5651/// unnamed one `<domain>_check`, then `_check1`, `_check2`, … (probed).
5652#[derive(Debug, Clone, PartialEq, Eq)]
5653pub struct DomainCheck {
5654 pub name: String,
5655 /// The predicate source, referencing the pseudo-column `VALUE`.
5656 pub expr: String,
5657}
5658
5659/// `default` / `checks` are stored as Display-form source so
5660/// `spg-storage` stays free of `spg-sql` dependency — same
5661/// pattern as FunctionDef / ViewDef.
5662#[derive(Debug, Clone, PartialEq, Eq)]
5663pub struct DomainDef {
5664 pub name: String,
5665 pub base_type: DataType,
5666 pub nullable: bool,
5667 pub default: Option<String>,
5668 /// v7.39 (round 260) — each CHECK carries its constraint NAME, so
5669 /// `ALTER DOMAIN … DROP CONSTRAINT <name>` can find it and the
5670 /// violation message can report the constraint that actually failed.
5671 /// PG's auto-naming for an unnamed check is `<domain>_check`, then
5672 /// `_check1`, `_check2`, … (probed).
5673 pub checks: Vec<DomainCheck>,
5674 /// v7.39 (round 258/259) — when this domain was declared over ANOTHER
5675 /// domain (`CREATE DOMAIN child AS parent CHECK (…)`), the parent's
5676 /// name. `base_type` is the ultimate scalar type either way, so
5677 /// without this the parent's constraints were invisible and a value
5678 /// violating them was silently accepted. PG checks the whole chain,
5679 /// base-first, and an `ALTER DOMAIN` on the parent takes effect for
5680 /// the child immediately (probed) — so the chain is walked at check
5681 /// time rather than copied at CREATE time. Catalog FILE_VERSION 74+.
5682 pub base_domain: Option<String>,
5683}
5684
5685/// v7.17.0 Phase 1.4 — catalogued user-defined ENUM type. The
5686/// label vector is order-preserving (PG enum ordering follows the
5687/// declared order). At INSERT/UPDATE on a column bound to this
5688/// enum, the engine looks up the value against `labels` and
5689/// rejects non-members.
5690#[derive(Debug, Clone, PartialEq, Eq)]
5691pub struct EnumDef {
5692 pub name: String,
5693 pub labels: Vec<String>,
5694}
5695
5696/// v7.37.42-T2 ζ-B — catalogued user-defined COMPOSITE type
5697/// (`CREATE TYPE name AS (field_name field_type, ...)`). Order
5698/// matters: PG composite literals are positional, and SPG mirrors
5699/// that. Stored as ordered `(name, DataType)` pairs to keep the
5700/// codec straightforward and to allow eventual `Value::Composite`
5701/// bodies to encode positionally. Persisted in catalog FILE_VERSION
5702/// 52+; older catalogs deserialise with an empty composite_types
5703/// map. Composite types can be used as a column type by spelling
5704/// the composite's name; the resolution from
5705/// `ColumnSchema.user_composite_type = Some(name)` happens at the
5706/// engine boundary (parallel to `user_enum_type` /
5707/// `user_domain_type`). The dense storage shape — JSON-text body
5708/// keyed by the composite's field list — keeps the codec free of
5709/// recursive `Value` bodies until the full Value::Composite arena
5710/// migration in a later phase.
5711#[derive(Debug, Clone, PartialEq, Eq)]
5712pub struct CompositeDef {
5713 pub name: String,
5714 /// Ordered `(field_name, field_type)` pairs. PG composite
5715 /// literals are positional, so order is part of the type's
5716 /// identity.
5717 pub fields: Vec<(String, DataType)>,
5718 /// v7.39 (round 264) — parallel to `fields`: the USER type name of
5719 /// each field when it is itself a composite (or another named user
5720 /// type). `DataType` has no room for one, so a nested composite
5721 /// field resolved to the parser's Text placeholder and the inner
5722 /// record stayed TEXT — `(x).inner.street` errored, `pg_typeof`
5723 /// said text, and `row_to_json` nested a string instead of an
5724 /// object. Same shape as `ColumnSchema.user_composite_type` and
5725 /// `DomainDef.base_domain`. Catalog FILE_VERSION 76+; an older
5726 /// catalog reads all-None, which is what it meant.
5727 pub field_user_types: Vec<Option<String>>,
5728}
5729
5730/// v7.17.0 Phase 1.2 — catalogued VIEW. The body is stored as the
5731/// raw source text the parser saw between `AS` and the statement
5732/// terminator; the engine re-parses on each invocation. Same
5733/// pattern as `FunctionDef` — keeps `spg-storage` free of
5734/// `spg-sql` dependency.
5735#[derive(Debug, Clone, PartialEq, Eq)]
5736pub struct ViewDef {
5737 pub name: String,
5738 /// Optional `(col, col, …)` rename list. Empty when the body's
5739 /// projected names are used directly.
5740 pub columns: Vec<String>,
5741 /// Raw SELECT source. Display-rendered at storage time so the
5742 /// catalog round-trips a deterministic form regardless of
5743 /// whitespace / comments in the original input. Re-parsed at
5744 /// SELECT-from-view time to materialise as a synthetic CTE.
5745 pub body: String,
5746 /// v7.39 (round 132) — `WITH CHECK OPTION`: 0 = none, 1 = LOCAL,
5747 /// 2 = CASCADED. A storage-local u8 (no dependency on the SQL AST).
5748 /// Persisted from FILE_VERSION 69; older catalogs read back as 0.
5749 pub check_option: u8,
5750}
5751
5752impl SequenceDataType {
5753 /// PG default min/max per AS clause.
5754 pub fn default_bounds(self, increment_positive: bool) -> (i64, i64) {
5755 match self {
5756 Self::SmallInt => {
5757 if increment_positive {
5758 (1, i64::from(i16::MAX))
5759 } else {
5760 (i64::from(i16::MIN), -1)
5761 }
5762 }
5763 Self::Int => {
5764 if increment_positive {
5765 (1, i64::from(i32::MAX))
5766 } else {
5767 (i64::from(i32::MIN), -1)
5768 }
5769 }
5770 Self::BigInt => {
5771 if increment_positive {
5772 (1, i64::MAX)
5773 } else {
5774 (i64::MIN, -1)
5775 }
5776 }
5777 }
5778 }
5779}
5780
5781impl Catalog {
5782 /// v7.37.15 (Phase D) — fleet-wide vacuum pass. Walks every
5783 /// user table and reclaims rows whose delete-commit version is
5784 /// older than `oldest_active_snapshot`. Returns an aggregated
5785 /// report with per-table breakdown so hosts can emit metrics.
5786 ///
5787 /// `dry_run = true` reports the work without doing it. Use it
5788 /// to estimate the cost before scheduling a real pass.
5789 pub fn vacuum_all(
5790 &mut self,
5791 oldest_active_snapshot: u64,
5792 dry_run: bool,
5793 ) -> vacuum::VacuumReport {
5794 let mut total = vacuum::VacuumReport::default();
5795 // Snapshot the table names so we don't hold an immutable
5796 // borrow during the get_mut loop.
5797 let names: Vec<String> = self
5798 .tables
5799 .iter()
5800 .map(|t| t.schema().name.clone())
5801 .collect();
5802 for name in names {
5803 let Some(t) = self.get_mut(&name) else {
5804 continue;
5805 };
5806 let r = t.vacuum(oldest_active_snapshot, dry_run);
5807 if r.rows_reclaimed > 0 {
5808 total.per_table.push((name, r.rows_reclaimed));
5809 }
5810 total.rows_reclaimed += r.rows_reclaimed;
5811 total.rows_examined += r.rows_examined;
5812 }
5813 total
5814 }
5815
5816 pub const fn new() -> Self {
5817 Self {
5818 cold_read_stats: ColdReadStats {
5819 cold_reads: core::sync::atomic::AtomicU64::new(0),
5820 },
5821 tables: Vec::new(),
5822 by_name: BTreeMap::new(),
5823 temp_prefix: None,
5824 dirty_tables: alloc::collections::BTreeSet::new(),
5825 dirty_nontable: alloc::collections::BTreeSet::new(),
5826 next_rel_id: 0,
5827 cold_segments: Vec::new(),
5828 functions: BTreeMap::new(),
5829 triggers: Vec::new(),
5830 rules: Vec::new(),
5831 statistics_ext: Vec::new(),
5832 large_objects: alloc::collections::BTreeMap::new(),
5833 sequences: BTreeMap::new(),
5834 schema_acl: Vec::new(),
5835 database_acl: Vec::new(),
5836 views: BTreeMap::new(),
5837 materialized_views: BTreeMap::new(),
5838 enum_types: BTreeMap::new(),
5839 domain_types: BTreeMap::new(),
5840 comments: BTreeMap::new(),
5841 db_role_settings: BTreeMap::new(),
5842 replication_slots: BTreeMap::new(),
5843 db_collation: None,
5844 created_databases: alloc::collections::BTreeSet::new(),
5845 composite_types: BTreeMap::new(),
5846 schemas: alloc::collections::BTreeSet::new(),
5847 }
5848 }
5849
5850 /// v7.12.4 — read-only view of catalogued user-defined
5851 /// functions. Engine callers go through here to look up the
5852 /// function body before re-parsing it for invocation.
5853 pub const fn functions(&self) -> &BTreeMap<String, FunctionDef> {
5854 &self.functions
5855 }
5856
5857 /// v7.12.4 — register a new user-defined function. With
5858 /// `or_replace = false`, errors if the name is taken. The
5859 /// engine validates the body before passing it here.
5860 pub fn create_function(
5861 &mut self,
5862 def: FunctionDef,
5863 or_replace: bool,
5864 ) -> Result<(), StorageError> {
5865 // v7.39 (read01 round 62) — functions are keyed by SIGNATURE, not by
5866 // name: `f(int)` and `f(text)` are two functions, as in PG. Keying by
5867 // name alone made a second overload an "already exists" error — so a
5868 // pg_dump carrying an overload set could not restore — and, worse, a
5869 // call to one overload silently ran the other.
5870 let key = function_signature_key(&def.name, &def.args_repr);
5871 if !or_replace && self.functions.contains_key(&key) {
5872 return Err(StorageError::Corrupt(format!(
5873 "function {:?} already exists (drop or use CREATE OR REPLACE)",
5874 def.name
5875 )));
5876 }
5877 self.functions.insert(key, def);
5878 Ok(())
5879 }
5880
5881 /// v7.39 (read01 round 62) — every overload of `name`.
5882 #[must_use]
5883 pub fn functions_named(&self, name: &str) -> Vec<&FunctionDef> {
5884 self.functions
5885 .values()
5886 .filter(|f| f.name.eq_ignore_ascii_case(name))
5887 .collect()
5888 }
5889
5890 /// v7.39 (read01 round 62) — one overload, by its signature key.
5891 #[must_use]
5892 pub fn function_by_key(&self, key: &str) -> Option<&FunctionDef> {
5893 self.functions.get(key)
5894 }
5895
5896 /// v7.39 (read01 round 62) — drop ONE overload. `true` if it was there.
5897 pub fn drop_function_by_key(&mut self, key: &str) -> bool {
5898 self.functions.remove(key).is_some()
5899 }
5900
5901 /// v7.12.4 — remove a user-defined function by name. Returns
5902 /// `true` if a function was removed, `false` if none matched.
5903 /// Caller decides whether to surface `if_exists` semantics.
5904 /// v7.39 (read01 round 62) — with no signature, PG drops the function only
5905 /// when the name is unambiguous. SPG mirrors that: this removes EVERY
5906 /// overload of `name`, and the caller (ddl.rs) refuses the ambiguous case
5907 /// before getting here.
5908 pub fn drop_function(&mut self, name: &str) -> bool {
5909 let keys: Vec<String> = self
5910 .functions
5911 .iter()
5912 .filter(|(_, f)| f.name.eq_ignore_ascii_case(name))
5913 .map(|(k, _)| k.clone())
5914 .collect();
5915 let hit = !keys.is_empty();
5916 for k in keys {
5917 self.functions.remove(&k);
5918 }
5919 hit
5920 }
5921
5922 /// v7.17.0 — read-only handle to catalogued sequences.
5923 /// v7.39 (read01 round 60) — the `public` schema's ACL (PG nspacl).
5924 #[must_use]
5925 pub fn schema_acl(&self) -> &[AclItem] {
5926 &self.schema_acl
5927 }
5928
5929 pub fn schema_acl_mut(&mut self) -> &mut Vec<AclItem> {
5930 &mut self.schema_acl
5931 }
5932
5933 /// v7.39 (read01 round 60) — the database's ACL.
5934 #[must_use]
5935 pub fn database_acl(&self) -> &[AclItem] {
5936 &self.database_acl
5937 }
5938
5939 pub fn database_acl_mut(&mut self) -> &mut Vec<AclItem> {
5940 &mut self.database_acl
5941 }
5942
5943 /// v7.39 (read01 round 60) — mutable sequence access, for GRANT.
5944 /// v7.39 (round 469) — resolves the session's temporary sequence
5945 /// first, like its read-only twin. `nextval` and `setval` reach the
5946 /// map through here, so a temporary sequence shadowing a permanent one
5947 /// advances the temporary one — measured against PG18, where the
5948 /// permanent sequence's counter is untouched while the temp exists.
5949 pub fn sequence_mut(&mut self, name: &str) -> Option<&mut SequenceDef> {
5950 let key = self.sequence_key(name);
5951 self.sequences.get_mut(&key)
5952 }
5953
5954 /// v7.39 (read01 round 61) — mutable function access, for GRANT.
5955 pub fn function_mut(&mut self, name: &str) -> Option<&mut FunctionDef> {
5956 self.functions.get_mut(name)
5957 }
5958
5959 /// Every catalogued sequence, temp ones included under their mangled
5960 /// storage names. Listing code filters these through
5961 /// [`Self::listed_name`]; anything resolving ONE name by its logical
5962 /// spelling wants [`Self::sequence`] instead.
5963 pub const fn sequences_all(&self) -> &BTreeMap<String, SequenceDef> {
5964 &self.sequences
5965 }
5966
5967 /// v7.39 (round 469) — resolve one sequence by its logical name, the
5968 /// session's temporary one winning over a permanent one of the same
5969 /// name. The same rule [`Self::resolve_index`] applies to tables.
5970 #[must_use]
5971 pub fn sequence(&self, name: &str) -> Option<&SequenceDef> {
5972 if let Some(mangled) = self.temp_name_for(name)
5973 && let Some(def) = self.sequences.get(&mangled)
5974 {
5975 return Some(def);
5976 }
5977 self.sequences.get(name)
5978 }
5979
5980 /// Does a sequence of this logical name exist for this session?
5981 #[must_use]
5982 pub fn has_sequence(&self, name: &str) -> bool {
5983 self.sequence(name).is_some()
5984 }
5985
5986 /// The storage key a sequence of this logical name resolves to — the
5987 /// session's temp mangling when it has one, else the name itself.
5988 #[must_use]
5989 pub fn sequence_key(&self, name: &str) -> String {
5990 if let Some(mangled) = self.temp_name_for(name)
5991 && self.sequences.contains_key(&mangled)
5992 {
5993 return mangled;
5994 }
5995 name.into()
5996 }
5997
5998 /// v7.17.0 — register a new SEQUENCE. Errors if `name`
5999 /// collides with an existing sequence and `if_not_exists`
6000 /// is false.
6001 pub fn create_sequence(
6002 &mut self,
6003 def: SequenceDef,
6004 if_not_exists: bool,
6005 ) -> Result<(), StorageError> {
6006 if self.sequences.contains_key(&def.name) {
6007 if if_not_exists {
6008 return Ok(());
6009 }
6010 // v7.39 (read01 round 47) — a sequence is a relation to PG (42P07).
6011 return Err(StorageError::Corrupt(format!(
6012 "relation {:?} already exists",
6013 def.name
6014 )));
6015 }
6016 self.mark_nontable_dirty(NonTableKind::Sequence, &def.name);
6017 self.sequences.insert(def.name.clone(), def);
6018 Ok(())
6019 }
6020
6021 /// v7.17.0 — remove a SEQUENCE by name. Returns `true` if a
6022 /// sequence was removed, `false` if none matched. Caller
6023 /// surfaces IF EXISTS semantics.
6024 /// v7.39 (read01 round 49) — `ALTER SEQUENCE old RENAME TO new`.
6025 /// Errors when `old` is missing or `new` is taken; the SequenceDef's own
6026 /// `name` field is rewritten so it stays self-describing.
6027 pub fn rename_sequence(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
6028 if !self.sequences.contains_key(old) {
6029 return Err(StorageError::Corrupt(format!(
6030 "relation {old:?} does not exist"
6031 )));
6032 }
6033 if self.sequences.contains_key(new) {
6034 return Err(StorageError::Corrupt(format!(
6035 "relation {new:?} already exists"
6036 )));
6037 }
6038 self.mark_nontable_dirty(NonTableKind::Sequence, old);
6039 self.mark_nontable_dirty(NonTableKind::Sequence, new);
6040 if let Some(mut def) = self.sequences.remove(old) {
6041 def.name = new.to_string();
6042 self.sequences.insert(new.to_string(), def);
6043 }
6044 Ok(())
6045 }
6046
6047 pub fn drop_sequence(&mut self, name: &str) -> bool {
6048 self.mark_nontable_dirty(NonTableKind::Sequence, name);
6049 self.sequences.remove(name).is_some()
6050 }
6051
6052 /// v7.17.0 — atomic nextval. Increments `last_value` per
6053 /// `increment`, returns the new value, sets `is_called`.
6054 /// Returns an error on CYCLE-less overflow.
6055 /// v7.39 (round 497) — the counter state of every sequence, for
6056 /// carrying across a commit install.
6057 ///
6058 /// A sequence's VALUE is not transactional in PG: `nextval` advances
6059 /// shared state that a rollback does not give back, because two
6060 /// sessions must never receive the same number. SPG keeps sequences in
6061 /// the catalog, and a transaction works on a catalog CLONE, so
6062 /// installing that clone at COMMIT would restore whatever the counter
6063 /// was at BEGIN. These two let the install put the live counters back.
6064 #[must_use]
6065 pub fn sequence_counters(&self) -> Vec<(String, i64, bool)> {
6066 self.sequences
6067 .iter()
6068 .map(|(k, d)| (k.clone(), d.last_value, d.is_called))
6069 .collect()
6070 }
6071
6072 /// Restore counters saved by [`Self::sequence_counters`], for the
6073 /// sequences that still exist. A sequence the transaction CREATED is
6074 /// absent from the saved set and keeps the value it was given.
6075 pub fn restore_sequence_counters(&mut self, saved: &[(String, i64, bool)]) {
6076 for (k, last, called) in saved {
6077 if let Some(d) = self.sequences.get_mut(k) {
6078 d.last_value = *last;
6079 d.is_called = *called;
6080 }
6081 }
6082 }
6083
6084 pub fn sequence_next_value(&mut self, name: &str) -> Result<i64, StorageError> {
6085 let key = self.sequence_key(name);
6086 let Some(seq) = self.sequences.get_mut(&key) else {
6087 return Err(StorageError::TableNotFound { name: name.into() });
6088 };
6089 // PG semantics: when !is_called (fresh sequence or
6090 // setval(_, false)), the next nextval returns the stored
6091 // `last_value`. When is_called, it advances by `increment`
6092 // and CYCLE-wraps on overflow.
6093 let candidate = if seq.is_called {
6094 let next = seq.last_value.checked_add(seq.increment).ok_or_else(|| {
6095 StorageError::Corrupt(format!("sequence {name:?} arithmetic overflow"))
6096 })?;
6097 if seq.increment > 0 {
6098 if next > seq.max_value {
6099 if seq.cycle {
6100 seq.min_value
6101 } else {
6102 // v7.39 (round 220) — PG's 2200H wording, not a
6103 // Corrupt-classed error.
6104 return Err(StorageError::SequenceExhausted {
6105 name: name.into(),
6106 limit: seq.max_value,
6107 is_max: true,
6108 });
6109 }
6110 } else {
6111 next
6112 }
6113 } else if next < seq.min_value {
6114 if seq.cycle {
6115 seq.max_value
6116 } else {
6117 return Err(StorageError::SequenceExhausted {
6118 name: name.into(),
6119 limit: seq.min_value,
6120 is_max: false,
6121 });
6122 }
6123 } else {
6124 next
6125 }
6126 } else {
6127 seq.last_value
6128 };
6129 seq.last_value = candidate;
6130 seq.is_called = true;
6131 Ok(candidate)
6132 }
6133
6134 /// v7.17.0 — currval. Errors if the session has never called
6135 /// nextval on this sequence (PG semantics). At the catalog
6136 /// level we approximate "session" with "is_called persisted";
6137 /// the engine session-tracking layer can wrap this for the
6138 /// strict per-session semantics later.
6139 pub fn sequence_current_value(&self, name: &str) -> Result<i64, StorageError> {
6140 let Some(seq) = self.sequences.get(name) else {
6141 return Err(StorageError::TableNotFound { name: name.into() });
6142 };
6143 if !seq.is_called {
6144 return Err(StorageError::Corrupt(format!(
6145 "currval of sequence {name:?} is not yet defined in this session"
6146 )));
6147 }
6148 Ok(seq.last_value)
6149 }
6150
6151 /// v7.17.0 — setval(name, value [, is_called]). PG returns
6152 /// `value` regardless. `is_called=true` means the NEXT
6153 /// nextval will return `value + increment`; `is_called=false`
6154 /// means the next nextval will return `value`.
6155 pub fn sequence_set_value(
6156 &mut self,
6157 name: &str,
6158 value: i64,
6159 is_called: bool,
6160 ) -> Result<i64, StorageError> {
6161 let key = self.sequence_key(name);
6162 let Some(seq) = self.sequences.get_mut(&key) else {
6163 return Err(StorageError::TableNotFound { name: name.into() });
6164 };
6165 // v7.39 (round 244) — PG refuses a value outside the sequence's
6166 // range (22003); SPG accepted it silently, leaving last_value out
6167 // of bounds.
6168 if value < seq.min_value || value > seq.max_value {
6169 return Err(StorageError::Unsupported(format!(
6170 "setval: value {value} is out of bounds for sequence \"{name}\" ({}..{})",
6171 seq.min_value, seq.max_value
6172 )));
6173 }
6174 seq.last_value = value;
6175 seq.is_called = is_called;
6176 Ok(value)
6177 }
6178
6179 /// v7.17.0 Phase 1.2 — read-only handle to catalogued views. Temp ones
6180 /// are in here under their mangled storage names; listing code filters
6181 /// through [`Self::listed_name`], and anything resolving ONE name by
6182 /// its logical spelling wants [`Self::view`].
6183 pub const fn views_all(&self) -> &BTreeMap<String, ViewDef> {
6184 &self.views
6185 }
6186
6187 /// v7.39 (round 469) — resolve one view by its logical name, the
6188 /// session's temporary one winning over a permanent one of the same
6189 /// name.
6190 #[must_use]
6191 pub fn view(&self, name: &str) -> Option<&ViewDef> {
6192 if let Some(mangled) = self.temp_name_for(name)
6193 && let Some(def) = self.views.get(&mangled)
6194 {
6195 return Some(def);
6196 }
6197 self.views.get(name)
6198 }
6199
6200 /// Does a view of this logical name exist for this session?
6201 #[must_use]
6202 pub fn has_view(&self, name: &str) -> bool {
6203 self.view(name).is_some()
6204 }
6205
6206 /// The storage key a view of this logical name resolves to.
6207 #[must_use]
6208 pub fn view_key(&self, name: &str) -> String {
6209 if let Some(mangled) = self.temp_name_for(name)
6210 && self.views.contains_key(&mangled)
6211 {
6212 return mangled;
6213 }
6214 name.into()
6215 }
6216
6217 /// v7.17.0 Phase 1.2 — install a VIEW. `or_replace=true`
6218 /// overwrites an existing entry; `if_not_exists=true` is a
6219 /// silent no-op when the name is taken. Errors if both flags
6220 /// are off and the name collides.
6221 pub fn create_view(
6222 &mut self,
6223 def: ViewDef,
6224 or_replace: bool,
6225 if_not_exists: bool,
6226 ) -> Result<(), StorageError> {
6227 if self.views.contains_key(&def.name) {
6228 if or_replace {
6229 self.mark_nontable_dirty(NonTableKind::View, &def.name);
6230 self.mark_nontable_dirty(NonTableKind::View, &def.name);
6231 self.views.insert(def.name.clone(), def);
6232 return Ok(());
6233 }
6234 if if_not_exists {
6235 return Ok(());
6236 }
6237 // v7.39 (read01 round 47) — a view is a relation to PG (42P07).
6238 return Err(StorageError::Corrupt(format!(
6239 "relation {:?} already exists",
6240 def.name
6241 )));
6242 }
6243 // Reject name collision with tables / sequences — same
6244 // namespace per PG.
6245 if self.by_name.contains_key(&def.name) {
6246 return Err(StorageError::Corrupt(format!(
6247 "view {:?} would shadow an existing table",
6248 def.name
6249 )));
6250 }
6251 if self.sequences.contains_key(&def.name) {
6252 return Err(StorageError::Corrupt(format!(
6253 "view {:?} would shadow an existing sequence",
6254 def.name
6255 )));
6256 }
6257 self.views.insert(def.name.clone(), def);
6258 Ok(())
6259 }
6260
6261 /// v7.17.0 Phase 1.2 — remove a view by name. Returns true if
6262 /// a view was removed.
6263 pub fn drop_view(&mut self, name: &str) -> bool {
6264 self.mark_nontable_dirty(NonTableKind::View, name);
6265 self.views.remove(name).is_some()
6266 }
6267
6268 /// v7.17.0 Phase 1.3 — read-only handle to the materialised-
6269 /// view source registry. Each entry pairs with a regular
6270 /// table of the same name that holds the cached rows.
6271 pub const fn materialized_views(&self) -> &BTreeMap<String, String> {
6272 &self.materialized_views
6273 }
6274
6275 /// v7.17.0 Phase 1.3 — register a source for a materialised
6276 /// view. Caller has already created the backing table.
6277 pub fn register_materialized_view(&mut self, name: String, body: String) {
6278 self.mark_nontable_dirty(NonTableKind::MaterializedView, &name);
6279 self.materialized_views.insert(name, body);
6280 }
6281
6282 /// v7.17.0 Phase 1.3 — drop the source registry entry. Returns
6283 /// true if a source was unregistered. Caller separately drops
6284 /// the backing table.
6285 pub fn drop_materialized_view_source(&mut self, name: &str) -> bool {
6286 self.mark_nontable_dirty(NonTableKind::MaterializedView, name);
6287 self.materialized_views.remove(name).is_some()
6288 }
6289
6290 /// v7.17.0 Phase 1.4 — read-only handle to user-defined ENUM
6291 /// catalog.
6292 pub const fn enum_types(&self) -> &BTreeMap<String, EnumDef> {
6293 &self.enum_types
6294 }
6295
6296 /// v7.17.0 Phase 1.4 — install a new ENUM type. Errors if
6297 /// `name` collides with an existing enum (no IF NOT EXISTS
6298 /// per PG semantics for CREATE TYPE).
6299 pub fn create_enum_type(&mut self, def: EnumDef) -> Result<(), StorageError> {
6300 if self.enum_types.contains_key(&def.name) {
6301 return Err(StorageError::Corrupt(format!(
6302 "type {:?} already exists",
6303 def.name
6304 )));
6305 }
6306 self.mark_nontable_dirty(NonTableKind::EnumType, &def.name);
6307 self.enum_types.insert(def.name.clone(), def);
6308 Ok(())
6309 }
6310
6311 /// v7.17.0 Phase 1.4 — drop an ENUM type by name. Returns
6312 /// true if a type was removed.
6313 /// v7.37 D.55 — `ALTER TYPE … ADD VALUE`. Appends `label` to an existing
6314 /// enum's ordered label list, or inserts it before/after an existing label.
6315 /// `if_not_exists` makes a duplicate a no-op; otherwise a duplicate errors.
6316 /// Returns `Ok(true)` if a label was added, `Ok(false)` if it already existed
6317 /// (only possible under `if_not_exists`).
6318 /// v7.39 (read01 round 49) — `ALTER TYPE t RENAME VALUE 'old' TO 'new'`.
6319 /// The parser used to swallow this form as a no-op, so the rename was
6320 /// accepted and silently ignored. Renaming in place keeps the label's
6321 /// sort position, which is what PG does (enumsortorder is untouched).
6322 pub fn rename_enum_value(
6323 &mut self,
6324 type_name: &str,
6325 old: &str,
6326 new: &str,
6327 ) -> Result<(), StorageError> {
6328 let def = self
6329 .enum_types
6330 .get_mut(type_name)
6331 .ok_or_else(|| StorageError::Corrupt(format!("type {type_name:?} does not exist")))?;
6332 if def.labels.iter().any(|l| l == new) {
6333 return Err(StorageError::Corrupt(format!(
6334 "enum label {new:?} already exists"
6335 )));
6336 }
6337 let at = def.labels.iter().position(|l| l == old).ok_or_else(|| {
6338 StorageError::Corrupt(format!("{old:?} is not an existing enum label"))
6339 })?;
6340 def.labels[at] = new.to_string();
6341 Ok(())
6342 }
6343
6344 /// v7.39 (read01 round 50) — set (or, with `None`, remove) the comment on
6345 /// an object. `key` is the canonical `"<kind>:<name>"` form.
6346 pub fn set_comment(&mut self, key: &str, text: Option<&str>) {
6347 match text {
6348 Some(t) => {
6349 self.comments.insert(key.to_string(), t.to_string());
6350 }
6351 None => {
6352 self.comments.remove(key);
6353 }
6354 }
6355 }
6356
6357 /// v7.39 (read01 round 50) — the comment on an object, if any.
6358 #[must_use]
6359 pub fn comment(&self, key: &str) -> Option<&str> {
6360 self.comments.get(key).map(String::as_str)
6361 }
6362
6363 /// v7.39 (round 547) — record a GUC default for a scope. An empty
6364 /// database or role name is PG's oid 0 ("all"). `None` value
6365 /// removes just that parameter, as PG's RESET does.
6366 pub fn set_db_role_setting(
6367 &mut self,
6368 database: &str,
6369 role: &str,
6370 param: &str,
6371 value: Option<&str>,
6372 ) {
6373 let key = (database.to_string(), role.to_string());
6374 match value {
6375 Some(v) => {
6376 self.db_role_settings
6377 .entry(key)
6378 .or_default()
6379 .insert(param.to_ascii_lowercase(), v.to_string());
6380 }
6381 None => {
6382 if let Some(m) = self.db_role_settings.get_mut(&key) {
6383 m.remove(¶m.to_ascii_lowercase());
6384 if m.is_empty() {
6385 self.db_role_settings.remove(&key);
6386 }
6387 }
6388 }
6389 }
6390 }
6391
6392 /// v7.39 (round 550) — create a replication slot. `Err` carries
6393 /// PG's own message for a duplicate.
6394 ///
6395 /// # Errors
6396 /// When a slot of that name already exists.
6397 pub fn create_replication_slot(
6398 &mut self,
6399 name: &str,
6400 plugin: &str,
6401 slot_type: &str,
6402 ) -> Result<(), String> {
6403 if self.replication_slots.contains_key(name) {
6404 return Err(alloc::format!("replication slot \"{name}\" already exists"));
6405 }
6406 self.replication_slots.insert(
6407 name.to_string(),
6408 (plugin.to_string(), slot_type.to_string()),
6409 );
6410 Ok(())
6411 }
6412
6413 /// # Errors
6414 /// When no slot of that name exists — PG's message, and the case
6415 /// that used to report success.
6416 pub fn drop_replication_slot(&mut self, name: &str) -> Result<(), String> {
6417 if self.replication_slots.remove(name).is_none() {
6418 return Err(alloc::format!("replication slot \"{name}\" does not exist"));
6419 }
6420 Ok(())
6421 }
6422
6423 #[must_use]
6424 /// v7.38.18 (S1) — the collation this database was created with.
6425 /// `"C"` when nothing was recorded, which is what an older catalog
6426 /// and a default `initdb`-less start both mean.
6427 pub fn db_collation(&self) -> &str {
6428 self.db_collation.as_deref().unwrap_or("C")
6429 }
6430
6431 /// Record the creation collation. Refused once one is set, because
6432 /// every index key already in this database was built under it —
6433 /// the same refusal PostgreSQL gives `ALTER DATABASE … LC_COLLATE`,
6434 /// and for the same reason.
6435 ///
6436 /// `Ok(false)` when the value asked for is the one already in force,
6437 /// so a host that passes its environment on every start is not an
6438 /// error.
6439 pub fn set_db_collation(&mut self, name: &str) -> Result<bool, StorageError> {
6440 if self.db_collation.as_deref() == Some(name) {
6441 return Ok(false);
6442 }
6443 if self.db_collation.is_none() && name.eq_ignore_ascii_case("C") {
6444 return Ok(false);
6445 }
6446 if self.db_collation.is_some() || !self.tables.is_empty() {
6447 return Err(StorageError::Corrupt(format!(
6448 "database collation is already {:?} and cannot be changed; \
6449 PostgreSQL refuses this too, because every index key here \
6450 was built under it",
6451 self.db_collation()
6452 )));
6453 }
6454 self.db_collation = Some(name.into());
6455 Ok(true)
6456 }
6457
6458 /// The user said so, in SQL: `CREATE DATABASE … LC_COLLATE 'x'`.
6459 ///
6460 /// Differs from [`Self::set_db_collation`] in one way, and the
6461 /// difference is the whole point: this REPLACES a collation the
6462 /// database already has, as long as no table has been created yet.
6463 /// The refusal in `set_db_collation` exists because index keys were
6464 /// built under the old collation — with no tables, none were.
6465 ///
6466 /// The case it is for: a server stamps the container's `LANG` on a
6467 /// fresh database at startup, and the customer's bootstrap script
6468 /// then says `CREATE DATABASE app LC_COLLATE 'de_DE.utf8'`. What the
6469 /// script asked for beats what the container happened to export.
6470 ///
6471 /// `Ok(false)` when a table already exists — the caller warns rather
6472 /// than failing, because PostgreSQL would have made a SEPARATE
6473 /// database here and returned success, and failing a bootstrap
6474 /// script is a customer change.
6475 pub fn declare_db_collation(&mut self, name: &str) -> bool {
6476 if self.db_collation.as_deref() == Some(name) {
6477 return true;
6478 }
6479 if !self.tables.is_empty() {
6480 return false;
6481 }
6482 self.db_collation = Some(name.into());
6483 true
6484 }
6485
6486 /// Record a name a `CREATE DATABASE` asked for; `true` when new.
6487 pub fn record_created_database(&mut self, name: &str) -> bool {
6488 self.created_databases.insert(name.to_string())
6489 }
6490
6491 /// The names `CREATE DATABASE` has been asked for.
6492 pub const fn created_databases(&self) -> &alloc::collections::BTreeSet<String> {
6493 &self.created_databases
6494 }
6495
6496 pub const fn replication_slots(&self) -> &BTreeMap<String, (String, String)> {
6497 &self.replication_slots
6498 }
6499
6500 /// PG's RESET ALL: drops this scope's whole entry, leaving the
6501 /// other scopes alone — measured on PG18, where `ALTER ROLE r RESET
6502 /// ALL` left the ALL, the database and the role-in-database rows.
6503 pub fn reset_db_role_settings(&mut self, database: &str, role: &str) {
6504 self.db_role_settings
6505 .remove(&(database.to_string(), role.to_string()));
6506 }
6507
6508 #[must_use]
6509 pub const fn db_role_settings(&self) -> &BTreeMap<(String, String), BTreeMap<String, String>> {
6510 &self.db_role_settings
6511 }
6512
6513 /// v7.39 (read01 round 50) — every `(key, text)` pair, for the
6514 /// pg_description view.
6515 #[must_use]
6516 pub const fn comments(&self) -> &BTreeMap<String, String> {
6517 &self.comments
6518 }
6519
6520 /// v7.39 (read01 round 50) — drop every comment whose key names `obj`
6521 /// (the object itself and, for a table, its columns). Called when the
6522 /// object is dropped so a later object of the same name doesn't inherit
6523 /// a stale comment.
6524 pub fn drop_comments_for(&mut self, kind: &str, name: &str) {
6525 let exact = alloc::format!("{kind}:{name}");
6526 let col_prefix = alloc::format!("column:{name}.");
6527 self.comments
6528 .retain(|k, _| *k != exact && !k.starts_with(&col_prefix));
6529 }
6530
6531 pub fn add_enum_value(
6532 &mut self,
6533 type_name: &str,
6534 label: &str,
6535 if_not_exists: bool,
6536 position: Option<(bool, String)>,
6537 ) -> Result<bool, StorageError> {
6538 self.mark_nontable_dirty(NonTableKind::EnumType, type_name);
6539 let def = self
6540 .enum_types
6541 .get_mut(type_name)
6542 .ok_or_else(|| StorageError::Corrupt(format!("type {type_name:?} does not exist")))?;
6543 if def.labels.iter().any(|l| l == label) {
6544 if if_not_exists {
6545 return Ok(false);
6546 }
6547 // v7.39 (read01 round 49) — PG wording (42710 at the wire).
6548 return Err(StorageError::Corrupt(format!(
6549 "enum label {label:?} already exists"
6550 )));
6551 }
6552 match position {
6553 None => def.labels.push(label.to_string()),
6554 Some((is_before, anchor)) => {
6555 let at = def
6556 .labels
6557 .iter()
6558 .position(|l| l == &anchor)
6559 .ok_or_else(|| {
6560 StorageError::Corrupt(format!(
6561 "enum label {anchor:?} does not exist in type {type_name:?}"
6562 ))
6563 })?;
6564 let idx = if is_before { at } else { at + 1 };
6565 def.labels.insert(idx, label.to_string());
6566 }
6567 }
6568 Ok(true)
6569 }
6570
6571 pub fn drop_enum_type(&mut self, name: &str) -> bool {
6572 self.mark_nontable_dirty(NonTableKind::EnumType, name);
6573 self.enum_types.remove(name).is_some()
6574 }
6575
6576 /// v7.17.0 Phase 1.5 — read-only handle to DOMAIN catalog.
6577 pub const fn domain_types(&self) -> &BTreeMap<String, DomainDef> {
6578 &self.domain_types
6579 }
6580
6581 /// v7.17.0 Phase 1.5 — install a DOMAIN. Errors on collision
6582 /// with an existing domain.
6583 pub fn create_domain_type(&mut self, def: DomainDef) -> Result<(), StorageError> {
6584 if self.domain_types.contains_key(&def.name) {
6585 return Err(StorageError::Corrupt(format!(
6586 "domain {:?} already exists",
6587 def.name
6588 )));
6589 }
6590 self.mark_nontable_dirty(NonTableKind::DomainType, &def.name);
6591 self.domain_types.insert(def.name.clone(), def);
6592 Ok(())
6593 }
6594
6595 /// v7.17.0 Phase 1.5 — drop a DOMAIN by name.
6596 pub fn drop_domain_type(&mut self, name: &str) -> bool {
6597 self.mark_nontable_dirty(NonTableKind::DomainType, name);
6598 self.domain_types.remove(name).is_some()
6599 }
6600
6601 /// v7.37.42-T2 ζ-B — read-only handle to user-defined COMPOSITE
6602 /// catalog. Used by the engine to resolve
6603 /// `ColumnSchema.user_composite_type` lookups + by
6604 /// information_schema-style introspection.
6605 pub const fn composite_types(&self) -> &BTreeMap<String, CompositeDef> {
6606 &self.composite_types
6607 }
6608
6609 /// v7.37.42-T2 ζ-B — install a new COMPOSITE type. Errors if
6610 /// `name` already exists in the composite registry (PG forbids
6611 /// IF NOT EXISTS on CREATE TYPE composite; the engine surfaces
6612 /// the collision with the existing name).
6613 pub fn create_composite_type(&mut self, def: CompositeDef) -> Result<(), StorageError> {
6614 if self.composite_types.contains_key(&def.name) {
6615 return Err(StorageError::Corrupt(format!(
6616 "type {:?} already exists",
6617 def.name
6618 )));
6619 }
6620 self.mark_nontable_dirty(NonTableKind::CompositeType, &def.name);
6621 self.composite_types.insert(def.name.clone(), def);
6622 Ok(())
6623 }
6624
6625 /// v7.37.42-T2 ζ-B — drop a COMPOSITE type by name. Returns
6626 /// true if a type was removed.
6627 pub fn drop_composite_type(&mut self, name: &str) -> bool {
6628 self.mark_nontable_dirty(NonTableKind::CompositeType, name);
6629 self.composite_types.remove(name).is_some()
6630 }
6631
6632 /// v7.17.0 Phase 1.6 — read-only handle to the user-created
6633 /// schema registry. Built-in schemas (`public`, `pg_catalog`,
6634 /// `information_schema`) are NOT included here; use
6635 /// [`schema_exists`](Self::schema_exists) for the full
6636 /// check.
6637 pub const fn user_schemas(&self) -> &alloc::collections::BTreeSet<String> {
6638 &self.schemas
6639 }
6640
6641 /// v7.17.0 Phase 1.6 — schema-name resolver. Returns true
6642 /// for built-in schemas + every user-CREATEd one. Used by
6643 /// CREATE SCHEMA collision checks and (future) by
6644 /// information_schema.schemata.
6645 pub fn schema_exists(&self, name: &str) -> bool {
6646 is_builtin_schema(name) || self.schemas.contains(name)
6647 }
6648
6649 /// v7.17.0 Phase 1.6 — register a new schema. Errors if the
6650 /// name already exists and `if_not_exists=false`. Built-in
6651 /// names cannot be redeclared.
6652 pub fn create_schema(&mut self, name: String, if_not_exists: bool) -> Result<(), StorageError> {
6653 if is_builtin_schema(&name) {
6654 if if_not_exists {
6655 return Ok(());
6656 }
6657 return Err(StorageError::Corrupt(format!(
6658 "schema {name:?} is built-in and cannot be redeclared"
6659 )));
6660 }
6661 if self.schemas.contains(&name) {
6662 if if_not_exists {
6663 return Ok(());
6664 }
6665 return Err(StorageError::Corrupt(format!(
6666 "schema {name:?} already exists"
6667 )));
6668 }
6669 self.schemas.insert(name);
6670 Ok(())
6671 }
6672
6673 /// v7.17.0 Phase 1.6 — drop a user-created schema. Returns
6674 /// true if a schema was removed. Built-in names always
6675 /// return false (cannot be dropped). Tables that previously
6676 /// used the schema as a prefix keep their bare name and stay
6677 /// queryable — this is the "prefix routing, not isolation"
6678 /// posture documented in v7.17 Phase 1.6.
6679 pub fn drop_schema(&mut self, name: &str) -> Result<bool, StorageError> {
6680 if is_builtin_schema(name) {
6681 return Err(StorageError::Corrupt(format!(
6682 "schema {name:?} is built-in and cannot be dropped"
6683 )));
6684 }
6685 Ok(self.schemas.remove(name))
6686 }
6687
6688 /// v7.17.0 — ALTER SEQUENCE option merge. Caller-provided
6689 /// updates overwrite the matching fields; unset fields keep
6690 /// their stored values. RESTART variants update last_value
6691 /// directly per PG: `RESTART` resets to current `start`;
6692 /// `RESTART WITH n` resets to `n`.
6693 #[allow(clippy::too_many_arguments)]
6694 pub fn alter_sequence(
6695 &mut self,
6696 name: &str,
6697 increment: Option<i64>,
6698 min_value: Option<i64>,
6699 max_value: Option<i64>,
6700 start: Option<i64>,
6701 restart: Option<Option<i64>>,
6702 cache: Option<i64>,
6703 cycle: Option<bool>,
6704 owned_by: Option<Option<(String, String)>>,
6705 ) -> Result<(), StorageError> {
6706 self.mark_nontable_dirty(NonTableKind::Sequence, name);
6707 let Some(seq) = self.sequences.get_mut(name) else {
6708 return Err(StorageError::TableNotFound { name: name.into() });
6709 };
6710 if let Some(v) = increment {
6711 seq.increment = v;
6712 }
6713 if let Some(v) = min_value {
6714 seq.min_value = v;
6715 }
6716 if let Some(v) = max_value {
6717 seq.max_value = v;
6718 }
6719 if let Some(v) = start {
6720 seq.start = v;
6721 }
6722 if let Some(restart_value) = restart {
6723 seq.last_value = restart_value.unwrap_or(seq.start);
6724 seq.is_called = false;
6725 }
6726 if let Some(v) = cache {
6727 seq.cache = v;
6728 }
6729 if let Some(v) = cycle {
6730 seq.cycle = v;
6731 }
6732 if let Some(v) = owned_by {
6733 seq.owned_by = v;
6734 }
6735 Ok(())
6736 }
6737
6738 /// v7.12.4 — read-only slice of all catalogued triggers.
6739 /// Engine row-write paths filter this by (table, event,
6740 /// timing) and fire matches in slice order.
6741 pub fn triggers(&self) -> &[TriggerDef] {
6742 &self.triggers
6743 }
6744
6745 /// v7.15.0 — mutable handle to the trigger slice for
6746 /// `ALTER TABLE … RENAME COLUMN`, which rewrites every
6747 /// `update_columns` entry that referenced the renamed
6748 /// column.
6749 pub fn triggers_mut(&mut self) -> &mut Vec<TriggerDef> {
6750 &mut self.triggers
6751 }
6752
6753 /// v7.12.4 — register a new trigger. With `or_replace = false`,
6754 /// errors when a trigger with the same name already exists on
6755 /// the same table (PG scoping rule — trigger names are
6756 /// per-table, not global). Trigger function must already
6757 /// exist in the catalog at registration time.
6758 pub fn create_trigger(
6759 &mut self,
6760 def: TriggerDef,
6761 or_replace: bool,
6762 ) -> Result<(), StorageError> {
6763 // v7.39 (round 137) — a trigger may target a base table (BEFORE / AFTER)
6764 // or a view (INSTEAD OF). The engine enforces the timing↔target rule;
6765 // storage only requires the relation to exist as one or the other.
6766 if !self.by_name.contains_key(&def.table) && !self.views.contains_key(&def.table) {
6767 return Err(StorageError::TableNotFound {
6768 name: def.table.clone(),
6769 });
6770 }
6771 // v7.39 (read01 round 62) — functions are keyed by SIGNATURE now. A
6772 // trigger names its function by NAME (a trigger function takes no
6773 // arguments), so the existence check goes through the name index.
6774 if self.functions_named(&def.function).is_empty() {
6775 // v7.39 (round 710) — PG's wording: the FUNCTION is what does
6776 // not exist (`function nosuch_fn() does not exist`), and the
6777 // old message rode `Corrupt`'s on-disk banner besides.
6778 return Err(StorageError::Corrupt(format!(
6779 "function {}() does not exist",
6780 def.function
6781 )));
6782 }
6783 let dup = self
6784 .triggers
6785 .iter()
6786 .position(|t| t.name == def.name && t.table == def.table);
6787 match (dup, or_replace) {
6788 (Some(_), false) => Err(StorageError::Corrupt(format!(
6789 "trigger {:?} already exists on table {:?}",
6790 def.name, def.table
6791 ))),
6792 (Some(i), true) => {
6793 self.triggers[i] = def;
6794 Ok(())
6795 }
6796 (None, _) => {
6797 self.triggers.push(def);
6798 Ok(())
6799 }
6800 }
6801 }
6802
6803 /// v7.12.4 — remove a trigger by `(name, table)`. Returns
6804 /// `true` if one was removed.
6805 pub fn drop_trigger(&mut self, name: &str, table: &str) -> bool {
6806 let before = self.triggers.len();
6807 self.triggers
6808 .retain(|t| !(t.name == name && t.table == table));
6809 before != self.triggers.len()
6810 }
6811
6812 /// v7.39 (round 139) — the catalogued query-rewrite RULEs.
6813 pub fn rules(&self) -> &[RuleDef] {
6814 &self.rules
6815 }
6816
6817 /// v7.39 (round 280) — the catalogued extended-statistics objects.
6818 #[must_use]
6819 pub fn statistics_ext(&self) -> &[StatisticsExtDef] {
6820 &self.statistics_ext
6821 }
6822
6823 /// v7.39 (round 287) — every large object, ascending by OID.
6824 #[must_use]
6825 pub fn large_objects(&self) -> &alloc::collections::BTreeMap<u32, Vec<u8>> {
6826 &self.large_objects
6827 }
6828
6829 /// The bytes of one large object, or `None` when no such OID exists.
6830 #[must_use]
6831 pub fn large_object(&self, oid: u32) -> Option<&[u8]> {
6832 self.large_objects.get(&oid).map(Vec::as_slice)
6833 }
6834
6835 /// Create a large object. `oid` of 0 means "pick one" — PG's
6836 /// `lo_create(0)` / `lo_creat(-1)` spelling. Errors when the
6837 /// requested OID is taken.
6838 pub fn create_large_object(&mut self, oid: u32, bytes: Vec<u8>) -> Result<u32, String> {
6839 let id = if oid == 0 {
6840 self.next_large_object_oid()
6841 } else {
6842 oid
6843 };
6844 if self.large_objects.contains_key(&id) {
6845 return Err(format!("large object {id} already exists"));
6846 }
6847 self.large_objects.insert(id, bytes);
6848 Ok(id)
6849 }
6850
6851 /// Overwrite `len` bytes at `offset` (0-based), growing the object
6852 /// with zero bytes if the write starts past the end — PG's
6853 /// `lo_put` semantics.
6854 pub fn put_large_object(&mut self, oid: u32, offset: usize, data: &[u8]) -> Result<(), String> {
6855 let Some(buf) = self.large_objects.get_mut(&oid) else {
6856 return Err(format!("large object {oid} does not exist"));
6857 };
6858 let end = offset.saturating_add(data.len());
6859 if buf.len() < end {
6860 buf.resize(end, 0);
6861 }
6862 buf[offset..end].copy_from_slice(data);
6863 Ok(())
6864 }
6865
6866 /// v7.39 (round 306) — `lo_truncate`. PG's truncate sets the object
6867 /// to exactly `len` bytes in BOTH directions: it shortens, and it
6868 /// GROWS with zero fill when `len` exceeds the current size
6869 /// (measured — `lo_truncate(fd, 8)` over a 4-byte object leaves
6870 /// eight bytes, the last four zero).
6871 pub fn truncate_large_object(&mut self, oid: u32, len: usize) -> Result<(), String> {
6872 let Some(buf) = self.large_objects.get_mut(&oid) else {
6873 return Err(format!("large object {oid} does not exist"));
6874 };
6875 buf.resize(len, 0);
6876 Ok(())
6877 }
6878
6879 /// Remove a large object. `false` when the OID was not there.
6880 pub fn unlink_large_object(&mut self, oid: u32) -> bool {
6881 self.large_objects.remove(&oid).is_some()
6882 }
6883
6884 /// The next free OID in PG's user band.
6885 /// v7.39 (round 343, V40) — large objects have their own oid band.
6886 /// It used to start at 16_384, which is where user TABLES start, so
6887 /// the first large object and the first table shared an oid — and
6888 /// `pg_largeobject_metadata.oid` is joinable against `pg_class.oid`,
6889 /// so a join across them matched a row that has nothing to do with
6890 /// it. (PG cannot collide: every oid there comes off one counter.)
6891 /// An object already stored keeps the oid it was given; only new
6892 /// ones land in the band.
6893 fn next_large_object_oid(&self) -> u32 {
6894 self.large_objects
6895 .keys()
6896 .next_back()
6897 .map_or(500_000, |m| m.saturating_add(1))
6898 }
6899
6900 /// Register one. `Err(name)` when the name is taken.
6901 pub fn create_statistics_ext(&mut self, def: StatisticsExtDef) -> Result<(), String> {
6902 if self.statistics_ext.iter().any(|s| s.name == def.name) {
6903 return Err(def.name);
6904 }
6905 self.statistics_ext.push(def);
6906 Ok(())
6907 }
6908
6909 /// Drop one by name; false when absent.
6910 pub fn drop_statistics_ext(&mut self, name: &str) -> bool {
6911 let before = self.statistics_ext.len();
6912 self.statistics_ext.retain(|s| s.name != name);
6913 before != self.statistics_ext.len()
6914 }
6915
6916 /// v7.39 (round 139) — register a RULE. Its target relation (table or view)
6917 /// must exist; `or_replace` overwrites a same-(name,table) rule.
6918 pub fn create_rule(&mut self, def: RuleDef, or_replace: bool) -> Result<(), StorageError> {
6919 if !self.by_name.contains_key(&def.table) && !self.views.contains_key(&def.table) {
6920 return Err(StorageError::TableNotFound {
6921 name: def.table.clone(),
6922 });
6923 }
6924 let dup = self
6925 .rules
6926 .iter()
6927 .position(|r| r.name == def.name && r.table == def.table);
6928 match (dup, or_replace) {
6929 (Some(_), false) => Err(StorageError::Corrupt(format!(
6930 "rule {:?} for relation {:?} already exists",
6931 def.name, def.table
6932 ))),
6933 (Some(i), true) => {
6934 self.rules[i] = def;
6935 Ok(())
6936 }
6937 (None, _) => {
6938 self.rules.push(def);
6939 Ok(())
6940 }
6941 }
6942 }
6943
6944 /// v7.39 (round 139) — drop a RULE by `(name, table)`.
6945 pub fn drop_rule(&mut self, name: &str, table: &str) -> bool {
6946 let before = self.rules.len();
6947 self.rules.retain(|r| !(r.name == name && r.table == table));
6948 before != self.rules.len()
6949 }
6950
6951 pub fn create_table(&mut self, schema: TableSchema) -> Result<(), StorageError> {
6952 if self.by_name.contains_key(&schema.name) {
6953 return Err(StorageError::DuplicateTable {
6954 name: schema.name.clone(),
6955 });
6956 }
6957 let idx = self.tables.len();
6958 let name = schema.name.clone();
6959 let mut t = Table::new(schema);
6960 // v7.38.18 (S2) — the table inherits the database's collation,
6961 // which is what its undeclared text columns compare under.
6962 t.set_db_collation(self.db_collation());
6963 self.tables.push(t);
6964 self.by_name.insert(name.clone(), idx);
6965 // v7.39 (round 496) — see `dirty_tables`.
6966 self.dirty_tables.insert(name);
6967 // v7.37.15 (Phase C.1) — stamp the new relation with a stable,
6968 // monotonic, never-reused RelId. Pre-increment so ids start at
6969 // 1 (0 = UNASSIGNED); a later DROP TABLE frees the slot but not
6970 // the id.
6971 self.next_rel_id += 1;
6972 let rid = row_header::RelId(self.next_rel_id);
6973 self.tables[idx].set_rel_id(rid);
6974 Ok(())
6975 }
6976
6977 /// v7.39 (round 436) — the session's temporary table of this name wins
6978 /// over a permanent one, as `pg_temp` does in PG's search path and as
6979 /// MySQL's TEMPORARY shadowing does. Every name → index resolution in
6980 /// this catalog goes through here.
6981 fn resolve_index(&self, name: &str) -> Option<usize> {
6982 if let Some(prefix) = &self.temp_prefix {
6983 let mut mangled = String::with_capacity(prefix.len() + name.len());
6984 mangled.push_str(prefix);
6985 mangled.push_str(name);
6986 if let Some(idx) = self.by_name.get(&mangled) {
6987 return Some(*idx);
6988 }
6989 }
6990 self.by_name.get(name).copied()
6991 }
6992
6993 /// v7.39 (round 436) — install the calling session's temp namespace.
6994 /// `None` disables temp resolution entirely (a session that never made
6995 /// one pays a single `Option` check per lookup).
6996 pub fn set_temp_prefix(&mut self, prefix: Option<String>) {
6997 self.temp_prefix = prefix;
6998 }
6999
7000 /// The mangled storage name a temp table of `name` takes in this
7001 /// session, or `None` when the session has no temp namespace.
7002 #[must_use]
7003 pub fn temp_name_for(&self, name: &str) -> Option<String> {
7004 self.temp_prefix
7005 .as_ref()
7006 .map(|p| alloc::format!("{p}{name}"))
7007 }
7008
7009 pub fn get(&self, name: &str) -> Option<&Table> {
7010 let idx = self.resolve_index(name)?;
7011 self.tables.get(idx)
7012 }
7013
7014 pub fn get_mut(&mut self, name: &str) -> Option<&mut Table> {
7015 let idx = self.resolve_index(name)?;
7016 // v7.39 (round 496) — the choke point for changing a table, so the
7017 // record is taken here. Over-approximate on purpose: a caller that
7018 // takes the handle and writes nothing merely carries that table
7019 // through a commit, which is the old behaviour.
7020 let recorded = self.tables.get(idx).map(|t| t.schema().name.clone());
7021 if let Some(n) = recorded {
7022 self.dirty_tables.insert(n);
7023 }
7024 self.tables.get_mut(idx)
7025 }
7026
7027 /// v7.39 (round 496) — the tables changed through this handle since
7028 /// [`Self::clear_dirty_tables`]. See `dirty_tables`.
7029 #[must_use]
7030 pub fn dirty_tables(&self) -> &alloc::collections::BTreeSet<String> {
7031 &self.dirty_tables
7032 }
7033
7034 /// r1059 — mark one table dirty without taking its handle. The
7035 /// rebase/merge paths replace a tx's shadow with a fresh base
7036 /// clone and must carry the tx's OWN dirty window across (the
7037 /// base's set is an ever-growing history, never cleared).
7038 pub fn mark_table_dirty(&mut self, name: &str) {
7039 self.dirty_tables.insert(name.into());
7040 }
7041
7042 /// v7.39 (round 496) — start a fresh recording window. A transaction's
7043 /// shadow calls this at BEGIN so the set means "changed by this tx".
7044 /// 7.38.1 S3.1 — one window covers both records (tables and the
7045 /// non-table families).
7046 pub fn clear_dirty_tables(&mut self) {
7047 self.dirty_tables.clear();
7048 self.dirty_nontable.clear();
7049 }
7050
7051 /// 7.38.1 S3.1 (D4) — record a non-table object as changed by this
7052 /// window. Called from every create/alter/rename/drop of the six
7053 /// [`NonTableKind`] families; a rename records BOTH names.
7054 fn mark_nontable_dirty(&mut self, kind: NonTableKind, name: &str) {
7055 self.dirty_nontable.insert((kind, name.into()));
7056 }
7057
7058 /// 7.38.1 S3.1 (D4) — reconcile the six non-table families with
7059 /// `base` (the latest committed catalog): every entry this window
7060 /// did NOT touch is taken from base — existence, definition and
7061 /// absence alike — so a neighbour's CREATE / ALTER / DROP of a
7062 /// sequence, view, matview, enum, domain or composite type
7063 /// survives a poisoned transaction's COMMIT. Entries this window
7064 /// DID touch keep the shadow's version (the tx's own DDL wins its
7065 /// own objects, exactly like the dirty-table merge above it).
7066 pub fn merge_nontable_objects_from(&mut self, base: &Catalog) {
7067 use NonTableKind as K;
7068 fn merge_map<V: Clone>(
7069 kind: NonTableKind,
7070 dirty: &alloc::collections::BTreeSet<(NonTableKind, String)>,
7071 mine: &mut BTreeMap<String, V>,
7072 theirs: &BTreeMap<String, V>,
7073 ) {
7074 let names: alloc::vec::Vec<String> =
7075 mine.keys().chain(theirs.keys()).cloned().collect();
7076 for n in names {
7077 if dirty.contains(&(kind, n.clone())) {
7078 continue;
7079 }
7080 match theirs.get(&n) {
7081 Some(v) => {
7082 mine.insert(n, v.clone());
7083 }
7084 None => {
7085 mine.remove(&n);
7086 }
7087 }
7088 }
7089 }
7090 let dirty = self.dirty_nontable.clone();
7091 merge_map(K::Sequence, &dirty, &mut self.sequences, &base.sequences);
7092 merge_map(K::View, &dirty, &mut self.views, &base.views);
7093 merge_map(
7094 K::MaterializedView,
7095 &dirty,
7096 &mut self.materialized_views,
7097 &base.materialized_views,
7098 );
7099 merge_map(K::EnumType, &dirty, &mut self.enum_types, &base.enum_types);
7100 merge_map(
7101 K::DomainType,
7102 &dirty,
7103 &mut self.domain_types,
7104 &base.domain_types,
7105 );
7106 merge_map(
7107 K::CompositeType,
7108 &dirty,
7109 &mut self.composite_types,
7110 &base.composite_types,
7111 );
7112 }
7113
7114 /// v7.39 (round 496) — put `table` in at `name`, replacing any table
7115 /// already there and keeping the rest of the catalog untouched.
7116 ///
7117 /// The commit-time table-granularity merge needs exactly this: take
7118 /// the latest committed catalog, then overwrite only the tables the
7119 /// transaction changed.
7120 pub fn install_table(&mut self, name: &str, table: Table) {
7121 match self.by_name.get(name).copied() {
7122 Some(idx) => self.tables[idx] = table,
7123 None => {
7124 let idx = self.tables.len();
7125 self.tables.push(table);
7126 self.by_name.insert(name.into(), idx);
7127 }
7128 }
7129 self.dirty_tables.insert(name.into());
7130 }
7131
7132 /// v7.37.42 (docker-fair SCALARSQ attack) — resolve a table name to
7133 /// its insertion-order index ONCE, so callers that need to fetch the
7134 /// same table many times (per-row PK probes in correlated scalar
7135 /// subqueries) can avoid the per-call `BTreeMap<String, usize>` string
7136 /// descent. The returned index is stable for the lifetime of the
7137 /// catalog snapshot the caller holds (same engine read guard).
7138 pub fn tables_position_of(&self, name: &str) -> Option<usize> {
7139 self.resolve_index(name)
7140 }
7141
7142 /// Direct positional fetch counterpart to [`tables_position_of`].
7143 /// `idx` must come from `tables_position_of` against the same catalog
7144 /// snapshot — out-of-range returns `None`.
7145 pub fn tables_at(&self, idx: usize) -> Option<&Table> {
7146 self.tables.get(idx)
7147 }
7148
7149 /// v7.34 (crash-recovery P0 #2) — replay a row-level redo log onto
7150 /// this catalog (the [`RowChange`] physical-redo apply primitive that
7151 /// row-level WAL recovery will use in place of statement re-execution).
7152 /// Applies each change in order via the same `Table` mutators the
7153 /// engine used — no uniqueness/FK/parse/plan: the original execution
7154 /// already validated, replay trusts and applies. Positions are
7155 /// physical and only valid when replayed from the matching checkpoint
7156 /// baseline in original order (see [`RowChange`] docs).
7157 ///
7158 /// A change naming an absent table, or whose position is out of range,
7159 /// is a corrupt/misaligned log and surfaces as an error rather than a
7160 /// silent skip.
7161 pub fn apply_redo(&mut self, changes: &[RowChange]) -> Result<(), StorageError> {
7162 // v7.37.5 (mailrs crash-recovery Ask 3) — true batched replay.
7163 // Pre-v7.37.5 each `RowChange::Delete` record ran a fresh
7164 // O(N) PersistentVec rebuild + O(N × indices × log N)
7165 // `rebuild_indices()` — 5000 records × 100k rows × 13 indices
7166 // ≈ 27 min on the mailrs prod-shape WAL.
7167 //
7168 // The strategy: group consecutive changes by table, and for
7169 // each run, compose all the row-level mutations through a
7170 // single "live" tracking vector + a per-table operation log,
7171 // then apply rows + indices ONCE at the end. The result:
7172 // - DELETE blow-up: O(records × rows × indices × log rows)
7173 // → O(rows × indices × log rows) — one rebuild per run.
7174 // - Row-position semantics preserved: positions in a later
7175 // `Delete` / `Update` record reference the layout produced
7176 // by every earlier change; we walk the live-vector
7177 // forward as each change is processed so positions
7178 // translate correctly to the ORIGINAL row index space.
7179 //
7180 // For correctness, even with this batching `apply_redo`
7181 // remains in-order: a single per-table run only batches
7182 // a contiguous slice of changes targeting that table; a
7183 // mid-run change targeting a DIFFERENT table forces a
7184 // flush of the current run.
7185 let mut runs: alloc::vec::Vec<(String, alloc::vec::Vec<&RowChange>)> =
7186 alloc::vec::Vec::new();
7187 for change in changes {
7188 // v7.39 (flip crash-replay P0) — a replayed tombstone carries
7189 // the xmax the CRASHED process allocated, but this process's
7190 // version cursor restarted; without advancing it past every
7191 // replayed version, `Snapshot::visible`'s "deletion is in the
7192 // future" branch (xmax > snapshot.version) resurrects every
7193 // replayed delete. Same recovery contract as the snapshot
7194 // loader (`observe_persisted_version`, the pg_control-style
7195 // nextXid recovery).
7196 if let RowChange::Tombstone { xmax, .. } = change {
7197 row_header::observe_persisted_version(*xmax);
7198 }
7199 let table = match change {
7200 RowChange::Insert { table, .. }
7201 | RowChange::Update { table, .. }
7202 | RowChange::Delete { table, .. }
7203 | RowChange::Tombstone { table, .. } => table.clone(),
7204 };
7205 if runs.last().map(|(t, _)| t.as_str()) != Some(table.as_str()) {
7206 runs.push((table, alloc::vec::Vec::new()));
7207 }
7208 runs.last_mut().unwrap().1.push(change);
7209 }
7210 for (table_name, run) in runs {
7211 self.apply_redo_run_on_table(&table_name, &run)?;
7212 }
7213 Ok(())
7214 }
7215
7216 /// v7.37.5 — apply a contiguous slice of `RowChange`s all
7217 /// targeting the same `table_name`. Composes row mutations
7218 /// through a single live-tracking vector + a single tail
7219 /// for appended `Insert`s + a single in-place edit set for
7220 /// `Update`s, then writes the final row layout to
7221 /// `self.rows` and rebuilds indices ONCE.
7222 fn apply_redo_run_on_table(
7223 &mut self,
7224 table_name: &str,
7225 run: &[&RowChange],
7226 ) -> Result<(), StorageError> {
7227 // Look up the table once; the unchecked unwrap is safe
7228 // because the caller just resolved `table_name` for each
7229 // change.
7230 let table = self.get_mut(table_name).ok_or_else(|| {
7231 StorageError::Corrupt(alloc::format!("redo: unknown table {table_name:?}"))
7232 })?;
7233 // Live-tracking over both pre-existing rows and tail-
7234 // appended Insert rows. `live[i] = true` initially for
7235 // every existing row. Appended Inserts extend with `true`.
7236 // A `Delete` flips entries to `false` (using the position
7237 // mapping that walks live indices in order). An `Update`
7238 // edits in place — collected into an overlay map keyed by
7239 // ORIGINAL row position so later Updates win.
7240 let original_rows: alloc::vec::Vec<Row<'static>> = table.rows().iter().cloned().collect();
7241 let mut live: alloc::vec::Vec<bool> = alloc::vec![true; original_rows.len()];
7242 let mut tail: alloc::vec::Vec<Row<'static>> = alloc::vec::Vec::new();
7243 // Overlay: index into ORIGINAL row space (existing rows
7244 // 0..original_rows.len()) or into tail (offset
7245 // original_rows.len()). Map -> new values.
7246 let mut overlay: alloc::collections::BTreeMap<usize, alloc::vec::Vec<Value<'static>>> =
7247 alloc::collections::BTreeMap::new();
7248 // v7.37.15 (Epic W durable-tombstone slice) — extra bookkeeping
7249 // ONLY when this run actually carries an in-place `Tombstone`.
7250 // A tombstone keeps its row physically present but stamps `xmax`
7251 // on the header; the run finalizer `set_rows_and_rebuild_indices`
7252 // freezes every header (and reassigns ids), so we must re-stamp
7253 // in a post-pass keyed by RowId. When the run has no tombstone
7254 // (every default gate-off replay) this is all skipped and the
7255 // path below stays byte-for-byte the legacy one.
7256 let has_tomb = run.iter().any(|c| matches!(c, RowChange::Tombstone { .. }));
7257 // Ids of the pre-existing rows, snapshotted parallel to
7258 // `original_rows`, and ids of the tail rows filled from each
7259 // `Insert`'s carried `rowid`. Together they let a tombstone name
7260 // the exact row the writer stamped, independent of the ids the
7261 // finalizer will hand out. (When `!has_tomb`, both stay empty.)
7262 // v7.39 (flip crash-replay P0) — ids are tracked UNCONDITIONALLY
7263 // now: the finalizer preserves them so a later WAL record's
7264 // tombstone can still name rows this record produced.
7265 let orig_rowids: alloc::vec::Vec<row_header::RowId> =
7266 table.rowids().iter().copied().collect();
7267 // Headers snapshotted in lock-step: the finalizer preserves
7268 // them so earlier records' tombstone stamps survive.
7269 let orig_headers: alloc::vec::Vec<row_header::RowHeader> =
7270 table.headers().iter().copied().collect();
7271 let mut tail_rowids: alloc::vec::Vec<row_header::RowId> = alloc::vec::Vec::new();
7272 // (RowId, xmax) of every row this run tombstones.
7273 let mut tomb_targets: alloc::vec::Vec<(row_header::RowId, u64)> = alloc::vec::Vec::new();
7274 // Helper: given a "current" position (i.e. position in
7275 // the post-prior-deletes layout), translate to the
7276 // ABSOLUTE position in the unified live + tail space
7277 // by walking the live vector + tail. Returns None when
7278 // the position is out of range.
7279 fn translate(live: &[bool], tail_len: usize, current_pos: usize) -> Option<usize> {
7280 // Walk live[..] counting live entries until we hit
7281 // current_pos. Then if not yet matched, dip into tail.
7282 let mut seen = 0usize;
7283 for (i, &alive) in live.iter().enumerate() {
7284 if alive {
7285 if seen == current_pos {
7286 return Some(i);
7287 }
7288 seen += 1;
7289 }
7290 }
7291 // Position lives in tail. tail_len rows in the tail
7292 // are all live (we haven't deleted any tail rows in
7293 // this simplification; if we did, we'd extend `live`).
7294 let off = current_pos - seen;
7295 if off < tail_len {
7296 Some(live.len() + off)
7297 } else {
7298 None
7299 }
7300 }
7301 for change in run {
7302 match *change {
7303 RowChange::Insert { row, rowid, .. } => {
7304 // Validate against schema before recording the
7305 // change so a corrupt log surfaces as an error
7306 // rather than silently mis-applying.
7307 if row.len() != table.schema().columns.len() {
7308 return Err(StorageError::ArityMismatch {
7309 expected: table.schema().columns.len(),
7310 actual: row.len(),
7311 });
7312 }
7313 tail.push(row.clone());
7314 // Keep the id lock-step with `tail` so a later
7315 // tombstone (this run or a later WAL record) can
7316 // find the row by the id the writer captured.
7317 tail_rowids.push(*rowid);
7318 }
7319 RowChange::Update { pos, new_row, .. } => {
7320 if new_row.len() != table.schema().columns.len() {
7321 return Err(StorageError::ArityMismatch {
7322 expected: table.schema().columns.len(),
7323 actual: new_row.len(),
7324 });
7325 }
7326 let abs = translate(&live, tail.len(), *pos).ok_or_else(|| {
7327 StorageError::Corrupt(alloc::format!(
7328 "redo: update_row position {pos} out of bounds in table {table_name:?}",
7329 ))
7330 })?;
7331 // Tail edits are applied directly to `tail`
7332 // (we own it); existing-row edits land in
7333 // the overlay map keyed by original index.
7334 if abs < live.len() {
7335 overlay.insert(abs, new_row.clone());
7336 } else {
7337 tail[abs - live.len()] = Row::new(new_row.clone());
7338 }
7339 }
7340 RowChange::Delete { positions, .. } => {
7341 // De-dup + sort so the translate walk stays
7342 // monotone (the second translate doesn't have
7343 // to redo work the first one did, in principle;
7344 // we keep it simple here and re-walk per
7345 // position). Bounds-filter silently mirrors
7346 // `Table::delete_rows`.
7347 let mut sorted: alloc::vec::Vec<usize> = positions.clone();
7348 sorted.sort_unstable();
7349 sorted.dedup();
7350 // Walk live[] once per Delete record to
7351 // translate all positions in this record's
7352 // post-prior-deletes layout to absolute
7353 // indices. We MUST defer the live[] flip
7354 // until after all positions are translated
7355 // so two positions in the same record
7356 // (e.g. [3, 7]) reference the same layout.
7357 let mut to_flip_live: alloc::vec::Vec<usize> = alloc::vec::Vec::new();
7358 let mut to_flip_tail: alloc::vec::Vec<usize> = alloc::vec::Vec::new();
7359 // Two-pointer walk: live[i] scanned monotonically,
7360 // sorted positions consumed in order.
7361 let mut seen = 0usize;
7362 let mut sp = sorted.iter().peekable();
7363 for (i, &alive) in live.iter().enumerate() {
7364 if !alive {
7365 continue;
7366 }
7367 while let Some(&&p) = sp.peek() {
7368 if seen == p {
7369 to_flip_live.push(i);
7370 sp.next();
7371 } else {
7372 break;
7373 }
7374 }
7375 if sp.peek().is_none() {
7376 break;
7377 }
7378 seen += 1;
7379 }
7380 // Remaining positions fall into the tail.
7381 for &p in sp {
7382 // p >= seen and refers to the (p - seen)-th
7383 // entry in tail. Filter out-of-bounds.
7384 let off = p - seen;
7385 if off < tail.len() {
7386 to_flip_tail.push(off);
7387 }
7388 }
7389 for i in to_flip_live {
7390 live[i] = false;
7391 // Any pending overlay edit for this
7392 // index is moot — the row is gone.
7393 overlay.remove(&i);
7394 }
7395 // Tail deletes: remove in REVERSE order so
7396 // shifting indices stay valid.
7397 to_flip_tail.sort_unstable();
7398 to_flip_tail.dedup();
7399 for off in to_flip_tail.into_iter().rev() {
7400 tail.remove(off);
7401 {
7402 // Keep the id vector lock-step with `tail`.
7403 tail_rowids.remove(off);
7404 }
7405 // Re-key tail-relative overlay entries that
7406 // were past `off` — in practice tail edits
7407 // are applied directly so the overlay map
7408 // only holds existing-row keys; nothing to
7409 // do here.
7410 }
7411 }
7412 RowChange::Tombstone { rowids, xmax, .. } => {
7413 // An in-place tombstone leaves the row physically
7414 // present — it does not touch `live` / `tail` /
7415 // `overlay`. Record the (id, xmax) targets; the
7416 // post-finalizer pass re-stamps `xmax` onto the
7417 // matching row's (otherwise-frozen) header.
7418 for rid in rowids {
7419 tomb_targets.push((*rid, *xmax));
7420 }
7421 }
7422 }
7423 }
7424 // Compose the final row layout: keep existing rows where
7425 // live[i] = true, applying overlay edits in place; then
7426 // append the surviving tail.
7427 let mut new_rows: PersistentVec<Row> = PersistentVec::new();
7428 let mut new_hot_bytes: u64 = 0;
7429 let schema_snapshot = table.schema().clone();
7430 // Parallel to `new_rows` (only built when `has_tomb`): the RowId
7431 // of each row in its FINAL slot, so the post-pass can map a
7432 // tombstone target id → the slot to re-stamp `xmax` on.
7433 let mut final_rowids: alloc::vec::Vec<row_header::RowId> = alloc::vec::Vec::new();
7434 let mut final_headers: alloc::vec::Vec<row_header::RowHeader> = alloc::vec::Vec::new();
7435 for (i, row) in original_rows.into_iter().enumerate() {
7436 if !live[i] {
7437 continue;
7438 }
7439 let final_row = if let Some(new_values) = overlay.remove(&i) {
7440 Row::new(new_values)
7441 } else {
7442 row
7443 };
7444 new_hot_bytes = new_hot_bytes
7445 .saturating_add(row_body_encoded_len(&final_row, &schema_snapshot) as u64);
7446 new_rows.push_mut(final_row);
7447 final_rowids.push(
7448 orig_rowids
7449 .get(i)
7450 .copied()
7451 .unwrap_or(row_header::RowId::UNASSIGNED),
7452 );
7453 final_headers.push(
7454 orig_headers
7455 .get(i)
7456 .copied()
7457 .unwrap_or_else(row_header::RowHeader::frozen),
7458 );
7459 }
7460 for (off, row) in tail.into_iter().enumerate() {
7461 new_hot_bytes =
7462 new_hot_bytes.saturating_add(row_body_encoded_len(&row, &schema_snapshot) as u64);
7463 new_rows.push_mut(row);
7464 final_rowids.push(
7465 tail_rowids
7466 .get(off)
7467 .copied()
7468 .unwrap_or(row_header::RowId::UNASSIGNED),
7469 );
7470 final_headers.push(row_header::RowHeader::frozen());
7471 }
7472 // v7.39 (flip crash-replay P0) — id-preserving finalizer, so a
7473 // LATER WAL record's tombstone still resolves rows this record
7474 // produced (per-statement replay used to reassign ids between
7475 // records, orphaning every cross-record tombstone target).
7476 table.set_rows_and_rebuild_indices_with_rowids(
7477 new_rows,
7478 new_hot_bytes,
7479 &final_rowids,
7480 &final_headers,
7481 );
7482 // v7.37.15 (Epic W durable-tombstone slice) — header-preserving
7483 // re-stamp. `set_rows_and_rebuild_indices` above froze every
7484 // header, so any row this run tombstoned is currently all-
7485 // visible again. Re-apply the `xmax` stamp by matching the
7486 // tombstone's target RowId against the final-slot id map. This
7487 // is what makes a gate-on DELETE durable across replay without
7488 // changing the on-disk snapshot format (headers/ids are still
7489 // NOT serialised — that is the deferred V6 coupling; see below).
7490 if has_tomb && !tomb_targets.is_empty() {
7491 let mut id_to_slot: alloc::collections::BTreeMap<row_header::RowId, usize> =
7492 alloc::collections::BTreeMap::new();
7493 for (slot, rid) in final_rowids.iter().enumerate() {
7494 if *rid != row_header::RowId::UNASSIGNED {
7495 id_to_slot.insert(*rid, slot);
7496 }
7497 }
7498 let table = self.get_mut(table_name).ok_or_else(|| {
7499 StorageError::Corrupt(alloc::format!("redo: unknown table {table_name:?}"))
7500 })?;
7501 for (rid, xmax) in &tomb_targets {
7502 match id_to_slot.get(rid) {
7503 Some(&slot) => {
7504 // First-deleter-wins + bounds handled inside.
7505 let _ = table.mark_row_deleted(slot, *xmax);
7506 }
7507 None => {
7508 // The target row was not produced by THIS redo
7509 // run and its id was not in the run-start
7510 // snapshot — the documented cross-checkpoint
7511 // limitation: after a checkpoint restore the
7512 // table's ids are reassigned (not yet persisted
7513 // in the envelope), so a tombstone naming a
7514 // pre-checkpoint row cannot be resolved by id.
7515 // Skipping leaves the row visible (identical to
7516 // the pre-Epic-W non-durable behaviour); it is
7517 // never a correctness regression, only an
7518 // unclosed durability gap the V6 envelope slice
7519 // closes. Counted for observability.
7520 UNRESOLVED_TOMBSTONES.fetch_add(1, core::sync::atomic::Ordering::Relaxed);
7521 }
7522 }
7523 }
7524 }
7525 Ok(())
7526 }
7527
7528 fn table_for_redo(&mut self, name: &str) -> Result<&mut Table, StorageError> {
7529 self.get_mut(name)
7530 .ok_or_else(|| StorageError::Corrupt(alloc::format!("redo: unknown table {name:?}")))
7531 }
7532
7533 /// v7.34 (crash-recovery P0 #2) — enable row-level redo capture on
7534 /// every table (the engine calls this before a mutating statement
7535 /// when persistence is on; idempotent, keeps any in-flight capture).
7536 pub fn enable_redo_all(&mut self) {
7537 for t in &mut self.tables {
7538 t.enable_redo();
7539 }
7540 }
7541
7542 /// v7.34 — drain the row-level redo captured across all tables, in
7543 /// table order then per-table apply order, and stop capturing. The
7544 /// engine calls this after a successful mutating statement and writes
7545 /// the returned [`RowChange`]s to the WAL in place of the SQL text.
7546 pub fn drain_redo(&mut self) -> Vec<RowChange> {
7547 let mut all = Vec::new();
7548 for t in &mut self.tables {
7549 all.extend(t.take_redo());
7550 }
7551 all
7552 }
7553
7554 pub fn table_count(&self) -> usize {
7555 self.tables.len()
7556 }
7557
7558 /// v7.14.0 — remove a table by name. Returns `true` when the
7559 /// table existed (and is now gone), `false` when it didn't.
7560 /// Used by `DROP TABLE` from pg_dump / mysqldump preambles
7561 /// where the dump re-creates schema and starts with
7562 /// `DROP TABLE IF EXISTS`.
7563 pub fn drop_table(&mut self, name: &str) -> bool {
7564 // v7.39 (round 436) — resolve through the session's temp namespace
7565 // first, exactly as a read would: MariaDB's plain `DROP TABLE tmp`
7566 // drops the TEMPORARY one and leaves a permanent namesake standing
7567 // (measured). Removing by the raw name would have dropped the
7568 // permanent table out from under every other session.
7569 let key = match self.temp_prefix.as_ref() {
7570 Some(p) => {
7571 let mangled = alloc::format!("{p}{name}");
7572 if self.by_name.contains_key(&mangled) {
7573 mangled
7574 } else {
7575 name.into()
7576 }
7577 }
7578 None => name.into(),
7579 };
7580 let Some(idx) = self.by_name.remove(&key) else {
7581 return false;
7582 };
7583 // v7.39 (round 496) — see `dirty_tables`. Recorded under the
7584 // RESOLVED key, which is what a commit-time merge looks up.
7585 self.dirty_tables.insert(key.clone());
7586 // swap_remove invalidates the trailing index → rebuild
7587 // by_name for affected entries.
7588 self.tables.swap_remove(idx);
7589 // Re-stamp moved table's index slot in by_name.
7590 if idx < self.tables.len() {
7591 let moved_name = self.tables[idx].schema.name.clone();
7592 self.by_name.insert(moved_name, idx);
7593 }
7594 true
7595 }
7596
7597 /// v7.16.2 — rename a table (mailrs round-10 A.5). Updates
7598 /// the schema name, the catalog name → index map, and
7599 /// rewrites every reference dangling at the table name:
7600 /// * every FK on every OTHER table whose `parent_table`
7601 /// pointed at the old name now points at the new
7602 /// name, so FK enforcement keeps working
7603 /// * every trigger watching the table updates its `table`
7604 /// field
7605 /// Returns `Ok` on success; `Err(StorageError::TableNotFound)`
7606 /// when the old name isn't in the catalog and
7607 /// `Err(StorageError::DuplicateTable)` when the new name is
7608 /// already taken.
7609 pub fn rename_table(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
7610 if old == new {
7611 return Ok(());
7612 }
7613 if self.by_name.contains_key(new) {
7614 return Err(StorageError::Corrupt(format!(
7615 "rename_table: target name {new:?} already exists"
7616 )));
7617 }
7618 let idx = self
7619 .by_name
7620 .remove(old)
7621 .ok_or_else(|| StorageError::TableNotFound { name: old.into() })?;
7622 self.tables[idx].schema.name = new.to_string();
7623 self.by_name.insert(new.to_string(), idx);
7624 for t in &mut self.tables {
7625 for fk in &mut t.schema.foreign_keys {
7626 if fk.parent_table == old {
7627 fk.parent_table = new.to_string();
7628 }
7629 }
7630 }
7631 for trig in &mut self.triggers {
7632 if trig.table == old {
7633 trig.table = new.to_string();
7634 }
7635 }
7636 Ok(())
7637 }
7638
7639 /// v7.16.2 — rename an index by name. Walks every table
7640 /// since the index lives on its owning table; updates the
7641 /// name in place. Errors with `IndexNotFound` when no
7642 /// index matches. mailrs round-10 A.5.
7643 pub fn rename_index(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
7644 if old == new {
7645 return Ok(());
7646 }
7647 // Reject the new name if it already exists anywhere.
7648 for t in &self.tables {
7649 if t.indices.iter().any(|i| i.name == new) {
7650 return Err(StorageError::Corrupt(format!(
7651 "rename_index: target name {new:?} already exists"
7652 )));
7653 }
7654 }
7655 for t in &mut self.tables {
7656 for i in &mut t.indices {
7657 if i.name == old {
7658 i.name = new.to_string();
7659 return Ok(());
7660 }
7661 }
7662 }
7663 Err(StorageError::IndexNotFound { name: old.into() })
7664 }
7665
7666 /// v7.14.0 — remove a named index across the catalog.
7667 /// Returns `true` when found + dropped.
7668 pub fn drop_named_index(&mut self, name: &str) -> bool {
7669 for t in &mut self.tables {
7670 let before = t.indices.len();
7671 t.indices.retain(|i| i.name != name);
7672 if t.indices.len() != before {
7673 return true;
7674 }
7675 }
7676 false
7677 }
7678
7679 /// Borrow-free copy of every table's name in catalog order
7680 /// (= insertion order, matching the on-disk encoding).
7681 pub fn table_names(&self) -> Vec<String> {
7682 self.tables.iter().map(|t| t.schema.name.clone()).collect()
7683 }
7684
7685 /// v7.39 (round 436) — the marker every session's temporary-table
7686 /// namespace starts with. Public so the catalog synths can tell a
7687 /// temp table from an ordinary one without knowing the session id.
7688 pub const TEMP_NAME_MARKER: &'static str = "__spg_temp_";
7689
7690 /// v7.39 (round 437) — how a stored table name should appear to the
7691 /// CALLING session in a catalog listing (SHOW TABLES, pg_class,
7692 /// information_schema, …):
7693 /// * an ordinary table → its own name
7694 /// * this session's temporary table → its logical name, prefix stripped
7695 /// * another session's temporary table → `None`, i.e. not listed
7696 ///
7697 /// Measured on both oracles: MariaDB 11 and PG 18 each list the calling
7698 /// session's own temporary tables and neither lists anybody else's.
7699 /// Round 436 stored temp tables under a prefix without teaching the
7700 /// listings about it, so the mangled names leaked to every client.
7701 #[must_use]
7702 pub fn listed_name<'a>(&self, stored: &'a str) -> Option<&'a str> {
7703 if !stored.starts_with(Self::TEMP_NAME_MARKER) {
7704 return Some(stored);
7705 }
7706 let prefix = self.temp_prefix.as_ref()?;
7707 stored.strip_prefix(prefix.as_str())
7708 }
7709
7710 /// The listing names of every table this session may see, in catalog
7711 /// order. See [`Catalog::listed_name`].
7712 #[must_use]
7713 pub fn visible_table_names(&self) -> Vec<String> {
7714 self.tables
7715 .iter()
7716 .filter_map(|t| self.listed_name(&t.schema.name).map(String::from))
7717 .collect()
7718 }
7719
7720 /// v5.1: register a cold-tier segment that already lives in
7721 /// memory (caller did the file read). Returns the
7722 /// `segment_id` that `RowLocator::Cold { segment_id, .. }`
7723 /// will reference — currently this is just the index into
7724 /// `cold_segments`, but treat it as an opaque token.
7725 ///
7726 /// Storage is `no_std`, so file I/O is the caller's
7727 /// responsibility — `spg-server` reads the file and forwards
7728 /// the bytes here. The bytes stay resident in the catalog
7729 /// for the life of the `Catalog`, parsed only once.
7730 pub fn load_segment_bytes(&mut self, bytes: Vec<u8>) -> Result<u32, StorageError> {
7731 let id = u32::try_from(self.cold_segments.len()).map_err(|_| {
7732 StorageError::Corrupt("cold segment count would exceed u32::MAX".into())
7733 })?;
7734 let seg = OwnedSegment::from_bytes(bytes)
7735 .map_err(|e| StorageError::Corrupt(format!("cold segment parse failed: {e}")))?;
7736 self.cold_segments.push(Some(Arc::new(seg)));
7737 Ok(id)
7738 }
7739
7740 /// v6.7.3 — register a cold-tier segment at a specific id. Used
7741 /// by the spg-server manifest-boot path so segments whose
7742 /// neighbouring ids were retired by compaction still get back
7743 /// the same `segment_id` they had pre-restart (the
7744 /// `RowLocator::Cold { segment_id }` baked into the BTree-index
7745 /// snapshot persists across restart and must continue to
7746 /// resolve).
7747 ///
7748 /// Pads the Vec with `None` slots up to `target_id` if needed.
7749 /// Errors when the target slot is already occupied (would
7750 /// stomp another segment), the parse fails, or `target_id`
7751 /// exceeds `u32::MAX`.
7752 pub fn load_segment_bytes_at(
7753 &mut self,
7754 target_id: u32,
7755 bytes: Vec<u8>,
7756 ) -> Result<(), StorageError> {
7757 let seg = OwnedSegment::from_bytes(bytes)
7758 .map_err(|e| StorageError::Corrupt(format!("cold segment parse failed: {e}")))?;
7759 let idx = target_id as usize;
7760 while self.cold_segments.len() <= idx {
7761 self.cold_segments.push(None);
7762 }
7763 if self.cold_segments[idx].is_some() {
7764 return Err(StorageError::Corrupt(format!(
7765 "load_segment_bytes_at: segment_id {target_id} already occupied"
7766 )));
7767 }
7768 self.cold_segments[idx] = Some(Arc::new(seg));
7769 Ok(())
7770 }
7771
7772 /// v6.7.3 — retire a cold-tier segment slot (compaction-driven).
7773 /// The physical file is the caller's concern (typically kept
7774 /// on disk until the next CHECKPOINT writes a manifest that
7775 /// no longer lists it); this just flips the in-memory slot
7776 /// to `None` so later cold lookups for `segment_id` resolve
7777 /// as "unknown" instead of returning a stale row.
7778 ///
7779 /// No-op when the slot is already `None`. Errors only when
7780 /// `segment_id` is out of bounds.
7781 pub fn tombstone_segment(&mut self, segment_id: u32) -> Result<(), StorageError> {
7782 let idx = segment_id as usize;
7783 if idx >= self.cold_segments.len() {
7784 return Err(StorageError::Corrupt(format!(
7785 "tombstone_segment: segment_id {segment_id} out of bounds (len={})",
7786 self.cold_segments.len()
7787 )));
7788 }
7789 self.cold_segments[idx] = None;
7790 Ok(())
7791 }
7792
7793 /// Number of *active* (non-tombstoned) cold segments.
7794 #[must_use]
7795 pub fn cold_segment_count(&self) -> usize {
7796 self.cold_segments.iter().filter(|s| s.is_some()).count()
7797 }
7798
7799 /// v7.37.42 (docker-fair SCALARSQ attack 3) — short-circuit guard
7800 /// for scan loops that conditionally walk the cold tier. Returns
7801 /// `false` when the catalog has never loaded a cold segment (or all
7802 /// segments are tombstoned), so callers can skip the per-table cold
7803 /// PK-index walk entirely on hot-only databases. O(N segments);
7804 /// typical N is small (single-digit) so the check is sub-µs.
7805 #[must_use]
7806 pub fn has_any_cold_segments(&self) -> bool {
7807 self.cold_segments.iter().any(Option::is_some)
7808 }
7809
7810 /// Slot count including tombstones (= the next id the
7811 /// no-arg `load_segment_bytes` would allocate).
7812 #[must_use]
7813 pub fn cold_segment_slot_count(&self) -> usize {
7814 self.cold_segments.len()
7815 }
7816
7817 /// v6.2.7 — list every *active* cold-tier segment id known to
7818 /// this catalog (skips compaction tombstones since v6.7.3).
7819 /// Used by EXPLAIN ANALYZE to annotate scan nodes with the
7820 /// segments they could have walked.
7821 #[must_use]
7822 pub fn cold_segment_ids_global(&self) -> Vec<u32> {
7823 self.cold_segments
7824 .iter()
7825 .enumerate()
7826 .filter_map(|(i, s)| s.as_ref().map(|_| i as u32))
7827 .collect()
7828 }
7829
7830 /// v5.2.1: sum of `Table::hot_bytes` across every table. The v5.2
7831 /// freezer compares this against `SPG_HOT_TIER_BYTES` (parsed at
7832 /// server startup; default 4 GiB) and wakes when the budget is
7833 /// crossed. Pre-freezer (v5.2.1) this is measurement-only — the
7834 /// counter exposes whether the budget is being approached without
7835 /// triggering any demotion.
7836 #[must_use]
7837 pub fn hot_tier_bytes(&self) -> u64 {
7838 self.tables
7839 .iter()
7840 .map(Table::hot_bytes)
7841 .fold(0u64, u64::saturating_add)
7842 }
7843
7844 /// v5.2.2: freeze the **first** `max_rows` rows of `table_name`'s
7845 /// hot tier into a brand-new cold-tier segment. The named `BTree`
7846 /// index supplies the per-row PK (its column must be an integer
7847 /// type — v5.2.2 only supports `IndexKey::Int` PKs, matching the
7848 /// `index_key_as_u64` constraint used by the cold-tier lookup
7849 /// path). On success returns a [`FreezeReport`] with the
7850 /// freshly-allocated segment id, the count of rows that moved,
7851 /// the encoded segment bytes (so the caller can persist them to
7852 /// disk for later reload via `SPG_PRELOAD_COLD_SEGMENT`), and the
7853 /// hot-tier byte delta that was reclaimed.
7854 ///
7855 /// **Semantics**:
7856 /// 1. The first `max_rows` rows (by hot-tier position — same as
7857 /// insertion order under v4.39 `PersistentVec`) are read.
7858 /// 2. Rows are sorted ascending by PK and serialised into a new
7859 /// segment via [`encode_segment`].
7860 /// 3. The hot rows are dropped via [`Table::delete_rows`]; the
7861 /// `rebuild_indices` it triggers regenerates `Hot` locators
7862 /// for every remaining row (their positions shift down by
7863 /// `max_rows`). Existing `Cold` locators in this index — from
7864 /// a previous freeze — are also rebuilt **but with empty
7865 /// payload** since rebuild reads only `self.rows`; this
7866 /// routine re-registers them at the end of the call so the
7867 /// user-visible state preserves all prior cold locators.
7868 /// 4. The new segment is loaded into `self.cold_segments` via
7869 /// [`Catalog::load_segment_bytes`] (allocating a fresh
7870 /// `segment_id`). New `Cold` locators are registered on the
7871 /// named index — one per frozen row.
7872 ///
7873 /// **v5.2.2 limits** (relaxed in later sub-versions):
7874 /// - INSERT-only flow: subsequent UPDATE/DELETE on a frozen row
7875 /// returns a stale-locator error (no promote-on-write until
7876 /// v5.2.3).
7877 /// - Single-table scope: callers iterate tables themselves.
7878 /// - All-or-nothing: returns `Err` and leaves catalog unchanged
7879 /// if any step fails before the atomic swap point.
7880 ///
7881 /// Errors:
7882 /// - [`StorageError::Corrupt`] for missing table/index, non-`BTree`
7883 /// index, non-integer PK column, `max_rows == 0`, or
7884 /// `max_rows > row_count`.
7885 /// - The encoder's [`SegmentError`] surfaces as `Corrupt` (the
7886 /// only realistic source is "a single row is larger than the
7887 /// page size"; SPG schemas don't hit it in practice).
7888 pub fn freeze_oldest_to_cold(
7889 &mut self,
7890 table_name: &str,
7891 index_name: &str,
7892 max_rows: usize,
7893 ) -> Result<FreezeReport, StorageError> {
7894 // --- validation phase: never mutates ---------------------
7895 if max_rows == 0 {
7896 return Err(StorageError::Corrupt(
7897 "freeze_oldest_to_cold: max_rows must be > 0".into(),
7898 ));
7899 }
7900 let table = self.get(table_name).ok_or_else(|| {
7901 StorageError::Corrupt(format!(
7902 "freeze_oldest_to_cold: table {table_name:?} not found"
7903 ))
7904 })?;
7905 if max_rows > table.rows.len() {
7906 return Err(StorageError::Corrupt(format!(
7907 "freeze_oldest_to_cold: max_rows {max_rows} > row_count {}",
7908 table.rows.len()
7909 )));
7910 }
7911 let idx = table
7912 .indices
7913 .iter()
7914 .find(|i| i.name == index_name)
7915 .ok_or_else(|| {
7916 StorageError::Corrupt(format!(
7917 "freeze_oldest_to_cold: index {index_name:?} not found on {table_name:?}"
7918 ))
7919 })?;
7920 if !matches!(idx.kind, IndexKind::BTree(_)) {
7921 return Err(StorageError::Corrupt(format!(
7922 "freeze_oldest_to_cold: index {index_name:?} is NSW; only BTree indices may freeze"
7923 )));
7924 }
7925 let column_position = idx.column_position;
7926
7927 // --- segment build phase: reads only --------------------
7928 let schema = table.schema.clone();
7929 let mut to_freeze: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(max_rows);
7930 for row_idx in 0..max_rows {
7931 let row = table.rows.get(row_idx).expect("bounds-checked above");
7932 let key = IndexKey::from_value(&row.values[column_position]).ok_or_else(|| {
7933 StorageError::Corrupt(format!(
7934 "freeze_oldest_to_cold: row {row_idx} has NULL / non-key value in index column"
7935 ))
7936 })?;
7937 let pk_u64 = index_key_as_u64(&key).ok_or_else(|| {
7938 StorageError::Corrupt(format!(
7939 "freeze_oldest_to_cold: index {index_name:?} column type is non-integer; \
7940 v5.2.2 cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
7941 ))
7942 })?;
7943 to_freeze.push((pk_u64, encode_row_body_dense(row, &schema), key));
7944 }
7945 // encode_segment requires ascending u64 keys. Sort by PK
7946 // before encoding; the caller's row-position order is not
7947 // necessarily PK order (e.g. workloads that insert random
7948 // PKs).
7949 to_freeze.sort_by_key(|(k, _, _)| *k);
7950 // Reject duplicate PKs — encode_segment also rejects them
7951 // (`SegmentError::UnsortedKey`), but the resulting error
7952 // message there is misleading. Surface a clearer one.
7953 for w in to_freeze.windows(2) {
7954 if w[0].0 == w[1].0 {
7955 return Err(StorageError::Corrupt(format!(
7956 "freeze_oldest_to_cold: duplicate PK {} in freeze batch",
7957 w[0].0
7958 )));
7959 }
7960 }
7961 // Snapshot the (key, locator) pairs that will be registered
7962 // post-swap. Cloning the IndexKey out before the move makes
7963 // the registration loop borrow-free.
7964 let post_swap_keys: Vec<IndexKey> = to_freeze.iter().map(|(_, _, k)| k.clone()).collect();
7965 // Segment encode is now infallible w.r.t. ordering. Map the
7966 // `SegmentError` into a `StorageError::Corrupt` so the
7967 // public surface stays one error type.
7968 let seg_rows: Vec<(u64, Vec<u8>)> = to_freeze
7969 .into_iter()
7970 .map(|(k, body, _)| (k, body))
7971 .collect();
7972 let frozen_rows = seg_rows.len();
7973 let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
7974 .map_err(|e| StorageError::Corrupt(format!("freeze_oldest_to_cold: encode: {e}")))?;
7975
7976 // --- atomic swap phase: mutations only past this point ---
7977 // v5.2.3 made `Table::rebuild_indices` preserve every Cold
7978 // locator across the per-table rebuild, so `delete_rows`
7979 // below no longer wipes prior-freeze cold entries. The pre-
7980 // v5.2.3 capture-then-re-register that used to live here
7981 // was removed in v5.3.1 — keeping it would double-count
7982 // every prior-frozen key's Cold locator on each subsequent
7983 // freeze.
7984 let bytes_before = self.get(table_name).expect("just validated").hot_bytes();
7985 let positions: Vec<usize> = (0..max_rows).collect();
7986 let t_mut = self
7987 .get_mut(table_name)
7988 .expect("just validated; still present");
7989 let removed = t_mut.delete_rows(&positions);
7990 debug_assert_eq!(removed, max_rows, "delete_rows count matches request");
7991 let bytes_after = t_mut.hot_bytes();
7992 let bytes_freed = bytes_before.saturating_sub(bytes_after);
7993
7994 let segment_id = self
7995 .load_segment_bytes(seg_bytes.clone())
7996 .map_err(|e| StorageError::Corrupt(format!("freeze_oldest_to_cold: load: {e}")))?;
7997 let new_cold = post_swap_keys.into_iter().map(|k| {
7998 (
7999 k,
8000 RowLocator::Cold {
8001 segment_id,
8002 page_offset: 0,
8003 },
8004 )
8005 });
8006 let t_mut = self.get_mut(table_name).expect("still present");
8007 t_mut.register_cold_locators(index_name, new_cold)?;
8008 // r944 — a freeze has to say that it froze something.
8009 //
8010 // `has_cold_rows_fast()` reads the cached count, and neither
8011 // freeze path touched it, so afterwards it answered "no cold
8012 // rows" while cold rows existed. That predicate gates four join
8013 // paths, and a gate that wrongly declines the cold-aware path
8014 // drops the frozen rows from the answer.
8015 //
8016 // Marking it stale rather than adding to it: stale reads as
8017 // true, which is the safe direction, and this function cannot
8018 // know the exact total (rows may already have been cold). ANALYZE
8019 // recomputes the number.
8020 t_mut.mark_cold_row_count_stale();
8021
8022 Ok(FreezeReport {
8023 segment_id,
8024 frozen_rows,
8025 bytes_freed,
8026 segment_bytes: seg_bytes,
8027 })
8028 }
8029
8030 /// v5.1: borrow the cold segment at `segment_id`. Used by the
8031 /// spg-server preload path to enumerate (key, locator) pairs
8032 /// after loading a segment, so it can call
8033 /// [`Table::register_cold_locators`] without re-parsing the
8034 /// bytes.
8035 #[must_use]
8036 pub fn cold_segment(&self, segment_id: u32) -> Option<&OwnedSegment> {
8037 self.cold_segments
8038 .get(segment_id as usize)
8039 .and_then(|s| s.as_deref())
8040 }
8041
8042 /// v5.1: resolve a single `RowLocator::Cold` to its underlying
8043 /// `Row`. Decoupled from [`Catalog::lookup_by_pk`] so callers
8044 /// iterating a multi-locator slice (e.g. the engine's index
8045 /// seek path) can dispatch per locator instead of getting back
8046 /// only the first row for a key. Returns `None` when the
8047 /// segment isn't registered, the key isn't `u64`-coercible, or
8048 /// the segment doesn't actually carry the key (bloom or page-
8049 /// index reject).
8050 pub fn resolve_cold_locator(
8051 &self,
8052 table_name: &str,
8053 segment_id: u32,
8054 key: &IndexKey,
8055 ) -> Option<Row<'static>> {
8056 let t = self.get(table_name)?;
8057 let u64_key = index_key_as_u64(key)?;
8058 let seg = self.cold_segments.get(segment_id as usize)?.as_ref()?;
8059 let payload = seg.lookup(u64_key)?;
8060 let (row, _) = decode_row_body_dense(&payload, &t.schema, seg.codec_version()).ok()?;
8061 // v7.39 (pg_stat blks knife) — one cold-tier "block read".
8062 self.cold_read_stats
8063 .cold_reads
8064 .fetch_add(1, core::sync::atomic::Ordering::Relaxed);
8065 Some(row)
8066 }
8067
8068 /// v5.1: indexed PK lookup that dispatches per locator,
8069 /// returning the first matching row from either the hot tier
8070 /// (`Table::rows`) or a registered cold segment.
8071 ///
8072 /// The cold path requires the index column to be coercible to
8073 /// a `u64` (the segment's PK type) and the segment payload to
8074 /// be a [`encode_row_body_dense`]-encoded row body for the
8075 /// same schema. v5.1 ships this for BIGINT / INT / SMALLINT
8076 /// PKs; other types fall through to hot-only behavior.
8077 ///
8078 /// Returns `None` if (a) the table or index doesn't exist,
8079 /// (b) the key isn't in the index at all, or (c) the key was
8080 /// resolved to a stale locator (Hot index out of range, Cold
8081 /// segment id unknown, segment lookup miss). Does not surface
8082 /// segment-decode errors — those would indicate corrupted
8083 /// cold-tier files and should be caught at
8084 /// [`Catalog::load_segment_bytes`] time.
8085 pub fn lookup_by_pk(&self, table: &str, index_name: &str, key: &IndexKey) -> Option<Row<'_>> {
8086 let t = self.get(table)?;
8087 let idx = t.indices.iter().find(|i| i.name == index_name)?;
8088 let locators = idx.lookup_eq(key);
8089 let cold_u64_key = index_key_as_u64(key);
8090 for loc in locators {
8091 match *loc {
8092 RowLocator::Hot(i) => {
8093 if let Some(row) = t.rows.get(i) {
8094 return Some(row.clone());
8095 }
8096 }
8097 RowLocator::Cold {
8098 segment_id,
8099 page_offset: _,
8100 } => {
8101 let Some(u64_key) = cold_u64_key else {
8102 // Key type not coercible to u64 — cold tier
8103 // only handles BIGINT/INT/SMALLINT in v5.1.
8104 continue;
8105 };
8106 let Some(seg) = self
8107 .cold_segments
8108 .get(segment_id as usize)
8109 .and_then(|s| s.as_deref())
8110 else {
8111 // v6.7.3 — `None` slot = compaction
8112 // retired this segment; the live locator
8113 // on a freshly-compacted index points to
8114 // the merged segment_id, so a Cold hit
8115 // here against a tombstone means the BTree
8116 // entry hasn't been swapped yet (mid-
8117 // compaction reader race) or the caller is
8118 // looking up a stale snapshot. Skip — the
8119 // next locator in the list, if any, is
8120 // typically the merged segment.
8121 continue;
8122 };
8123 let Some(payload) = seg.lookup(u64_key) else {
8124 continue;
8125 };
8126 let (row, _) =
8127 decode_row_body_dense(&payload, &t.schema, seg.codec_version()).ok()?;
8128 return Some(row);
8129 }
8130 }
8131 }
8132 None
8133 }
8134
8135 /// v5.2.3: promote a frozen row back to the hot tier so an
8136 /// UPDATE / DELETE can mutate it. Reads the cold-tier row body
8137 /// (decoded from its registered segment), pushes it into
8138 /// `table.rows` via [`Table::insert`] (which also adds a fresh
8139 /// `Hot(new_idx)` locator on `index_name`), then retires the
8140 /// shadowed `Cold` locator via
8141 /// [`Table::remove_cold_locators_for_key`]. The cold-tier row
8142 /// in the segment file becomes garbage — recoverable when a
8143 /// future cold-segment compaction job lands.
8144 ///
8145 /// Returns:
8146 /// - `Ok(Some(new_hot_idx))` when the key resolved through a
8147 /// cold locator and the promote completed. `new_hot_idx` is
8148 /// the position the row now occupies in `table.rows`.
8149 /// - `Ok(None)` when the key has no Cold locator on the index
8150 /// (already hot, or wasn't present at all). Callers treat this
8151 /// as "nothing to do here, fall back to the hot-only path".
8152 ///
8153 /// Errors when the table / index doesn't exist, the index isn't
8154 /// `BTree`, the cold segment is missing / can't decode the row,
8155 /// or the inferred row body fails `Table::insert` validation.
8156 pub fn promote_cold_row(
8157 &mut self,
8158 table_name: &str,
8159 index_name: &str,
8160 key: &IndexKey,
8161 ) -> Result<Option<usize>, StorageError> {
8162 let cold_loc = self.find_cold_locator(table_name, index_name, key)?;
8163 let Some((segment_id, _page_offset)) = cold_loc else {
8164 return Ok(None);
8165 };
8166 let u64_key = index_key_as_u64(key).ok_or_else(|| {
8167 StorageError::Corrupt(
8168 "promote_cold_row: key type not coercible to u64 (cold tier requires integer PK)"
8169 .into(),
8170 )
8171 })?;
8172 // Read the row body from the segment. Borrow the segment +
8173 // schema short-term so we can then take `&mut self` for the
8174 // hot-side insert.
8175 let schema = self
8176 .get(table_name)
8177 .ok_or_else(|| {
8178 StorageError::Corrupt(format!("promote_cold_row: table {table_name:?} not found"))
8179 })?
8180 .schema
8181 .clone();
8182 let seg = self
8183 .cold_segments
8184 .get(segment_id as usize)
8185 .and_then(|s| s.as_ref())
8186 .ok_or_else(|| {
8187 StorageError::Corrupt(format!(
8188 "promote_cold_row: segment {segment_id} not registered on catalog"
8189 ))
8190 })?;
8191 let payload = seg.lookup(u64_key).ok_or_else(|| {
8192 StorageError::Corrupt(format!(
8193 "promote_cold_row: key {u64_key} resolves to segment {segment_id} \
8194 but the segment's bloom/page lookup didn't return a row"
8195 ))
8196 })?;
8197 let (row, _consumed) = decode_row_body_dense(&payload, &schema, seg.codec_version())?;
8198 // Insert the promoted row into the hot tier. `Table::insert`
8199 // appends to `self.rows`, adds a `Hot(new_idx)` locator to
8200 // every BTree index covering the row's keyed columns, and
8201 // increments `hot_bytes`.
8202 let t = self
8203 .get_mut(table_name)
8204 .expect("table existed at lookup time");
8205 t.insert(row)?;
8206 let new_hot_idx =
8207 t.rows.len().checked_sub(1).ok_or_else(|| {
8208 StorageError::Corrupt("promote_cold_row: empty after insert".into())
8209 })?;
8210 // The hot insert added Hot(new_idx) alongside the still-
8211 // present Cold locator. Drop the Cold entry so future
8212 // lookups return only the fresh hot row.
8213 t.remove_cold_locators_for_key(index_name, key)?;
8214 Ok(Some(new_hot_idx))
8215 }
8216
8217 /// v5.2.3: shadow a frozen row's index entry. Used by DELETE
8218 /// when the row to remove lives in a cold-tier segment — the
8219 /// row body stays in the segment file (becoming garbage) but
8220 /// every `Cold` locator for `key` on `index_name` is removed
8221 /// so PK lookups stop returning it.
8222 ///
8223 /// Returns the number of cold locators retired (0 when the key
8224 /// has no cold entries — the DELETE fell on a hot row or a
8225 /// key that was already absent). Errors when the table /
8226 /// index doesn't exist or the index isn't `BTree`.
8227 ///
8228 /// Cold-segment compaction (which merges shadowed-heavy
8229 /// segments and reclaims their disk footprint) lands in a
8230 /// later v5.x sub-version; until then, repeated UPDATE/DELETE
8231 /// of cold rows can amplify cold-segment disk usage by up to
8232 /// 1-2× — still well under typical LSM-tree shadowing because
8233 /// SPG segments are bulk-baked, not write-merged.
8234 pub fn shadow_cold_row(
8235 &mut self,
8236 table_name: &str,
8237 index_name: &str,
8238 key: &IndexKey,
8239 ) -> Result<usize, StorageError> {
8240 let t = self.get_mut(table_name).ok_or_else(|| {
8241 StorageError::Corrupt(format!("shadow_cold_row: table {table_name:?} not found"))
8242 })?;
8243 t.remove_cold_locators_for_key(index_name, key)
8244 }
8245
8246 /// v6.7.4 — read-only slice preparation for the parallel
8247 /// freezer. Walks rows in `row_range`, builds the
8248 /// `(pk_u64, encoded_body, IndexKey)` triples that the
8249 /// coordinator's k-way merge consumes, sorts the slice by
8250 /// `pk_u64`, and returns a [`FreezeSlice`].
8251 ///
8252 /// Caller invariants:
8253 /// - `row_range.end <= table.rows.len()` (caller's job to
8254 /// compute the partition).
8255 /// - All slices passed to `commit_freeze_slices` must cover a
8256 /// contiguous half-open range `[0, total_max_rows)` with no
8257 /// gaps and no overlaps. The coordinator validates this
8258 /// invariant before committing.
8259 ///
8260 /// `&self`-only — multiple workers can run this concurrently
8261 /// against the same `Catalog` reference under the engine's
8262 /// write lock (workers don't mutate; the coordinator does).
8263 pub fn prepare_freeze_slice(
8264 &self,
8265 table_name: &str,
8266 index_name: &str,
8267 row_range: core::ops::Range<usize>,
8268 ) -> Result<FreezeSlice, StorageError> {
8269 let table = self.get(table_name).ok_or_else(|| {
8270 StorageError::Corrupt(format!(
8271 "prepare_freeze_slice: table {table_name:?} not found"
8272 ))
8273 })?;
8274 let idx = table
8275 .indices
8276 .iter()
8277 .find(|i| i.name == index_name)
8278 .ok_or_else(|| {
8279 StorageError::Corrupt(format!(
8280 "prepare_freeze_slice: index {index_name:?} not found on {table_name:?}"
8281 ))
8282 })?;
8283 if !matches!(idx.kind, IndexKind::BTree(_)) {
8284 return Err(StorageError::Corrupt(format!(
8285 "prepare_freeze_slice: index {index_name:?} is NSW; only BTree indices may freeze"
8286 )));
8287 }
8288 if row_range.end > table.rows.len() {
8289 return Err(StorageError::Corrupt(format!(
8290 "prepare_freeze_slice: row_range end {} > row_count {}",
8291 row_range.end,
8292 table.rows.len()
8293 )));
8294 }
8295 let column_position = idx.column_position;
8296 let schema = table.schema.clone();
8297 let mut rows: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(row_range.len());
8298 for row_idx in row_range.clone() {
8299 let row = table.rows.get(row_idx).expect("bounds-checked above");
8300 let key = IndexKey::from_value(&row.values[column_position]).ok_or_else(|| {
8301 StorageError::Corrupt(format!(
8302 "prepare_freeze_slice: row {row_idx} has NULL / non-key value in index column"
8303 ))
8304 })?;
8305 let pk_u64 = index_key_as_u64(&key).ok_or_else(|| {
8306 StorageError::Corrupt(format!(
8307 "prepare_freeze_slice: index {index_name:?} column type is non-integer; \
8308 v5.2.2 cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
8309 ))
8310 })?;
8311 rows.push((pk_u64, encode_row_body_dense(row, &schema), key));
8312 }
8313 rows.sort_by_key(|(k, _, _)| *k);
8314 Ok(FreezeSlice { row_range, rows })
8315 }
8316
8317 /// v6.7.4 — coordinator commit step. Merges N
8318 /// [`FreezeSlice`]s into one segment via the standard
8319 /// [`encode_segment`] path, atomically swaps the catalog
8320 /// state (delete the union row range + register Cold
8321 /// locators + load the segment).
8322 ///
8323 /// Validates that the slices cover a contiguous, gap-free,
8324 /// overlap-free half-open range starting at index 0 (the
8325 /// freezer always freezes "oldest first" — same semantics as
8326 /// the single-threaded [`Catalog::freeze_oldest_to_cold`]).
8327 ///
8328 /// Empty `slices` → no-op success (returns a zero-row report
8329 /// without mutating). Total row count = `Σ slice.rows.len()`.
8330 pub fn commit_freeze_slices(
8331 &mut self,
8332 table_name: &str,
8333 index_name: &str,
8334 slices: Vec<FreezeSlice>,
8335 ) -> Result<FreezeReport, StorageError> {
8336 // --- validation phase: never mutates ---------------------
8337 let table = self.get(table_name).ok_or_else(|| {
8338 StorageError::Corrupt(format!(
8339 "commit_freeze_slices: table {table_name:?} not found"
8340 ))
8341 })?;
8342 let idx = table
8343 .indices
8344 .iter()
8345 .find(|i| i.name == index_name)
8346 .ok_or_else(|| {
8347 StorageError::Corrupt(format!(
8348 "commit_freeze_slices: index {index_name:?} not found on {table_name:?}"
8349 ))
8350 })?;
8351 if !matches!(idx.kind, IndexKind::BTree(_)) {
8352 return Err(StorageError::Corrupt(format!(
8353 "commit_freeze_slices: index {index_name:?} is NSW; only BTree indices may freeze"
8354 )));
8355 }
8356 // Validate slice coverage: contiguous from 0, no gaps, no
8357 // overlaps. Allow the caller to pass slices in any order —
8358 // sort by row_range.start first.
8359 let mut ordered = slices;
8360 ordered.sort_by_key(|s| s.row_range.start);
8361 // Drop fully-empty slices that fell out of an uneven
8362 // partition; they carry no data but contribute to the
8363 // contiguity check, so keep them in line.
8364 let mut expected_start = 0usize;
8365 for s in &ordered {
8366 if s.row_range.start != expected_start {
8367 return Err(StorageError::Corrupt(format!(
8368 "commit_freeze_slices: gap/overlap at row {}; expected start {}",
8369 s.row_range.start, expected_start
8370 )));
8371 }
8372 expected_start = s.row_range.end;
8373 }
8374 let max_rows = expected_start;
8375 if max_rows > table.rows.len() {
8376 return Err(StorageError::Corrupt(format!(
8377 "commit_freeze_slices: total row range {} exceeds row_count {}",
8378 max_rows,
8379 table.rows.len()
8380 )));
8381 }
8382 if max_rows == 0 {
8383 return Ok(FreezeReport {
8384 segment_id: u32::MAX,
8385 frozen_rows: 0,
8386 bytes_freed: 0,
8387 segment_bytes: Vec::new(),
8388 });
8389 }
8390
8391 // --- segment build phase: reads only --------------------
8392 // K-way merge of already-sorted slices. Each slice's rows
8393 // are ascending by pk_u64; we keep a per-slice cursor and
8394 // pull the next-smallest head until every cursor drains.
8395 let total_rows: usize = ordered.iter().map(|s| s.rows.len()).sum();
8396 if total_rows != max_rows {
8397 return Err(StorageError::Corrupt(format!(
8398 "commit_freeze_slices: total slice rows {total_rows} ≠ row_range coverage {max_rows}"
8399 )));
8400 }
8401 let mut cursors: Vec<usize> = alloc::vec![0; ordered.len()];
8402 let mut merged: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(total_rows);
8403 loop {
8404 // Pick the slice whose head row has the smallest key
8405 // and isn't yet exhausted.
8406 let mut pick: Option<usize> = None;
8407 for (i, c) in cursors.iter().enumerate() {
8408 let slice = &ordered[i];
8409 if *c >= slice.rows.len() {
8410 continue;
8411 }
8412 match pick {
8413 None => pick = Some(i),
8414 Some(j) => {
8415 if slice.rows[*c].0 < ordered[j].rows[cursors[j]].0 {
8416 pick = Some(i);
8417 }
8418 }
8419 }
8420 }
8421 let Some(i) = pick else { break };
8422 let row = ordered[i].rows[cursors[i]].clone();
8423 cursors[i] += 1;
8424 merged.push(row);
8425 }
8426 // Reject duplicate PKs — same error as the single-threaded
8427 // path so callers get a uniform surface.
8428 for w in merged.windows(2) {
8429 if w[0].0 == w[1].0 {
8430 return Err(StorageError::Corrupt(format!(
8431 "commit_freeze_slices: duplicate PK {} across slices",
8432 w[0].0
8433 )));
8434 }
8435 }
8436 let post_swap_keys: Vec<IndexKey> = merged.iter().map(|(_, _, k)| k.clone()).collect();
8437 let seg_rows: Vec<(u64, Vec<u8>)> =
8438 merged.into_iter().map(|(k, body, _)| (k, body)).collect();
8439 let frozen_rows = seg_rows.len();
8440 let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
8441 .map_err(|e| StorageError::Corrupt(format!("commit_freeze_slices: encode: {e}")))?;
8442
8443 // --- atomic swap phase: mutations only past this point ---
8444 let bytes_before = self.get(table_name).expect("just validated").hot_bytes();
8445 let positions: Vec<usize> = (0..max_rows).collect();
8446 let t_mut = self
8447 .get_mut(table_name)
8448 .expect("just validated; still present");
8449 let removed = t_mut.delete_rows(&positions);
8450 debug_assert_eq!(removed, max_rows, "delete_rows count matches request");
8451 let bytes_after = t_mut.hot_bytes();
8452 let bytes_freed = bytes_before.saturating_sub(bytes_after);
8453
8454 let segment_id = self
8455 .load_segment_bytes(seg_bytes.clone())
8456 .map_err(|e| StorageError::Corrupt(format!("commit_freeze_slices: load: {e}")))?;
8457 let new_cold = post_swap_keys.into_iter().map(|k| {
8458 (
8459 k,
8460 RowLocator::Cold {
8461 segment_id,
8462 page_offset: 0,
8463 },
8464 )
8465 });
8466 let t_mut = self.get_mut(table_name).expect("still present");
8467 t_mut.register_cold_locators(index_name, new_cold)?;
8468 // r944 — a freeze has to say that it froze something.
8469 //
8470 // `has_cold_rows_fast()` reads the cached count, and neither
8471 // freeze path touched it, so afterwards it answered "no cold
8472 // rows" while cold rows existed. That predicate gates four join
8473 // paths, and a gate that wrongly declines the cold-aware path
8474 // drops the frozen rows from the answer.
8475 //
8476 // Marking it stale rather than adding to it: stale reads as
8477 // true, which is the safe direction, and this function cannot
8478 // know the exact total (rows may already have been cold). ANALYZE
8479 // recomputes the number.
8480 t_mut.mark_cold_row_count_stale();
8481
8482 Ok(FreezeReport {
8483 segment_id,
8484 frozen_rows,
8485 bytes_freed,
8486 segment_bytes: seg_bytes,
8487 })
8488 }
8489
8490 /// v6.7.3 — compact every cold segment on `(table, index)` whose
8491 /// `OwnedSegment::bytes().len()` is below `target_segment_bytes`
8492 /// into a single larger merged segment. Rows present in source
8493 /// segment payloads but no longer referenced by any
8494 /// `RowLocator::Cold` on the index (DELETE'd + frozen rows
8495 /// retired via [`Catalog::shadow_cold_row`]) are GC'd in the
8496 /// merge.
8497 ///
8498 /// **Semantics**:
8499 /// 1. Walk the BTree index to collect every Cold locator that
8500 /// targets a small (< threshold) segment. Each such
8501 /// `(key, segment_id)` becomes a row in the merged segment;
8502 /// payload is looked up from the source segment in-place.
8503 /// 2. Encode the collected rows into one new segment via
8504 /// [`encode_segment`]; register it via
8505 /// [`Catalog::load_segment_bytes`] (allocating a fresh
8506 /// `merged_segment_id` at the end of `cold_segments`).
8507 /// 3. Rewrite the BTree index in one pass: every
8508 /// `RowLocator::Cold { segment_id ∈ sources }` becomes
8509 /// `RowLocator::Cold { segment_id = merged_id, page_offset = 0 }`.
8510 /// Hot locators are untouched.
8511 /// 4. Tombstone every source slot via
8512 /// [`Catalog::tombstone_segment`]. Source segment payloads
8513 /// are no longer reachable through the catalog; the on-disk
8514 /// files are the caller's concern.
8515 ///
8516 /// On fewer than 2 candidate segments the catalog is **not**
8517 /// mutated and a no-op report (`merged_segment_id: None`,
8518 /// `sources: []`) is returned. This is the routine case — a
8519 /// freshly-frozen table has at most 1 small segment, no merge
8520 /// possible.
8521 ///
8522 /// Atomicity: every mutating step runs after the read-only
8523 /// gather phase, so a panic before the merge encode leaves the
8524 /// catalog unchanged. The mutation block itself (load + rewrite +
8525 /// tombstone) takes only `&mut self` — callers serialise the
8526 /// engine write lock outside this function.
8527 ///
8528 /// Errors when the table / index doesn't exist, the index isn't
8529 /// `BTree`, the index column type isn't u64-coercible (cold-tier
8530 /// pre-condition), or a source segment fails its in-place
8531 /// row-body lookup (would indicate prior catalog corruption).
8532 pub fn compact_cold_segments(
8533 &mut self,
8534 table_name: &str,
8535 index_name: &str,
8536 target_segment_bytes: u64,
8537 ) -> Result<CompactReport, StorageError> {
8538 // --- validation phase ----------------------------------
8539 let t = self.get(table_name).ok_or_else(|| {
8540 StorageError::Corrupt(format!(
8541 "compact_cold_segments: table {table_name:?} not found"
8542 ))
8543 })?;
8544 let idx = t
8545 .indices
8546 .iter()
8547 .find(|i| i.name == index_name)
8548 .ok_or_else(|| {
8549 StorageError::Corrupt(format!(
8550 "compact_cold_segments: index {index_name:?} not found on {table_name:?}"
8551 ))
8552 })?;
8553 let map = match &idx.kind {
8554 IndexKind::BTree(m) => m,
8555 IndexKind::Nsw(_)
8556 | IndexKind::Brin { .. }
8557 | IndexKind::Gin(_)
8558 | IndexKind::GinTrgm(_)
8559 | IndexKind::GinFulltext(_)
8560 | IndexKind::GinJsonb(_)
8561 | IndexKind::BTreeMulti(_) => {
8562 return Err(StorageError::Corrupt(format!(
8563 "compact_cold_segments: index {index_name:?} is not BTree; \
8564 compaction applies only to BTree cold-tier indices"
8565 )));
8566 }
8567 };
8568
8569 // --- gather phase --------------------------------------
8570 // Step A: every segment_id this BTree index Cold-references.
8571 let mut referenced_ids: BTreeSet<u32> = BTreeSet::new();
8572 for (_key, locators) in map.iter() {
8573 for loc in locators {
8574 if let RowLocator::Cold { segment_id, .. } = loc {
8575 referenced_ids.insert(*segment_id);
8576 }
8577 }
8578 }
8579 // Step B: keep only the small + still-active ones.
8580 let candidate_set: BTreeSet<u32> = referenced_ids
8581 .into_iter()
8582 .filter(|id| {
8583 self.cold_segments
8584 .get(*id as usize)
8585 .and_then(|s| s.as_deref())
8586 .is_some_and(|s| (s.bytes().len() as u64) < target_segment_bytes)
8587 })
8588 .collect();
8589 if candidate_set.len() < 2 {
8590 return Ok(CompactReport {
8591 sources: Vec::new(),
8592 merged_segment_id: None,
8593 merged_segment_bytes: Vec::new(),
8594 merged_rows: 0,
8595 deleted_rows_pruned: 0,
8596 bytes_reclaimed_estimate: 0,
8597 });
8598 }
8599 // Step C: pre-count source rows for the deleted-pruned metric.
8600 let mut source_row_count: usize = 0;
8601 let mut source_byte_total: u64 = 0;
8602 for &id in &candidate_set {
8603 let seg = self.cold_segments[id as usize]
8604 .as_ref()
8605 .expect("candidate selected only when slot is Some");
8606 source_row_count = source_row_count.saturating_add(seg.meta().num_rows as usize);
8607 source_byte_total = source_byte_total.saturating_add(seg.bytes().len() as u64);
8608 }
8609 // Step D: collect (key, body) pairs from every live Cold
8610 // locator pointing at a candidate. dedupe by key — one
8611 // BTree key resolves to at most one cold payload (the
8612 // freezer + promote/shadow flow keeps Cold locators
8613 // unique per key).
8614 let mut collected: BTreeMap<u64, (Vec<u8>, IndexKey)> = BTreeMap::new();
8615 for (key, locators) in map.iter() {
8616 for loc in locators {
8617 let RowLocator::Cold { segment_id, .. } = loc else {
8618 continue;
8619 };
8620 if !candidate_set.contains(segment_id) {
8621 continue;
8622 }
8623 let u64_key = index_key_as_u64(key).ok_or_else(|| {
8624 StorageError::Corrupt(format!(
8625 "compact_cold_segments: index {index_name:?} has non-integer Cold key; \
8626 cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
8627 ))
8628 })?;
8629 let seg = self.cold_segments[*segment_id as usize]
8630 .as_ref()
8631 .expect("candidate slot guaranteed Some above");
8632 let payload = seg.lookup(u64_key).ok_or_else(|| {
8633 StorageError::Corrupt(format!(
8634 "compact_cold_segments: BTree {index_name:?} points key={u64_key} \
8635 at segment {segment_id} but the segment lookup missed"
8636 ))
8637 })?;
8638 collected.insert(u64_key, (payload, key.clone()));
8639 break;
8640 }
8641 }
8642 let merged_rows = collected.len();
8643 let deleted_rows_pruned = source_row_count.saturating_sub(merged_rows);
8644
8645 // Step E: encode the merged segment. `BTreeMap<u64, _>`
8646 // iteration is ascending by key, which is what
8647 // `encode_segment` requires.
8648 let seg_rows: Vec<(u64, Vec<u8>)> = collected
8649 .iter()
8650 .map(|(k, (body, _))| (*k, body.clone()))
8651 .collect();
8652 let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
8653 .map_err(|e| StorageError::Corrupt(format!("compact_cold_segments: encode: {e}")))?;
8654 let merged_bytes_len = seg_bytes.len() as u64;
8655
8656 // --- atomic mutation phase ------------------------------
8657 let merged_segment_id = self
8658 .load_segment_bytes(seg_bytes.clone())
8659 .map_err(|e| StorageError::Corrupt(format!("compact_cold_segments: load: {e}")))?;
8660
8661 // Rewrite the BTree index: every Cold locator pointing at
8662 // a candidate source becomes a Cold locator pointing at
8663 // the merged segment. Use a flat collect-then-replace
8664 // pattern so we never hold a `&self` borrow across the
8665 // `&mut self` write.
8666 let entries: Vec<(IndexKey, crate::posting::PostingList)> = {
8667 let t = self
8668 .get(table_name)
8669 .expect("table existed at the start of this fn");
8670 let idx = t
8671 .indices
8672 .iter()
8673 .find(|i| i.name == index_name)
8674 .expect("index existed at the start of this fn");
8675 let IndexKind::BTree(map) = &idx.kind else {
8676 unreachable!("validated above");
8677 };
8678 map.iter().map(|(k, v)| (k.clone(), v.clone())).collect()
8679 };
8680 let t_mut = self
8681 .get_mut(table_name)
8682 .expect("table existed at the start of this fn");
8683 let idx_mut = t_mut
8684 .indices
8685 .iter_mut()
8686 .find(|i| i.name == index_name)
8687 .expect("index existed at the start of this fn");
8688 let IndexKind::BTree(map_mut) = &mut idx_mut.kind else {
8689 unreachable!("validated above");
8690 };
8691 for (key, locators) in entries {
8692 let mut new_locs = crate::posting::PostingList::new();
8693 let mut changed = false;
8694 for loc in &locators {
8695 match *loc {
8696 RowLocator::Cold {
8697 segment_id,
8698 page_offset: _,
8699 } if candidate_set.contains(&segment_id) => {
8700 let replacement = RowLocator::Cold {
8701 segment_id: merged_segment_id,
8702 page_offset: 0,
8703 };
8704 if !new_locs.contains(replacement) {
8705 new_locs.push(replacement);
8706 }
8707 changed = true;
8708 }
8709 other => new_locs.push(other),
8710 }
8711 }
8712 if changed {
8713 map_mut.insert_mut(key, new_locs);
8714 }
8715 }
8716
8717 // Tombstone every source slot. Last step — failures here
8718 // would leave the segment double-referenced in both
8719 // memory + manifest, but `tombstone_segment` only errors
8720 // on out-of-bounds, which we've already validated.
8721 for &id in &candidate_set {
8722 self.tombstone_segment(id)?;
8723 }
8724
8725 let bytes_reclaimed_estimate = source_byte_total.saturating_sub(merged_bytes_len);
8726 Ok(CompactReport {
8727 sources: candidate_set.into_iter().collect(),
8728 merged_segment_id: Some(merged_segment_id),
8729 merged_segment_bytes: seg_bytes,
8730 merged_rows,
8731 deleted_rows_pruned,
8732 bytes_reclaimed_estimate,
8733 })
8734 }
8735
8736 /// Internal helper: scan `(table, index)` for a `Cold` locator
8737 /// keyed by `key`. Returns `Ok(Some((segment_id, page_offset)))`
8738 /// when found, `Ok(None)` when the key has only hot entries
8739 /// or no entries at all, `Err` on the same input-validation
8740 /// errors as the public `promote_cold_row` / `shadow_cold_row`.
8741 fn find_cold_locator(
8742 &self,
8743 table_name: &str,
8744 index_name: &str,
8745 key: &IndexKey,
8746 ) -> Result<Option<(u32, u32)>, StorageError> {
8747 let t = self.get(table_name).ok_or_else(|| {
8748 StorageError::Corrupt(format!("find_cold_locator: table {table_name:?} not found"))
8749 })?;
8750 let idx = t
8751 .indices
8752 .iter()
8753 .find(|i| i.name == index_name)
8754 .ok_or_else(|| {
8755 StorageError::Corrupt(format!(
8756 "find_cold_locator: index {index_name:?} not found on {table_name:?}"
8757 ))
8758 })?;
8759 if !matches!(idx.kind, IndexKind::BTree(_)) {
8760 return Err(StorageError::Corrupt(format!(
8761 "find_cold_locator: index {index_name:?} is NSW; promote-on-write only applies to BTree indices"
8762 )));
8763 }
8764 for loc in idx.lookup_eq(key) {
8765 if let RowLocator::Cold {
8766 segment_id,
8767 page_offset,
8768 } = *loc
8769 {
8770 return Ok(Some((segment_id, page_offset)));
8771 }
8772 }
8773 Ok(None)
8774 }
8775}
8776
8777/// Coerce an [`IndexKey`] to the `u64` that v5.1 cold-tier
8778/// segments use as their on-disk PK. Returns `None` for keys that
8779/// aren't representable as `u64` — Text PKs need a hash mapping
8780/// the segment writer baked in (deferred to v5.2+), Bool PKs are
8781/// almost never wide enough to be sharded into a cold tier.
8782fn index_key_as_u64(key: &IndexKey) -> Option<u64> {
8783 match key {
8784 // Reinterpret the i64 bit pattern as u64. Cold-tier segments
8785 // are sorted by this u64 view, so the chosen interpretation
8786 // only has to match between insert (bake_segment / freezer)
8787 // and lookup — using cast_unsigned keeps both sides honest
8788 // and silences clippy::cast_sign_loss.
8789 IndexKey::Int(n) => Some(n.cast_unsigned()),
8790 // Text / Bool / Uuid / Bytes / Numeric PKs aren't representable
8791 // as u64 and so can't participate in the u64-sorted cold-tier
8792 // segment PK layout. Same deferral story as Text — lookup falls
8793 // through the in-memory btree.
8794 IndexKey::Text(_)
8795 | IndexKey::Bool(_)
8796 | IndexKey::Uuid(_)
8797 | IndexKey::Bytes(_)
8798 | IndexKey::Numeric(_)
8799 | IndexKey::Null => None,
8800 }
8801}
8802
8803#[derive(Debug, Clone, PartialEq, Eq)]
8804#[non_exhaustive]
8805pub enum StorageError {
8806 DuplicateTable {
8807 name: String,
8808 },
8809 TableNotFound {
8810 name: String,
8811 },
8812 ArityMismatch {
8813 expected: usize,
8814 actual: usize,
8815 },
8816 TypeMismatch {
8817 column: String,
8818 expected: DataType,
8819 actual: DataType,
8820 position: usize,
8821 },
8822 NullInNotNull {
8823 column: String,
8824 },
8825 /// Index with this name already exists on the table.
8826 DuplicateIndex {
8827 name: String,
8828 },
8829 /// Column referenced by an index doesn't exist on the table.
8830 ColumnNotFound {
8831 column: String,
8832 },
8833 /// On-disk format failed to parse — corrupted file, wrong magic, truncated
8834 /// payload, or unknown tag bytes.
8835 Corrupt(String),
8836 /// v6.0.4 — ALTER INDEX targeted an index name that doesn't
8837 /// exist on any table in this catalog.
8838 IndexNotFound {
8839 name: String,
8840 },
8841 /// v6.0.4 — operation requested isn't supported on this index
8842 /// kind / column type (e.g. ALTER INDEX REBUILD on a `BTree`
8843 /// index, or REBUILD WITH (encoding=…) on a non-vector column).
8844 Unsupported(String),
8845 /// v7.39 (round 220) — a CYCLE-less sequence ran past its bound.
8846 /// PG's 2200H phrasing: `nextval: reached maximum value of
8847 /// sequence "s" (n)` (`is_max: false` = the MINVALUE direction).
8848 SequenceExhausted {
8849 name: String,
8850 limit: i64,
8851 is_max: bool,
8852 },
8853}
8854
8855impl fmt::Display for StorageError {
8856 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
8857 match self {
8858 // v7.39 (read01 round 47) — PG's 42P07 wording.
8859 Self::DuplicateTable { name } => write!(f, "relation \"{name}\" already exists"),
8860 // v7.39 (read01 round 47) — PG's wording for a missing relation
8861 // (42P01). DROP TABLE says "table" and raises its own error at
8862 // the engine; every other path (SELECT / ALTER / …) says
8863 // "relation", which is what this carries.
8864 Self::TableNotFound { name } => write!(f, "relation \"{name}\" does not exist"),
8865 Self::ArityMismatch { expected, actual } => write!(
8866 f,
8867 "row arity mismatch: expected {expected} columns, got {actual}"
8868 ),
8869 Self::TypeMismatch {
8870 column,
8871 expected,
8872 actual,
8873 position,
8874 } => write!(
8875 f,
8876 "type mismatch in column {column:?} (position {position}): expected {expected}, got {actual}"
8877 ),
8878 Self::NullInNotNull { column } => {
8879 // v7.39 (SQLSTATE fidelity) — PG's 23502 phrasing (the
8880 // relation-qualified long form is added by engine call
8881 // sites that know the table name).
8882 write!(
8883 f,
8884 "null value in column \"{column}\" violates not-null constraint"
8885 )
8886 }
8887 // v7.39 (read01 round 47) — an index is a relation to PG (42P07).
8888 Self::DuplicateIndex { name } => write!(f, "relation \"{name}\" already exists"),
8889 // v7.39 (round 701) — PG's wording, and the same fix `EvalError::
8890 // ColumnNotFound` took in read01 round 81 with the same reason:
8891 // "column not found: x" matches none of the wire layer's `does
8892 // not exist` patterns, so a missing column reached the client as
8893 // the generic error class. The eval-side variant was changed and
8894 // the storage-side one was not, so which sentence you got
8895 // depended on which layer noticed — `CREATE INDEX ix ON t(nope)`
8896 // came out of storage and kept the old spelling.
8897 Self::ColumnNotFound { column } => write!(f, "column \"{column}\" does not exist"),
8898 Self::Corrupt(detail) => write!(f, "corrupt on-disk format: {detail}"),
8899 Self::IndexNotFound { name } => write!(f, "index \"{name}\" does not exist"),
8900 Self::Unsupported(detail) => write!(f, "unsupported: {detail}"),
8901 // v7.39 (round 220) — PG's exact 2200H wording.
8902 Self::SequenceExhausted {
8903 name,
8904 limit,
8905 is_max,
8906 } => write!(
8907 f,
8908 "nextval: reached {} value of sequence \"{name}\" ({limit})",
8909 if *is_max { "maximum" } else { "minimum" }
8910 ),
8911 }
8912 }
8913}
8914
8915impl ColumnSchema {
8916 pub fn new(name: impl Into<String>, ty: DataType, nullable: bool) -> Self {
8917 Self {
8918 name: name.into(),
8919 ty,
8920 nullable,
8921 collation_name: None,
8922 default: None,
8923 runtime_default: None,
8924 auto_increment: false,
8925 user_enum_type: None,
8926 user_domain_type: None,
8927 user_composite_type: None,
8928 acl: Vec::new(),
8929 on_update_runtime: None,
8930 collation: Collation::Binary,
8931 is_unsigned: false,
8932 inline_enum_variants: None,
8933 inline_set_variants: None,
8934 generated_stored_expr: None,
8935 identity_always: false,
8936 default_text: None,
8937 auto_restart: None,
8938 scalar_row_source: false,
8939 mysql_int_width: None,
8940 mysql_fsp: None,
8941 }
8942 }
8943
8944 /// v7.38.14 — the SAME column, re-described.
8945 ///
8946 /// `ColumnSchema::new` is for SYNTHESISING a column: a catalog row, an
8947 /// admin view, a computed output. It sets twenty-two fields to their
8948 /// defaults, which is right when there is no source column to speak of.
8949 ///
8950 /// It is wrong, and quietly so, when there IS one -- a join's combined
8951 /// schema, an aggregate's synthetic keys, a derived table's output. Those
8952 /// sites re-describe an existing column under a new name or type, and
8953 /// have each been written as `new(..)` followed by hand-picking a few
8954 /// attributes to copy across. They all pick differently and none picks
8955 /// them all.
8956 ///
8957 /// Five fields have been lost through that shape so far -- enum identity,
8958 /// MySQL fsp, the PG collation name, `ProjectedItem::fold_exempt`, and
8959 /// the `collation` enum -- and v7.38.14 alone found four sites dropping
8960 /// the last of those. The failure is never loud: `collation` defaults to
8961 /// `Binary`, which downstream reads as "byte-wise ON PURPOSE" rather than
8962 /// as "unknown", so a dropped declaration presents as a deliberate one.
8963 ///
8964 /// This constructor copies everything by construction. A field added to
8965 /// `ColumnSchema` therefore reaches every re-describe site without anyone
8966 /// having to remember, which is the property the hand-written copy lists
8967 /// never had.
8968 ///
8969 /// The two fields a re-describe legitimately changes -- name and
8970 /// nullability -- are parameters. Callers that also retype the column
8971 /// assign `ty` afterwards.
8972 #[must_use]
8973 pub fn rederive(source: &Self, name: impl Into<String>, nullable: bool) -> Self {
8974 Self {
8975 name: name.into(),
8976 nullable,
8977 ..source.clone()
8978 }
8979 }
8980
8981 /// Builder-style helper to attach a default value to an otherwise
8982 /// plain column schema. Used by the engine when CREATE TABLE
8983 /// specifies `column TYPE DEFAULT <expr>`.
8984 #[must_use]
8985 pub fn with_default(mut self, default: Value<'static>) -> Self {
8986 self.default = Some(default);
8987 self
8988 }
8989
8990 /// v7.9.21 — builder for runtime-evaluated defaults
8991 /// (`DEFAULT now()`, `DEFAULT CURRENT_TIMESTAMP`, …).
8992 /// `expr` is the Expr's `Display` form, re-parsed by the
8993 /// engine at each INSERT.
8994 #[must_use]
8995 pub fn with_runtime_default(mut self, expr: impl Into<String>) -> Self {
8996 self.runtime_default = Some(expr.into());
8997 self
8998 }
8999
9000 /// Builder-style helper to mark a column as `AUTO_INCREMENT`.
9001 #[must_use]
9002 pub const fn with_auto_increment(mut self) -> Self {
9003 self.auto_increment = true;
9004 self
9005 }
9006}
9007
9008impl TableSchema {
9009 pub fn new(name: impl Into<String>, columns: Vec<ColumnSchema>) -> Self {
9010 Self {
9011 name: name.into(),
9012 columns,
9013 hot_tier_bytes: None,
9014 foreign_keys: Vec::new(),
9015 uniqueness_constraints: Vec::new(),
9016 exclusion_constraints: Vec::new(),
9017 checks: Vec::new(),
9018 partition_role: None,
9019 policies: Vec::new(),
9020 row_security: false,
9021 force_row_security: false,
9022 owner: None,
9023 acl: Vec::new(),
9024 }
9025 }
9026}
9027
9028// =========================================================================
9029// Persistent binary format for the catalog.
9030//
9031// Layout (little-endian throughout):
9032//
9033// [magic "SPGDB001" 8 bytes][version u8]
9034// [table_count u32]
9035// for each table:
9036// [name_len u16][name bytes]
9037// [col_count u16]
9038// for each col:
9039// [name_len u16][name bytes]
9040// [type_tag u8 + optional payload]
9041// 1=Int 2=BigInt 3=Float 4=Text 5=Bool
9042// 6=Vector(u32 dim)
9043// 7=SmallInt
9044// 8=Varchar(u32 max)
9045// 9=Char(u32 size)
9046// 10=Numeric(u8 precision, u8 scale)
9047// 11=Date
9048// 12=Timestamp
9049// [nullable u8] 0/1
9050// [default_tag u8] 0=none 1=value (followed by [value_tag u8] + bytes)
9051// [row_count u32]
9052// for each row, for each col, one [value_tag u8] + value bytes:
9053// tag 0 (Null) → no body
9054// tag 1 (Int) → i32 LE
9055// tag 2 (BigInt) → i64 LE
9056// tag 3 (Float) → f64 LE
9057// tag 4 (Text) → u16 LE len + UTF-8 bytes
9058// tag 5 (Bool) → u8 0/1
9059// tag 6 (Vector) → u32 LE dim + dim×f32 LE
9060// tag 7 (SmallInt) → i16 LE
9061// tag 8 (Numeric) → i128 LE (16 bytes) + u8 scale
9062// tag 9 (Date) → i32 LE (days since Unix epoch)
9063// tag 10 (Timestamp) → i64 LE (microseconds since Unix epoch)
9064//
9065// Bumped to version 3 when NUMERIC was added; to version 4 when
9066// AUTO_INCREMENT (per-column flag) + NSW index `kind` byte landed;
9067// to version 5 when DATE / TIMESTAMP were added; to version 6 when
9068// NSW graph topology started travelling on disk (v2.7); to version 7
9069// when the NSW topology became multi-layer HNSW (v2.13); to version 8
9070// when row encoding switched to schema-driven dense layout (v3.0.2 —
9071// per-row NULL bitmap + per-column fixed-width body, no per-cell type
9072// tag).
9073// =========================================================================
9074
9075const FILE_MAGIC: &[u8; 8] = b"SPGDB001";
9076/// Current catalog snapshot format version emitted by [`Catalog::serialize`].
9077///
9078/// v9 (v5.2) extends v8 by serialising `BTree` index entries directly — every
9079/// `(IndexKey, Vec<RowLocator>)` pair travels on disk with the v5.1
9080/// `RowLocator::write_le` tag-prefixed codec. v8 `BTree` indices stored no
9081/// entries at all (the map was rebuilt from `Table::rows` on load); v9
9082/// preserves on-disk Cold locators so freezer-produced cold-tier index
9083/// entries survive a catalog snapshot round-trip. v8 readers are accepted
9084/// by version dispatch in [`Catalog::deserialize`] — every entry decodes
9085/// as `RowLocator::Hot(_)` via `add_index` rebuild, identical to v5.1
9086/// behaviour.
9087/// v6.7.2 — bumped from 10 to 11 to append per-table
9088/// `hot_tier_bytes: Option<u64>` after the per-table indices
9089/// section. v10 catalogs (v6.7.1) load with `hot_tier_bytes =
9090/// None` for every table (the deserialiser short-circuits when
9091/// version < 11). v11 snapshots written by a pre-v6.7.2 binary
9092/// fail loudly at the version check, matching the v6.1.2 /
9093/// v6.1.4 / v6.2.0 / v6.7.1 envelope-bump upgrade fences.
9094///
9095/// v6.8.0 — bumped from 11 to 12: per-index
9096/// `included_columns: Vec<u16>` appended at the tail of each
9097/// index payload. v11 (= v6.7.2) catalogs load with
9098/// `included_columns = Vec::new()` for every index — same
9099/// "older readers, append-only extension" pattern as the v6.7.2
9100/// hot_tier_bytes byte.
9101/// v7.13.0 — bumped from 22 to 23. mailrs round-5 G3 / G10.
9102/// Per-table appendix gains two new sections:
9103/// * `checks: Vec<String>` — CHECK predicate sources (Display
9104/// form of the AST Expr); re-parsed on INSERT/UPDATE to
9105/// enforce against candidate rows. Same persistence pattern
9106/// as `Index::partial_predicate`.
9107/// * Per `UniquenessConstraint`: trailing `nulls_not_distinct:
9108/// u8` flag for PG 15+ `UNIQUE NULLS NOT DISTINCT (cols)`
9109/// semantics.
9110/// v22 catalogs deserialise with empty `checks` and every UC
9111/// at `nulls_not_distinct = false`.
9112/// v24 introduces:
9113/// * Index kind tag 4 = trigram-GIN (`gin_trgm_ops`-flavoured
9114/// `USING gin` over a TEXT/VARCHAR column). Payload shape is
9115/// identical to tag-3 GIN (String → Vec<RowLocator>); the
9116/// keys are PG-compatible 3-byte trigram shingles instead of
9117/// tsvector lexemes. v23 catalogs deserialise unchanged — no
9118/// v23 writer ever emitted tag 4.
9119/// v25 introduces:
9120/// * Per `TriggerDef`: trailing `enabled: u8` flag (mailrs
9121/// round-9 A.2.b — `ALTER TABLE … { ENABLE | DISABLE }
9122/// TRIGGER …`). v24 catalogs deserialise with every trigger
9123/// `enabled = true`, matching pre-v7.16.1 behaviour.
9124/// v26 introduces (v7.17.0 Phase 1.1):
9125/// * Trailing SEQUENCE catalog block after triggers. Encoded
9126/// as `u32 count` followed by per-sequence:
9127/// `name`, `data_type: u8` (0=SmallInt,1=Int,2=BigInt),
9128/// `start i64`, `increment i64`, `min_value i64`,
9129/// `max_value i64`, `cache i64`, `cycle u8`,
9130/// `owned_by_tag u8` (0=NONE, 1=Column → `table`,`column`),
9131/// `last_value i64`, `is_called u8`. v25-and-below catalogs
9132/// deserialise with an empty sequences map.
9133/// v27 introduces (v7.17.0 Phase 1.2):
9134/// * Trailing VIEW catalog block after sequences. Encoded as
9135/// `u32 count` followed by per-view:
9136/// `name`, `column_count u16`, then column names, then
9137/// `body` long-string. v26-and-below catalogs deserialise
9138/// with an empty views map.
9139/// v28 introduces (v7.17.0 Phase 1.3):
9140/// * Trailing MATERIALIZED VIEW source registry block after
9141/// views. Encoded as `u32 count` followed by per-entry:
9142/// `name`, `body` long-string. The materialised rows live
9143/// as a regular Table of the same name (already covered by
9144/// the pre-existing tables block). v27-and-below catalogs
9145/// deserialise with an empty map.
9146/// v29 introduces (v7.17.0 Phase 1.4):
9147/// * Per-table user_enum_type appendix (after the CHECK
9148/// appendix). Layout: `u16 count` followed by per-binding
9149/// `[u16 col_pos][str enum_name]`. Only columns whose
9150/// `user_enum_type` is Some land here; the catalog stays
9151/// compact for the common no-enum case.
9152/// * Trailing ENUM types catalog block after materialized
9153/// views. Encoded as `u32 count` followed by per-entry:
9154/// `name`, `u16 label_count`, then `label_count` short
9155/// strings. v28-and-below catalogs deserialise with an
9156/// empty enum_types map and every column's
9157/// `user_enum_type = None`.
9158/// v30 introduces (v7.17.0 Phase 1.5):
9159/// * Per-table user_domain_type appendix (after the
9160/// user_enum_type appendix). Same shape as the enum one.
9161/// * Trailing DOMAIN types catalog block after the enum
9162/// block. Encoded as `u32 count` followed by per-entry:
9163/// `name`, `data_type` byte, `nullable u8`,
9164/// `default_present u8` + optional default string,
9165/// `u16 check_count` then `check_count` Display-form
9166/// CHECK strings. v29-and-below catalogs deserialise with
9167/// an empty domain_types map and `user_domain_type = None`.
9168/// v31 introduces (v7.17.0 Phase 1.6):
9169/// * Trailing user-schemas block after the DOMAIN block.
9170/// Encoded as `u32 count` followed by `count` schema-name
9171/// short strings. Built-in schemas (`public`, `pg_catalog`,
9172/// `information_schema`) are NOT serialised — they're
9173/// hardcoded in `is_builtin_schema`. v30-and-below catalogs
9174/// deserialise with an empty user-schemas set.
9175/// v32 introduces (v7.17.0 Phase 2.1):
9176/// * Per-table on_update_runtime appendix (after the
9177/// user_domain_type appendix). Layout: `u16 count` followed
9178/// by per-binding `[u16 col_pos][str expr_src]`. Only
9179/// columns whose `on_update_runtime` is Some land here;
9180/// the catalog stays compact when no MySQL-shaped table
9181/// uses the attribute. v31-and-below catalogs deserialise
9182/// with every column's `on_update_runtime = None`.
9183/// v33 introduces (v7.17.0 Phase 2.2):
9184/// * Index kind tag 5 = fulltext-GIN (MySQL `FULLTEXT KEY`
9185/// surface over a TEXT / VARCHAR column). Payload shape is
9186/// identical to tag-3 / tag-4 GIN (`String → Vec<RowLocator>`);
9187/// the keys are lower-cased word lexemes (same rule as
9188/// `to_tsvector('simple', text)`). v32 catalogs deserialise
9189/// unchanged — no v32 writer ever emitted tag 5, and FULLTEXT
9190/// KEY was silently dropped pre-v7.17 so no rebuild shim is
9191/// needed for round-tripped catalogs.
9192/// v34 introduces (v7.17.0 Phase 2.5):
9193/// * Per-table collation appendix (after the on_update_runtime
9194/// appendix). Sparse layout: only columns whose `collation`
9195/// is non-Binary land here. `u16 count` then per-binding
9196/// `[u16 col_pos][u8 collation_tag]` where the tag matches
9197/// `Collation::TAG_*`. Snapshots written by v33-and-below
9198/// readers deserialise every column with `collation =
9199/// Binary`, preserving the prior byte-wise compare
9200/// semantics. Unknown tags read back as Binary too — keeps
9201/// a forward-compat path if a future v35 adds variants
9202/// and someone rolls back to a v34 reader.
9203/// v35 introduces (v7.17.0 Phase 4.4):
9204/// * Per-table is_unsigned appendix (after the collation
9205/// appendix). Sparse layout: only `is_unsigned = true`
9206/// columns land. `u16 count` then per-binding `[u16 col_pos]`.
9207/// v34-and-below catalogs deserialise every column as
9208/// `is_unsigned = false`, preserving the prior silent-
9209/// accept behaviour for negative inserts on UNSIGNED columns.
9210/// v46 introduces (v7.23, mailrs round-14):
9211/// * Escaped short-string codec — `write_str` lengths >= 0xFFFF
9212/// emit `[u16 0xFFFF][u32 real_len]` so TEXT cells (mail bodies,
9213/// document text) above 64 KiB encode instead of panicking.
9214/// One-way upgrade: v45-and-below readers reject v46 catalogs
9215/// loudly via the version gate; v46 readers decode v45 catalogs
9216/// with the plain-u16 rules (0xFFFF is a legitimate length
9217/// there).
9218/// v47 introduces (v7.27, mailrs round-21):
9219/// * Escaped lengths for the REMAINING u16-length cell payloads —
9220/// BYTEA cells, TEXT[] elements, tsvector lexemes and tsquery
9221/// terms — the same `[u16 0xFFFF][u32 real_len]` escape v46
9222/// gave short strings. Round-14 fixed TEXT and missed these;
9223/// round-21 fired the BYTEA twin during a production migration.
9224/// One-way upgrade, same posture as v46.
9225/// v48 introduces (v7.37.5 β-P2, sentori cutover window):
9226/// * `INTERVAL` becomes a real column type. Catalog tag 34 in
9227/// `write_data_type`; per-row body is a fixed 16 bytes
9228/// (i64 micros + i32 days + i32 months, LE, PG-byte-equal
9229/// field order). The runtime-only days collapse is gone —
9230/// `'1 day'` and `'24 hours'` are stored distinctly. One-way
9231/// upgrade: v47 catalogs without INTERVAL columns deserialise
9232/// identically; v47 readers fed a v48 catalog that contains
9233/// INTERVAL hit the explicit "unknown data type tag: 34"
9234/// fence in `read_data_type`.
9235/// v49 introduces (v7.37.6-B, sentori Epic 2 P0):
9236/// * Per-table partition role appendix(declarative
9237/// `PARTITION BY RANGE` parent / range child / DEFAULT
9238/// child)。Layout, written **after** the inline_set_variants
9239/// appendix and **before** the per-table block close:
9240/// `[u8 role_tag]`
9241/// 0 = `None`(普通表,后向兼容默认)
9242/// 1 = `Parent`: `[u8 kind_tag (0=Range)]`
9243/// `[u16 key_col_count]` `(× u16 col_pos)`
9244/// `[u16 tmpl_count]` `(× str source)`
9245/// 2 = `Range`: `[str parent_name]` `[Bound]` `[Bound]`
9246/// 3 = `Default`: `[str parent_name]`
9247/// `PartitionBound` codec:
9248/// `[u8 bound_tag]` 0=MinValue 1=MaxValue 2=TimestampTz(`[i64 LE micros]`)
9249/// v48-and-below readers stop after the inline_set_variants
9250/// block — they don't see this appendix and deserialise every
9251/// table with `partition_role = None`. v49 writers always emit
9252/// `[0]` for plain tables, so the encoding stays one-byte-cheap.
9253/// v50 introduces (v7.37.7, sentori Epic 3 P1):
9254/// * Per-table `generated_stored_expr` appendix(stored generated
9255/// columns — `GENERATED ALWAYS AS (<expr>) STORED`)。Layout,
9256/// written **after** the partition_role appendix and before
9257/// the per-table block close:
9258/// `[u16 binding_count]`
9259/// `binding_count × { [u16 col_pos][str expr_source] }`
9260/// Sparse — only generated columns land here, so plain-shape
9261/// catalogs stay byte-for-byte identical save for the new
9262/// u16 zero count. v49-and-below readers stop after the
9263/// partition_role appendix; v50 readers default every column
9264/// to `generated_stored_expr = None` when this block is absent.
9265/// v51 introduces (v7.37.8, sentori Epic 5 P2):
9266/// * Per-index tag byte 6 = `GinJsonb`(real posting-list GIN
9267/// over a JSONB column). Payload shape mirrors tag-3 / 4 / 5:
9268/// `[u32 posting_list_count]` then `(str token, u32 locator_count,
9269/// locators …)` per posting list. Same `write_str` /
9270/// `RowLocator::write_le` codec as the rest of the GIN family.
9271/// v50 catalogs never wrote tag 6(the same DDL loaded as a
9272/// BTree fallback); v51 readers see tag 6 explicitly and dispatch
9273/// into `IndexKind::GinJsonb`.
9274/// v52 introduces (v7.37.42-T2 ζ-B composite + domain metasystem):
9275/// * Trailing COMPOSITE-types catalog block after the
9276/// user-schemas block. Encoded as `u32 count` followed by
9277/// per-entry: `name`, `u16 field_count`, then `field_count`
9278/// `[str field_name][data_type]` pairs (`write_data_type` is
9279/// reused). v51-and-below catalogs deserialise with an empty
9280/// composite_types map; v52 readers tolerate v51 catalogs by
9281/// stopping at the schema block (no composite block present
9282/// ⇒ empty map). Composite types are referenced by columns
9283/// via `ColumnSchema.user_composite_type`, mirroring the
9284/// `user_enum_type` / `user_domain_type` pattern. The block
9285/// lands here (not as a per-table appendix) so dropping the
9286/// composite type registers globally and DROP TYPE can find it
9287/// without a table scan.
9288/// v53 introduces (v7.37.16 Epic W — cross-checkpoint tombstone
9289/// durability):
9290/// * Trailing per-table MVCC appendix carrying, for every row,
9291/// its `RowHeader` (`xmin:u64`, `xmax:u64`, `flags:u8`) and its
9292/// stable `RowId` (`u64`), followed by the relation's
9293/// `next_rowid:u64`. Layout per table (after the v50
9294/// generated_stored_expr block, before the table loop closes):
9295/// `[u32 row_count]` (== `Table::rows().len()`, cross-check)
9296/// per row in physical order:
9297/// `[u64 xmin][u64 xmax][u8 flags][u64 rowid]`
9298/// `[u64 next_rowid]`
9299/// v52-and-below catalogs never wrote this block; their reader
9300/// stops after the last per-table appendix and
9301/// `deserialize_rows` leaves every row `RowHeader::frozen()`
9302/// with dense 1..=N ids — the exact pre-v53 contract. A v53
9303/// reader instead reconstructs headers + ids VERBATIM, so a
9304/// tombstone-redo naming a row inserted before the last
9305/// checkpoint resolves by `RowId` across the base-snapshot
9306/// boundary (closing the coupling the Epic W WAL slices deferred
9307/// to this format bump). Because the reader routes on `version`,
9308/// the block is strictly backward-compatible: old images load
9309/// byte-for-byte as before. `SPG_MVCC_INPLACE` is unaffected —
9310/// a gate-off database's rows are all frozen/alive, so
9311/// persisting + restoring their headers is observationally a
9312/// no-op.
9313/// v7.38 (read01 P5.05) — v54 appends a CRC32C over the whole preceding
9314/// image so a corrupted `base.spg` is caught on load instead of silently
9315/// deserialising garbage. Older images (v8..=53) carry no trailer and load
9316/// unchanged.
9317/// v7.39 (round 210) — v72 appends a per-table EXCLUDE-constraint appendix
9318/// (sparse: only tables carrying an EXCLUDE write it) at the very end of the
9319/// per-table block, after the column-ACL appendix. A v71 reader stops before
9320/// it and its tables read back with no exclusion constraints, which is what
9321/// they were.
9322/// v7.39 (round 220) — v73 appends a per-table identity-RESTART appendix
9323/// (sparse: [u16 count] then per entry [u16 col_pos][i64 LE floor]) after
9324/// the EXCLUDE appendix. A v72 reader stops before it; its columns read
9325/// back with no RESTART floor, losing only an un-consumed
9326/// `ALTER … RESTART WITH` across a restart.
9327/// r1039 — v90 adds index-key tags 4 (bytea) and 5 (the canonical
9328/// numeric key), so BYTEA and NUMERIC columns carry a real B-tree
9329/// instead of falling back to a scan. A v89 reader meeting either tag
9330/// reports a corrupt catalog rather than mis-reading it, which is the
9331/// same forward-compatibility story tag 3 (uuid) had at v36.
9332const FILE_VERSION: u8 = 92;
9333
9334/// v7.37 (round 833) — the codec version to decode a row that
9335/// [`encode_row_body_dense`] has just produced.
9336///
9337/// That encoder always writes the newest form, and every decoder gate is
9338/// a `codec_version >= N` feature test, so a freshly encoded row must be
9339/// read at the current version. Cold segments carry their own version in
9340/// their header and keep passing that; this is for in-process round
9341/// trips — sort runs on temp storage — where the bytes never outlive the
9342/// build that wrote them.
9343pub const CURRENT_ROW_CODEC_VERSION: u8 = FILE_VERSION;
9344/// First version that appends the trailing CRC32C integrity trailer.
9345const FILE_VERSION_CRC_TRAILER: u8 = 54;
9346/// Oldest format version [`Catalog::deserialize`] still accepts. v8 is the
9347/// v3.0.2 dense-row layout; pre-v8 catalogs require an offline migration.
9348const MIN_SUPPORTED_FILE_VERSION: u8 = 8;
9349
9350// IndexKey wire format (v9):
9351// tag 0 = Int → [i64 LE]
9352// tag 1 = Text → [u16 LE len + UTF-8 bytes] (via write_str / read_str)
9353// tag 2 = Bool → [u8 0/1]
9354const INDEX_KEY_TAG_INT: u8 = 0;
9355const INDEX_KEY_TAG_TEXT: u8 = 1;
9356const INDEX_KEY_TAG_BOOL: u8 = 2;
9357/// v7.17.0 — `IndexKey::Uuid([u8; 16])`. Body = raw 16 bytes
9358/// (RFC 4122 byte order). Persisted only in FILE_VERSION 36+
9359/// catalogs.
9360const INDEX_KEY_TAG_UUID: u8 = 3;
9361/// r1039 — `IndexKey::Bytes`. Body = [u32 LE len][raw bytes].
9362/// Persisted only in FILE_VERSION 90+ catalogs.
9363const INDEX_KEY_TAG_BYTES: u8 = 4;
9364/// r1039 — `IndexKey::Numeric`. Body = [u8 class][u8 neg][i32 LE exp]
9365/// [u32 LE digit count][one byte per decimal digit, 0..=9, MSD first].
9366/// Persisted only in FILE_VERSION 90+ catalogs.
9367const INDEX_KEY_TAG_NUMERIC: u8 = 5;
9368/// v7.38.1 (L12) — `IndexKey::Null`, a NULL component inside a
9369/// composite key. No body. Persisted only inside tag-7 multi-index
9370/// payloads, FILE_VERSION 91+.
9371const INDEX_KEY_TAG_NULL: u8 = 6;
9372
9373impl Catalog {
9374 /// Serialize the whole catalog (schema + every row) into a self-contained
9375 /// byte buffer. Format is documented above the impl block.
9376 pub fn serialize(&self) -> Vec<u8> {
9377 let mut out = Vec::with_capacity(64);
9378 out.extend_from_slice(FILE_MAGIC);
9379 out.push(FILE_VERSION);
9380 write_u32(
9381 &mut out,
9382 u32::try_from(self.tables.len()).expect("≤ 4G tables"),
9383 );
9384 for t in &self.tables {
9385 write_str(&mut out, &t.schema.name);
9386 write_u16(
9387 &mut out,
9388 u16::try_from(t.schema.columns.len()).expect("≤ 65k columns/table"),
9389 );
9390 for c in &t.schema.columns {
9391 write_str(&mut out, &c.name);
9392 write_data_type(&mut out, c.ty);
9393 out.push(u8::from(c.nullable));
9394 match &c.default {
9395 None => out.push(0),
9396 Some(v) => {
9397 out.push(1);
9398 write_value(&mut out, v);
9399 }
9400 }
9401 out.push(u8::from(c.auto_increment));
9402 }
9403 write_u32(
9404 &mut out,
9405 u32::try_from(t.rows.len()).expect("≤ 4G rows/table"),
9406 );
9407 // v3.0.2 dense row encoding (FILE_VERSION 8): per-row NULL
9408 // bitmap, then tightly-packed bodies. Identical wire format
9409 // as before — extracted into `encode_row_body_dense` so cold-
9410 // tier segments (v5.1+) can share the encoding.
9411 for row in &t.rows {
9412 out.extend_from_slice(&encode_row_body_dense(row, &t.schema));
9413 }
9414 // Index definitions. Per-index payload:
9415 // [name][col_pos u16][kind u8]
9416 // kind 0 = B-tree (no params — rebuilt on load)
9417 // kind 1 = NSW graph (u16 M + serialized graph)
9418 // For NSW the graph topology travels on disk so startup
9419 // doesn't re-run the O(n²M) rebuild — see v2.7 notes.
9420 write_u16(
9421 &mut out,
9422 u16::try_from(t.indices.len()).expect("≤ 65k indices/table"),
9423 );
9424 for idx in &t.indices {
9425 write_str(&mut out, &idx.name);
9426 write_u16(
9427 &mut out,
9428 u16::try_from(idx.column_position).expect("≤ 65k columns/table"),
9429 );
9430 match &idx.kind {
9431 IndexKind::BTree(map) => {
9432 out.push(0);
9433 // v9: serialise the full PB map. Each entry's
9434 // RowLocator list travels with the tag-prefixed
9435 // codec from `row_locator::write_le`, so freezer-
9436 // produced Cold locators survive a snapshot
9437 // round-trip. v8 BTree wrote nothing here and
9438 // rebuilt from rows — v9 readers tolerate v8 by
9439 // version dispatch in `Catalog::deserialize`.
9440 write_u32(
9441 &mut out,
9442 u32::try_from(map.len()).expect("≤ 4G index entries/index"),
9443 );
9444 for (key, locators) in map {
9445 write_index_key(&mut out, key);
9446 write_u32(
9447 &mut out,
9448 u32::try_from(locators.len()).expect("≤ 4G locators/key"),
9449 );
9450 for loc in locators {
9451 loc.write_le(&mut out);
9452 }
9453 }
9454 }
9455 // v7.38.1 (L12) — tag byte 7 = BTreeMulti. Payload
9456 // mirrors the tag-0 BTree encoding, with each key
9457 // written as `[u16 arity]` followed by that many
9458 // `write_index_key` components. FILE_VERSION 91+;
9459 // older catalogs never carried a multi index, so no
9460 // migration shim is needed.
9461 IndexKind::BTreeMulti(map) => {
9462 out.push(7);
9463 write_u32(
9464 &mut out,
9465 u32::try_from(map.len()).expect("≤ 4G index entries/index"),
9466 );
9467 for (key, locators) in map {
9468 write_u16(
9469 &mut out,
9470 u16::try_from(key.len()).expect("≤ 65k key components"),
9471 );
9472 for component in key.iter() {
9473 write_index_key(&mut out, component);
9474 }
9475 write_u32(
9476 &mut out,
9477 u32::try_from(locators.len()).expect("≤ 4G locators/key"),
9478 );
9479 for loc in locators {
9480 loc.write_le(&mut out);
9481 }
9482 }
9483 }
9484 IndexKind::Nsw(g) => {
9485 out.push(1);
9486 write_u16(&mut out, u16::try_from(g.m).expect("≤ 65k NSW neighbours"));
9487 write_nsw_graph(&mut out, g);
9488 }
9489 IndexKind::Brin { column_type, .. } => {
9490 // v6.7.1 — tag byte 2 = BRIN. Payload is the
9491 // column type code (1 byte mapping to the
9492 // shared DataType numeric encoding); no
9493 // further data — BRIN summaries live in
9494 // cold segments, not the catalog.
9495 out.push(2);
9496 write_data_type(&mut out, *column_type);
9497 }
9498 IndexKind::Gin(map) => {
9499 // v7.12.3 — tag byte 3 = GIN. Payload mirrors
9500 // the BTree encoding but with String (lexeme
9501 // word) keys instead of IndexKey. Tag-prefixed
9502 // RowLocator codec so freezer-produced Cold
9503 // locators survive snapshot round-trip.
9504 // FILE_VERSION 21+; v20 catalogs never wrote a
9505 // GIN index (the AM degraded to BTree fallback
9506 // pre-v7.12.3), so no migration shim is needed.
9507 out.push(3);
9508 write_u32(
9509 &mut out,
9510 u32::try_from(map.len()).expect("≤ 4G GIN posting lists"),
9511 );
9512 for (word, locators) in map {
9513 write_str(&mut out, word);
9514 write_u32(
9515 &mut out,
9516 u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9517 );
9518 for loc in locators {
9519 loc.write_le(&mut out);
9520 }
9521 }
9522 }
9523 IndexKind::GinTrgm(map) => {
9524 // v7.15.0 — tag byte 4 = GinTrgm
9525 // (`gin_trgm_ops` GIN over a TEXT column).
9526 // Payload shape is identical to tag-3 GIN —
9527 // `String → Vec<RowLocator>` posting lists.
9528 // The String keys are 3-byte trigrams instead
9529 // of tsvector lexemes; the deserializer
9530 // dispatches on the tag, not the key shape.
9531 // FILE_VERSION 24+; v23 catalogs never wrote
9532 // a trigram-GIN.
9533 out.push(4);
9534 write_u32(
9535 &mut out,
9536 u32::try_from(map.len()).expect("≤ 4G trigram-GIN posting lists"),
9537 );
9538 for (tri, locators) in map {
9539 write_str(&mut out, tri);
9540 write_u32(
9541 &mut out,
9542 u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9543 );
9544 for loc in locators {
9545 loc.write_le(&mut out);
9546 }
9547 }
9548 }
9549 IndexKind::GinFulltext(map) => {
9550 // v7.17.0 Phase 2.2 — tag byte 5 =
9551 // GinFulltext (MySQL `FULLTEXT KEY` GIN
9552 // over a TEXT/VARCHAR column). Payload
9553 // shape mirrors tag-3 / tag-4 GIN —
9554 // `String → Vec<RowLocator>` posting
9555 // lists keyed by lower-cased word
9556 // lexemes. FILE_VERSION 33+; v32 catalogs
9557 // never wrote a fulltext-GIN (FULLTEXT
9558 // KEY was silently dropped pre-v7.17).
9559 out.push(5);
9560 write_u32(
9561 &mut out,
9562 u32::try_from(map.len()).expect("≤ 4G fulltext-GIN posting lists"),
9563 );
9564 for (lex, locators) in map {
9565 write_str(&mut out, lex);
9566 write_u32(
9567 &mut out,
9568 u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9569 );
9570 for loc in locators {
9571 loc.write_le(&mut out);
9572 }
9573 }
9574 }
9575 IndexKind::GinJsonb(map) => {
9576 // v7.37.8 — tag byte 6 = GinJsonb
9577 // (real posting-list GIN over a JSONB
9578 // column; sentori Epic 5 P2). Payload
9579 // shape mirrors tag-3 / 4 / 5 — keys are
9580 // the canonical `(path, leaf)` tokens
9581 // from `jsonb_gin::extract_tokens`.
9582 // FILE_VERSION 51+; v50 catalogs never
9583 // wrote a JSONB-GIN (the same DDL loaded
9584 // as a BTree fallback).
9585 out.push(6);
9586 write_u32(
9587 &mut out,
9588 u32::try_from(map.len()).expect("≤ 4G JSONB-GIN posting lists"),
9589 );
9590 for (token, locators) in map {
9591 write_str(&mut out, token);
9592 write_u32(
9593 &mut out,
9594 u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9595 );
9596 for loc in locators {
9597 loc.write_le(&mut out);
9598 }
9599 }
9600 }
9601 }
9602 // v6.8.0 — included_columns appendix per index.
9603 // Layout: [u16 num_included][num × u16 column_position].
9604 // v11 readers stop before this u16 (deserialise loop
9605 // gated on version >= 12); v12+ readers always
9606 // consume it. Empty Vec serialises as a bare 0u16.
9607 write_u16(
9608 &mut out,
9609 u16::try_from(idx.included_columns.len()).expect("≤ 65k INCLUDE columns/index"),
9610 );
9611 for col_pos in &idx.included_columns {
9612 write_u16(
9613 &mut out,
9614 u16::try_from(*col_pos).expect("≤ 65k columns/table"),
9615 );
9616 }
9617 // v6.8.1 — partial_predicate appendix per index.
9618 // Layout: [u8 has_pred][u16 LE len][bytes (if has_pred)].
9619 // Same v12 gate as included_columns.
9620 match &idx.partial_predicate {
9621 None => out.push(0),
9622 Some(pred) => {
9623 out.push(1);
9624 write_str(&mut out, pred);
9625 }
9626 }
9627 // v6.8.2 — expression appendix. Same shape as
9628 // partial_predicate.
9629 match &idx.expression {
9630 None => out.push(0),
9631 Some(expr) => {
9632 out.push(1);
9633 write_str(&mut out, expr);
9634 }
9635 }
9636 // v7.9.29 — is_unique appendix (FILE_VERSION 16+).
9637 // Single byte 0/1. v15-and-below readers stop before
9638 // this byte; v16 readers always consume it. mailrs K1.
9639 out.push(u8::from(idx.is_unique));
9640 // v7.9.29 — extra_column_positions appendix.
9641 // Layout: [u16 count][count × u16 column_position].
9642 write_u16(
9643 &mut out,
9644 u16::try_from(idx.extra_column_positions.len())
9645 .expect("≤ 65k extra cols / index"),
9646 );
9647 for cp in &idx.extra_column_positions {
9648 write_u16(&mut out, u16::try_from(*cp).expect("≤ 65k columns/table"));
9649 }
9650 // v7.39 (read01 round 52) — nulls_not_distinct (FILE_VERSION
9651 // 62+). Appended at the end of the per-index block so the v16
9652 // layout above is untouched; v61-and-below readers stop before
9653 // this byte and default the flag to false (NULLS DISTINCT).
9654 out.push(u8::from(idx.nulls_not_distinct));
9655 // v7.39 (round 537) — the key column's ordering clause
9656 // (FILE_VERSION 83+).
9657 out.push(u8::from(idx.descending));
9658 out.push(match idx.nulls_first {
9659 None => 0,
9660 Some(true) => 1,
9661 Some(false) => 2,
9662 });
9663 // v7.39 (round 538) — the key's explicit collation
9664 // (FILE_VERSION 84+).
9665 match &idx.collation {
9666 Some(c) => {
9667 out.push(1);
9668 write_str(&mut out, c);
9669 }
9670 None => out.push(0),
9671 }
9672 }
9673 // v6.7.2 — per-table hot_tier_bytes Option<u64>.
9674 // Layout: [u8 has_value][u64 LE value (if has_value)].
9675 // v10 readers stop before this byte (deserialise loop
9676 // gated on version >= 11); v11+ readers always
9677 // consume it.
9678 match t.schema.hot_tier_bytes {
9679 None => out.push(0),
9680 Some(n) => {
9681 out.push(1);
9682 out.extend_from_slice(&n.to_le_bytes());
9683 }
9684 }
9685 // v7.6.1 — FOREIGN KEY appendix (catalog FILE_VERSION 13+).
9686 // Layout: [u16 LE fk_count]
9687 // per fk:
9688 // [u8 has_name] [str name (if has_name)]
9689 // [u16 LE local_arity] [u16 LE local_pos]*arity
9690 // [str parent_table]
9691 // [u16 LE parent_arity] [u16 LE parent_pos]*arity
9692 // [u8 on_delete_tag] [u8 on_update_tag]
9693 // Older catalogs (v12 and below) skip this block entirely;
9694 // their reader stops before this byte.
9695 write_u16(
9696 &mut out,
9697 u16::try_from(t.schema.foreign_keys.len()).expect("≤ 65k FKs/table"),
9698 );
9699 for fk in &t.schema.foreign_keys {
9700 match &fk.name {
9701 None => out.push(0),
9702 Some(n) => {
9703 out.push(1);
9704 write_str(&mut out, n);
9705 }
9706 }
9707 write_u16(
9708 &mut out,
9709 u16::try_from(fk.local_columns.len()).expect("≤ 65k FK columns"),
9710 );
9711 for &p in &fk.local_columns {
9712 write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9713 }
9714 write_str(&mut out, &fk.parent_table);
9715 write_u16(
9716 &mut out,
9717 u16::try_from(fk.parent_columns.len()).expect("≤ 65k FK parent columns"),
9718 );
9719 for &p in &fk.parent_columns {
9720 write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9721 }
9722 out.push(fk.on_delete.tag());
9723 out.push(fk.on_update.tag());
9724 // v7.38 (read01, T29) — MATCH type tag (FILE_VERSION 55+).
9725 out.push(fk.match_type.tag());
9726 // v7.39 (round 288) — constraint timing (FILE_VERSION 79+).
9727 // One byte, bit 0 = DEFERRABLE, bit 1 = INITIALLY DEFERRED.
9728 out.push(u8::from(fk.deferrable) | (u8::from(fk.initially_deferred) << 1));
9729 }
9730 // v7.9.19 — UniquenessConstraint appendix (catalog
9731 // FILE_VERSION 15+). Layout per table after the FK
9732 // block:
9733 // [u16 count]
9734 // per constraint:
9735 // [u8 is_primary_key]
9736 // [u16 arity][u16 col_pos]*arity
9737 // Older catalogs (v14 and below) skip this block.
9738 write_u16(
9739 &mut out,
9740 u16::try_from(t.schema.uniqueness_constraints.len())
9741 .expect("≤ 65k uniqueness constraints/table"),
9742 );
9743 for uc in &t.schema.uniqueness_constraints {
9744 out.push(u8::from(uc.is_primary_key));
9745 write_u16(
9746 &mut out,
9747 u16::try_from(uc.columns.len()).expect("≤ 65k cols in uniqueness constraint"),
9748 );
9749 for &p in &uc.columns {
9750 write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9751 }
9752 // v7.13.0 — `nulls_not_distinct` flag
9753 // (FILE_VERSION 23+). Always written by writers at
9754 // version 23+; deserialise gates on `version >= 23`
9755 // so v22-and-below catalogs round-trip cleanly.
9756 out.push(u8::from(uc.nulls_not_distinct));
9757 }
9758 // v7.9.21 — runtime_default appendix per table.
9759 // Layout: [u16 count] then for each:
9760 // [u16 col_pos][str expr]
9761 // Only columns whose runtime_default is Some land here;
9762 // catalog stays compact for the common literal-default
9763 // case.
9764 let mut rt_defaults: Vec<(usize, &str)> = Vec::new();
9765 for (i, c) in t.schema.columns.iter().enumerate() {
9766 if let Some(e) = &c.runtime_default {
9767 rt_defaults.push((i, e.as_str()));
9768 }
9769 }
9770 write_u16(
9771 &mut out,
9772 u16::try_from(rt_defaults.len()).expect("≤ 65k runtime defaults/table"),
9773 );
9774 for (pos, expr) in rt_defaults {
9775 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9776 write_str(&mut out, expr);
9777 }
9778 // v7.13.0 — CHECK constraint appendix per table.
9779 // Layout: [u16 count] then `count` Display-form
9780 // expression strings. Re-parsed on every INSERT/UPDATE
9781 // by the engine. FILE_VERSION 23+ only; v22 readers
9782 // never reach this block because the writer also moves
9783 // to v23 in lock-step.
9784 write_u16(
9785 &mut out,
9786 u16::try_from(t.schema.checks.len()).expect("≤ 65k CHECK constraints/table"),
9787 );
9788 for c in &t.schema.checks {
9789 // v7.39 (read01 round 48) — the expr stays in this v23
9790 // appendix (byte layout unchanged for old readers); the
9791 // name rides the v60 constraint-name appendix at the tail.
9792 write_str(&mut out, c.expr.as_str());
9793 }
9794 // v7.17.0 Phase 1.4 — per-table user_enum_type
9795 // appendix. Layout: [u16 count] then
9796 // [u16 col_pos][str enum_name] per binding. Only
9797 // columns whose user_enum_type is Some land here.
9798 let mut enum_bindings: Vec<(usize, &str)> = Vec::new();
9799 for (i, c) in t.schema.columns.iter().enumerate() {
9800 if let Some(e) = &c.user_enum_type {
9801 enum_bindings.push((i, e.as_str()));
9802 }
9803 }
9804 write_u16(
9805 &mut out,
9806 u16::try_from(enum_bindings.len()).expect("≤ 65k enum-typed columns/table"),
9807 );
9808 for (pos, ename) in enum_bindings {
9809 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9810 write_str(&mut out, ename);
9811 }
9812 // v7.17.0 Phase 1.5 — per-table user_domain_type
9813 // appendix. Same layout as the enum one. v29-and-
9814 // below readers stop after the enum appendix.
9815 let mut domain_bindings: Vec<(usize, &str)> = Vec::new();
9816 for (i, c) in t.schema.columns.iter().enumerate() {
9817 if let Some(d) = &c.user_domain_type {
9818 domain_bindings.push((i, d.as_str()));
9819 }
9820 }
9821 write_u16(
9822 &mut out,
9823 u16::try_from(domain_bindings.len()).expect("≤ 65k domain-typed columns/table"),
9824 );
9825 for (pos, dname) in domain_bindings {
9826 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9827 write_str(&mut out, dname);
9828 }
9829 // v7.17.0 Phase 2.1 — per-table on_update_runtime
9830 // appendix. Sparse: only ON UPDATE-bound columns.
9831 let mut on_update_bindings: Vec<(usize, &str)> = Vec::new();
9832 for (i, c) in t.schema.columns.iter().enumerate() {
9833 if let Some(e) = &c.on_update_runtime {
9834 on_update_bindings.push((i, e.as_str()));
9835 }
9836 }
9837 write_u16(
9838 &mut out,
9839 u16::try_from(on_update_bindings.len()).expect("≤ 65k ON UPDATE columns/table"),
9840 );
9841 for (pos, expr_src) in on_update_bindings {
9842 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9843 write_str(&mut out, expr_src);
9844 }
9845 // v7.17.0 Phase 2.5 — per-table collation appendix.
9846 // Sparse: only non-Binary columns land. Layout:
9847 // `[u16 count][u16 col_pos][u8 tag] × count`.
9848 let mut coll_bindings: Vec<(usize, u8)> = Vec::new();
9849 for (i, c) in t.schema.columns.iter().enumerate() {
9850 let tag = match c.collation {
9851 Collation::Binary => continue,
9852 Collation::CaseInsensitive => Collation::TAG_CASE_INSENSITIVE,
9853 };
9854 coll_bindings.push((i, tag));
9855 }
9856 write_u16(
9857 &mut out,
9858 u16::try_from(coll_bindings.len()).expect("≤ 65k collation bindings/table"),
9859 );
9860 for (pos, tag) in coll_bindings {
9861 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9862 out.push(tag);
9863 }
9864 // v7.17.0 Phase 4.4 — per-table is_unsigned appendix.
9865 // Sparse: only UNSIGNED columns land. Layout:
9866 // `[u16 count][u16 col_pos] × count`.
9867 let mut unsigned_bindings: Vec<usize> = Vec::new();
9868 for (i, c) in t.schema.columns.iter().enumerate() {
9869 if c.is_unsigned {
9870 unsigned_bindings.push(i);
9871 }
9872 }
9873 write_u16(
9874 &mut out,
9875 u16::try_from(unsigned_bindings.len()).expect("≤ 65k UNSIGNED columns/table"),
9876 );
9877 for pos in unsigned_bindings {
9878 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9879 }
9880 // v7.17.0 Phase 3.P0-36 — per-table inline_enum_variants
9881 // appendix. Sparse: only ENUM columns land. Layout:
9882 // `[u16 count] then per binding [u16 col_pos]
9883 // [u16 variant_count] then variant strings`.
9884 // FILE_VERSION 41+; v40 readers never reach this block.
9885 let mut enum_inline_bindings: Vec<(usize, &[String])> = Vec::new();
9886 for (i, c) in t.schema.columns.iter().enumerate() {
9887 if let Some(vs) = &c.inline_enum_variants {
9888 enum_inline_bindings.push((i, vs.as_slice()));
9889 }
9890 }
9891 write_u16(
9892 &mut out,
9893 u16::try_from(enum_inline_bindings.len()).expect("≤ 65k inline-ENUM columns/table"),
9894 );
9895 for (pos, variants) in enum_inline_bindings {
9896 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9897 write_u16(
9898 &mut out,
9899 u16::try_from(variants.len()).expect("≤ 65k variants/ENUM"),
9900 );
9901 for v in variants {
9902 write_str(&mut out, v.as_str());
9903 }
9904 }
9905 // v7.17.0 Phase 3.P0-37 — per-table inline_set_variants
9906 // appendix. Same layout as the inline ENUM block.
9907 // FILE_VERSION 42+; v41 readers never reach this block.
9908 let mut set_inline_bindings: Vec<(usize, &[String])> = Vec::new();
9909 for (i, c) in t.schema.columns.iter().enumerate() {
9910 if let Some(vs) = &c.inline_set_variants {
9911 set_inline_bindings.push((i, vs.as_slice()));
9912 }
9913 }
9914 write_u16(
9915 &mut out,
9916 u16::try_from(set_inline_bindings.len()).expect("≤ 65k inline-SET columns/table"),
9917 );
9918 for (pos, variants) in set_inline_bindings {
9919 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9920 write_u16(
9921 &mut out,
9922 u16::try_from(variants.len()).expect("≤ 65k variants/SET"),
9923 );
9924 for v in variants {
9925 write_str(&mut out, v.as_str());
9926 }
9927 }
9928 // v7.37.6-B — partition role appendix(FILE_VERSION 49+)。
9929 // Layout 详见 FILE_VERSION 49 docstring。普通表 = 单字节 0。
9930 write_partition_role(&mut out, t.schema.partition_role.as_ref());
9931 // v7.37.7 — per-table generated_stored_expr appendix
9932 // (FILE_VERSION 50+). Sparse: only columns whose
9933 // generated_stored_expr is Some land here.
9934 let mut gen_bindings: Vec<(usize, &str)> = Vec::new();
9935 for (i, c) in t.schema.columns.iter().enumerate() {
9936 if let Some(src) = &c.generated_stored_expr {
9937 gen_bindings.push((i, src.as_str()));
9938 }
9939 }
9940 write_u16(
9941 &mut out,
9942 u16::try_from(gen_bindings.len()).expect("≤ 65k GENERATED STORED columns/table"),
9943 );
9944 for (pos, src) in gen_bindings {
9945 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9946 write_str(&mut out, src);
9947 }
9948 // v7.38 (read01) — per-table default_text appendix
9949 // (FILE_VERSION 58+). Sparse: only columns whose default_text
9950 // is Some land here. Mirrors the generated_stored_expr shape.
9951 let mut default_texts: Vec<(usize, &str)> = Vec::new();
9952 for (i, c) in t.schema.columns.iter().enumerate() {
9953 if let Some(src) = &c.default_text {
9954 default_texts.push((i, src.as_str()));
9955 }
9956 }
9957 write_u16(
9958 &mut out,
9959 u16::try_from(default_texts.len()).expect("≤ 65k defaulted columns/table"),
9960 );
9961 for (pos, src) in default_texts {
9962 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9963 write_str(&mut out, src);
9964 }
9965 // v7.39 (RLS) — per-table policy appendix + the two RLS flags
9966 // (FILE_VERSION 59+). Written after the default_text block and
9967 // before the MVCC row appendix, so a v58 reader stops before it.
9968 // Layout: [u8 row_security][u8 force] [u16 policy_count] then per
9969 // policy: [str name][u8 cmd][u8 permissive][u16 role_count]
9970 // (role_count × str) [u8 has_using](+str)[u8 has_check](+str).
9971 out.push(u8::from(t.schema.row_security));
9972 out.push(u8::from(t.schema.force_row_security));
9973 write_u16(
9974 &mut out,
9975 u16::try_from(t.schema.policies.len()).expect("≤ 65k policies/table"),
9976 );
9977 for p in &t.schema.policies {
9978 write_str(&mut out, &p.name);
9979 out.push(p.cmd.to_wire_byte());
9980 out.push(u8::from(p.permissive));
9981 write_u16(
9982 &mut out,
9983 u16::try_from(p.roles.len()).expect("≤ 65k roles/policy"),
9984 );
9985 for r in &p.roles {
9986 write_str(&mut out, r);
9987 }
9988 match &p.using_expr {
9989 Some(s) => {
9990 out.push(1);
9991 write_str(&mut out, s);
9992 }
9993 None => out.push(0),
9994 }
9995 match &p.with_check_expr {
9996 Some(s) => {
9997 out.push(1);
9998 write_str(&mut out, s);
9999 }
10000 None => out.push(0),
10001 }
10002 }
10003 // v7.37.16 (Epic W) — per-row MVCC header + stable RowId
10004 // appendix (FILE_VERSION 53+). Persists xmin/xmax/flags +
10005 // RowId for every row so a tombstone naming a pre-checkpoint
10006 // row survives a serialize→deserialize base restore
10007 // (cross-checkpoint tombstone durability). `headers` /
10008 // `rowids` are lock-step parallel to `rows` (invariant held
10009 // at every mutation boundary), so the count is `rows.len()`
10010 // and the zipped walk visits them in physical row order —
10011 // the same order the rows block above was written in. v52
10012 // readers never reach this block (the writer also moves to
10013 // v53 in lock-step); a v53 reader restores headers + ids
10014 // verbatim instead of freezing + dense-assigning.
10015 debug_assert_eq!(
10016 t.rows.len(),
10017 t.headers.len(),
10018 "headers must be lock-step with rows at serialize"
10019 );
10020 debug_assert_eq!(
10021 t.rows.len(),
10022 t.rowids.len(),
10023 "rowids must be lock-step with rows at serialize"
10024 );
10025 write_u32(
10026 &mut out,
10027 u32::try_from(t.rows.len()).expect("≤ 4G rows/table"),
10028 );
10029 for (h, rid) in t.headers.iter().zip(t.rowids.iter()) {
10030 out.extend_from_slice(&h.xmin.to_le_bytes());
10031 out.extend_from_slice(&h.xmax.to_le_bytes());
10032 out.push(h.flags);
10033 out.extend_from_slice(&rid.0.to_le_bytes());
10034 }
10035 out.extend_from_slice(
10036 &t.next_rowid
10037 .load(core::sync::atomic::Ordering::Relaxed)
10038 .to_le_bytes(),
10039 );
10040 // v7.39 (read01 round 48) — constraint-name appendix
10041 // (FILE_VERSION 60+). Index-aligned to the CHECK and
10042 // uniqueness-constraint appendices written above, so the
10043 // existing byte layouts stay untouched and a v59 catalog still
10044 // decodes (its constraints just come back unnamed).
10045 // Layout: [u16 check_count] then per check
10046 // [u8 has_name] ([str name] when has_name)
10047 // [u16 uc_count] then per uc the same pair.
10048 write_u16(
10049 &mut out,
10050 u16::try_from(t.schema.checks.len()).expect("≤ 65k CHECK constraints/table"),
10051 );
10052 for c in &t.schema.checks {
10053 match &c.name {
10054 Some(n) => {
10055 out.push(1);
10056 write_str(&mut out, n);
10057 }
10058 None => out.push(0),
10059 }
10060 }
10061 write_u16(
10062 &mut out,
10063 u16::try_from(t.schema.uniqueness_constraints.len())
10064 .expect("≤ 65k uniqueness constraints/table"),
10065 );
10066 for uc in &t.schema.uniqueness_constraints {
10067 match &uc.name {
10068 Some(n) => {
10069 out.push(1);
10070 write_str(&mut out, n);
10071 }
10072 None => out.push(0),
10073 }
10074 }
10075 // v7.39 (read01 round 56) — user_composite_type appendix
10076 // (FILE_VERSION 63+). Sparse, at the very end of the per-table
10077 // block: only composite-typed columns land here, so a v62 reader
10078 // stops before it and its composite columns stay plain JSON.
10079 let mut comp_bindings: Vec<(usize, &str)> = Vec::new();
10080 for (i, c) in t.schema.columns.iter().enumerate() {
10081 if let Some(n) = &c.user_composite_type {
10082 comp_bindings.push((i, n.as_str()));
10083 }
10084 }
10085 write_u16(
10086 &mut out,
10087 u16::try_from(comp_bindings.len()).expect("≤ 65k composite-typed columns/table"),
10088 );
10089 for (pos, n) in comp_bindings {
10090 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
10091 write_str(&mut out, n);
10092 }
10093 // v7.39 (read01 round 57) — owner + ACL appendix (FILE_VERSION
10094 // 64+), at the very end of the per-table block so a v63 reader
10095 // stops before it (its tables then read back owner-less, i.e.
10096 // owned by the login role, with no grants — which is exactly what
10097 // they were).
10098 match &t.schema.owner {
10099 Some(o) => {
10100 out.push(1);
10101 write_str(&mut out, o);
10102 }
10103 None => out.push(0),
10104 }
10105 write_u16(
10106 &mut out,
10107 u16::try_from(t.schema.acl.len()).expect("≤ 65k aclitems/table"),
10108 );
10109 for a in &t.schema.acl {
10110 write_str(&mut out, &a.grantee);
10111 write_u16(&mut out, a.privs);
10112 write_u16(&mut out, a.grantable);
10113 write_str(&mut out, &a.grantor);
10114 }
10115 // v7.39 (read01 round 59) — COLUMN acl appendix (FILE_VERSION 65+),
10116 // sparse: only columns that carry a grant land here, so a v64 reader
10117 // stops before it and its columns read back un-granted, which is
10118 // what they were.
10119 let granted: Vec<(usize, &ColumnSchema)> = t
10120 .schema
10121 .columns
10122 .iter()
10123 .enumerate()
10124 .filter(|(_, c)| !c.acl.is_empty())
10125 .collect();
10126 write_u16(
10127 &mut out,
10128 u16::try_from(granted.len()).expect("≤ 65k granted columns/table"),
10129 );
10130 for (pos, c) in granted {
10131 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
10132 write_u16(
10133 &mut out,
10134 u16::try_from(c.acl.len()).expect("≤ 65k aclitems/column"),
10135 );
10136 for a in &c.acl {
10137 write_str(&mut out, &a.grantee);
10138 write_u16(&mut out, a.privs);
10139 write_u16(&mut out, a.grantable);
10140 write_str(&mut out, &a.grantor);
10141 }
10142 }
10143 // v7.39 (round 210) — EXCLUDE-constraint appendix (FILE_VERSION
10144 // 72+), at the very end of the per-table block so a v71 reader
10145 // stops before it and its tables read back with no exclusion
10146 // constraints. Layout: [u16 excl_count] then per constraint
10147 // [str name] [u8 has_method](+str) [u16 elem_count] then per
10148 // element [u16 col_pos][str op].
10149 write_u16(
10150 &mut out,
10151 u16::try_from(t.schema.exclusion_constraints.len())
10152 .expect("≤ 65k exclusion constraints/table"),
10153 );
10154 for ex in &t.schema.exclusion_constraints {
10155 write_str(&mut out, &ex.name);
10156 match &ex.method {
10157 Some(m) => {
10158 out.push(1);
10159 write_str(&mut out, m);
10160 }
10161 None => out.push(0),
10162 }
10163 write_u16(
10164 &mut out,
10165 u16::try_from(ex.elements.len()).expect("≤ 65k elements/exclusion"),
10166 );
10167 for (pos, op) in &ex.elements {
10168 write_u16(&mut out, u16::try_from(*pos).expect("≤ 65k columns/table"));
10169 write_str(&mut out, op);
10170 }
10171 }
10172 // v7.39 (round 220) — identity-RESTART appendix (FILE_VERSION
10173 // 73+), sparse: only columns carrying a RESTART floor land here.
10174 let restarts: Vec<(usize, i64)> = t
10175 .schema
10176 .columns
10177 .iter()
10178 .enumerate()
10179 .filter_map(|(i, c)| c.auto_restart.map(|n| (i, n)))
10180 .collect();
10181 write_u16(
10182 &mut out,
10183 u16::try_from(restarts.len()).expect("≤ 65k restart columns/table"),
10184 );
10185 for (pos, n) in restarts {
10186 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
10187 out.extend_from_slice(&n.to_le_bytes());
10188 }
10189 // v7.39 (round 386, type-fidelity epic P1) — per-table
10190 // mysql_int_width appendix (FILE_VERSION 81+). Sparse: only
10191 // TINYINT / MEDIUMINT columns land. Layout:
10192 // `[u16 count]([u16 col_pos][u8 width_tag]) × count`
10193 // (tag 0 = Tiny, 1 = Medium). v80-and-below readers stop after
10194 // the identity-RESTART appendix, leaving every column at None.
10195 let int_widths: Vec<(usize, u8)> = t
10196 .schema
10197 .columns
10198 .iter()
10199 .enumerate()
10200 .filter_map(|(i, c)| {
10201 c.mysql_int_width.map(|w| {
10202 let tag = match w {
10203 MysqlIntWidth::Tiny => 0u8,
10204 MysqlIntWidth::Medium => 1u8,
10205 MysqlIntWidth::Small => 2u8,
10206 MysqlIntWidth::Int => 3u8,
10207 MysqlIntWidth::Big => 4u8,
10208 };
10209 (i, tag)
10210 })
10211 })
10212 .collect();
10213 write_u16(
10214 &mut out,
10215 u16::try_from(int_widths.len()).expect("≤ 65k narrow-int columns/table"),
10216 );
10217 for (pos, tag) in int_widths {
10218 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
10219 out.push(tag);
10220 }
10221 // v7.39 (round 424, type-fidelity epic) — per-table mysql_fsp
10222 // appendix (FILE_VERSION 82+). Sparse: only MySQL-declared
10223 // temporal columns land. Layout:
10224 // `[u16 count]([u16 col_pos][u8 fsp]) × count`, fsp in 0..=6.
10225 // v81-and-below readers stop after the int-width appendix,
10226 // leaving every column at None (PG microsecond behaviour).
10227 let fsps: Vec<(usize, u8)> = t
10228 .schema
10229 .columns
10230 .iter()
10231 .enumerate()
10232 .filter_map(|(i, c)| c.mysql_fsp.map(|p| (i, p)))
10233 .collect();
10234 write_u16(
10235 &mut out,
10236 u16::try_from(fsps.len()).expect("≤ 65k temporal columns/table"),
10237 );
10238 for (pos, fsp) in fsps {
10239 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
10240 out.push(fsp);
10241 }
10242 // v7.39 (round 652) — CHECK-validated appendix (FILE_VERSION
10243 // 87+). Sparse the other way round from the ones above: the
10244 // common case is every constraint validated, so only the
10245 // NOT VALID ones are written, by their index into the CHECK
10246 // appendix. Layout: `[u16 count]([u16 check_idx]) × count`.
10247 let unvalidated: Vec<usize> = t
10248 .schema
10249 .checks
10250 .iter()
10251 .enumerate()
10252 .filter_map(|(i, c)| (!c.validated).then_some(i))
10253 .collect();
10254 write_u16(
10255 &mut out,
10256 u16::try_from(unvalidated.len()).expect("≤ 65k CHECK constraints/table"),
10257 );
10258 for idx in unvalidated {
10259 write_u16(&mut out, u16::try_from(idx).expect("≤ 65k CHECK/table"));
10260 }
10261 // v7.39 (round 677) — per-column collation names (FILE_VERSION
10262 // 88+). Sparse: only the columns that were written with an
10263 // explicit `COLLATE` appear, so a table that declares none pays
10264 // two bytes. Layout: `[u16 count]([u16 col_idx][str]) × count`.
10265 //
10266 // Without this the declaration survives CREATE TABLE and dies
10267 // at the next restart — measured: a column declared
10268 // `COLLATE "C"` reported attcollation 950 in the session that
10269 // created it and 100 after a reload.
10270 let collated: Vec<(usize, &str)> = t
10271 .schema
10272 .columns
10273 .iter()
10274 .enumerate()
10275 .filter_map(|(i, c)| c.collation_name.as_deref().map(|n| (i, n)))
10276 .collect();
10277 write_u16(
10278 &mut out,
10279 u16::try_from(collated.len()).expect("≤ 65k columns/table"),
10280 );
10281 for (idx, name) in collated {
10282 write_u16(&mut out, u16::try_from(idx).expect("≤ 65k columns/table"));
10283 write_str(&mut out, name);
10284 }
10285 // v7.39 (round 711) — PK/UNIQUE constraint timing (FILE_VERSION
10286 // 89+). Dense, one byte per uniqueness constraint in
10287 // declaration order, the same bit layout the FK block has
10288 // carried since round 288: bit 0 = DEFERRABLE, bit 1 =
10289 // INITIALLY DEFERRED. A v88 reader stops before it.
10290 write_u16(
10291 &mut out,
10292 u16::try_from(t.schema.uniqueness_constraints.len())
10293 .expect("≤ 65k uniqueness constraints/table"),
10294 );
10295 for uc in &t.schema.uniqueness_constraints {
10296 out.push(u8::from(uc.deferrable) | (u8::from(uc.initially_deferred) << 1));
10297 }
10298 }
10299 // v7.12.4 — catalog-wide appendix: user-defined functions
10300 // then triggers. FILE_VERSION 22+ only. v21 and earlier
10301 // readers stop after the last table; v22 readers always
10302 // consume two `u32` counts (possibly zero).
10303 //
10304 // Function entry layout:
10305 // [str name] [str args_repr] [str returns]
10306 // [str language] [str body]
10307 // Trigger entry layout:
10308 // [str name] [str table] [str timing]
10309 // [u16 event_count] (event_count × str)
10310 // [str for_each] [str function]
10311 write_u32(
10312 &mut out,
10313 u32::try_from(self.functions.len()).expect("≤ 4G functions"),
10314 );
10315 for fd in self.functions.values() {
10316 write_str(&mut out, &fd.name);
10317 write_str(&mut out, &fd.args_repr);
10318 write_str(&mut out, &fd.returns);
10319 write_str(&mut out, &fd.language);
10320 write_str_long(&mut out, &fd.body);
10321 }
10322 write_u32(
10323 &mut out,
10324 u32::try_from(self.triggers.len()).expect("≤ 4G triggers"),
10325 );
10326 for td in &self.triggers {
10327 write_str(&mut out, &td.name);
10328 write_str(&mut out, &td.table);
10329 write_str(&mut out, &td.timing);
10330 write_u16(
10331 &mut out,
10332 u16::try_from(td.events.len()).expect("≤ 65k events / trigger"),
10333 );
10334 for ev in &td.events {
10335 write_str(&mut out, ev);
10336 }
10337 write_str(&mut out, &td.for_each);
10338 write_str(&mut out, &td.function);
10339 // v7.13.0 — `UPDATE OF cols` filter
10340 // (FILE_VERSION 23+). v22 readers omit; v23 writers
10341 // always emit (possibly zero).
10342 write_u16(
10343 &mut out,
10344 u16::try_from(td.update_columns.len()).expect("≤ 65k cols / trigger"),
10345 );
10346 for c in &td.update_columns {
10347 write_str(&mut out, c);
10348 }
10349 // v7.16.1 — TriggerDef.enabled (FILE_VERSION 25+).
10350 out.push(u8::from(td.enabled));
10351 // v7.39 (round 138) — WHEN condition text (FILE_VERSION 70+).
10352 write_str(&mut out, &td.when_condition);
10353 }
10354 // v7.17.0 Phase 1.1 — SEQUENCE catalog block (FILE_VERSION 26+).
10355 write_u32(
10356 &mut out,
10357 u32::try_from(self.sequences.len()).expect("≤ 4G sequences"),
10358 );
10359 for seq in self.sequences.values() {
10360 write_str(&mut out, &seq.name);
10361 out.push(match seq.data_type {
10362 SequenceDataType::SmallInt => 0,
10363 SequenceDataType::Int => 1,
10364 SequenceDataType::BigInt => 2,
10365 });
10366 out.extend_from_slice(&seq.start.to_le_bytes());
10367 out.extend_from_slice(&seq.increment.to_le_bytes());
10368 out.extend_from_slice(&seq.min_value.to_le_bytes());
10369 out.extend_from_slice(&seq.max_value.to_le_bytes());
10370 out.extend_from_slice(&seq.cache.to_le_bytes());
10371 out.push(u8::from(seq.cycle));
10372 match &seq.owned_by {
10373 None => out.push(0),
10374 Some((table, column)) => {
10375 out.push(1);
10376 write_str(&mut out, table);
10377 write_str(&mut out, column);
10378 }
10379 }
10380 out.extend_from_slice(&seq.last_value.to_le_bytes());
10381 out.push(u8::from(seq.is_called));
10382 }
10383 // v7.17.0 Phase 1.2 — VIEW catalog block (FILE_VERSION 27+).
10384 write_u32(
10385 &mut out,
10386 u32::try_from(self.views.len()).expect("≤ 4G views"),
10387 );
10388 for view in self.views.values() {
10389 write_str(&mut out, &view.name);
10390 write_u16(
10391 &mut out,
10392 u16::try_from(view.columns.len()).expect("≤ 65k cols / view"),
10393 );
10394 for c in &view.columns {
10395 write_str(&mut out, c);
10396 }
10397 write_str_long(&mut out, &view.body);
10398 // v7.39 (round 132, FILE_VERSION 69+) — WITH CHECK OPTION marker.
10399 out.push(view.check_option);
10400 }
10401 // v7.17.0 Phase 1.3 — MATERIALIZED VIEW source registry
10402 // (FILE_VERSION 28+). The backing rows live as a regular
10403 // table of the same name already in the tables block.
10404 write_u32(
10405 &mut out,
10406 u32::try_from(self.materialized_views.len()).expect("≤ 4G materialized views"),
10407 );
10408 for (name, body) in &self.materialized_views {
10409 write_str(&mut out, name);
10410 write_str_long(&mut out, body);
10411 }
10412 // v7.17.0 Phase 1.4 — ENUM types catalog block
10413 // (FILE_VERSION 29+).
10414 write_u32(
10415 &mut out,
10416 u32::try_from(self.enum_types.len()).expect("≤ 4G enum types"),
10417 );
10418 for e in self.enum_types.values() {
10419 write_str(&mut out, &e.name);
10420 write_u16(
10421 &mut out,
10422 u16::try_from(e.labels.len()).expect("≤ 65k labels / enum"),
10423 );
10424 for l in &e.labels {
10425 write_str(&mut out, l);
10426 }
10427 }
10428 // v7.17.0 Phase 1.5 — DOMAIN types catalog block
10429 // (FILE_VERSION 30+).
10430 write_u32(
10431 &mut out,
10432 u32::try_from(self.domain_types.len()).expect("≤ 4G domain types"),
10433 );
10434 for d in self.domain_types.values() {
10435 write_str(&mut out, &d.name);
10436 write_data_type(&mut out, d.base_type);
10437 out.push(u8::from(d.nullable));
10438 match &d.default {
10439 None => out.push(0),
10440 Some(s) => {
10441 out.push(1);
10442 write_str(&mut out, s);
10443 }
10444 }
10445 write_u16(
10446 &mut out,
10447 u16::try_from(d.checks.len()).expect("≤ 65k CHECKs / domain"),
10448 );
10449 for c in &d.checks {
10450 write_str(&mut out, &c.expr);
10451 // v7.39 (round 260) — the constraint name (FILE_VERSION 75+).
10452 write_str(&mut out, &c.name);
10453 }
10454 // v7.39 (round 259) — the parent domain (FILE_VERSION 74+).
10455 match &d.base_domain {
10456 None => out.push(0),
10457 Some(s) => {
10458 out.push(1);
10459 write_str(&mut out, s);
10460 }
10461 }
10462 }
10463 // v7.17.0 Phase 1.6 — user-schemas registry
10464 // (FILE_VERSION 31+). Built-ins are hardcoded in
10465 // `is_builtin_schema` and not persisted.
10466 write_u32(
10467 &mut out,
10468 u32::try_from(self.schemas.len()).expect("≤ 4G schemas"),
10469 );
10470 for name in &self.schemas {
10471 write_str(&mut out, name);
10472 }
10473 // v7.37.42-T2 ζ-B — COMPOSITE types catalog block
10474 // (FILE_VERSION 52+). Each entry: name, u16 field_count,
10475 // then field_count `[str field_name][data_type]` pairs.
10476 write_u32(
10477 &mut out,
10478 u32::try_from(self.composite_types.len()).expect("≤ 4G composite types"),
10479 );
10480 for c in self.composite_types.values() {
10481 write_str(&mut out, &c.name);
10482 write_u16(
10483 &mut out,
10484 u16::try_from(c.fields.len()).expect("≤ 65k fields / composite"),
10485 );
10486 for (i, (fname, fty)) in c.fields.iter().enumerate() {
10487 write_str(&mut out, fname);
10488 write_data_type(&mut out, *fty);
10489 // v7.39 (round 264) — the field's user type (v76+).
10490 match c.field_user_types.get(i).and_then(Option::as_ref) {
10491 None => out.push(0),
10492 Some(n) => {
10493 out.push(1);
10494 write_str(&mut out, n);
10495 }
10496 }
10497 }
10498 }
10499 // v7.39 (read01 round 50) — COMMENT store (FILE_VERSION 61+).
10500 // Catalog-wide, written last (before the CRC trailer) so every older
10501 // reader stops before it. Layout: [u32 count] then [str key][str text].
10502 write_u32(
10503 &mut out,
10504 u32::try_from(self.comments.len()).expect("≤ 4G comments"),
10505 );
10506 for (k, v) in &self.comments {
10507 write_str(&mut out, k);
10508 write_str_long(&mut out, v);
10509 }
10510 // v7.39 (read01 round 60) — non-table ACLs (FILE_VERSION 66+), catalog-
10511 // wide and written last so a v65 reader stops before them. The sequence
10512 // block itself sits mid-image and cannot grow without breaking older
10513 // readers, so a sequence's owner + ACL rides here, keyed by name.
10514 let acl_out = |out: &mut Vec<u8>, acl: &[AclItem]| {
10515 write_u16(out, u16::try_from(acl.len()).expect("≤ 65k aclitems"));
10516 for a in acl {
10517 write_str(out, &a.grantee);
10518 write_u16(out, a.privs);
10519 write_u16(out, a.grantable);
10520 write_str(out, &a.grantor);
10521 }
10522 };
10523 let owned: Vec<&SequenceDef> = self
10524 .sequences
10525 .values()
10526 .filter(|s| s.owner.is_some() || !s.acl.is_empty())
10527 .collect();
10528 write_u32(
10529 &mut out,
10530 u32::try_from(owned.len()).expect("≤ 4G sequences"),
10531 );
10532 for seq in owned {
10533 write_str(&mut out, &seq.name);
10534 match &seq.owner {
10535 Some(o) => {
10536 out.push(1);
10537 write_str(&mut out, o);
10538 }
10539 None => out.push(0),
10540 }
10541 acl_out(&mut out, &seq.acl);
10542 }
10543 acl_out(&mut out, &self.schema_acl);
10544 acl_out(&mut out, &self.database_acl);
10545 // v7.39 (read01 round 61) — FUNCTION owner + ACL (FILE_VERSION 67+).
10546 // The function block sits mid-image like the sequence one, so this
10547 // rides the catalog-wide tail too, keyed by name.
10548 let fns: Vec<&FunctionDef> = self
10549 .functions
10550 .values()
10551 .filter(|f| f.owner.is_some() || !f.acl.is_empty())
10552 .collect();
10553 write_u32(&mut out, u32::try_from(fns.len()).expect("≤ 4G functions"));
10554 for f in fns {
10555 // v7.39 (read01 round 62) — keyed by SIGNATURE now: two overloads
10556 // have two ACLs.
10557 write_str(&mut out, &function_signature_key(&f.name, &f.args_repr));
10558 match &f.owner {
10559 Some(o) => {
10560 out.push(1);
10561 write_str(&mut out, o);
10562 }
10563 None => out.push(0),
10564 }
10565 acl_out(&mut out, &f.acl);
10566 }
10567 // v7.39 (round 139) — RULE catalog block (FILE_VERSION 71+), catalog-
10568 // wide and written last (right before the CRC trailer) so every older
10569 // reader stops cleanly before it. Layout: [u32 count] then per rule
10570 // [str name][str table][str event][u8 instead][str when]
10571 // [u16 cmd_count]([str cmd] × cmd_count).
10572 write_u32(
10573 &mut out,
10574 u32::try_from(self.rules.len()).expect("≤ 4G rules"),
10575 );
10576 for r in &self.rules {
10577 write_str(&mut out, &r.name);
10578 write_str(&mut out, &r.table);
10579 write_str(&mut out, &r.event);
10580 out.push(u8::from(r.instead));
10581 write_str(&mut out, &r.when_condition);
10582 write_u16(
10583 &mut out,
10584 u16::try_from(r.commands.len()).expect("≤ 65k commands / rule"),
10585 );
10586 for c in &r.commands {
10587 write_str(&mut out, c);
10588 }
10589 }
10590 // v7.39 (round 280) — extended-statistics block (FILE_VERSION
10591 // 77+), appended after the RULE block for the same reason: an
10592 // older reader stops cleanly before it. Layout: [u32 count]
10593 // then per object [str name][str table][u16 n]([str kind] × n)
10594 // [u16 m]([str column] × m).
10595 write_u32(
10596 &mut out,
10597 u32::try_from(self.statistics_ext.len()).expect("≤ 4G statistics objects"),
10598 );
10599 for st in &self.statistics_ext {
10600 write_str(&mut out, &st.name);
10601 write_str(&mut out, &st.table);
10602 write_u16(
10603 &mut out,
10604 u16::try_from(st.kinds.len()).expect("≤ 65k kinds"),
10605 );
10606 for k in &st.kinds {
10607 write_str(&mut out, k);
10608 }
10609 write_u16(
10610 &mut out,
10611 u16::try_from(st.columns.len()).expect("≤ 65k columns"),
10612 );
10613 for c in &st.columns {
10614 write_str(&mut out, c);
10615 }
10616 }
10617 // v7.39 (round 287) — large-object block (FILE_VERSION 78+),
10618 // appended after the statistics block for the same reason: an
10619 // older reader stops cleanly before it. Layout: [u32 count]
10620 // then per object [u32 oid][u32 len][len bytes].
10621 write_u32(
10622 &mut out,
10623 u32::try_from(self.large_objects.len()).expect("≤ 4G large objects"),
10624 );
10625 for (oid, bytes) in &self.large_objects {
10626 write_u32(&mut out, *oid);
10627 write_u32(
10628 &mut out,
10629 u32::try_from(bytes.len()).expect("≤ 4G per object"),
10630 );
10631 out.extend_from_slice(bytes);
10632 }
10633 // v7.39 (round 322, V46) — function-attribute block (FILE_VERSION
10634 // 80+), appended last for the same reason as every block before
10635 // it: an older reader stops cleanly ahead of it and simply sees
10636 // functions with PG's default attributes. Only functions that
10637 // declared something non-default are written. Layout: [u32 count]
10638 // then per function [str signature_key][u8 volatility][u8 flags]
10639 // [u8 parallel][f64 cost or NaN][f64 rows or NaN], where flags bit
10640 // 0 = strict, 1 = security definer, 2 = leakproof.
10641 let attr_fns: Vec<(&String, &FunctionDef)> = self
10642 .functions
10643 .iter()
10644 .filter(|(_, f)| {
10645 f.volatility != FN_VOLATILE
10646 || f.strict
10647 || f.security_definer
10648 || f.leakproof
10649 || f.parallel != FN_PARALLEL_UNSAFE
10650 || f.cost.is_some()
10651 || f.rows.is_some()
10652 })
10653 .collect();
10654 write_u32(
10655 &mut out,
10656 u32::try_from(attr_fns.len()).expect("≤ 4G functions"),
10657 );
10658 for (key, f) in attr_fns {
10659 write_str(&mut out, key);
10660 out.push(f.volatility);
10661 let flags = u8::from(f.strict)
10662 | (u8::from(f.security_definer) << 1)
10663 | (u8::from(f.leakproof) << 2);
10664 out.push(flags);
10665 out.push(f.parallel);
10666 out.extend_from_slice(&f.cost.unwrap_or(f64::NAN).to_le_bytes());
10667 out.extend_from_slice(&f.rows.unwrap_or(f64::NAN).to_le_bytes());
10668 }
10669 // v7.38 (read01 P5.05) — CRC32C trailer over the whole image so a
10670 // corrupted snapshot is rejected on load. FILE_VERSION is >= the
10671 // trailer version, so this always runs for freshly-written images.
10672 // v7.39 (round 547) — pg_db_role_setting (FILE_VERSION 85+),
10673 // catalog-wide and written LAST so a v84 reader stops before it.
10674 // Layout: [u32 scopes] then [str database][str role][u32 params]
10675 // then [str name][str value] per param.
10676 write_u32(
10677 &mut out,
10678 u32::try_from(self.db_role_settings.len()).expect("≤ 4G scopes"),
10679 );
10680 for ((db, role), params) in &self.db_role_settings {
10681 write_str(&mut out, db);
10682 write_str(&mut out, role);
10683 write_u32(&mut out, u32::try_from(params.len()).expect("≤ 4G params"));
10684 for (name, value) in params {
10685 write_str(&mut out, name);
10686 write_str(&mut out, value);
10687 }
10688 }
10689 // v7.39 (round 550) — replication slots (FILE_VERSION 86+),
10690 // written LAST so a v85 reader stops before them.
10691 write_u32(
10692 &mut out,
10693 u32::try_from(self.replication_slots.len()).expect("≤ 4G slots"),
10694 );
10695 for (name, (plugin, slot_type)) in &self.replication_slots {
10696 write_str(&mut out, name);
10697 write_str(&mut out, plugin);
10698 write_str(&mut out, slot_type);
10699 }
10700 // v7.38.18 (S1) — the database collation (FILE_VERSION 92+).
10701 // Absent on an older image, which reads back as `C`.
10702 match &self.db_collation {
10703 None => out.push(0),
10704 Some(c) => {
10705 out.push(1);
10706 write_str(&mut out, c);
10707 }
10708 }
10709 let crc = spg_crypto::crc32c::crc32c(&out);
10710 write_u32(&mut out, crc);
10711 out
10712 }
10713
10714 /// Deserialize a previously-serialized catalog. Rejects bad magic, version
10715 /// mismatch, unknown tags, truncation, and trailing bytes.
10716 pub fn deserialize(buf: &[u8]) -> Result<Self, StorageError> {
10717 let mut cur = Cursor::new(buf);
10718 let magic = cur.take(8)?;
10719 if magic != FILE_MAGIC {
10720 return Err(StorageError::Corrupt(format!(
10721 "bad magic: expected SPGDB001, got {magic:?}"
10722 )));
10723 }
10724 let version = cur.read_u8()?;
10725 if !(MIN_SUPPORTED_FILE_VERSION..=FILE_VERSION).contains(&version) {
10726 return Err(StorageError::Corrupt(format!(
10727 "unsupported file version: {version} (supported: {MIN_SUPPORTED_FILE_VERSION}..={FILE_VERSION})"
10728 )));
10729 }
10730 // v7.23/v7.27 — escape decoding is version-gated (see
10731 // STR_LEN_ESCAPE / Cursor::codec_version).
10732 cur.codec_version = version;
10733 let table_count = cur.read_u32()? as usize;
10734 let mut cat = Self::new();
10735 for _ in 0..table_count {
10736 deserialize_table(&mut cur, &mut cat, version)?;
10737 }
10738 // v7.37.15 (Phase C.1) — stamp dense stable RelIds on load.
10739 // Pre-V6 envelopes carry no ids; a dense 1..=N assignment is
10740 // sufficient while RelId is process-local bookkeeping (the V6
10741 // envelope, Phase C.6, will round-trip real ids). Sets the
10742 // allocator above the loaded ids so a post-load CREATE TABLE
10743 // never collides.
10744 for (i, t) in cat.tables.iter_mut().enumerate() {
10745 t.set_rel_id(row_header::RelId((i as u64) + 1));
10746 }
10747 cat.next_rel_id = cat.tables.len() as u64;
10748 // v7.12.4 — catalog-wide function + trigger appendix.
10749 // FILE_VERSION 22+ only; v21 and earlier catalogs stop
10750 // after the last table.
10751 if version >= 22 {
10752 let fn_count = cur.read_u32()? as usize;
10753 for _ in 0..fn_count {
10754 let name = cur.read_str()?;
10755 let args_repr = cur.read_str()?;
10756 let returns = cur.read_str()?;
10757 let language = cur.read_str()?;
10758 let body = cur.read_str_long()?;
10759 let key = function_signature_key(&name, &args_repr);
10760 cat.functions.insert(
10761 key,
10762 FunctionDef {
10763 name,
10764 args_repr,
10765 returns,
10766 language,
10767 body,
10768 owner: None,
10769 acl: Vec::new(),
10770 volatility: FN_VOLATILE,
10771 strict: false,
10772 security_definer: false,
10773 leakproof: false,
10774 parallel: FN_PARALLEL_UNSAFE,
10775 cost: None,
10776 rows: None,
10777 },
10778 );
10779 }
10780 let trg_count = cur.read_u32()? as usize;
10781 for _ in 0..trg_count {
10782 let name = cur.read_str()?;
10783 let table = cur.read_str()?;
10784 let timing = cur.read_str()?;
10785 let ev_count = cur.read_u16()? as usize;
10786 let mut events = Vec::with_capacity(ev_count);
10787 for _ in 0..ev_count {
10788 events.push(cur.read_str()?);
10789 }
10790 let for_each = cur.read_str()?;
10791 let function = cur.read_str()?;
10792 // v7.13.0 — trailing `UPDATE OF cols` filter
10793 // (FILE_VERSION 23+ only; v22 catalogs omit and
10794 // deserialise with an empty vec).
10795 let update_columns = if version >= 23 {
10796 let n = cur.read_u16()? as usize;
10797 let mut cols = Vec::with_capacity(n);
10798 for _ in 0..n {
10799 cols.push(cur.read_str()?);
10800 }
10801 cols
10802 } else {
10803 Vec::new()
10804 };
10805 // v7.16.1 — TriggerDef.enabled (FILE_VERSION 25+).
10806 // v24-and-below catalogs deserialise with `true`
10807 // — pre-v7.16.1 every trigger always fired.
10808 let enabled = if version >= 25 {
10809 cur.read_u8()? != 0
10810 } else {
10811 true
10812 };
10813 // v7.39 (round 138) — WHEN condition text added at FILE_VERSION
10814 // 70; older catalogs read back empty (no WHEN filter).
10815 let when_condition = if version >= 70 {
10816 cur.read_str()?
10817 } else {
10818 String::new()
10819 };
10820 cat.triggers.push(TriggerDef {
10821 name,
10822 table,
10823 timing,
10824 events,
10825 for_each,
10826 function,
10827 update_columns,
10828 enabled,
10829 when_condition,
10830 });
10831 }
10832 }
10833 // v7.17.0 Phase 1.1 — SEQUENCE block (FILE_VERSION 26+).
10834 // v25-and-below catalogs omit; we leave the map empty.
10835 if version >= 26 {
10836 let seq_count = cur.read_u32()? as usize;
10837 for _ in 0..seq_count {
10838 let name = cur.read_str()?;
10839 let data_type = match cur.read_u8()? {
10840 0 => SequenceDataType::SmallInt,
10841 1 => SequenceDataType::Int,
10842 2 => SequenceDataType::BigInt,
10843 other => {
10844 return Err(StorageError::Corrupt(format!(
10845 "unknown SEQUENCE data-type tag {other}"
10846 )));
10847 }
10848 };
10849 let start = cur.read_i64()?;
10850 let increment = cur.read_i64()?;
10851 let min_value = cur.read_i64()?;
10852 let max_value = cur.read_i64()?;
10853 let cache = cur.read_i64()?;
10854 let cycle = cur.read_u8()? != 0;
10855 let owned_by = match cur.read_u8()? {
10856 0 => None,
10857 1 => {
10858 let t = cur.read_str()?;
10859 let c = cur.read_str()?;
10860 Some((t, c))
10861 }
10862 other => {
10863 return Err(StorageError::Corrupt(format!(
10864 "unknown SEQUENCE owned-by tag {other}"
10865 )));
10866 }
10867 };
10868 let last_value = cur.read_i64()?;
10869 let is_called = cur.read_u8()? != 0;
10870 cat.sequences.insert(
10871 name.clone(),
10872 SequenceDef {
10873 name,
10874 data_type,
10875 start,
10876 increment,
10877 min_value,
10878 max_value,
10879 cache,
10880 cycle,
10881 owned_by,
10882 last_value,
10883 is_called,
10884 owner: None,
10885 acl: Vec::new(),
10886 },
10887 );
10888 }
10889 }
10890 // v7.17.0 Phase 1.2 — VIEW block (FILE_VERSION 27+).
10891 // v26-and-below catalogs omit; we leave the map empty.
10892 if version >= 27 {
10893 let view_count = cur.read_u32()? as usize;
10894 for _ in 0..view_count {
10895 let name = cur.read_str()?;
10896 let col_count = cur.read_u16()? as usize;
10897 let mut columns = Vec::with_capacity(col_count);
10898 for _ in 0..col_count {
10899 columns.push(cur.read_str()?);
10900 }
10901 let body = cur.read_str_long()?;
10902 // v7.39 (round 132) — check-option marker added at FILE_VERSION
10903 // 69; older catalogs default to 0 (no check option).
10904 let check_option = if version >= 69 { cur.read_u8()? } else { 0 };
10905 cat.views.insert(
10906 name.clone(),
10907 ViewDef {
10908 name,
10909 columns,
10910 body,
10911 check_option,
10912 },
10913 );
10914 }
10915 }
10916 // v7.17.0 Phase 1.3 — MATERIALIZED VIEW source registry
10917 // (FILE_VERSION 28+). v27-and-below catalogs omit.
10918 if version >= 28 {
10919 let mv_count = cur.read_u32()? as usize;
10920 for _ in 0..mv_count {
10921 let name = cur.read_str()?;
10922 let body = cur.read_str_long()?;
10923 cat.materialized_views.insert(name, body);
10924 }
10925 }
10926 // v7.17.0 Phase 1.4 — ENUM types catalog block
10927 // (FILE_VERSION 29+).
10928 if version >= 29 {
10929 let etype_count = cur.read_u32()? as usize;
10930 for _ in 0..etype_count {
10931 let name = cur.read_str()?;
10932 let label_count = cur.read_u16()? as usize;
10933 let mut labels = Vec::with_capacity(label_count);
10934 for _ in 0..label_count {
10935 labels.push(cur.read_str()?);
10936 }
10937 cat.enum_types
10938 .insert(name.clone(), EnumDef { name, labels });
10939 }
10940 }
10941 // v7.17.0 Phase 1.5 — DOMAIN types catalog block
10942 // (FILE_VERSION 30+).
10943 if version >= 30 {
10944 let dtype_count = cur.read_u32()? as usize;
10945 for _ in 0..dtype_count {
10946 let name = cur.read_str()?;
10947 let base_type = cur.read_data_type()?;
10948 let nullable = cur.read_u8()? != 0;
10949 let default = match cur.read_u8()? {
10950 0 => None,
10951 1 => Some(cur.read_str()?),
10952 other => {
10953 return Err(StorageError::Corrupt(format!(
10954 "unknown DOMAIN default tag {other}"
10955 )));
10956 }
10957 };
10958 let check_count = cur.read_u16()? as usize;
10959 let mut checks: Vec<DomainCheck> = Vec::with_capacity(check_count);
10960 for i in 0..check_count {
10961 let expr = cur.read_str()?;
10962 // v7.39 (round 260) — names arrived in FILE_VERSION 75.
10963 // An older catalog gets PG's auto-naming applied to the
10964 // checks it stored, which is what they would have been.
10965 let cname = if version >= 75 {
10966 cur.read_str()?
10967 } else if i == 0 {
10968 alloc::format!("{name}_check")
10969 } else {
10970 alloc::format!("{name}_check{i}")
10971 };
10972 checks.push(DomainCheck { name: cname, expr });
10973 }
10974 // v7.39 (round 259) — the parent domain. Absent before
10975 // FILE_VERSION 74; an older catalog reads as a domain over
10976 // a scalar, which is what it was.
10977 let base_domain = if version >= 74 {
10978 match cur.read_u8()? {
10979 0 => None,
10980 1 => Some(cur.read_str()?),
10981 other => {
10982 return Err(StorageError::Corrupt(alloc::format!(
10983 "domain base_domain tag {other}"
10984 )));
10985 }
10986 }
10987 } else {
10988 None
10989 };
10990 cat.domain_types.insert(
10991 name.clone(),
10992 DomainDef {
10993 name,
10994 base_type,
10995 nullable,
10996 default,
10997 checks,
10998 base_domain,
10999 },
11000 );
11001 }
11002 }
11003 // v7.17.0 Phase 1.6 — user-schemas registry
11004 // (FILE_VERSION 31+).
11005 if version >= 31 {
11006 let sch_count = cur.read_u32()? as usize;
11007 for _ in 0..sch_count {
11008 let name = cur.read_str()?;
11009 cat.schemas.insert(name);
11010 }
11011 }
11012 // v7.37.42-T2 ζ-B — COMPOSITE types catalog block
11013 // (FILE_VERSION 52+). v51-and-below readers stop at the
11014 // user-schemas block; v52 readers fed a v51 catalog see no
11015 // composite block and default to an empty map.
11016 if version >= 52 {
11017 let ctype_count = cur.read_u32()? as usize;
11018 for _ in 0..ctype_count {
11019 let name = cur.read_str()?;
11020 let field_count = cur.read_u16()? as usize;
11021 let mut fields = Vec::with_capacity(field_count);
11022 let mut field_user_types: Vec<Option<String>> = Vec::with_capacity(field_count);
11023 for _ in 0..field_count {
11024 let fname = cur.read_str()?;
11025 let fty = cur.read_data_type()?;
11026 // v7.39 (round 264) — present from FILE_VERSION 76.
11027 let ut = if version >= 76 {
11028 match cur.read_u8()? {
11029 0 => None,
11030 1 => Some(cur.read_str()?),
11031 other => {
11032 return Err(StorageError::Corrupt(alloc::format!(
11033 "composite field user-type tag {other}"
11034 )));
11035 }
11036 }
11037 } else {
11038 None
11039 };
11040 fields.push((fname, fty));
11041 field_user_types.push(ut);
11042 }
11043 cat.composite_types.insert(
11044 name.clone(),
11045 CompositeDef {
11046 name,
11047 fields,
11048 field_user_types,
11049 },
11050 );
11051 }
11052 }
11053 // v7.39 (read01 round 50) — COMMENT store (FILE_VERSION 61+).
11054 if version >= 61 {
11055 let comment_count = cur.read_u32()? as usize;
11056 for _ in 0..comment_count {
11057 let key = cur.read_str()?;
11058 let text = cur.read_str_long()?;
11059 cat.comments.insert(key, text);
11060 }
11061 }
11062 // v7.39 (read01 round 60) — non-table ACLs (FILE_VERSION 66+).
11063 if version >= 66 {
11064 let read_acl = |cur: &mut Cursor| -> Result<Vec<AclItem>, StorageError> {
11065 let n = cur.read_u16()? as usize;
11066 let mut acl = Vec::with_capacity(n);
11067 for _ in 0..n {
11068 let grantee = cur.read_str()?;
11069 let privs = cur.read_u16()?;
11070 let grantable = cur.read_u16()?;
11071 let grantor = cur.read_str()?;
11072 acl.push(AclItem {
11073 grantee,
11074 privs,
11075 grantable,
11076 grantor,
11077 });
11078 }
11079 Ok(acl)
11080 };
11081 let seq_count = cur.read_u32()? as usize;
11082 for _ in 0..seq_count {
11083 let name = cur.read_str()?;
11084 let owner = if cur.read_u8()? == 1 {
11085 Some(cur.read_str()?)
11086 } else {
11087 None
11088 };
11089 let acl = read_acl(&mut cur)?;
11090 if let Some(seq) = cat.sequences.get_mut(&name) {
11091 seq.owner = owner;
11092 seq.acl = acl;
11093 }
11094 }
11095 cat.schema_acl = read_acl(&mut cur)?;
11096 cat.database_acl = read_acl(&mut cur)?;
11097 // v7.39 (read01 round 61) — FUNCTION owner + ACL (v67+; keyed by
11098 // signature from v68, when overloads became possible).
11099 if version >= 67 {
11100 let fn_count = cur.read_u32()? as usize;
11101 for _ in 0..fn_count {
11102 let name = cur.read_str()?;
11103 let owner = if cur.read_u8()? == 1 {
11104 Some(cur.read_str()?)
11105 } else {
11106 None
11107 };
11108 let acl = read_acl(&mut cur)?;
11109 // v7.39 (round 315, V19) — the stored key was computed
11110 // by whichever formula was current when the image was
11111 // written. A miss is not "no such function": before the
11112 // multi-word fix, `f(double precision)` keyed as
11113 // `f(precision)`, so an older image's grants would land
11114 // nowhere and vanish silently. Fall back to matching by
11115 // the old formula, which re-attaches them.
11116 let target = resolve_stored_function_key(&cat.functions, &name);
11117 if let Some(k) = target
11118 && let Some(f) = cat.functions.get_mut(&k)
11119 {
11120 f.owner = owner;
11121 f.acl = acl;
11122 }
11123 }
11124 }
11125 }
11126 // v7.39 (round 139) — RULE catalog block (FILE_VERSION 71+), read from
11127 // the tail right before the CRC trailer. Pre-71 images stop before it.
11128 if version >= 71 {
11129 let rule_count = cur.read_u32()? as usize;
11130 for _ in 0..rule_count {
11131 let name = cur.read_str()?;
11132 let table = cur.read_str()?;
11133 let event = cur.read_str()?;
11134 let instead = cur.read_u8()? != 0;
11135 let when_condition = cur.read_str()?;
11136 let cmd_count = cur.read_u16()? as usize;
11137 let mut commands = Vec::with_capacity(cmd_count);
11138 for _ in 0..cmd_count {
11139 commands.push(cur.read_str()?);
11140 }
11141 cat.rules.push(RuleDef {
11142 name,
11143 table,
11144 event,
11145 instead,
11146 when_condition,
11147 commands,
11148 });
11149 }
11150 }
11151 // v7.39 (round 280) — extended-statistics block (FILE_VERSION
11152 // 77+). Pre-77 images stop before it.
11153 if version >= 77 {
11154 let count = cur.read_u32()? as usize;
11155 for _ in 0..count {
11156 let name = cur.read_str()?;
11157 let table = cur.read_str()?;
11158 let nk = cur.read_u16()? as usize;
11159 let mut kinds = Vec::with_capacity(nk);
11160 for _ in 0..nk {
11161 kinds.push(cur.read_str()?);
11162 }
11163 let nc = cur.read_u16()? as usize;
11164 let mut columns = Vec::with_capacity(nc);
11165 for _ in 0..nc {
11166 columns.push(cur.read_str()?);
11167 }
11168 cat.statistics_ext.push(StatisticsExtDef {
11169 name,
11170 table,
11171 kinds,
11172 columns,
11173 });
11174 }
11175 }
11176 // v7.39 (round 287) — large-object block (FILE_VERSION 78+).
11177 // Pre-78 images stop before it.
11178 if version >= 78 {
11179 let count = cur.read_u32()? as usize;
11180 for _ in 0..count {
11181 let oid = cur.read_u32()?;
11182 let len = cur.read_u32()? as usize;
11183 let bytes = cur.read_bytes(len)?;
11184 cat.large_objects.insert(oid, bytes);
11185 }
11186 }
11187 // v7.39 (round 322, V46) — function-attribute block (FILE_VERSION
11188 // 80+). Pre-80 images stop before it and keep PG's defaults.
11189 if version >= 80 {
11190 let count = cur.read_u32()? as usize;
11191 for _ in 0..count {
11192 let key = cur.read_str()?;
11193 let volatility = cur.read_u8()?;
11194 let flags = cur.read_u8()?;
11195 let parallel = cur.read_u8()?;
11196 let cost = f64::from_le_bytes(cur.read_bytes(8)?.try_into().unwrap_or([0; 8]));
11197 let rows = f64::from_le_bytes(cur.read_bytes(8)?.try_into().unwrap_or([0; 8]));
11198 if let Some(f) = cat.functions.get_mut(&key) {
11199 f.volatility = volatility;
11200 f.strict = flags & 1 != 0;
11201 f.security_definer = flags & 2 != 0;
11202 f.leakproof = flags & 4 != 0;
11203 f.parallel = parallel;
11204 f.cost = (!cost.is_nan()).then_some(cost);
11205 f.rows = (!rows.is_nan()).then_some(rows);
11206 }
11207 }
11208 }
11209 // v7.39 (round 547) — pg_db_role_setting (FILE_VERSION 85+).
11210 // Pre-85 images stop before it and carry no GUC defaults.
11211 if version >= 85 {
11212 let scopes = cur.read_u32()? as usize;
11213 for _ in 0..scopes {
11214 let db = cur.read_str()?;
11215 let role = cur.read_str()?;
11216 let params = cur.read_u32()? as usize;
11217 let mut m: BTreeMap<String, String> = BTreeMap::new();
11218 for _ in 0..params {
11219 let name = cur.read_str()?;
11220 let value = cur.read_str()?;
11221 m.insert(name, value);
11222 }
11223 if !m.is_empty() {
11224 cat.db_role_settings.insert((db, role), m);
11225 }
11226 }
11227 }
11228 // v7.39 (round 550) — replication slots (FILE_VERSION 86+).
11229 if version >= 86 {
11230 let count = cur.read_u32()? as usize;
11231 for _ in 0..count {
11232 let name = cur.read_str()?;
11233 let plugin = cur.read_str()?;
11234 let slot_type = cur.read_str()?;
11235 cat.replication_slots.insert(name, (plugin, slot_type));
11236 }
11237 }
11238 // v7.38.18 (S1) — the database collation (FILE_VERSION 92+).
11239 if version >= 92 {
11240 match cur.read_u8()? {
11241 0 => {}
11242 1 => cat.db_collation = Some(cur.read_str()?),
11243 other => {
11244 return Err(StorageError::Corrupt(format!(
11245 "db_collation tag: unknown byte {other}"
11246 )));
11247 }
11248 }
11249 }
11250 // v7.38.18 (S3) — a database created under a collation this
11251 // build cannot perform does not open.
11252 //
11253 // Falling back to bytes would answer with a different comparator
11254 // than every index key in it was built under, which is the one
11255 // failure this whole layer exists to prevent — and it would do
11256 // it silently, since a byte-ordered answer looks exactly like a
11257 // correct one. The check is a NAME classification here; the
11258 // engine, which owns the collator, verifies it can actually
11259 // perform the name before recording it.
11260 if let Some(c) = &cat.db_collation
11261 && c.trim().is_empty()
11262 {
11263 return Err(StorageError::Corrupt(format!(
11264 "database collation is recorded as {c:?}, which names nothing"
11265 )));
11266 }
11267 // v7.38.18 (S2) — and every table read back learns it, because a
11268 // table decides for itself which of its indexes key under a
11269 // collation. Done here rather than per-table in the loop above
11270 // because the byte that says so is written after the tables.
11271 let db_coll = cat.db_collation().to_string();
11272 for t in &mut cat.tables {
11273 t.set_db_collation(&db_coll);
11274 }
11275 // v7.38 (read01 P5.05) — v54+ images end with a CRC32C over every
11276 // preceding byte; verify it before accepting the snapshot. Older
11277 // images have no trailer and fall through to the trailing-byte check.
11278 if version >= FILE_VERSION_CRC_TRAILER {
11279 let crc_start = cur.pos;
11280 let stored = cur.read_u32()?;
11281 let computed = spg_crypto::crc32c::crc32c(&buf[..crc_start]);
11282 if computed != stored {
11283 return Err(StorageError::Corrupt(format!(
11284 "base snapshot CRC mismatch: computed {computed:#010x}, stored {stored:#010x}"
11285 )));
11286 }
11287 }
11288 if cur.pos < buf.len() {
11289 return Err(StorageError::Corrupt(format!(
11290 "trailing bytes: {} unread",
11291 buf.len() - cur.pos
11292 )));
11293 }
11294 Ok(cat)
11295 }
11296}
11297
11298#[cfg(test)]
11299mod tests;