spg_storage/lib.rs
1//! In-memory storage primitives.
2//!
3//! v0.3 is intentionally simple: a flat catalog of tables, each holding rows
4//! as `Vec<Value>` (positional, matching the table's `TableSchema`). No MVCC,
5//! no on-disk format — those land in later milestones.
6#![no_std]
7// v3.3.2 NEON path for l2_distance_sq (aarch64 only). Scoped allow:
8// `unsafe_code = "deny"` at workspace level stays in force for every
9// other crate.
10#![cfg_attr(target_arch = "aarch64", allow(unsafe_code))]
11
12extern crate alloc;
13
14pub mod bignum;
15pub mod bloom;
16mod codec;
17pub mod fts_simple;
18pub mod halfvec;
19pub mod jsonb_gin;
20mod nsw;
21pub mod persistent;
22pub mod persistent_btree;
23pub mod posting;
24pub mod quantize;
25pub mod row_header;
26pub mod row_locator;
27pub mod segment;
28pub mod snapshot;
29mod table;
30pub mod trgm;
31pub mod vacuum;
32
33pub use self::bloom::{BloomError, BloomFilter};
34// v7.31 monster tier-3 cut 3 — on-disk codec moved to `codec`; the
35// public dense-row surface keeps its `spg_storage::*` paths, and the
36// low-level write/read primitives stay crate-visible for the
37// `Catalog::serialize`/`deserialize` methods that remain in this file.
38pub(crate) use self::codec::*;
39pub use self::codec::{
40 decode_row_body_dense, decode_row_body_dense_pruned, encode_row_body_dense,
41 encode_row_body_dense_into, encode_row_body_dense_masked_into, row_body_encoded_len,
42};
43// v7.31 monster tier-3 cut 2 — HNSW algorithms moved to `nsw`; the
44// public vector-search surface keeps its `spg_storage::*` paths via
45// these re-exports, and `nsw_insert_at` stays crate-visible for the
46// `Table` insert paths in the `table` module.
47pub(crate) use self::nsw::nsw_insert_at;
48pub use self::nsw::{NswMetric, cosine_dot_norms_f32, inner_product_f32, nsw_index_on, nsw_query};
49pub use self::posting::PostingList;
50
51/// The list handed back for an absent key, so callers cannot tell an
52/// absent key from an empty posting list — the property the old
53/// `&[][..]` return had, kept.
54static EMPTY_POSTINGS: crate::posting::PostingList = crate::posting::PostingList::new();
55pub use self::row_locator::{RowLocator, RowLocatorError};
56pub use self::segment::{
57 BRIN_SIDECAR_MAGIC, BrinSummary, OwnedSegment, SEGMENT_COMPRESS_ALGO_LZSS,
58 SEGMENT_COMPRESS_ALGO_NONE, SEGMENT_MAGIC, SEGMENT_MAGIC_V2, SEGMENT_PAGE_BYTES, SegmentError,
59 SegmentMeta, SegmentReader, derive_brin_summaries, encode_segment, wrap_v2_envelope,
60 wrap_v2_envelope_with_brin,
61};
62
63use alloc::borrow::Cow;
64use alloc::boxed::Box;
65use alloc::collections::{BTreeMap, BTreeSet};
66use alloc::format;
67use alloc::string::{String, ToString};
68use alloc::sync::Arc;
69use alloc::vec::Vec;
70use core::fmt;
71
72use self::persistent::PersistentVec;
73use self::persistent_btree::PersistentBTreeMap;
74
75/// In-cell encoding for `DataType::Vector`. Mirrors
76/// `spg_sql::ast::VecEncoding` — kept here so storage stays
77/// dep-free of `spg-sql`. The engine bridges between the two
78/// at DDL-execution time.
79///
80/// `F32` is the pre-v6 default: each cell holds a raw `Vec<f32>`.
81/// `Sq8` (v6.0.1) stores `Sq8Vector { min, max, bytes: Vec<u8> }`
82/// per cell; 4× compression vs `F32` with recall@10 ≥ 0.95 on
83/// natural embeddings (Gaussian / unit-sphere corpora).
84/// `F16` (v6.0.3, DDL keyword `HALF`) stores each element as
85/// IEEE-754 binary16; 2× compression and bit-exact dequantise.
86#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
87pub enum VecEncoding {
88 #[default]
89 F32,
90 Sq8,
91 F16,
92}
93
94impl fmt::Display for VecEncoding {
95 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
96 match self {
97 Self::F32 => f.write_str("F32"),
98 Self::Sq8 => f.write_str("SQ8"),
99 Self::F16 => f.write_str("HALF"),
100 }
101 }
102}
103
104/// Runtime type tags. `Vector { dim, encoding }` / `Varchar(max)` /
105/// `Char(size)` are parameterised; the parameter travels with both
106/// the column schema and the on-wire serialised representation.
107#[derive(Debug, Clone, Copy, PartialEq, Eq)]
108pub enum DataType {
109 /// 16-bit signed. Backed by `Value::SmallInt(i16)`; arithmetic that
110 /// would overflow surfaces as a type error at INSERT time.
111 SmallInt,
112 Int, // 32-bit signed
113 BigInt, // 64-bit signed
114 Float, // f64 (PG double precision)
115 /// v7.38 (read01, T-float4) — `real` / `float4`: 32-bit IEEE float (PG
116 /// `real`). Backed by `Value::Real(f32)`; behaves like `Float` for most
117 /// dispatch but renders / stores at f32 precision.
118 Real,
119 Text,
120 /// `VARCHAR(n)` — same byte representation as `Text`, but INSERT
121 /// rejects values longer than `n` Unicode characters.
122 Varchar(u32),
123 /// `CHAR(n)` — same representation as `Text`, but INSERT right-pads
124 /// with U+0020 to exactly `n` Unicode characters (or rejects when
125 /// the input is already longer).
126 Char(u32),
127 Bool,
128 /// pgvector-style fixed-dimension vector. `encoding` selects
129 /// the in-cell representation (`F32` = pre-v6 raw f32 buffer;
130 /// `Sq8` = v6.0.1 8-bit scalar-quantised). The DDL grammar
131 /// surfaces encoding via the optional `USING <encoding>`
132 /// clause: `VECTOR(128) USING SQ8`.
133 Vector {
134 dim: u32,
135 encoding: VecEncoding,
136 },
137 /// `NUMERIC(precision, scale)` — exact fixed-point decimal stored as
138 /// a scaled `i128`. `precision` caps total decimal digits, `scale`
139 /// fixes digits after the decimal point. v1.12 supports up to
140 /// precision 38 (the i128-safe ceiling). `NUMERIC` and `NUMERIC(p)`
141 /// surface as `Numeric { precision: p, scale: 0 }`.
142 Numeric {
143 /// v7.39 (round 272) — widened from u8. PG's declared precision
144 /// runs to 1000; at u8 it could not even be spelled, and the
145 /// parser rejected anything past 38 (i128's width) outright.
146 precision: u16,
147 /// v7.39 (round 271) — widened alongside the value's scale.
148 /// v7.39 (round 273) — and signed: PG's DECLARED scale runs
149 /// -1000..=1000, where a negative one rounds to tens / hundreds.
150 /// A VALUE's display scale is always non-negative.
151 scale: i16,
152 },
153 /// `DATE` — calendar date with day precision, stored as `i32` days
154 /// since the Unix epoch (1970-01-01).
155 Date,
156 /// `TIMESTAMP` (a.k.a. `MySQL` `DATETIME`) — instant with microsecond
157 /// precision, stored as `i64` microseconds since the Unix epoch.
158 Timestamp,
159 /// v7.9.2 `TIMESTAMPTZ` — bit-identical to `Timestamp` on disk
160 /// (i64 microseconds, UTC by convention). Carried as a distinct
161 /// type tag so the PG-wire layer can advertise OID 1184 (PG's
162 /// `timestamp with time zone`) and `sqlx`/`pgx`/JDBC clients
163 /// decode into their TZ-aware datetime types. The internal
164 /// semantics are unchanged: SPG never stored per-row offsets,
165 /// and neither did PG — `TIMESTAMPTZ` in PG is also UTC i64.
166 Timestamptz,
167 /// v7.39 (round 291) — PG's `name`: the type its catalogs use for
168 /// identifiers. Text truncated to NAMEDATALEN-1 (63) bytes, with
169 /// its own type identity — `pg_typeof('abc'::name)` is `name`, and
170 /// `CREATE TABLE t (a name)` is legal SQL that SPG rejected.
171 Name,
172 /// v7.39 (round 640) — PG's `xid`: a transaction id. [`Value::Xid`]
173 /// has existed since round 512, so a `'5'::xid` literal already knew
174 /// what it was; this is the DECLARED half, which nothing had. Without
175 /// it `pg_typeof(NULL::xid)` answered `bigint`, `pg_type` could not
176 /// list oid 28 — leaving the 48 `pg_attribute` rows that describe
177 /// `xmin` / `xmax` pointing at a type no catalog carried — and
178 /// `CREATE TABLE t (a xid)` was refused as an unknown type.
179 ///
180 /// On disk it is the 8-byte body its BIGINT sibling writes, and it
181 /// reads back as a `Value::Xid`, so a stored column and a literal are
182 /// the same thing to everything downstream.
183 ///
184 /// What is NOT yet true of the identity: PG gives `xid` equality and
185 /// hashing and no ordering operator at all, so `min` / `max` /
186 /// `count(DISTINCT …)` / `<=` all error there and all answer here.
187 /// Measured, not assumed — and left for the operator surface rather
188 /// than claimed by this comment.
189 Xid,
190 /// v7.39 (round 640) — PG's `xid8`: the same transaction id, 64 bits
191 /// wide and monotonic. Unlike [`DataType::Xid`] it has no value of
192 /// its own; a cell is a `Value::BigInt` and only the declared type
193 /// witnesses it. That is enough for `pg_typeof`, the catalogs and
194 /// the wire OID, and not enough to refuse a bigint where PG refuses
195 /// one. `pg_current_xact_id()` returns this type on PG.
196 Xid8,
197 /// v7.39 (round 667) — PG's `oid`: an unsigned 32-bit object
198 /// identifier. Modelled exactly like [`DataType::Xid8`] above: it has
199 /// no value of its own, a cell is a `Value::BigInt`, and only the
200 /// declared type witnesses it.
201 ///
202 /// That deliberately buys less than a full value type. What it buys:
203 /// `CREATE TABLE t(o OID)` is accepted (it was rejected outright with
204 /// `type "oid" does not exist`, while the neighbouring `XID` worked),
205 /// `pg_typeof` answers `oid` rather than `bigint`, and the catalogs
206 /// report their own key columns honestly. What it does NOT buy is
207 /// refusing a bigint where PG refuses an oid — `sum(oid)` and
208 /// `avg(oid)` still answer here and error on PG, because at runtime
209 /// the cell is indistinguishable from a bigint. Round 664 tried to
210 /// close those two by name and withdrew: a guard keyed on the name
211 /// would have caught `sum(bigint)` with it.
212 ///
213 /// The cast itself was already right before this — `4294967296::oid`
214 /// and `'abc'::oid` produce PG's errors word for word, and `(-1)::oid`
215 /// wraps to 4294967295 as PG does. Only the resulting type was lost,
216 /// because `conversions.rs` mapped the target to `BigInt`.
217 Oid,
218 /// `INTERVAL` — calendar-aware span (months + microseconds). v2.11
219 /// supports INTERVAL only as a runtime intermediate (literals,
220 /// arithmetic results); on-disk encoding is rejected so this branch
221 /// can't appear in a `ColumnSchema`.
222 Interval,
223 /// v4.9: `JSON` — text-backed JSON document. We don't parse
224 /// the content (no path operators or jsonb functions yet) —
225 /// the column accepts any TEXT-compatible value and round-trips
226 /// it verbatim. PG OID 114 on the wire.
227 Json,
228 /// v7.9.0: `JSONB` — semantically identical to `Json` on
229 /// the storage side (same `Value::Json` cells, same
230 /// row codec), but advertised as PG OID 3802 on the wire
231 /// so `sqlx`-style clients that bind `jsonb` columns
232 /// decode correctly. mailrs migration blocker #3.
233 Jsonb,
234 /// v7.10.4: `BYTES` / `BYTEA` — variable-length raw binary.
235 /// Backed by `Value::Bytes(Vec<u8>)`. PG wire OID 17. Literal
236 /// forms accepted by parser/engine: PG hex form `'\xDEADBEEF'`
237 /// (case-insensitive hex pairs) and escape form
238 /// `'foo\\000bar'` (the latter decoded at coercion time when
239 /// the target column is BYTEA — TEXT columns leave the
240 /// backslash sequence verbatim).
241 Bytes,
242 /// v7.10.9: `TEXT[]` — single-dimension TEXT array. Elements
243 /// may be NULL (PG semantics). PG wire OID 1009. Literal
244 /// forms: `ARRAY['a', 'b', NULL]` and the PG external form
245 /// `'{a,b,NULL}'::TEXT[]`. Engine implements `= ANY(arr)`,
246 /// `<> ALL(arr)`, and 1-based indexing `arr[i]`. Catalog
247 /// FILE_VERSION 18+; older snapshots reject this DataType
248 /// (forward-only by design — TEXT[] columns aren't readable
249 /// on a pre-v7.10 binary).
250 TextArray,
251 /// v7.11.12: `INT[]` — single-dimension i32 array. PG wire
252 /// OID 1007 (_int4). Same `ARRAY[...]` / `'{1,2,3}'::INT[]`
253 /// literal surface as TEXT[]. Catalog FILE_VERSION 19+.
254 IntArray,
255 /// v7.11.12: `BIGINT[]` — single-dimension i64 array. PG
256 /// wire OID 1016 (_int8). Catalog FILE_VERSION 19+.
257 BigIntArray,
258 /// v7.39 (round 694) — `oid[]`. It exists for the reason
259 /// [`DataType::Oid`] does: mapping it onto `BigIntArray` answers
260 /// `pg_typeof('{1,2}'::oid[])` with `bigint[]`, which is the defect
261 /// round 667 closed for the scalar.
262 OidArray,
263 /// v7.37.5 β-P4 — `INTERVAL[]` — single-dimension array of
264 /// `IntervalSpan { months, days, micros }`. PG wire OID 1187
265 /// (`_interval`). Catalog tag 35 + per-cell body
266 /// `[u16 count][per elem: u8 null + (if non-null) 16-byte
267 /// interval body in LE PG-byte-equal field order]`.
268 /// FILE_VERSION 48+.
269 IntervalArray,
270 /// v7.37.5 γ — full PG array-of-scalar family. Catalog tags
271 /// 36..48; wire OIDs from PG `pg_type.dat`. Per-element body
272 /// uses the scalar's existing `write_value_body` shape.
273 /// FILE_VERSION 48+ (same window as β; no separate bump).
274 BoolArray, // PG `_bool` OID 1000, tag 36
275 SmallIntArray, // PG `_int2` OID 1005, tag 37
276 FloatArray, // PG `_float8` OID 1022, tag 38
277 NumericArray, // PG `_numeric` OID 1231, tag 39
278 DateArray, // PG `_date` OID 1182, tag 40
279 TimestampArray, // PG `_timestamp` OID 1115, tag 41
280 TimestamptzArray, // PG `_timestamptz` OID 1185, tag 42
281 UuidArray, // PG `_uuid` OID 2951, tag 43
282 JsonArray, // PG `_json` OID 199, tag 44
283 JsonbArray, // PG `_jsonb` OID 3807, tag 45
284 BytesArray, // PG `_bytea` OID 1001, tag 46
285 VarcharArray, // PG `_varchar` OID 1015, tag 47
286 CharArray, // PG `_bpchar` OID 1014, tag 48
287 /// v7.37.5 δ — PG 14+ multirange types. A multirange is an
288 /// ordered collection of non-overlapping ranges of the same
289 /// element kind (e.g. `int4multirange(int4range(1,5),
290 /// int4range(10,15))` → `{[1,5),[10,15)}`). The same DataType
291 /// variant covers all six builtin multiranges; `RangeKind`
292 /// pins the element type so encode/decode/display can route
293 /// off one switch (parallel to `Range(RangeKind)`).
294 /// Wire OIDs: int4multirange=4451, int8multirange=4537,
295 /// nummultirange=4536, tsmultirange=4533, tstzmultirange=4534,
296 /// datemultirange=4535. Catalog tag 49 + 1-byte RangeKind on
297 /// the dense type-tag side. FILE_VERSION 48+ (same window as
298 /// β/γ, no separate bump).
299 Multirange(RangeKind),
300 /// v7.37.5 ε — PG geometry scalar family. Mirrors PG's seven
301 /// builtin geometric types one-for-one. Body shapes (LE):
302 /// Point = 16 B fixed (f64 x + f64 y) OID 600
303 /// Lseg = 32 B fixed (Point p1 + Point p2) OID 601
304 /// Path = varlena ([u8 closed][u32 n][Point*n]) OID 602
305 /// Box = 32 B fixed (Point ur + Point ll) OID 603
306 /// Polygon = varlena ([u32 n][Point*n]) OID 604
307 /// Line = 24 B fixed (f64 a + f64 b + f64 c) OID 628
308 /// Circle = 24 B fixed (Point center + f64 r) OID 718
309 /// Catalog tags 50..56. FILE_VERSION 48+ (same window as β/γ/δ;
310 /// no separate bump). Geometric operators (`<->` / `@>` / `&&`
311 /// / `<<` / `>>` / `~=`) are a planner-integration follow-up,
312 /// parallel to the Range operator defer in e2e_pg_range.rs.
313 Point,
314 Lseg,
315 Path,
316 PgBox,
317 Polygon,
318 Line,
319 Circle,
320 /// v7.37.5 ζ-A — PG network address family. Body shapes (LE):
321 /// Inet = 18 B fixed (u8 family + u8 bits + 16 B addr) OID 869
322 /// Cidr = 18 B fixed (same shape as Inet; CIDR rejects
323 /// host bits at parse / coerce) OID 650
324 /// Macaddr = 6 B fixed OID 829
325 /// Macaddr8 = 8 B fixed (EUI-64) OID 774
326 /// Catalog tags 57-60. FILE_VERSION 48+. `family = 4` is IPv4
327 /// (uses the first 4 bytes of the 16-B addr slot, rest 0);
328 /// `family = 6` is IPv6 (full 16 B).
329 Inet,
330 Cidr,
331 Macaddr,
332 Macaddr8,
333 /// v7.39 (read01 pg_lsn.c) — PG `pg_lsn` (WAL location). 8 bytes,
334 /// rendered `%X/%X`. Catalog tag 66. OID 3220.
335 PgLsn,
336 /// v7.37.5 ζ-A — PG bit string. Body = `[u32 nbits][ceil(nbits/8) bytes]`,
337 /// big-endian within each byte (matches PG binary).
338 /// Bit OID 1560 (fixed-length, but SPG carries the
339 /// length per cell — column declaration
340 /// `BIT(n)` constrains at coerce time)
341 /// BitVarying OID 1562 (variable-length, declared as `VARBIT`)
342 /// Catalog tags 61-62.
343 /// v7.39 (round 281) — `BIT(n)`: a FIXED-length bit string. `0`
344 /// means the type was written without a typmod, which PG treats as
345 /// `bit(1)`. Column assignment requires the length to match
346 /// exactly; an explicit cast pads or truncates instead.
347 Bit(u32),
348 /// v7.39 (round 281) — `BIT VARYING(n)`: `n` is a MAXIMUM, and `0`
349 /// means unbounded (`varbit` with no typmod).
350 BitVarying(u32),
351 /// v7.37.5 ζ-A — PG `xml`. Body identical to TEXT (storage is
352 /// the verbatim XML string; no parse-time validation). Only
353 /// the wire OID (142) differs. Catalog tag 63.
354 Xml,
355 /// v7.37.5 ζ-A — PG `"char"` (the internal single-byte type,
356 /// distinct from `CHAR(n)` / `BPCHAR`). Body = 1 byte raw.
357 /// OID 18. Catalog tag 64.
358 Char1,
359 /// v7.37.5 ζ-A — `MONEY[]`. Body = `[u16 count][per elem: u8 null
360 /// + (non-null) i64 LE cents]`. OID 791. Catalog tag 65.
361 MoneyArray,
362 /// v7.12.0: PG `tsvector` — ordered, deduplicated set of
363 /// `(lexeme, positions, weight)` tuples. PG wire OID 3614.
364 /// Catalog FILE_VERSION 20+. Storage shape is row-codec
365 /// tag 22; the schema-agnostic `write_value` path emits tag
366 /// 18. Literal: `'foo:1 bar:2,3'::tsvector` (PG external
367 /// form). G-CRIT-3 entry — v7.12.0 only ships the type +
368 /// codec; matching `@@` lands in v7.12.2.
369 TsVector,
370 /// v7.12.0: PG `tsquery` — parse tree of lexemes joined by
371 /// `&` `|` `!` and phrase operators. PG wire OID 3615.
372 /// Catalog FILE_VERSION 20+.
373 TsQuery,
374 /// v7.17.0: PG `uuid` — 128-bit identifier stored as
375 /// `Value::Uuid([u8; 16])`. PG wire OID 2950. Canonical
376 /// text form is lowercase 8-4-4-4-12 hyphenated; input
377 /// also accepts uppercase, unhyphenated, and brace-wrapped
378 /// forms (`{xxxx…}`). Catalog FILE_VERSION 36+; tag 24 on
379 /// the dense type-tag side, tag 20 on the schema-agnostic
380 /// value side. The drop-in PG/MySQL surface for Django /
381 /// Rails / Hibernate "id UUID PRIMARY KEY DEFAULT
382 /// gen_random_uuid()" default-PK pattern.
383 Uuid,
384 /// v7.17.0 Phase 3.P0-32: PG `time` (without time zone) — i64
385 /// microseconds since 00:00:00. PG wire OID 1083. Display:
386 /// canonical zero-padded `HH:MM:SS` when fractional is zero,
387 /// `HH:MM:SS.ffffff` otherwise. Catalog FILE_VERSION 37+;
388 /// tag 25 on the dense type-tag side, tag 21 on the schema-
389 /// agnostic value side. The wall-clock-of-day half of PG's
390 /// date/time triplet (date / time / timestamp).
391 Time,
392 /// v7.17.0 Phase 3.P0-33: MySQL `YEAR` — u16 in range
393 /// 1901..=2155 plus the special zero-year sentinel 0. No
394 /// dedicated PG OID (advertised as INT4 / OID 23 on the wire
395 /// — psql renders integers, MySQL CLI renders 4-digit
396 /// zero-padded text). Display always 4 digits: `0000` for the
397 /// zero-year, `1985` / `2007` / etc otherwise. Catalog
398 /// FILE_VERSION 38+; tag 26 on the dense type-tag side, tag
399 /// 22 on the schema-agnostic value side.
400 Year,
401 /// v7.17.0 Phase 3.P0-34: PG `time with time zone` (TIMETZ) —
402 /// i64 microseconds since 00:00:00 in the local wall clock
403 /// PLUS i32 offset-from-UTC in seconds. PG wire OID 1266.
404 /// Display: `HH:MM:SS[.ffffff]±HH[:MM]` (PG `timetz_out`).
405 /// Range: offset in ±50400 seconds (±14 hours). Catalog
406 /// FILE_VERSION 39+; tag 27 on the dense type-tag side, tag
407 /// 23 on the schema-agnostic value side.
408 TimeTz,
409 /// v7.17.0 Phase 3.P0-35: PG `money` — i64 cents (locale-
410 /// independent storage). PG wire OID 790. Display: en_US
411 /// locale (`$N,NNN.CC`, negative → `-$1.23`). Input accepts
412 /// `$N.NN`, `$N,NNN.NN`, bare integer (treated as major
413 /// units), optional leading `-`. Range: full i64. Catalog
414 /// FILE_VERSION 40+; tag 28 on the dense type-tag side, tag
415 /// 24 on the schema-agnostic value side.
416 Money,
417 /// v7.17.0 Phase 3.P0-38: PG range type. The same DataType
418 /// variant covers all six builtin ranges (int4range,
419 /// int8range, numrange, tsrange, tstzrange, daterange) —
420 /// `RangeKind` pins the element type so encode / decode /
421 /// display can route off one switch. Catalog FILE_VERSION
422 /// 43+; tag 29 + a 1-byte RangeKind on the dense type-tag
423 /// side, tag 25 on the schema-agnostic value side.
424 Range(RangeKind),
425 /// v7.17.0 Phase 3.P0-39: PG `hstore` extension type — flat
426 /// `text => text` map with NULL value support. Catalog
427 /// FILE_VERSION 44+; tag 30 on the dense type-tag side, tag
428 /// 26 on the schema-agnostic value side. The contrib OID is
429 /// installation-dependent in real PG; SPG advertises it via
430 /// dynamic lookup, falling back to TEXT (OID 25) on the wire
431 /// when the installed `hstore` extension hasn't claimed an
432 /// OID yet.
433 Hstore,
434 /// v7.17.0 Phase 3.P0-40: PG `int[][]` — 2-dimensional INT
435 /// matrix. Storage: row-major Vec<Vec<Option<i32>>>. All
436 /// rows must share the same column count. Wire OID 1007
437 /// (same as INT[]; the dimension count travels in the data
438 /// header, not the OID). Catalog FILE_VERSION 45+; tag 31
439 /// on the dense type-tag side, tag 27 on the schema-agnostic
440 /// value side.
441 IntArray2D,
442 /// v7.17.0 Phase 3.P0-40: PG `bigint[][]` — 2-dimensional
443 /// BIGINT matrix. Storage / OID / tags mirror IntArray2D.
444 /// Tag 32 dense, tag 28 schema-agnostic.
445 BigIntArray2D,
446 /// v7.17.0 Phase 3.P0-40: PG `text[][]` — 2-dimensional TEXT
447 /// matrix. Storage: row-major Vec<Vec<Option<String>>>.
448 /// Tag 33 dense, tag 29 schema-agnostic.
449 TextArray2D,
450 /// v7.39 (read01 round 75) — `bool[][]`. BOOL is the ONE element type whose
451 /// ARRAY rendering differs from its scalar one (`t` vs `true`), so a
452 /// text-backed 2-D cannot be PG-faithful for it: rendering the whole array
453 /// wants `t`, and subscripting a cell to text wants `false`. Every other
454 /// element type renders the same either way, which is why this is the only
455 /// typed 2-D variant SPG needs.
456 BoolArray2D,
457}
458
459/// v7.17.0 Phase 3.P0-38 — pins the element type of a range value
460/// or column. Wire OIDs: Int4=3904, Int8=3926, Num=3906,
461/// Ts=3908, TsTz=3910, Date=3912.
462#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
463pub enum RangeKind {
464 Int4,
465 Int8,
466 Num,
467 Ts,
468 TsTz,
469 Date,
470}
471
472impl RangeKind {
473 pub const fn tag(self) -> u8 {
474 match self {
475 Self::Int4 => 0,
476 Self::Int8 => 1,
477 Self::Num => 2,
478 Self::Ts => 3,
479 Self::TsTz => 4,
480 Self::Date => 5,
481 }
482 }
483 pub const fn from_tag(t: u8) -> Option<Self> {
484 Some(match t {
485 0 => Self::Int4,
486 1 => Self::Int8,
487 2 => Self::Num,
488 3 => Self::Ts,
489 4 => Self::TsTz,
490 5 => Self::Date,
491 _ => return None,
492 })
493 }
494 pub const fn keyword(self) -> &'static str {
495 match self {
496 Self::Int4 => "INT4RANGE",
497 Self::Int8 => "INT8RANGE",
498 Self::Num => "NUMRANGE",
499 Self::Ts => "TSRANGE",
500 Self::TsTz => "TSTZRANGE",
501 Self::Date => "DATERANGE",
502 }
503 }
504}
505
506impl fmt::Display for DataType {
507 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
508 match self {
509 Self::SmallInt => f.write_str("SMALLINT"),
510 Self::Int => f.write_str("INT"),
511 Self::BigInt => f.write_str("BIGINT"),
512 Self::Xid => f.write_str("XID"),
513 Self::Xid8 => f.write_str("XID8"),
514 Self::Oid => f.write_str("OID"),
515 Self::OidArray => f.write_str("OID[]"),
516 Self::Float => f.write_str("FLOAT"),
517 Self::Real => f.write_str("REAL"),
518 Self::Text => f.write_str("TEXT"),
519 Self::Varchar(n) => write!(f, "VARCHAR({n})"),
520 Self::Char(n) => write!(f, "CHAR({n})"),
521 Self::Bool => f.write_str("BOOL"),
522 Self::Vector { dim, encoding } => match encoding {
523 VecEncoding::F32 => write!(f, "VECTOR({dim})"),
524 VecEncoding::Sq8 => write!(f, "VECTOR({dim}) USING SQ8"),
525 VecEncoding::F16 => write!(f, "VECTOR({dim}) USING HALF"),
526 },
527 Self::Numeric { precision, scale } => {
528 if *scale == 0 {
529 write!(f, "NUMERIC({precision})")
530 } else {
531 write!(f, "NUMERIC({precision}, {scale})")
532 }
533 }
534 Self::Date => f.write_str("DATE"),
535 Self::Timestamp => f.write_str("TIMESTAMP"),
536 Self::Timestamptz => f.write_str("TIMESTAMPTZ"),
537 Self::Name => f.write_str("NAME"),
538 Self::Interval => f.write_str("INTERVAL"),
539 Self::Json => f.write_str("JSON"),
540 Self::Jsonb => f.write_str("JSONB"),
541 Self::Bytes => f.write_str("BYTEA"),
542 Self::TextArray => f.write_str("TEXT[]"),
543 Self::IntArray => f.write_str("INT[]"),
544 Self::BigIntArray => f.write_str("BIGINT[]"),
545 Self::IntervalArray => f.write_str("INTERVAL[]"),
546 Self::BoolArray => f.write_str("BOOL[]"),
547 Self::SmallIntArray => f.write_str("SMALLINT[]"),
548 Self::FloatArray => f.write_str("FLOAT[]"),
549 Self::NumericArray => f.write_str("NUMERIC[]"),
550 Self::DateArray => f.write_str("DATE[]"),
551 Self::TimestampArray => f.write_str("TIMESTAMP[]"),
552 Self::TimestamptzArray => f.write_str("TIMESTAMPTZ[]"),
553 Self::UuidArray => f.write_str("UUID[]"),
554 Self::JsonArray => f.write_str("JSON[]"),
555 Self::JsonbArray => f.write_str("JSONB[]"),
556 Self::BytesArray => f.write_str("BYTEA[]"),
557 Self::VarcharArray => f.write_str("VARCHAR[]"),
558 Self::CharArray => f.write_str("CHAR[]"),
559 Self::Multirange(k) => f.write_str(match k {
560 RangeKind::Int4 => "INT4MULTIRANGE",
561 RangeKind::Int8 => "INT8MULTIRANGE",
562 RangeKind::Num => "NUMMULTIRANGE",
563 RangeKind::Ts => "TSMULTIRANGE",
564 RangeKind::TsTz => "TSTZMULTIRANGE",
565 RangeKind::Date => "DATEMULTIRANGE",
566 }),
567 Self::Point => f.write_str("POINT"),
568 Self::Lseg => f.write_str("LSEG"),
569 Self::Path => f.write_str("PATH"),
570 Self::PgBox => f.write_str("BOX"),
571 Self::Polygon => f.write_str("POLYGON"),
572 Self::Line => f.write_str("LINE"),
573 Self::Circle => f.write_str("CIRCLE"),
574 Self::Inet => f.write_str("INET"),
575 Self::Cidr => f.write_str("CIDR"),
576 Self::Macaddr => f.write_str("MACADDR"),
577 Self::Macaddr8 => f.write_str("MACADDR8"),
578 Self::PgLsn => f.write_str("PG_LSN"),
579 Self::Bit(0) => f.write_str("BIT"),
580 Self::Bit(n) => write!(f, "BIT({n})"),
581 Self::BitVarying(0) => f.write_str("VARBIT"),
582 Self::BitVarying(n) => write!(f, "VARBIT({n})"),
583 Self::Xml => f.write_str("XML"),
584 Self::Char1 => f.write_str("\"char\""),
585 Self::MoneyArray => f.write_str("MONEY[]"),
586 Self::TsVector => f.write_str("TSVECTOR"),
587 Self::TsQuery => f.write_str("TSQUERY"),
588 Self::Uuid => f.write_str("UUID"),
589 Self::Time => f.write_str("TIME"),
590 Self::Year => f.write_str("YEAR"),
591 Self::TimeTz => f.write_str("TIMETZ"),
592 Self::Money => f.write_str("MONEY"),
593 Self::Range(k) => f.write_str(k.keyword()),
594 Self::Hstore => f.write_str("HSTORE"),
595 Self::IntArray2D => f.write_str("INT[][]"),
596 Self::BigIntArray2D => f.write_str("BIGINT[][]"),
597 Self::TextArray2D => f.write_str("TEXT[][]"),
598 Self::BoolArray2D => f.write_str("BOOL[][]"),
599 }
600 }
601}
602
603/// v7.12.0 — one entry in a `Value::TsVector`. The lexeme is the
604/// (already-tokenised + stemmed in v7.12.1+) word; `positions` is
605/// a strictly-ascending list of 1-based positions; `weight` is the
606/// PG weight letter (A=3, B=2, C=1, D=0) — v7.12.0 defaults every
607/// lexeme to D, the v7.12.2 ranking path consumes the weight.
608#[derive(Debug, Clone, PartialEq, Eq)]
609pub struct TsLexeme {
610 pub word: String,
611 pub positions: Vec<u16>,
612 pub weight: u8,
613}
614
615/// v7.12.0 — parse tree for a PG `tsquery`. v7.12.0 ships the
616/// type + codec only; the `to_tsquery` / `plainto_tsquery` lexer
617/// lands in v7.12.1 and the `@@` evaluator in v7.12.2.
618#[derive(Debug, Clone, PartialEq, Eq)]
619pub enum TsQueryAst {
620 /// Single lexeme term. The `weight_mask` is the PG-style
621 /// bitmask of accepted weights (`A=1<<3`, `B=1<<2`, `C=1<<1`,
622 /// `D=1<<0`); `0` = any weight. v7.12.0 always sets it to 0.
623 Term {
624 word: String,
625 weight_mask: u8,
626 },
627 And(Box<TsQueryAst>, Box<TsQueryAst>),
628 Or(Box<TsQueryAst>, Box<TsQueryAst>),
629 Not(Box<TsQueryAst>),
630 /// `phrase <distance> phrase`. v7.12.0 only persists this; the
631 /// match semantics arrive in v7.12.2 alongside `@@`.
632 Phrase {
633 left: Box<TsQueryAst>,
634 right: Box<TsQueryAst>,
635 distance: u16,
636 },
637}
638
639/// A row-cell value, including SQL `NULL`. `Float` uses `f64`; NaN compares
640/// non-equal to itself (PG behaviour) — `PartialEq` is derived so callers
641/// must opt into NaN-aware comparison if they need stronger guarantees.
642///
643/// v7.37.42-arena Phase 1: parameterised on `'arena` so heap-bearing
644/// variants (Text/Json/Xml/Bytes/Vector/BitString.bytes) can borrow from
645/// a per-query bump arena (`Cow::Borrowed(&'arena ...)`). Persistent /
646/// catalog Values use `Value<'static>` (alias `ValueOwned`) with
647/// `Cow::Owned(...)`. Phase 1 keeps Range/Multirange recursive `Box<Value>`
648/// at `'static` (owned) — arena migration deferred to a later phase.
649/// Array-of-Option<String> variants (TextArray etc.) also stay owned in
650/// Phase 1; their nested shape is awkward for the simple Cow lift and the
651/// SCALARSQ hot path doesn't touch them.
652/// v7.38 (read01, T6) — the IEEE-style class of a NUMERIC value. `Finite` is the
653/// ordinary fixed-point case; the specials mirror PG's `'NaN'` / `'Infinity'` /
654/// `'-Infinity'`. Derived `PartialEq` gives `NaN == NaN` — correct for NUMERIC
655/// (unlike float's NaN ≠ NaN); the total order (`-Inf < finite < +Inf < NaN`)
656/// lives in the comparison paths, not in `Ord`.
657#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Hash)]
658pub enum NumericKind {
659 #[default]
660 Finite,
661 NaN,
662 PosInf,
663 NegInf,
664}
665
666#[derive(Debug, Clone, PartialEq)]
667#[non_exhaustive]
668pub enum Value<'arena> {
669 SmallInt(i16),
670 Int(i32),
671 BigInt(i64),
672 Float(f64),
673 /// v7.38 (read01, T-float4) — PG `real` (32-bit IEEE float).
674 Real(f32),
675 Text(Cow<'arena, str>),
676 Bool(bool),
677 Vector(Cow<'arena, [f32]>),
678 /// v6.0.1: 8-bit scalar-quantised vector cell. Lives in
679 /// columns declared `VECTOR(N) USING SQ8`. Layout per cell:
680 /// `Sq8Vector { min: f32, max: f32, bytes: Vec<u8> }` —
681 /// 4× compression vs `Vector(Vec<f32>)`. The wire layer
682 /// dequantises to `f32` on SELECT; INSERT path quantises
683 /// incoming `Vector(Vec<f32>)` cells into this variant.
684 Sq8Vector(crate::quantize::Sq8Vector),
685 /// v6.0.3: IEEE-754 binary16 vector cell. Lives in columns
686 /// declared `VECTOR(N) USING HALF`. Stores raw u16 LE bits
687 /// (2× compression vs `Vector(Vec<f32>)`). Wire / display
688 /// paths dequantise to f32 bit-exactly; INSERT path converts
689 /// incoming f32 vectors at the engine boundary.
690 HalfVector(crate::halfvec::HalfVector),
691 /// Exact fixed-point decimal. `scaled` holds the value as
692 /// `actual * 10^scale` so the storage type is always integral —
693 /// arithmetic never falls back to floating-point. v7.38 (read01, T6) —
694 /// `kind` classifies the value as finite (the common case, using
695 /// `scaled`/`scale`) or one of PG's NUMERIC specials (NaN / ±Infinity),
696 /// which ignore `scaled`/`scale` (canonicalized to 0).
697 Numeric {
698 scaled: i128,
699 /// v7.39 (round 271) — widened from u8. PG's numeric carries a
700 /// display scale up to 16383; at u8 a literal with 256 decimal
701 /// places could not be represented at all, and the conversion
702 /// aborted the query with an internal error.
703 scale: u16,
704 kind: NumericKind,
705 },
706 /// v7.38 (read01, T3) — an exact NUMERIC whose mantissa overflows `i128`
707 /// (PG's NUMERIC is unbounded). Boxed so the common finite case keeps its
708 /// small footprint; specials never take this form (they stay `Numeric`).
709 NumericBig(alloc::boxed::Box<crate::bignum::BigNumeric>),
710 /// Days since the Unix epoch (1970-01-01). Negative for earlier dates.
711 Date(i32),
712 /// Microseconds since the Unix epoch (1970-01-01T00:00:00Z).
713 Timestamp(i64),
714 /// Calendar span: `months` + `days` + `micros`. Three fields are
715 /// required for PG byte-equal: `'1 day'` ≠ `'24 hours'` (DST,
716 /// month-boundary, and the on-wire `pg_type` `interval` are all
717 /// `i64 micros + i32 days + i32 months`). v7.37.5 β widened from
718 /// `{months, micros}`; column storage lands in the same window.
719 Interval {
720 months: i32,
721 days: i32,
722 micros: i64,
723 },
724 /// v4.9 `JSON` — raw JSON text. No structural validation
725 /// happens at the storage layer; whatever the parser hands us
726 /// round-trips verbatim. Equality is byte-wise.
727 Json(Cow<'arena, str>),
728 /// v7.10.4 `BYTEA` — raw binary blob. Equality is byte-wise.
729 /// Layout matches `Text`'s length-prefixed shape (`[u32 LE
730 /// len][bytes]`) under tag 18; the engine accepts PG hex
731 /// literals (`'\xDEADBEEF'`) and escape literals at the
732 /// coercion boundary.
733 Bytes(Cow<'arena, [u8]>),
734 /// v7.10.9 `TEXT[]` — single-dimension TEXT array with
735 /// optional NULL elements. Equality is element-wise. PG's
736 /// NULL-element comparison semantics: NULL ≠ NULL inside
737 /// arrays under `=`, so `[NULL] != [NULL]` (the engine
738 /// honours this).
739 TextArray(Vec<Option<String>>),
740 /// v7.11.12 `INT[]` — single-dimension i32 array with optional
741 /// NULL elements. Codec mirrors TextArray with i32 LE per
742 /// element instead of length-prefixed UTF-8.
743 IntArray(Vec<Option<i32>>),
744 /// v7.11.12 `BIGINT[]` — single-dimension i64 array with optional
745 /// NULL elements.
746 BigIntArray(Vec<Option<i64>>),
747 /// v7.37.5 β-P4 `INTERVAL[]` — single-dimension array of
748 /// `IntervalSpan { months, days, micros }` with optional NULL
749 /// elements. PG external form quotes each non-NULL element
750 /// (`{"1 day","24:00:00",NULL}`) because interval text contains
751 /// spaces and colons. Storage codec follows the BigIntArray
752 /// shape with a 16-byte per-element body.
753 IntervalArray(Vec<Option<IntervalSpan>>),
754 /// v7.37.5 γ — single-dimension arrays of the remaining PG
755 /// scalar types. Each carries `Vec<Option<T>>` with the
756 /// scalar's natural Rust shape; element NULLs are first-class
757 /// (per PG: `{1,NULL,3}` is a 3-element array, not a 2-element
758 /// one). Codec follows the IntervalArray shape — `[u16 count]
759 /// [per elem: u8 null + (non-null) scalar body]`.
760 BoolArray(Vec<Option<bool>>),
761 SmallIntArray(Vec<Option<i16>>),
762 FloatArray(Vec<Option<f64>>),
763 /// PG `NUMERIC[]` — `(scaled: i128, scale: u16)` per element.
764 NumericArray(Vec<Option<(i128, u16)>>),
765 DateArray(Vec<Option<i32>>),
766 TimestampArray(Vec<Option<i64>>),
767 TimestamptzArray(Vec<Option<i64>>),
768 UuidArray(Vec<Option<[u8; 16]>>),
769 JsonArray(Vec<Option<String>>),
770 JsonbArray(Vec<Option<String>>),
771 BytesArray(Vec<Option<Vec<u8>>>),
772 VarcharArray(Vec<Option<String>>),
773 CharArray(Vec<Option<String>>),
774 /// v7.37.5 δ — PG 14+ multirange. `ranges` is a Vec of
775 /// non-overlapping bounds spans of the shared `kind`. PG's
776 /// canonical text form is `{[a,b),[c,d),...}` (comma-separated
777 /// ranges in braces; `{}` for the empty multirange). SPG's
778 /// constructor enforces no overlap/coalescing — for now the
779 /// engine trusts the caller (mirrors PG's `_construct_array`
780 /// pattern). Catalog tag 49 + 1-byte RangeKind on the dense
781 /// type-tag side; schema-less path is unreachable (multirange
782 /// is column-typed only).
783 Multirange {
784 kind: RangeKind,
785 ranges: Vec<RangeSpan>,
786 },
787 /// v7.37.5 ε — PG geometry scalars. Per-type Vec/struct shape;
788 /// codec body shape is described on the matching DataType
789 /// variant. PG canonical text forms:
790 /// Point `(x,y)`
791 /// Lseg `[(x1,y1),(x2,y2)]`
792 /// Path open `[(x,y),(x,y),...]` / closed `((x,y),(x,y),...)`
793 /// Box `(ux,uy),(lx,ly)` (PG normalises to upper-right + lower-left)
794 /// Polygon `((x,y),(x,y),...)` (implicit closed)
795 /// Line `{a,b,c}` (Ax + By + C = 0)
796 /// Circle `<(x,y),r>`
797 Point(Point2D),
798 Lseg(Point2D, Point2D),
799 /// `closed = true` is `((p,p,...))`; `false` is `[(p,p,...)]`.
800 Path {
801 points: Vec<Point2D>,
802 closed: bool,
803 },
804 /// PG `box` — stored as `(upper_right, lower_left)` (PG's
805 /// normalised order). The engine accepts both endpoint
806 /// orderings at parse time and normalises here.
807 PgBox(Point2D, Point2D),
808 Polygon(Vec<Point2D>),
809 Line {
810 a: f64,
811 b: f64,
812 c: f64,
813 },
814 Circle {
815 center: Point2D,
816 radius: f64,
817 },
818 /// v7.37.5 ζ-A — PG `inet`. `family = 4` (IPv4) or `6` (IPv6).
819 /// `bits` is the netmask bit count (0..=32 for IPv4, 0..=128
820 /// for IPv6). `addr` is right-padded with zeros when family=4
821 /// (first 4 bytes are the address).
822 Inet {
823 family: u8,
824 bits: u8,
825 addr: [u8; 16],
826 },
827 /// v7.37.5 ζ-A — PG `cidr`. Same shape as Inet; CIDR's
828 /// invariant (host bits zero) is enforced at parse / coerce.
829 Cidr {
830 family: u8,
831 bits: u8,
832 addr: [u8; 16],
833 },
834 /// v7.37.5 ζ-A — PG `macaddr`. 6 bytes (XX:XX:XX:XX:XX:XX).
835 Macaddr([u8; 6]),
836 /// v7.37.5 ζ-A — PG `macaddr8`. 8 bytes (EUI-64).
837 Macaddr8([u8; 8]),
838 /// v7.39 (read01 pg_lsn.c) — PG `pg_lsn`, a 64-bit WAL location.
839 PgLsn(u64),
840 /// v7.39 (read01 ruleutils.c) — PG `regclass`: an OID-typed relation
841 /// reference that renders as the relation name. SPG carries BOTH
842 /// (the synthetic oid for catalog joins, the name for display) so
843 /// `conrelid = 't'::regclass` and `'t'::regclass::text` agree.
844 /// Eval-only (no column storage).
845 RegClass(i64, alloc::boxed::Box<str>),
846 /// v7.39 (round 342, V65) — PG `regproc`: an OID-typed FUNCTION
847 /// reference that renders as the function name. Same dual shape
848 /// [`Value::RegClass`] carries, and for the same reason: without the
849 /// oid half, `pg_proc.oid = 'f'::regproc` cannot join, and a callee
850 /// cannot tell `pg_get_functiondef('f'::regproc)` — which PG answers
851 /// — from `pg_get_functiondef('f')` — which PG rejects.
852 /// Eval-only (no column storage).
853 RegProc(i64, alloc::boxed::Box<str>),
854 /// v7.39 (round 648) — PG `regtype`: an OID-typed TYPE reference
855 /// that renders as the type name. The third of the shape
856 /// [`Value::RegClass`] and [`Value::RegProc`] carry, and the one
857 /// that was missing it: `::regtype` produced a plain `Value::Text`
858 /// holding the canonical name, so `'text'::regtype::oid` tried to
859 /// parse the NAME as a number and answered `invalid input syntax
860 /// for type oid: "text"` where PG answers 25. `pg_typeof` on one
861 /// said `text` rather than `regtype` for the same reason.
862 ///
863 /// Eval-only (no column storage).
864 RegType(i64, alloc::boxed::Box<str>),
865 /// v7.39 (round 512) — PG `xid` and `cid`, the transaction and command
866 /// ids the `xmin` / `xmax` / `cmin` / `cmax` system columns carry.
867 ///
868 /// Their own types rather than integers, because PG deliberately gives
869 /// them almost no operators: measured on PG18, `xmin + 1` is "operator
870 /// does not exist: xid + integer", `xmin > 0` likewise, `xmin::bigint`
871 /// is "cannot cast type xid to bigint", and there is no `max(xid)`.
872 /// Carrying them as BigInt would quietly allow all four.
873 ///
874 /// Eval-only (no column storage).
875 Xid(u32),
876 Cid(u32),
877 /// v7.39 (round 511) — PG `tid`, the physical row identity `ctid`
878 /// carries: a block number and a one-based offset inside it, rendered
879 /// `(block,offset)`.
880 ///
881 /// It is a real type rather than a two-field record because the idiom
882 /// that makes `ctid` worth having — `DELETE … WHERE ctid NOT IN (SELECT
883 /// min(ctid) … GROUP BY key)` — needs `min()` over it, and PG has no
884 /// `min(record)`. Ordering is by block then offset, so `(0,2) < (0,9) <
885 /// (0,10)`; a text form would order those `(0,10) < (0,2) < (0,9)` and
886 /// the dedup would keep the wrong row.
887 ///
888 /// Eval-only (no column storage).
889 Tid(u32, u32),
890 /// v7.37.5 ζ-A — PG `bit` / `bit varying`. `nbits` is the
891 /// actual bit count; `bytes` is the packed representation
892 /// (big-endian within each byte; final byte right-padded
893 /// with 0s if `nbits % 8 != 0`).
894 BitString {
895 nbits: u32,
896 bytes: Cow<'arena, [u8]>,
897 },
898 /// v7.37.5 ζ-A — PG `xml`. Stored verbatim as a string; no
899 /// parse-time validation (matches the SPG JSON convention).
900 Xml(Cow<'arena, str>),
901 /// v7.37.5 ζ-A — PG `"char"` (internal single-byte type,
902 /// distinct from CHAR(n)).
903 Char1(u8),
904 /// v7.38 (read01, T11) — PG `bpchar` / CHAR(n): blank-padded fixed-length
905 /// string. Stored space-padded to the declared width (as PG does + for wire
906 /// display); length / comparison / ::text / concat all ignore the trailing
907 /// blanks (handled at those sites).
908 BpChar(Cow<'arena, str>),
909 /// v7.37.5 ζ-A — PG `money[]`.
910 MoneyArray(Vec<Option<i64>>),
911 /// v7.12.0 `tsvector` — sorted-by-word, deduped lexeme set with
912 /// positions + weights. The engine enforces sort/dedup on
913 /// construction; consumers can rely on `lexemes.windows(2)`
914 /// being strictly ascending by `word`.
915 TsVector(Vec<TsLexeme>),
916 /// v7.12.0 `tsquery` — boolean / phrase parse tree over
917 /// lexemes. Engine builds via `to_tsquery` family.
918 TsQuery(TsQueryAst),
919 /// v7.17.0 `uuid` — 128-bit identifier. Stored as 16 bytes
920 /// (big-endian / network-byte order, same as RFC 4122).
921 /// Display normalises to canonical lowercase 8-4-4-4-12
922 /// hyphenated form. Equality is byte-wise.
923 Uuid([u8; 16]),
924 /// v7.17.0 Phase 3.P0-32 — PG `time` (without time zone) —
925 /// i64 microseconds since 00:00:00. Range 0..86_400_000_000.
926 /// Display: `HH:MM:SS` zero-padded, with optional `.ffffff`
927 /// suffix when fractional is non-zero.
928 Time(i64),
929 /// v7.17.0 Phase 3.P0-33 — MySQL `YEAR` — u16 in range
930 /// 1901..=2155 plus the special zero-year sentinel 0.
931 /// Display always 4 digits zero-padded (`0000` for the
932 /// sentinel; `1985`/`2007` otherwise).
933 Year(u16),
934 /// v7.17.0 Phase 3.P0-34 — PG `time with time zone` — i64
935 /// microseconds since 00:00:00 in the LOCAL wall clock PLUS
936 /// an i32 offset-from-UTC in seconds. PG preserves the
937 /// offset on output, so the wall-clock value is NOT shifted
938 /// to UTC at storage time. Offset range: ±50400 seconds
939 /// (±14 hours).
940 TimeTz {
941 us: i64,
942 offset_secs: i32,
943 },
944 /// v7.17.0 Phase 3.P0-35 — PG `money` — i64 cents
945 /// (locale-independent storage; the en_US locale renders on
946 /// display via `$N,NNN.CC`).
947 Money(i64),
948 /// v7.17.0 Phase 3.P0-39 — PG `hstore` value: flat
949 /// `text => text` map with NULL value support. Insertion
950 /// order preserved on input; duplicate keys take last-write-
951 /// wins at parse time.
952 Hstore(Vec<(String, Option<String>)>),
953 /// v7.17.0 Phase 3.P0-40 — 2D INT matrix (row-major).
954 IntArray2D(Vec<Vec<Option<i32>>>),
955 /// v7.17.0 Phase 3.P0-40 — 2D BIGINT matrix (row-major).
956 BigIntArray2D(Vec<Vec<Option<i64>>>),
957 /// v7.17.0 Phase 3.P0-40 — 2D TEXT matrix (row-major).
958 TextArray2D(Vec<Vec<Option<String>>>),
959 /// v7.39 (read01 round 75) — see `DataType::BoolArray2D`.
960 BoolArray2D(Vec<Vec<Option<bool>>>),
961 /// v7.17.0 Phase 3.P0-38 — PG range value. One shape covers
962 /// all six builtin range types; `kind` pins the element type
963 /// (must match the column's `DataType::Range(kind)`).
964 /// `lower` / `upper` are `None` for the unbounded sides;
965 /// `lower_inc` / `upper_inc` mirror the canonical PG
966 /// `[` / `(` / `]` / `)` bracket inclusivity. `empty=true`
967 /// supersedes all other fields (the empty range has no
968 /// bounds).
969 Range {
970 kind: RangeKind,
971 // v7.37.42-arena Phase 1: Range bounds stay owned ('static).
972 // Recursive arena lifetimes are awkward to migrate at this
973 // phase and the SCALARSQ hot path doesn't construct ranges.
974 lower: Option<alloc::boxed::Box<Value<'static>>>,
975 upper: Option<alloc::boxed::Box<Value<'static>>>,
976 lower_inc: bool,
977 upper_inc: bool,
978 empty: bool,
979 },
980 /// v7.38 (read01, T9) — a composite / record value (a `row(...)`
981 /// constructor or a whole-row reference). Fields are `(name, value)`; the
982 /// names are `f1..fN` for an anonymous `row(...)` or the source column
983 /// names for a table row. Transient — flows through row_to_json / to_json
984 /// and the composite text form `(a,b)`; not a storable column type here.
985 Composite(alloc::vec::Vec<(alloc::string::String, Value<'static>)>),
986 Null,
987}
988
989/// Owned `Value` — heap-bearing variants are `Cow::Owned`. Used everywhere
990/// a Value must outlive a query-scoped arena (catalog defaults, persistent
991/// storage, public APIs).
992pub type ValueOwned = Value<'static>;
993
994/// v7.37.5 ε — PG `point` building block. Shared by every other
995/// geometric type (lseg / path / box / polygon / circle all
996/// reduce to compositions of `Point2D`). Packed `{x: f64, y: f64}`,
997/// 16 B, on-disk LE field order matches the PG binary point
998/// format byte-for-byte (so a future binary BIND path lands
999/// without rearrangement).
1000#[derive(Debug, Clone, Copy, PartialEq)]
1001pub struct Point2D {
1002 pub x: f64,
1003 pub y: f64,
1004}
1005
1006/// v7.37.5 δ — single-range bounds without the kind tag. Used as
1007/// the element type of `Value::Multirange { kind, ranges }` so a
1008/// multirange carries one shared `RangeKind` plus N bounds-only
1009/// spans (saves 1 byte/elem vs duplicating the kind). The five
1010/// other fields mirror `Value::Range` exactly.
1011#[derive(Debug, Clone, PartialEq)]
1012pub struct RangeSpan {
1013 // v7.37.42-arena Phase 1: stays owned ('static) — same rationale as
1014 // Range bounds above.
1015 pub lower: Option<alloc::boxed::Box<Value<'static>>>,
1016 pub upper: Option<alloc::boxed::Box<Value<'static>>>,
1017 pub lower_inc: bool,
1018 pub upper_inc: bool,
1019 pub empty: bool,
1020}
1021
1022/// v7.37.5 β-P4 — element type for `Value::IntervalArray`. Mirrors
1023/// the `{months, days, micros}` shape of scalar `Value::Interval`,
1024/// broken out as a named struct so `IntervalArray`'s element type
1025/// is concrete (24 bytes, packed) instead of an enum-boxed Value.
1026/// All three dimensions are independent — `IntervalSpan { days: 1,
1027/// .. }` is distinct from `IntervalSpan { micros: 86_400_000_000,
1028/// .. }` per PG byte-equal.
1029#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1030pub struct IntervalSpan {
1031 pub months: i32,
1032 pub days: i32,
1033 pub micros: i64,
1034}
1035
1036impl<'arena> Value<'arena> {
1037 /// Type tag, or `None` for `NULL` (unknown at value level).
1038 pub fn data_type(&self) -> Option<DataType> {
1039 match self {
1040 Self::SmallInt(_) => Some(DataType::SmallInt),
1041 Self::Int(_) => Some(DataType::Int),
1042 Self::BigInt(_) => Some(DataType::BigInt),
1043 Self::Float(_) => Some(DataType::Float),
1044 Self::Real(_) => Some(DataType::Real),
1045 // `Text` covers both unbounded TEXT and bounded VARCHAR/CHAR
1046 // — the constraint lives on the column schema, not the value.
1047 Self::Text(_) => Some(DataType::Text),
1048 Self::Bool(_) => Some(DataType::Bool),
1049 Self::Vector(v) => Some(DataType::Vector {
1050 dim: u32::try_from(v.len()).expect("vector dim ≤ u32"),
1051 encoding: VecEncoding::F32,
1052 }),
1053 Self::Sq8Vector(q) => Some(DataType::Vector {
1054 dim: u32::try_from(q.bytes.len()).expect("vector dim ≤ u32"),
1055 encoding: VecEncoding::Sq8,
1056 }),
1057 Self::HalfVector(h) => Some(DataType::Vector {
1058 dim: u32::try_from(h.dim()).expect("vector dim ≤ u32"),
1059 encoding: VecEncoding::F16,
1060 }),
1061 // `Value::Numeric` doesn't carry its precision (the column
1062 // schema does); we surface precision=0 as "unknown" and let
1063 // the engine reconcile against the column type at coercion
1064 // time.
1065 // v7.39 (round 273) — a VALUE's display scale is unsigned and
1066 // never exceeds PG's 16383 ceiling, so it always fits the
1067 // signed declared-scale field this describes itself with.
1068 Self::Numeric { scale, .. } => Some(DataType::Numeric {
1069 precision: 0,
1070 scale: i16::try_from(*scale).unwrap_or(i16::MAX),
1071 }),
1072 Self::NumericBig(b) => Some(DataType::Numeric {
1073 precision: 0,
1074 scale: i16::try_from(b.scale()).unwrap_or(i16::MAX),
1075 }),
1076 Self::Date(_) => Some(DataType::Date),
1077 Self::Timestamp(_) => Some(DataType::Timestamp),
1078 Self::Interval { .. } => Some(DataType::Interval),
1079 Self::Json(_) => Some(DataType::Json),
1080 Self::Bytes(_) => Some(DataType::Bytes),
1081 Self::TextArray(_) => Some(DataType::TextArray),
1082 Self::IntArray(_) => Some(DataType::IntArray),
1083 Self::BigIntArray(_) => Some(DataType::BigIntArray),
1084 Self::IntervalArray(_) => Some(DataType::IntervalArray),
1085 Self::BoolArray(_) => Some(DataType::BoolArray),
1086 Self::SmallIntArray(_) => Some(DataType::SmallIntArray),
1087 Self::FloatArray(_) => Some(DataType::FloatArray),
1088 Self::NumericArray(_) => Some(DataType::NumericArray),
1089 Self::DateArray(_) => Some(DataType::DateArray),
1090 Self::TimestampArray(_) => Some(DataType::TimestampArray),
1091 Self::TimestamptzArray(_) => Some(DataType::TimestamptzArray),
1092 Self::UuidArray(_) => Some(DataType::UuidArray),
1093 Self::JsonArray(_) => Some(DataType::JsonArray),
1094 Self::JsonbArray(_) => Some(DataType::JsonbArray),
1095 Self::BytesArray(_) => Some(DataType::BytesArray),
1096 Self::VarcharArray(_) => Some(DataType::VarcharArray),
1097 Self::CharArray(_) => Some(DataType::CharArray),
1098 Self::Multirange { kind, .. } => Some(DataType::Multirange(*kind)),
1099 Self::Point(_) => Some(DataType::Point),
1100 Self::Lseg(_, _) => Some(DataType::Lseg),
1101 Self::Path { .. } => Some(DataType::Path),
1102 Self::PgBox(_, _) => Some(DataType::PgBox),
1103 Self::Polygon(_) => Some(DataType::Polygon),
1104 Self::Line { .. } => Some(DataType::Line),
1105 Self::Circle { .. } => Some(DataType::Circle),
1106 Self::Inet { .. } => Some(DataType::Inet),
1107 Self::Cidr { .. } => Some(DataType::Cidr),
1108 Self::Macaddr(_) => Some(DataType::Macaddr),
1109 Self::Macaddr8(_) => Some(DataType::Macaddr8),
1110 Self::PgLsn(_) => Some(DataType::PgLsn),
1111 // BitString could be either Bit or BitVarying; column
1112 // schema decides. Default to BitVarying when called
1113 // schema-less (rare; storage path is always
1114 // schema-aware so this only matters for diagnostics).
1115 Self::BitString { .. } => Some(DataType::BitVarying(0)),
1116 Self::Xml(_) => Some(DataType::Xml),
1117 Self::Char1(_) => Some(DataType::Char1),
1118 // BpChar reports its declared width from the padded length.
1119 Self::BpChar(s) => Some(DataType::Char(
1120 u32::try_from(s.chars().count()).unwrap_or(0),
1121 )),
1122 Self::MoneyArray(_) => Some(DataType::MoneyArray),
1123 Self::TsVector(_) => Some(DataType::TsVector),
1124 Self::TsQuery(_) => Some(DataType::TsQuery),
1125 Self::Uuid(_) => Some(DataType::Uuid),
1126 Self::Time(_) => Some(DataType::Time),
1127 Self::Year(_) => Some(DataType::Year),
1128 Self::TimeTz { .. } => Some(DataType::TimeTz),
1129 Self::Money(_) => Some(DataType::Money),
1130 Self::Range { kind, .. } => Some(DataType::Range(*kind)),
1131 Self::Hstore(_) => Some(DataType::Hstore),
1132 Self::IntArray2D(_) => Some(DataType::IntArray2D),
1133 Self::BigIntArray2D(_) => Some(DataType::BigIntArray2D),
1134 Self::TextArray2D(_) => Some(DataType::TextArray2D),
1135 Self::BoolArray2D(_) => Some(DataType::BoolArray2D),
1136 // v7.38 (read01, T9) — a transient composite/record has no storable
1137 // column DataType (it flows through row_to_json / to_json).
1138 Self::Composite(_) => None,
1139 // v7.39 (read01 ruleutils.c) — regclass is eval-only (dual
1140 // oid+name shape); no column storage type.
1141 // v7.39 (round 640) — `xid` became a column type, so its value
1142 // has a DataType to answer with. `cid` and `tid` are equally
1143 // legal column types on PG (measured: `CREATE TABLE t (a cid,
1144 // b tid)` is accepted), but SPG's grammar has no keyword for
1145 // them yet; they stay eval-only rather than half-declared.
1146 Self::Xid(_) => Some(DataType::Xid),
1147 Self::RegClass(..)
1148 | Self::RegProc(..)
1149 | Self::RegType(..)
1150 | Self::Tid(..)
1151 | Self::Cid(_) => None,
1152 Self::Null => None,
1153 }
1154 }
1155
1156 pub const fn is_null(&self) -> bool {
1157 matches!(self, Self::Null)
1158 }
1159
1160 /// v7.37.42-arena Phase 1: lift any `Value<'arena>` (possibly
1161 /// borrowing from a bump arena) into a fully-owned `Value<'static>`.
1162 /// Used at boundaries that must outlive the per-query arena
1163 /// (catalog write, public QueryResult emit, sqlx materialise).
1164 ///
1165 /// For the recursive Range/Multirange variants — bounds are already
1166 /// `Box<Value<'static>>` per Phase 1 design, so we just rebuild the
1167 /// outer enum at `'static`.
1168 pub fn into_owned(self) -> Value<'static> {
1169 match self {
1170 Value::SmallInt(n) => Value::SmallInt(n),
1171 Value::Int(n) => Value::Int(n),
1172 Value::BigInt(n) => Value::BigInt(n),
1173 Value::Float(f) => Value::Float(f),
1174 Value::Real(f) => Value::Real(f),
1175 Value::Text(s) => Value::Text(Cow::Owned(s.into_owned())),
1176 Value::Bool(b) => Value::Bool(b),
1177 Value::Vector(v) => Value::Vector(Cow::Owned(v.into_owned())),
1178 Value::Sq8Vector(q) => Value::Sq8Vector(q),
1179 Value::HalfVector(h) => Value::HalfVector(h),
1180 Value::Numeric {
1181 scaled,
1182 scale,
1183 kind,
1184 } => Value::Numeric {
1185 scaled,
1186 scale,
1187 kind,
1188 },
1189 Value::NumericBig(b) => Value::NumericBig(b),
1190 Value::Date(d) => Value::Date(d),
1191 Value::Timestamp(t) => Value::Timestamp(t),
1192 Value::Interval {
1193 months,
1194 days,
1195 micros,
1196 } => Value::Interval {
1197 months,
1198 days,
1199 micros,
1200 },
1201 Value::Json(s) => Value::Json(Cow::Owned(s.into_owned())),
1202 Value::Bytes(b) => Value::Bytes(Cow::Owned(b.into_owned())),
1203 Value::TextArray(v) => Value::TextArray(v),
1204 Value::IntArray(v) => Value::IntArray(v),
1205 Value::BigIntArray(v) => Value::BigIntArray(v),
1206 Value::IntervalArray(v) => Value::IntervalArray(v),
1207 Value::BoolArray(v) => Value::BoolArray(v),
1208 Value::SmallIntArray(v) => Value::SmallIntArray(v),
1209 Value::FloatArray(v) => Value::FloatArray(v),
1210 Value::NumericArray(v) => Value::NumericArray(v),
1211 Value::DateArray(v) => Value::DateArray(v),
1212 Value::TimestampArray(v) => Value::TimestampArray(v),
1213 Value::TimestamptzArray(v) => Value::TimestamptzArray(v),
1214 Value::UuidArray(v) => Value::UuidArray(v),
1215 Value::JsonArray(v) => Value::JsonArray(v),
1216 Value::JsonbArray(v) => Value::JsonbArray(v),
1217 Value::BytesArray(v) => Value::BytesArray(v),
1218 Value::VarcharArray(v) => Value::VarcharArray(v),
1219 Value::CharArray(v) => Value::CharArray(v),
1220 Value::Multirange { kind, ranges } => Value::Multirange { kind, ranges },
1221 // v7.38 (read01, T9) — Composite fields are already `Value<'static>`.
1222 Value::Composite(fields) => Value::Composite(fields),
1223 Value::RegClass(oid, name) => Value::RegClass(oid, name),
1224 Value::Tid(b, o) => Value::Tid(b, o),
1225 Value::Xid(x) => Value::Xid(x),
1226 Value::Cid(c) => Value::Cid(c),
1227 Value::RegProc(oid, name) => Value::RegProc(oid, name),
1228 Value::RegType(oid, name) => Value::RegType(oid, name),
1229 Value::Point(p) => Value::Point(p),
1230 Value::Lseg(a, b) => Value::Lseg(a, b),
1231 Value::Path { points, closed } => Value::Path { points, closed },
1232 Value::PgBox(a, b) => Value::PgBox(a, b),
1233 Value::Polygon(p) => Value::Polygon(p),
1234 Value::Line { a, b, c } => Value::Line { a, b, c },
1235 Value::Circle { center, radius } => Value::Circle { center, radius },
1236 Value::Inet { family, bits, addr } => Value::Inet { family, bits, addr },
1237 Value::Cidr { family, bits, addr } => Value::Cidr { family, bits, addr },
1238 Value::Macaddr(m) => Value::Macaddr(m),
1239 Value::Macaddr8(m) => Value::Macaddr8(m),
1240 Value::PgLsn(l) => Value::PgLsn(l),
1241 Value::BitString { nbits, bytes } => Value::BitString {
1242 nbits,
1243 bytes: Cow::Owned(bytes.into_owned()),
1244 },
1245 Value::Xml(s) => Value::Xml(Cow::Owned(s.into_owned())),
1246 Value::Char1(c) => Value::Char1(c),
1247 Value::BpChar(s) => Value::BpChar(Cow::Owned(s.into_owned())),
1248 Value::MoneyArray(v) => Value::MoneyArray(v),
1249 Value::TsVector(v) => Value::TsVector(v),
1250 Value::TsQuery(q) => Value::TsQuery(q),
1251 Value::Uuid(u) => Value::Uuid(u),
1252 Value::Time(t) => Value::Time(t),
1253 Value::Year(y) => Value::Year(y),
1254 Value::TimeTz { us, offset_secs } => Value::TimeTz { us, offset_secs },
1255 Value::Money(m) => Value::Money(m),
1256 Value::Range {
1257 kind,
1258 lower,
1259 upper,
1260 lower_inc,
1261 upper_inc,
1262 empty,
1263 } => Value::Range {
1264 kind,
1265 lower,
1266 upper,
1267 lower_inc,
1268 upper_inc,
1269 empty,
1270 },
1271 Value::Hstore(h) => Value::Hstore(h),
1272 Value::IntArray2D(a) => Value::IntArray2D(a),
1273 Value::BigIntArray2D(a) => Value::BigIntArray2D(a),
1274 Value::TextArray2D(a) => Value::TextArray2D(a),
1275 Value::BoolArray2D(a) => Value::BoolArray2D(a),
1276 Value::Null => Value::Null,
1277 }
1278 }
1279
1280 /// v7.37.42-arena Phase 4 — copy heap payloads into the supplied
1281 /// bump arena, yielding a `Value<'a>` whose Cow-variant payloads
1282 /// are arena-borrowed (or stay as small owned scalars for the
1283 /// `Copy`-able variants).
1284 ///
1285 /// Used at the catalog ↔ ephemeral boundary: a `ColumnSchema.default`
1286 /// is `Value<'static>` but INSERT-time eval may want it stamped into
1287 /// the per-statement arena alongside other arena-built scalars.
1288 ///
1289 /// Allocates only into the supplied arena; the input `&self` keeps
1290 /// its own storage. For `Copy`-able / nested-owned variants the
1291 /// implementation falls back to `clone()` (the nested heap blocks
1292 /// stay on the global allocator, which is fine — the boundary
1293 /// requirement is just "no aliasing of caller-owned strings").
1294 pub fn clone_into<'a>(&self, arena: &'a bumpalo::Bump) -> Value<'a> {
1295 match self {
1296 Value::Text(s) => Value::Text(Cow::Borrowed(arena.alloc_str(s))),
1297 Value::Json(s) => Value::Json(Cow::Borrowed(arena.alloc_str(s))),
1298 Value::Xml(s) => Value::Xml(Cow::Borrowed(arena.alloc_str(s))),
1299 Value::BpChar(s) => Value::BpChar(Cow::Borrowed(arena.alloc_str(s))),
1300 Value::Bytes(b) => {
1301 let slot = arena.alloc_slice_copy::<u8>(b);
1302 Value::Bytes(Cow::Borrowed(slot))
1303 }
1304 Value::Vector(v) => {
1305 let slot = arena.alloc_slice_copy::<f32>(v);
1306 Value::Vector(Cow::Borrowed(slot))
1307 }
1308 Value::BitString { nbits, bytes } => {
1309 let slot = arena.alloc_slice_copy::<u8>(bytes);
1310 Value::BitString {
1311 nbits: *nbits,
1312 bytes: Cow::Borrowed(slot),
1313 }
1314 }
1315 // Copy-able scalars + variants whose nested heap blocks are
1316 // `'static` regardless of `'arena` (TextArray, JsonArray,
1317 // Hstore, TsVector, Range bounds, …). Clone the heap block
1318 // via the standard `into_owned()` path then lift the
1319 // resulting `Value<'static>` to `Value<'a>` via the Cow
1320 // variance — `'static` covers any lifetime.
1321 other => other.clone().into_owned(),
1322 }
1323 }
1324}
1325
1326impl Value<'static> {
1327 /// v7.37.42-arena Phase 1 — owned-Text constructor. The variant now
1328 /// holds `Cow<'arena, str>`, so the previous `Value::Text(String)`
1329 /// shape no longer compiles directly. This helper preserves the
1330 /// historical ergonomics: `Value::text("foo")` or
1331 /// `Value::text(String::from("foo"))`.
1332 pub fn text<S: Into<String>>(s: S) -> Self {
1333 Value::Text(Cow::Owned(s.into()))
1334 }
1335
1336 /// v7.38 (read01, T6) — a finite NUMERIC from its fixed-point parts.
1337 pub const fn numeric(scaled: i128, scale: u16) -> Self {
1338 Value::Numeric {
1339 scaled,
1340 scale,
1341 kind: NumericKind::Finite,
1342 }
1343 }
1344
1345 /// v7.38 (read01, T6) — a special NUMERIC (NaN / ±Infinity). The fixed-point
1346 /// fields are canonicalized to 0 so equal specials compare byte-identical.
1347 pub const fn numeric_special(kind: NumericKind) -> Self {
1348 Value::Numeric {
1349 scaled: 0,
1350 scale: 0,
1351 kind,
1352 }
1353 }
1354
1355 /// v7.37.42-arena Phase 1 — owned-Json constructor (mirrors `text`).
1356 pub fn json<S: Into<String>>(s: S) -> Self {
1357 Value::Json(Cow::Owned(s.into()))
1358 }
1359
1360 /// v7.37.42-arena Phase 1 — owned-Xml constructor.
1361 pub fn xml<S: Into<String>>(s: S) -> Self {
1362 Value::Xml(Cow::Owned(s.into()))
1363 }
1364
1365 /// v7.37.42-arena Phase 1 — owned-Bytes constructor.
1366 pub fn bytes<B: Into<Vec<u8>>>(b: B) -> Self {
1367 Value::Bytes(Cow::Owned(b.into()))
1368 }
1369
1370 /// v7.37.42-arena Phase 1 — owned-Vector constructor.
1371 pub fn vector<V: Into<Vec<f32>>>(v: V) -> Self {
1372 Value::Vector(Cow::Owned(v.into()))
1373 }
1374
1375 /// v7.37.42-arena Phase 1 — owned-BitString constructor.
1376 pub fn bit_string<B: Into<Vec<u8>>>(nbits: u32, bytes: B) -> Self {
1377 Value::BitString {
1378 nbits,
1379 bytes: Cow::Owned(bytes.into()),
1380 }
1381 }
1382}
1383
1384/// One table row — values are positional and must match
1385/// `TableSchema.columns` in length and (modulo NULL) in `DataType`.
1386///
1387/// v7.37.42-arena Phase 1: parameterised on `'arena` so per-query rows
1388/// can borrow from a bump arena. The owned shape (`Row<'static>`, alias
1389/// `RowOwned`) is what catalog storage, public APIs, and tests use.
1390#[derive(Debug, Clone, PartialEq)]
1391pub struct Row<'arena> {
1392 pub values: Vec<Value<'arena>>,
1393}
1394
1395/// Owned `Row` — values are `Value<'static>`. Used everywhere a row must
1396/// outlive a query-scoped arena.
1397pub type RowOwned = Row<'static>;
1398
1399impl<'arena> Row<'arena> {
1400 pub const fn new(values: Vec<Value<'arena>>) -> Self {
1401 Self { values }
1402 }
1403
1404 pub fn len(&self) -> usize {
1405 self.values.len()
1406 }
1407
1408 pub fn is_empty(&self) -> bool {
1409 self.values.is_empty()
1410 }
1411}
1412
1413impl<'arena> Row<'arena> {
1414 /// v7.37.42-arena Phase 4 — copy every cell into the supplied bump
1415 /// arena, yielding a `Row<'a>` whose Cow-payloads are arena-borrowed.
1416 /// Boundary helper for catalog defaults → DML eval handoff and
1417 /// arena-local row scratch.
1418 pub fn clone_into<'a>(&self, arena: &'a bumpalo::Bump) -> Row<'a> {
1419 Row {
1420 values: self.values.iter().map(|v| v.clone_into(arena)).collect(),
1421 }
1422 }
1423
1424 /// v7.37.42-arena Phase 4 — lift this `Row<'arena>` to a fully-owned
1425 /// `Row<'static>` for catalog write / WAL serialisation. Equivalent
1426 /// to `Row::from_arena(self)` but consumes by value at any lifetime
1427 /// (callers can write `row.into_owned()` mirroring `Value::into_owned`).
1428 pub fn into_owned(self) -> Row<'static> {
1429 Row {
1430 values: self.values.into_iter().map(Value::into_owned).collect(),
1431 }
1432 }
1433}
1434
1435impl Row<'static> {
1436 /// v7.37.42-arena Phase 1 — lift any `Row<'arena>` (possibly arena-
1437 /// borrowed) into a fully-owned `Row<'static>`. Mirrors
1438 /// `Value::into_owned`.
1439 pub fn from_arena(row: Row<'_>) -> Self {
1440 Self {
1441 values: row.values.into_iter().map(Value::into_owned).collect(),
1442 }
1443 }
1444}
1445
1446/// Each bool is an independent, separately-persisted column attribute
1447/// (`nullable`, `auto_increment`, `is_unsigned`, `identity_always`) that the
1448/// catalog appendix reads and writes by name. Packing them into a bitflags
1449/// word would buy nothing and would put a decoding step between the on-disk
1450/// format and every reader of the schema.
1451#[allow(clippy::struct_excessive_bools)]
1452#[derive(Debug, Clone, PartialEq)]
1453pub struct ColumnSchema {
1454 pub name: String,
1455 pub ty: DataType,
1456 pub nullable: bool,
1457 /// Optional `DEFAULT` value, frozen at CREATE TABLE time. `None`
1458 /// means "no default" (so omitted columns become NULL, or error
1459 /// out when the column is NOT NULL). Literal defaults take this
1460 /// path.
1461 ///
1462 /// v7.37.42-arena Phase 1: explicitly `Value<'static>` — catalog
1463 /// defaults must outlive any per-query arena.
1464 pub default: Option<Value<'static>>,
1465 /// v7.9.21 — for DEFAULT expressions that need INSERT-time
1466 /// evaluation (e.g. `DEFAULT now()`, `DEFAULT CURRENT_TIMESTAMP`),
1467 /// the Display form of the expression. The engine re-parses
1468 /// it on each INSERT default-fill, evaluates against an empty
1469 /// row context, and coerces to the column type. mailrs G4.
1470 /// Persisted in catalog FILE_VERSION 15+; older catalogs
1471 /// deserialise with None.
1472 pub runtime_default: Option<String>,
1473 /// MySQL-style `AUTO_INCREMENT`. When set, an INSERT that leaves
1474 /// this column unbound (or sets it to NULL) gets the next integer
1475 /// computed from the column's current max + 1.
1476 /// v7.39 (round 676) — the collation NAME as written, when the column
1477 /// carried an explicit `COLLATE`.
1478 ///
1479 /// `spg_sql::Collation` cannot carry it: it is a two-variant MySQL enum
1480 /// and `from_collation_name` folds `C`, `POSIX`, `en_US` and `default`
1481 /// all into `Binary`. Without the name `pg_attribute.attcollation` can
1482 /// only ever report the type's default, which is what F36 records as
1483 /// "the declaration is taken and ignored".
1484 ///
1485 /// None means the column was written without a `COLLATE` clause and
1486 /// takes its type's collation. Persisted through the v88 appendix,
1487 /// which costs two bytes for a table that declares none.
1488 pub collation_name: Option<String>,
1489 pub auto_increment: bool,
1490 /// v7.17.0 Phase 1.4 — when the column is bound to a user-
1491 /// defined ENUM type (the parser saw an unknown type ident
1492 /// and the engine resolved it against `catalog.enum_types`),
1493 /// this carries the enum name so INSERT/UPDATE can validate
1494 /// the cell value against the enum's labels. `ty` is
1495 /// `DataType::Text` in that case. Persisted in catalog
1496 /// FILE_VERSION 29+; older catalogs deserialise with None.
1497 pub user_enum_type: Option<String>,
1498 /// v7.17.0 Phase 1.5 — when the column is bound to a user-
1499 /// defined DOMAIN (the parser saw an unknown type ident and
1500 /// the engine resolved it against `catalog.domain_types`),
1501 /// this carries the domain name. `ty` is the domain's base
1502 /// type; INSERT/UPDATE re-evaluates the domain's CHECK list
1503 /// + NOT NULL against the cell value. Persisted in catalog
1504 /// FILE_VERSION 30+; older catalogs deserialise with None.
1505 pub user_domain_type: Option<String>,
1506 /// v7.39 (read01 round 56) — when the column is bound to a user-defined
1507 /// COMPOSITE type. `ty` stays `DataType::Jsonb` (the on-disk form), but the
1508 /// engine REHYDRATES the stored JSON into a `Value::Composite` on read, so
1509 /// field access `(p).x`, `= ROW(…)`, ordering and the canonical `(2,b)`
1510 /// text form all work — they were already implemented on Value::Composite;
1511 /// what was missing was that the column never recorded WHICH composite type
1512 /// it holds (this field's doc comment existed for two releases, the field
1513 /// itself did not). Persisted in the composite-column appendix
1514 /// (FILE_VERSION 63+); older catalogs deserialise with None.
1515 pub user_composite_type: Option<String>,
1516 /// v7.39 (read01 round 59) — column-level privileges (PG
1517 /// `pg_attribute.attacl`). `GRANT SELECT (pub) ON t TO dan` lands here and
1518 /// does NOT touch the table's `relacl`. Empty = no column grant, which is
1519 /// every column until one is made.
1520 pub acl: Vec<AclItem>,
1521 /// v7.17.0 Phase 2.1 — MySQL `ON UPDATE CURRENT_TIMESTAMP`
1522 /// column attribute. When `Some(expr_src)`, an UPDATE that
1523 /// does NOT bind this column overrides the new value with
1524 /// the engine-evaluated expression (always `now()` in
1525 /// v7.17.0). Stored as Display-form source so storage
1526 /// stays free of spg-sql; the engine re-parses at UPDATE
1527 /// time. Persisted in catalog FILE_VERSION 32+; older
1528 /// catalogs deserialise with None — preserves the existing
1529 /// "silent ignore" behaviour for snapshots written before
1530 /// the upgrade.
1531 pub on_update_runtime: Option<String>,
1532 /// v7.17.0 Phase 2.5 — text collation. Pre-2.5 SPG accepted
1533 /// `COLLATE <name>` clauses but discarded the name, so a
1534 /// column declared `COLLATE "case_insensitive"` (or any
1535 /// MySQL `_ci` collation) still compared byte-wise — a
1536 /// Tier-S silent failure where `WHERE name = 'foo'` never
1537 /// matched stored `'Foo'`. This carries the parser-derived
1538 /// classification so the engine's WHERE evaluator can route
1539 /// text equality through a case-aware compare. `Binary` (the
1540 /// default) preserves the prior byte-wise behaviour. Only
1541 /// CaseInsensitive lands in the catalog appendix — Binary
1542 /// columns stay implicit, keeping snapshots compact.
1543 /// Persisted in catalog FILE_VERSION 34+; older catalogs
1544 /// deserialise every column as `Binary`.
1545 pub collation: Collation,
1546 /// v7.17.0 Phase 4.4 — MySQL `UNSIGNED` modifier flag. Drives
1547 /// engine-side INSERT / UPDATE range enforcement (rejects
1548 /// negative values on UNSIGNED int columns). Pre-4.4 the
1549 /// parser consumed and discarded the keyword silently, so
1550 /// every UNSIGNED column quietly accepted negatives — a
1551 /// Tier-A correctness drift. Sparse: only UNSIGNED columns
1552 /// land in the catalog appendix; the default `false` keeps
1553 /// snapshots compact for the common signed-int path.
1554 /// Persisted in catalog FILE_VERSION 35+; older catalogs
1555 /// deserialise every column as `is_unsigned = false`.
1556 pub is_unsigned: bool,
1557 /// v7.17.0 Phase 3.P0-36 — MySQL inline `ENUM('a','b','c')`
1558 /// value list. Distinct from `user_enum_type` (which points
1559 /// to a separately CREATE TYPE'd PG enum); this carries the
1560 /// column-local list MySQL DDL declares inline. When `Some`,
1561 /// `ty` is `DataType::Text` and INSERT/UPDATE validates the
1562 /// cell value against this list. Variant ORDER is preserved
1563 /// (MySQL uses it for `ORDER BY col`). Sparse: only ENUM
1564 /// columns land in the catalog appendix.
1565 /// Persisted in catalog FILE_VERSION 41+; older catalogs
1566 /// deserialise with None — preserves silent-drop behaviour
1567 /// for snapshots written before P0-36.
1568 pub inline_enum_variants: Option<Vec<String>>,
1569 /// v7.17.0 Phase 3.P0-37 — MySQL inline `SET('a','b','c')`
1570 /// variant list. Storage is TEXT (canonical comma-joined in
1571 /// definition order, de-duplicated). INSERT/UPDATE validates
1572 /// every comma-separated token against this list. Sparse:
1573 /// only SET columns land in the catalog appendix.
1574 /// Persisted in catalog FILE_VERSION 42+; older catalogs
1575 /// deserialise with None.
1576 pub inline_set_variants: Option<Vec<String>>,
1577 /// v7.37.7(sentori Epic 3 P1)— `GENERATED ALWAYS AS (<expr>)
1578 /// STORED` computed-column source. When `Some`, INSERT / UPDATE
1579 /// recompute the cell against the candidate row(re-parse the
1580 /// stored Display form and evaluate)and overwrite any
1581 /// user-supplied value, matching PG's stored-generated-column
1582 /// semantics. `None` (the default) preserves the regular
1583 /// "column value is whatever the caller passed" path.
1584 /// Persisted in catalog FILE_VERSION 50+; older catalogs
1585 /// deserialise with None.
1586 pub generated_stored_expr: Option<String>,
1587 /// v7.38 (read01) — `GENERATED ALWAYS AS IDENTITY`. Both identity
1588 /// flavours set `auto_increment`; this additionally marks the ALWAYS
1589 /// flavour, whose explicit INSERT value PG rejects ("cannot insert a
1590 /// non-DEFAULT value into column …") unless `OVERRIDING SYSTEM VALUE`.
1591 /// `false` (serial / `BY DEFAULT`) keeps the permissive path. In-memory
1592 /// only for now — not yet in the catalog appendix, so a reloaded table
1593 /// deserialises as `false` (the pre-existing permissive behaviour).
1594 pub identity_always: bool,
1595 /// v7.38 (read01) — the DEFAULT expression's source text, deparsed to
1596 /// PG-compatible form at CREATE TABLE time (e.g. `0`, `(3 + 4)`,
1597 /// `'hi'::text`, `now()`, `CURRENT_DATE`). Distinct from `default`
1598 /// (the coerced value the INSERT path fills) and `runtime_default`
1599 /// (the recompute-per-row Display form): those lose the source
1600 /// spelling, so `information_schema.columns.column_default` /
1601 /// `pg_attrdef` / `pg_get_expr` reported the coerced render
1602 /// (`0.00` for `numeric(10,2) DEFAULT 0`) instead of PG's `0`.
1603 /// `None` for a column with no explicit default. Persisted in catalog
1604 /// FILE_VERSION 58+; older catalogs deserialise with None.
1605 pub default_text: Option<String>,
1606 /// v7.39 (round 220) — `ALTER TABLE … ALTER COLUMN … RESTART [WITH n]`
1607 /// on an identity column. SPG's identity allocation is a max+1 scan;
1608 /// this floor lifts the next allocated value to at least `n`
1609 /// (`max(max+1, n)`) — exactly what a dump-restore RESTART needs, and
1610 /// safer than PG for a backward RESTART (no duplicate-key landmine).
1611 /// Persisted in the FILE_VERSION 73+ sparse appendix; older catalogs
1612 /// deserialise with None.
1613 pub auto_restart: Option<i64>,
1614 /// v7.39 (read01 round 78) — this column is the ONLY column of a FROM item
1615 /// that calls a function returning a BASE type, so the item's row type IS
1616 /// this column: a whole-row reference collapses to the value
1617 /// (`SELECT j FROM jsonb_array_elements('[1]') AS j` → `1`, PG). Runtime
1618 /// only — a catalogued table column is never one, and it is not persisted.
1619 pub scalar_row_source: bool,
1620 /// v7.39 (round 386, type-fidelity epic P1) — the declared MySQL narrow
1621 /// integer width (TINYINT / MEDIUMINT) whose range the storage `ty`
1622 /// (SmallInt / Int) is too wide to enforce. `None` for every other
1623 /// column. Drives the epic-P2 write-path range check. Persisted in the
1624 /// FILE_VERSION 81+ sparse appendix; older catalogs deserialise as None.
1625 pub mysql_int_width: Option<MysqlIntWidth>,
1626 /// v7.39 (round 424, type-fidelity epic) — the declared MySQL
1627 /// fractional-seconds precision of a temporal column: `DATETIME(3)` is
1628 /// `Some(3)`, a BARE `DATETIME` / `TIME` / `TIMESTAMP` is `Some(0)`
1629 /// (MySQL's default is zero — the fraction is dropped on write), and
1630 /// `None` means "not a MySQL-declared temporal column", which is every
1631 /// PG column and leaves microsecond behaviour untouched.
1632 ///
1633 /// Drives write-path truncation (toward zero) and render padding
1634 /// (exactly this many digits, `.000` when the fraction is zero).
1635 /// Persisted in the FILE_VERSION 82+ sparse appendix; older catalogs
1636 /// deserialise as None.
1637 pub mysql_fsp: Option<u8>,
1638}
1639
1640/// v7.17.0 Phase 2.5 — column-level text collation. Drives the
1641/// engine's WHERE / GROUP BY equality routing for `Value::Text`.
1642/// Only two variants are modelled in v7.17:
1643/// * `Binary` — byte-wise comparison (the SPG default;
1644/// matches PG `COLLATE "C"` / `pg_catalog.default`
1645/// and MySQL `*_bin`).
1646/// * `CaseInsensitive` — ASCII case-folded comparison (like
1647/// MySQL `*_ci` collations; PG has NO built-in
1648/// collation of this name — round-761 audit: a
1649/// nondeterministic ICU collation must be CREATEd
1650/// there first). Non-ASCII bytes
1651/// still compare byte-wise; full ICU folding is
1652/// out of v7.17 scope.
1653/// New variants append at the end — older catalogs read missing
1654/// columns as `Binary`.
1655#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1656pub enum Collation {
1657 Binary,
1658 CaseInsensitive,
1659}
1660
1661/// v7.39 (round 386, type-fidelity epic P1) — the declared MySQL narrow
1662/// integer type for a column whose storage `DataType` cannot express it.
1663/// MySQL `TINYINT` (i8, -128..127) collapses to `DataType::SmallInt` (i16)
1664/// and `MEDIUMINT` (24-bit) to `DataType::Int` (i32) — both wider than the
1665/// declared type, so a range check against `ty` alone accepts out-of-range
1666/// values (`INSERT 128 INTO TINYINT` is stored silently where MariaDB
1667/// strict raises ERROR 1264). This annotation records the lost width so the
1668/// write path (epic P2) can enforce the real bounds. `SMALLINT` / `INT` /
1669/// `BIGINT` need no marker — their storage `DataType` is already faithful.
1670/// Sparse: only TINYINT / MEDIUMINT columns carry it; persisted in the
1671/// FILE_VERSION 81+ appendix, older catalogs deserialise as None.
1672#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1673pub enum MysqlIntWidth {
1674 /// MySQL `TINYINT` — signed -128..127, unsigned 0..255. Storage i16.
1675 Tiny,
1676 /// MySQL `SMALLINT UNSIGNED` — 0..65535. Storage widened to i32 (a
1677 /// signed SMALLINT keeps `DataType::SmallInt` and carries no marker).
1678 Small,
1679 /// MySQL `MEDIUMINT` — signed -8388608..8388607, unsigned 0..16777215.
1680 /// Storage i32.
1681 Medium,
1682 /// MySQL `INT UNSIGNED` — 0..4294967295. Storage widened to i64 (a
1683 /// signed INT keeps `DataType::Int` and carries no marker).
1684 Int,
1685 /// v7.39 (round 471, epic P4b) — MySQL `BIGINT UNSIGNED` —
1686 /// 0..18446744073709551615. i64 stops at 2^63-1, so the storage tag is
1687 /// widened to `Numeric` (i128-backed, scale 0), which already compares,
1688 /// orders, indexes and renders as an exact integer. A signed BIGINT
1689 /// keeps `DataType::BigInt` and carries no marker.
1690 Big,
1691}
1692
1693/// v7.39 (round 363, M4 P1) — MySQL's default accent- and
1694/// case-insensitive fold (`utf8mb4_uca1400_ai_ci`).
1695///
1696/// This is the primitive M4 rests on: a session on the MySQL dialect
1697/// compares, groups, sorts and de-duplicates text by its FOLDED form, so
1698/// `Foo` = `foo` = `FOO` and, because the default collation is accent-
1699/// insensitive too, `Bär` = `bar`. The later stages (read path, then the
1700/// UNIQUE / index write path) all route through here so they cannot fold
1701/// differently from one another.
1702///
1703/// The fold is more than case + strip-combining: MariaDB EXPANDS some
1704/// letters — `ß` → `ss`, `æ` → `ae`, `œ` → `oe` — which is why the result
1705/// is built as a `String` rather than mapped char-for-char. Every mapping
1706/// below was measured on MariaDB 11 (`'Bär'='bar'` is 1, `'straße'=
1707/// 'strasse'` is 1, `'a'='æ'` is 0, `'s'='ß'` is 0). Characters with no
1708/// entry keep their lower-cased self, so ASCII and unknown scripts pass
1709/// through unchanged.
1710#[must_use]
1711pub fn mysql_ci_fold(s: &str) -> String {
1712 let mut out = String::with_capacity(s.len());
1713 for ch in s.chars() {
1714 // Lower-case first (`À` → `à`, `Æ` → `æ`), then fold the base.
1715 for lc in ch.to_lowercase() {
1716 match fold_latin_base(lc) {
1717 Some(base) => out.push_str(base),
1718 None => out.push(lc),
1719 }
1720 }
1721 }
1722 out
1723}
1724
1725/// v7.39 (round 375) — the fold used to COMPARE / GROUP / de-dup text on
1726/// the MySQL dialect. Its default collation is PAD SPACE: trailing spaces
1727/// do not affect a comparison (`'a' = 'a '`, `'' = ' '`, measured on
1728/// MariaDB 11), so they are stripped before the case/accent fold. Only
1729/// literal spaces pad — a tab or other whitespace is significant — and
1730/// this is NOT used by `LIKE`, whose pattern treats a trailing space
1731/// literally.
1732pub fn mysql_compare_fold(s: &str) -> String {
1733 mysql_ci_fold(s.trim_end_matches(' '))
1734}
1735
1736/// The base letter(s) a lower-cased Latin character folds to, or `None`
1737/// when it is already a base / has no fold. Expansions (`ß` → `ss`) are
1738/// why this returns a string.
1739fn fold_latin_base(c: char) -> Option<&'static str> {
1740 Some(match c {
1741 'à' | 'á' | 'â' | 'ã' | 'ä' | 'å' | 'ā' | 'ă' | 'ą' => "a",
1742 'æ' => "ae",
1743 'ç' | 'ć' | 'č' | 'ĉ' | 'ċ' => "c",
1744 'ð' | 'ď' | 'đ' => "d",
1745 'è' | 'é' | 'ê' | 'ë' | 'ē' | 'ĕ' | 'ė' | 'ę' | 'ě' => "e",
1746 'ĝ' | 'ğ' | 'ġ' | 'ģ' => "g",
1747 'ì' | 'í' | 'î' | 'ï' | 'ĩ' | 'ī' | 'ĭ' | 'į' => "i",
1748 'ĵ' => "j",
1749 'ķ' => "k",
1750 'ł' | 'ĺ' | 'ļ' | 'ľ' => "l",
1751 'ñ' | 'ń' | 'ņ' | 'ň' => "n",
1752 'ò' | 'ó' | 'ô' | 'õ' | 'ö' | 'ø' | 'ō' | 'ŏ' | 'ő' => "o",
1753 'œ' => "oe",
1754 'ŕ' | 'ŗ' | 'ř' => "r",
1755 'ś' | 'š' | 'ŝ' | 'ş' => "s",
1756 'ß' => "ss",
1757 'ţ' | 'ť' | 'ŧ' => "t",
1758 'ù' | 'ú' | 'û' | 'ü' | 'ũ' | 'ū' | 'ŭ' | 'ů' | 'ű' | 'ų' => "u",
1759 'ý' | 'ÿ' => "y",
1760 'ź' | 'ž' | 'ż' => "z",
1761 _ => return None,
1762 })
1763}
1764
1765#[allow(clippy::derivable_impls)]
1766impl Default for Collation {
1767 fn default() -> Self {
1768 Self::Binary
1769 }
1770}
1771
1772impl Collation {
1773 /// Wire tag persisted in the FILE_VERSION 34+ catalog appendix.
1774 /// Stable: future variants append above the recognised range
1775 /// and unknown tags read back as `Binary` for forward-compat
1776 /// on rollback.
1777 pub const TAG_BINARY: u8 = 0;
1778 pub const TAG_CASE_INSENSITIVE: u8 = 1;
1779}
1780
1781/// v7.39 (RLS) — the command a policy applies to. `ALL` is the default and
1782/// covers every command; the others scope the policy to one statement kind.
1783/// Persisted as a single byte in the policy appendix (FILE_VERSION 59+).
1784#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1785pub enum PolicyCmd {
1786 All,
1787 Select,
1788 Insert,
1789 Update,
1790 Delete,
1791}
1792
1793impl PolicyCmd {
1794 /// PG `pg_policy.polcmd` single-char encoding.
1795 #[must_use]
1796 pub const fn as_pg_char(self) -> char {
1797 match self {
1798 Self::All => '*',
1799 Self::Select => 'r',
1800 Self::Insert => 'a',
1801 Self::Update => 'w',
1802 Self::Delete => 'd',
1803 }
1804 }
1805
1806 /// PG `pg_policies.cmd` word form.
1807 #[must_use]
1808 pub const fn as_pg_word(self) -> &'static str {
1809 match self {
1810 Self::All => "ALL",
1811 Self::Select => "SELECT",
1812 Self::Insert => "INSERT",
1813 Self::Update => "UPDATE",
1814 Self::Delete => "DELETE",
1815 }
1816 }
1817
1818 #[must_use]
1819 pub const fn to_wire_byte(self) -> u8 {
1820 match self {
1821 Self::All => 0,
1822 Self::Select => 1,
1823 Self::Insert => 2,
1824 Self::Update => 3,
1825 Self::Delete => 4,
1826 }
1827 }
1828
1829 #[must_use]
1830 pub const fn from_wire_byte(b: u8) -> Option<Self> {
1831 match b {
1832 0 => Some(Self::All),
1833 1 => Some(Self::Select),
1834 2 => Some(Self::Insert),
1835 3 => Some(Self::Update),
1836 4 => Some(Self::Delete),
1837 _ => None,
1838 }
1839 }
1840}
1841
1842/// v7.39 (RLS) — one `CREATE POLICY` object, stored per table. The `using_expr`
1843/// / `with_check_expr` hold the qualifying expression's `Display` form
1844/// (re-parsed and evaluated per row at enforcement time, exactly like
1845/// `TableSchema.checks`); `None` means the clause was absent. `roles` empty =
1846/// PUBLIC. Persisted in the policy appendix (FILE_VERSION 59+).
1847#[derive(Debug, Clone, PartialEq)]
1848pub struct PolicyDef {
1849 pub name: String,
1850 pub cmd: PolicyCmd,
1851 /// `true` = PERMISSIVE (default, OR-combined), `false` = RESTRICTIVE
1852 /// (AND-combined).
1853 pub permissive: bool,
1854 pub roles: Vec<String>,
1855 pub using_expr: Option<String>,
1856 pub with_check_expr: Option<String>,
1857}
1858
1859#[derive(Debug, Clone, PartialEq)]
1860pub struct TableSchema {
1861 pub name: String,
1862 pub columns: Vec<ColumnSchema>,
1863 /// v6.7.2 — per-table hot-tier byte budget override. `None`
1864 /// falls through to the global `SPG_HOT_TIER_BYTES` setting;
1865 /// `Some(n)` overrides it for this specific table. Set via
1866 /// `ALTER TABLE t SET hot_tier_bytes = X`. Persisted in
1867 /// catalog FILE_VERSION 11+.
1868 pub hot_tier_bytes: Option<u64>,
1869 /// v7.6.1 — FOREIGN KEY constraints declared on this table.
1870 /// Engine maintains this in lock-step with `spg-sql`'s parser
1871 /// AST; the storage layer carries the on-disk shape so a
1872 /// catalog snapshot round-trips without external mapping.
1873 /// Persisted in catalog FILE_VERSION 13+. Older catalogs
1874 /// deserialise with an empty vec.
1875 pub foreign_keys: Vec<ForeignKeyConstraint>,
1876 /// v7.9.19 — composite UNIQUE / PRIMARY KEY constraints
1877 /// declared at the table level. Each entry's leading column
1878 /// has a BTree index (created via the constraint), and INSERT
1879 /// path enforces the full-tuple uniqueness via a scan keyed
1880 /// by the leading column. Persisted in catalog FILE_VERSION
1881 /// 15+. Older catalogs (≤ 14) deserialise with an empty vec.
1882 pub uniqueness_constraints: Vec<UniquenessConstraint>,
1883 /// v7.39 (round 210) — `EXCLUDE` constraints declared at the table level.
1884 /// Enforced on INSERT/UPDATE by a full live-row scan re-checking each
1885 /// element's operator (no equality index can answer overlap). Persisted
1886 /// in catalog FILE_VERSION 72+; older catalogs deserialise with an empty
1887 /// vec.
1888 pub exclusion_constraints: Vec<ExclusionConstraint>,
1889 /// v7.13.0 — `CHECK (<expr>)` predicates declared on this
1890 /// table. Both column-level inline `CHECK (…)` and
1891 /// table-level `CHECK (…)` fold into this list. Each entry
1892 /// is the AST Expr's `Display` form, re-parsed on every
1893 /// INSERT/UPDATE and evaluated against the candidate row.
1894 /// A false / NULL result rejects the mutation (PG semantics).
1895 /// Persisted in catalog FILE_VERSION 23+. Older catalogs
1896 /// deserialise with an empty vec. v7.39 (read01 round 48) — each entry
1897 /// now carries the user's constraint name too (FILE_VERSION 60+).
1898 pub checks: Vec<CheckConstraint>,
1899 /// v7.37.6-B — declarative partition role(sentori Epic 2 P0).
1900 /// `None` = 普通表(后向兼容,< v49 catalog 默认 None)。
1901 /// `Some(Parent { … })` = `CREATE TABLE p (...) PARTITION BY RANGE (key_col)` 父表 —
1902 /// 父表自己 `rows` 永远空,INSERT 在引擎层路由到命中的 child。
1903 /// `Some(Range { … })` = `CREATE TABLE c PARTITION OF p FOR VALUES FROM (a) TO (b)` 范围子表。
1904 /// `Some(Default { … })` = `CREATE TABLE c PARTITION OF p DEFAULT` 兜底子表。
1905 /// 持久化于 FILE_VERSION 49+。
1906 pub partition_role: Option<PartitionRole>,
1907 /// v7.39 (RLS) — `CREATE POLICY` objects on this table, independent of the
1908 /// `row_security` flag (PG stores policies even on non-RLS tables; they
1909 /// only take effect once RLS is enabled). Persisted in the policy appendix
1910 /// (FILE_VERSION 59+). Older catalogs deserialise with an empty vec.
1911 pub policies: Vec<PolicyDef>,
1912 /// v7.39 (RLS) — `ALTER TABLE … ENABLE ROW LEVEL SECURITY`
1913 /// (PG `pg_class.relrowsecurity`). Fresh table = `false`.
1914 pub row_security: bool,
1915 /// v7.39 (RLS) — `ALTER TABLE … FORCE ROW LEVEL SECURITY`
1916 /// (PG `pg_class.relforcerowsecurity`); subjects the table owner to RLS
1917 /// too. Fresh table = `false`.
1918 pub force_row_security: bool,
1919 /// v7.39 (read01 round 57, ACL) — the role that owns this table: whoever
1920 /// ran CREATE TABLE (PG `pg_class.relowner`). The owner holds every
1921 /// privilege implicitly and is the only role that may ALTER / DROP it.
1922 /// `None` = an image written before FILE_VERSION 64, which predates roles
1923 /// entirely; those tables read back as owned by the login role.
1924 pub owner: Option<String>,
1925 /// v7.39 (read01 round 57, ACL) — explicit GRANTs on this table
1926 /// (PG `pg_class.relacl`). EMPTY means "never granted": PG leaves relacl
1927 /// NULL while only the owner's implicit privileges apply, and materialises
1928 /// the whole list — owner's default entry included — on the first GRANT.
1929 /// Once materialised it stays, even after every grant is revoked.
1930 pub acl: Vec<AclItem>,
1931}
1932
1933/// v7.39 (read01 round 57) — one PG `aclitem`: what `grantee` may do to a
1934/// table, and who granted it. Renders as `grantee=privs/grantor`, with an
1935/// EMPTY grantee meaning PUBLIC (`=r/owner`).
1936#[derive(Debug, Clone, PartialEq, Eq)]
1937pub struct AclItem {
1938 /// The role the privileges are held by. Empty string = PUBLIC.
1939 pub grantee: String,
1940 /// Bitmask over `priv_bits`: which privileges are held.
1941 pub privs: u16,
1942 /// Bitmask over `priv_bits`: which of them carry WITH GRANT OPTION
1943 /// (PG renders those with a trailing `*` — `r*`).
1944 pub grantable: u16,
1945 /// The role that ran the GRANT.
1946 pub grantor: String,
1947}
1948
1949/// v7.39 (read01 round 57) — the table-privilege bits, in PG's `aclitem`
1950/// rendering order (`arwdDxtm`). The order matters: `relacl` output is
1951/// byte-compared against PG.
1952pub mod priv_bits {
1953 pub const INSERT: u16 = 1 << 0; // a
1954 pub const SELECT: u16 = 1 << 1; // r
1955 pub const UPDATE: u16 = 1 << 2; // w
1956 pub const DELETE: u16 = 1 << 3; // d
1957 pub const TRUNCATE: u16 = 1 << 4; // D
1958 pub const REFERENCES: u16 = 1 << 5; // x
1959 pub const TRIGGER: u16 = 1 << 6; // t
1960 pub const MAINTAIN: u16 = 1 << 7; // m
1961 /// v7.39 (read01 round 60) — the non-table privileges. They share the
1962 /// bitmask because an aclitem is an aclitem whatever it hangs off; which
1963 /// bits are MEANINGFUL depends on the object (a sequence has r / w / U, a
1964 /// schema has U / C, a database has C / c / T).
1965 pub const USAGE: u16 = 1 << 8; // U
1966 pub const CREATE: u16 = 1 << 9; // C
1967 pub const CONNECT: u16 = 1 << 10; // c
1968 pub const TEMPORARY: u16 = 1 << 11; // T
1969 pub const EXECUTE: u16 = 1 << 12; // X
1970 /// Every TABLE privilege — what `GRANT ALL ON <table>` grants and what a
1971 /// table's owner holds.
1972 pub const ALL: u16 =
1973 INSERT | SELECT | UPDATE | DELETE | TRUNCATE | REFERENCES | TRIGGER | MAINTAIN;
1974 /// `GRANT ALL ON SEQUENCE` — PG renders a sequence owner's default as `rwU`.
1975 pub const ALL_SEQUENCE: u16 = SELECT | UPDATE | USAGE;
1976 /// `GRANT ALL ON SCHEMA` — `UC`.
1977 pub const ALL_SCHEMA: u16 = USAGE | CREATE;
1978 /// `GRANT ALL ON DATABASE` — `CTc`.
1979 pub const ALL_DATABASE: u16 = CREATE | CONNECT | TEMPORARY;
1980 /// `GRANT ALL ON FUNCTION` — just `X`.
1981 pub const ALL_FUNCTION: u16 = EXECUTE;
1982}
1983
1984/// v7.37.6-B — partition 三态(parent / range child / default child)。
1985#[derive(Debug, Clone, PartialEq, Eq)]
1986pub enum PartitionRole {
1987 Parent {
1988 kind: PartitionKind,
1989 /// 父表 columns 中 key 列的下标(单列 v7.37.6-B,
1990 /// `Vec` 为将来扩多列预留)。
1991 key_column_positions: Vec<usize>,
1992 /// `CREATE INDEX ON parent (…)` 的 Display-form 源串。
1993 /// child 创建时再 parse + 在 child 上 execute,这样 future
1994 /// child 也自动继承父表索引。fan-out 实施在引擎层。
1995 index_template_sources: Vec<String>,
1996 },
1997 Range {
1998 parent_name: String,
1999 /// 半开区间下界(`>=`,SQL `FROM (lower)`).
2000 lower: PartitionBound,
2001 /// 半开区间上界(`<`,SQL `TO (upper)`).
2002 upper: PartitionBound,
2003 },
2004 /// v7.37.16 (16.1) — LIST child:行属于本 child iff key ∈ values。
2005 /// `values` 在 child 创建时从 SQL `FOR VALUES IN (lit, …)` 求值;
2006 /// 跟 PG 一样,显式 NULL ∈ values 由 caller 单独处理(不在
2007 /// PartitionBound 内表达 NULL)。
2008 List {
2009 parent_name: String,
2010 values: Vec<PartitionBound>,
2011 },
2012 /// v7.39 (round 645) — PG 表继承的 CHILD:`CREATE TABLE c (…)
2013 /// INHERITS (p1, p2)`。跟分区 child 的三个本质区别(实测 PG18):
2014 /// * 父表**自己有行**(分区父表永远空),所以父表的联合体要含自身;
2015 /// * `INSERT INTO 父表` **不路由**到 child(分区会路由);
2016 /// * `DROP TABLE 父表` 不带 CASCADE **报错**(分区父表连子表一起删)。
2017 /// 多父继承合法,故 `parent_names` 是 Vec;`pg_inherits.inhseqno`
2018 /// 正是父表在这个列表里的位置(1-based)。
2019 Inherits {
2020 parent_names: Vec<String>,
2021 },
2022 /// v7.37.16 (16.2) — HASH child:行属于本 child iff
2023 /// `pg_compatible_hash(key) mod modulus == remainder`。
2024 /// PG 强制 `0 ≤ remainder < modulus`;parser/DDL 层先 gate。
2025 Hash {
2026 parent_name: String,
2027 modulus: u32,
2028 remainder: u32,
2029 },
2030 Default {
2031 parent_name: String,
2032 },
2033}
2034
2035/// v7.37.6-B — 分区策略。
2036///
2037/// - `Range`:半开区间 `[lower, upper)`(v7.37.6-B 初始)
2038/// - `List` (v7.37.16):枚举集合 — 行属于 partition iff key ∈ children list
2039/// - `Hash` (v7.37.16):`hash(key) mod modulus == remainder`
2040#[derive(Debug, Clone, Copy, PartialEq, Eq)]
2041pub enum PartitionKind {
2042 Range,
2043 List,
2044 Hash,
2045}
2046
2047/// v7.37.6-B — partition 边界 literal。
2048///
2049/// v7.37.6-B 仅 `TimestampTz`(i64 microseconds since epoch);
2050/// v7.37.16 (16.6) 加全 PG 内建可比类型,匹配 `Value` 的对应 variant
2051/// 以避免 LIST membership 比较时的类型转换。
2052///
2053/// `MinValue` / `MaxValue` 对应 SQL `MINVALUE` / `MAXVALUE`,仅
2054/// Range 策略有意义(LIST 无 minvalue/maxvalue 概念,HASH 不
2055/// 使用 PartitionBound)。
2056#[derive(Debug, Clone, PartialEq, Eq)]
2057pub enum PartitionBound {
2058 MinValue,
2059 MaxValue,
2060 TimestampTz(i64),
2061 /// v7.37.16 (16.6) — BIGINT partition key.
2062 BigInt(i64),
2063 /// v7.37.16 (16.6) — INTEGER partition key (also covers
2064 /// `SERIAL` since SPG decomposes it to INTEGER + sequence).
2065 Int(i32),
2066 /// v7.37.16 (16.6) — SMALLINT partition key.
2067 SmallInt(i16),
2068 /// v7.37.16 (16.6) — DATE partition key. Stored as days
2069 /// since the Unix epoch (matches `Value::Date`).
2070 Date(i32),
2071 /// v7.37.16 (16.6) — TEXT / VARCHAR partition key.
2072 Text(alloc::string::String),
2073}
2074
2075impl PartitionBound {
2076 /// v7.37.16 (16.6) — true iff this bound's underlying value
2077 /// equals `other`'s. Used for LIST partition membership
2078 /// checks. Returns false for `MinValue` / `MaxValue`
2079 /// (sentinels — never literal equality).
2080 #[must_use]
2081 pub fn equals_value(&self, other: &Value<'_>) -> bool {
2082 match (self, other) {
2083 (PartitionBound::TimestampTz(a), Value::Timestamp(b)) => a == b,
2084 (PartitionBound::BigInt(a), Value::BigInt(b)) => a == b,
2085 (PartitionBound::Int(a), Value::Int(b)) => a == b,
2086 (PartitionBound::SmallInt(a), Value::SmallInt(b)) => a == b,
2087 (PartitionBound::Date(a), Value::Date(b)) => a == b,
2088 (PartitionBound::Text(a), Value::Text(b)) => a.as_str() == b.as_ref(),
2089 _ => false,
2090 }
2091 }
2092}
2093
2094/// v7.9.19 — composite UNIQUE / PRIMARY KEY constraint persisted
2095/// on the table schema. The leading column always has a BTree
2096/// index (created at CREATE TABLE time); INSERT enforcement
2097/// scans that index for collisions on the full column tuple.
2098/// v7.39 (read01 round 48) — a `CHECK` constraint: the SQL name the user
2099/// gave it (via `ADD CONSTRAINT <name> CHECK (...)` or the inline
2100/// `CONSTRAINT <name> CHECK (...)` form) plus the predicate source. `None`
2101/// name = unnamed, in which case `pg_constraint` synthesises PG's
2102/// `<table>_<col>_check` form. Names are persisted in the constraint-name
2103/// appendix (FILE_VERSION 60+); older catalogs deserialise with `None`.
2104#[derive(Debug, Clone, PartialEq, Eq)]
2105pub struct CheckConstraint {
2106 pub name: Option<String>,
2107 /// The AST Expr's `Display` form, re-parsed on every INSERT/UPDATE.
2108 pub expr: String,
2109 /// v7.39 (round 652) — `false` for a constraint added `NOT VALID`: the
2110 /// rows already in the table were never scanned against it, and
2111 /// `pg_constraint.convalidated` says so. It does NOT weaken the check on
2112 /// new rows — INSERT and UPDATE enforce it either way, as in PG.
2113 /// `VALIDATE CONSTRAINT` does the deferred scan and flips it. Persisted
2114 /// by the FILE_VERSION 87 appendix; older catalogs deserialise as `true`,
2115 /// which is what every constraint they could hold actually was.
2116 pub validated: bool,
2117}
2118
2119#[derive(Debug, Clone, PartialEq, Eq)]
2120pub struct UniquenessConstraint {
2121 /// `true` when this constraint was declared as `PRIMARY KEY`
2122 /// (vs `UNIQUE`). Semantically PK implies NOT NULL on all
2123 /// referenced columns; the engine enforces that at CREATE
2124 /// TABLE time.
2125 pub is_primary_key: bool,
2126 /// Column positions on the parent table. ≥ 1 element. For
2127 /// single-column UNIQUE this is exactly one position; the
2128 /// BTree index alone enforces it.
2129 pub columns: Vec<usize>,
2130 /// v7.13.0 — `UNIQUE NULLS NOT DISTINCT` modifier
2131 /// (mailrs round-5 G10; PG 15+ surface). When `true`, two
2132 /// rows whose constrained columns are all NULL collide on
2133 /// the constraint. Default (`false`) is the SQL-standard
2134 /// `NULLS DISTINCT` behaviour where any NULL passes.
2135 /// Persisted in catalog FILE_VERSION 23+.
2136 pub nulls_not_distinct: bool,
2137 /// v7.39 (read01 round 48) — the constraint's SQL name when the user
2138 /// supplied one (`ADD CONSTRAINT <name> PRIMARY KEY/UNIQUE (...)`, or
2139 /// the inline `CONSTRAINT <name>` form). `None` = unnamed, in which
2140 /// case `pg_constraint` synthesises PG's `<table>_pkey` /
2141 /// `<table>_<col>_key` form. DROP CONSTRAINT resolves the stored name
2142 /// first and falls back to the synthesised one, so catalogs written
2143 /// before this field (< FILE_VERSION 60) keep working unchanged.
2144 pub name: Option<String>,
2145 /// v7.39 (round 711) — `[NOT] DEFERRABLE`. Round 621 taught the parser
2146 /// to CONSUME the clause on PK/UNIQUE (the FK path had stored it since
2147 /// round 288); this is the storing half. Persisted in the v89 timing
2148 /// appendix.
2149 pub deferrable: bool,
2150 /// `INITIALLY DEFERRED`: the check belongs to COMMIT, not the
2151 /// statement, unless `SET CONSTRAINTS … IMMEDIATE` pulls it in.
2152 pub initially_deferred: bool,
2153}
2154
2155/// v7.39 (round 210) — an `EXCLUDE` constraint. Forbids two distinct live
2156/// rows from satisfying, for EVERY element, `new.col <op> existing.col`
2157/// (e.g. `EXCLUDE USING gist (during WITH &&)` = no two `during` ranges
2158/// overlap). Unlike a uniqueness constraint the operator is not equality,
2159/// so enforcement is a full live-row scan re-checking the operator (a real
2160/// GiST index that answers overlap in O(log n) is a later perf phase). A
2161/// NULL in any element column exempts the row (matching PG / UNIQUE NULL
2162/// semantics). Persisted in catalog FILE_VERSION 72+.
2163#[derive(Debug, Clone, PartialEq, Eq)]
2164pub struct ExclusionConstraint {
2165 /// The constraint's SQL name. PG auto-names an unnamed EXCLUDE
2166 /// `<table>_<leading-col>_excl`; the engine synthesises that at CREATE
2167 /// TABLE time so this is always populated.
2168 pub name: String,
2169 /// Access method spelled after `USING` (`gist`, `spgist`, …), lower-cased.
2170 /// `None` = no `USING` clause. Purely cosmetic for enforcement; it round-
2171 /// trips into `pg_get_constraintdef`.
2172 pub method: Option<String>,
2173 /// One `(column-position, operator-spelling)` pair per element, in
2174 /// declaration order. The operator spelling is the wire token (`&&`,
2175 /// `=`, `@>`, `<@`, `&<`, `&>`) evaluated against each existing row.
2176 pub elements: Vec<(usize, String)>,
2177}
2178
2179/// v7.6.1 — Storage-layer mirror of `spg_sql::ast::ForeignKeyConstraint`.
2180/// The engine's CREATE TABLE path translates between the two; keeping
2181/// them separate preserves the no-deps boundary between
2182/// `spg-storage` and `spg-sql`.
2183#[derive(Debug, Clone, PartialEq, Eq)]
2184pub struct ForeignKeyConstraint {
2185 /// Optional user-supplied constraint name (`CONSTRAINT <name>`
2186 /// prefix). Used by `ALTER TABLE DROP CONSTRAINT <name>` in
2187 /// v7.6.8; ignored by enforcement.
2188 pub name: Option<String>,
2189 /// Positions of local columns in this table's column list.
2190 /// Same arity as `parent_columns`.
2191 pub local_columns: Vec<usize>,
2192 /// Referenced parent table name.
2193 pub parent_table: String,
2194 /// Positions of parent columns in the parent's column list.
2195 /// Engine resolves these at CREATE TABLE time (after the parent
2196 /// schema is known) so enforcement paths can skip the name
2197 /// lookup on every row.
2198 pub parent_columns: Vec<usize>,
2199 /// Referential action when a parent row is deleted.
2200 pub on_delete: FkAction,
2201 /// Referential action when a parent row's referenced columns
2202 /// are updated.
2203 pub on_update: FkAction,
2204 /// v7.38 (read01, T29) — `MATCH SIMPLE | FULL`. Defaults to `Simple`.
2205 pub match_type: MatchType,
2206 /// v7.39 (round 288) — `[NOT] DEFERRABLE`.
2207 pub deferrable: bool,
2208 /// `INITIALLY DEFERRED`: the check runs at COMMIT rather than at
2209 /// the statement, unless `SET CONSTRAINTS … IMMEDIATE` pulls it in.
2210 pub initially_deferred: bool,
2211}
2212
2213/// v7.38 (read01, T29) — FK MATCH type. Mirrors `spg_sql::ast::MatchType`.
2214#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
2215pub enum MatchType {
2216 #[default]
2217 Simple,
2218 Full,
2219}
2220
2221impl MatchType {
2222 /// On-disk tag byte (catalog appendix, `FILE_VERSION` 55+).
2223 pub const fn tag(self) -> u8 {
2224 match self {
2225 Self::Simple => 0,
2226 Self::Full => 1,
2227 }
2228 }
2229 pub const fn from_tag(b: u8) -> Option<Self> {
2230 Some(match b {
2231 0 => Self::Simple,
2232 1 => Self::Full,
2233 _ => return None,
2234 })
2235 }
2236}
2237
2238/// v7.6.1 — referential action tag. Mirrors `spg_sql::ast::FkAction`.
2239#[derive(Debug, Clone, Copy, PartialEq, Eq)]
2240pub enum FkAction {
2241 Restrict,
2242 Cascade,
2243 SetNull,
2244 SetDefault,
2245 NoAction,
2246}
2247
2248impl FkAction {
2249 /// On-disk tag byte (v13 catalog appendix).
2250 pub const fn tag(self) -> u8 {
2251 match self {
2252 Self::Restrict => 0,
2253 Self::Cascade => 1,
2254 Self::SetNull => 2,
2255 Self::SetDefault => 3,
2256 Self::NoAction => 4,
2257 }
2258 }
2259 pub const fn from_tag(b: u8) -> Option<Self> {
2260 Some(match b {
2261 0 => Self::Restrict,
2262 1 => Self::Cascade,
2263 2 => Self::SetNull,
2264 3 => Self::SetDefault,
2265 4 => Self::NoAction,
2266 _ => return None,
2267 })
2268 }
2269}
2270
2271impl TableSchema {
2272 pub fn column_position(&self, name: &str) -> Option<usize> {
2273 self.columns.iter().position(|c| c.name == name)
2274 }
2275}
2276
2277/// Key type accepted by secondary indices. Float / NULL / Vector values
2278/// can't participate in a B-tree index — `f64` is only `PartialOrd`, NULL
2279/// has SQL-three-valued semantics, and Vector belongs to the (future) HNSW
2280/// path. Index lookups on those columns fall back to full scan.
2281#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
2282pub enum IndexKey {
2283 Int(i64),
2284 Text(String),
2285 Bool(bool),
2286 /// v7.17.0 — `Value::Uuid` index key. Comparison is byte-wise
2287 /// (RFC 4122 byte order) so PRIMARY KEY UUID lookups land on
2288 /// the same fast-path as Int / Text.
2289 Uuid([u8; 16]),
2290 /// r1039 — `Value::Bytes` (bytea). PG orders bytea by plain byte
2291 /// comparison, shorter-prefix first (`'' < \x00 < \x0000 < \x01ff <
2292 /// \xff`, measured on 18.4), which is exactly `Vec<u8>`'s `Ord`.
2293 Bytes(Vec<u8>),
2294 /// r1039 — exact decimal, in the canonical form described on
2295 /// [`NumericKey`].
2296 ///
2297 /// r1040 — BOXED, and the box is load-bearing for every OTHER index.
2298 /// A `NumericKey` is 48 bytes against `Text(String)`'s 24, so inline
2299 /// it set the size of the whole enum and every B-tree node in every
2300 /// index grew with it: 32 bytes per key to 48, align 8 to 16.
2301 /// Measured through the release sweep, `SELECT pad FROM t ORDER BY
2302 /// id` over 400,000 rows — a walk of the primary key's index — went
2303 /// 39.4-40.6 ms to 42.3-44.1, in both leg orders. The indirection is
2304 /// charged to numeric keys, which are new, instead of to every index
2305 /// that existed already.
2306 Numeric(alloc::boxed::Box<NumericKey>),
2307 /// v7.38.1 (L12) — a NULL component INSIDE a composite key, and
2308 /// nothing else. `IndexKey::from_value(Value::Null)` still returns
2309 /// `None`, so single-column B-trees never hold one, and no probe
2310 /// path ever BUILDS one (`col = NULL` is not a match in SQL) — the
2311 /// variant is only reachable through a composite key's component
2312 /// list, where it exists so that a row like `(2, 3, NULL)` stays
2313 /// findable by a PREFIX probe on `(w, d)`. Declared last: slice
2314 /// `Ord` then sorts NULL components after every value, PG's
2315 /// NULLS LAST.
2316 Null,
2317}
2318
2319/// r1039 — an exact-decimal index key, canonical so that representation
2320/// equality IS value equality.
2321///
2322/// That property is the whole reason this is a struct rather than the
2323/// `(scaled, scale)` pair the value carries. `1.5` and `1.50` are the
2324/// same NUMERIC (PG18.4: `1.5::numeric = 1.50::numeric` is true) and
2325/// arrive here as `(15, 1)` and `(150, 2)`. A B-tree keyed on the raw
2326/// pair would file them apart, so `WHERE n = 1.5` would miss a row stored
2327/// as `1.50` — an index changing the answer, which is the one thing an
2328/// index may never do. `BigNumeric::cmp` carries the same warning and
2329/// declines to implement `Ord` for exactly this reason; a KEY cannot
2330/// decline, so it normalizes instead.
2331///
2332/// Canonical form: significant decimal digits with no leading and no
2333/// trailing zeros, most significant first, plus the decimal exponent of
2334/// the leading digit. Zero is the empty digit vector with `neg == false`
2335/// and `exp == 0`, so there is no `-0`.
2336///
2337/// Ordering is PG's, measured: `-Infinity < -1 < 0 < 1 < Infinity < NaN`,
2338/// and `NaN = NaN`.
2339#[derive(Debug, Clone, PartialEq, Eq)]
2340pub struct NumericKey {
2341 /// 0 = -Infinity, 1 = finite, 2 = +Infinity, 3 = NaN. Ordering the
2342 /// classes by this byte is what puts NaN on top, where PG keeps it.
2343 class: u8,
2344 /// Finite only, and never set for zero.
2345 neg: bool,
2346 /// Decimal exponent of the leading significant digit; 0 for zero.
2347 exp: i32,
2348 /// r1040 — the first [`HEAD_DIGITS`] significant digits, LEFT-ALIGNED
2349 /// (multiplied up so the leading digit always sits at 10^36). That
2350 /// alignment is what makes an integer comparison of two heads the same
2351 /// answer as a digit-by-digit one: `12` and `1` become 1.2e36 and
2352 /// 1.0e36, which order the way the digit strings do, where the bare
2353 /// integers 12 and 1 would not.
2354 ///
2355 /// Zero for the value zero and for every special.
2356 ///
2357 /// This started as a `Vec<u8>` of digits, which is correct and cost
2358 /// an allocation per key and a slice comparison per sort comparison.
2359 /// `ORDER BY <numeric>` builds one key per row and compares n log n
2360 /// times: 200,000 rows measured 65.4 ms against 39.6 for the f64
2361 /// projection that had been returning rows in the wrong order.
2362 head: u128,
2363 /// Significant digits past the 37th, one per byte, no trailing zeros.
2364 /// Empty for everything an `i128` mantissa can hold with room to
2365 /// spare — and an empty `Vec` does not allocate, which is the point.
2366 tail: Vec<u8>,
2367}
2368
2369/// Significant digits carried in [`NumericKey::head`]. 37 is the most
2370/// that can be left-aligned inside a `u128`: the largest such value is
2371/// 9.99…e36, and `u128::MAX` is 3.4e38.
2372const HEAD_DIGITS: u32 = 37;
2373/// `10^36` — where a left-aligned leading digit sits.
2374const HEAD_SCALE: u128 = 1_000_000_000_000_000_000_000_000_000_000_000_000;
2375
2376/// The `class` byte of [`NumericKey`], in PG's order.
2377const NUM_CLASS_NEG_INF: u8 = 0;
2378const NUM_CLASS_FINITE: u8 = 1;
2379const NUM_CLASS_POS_INF: u8 = 2;
2380const NUM_CLASS_NAN: u8 = 3;
2381
2382impl NumericKey {
2383 /// The key for a `Value::Numeric`'s three fields.
2384 ///
2385 /// Public because the ORDER BY key wants the same canonical form the
2386 /// index key uses: two sort keys that disagree about which of two
2387 /// NUMERICs is larger is the same class of defect as an index that
2388 /// disagrees with a scan, and one definition is how they stay honest.
2389 #[must_use]
2390 pub fn from_numeric(scaled: i128, scale: u16, kind: NumericKind) -> Self {
2391 match kind {
2392 NumericKind::Finite => {
2393 let mut buf = [0u8; 40];
2394 let n = digits_of_u128(scaled.unsigned_abs(), &mut buf);
2395 Self::finite(scaled < 0, &buf[..n], i32::from(scale))
2396 }
2397 NumericKind::NaN => Self::special(NUM_CLASS_NAN),
2398 NumericKind::PosInf => Self::special(NUM_CLASS_POS_INF),
2399 NumericKind::NegInf => Self::special(NUM_CLASS_NEG_INF),
2400 }
2401 }
2402
2403 /// The key for an exact integer — no scale, so no rounding.
2404 #[must_use]
2405 pub fn from_i128(n: i128) -> Self {
2406 let mut buf = [0u8; 40];
2407 let len = digits_of_u128(n.unsigned_abs(), &mut buf);
2408 Self::finite(n < 0, &buf[..len], 0)
2409 }
2410
2411 /// The key for a mantissa that overflowed `i128`. The two
2412 /// representations of one value land on one key.
2413 #[must_use]
2414 pub fn from_big(b: &crate::bignum::BigNumeric) -> Self {
2415 let (neg, limbs, scale) = b.parts();
2416 Self::finite(neg, &digits_of_limbs(limbs), i32::from(scale))
2417 }
2418
2419 /// The `f64` this key means, for the one comparison PG defines that
2420 /// way: `numeric` against `float8` demotes the numeric.
2421 ///
2422 /// Lossy by construction — that is the point, and it is why nothing
2423 /// else uses it.
2424 #[must_use]
2425 #[allow(clippy::cast_precision_loss)]
2426 pub fn to_f64(&self) -> f64 {
2427 match self.class {
2428 NUM_CLASS_NAN => return f64::NAN,
2429 NUM_CLASS_POS_INF => return f64::INFINITY,
2430 NUM_CLASS_NEG_INF => return f64::NEG_INFINITY,
2431 _ => {}
2432 }
2433 if self.head == 0 {
2434 return 0.0;
2435 }
2436 // `head` is `d.ddd… × 10^36`; the value is that leading digit and
2437 // its followers at `exp`. The tail is below f64's resolution by
2438 // construction (it starts at the 38th significant digit).
2439 let mantissa = self.head as f64 / HEAD_SCALE as f64;
2440 let out = mantissa * pow10_f64(self.exp);
2441 if self.neg { -out } else { out }
2442 }
2443
2444 /// The significant decimal digits, most significant first — the form
2445 /// the catalog codec writes, and the one `from_parts` reads back.
2446 #[must_use]
2447 pub fn digits(&self) -> Vec<u8> {
2448 let mut out = Vec::new();
2449 if self.head != 0 {
2450 let mut h = self.head;
2451 for _ in 0..HEAD_DIGITS {
2452 let d = u8::try_from(h / HEAD_SCALE).unwrap_or(0);
2453 out.push(d);
2454 h = (h % HEAD_SCALE) * 10;
2455 }
2456 while out.last() == Some(&0) {
2457 out.pop();
2458 }
2459 }
2460 out.extend_from_slice(&self.tail);
2461 out
2462 }
2463
2464 /// The wire parts, for the catalog codec.
2465 #[must_use]
2466 pub fn parts(&self) -> (u8, bool, i32) {
2467 (self.class, self.neg, self.exp)
2468 }
2469
2470 /// Rebuild from the wire parts. Returns `None` on parts that are not
2471 /// canonical, so a corrupt catalog cannot smuggle in a key whose `Eq`
2472 /// and `Ord` disagree.
2473 #[must_use]
2474 pub fn from_parts(class: u8, neg: bool, exp: i32, digits: &[u8]) -> Option<Self> {
2475 if class > NUM_CLASS_NAN || digits.iter().any(|d| *d > 9) {
2476 return None;
2477 }
2478 if class != NUM_CLASS_FINITE && (neg || exp != 0 || !digits.is_empty()) {
2479 return None;
2480 }
2481 if digits.is_empty() {
2482 if neg || exp != 0 {
2483 return None;
2484 }
2485 return Some(Self::special(class));
2486 }
2487 if digits[0] == 0 || digits[digits.len() - 1] == 0 {
2488 return None;
2489 }
2490 Some(Self {
2491 class,
2492 neg,
2493 exp,
2494 head: head_of(digits),
2495 tail: digits.iter().skip(HEAD_DIGITS as usize).copied().collect(),
2496 })
2497 }
2498
2499 /// Canonicalize `(-1)^neg · <digits as an integer> · 10^-scale`.
2500 ///
2501 /// `digits` is most-significant-first and may carry leading and
2502 /// trailing zeros; both are stripped, which is what makes `1.5` and
2503 /// `1.50` land on the same key.
2504 fn finite(neg: bool, digits: &[u8], scale: i32) -> Self {
2505 let lead = digits.iter().position(|d| *d != 0).unwrap_or(digits.len());
2506 let digits = &digits[lead..];
2507 if digits.is_empty() {
2508 return Self::special(NUM_CLASS_FINITE);
2509 }
2510 // The leading digit's exponent, taken BEFORE trailing zeros go:
2511 // dropping low-order digits does not move the leading one.
2512 let exp = i32::try_from(digits.len()).unwrap_or(i32::MAX) - 1 - scale;
2513 let mut end = digits.len();
2514 while end > 0 && digits[end - 1] == 0 {
2515 end -= 1;
2516 }
2517 let digits = &digits[..end];
2518 Self {
2519 class: NUM_CLASS_FINITE,
2520 neg,
2521 exp,
2522 head: head_of(digits),
2523 tail: digits.iter().skip(HEAD_DIGITS as usize).copied().collect(),
2524 }
2525 }
2526
2527 fn special(class: u8) -> Self {
2528 Self {
2529 class,
2530 neg: false,
2531 exp: 0,
2532 head: 0,
2533 tail: Vec::new(),
2534 }
2535 }
2536}
2537
2538/// The first [`HEAD_DIGITS`] of `digits`, left-aligned so the leading one
2539/// sits at `10^36`.
2540fn head_of(digits: &[u8]) -> u128 {
2541 let mut head: u128 = 0;
2542 let take = (HEAD_DIGITS as usize).min(digits.len());
2543 for d in &digits[..take] {
2544 head = head * 10 + u128::from(*d);
2545 }
2546 for _ in take..HEAD_DIGITS as usize {
2547 head *= 10;
2548 }
2549 head
2550}
2551
2552/// Decimal digits of `mag` into `buf`, most significant first; returns how
2553/// many were written. Zero writes none.
2554///
2555/// r1040 — split at `u64` on purpose. A `u128` divide is a called routine,
2556/// not an instruction, and this loop runs once per digit per key.
2557fn digits_of_u128(mag: u128, buf: &mut [u8; 40]) -> usize {
2558 if mag == 0 {
2559 return 0;
2560 }
2561 let mut rev = [0u8; 40];
2562 let mut n = 0usize;
2563 let mut big = mag;
2564 // Peel nineteen digits at a time — the most a `u64` holds — so the
2565 // wide divide runs at most twice.
2566 while big > u128::from(u64::MAX) {
2567 let mut chunk = u64::try_from(big % 10_000_000_000_000_000_000_u128).unwrap_or(0);
2568 big /= 10_000_000_000_000_000_000_u128;
2569 for _ in 0..19 {
2570 rev[n] = u8::try_from(chunk % 10).unwrap_or(0);
2571 chunk /= 10;
2572 n += 1;
2573 }
2574 }
2575 let mut small = u64::try_from(big).unwrap_or(0);
2576 while small > 0 {
2577 rev[n] = u8::try_from(small % 10).unwrap_or(0);
2578 small /= 10;
2579 n += 1;
2580 }
2581 for i in 0..n {
2582 buf[i] = rev[n - 1 - i];
2583 }
2584 n
2585}
2586
2587/// Decimal digits of a base-10^9 little-endian limb vector, most
2588/// significant first. Every limb but the leading one is padded to its
2589/// full nine digits — that padding is the whole point, since a limb of 5
2590/// in the middle of a number means `000000005`.
2591fn digits_of_limbs(limbs: &[u32]) -> Vec<u8> {
2592 let mut out = Vec::new();
2593 let mut buf = [0u8; 40];
2594 for (i, limb) in limbs.iter().enumerate().rev() {
2595 let n = digits_of_u128(u128::from(*limb), &mut buf);
2596 if i + 1 == limbs.len() {
2597 out.extend_from_slice(&buf[..n]);
2598 } else {
2599 out.extend(core::iter::repeat_n(0u8, 9 - n));
2600 out.extend_from_slice(&buf[..n]);
2601 }
2602 }
2603 out
2604}
2605
2606/// `10^e` as an `f64`, for any `e` a canonical key can carry.
2607#[allow(clippy::cast_precision_loss)]
2608fn pow10_f64(e: i32) -> f64 {
2609 let mut out = 1.0_f64;
2610 let mag = e.unsigned_abs();
2611 for _ in 0..mag {
2612 out *= 10.0;
2613 }
2614 if e < 0 { 1.0 / out } else { out }
2615}
2616
2617impl Ord for NumericKey {
2618 fn cmp(&self, other: &Self) -> core::cmp::Ordering {
2619 use core::cmp::Ordering;
2620 if self.class != other.class {
2621 return self.class.cmp(&other.class);
2622 }
2623 if self.class != NUM_CLASS_FINITE {
2624 // Each of the three specials is a single value, and PG holds
2625 // `'NaN'::numeric = 'NaN'::numeric` true.
2626 return Ordering::Equal;
2627 }
2628 // Zero first: it is stored with `neg == false` and `exp == 0`, so
2629 // the magnitude comparison below would put it above every value
2630 // smaller than 1 rather than between the negatives and positives.
2631 match (self.head == 0, other.head == 0) {
2632 (true, true) => return Ordering::Equal,
2633 (true, false) => {
2634 return if other.neg {
2635 Ordering::Greater
2636 } else {
2637 Ordering::Less
2638 };
2639 }
2640 (false, true) => {
2641 return if self.neg {
2642 Ordering::Less
2643 } else {
2644 Ordering::Greater
2645 };
2646 }
2647 (false, false) => {}
2648 }
2649 match (self.neg, other.neg) {
2650 (false, true) => return Ordering::Greater,
2651 (true, false) => return Ordering::Less,
2652 _ => {}
2653 }
2654 // Same sign, both non-zero: more integer digits is bigger, and at
2655 // equal exponent the left-aligned heads compare as one integer —
2656 // the alignment is what makes that the same answer as comparing
2657 // the digit strings. The tail only speaks when the first 37
2658 // significant digits are identical.
2659 let mag = self
2660 .exp
2661 .cmp(&other.exp)
2662 .then_with(|| self.head.cmp(&other.head))
2663 .then_with(|| self.tail.cmp(&other.tail));
2664 if self.neg { mag.reverse() } else { mag }
2665 }
2666}
2667
2668impl PartialOrd for NumericKey {
2669 fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
2670 Some(self.cmp(other))
2671 }
2672}
2673
2674impl IndexKey {
2675 /// v7.37.43 (INSUBQ B-4) — inline-friendly BigInt fast path.
2676 /// `try_count_star_pk_in_subquery_fast` (and any other hot loop
2677 /// probing an integer PK) already holds an `i64`; this builds the
2678 /// `IndexKey` without going through the generic `from_value`
2679 /// dispatch tree.
2680 #[inline]
2681 pub fn from_i64(n: i64) -> Self {
2682 Self::Int(n)
2683 }
2684
2685 /// r1039 — the key a value takes when the INDEXED COLUMN is `ty`, or
2686 /// `None` when it takes none (→ the caller falls back to a scan).
2687 ///
2688 /// Every key under one index comes from one column, so they all live
2689 /// in one key SPACE. A probe built in a different space finds nothing
2690 /// — and "nothing" is indistinguishable from "no matching rows",
2691 /// which is how round 564 and r1037 both turned an index into a wrong
2692 /// answer (a TEXT key sought against a DATE-keyed and a UUID-keyed
2693 /// index).
2694 ///
2695 /// The two spaces this round adds make that trap reachable again from
2696 /// a new direction: `WHERE n = 2` on a NUMERIC column produces
2697 /// `Value::Int`, and an integer key would look in a space nothing
2698 /// lives in. So NUMERIC columns take integers by converting them
2699 /// exactly, and refuse anything they cannot convert; BYTEA columns
2700 /// take only `Value::Bytes`; and no other column may be keyed in
2701 /// either of the two new spaces.
2702 ///
2703 /// Use this wherever the key comes from a LITERAL or from another
2704 /// table's value. [`IndexKey::from_value`] stays right for building
2705 /// the index itself, where the value is the column's own.
2706 pub fn from_value_for_column(v: &Value<'_>, ty: DataType) -> Option<Self> {
2707 match ty {
2708 DataType::Numeric { .. } => match v {
2709 Value::SmallInt(n) => Some(Self::exact_int_key(i128::from(*n))),
2710 Value::Int(n) => Some(Self::exact_int_key(i128::from(*n))),
2711 Value::BigInt(n) => Some(Self::exact_int_key(i128::from(*n))),
2712 Value::Numeric { .. } | Value::NumericBig(_) => Self::from_value(v),
2713 // Float included: `2.0::float8` and `2.0::numeric` are not
2714 // the same value to a B-tree, and rounding one into the
2715 // other's space is how a seek reaches the wrong row.
2716 _ => None,
2717 },
2718 DataType::Bytes => match v {
2719 Value::Bytes(b) => Some(Self::Bytes(b.to_vec())),
2720 _ => None,
2721 },
2722 _ => match Self::from_value(v) {
2723 Some(Self::Numeric(_) | Self::Bytes(_)) => None,
2724 other => other,
2725 },
2726 }
2727 }
2728
2729 /// An integer as a NUMERIC key. Exact by construction — no scale, no
2730 /// rounding — which is why the conversion is allowed at all.
2731 fn exact_int_key(n: i128) -> Self {
2732 Self::Numeric(alloc::boxed::Box::new(NumericKey::from_i128(n)))
2733 }
2734
2735 pub fn from_value(v: &Value<'_>) -> Option<Self> {
2736 match v {
2737 // v7.37.43 (INSUBQ B-4) — BigInt hits first (the dominant
2738 // INSUBQ shape probes PK as BigInt). Tiny micro-win.
2739 Value::BigInt(n) => Some(Self::Int(*n)),
2740 Value::SmallInt(n) => Some(Self::Int(i64::from(*n))),
2741 Value::Int(n) => Some(Self::Int(i64::from(*n))),
2742 Value::Text(s) => Some(Self::Text(s.clone().into_owned())),
2743 // v7.38 (read01, T11) — bpchar keys compare blank-insensitively.
2744 Value::BpChar(s) => Some(Self::Text(s.trim_end_matches(' ').to_string())),
2745 Value::Bool(b) => Some(Self::Bool(*b)),
2746 // Date/Timestamp use their integer storage repr as the
2747 // index key — same order semantics, same comparison.
2748 Value::Date(d) => Some(Self::Int(i64::from(*d))),
2749 Value::Timestamp(t) => Some(Self::Int(*t)),
2750 // v7.17.0: UUID indexable via byte-wise ordering. Lookup
2751 // on `id = '...'::uuid` resolves through the secondary
2752 // index rather than full-scan.
2753 Value::Uuid(b) => Some(Self::Uuid(*b)),
2754 // v7.17.0 Phase 3.P0-32: TIME indexable via i64 — same
2755 // order semantics as Date/Timestamp.
2756 Value::Time(us) => Some(Self::Int(*us)),
2757 // v7.17.0 Phase 3.P0-33: YEAR indexable as i64 — u16
2758 // widens losslessly and gives the natural calendar
2759 // ordering.
2760 Value::Year(y) => Some(Self::Int(i64::from(*y))),
2761 // v7.17.0 Phase 3.P0-34: TIMETZ indexable by its
2762 // UTC-equivalent microseconds (local wall - offset).
2763 // Without normalising, two values for the same
2764 // physical instant in different zones would sort
2765 // wrong. Matches PG's TIMETZ index behaviour.
2766 Value::TimeTz { us, offset_secs } => {
2767 Some(Self::Int(us - i64::from(*offset_secs) * 1_000_000))
2768 }
2769 // v7.17.0 Phase 3.P0-35: MONEY indexable as i64 cents
2770 // (no scaling needed — natural numeric ordering).
2771 Value::Money(c) => Some(Self::Int(*c)),
2772 // v7.17.0 Phase 3.P0-38: ranges are NOT indexable in
2773 // v7.17.0 — they'd need a custom comparator (PG uses
2774 // SP-GiST for this). Skip.
2775 Value::Range { .. } => None,
2776 // v7.17.0 Phase 3.P0-39: hstore is NOT indexable in
2777 // v7.17.0 — map columns need GIN with bespoke ops.
2778 Value::Hstore(_) => None,
2779 // r1039 — exact decimals index through the canonical
2780 // [`NumericKey`], which is what makes `1.5` and `1.50` one key.
2781 Value::NumericBig(b) => Some(Self::Numeric(alloc::boxed::Box::new(NumericKey::from_big(b)))),
2782 Value::Numeric {
2783 scaled,
2784 scale,
2785 kind,
2786 } => Some(Self::Numeric(alloc::boxed::Box::new(
2787 NumericKey::from_numeric(*scaled, *scale, *kind),
2788 ))),
2789 // r1039 — bytea orders by plain byte comparison, which is
2790 // `Vec<u8>`'s own.
2791 Value::Bytes(b) => Some(Self::Bytes(b.to_vec())),
2792 // v7.17.0 Phase 3.P0-40: 2D arrays aren't indexable.
2793 Value::IntArray2D(_)
2794 | Value::BigIntArray2D(_)
2795 | Value::TextArray2D(_)
2796 | Value::BoolArray2D(_) => None,
2797 // v7.37.5 β-P4: INTERVAL[] isn't indexable (PG uses
2798 // GIN/intarray for array-contains queries; SPG plans
2799 // that as a separate axis under v7.37.8 GIN-on-jsonb).
2800 Value::IntervalArray(_) => None,
2801 // v7.37.5 γ — none of the array-of-scalar family is
2802 // B-tree indexable. Same reason as IntervalArray: PG
2803 // serves array-contains / array-overlap queries via
2804 // GIN, and SPG's GIN axis lands in v7.37.8.
2805 Value::BoolArray(_)
2806 | Value::SmallIntArray(_)
2807 | Value::FloatArray(_)
2808 | Value::NumericArray(_)
2809 | Value::DateArray(_)
2810 | Value::TimestampArray(_)
2811 | Value::TimestamptzArray(_)
2812 | Value::UuidArray(_)
2813 | Value::JsonArray(_)
2814 | Value::JsonbArray(_)
2815 | Value::BytesArray(_)
2816 | Value::VarcharArray(_)
2817 | Value::CharArray(_)
2818 // v7.37.5 δ — multirange not indexable (PG uses GiST/
2819 // SP-GiST + a custom operator class; SPG plans the same
2820 // axis under v7.37.8 with ranges).
2821 | Value::Multirange { .. }
2822 // v7.37.5 ε — geometric scalars not B-tree indexable
2823 // (PG uses GiST/SP-GiST for these too; SPG plans the
2824 // same axis under v7.37.8).
2825 | Value::Point(_)
2826 | Value::Lseg(_, _)
2827 | Value::Path { .. }
2828 | Value::PgBox(_, _)
2829 | Value::Polygon(_)
2830 | Value::Line { .. }
2831 | Value::Circle { .. }
2832 // v7.37.5 ζ-A — network / bit / xml / "char" / money[].
2833 // INET / CIDR / MACADDR / MACADDR8 could be B-tree
2834 // indexable (PG does this), but the byte-wise compare
2835 // family-blind would mis-order IPv4 vs IPv6; left as
2836 // a follow-up under v7.37.8 GIN window.
2837 | Value::Inet { .. }
2838 | Value::Cidr { .. }
2839 | Value::Macaddr(_)
2840 | Value::Macaddr8(_)
2841 | Value::PgLsn(_)
2842 | Value::BitString { .. }
2843 | Value::Xml(_)
2844 | Value::Char1(_)
2845 | Value::MoneyArray(_)
2846 | Value::Composite(_)
2847 | Value::Tid(..)
2848 | Value::Xid(_)
2849 | Value::Cid(_)
2850 | Value::RegClass(..)
2851 | Value::RegProc(..)
2852 | Value::RegType(..) => None,
2853 // Interval isn't index-eligible (and can't reach this path
2854 // through column storage anyway). Float / Real stay out
2855 // because `f64` is only `PartialOrd`.
2856 Value::Null
2857 | Value::Float(_)
2858 | Value::Vector(_)
2859 | Value::Sq8Vector(_)
2860 | Value::HalfVector(_)
2861 | Value::Interval { .. }
2862 | Value::Json(_)
2863 | Value::TextArray(_)
2864 | Value::IntArray(_)
2865 | Value::BigIntArray(_)
2866 | Value::TsVector(_)
2867 | Value::TsQuery(_)
2868 | Value::Real(_) => None,
2869 }
2870 }
2871}
2872
2873/// A single-column secondary index. v2.0 carries either a B-tree map
2874/// (the default — used for equality / range lookups on scalar columns)
2875/// or a navigable-small-world graph (used for kNN over vector
2876/// columns).
2877#[derive(Debug, Clone)]
2878pub struct Index {
2879 pub name: String,
2880 pub column_position: usize,
2881 pub kind: IndexKind,
2882 /// v6.8.0 — column positions of `INCLUDE (col1, col2, …)`
2883 /// non-key columns. Carries the planner's "this query is
2884 /// covered by the index" signal; lookup paths still resolve
2885 /// via the `RowLocator` to fetch the row body, but EXPLAIN
2886 /// surfaces the covered-scan annotation so operators can
2887 /// confirm the planner sees the coverage.
2888 ///
2889 /// Empty `Vec` = no `INCLUDE` clause (the legacy shape). v12
2890 /// catalog snapshots deserialise with an empty vec.
2891 pub included_columns: Vec<usize>,
2892 /// v6.8.1 — partial-index predicate stored as its canonical
2893 /// Display form (the engine re-parses it on the maintenance
2894 /// path). `None` = unconditional index (the legacy shape).
2895 /// Persisted as `[u8 has_pred][u16 LE len][bytes]` on the
2896 /// catalog snapshot (FILE_VERSION 12, appended after
2897 /// `included_columns`).
2898 pub partial_predicate: Option<String>,
2899 /// v6.8.2 — expression-index key, stored as the expression's
2900 /// canonical Display form. `None` = bare column-reference
2901 /// index (the legacy shape). Persisted alongside
2902 /// `partial_predicate` on the v12 catalog snapshot.
2903 pub expression: Option<String>,
2904 /// v7.39 (read01 round 52) — `CREATE UNIQUE INDEX … NULLS NOT DISTINCT`
2905 /// (PG 15+): a NULL in the key no longer exempts the row, so two
2906 /// all-NULL keys collide. Default `false` = SQL-standard NULLS DISTINCT.
2907 /// Persisted in the index appendix (FILE_VERSION 62+); older catalogs
2908 /// deserialise with `false`.
2909 pub nulls_not_distinct: bool,
2910 /// v7.39 (round 537) — the key column's ordering clause, as written.
2911 ///
2912 /// SPG's index does not scan in a direction, so this changes no
2913 /// lookup; `pg_indexes.indexdef` is a reproduction of the DDL and
2914 /// dropping the clause made `CREATE INDEX i ON t (a DESC NULLS
2915 /// LAST)` read back as `(a)` — a dump lost it and a schema diff saw
2916 /// drift every run. `nulls_first` is `None` when the statement did
2917 /// not say, in which case PG's default applies and neither word is
2918 /// rendered.
2919 pub descending: bool,
2920 pub nulls_first: Option<bool>,
2921 /// v7.39 (round 538) — an explicit `COLLATE` on the key, as written.
2922 /// SPG orders text by bytes, so it changes no comparison; PG prints
2923 /// it because a named collation and an inherited one are different
2924 /// objects even where they sort identically.
2925 pub collation: Option<String>,
2926 /// v7.9.29 — `CREATE UNIQUE INDEX …`. When true the engine
2927 /// rejects INSERTs whose key already appears in this index
2928 /// (combined with `partial_predicate` when present — only
2929 /// rows matching the predicate enter the uniqueness check).
2930 /// Catalog FILE_VERSION 16+; older snapshots deserialise
2931 /// with `false`. mailrs K1.
2932 pub is_unique: bool,
2933 /// v7.9.29 — extra (non-leading) column positions for
2934 /// multi-column indexes (`CREATE INDEX … (a, b, c)`). The
2935 /// planner today still only uses the leading
2936 /// `column_position` for index seeks, but UNIQUE INDEX
2937 /// enforcement walks the full tuple so partial-unique
2938 /// invariants like CalDAV `(calendar_id, uid,
2939 /// recurrence_id)` are enforced correctly. Catalog
2940 /// FILE_VERSION 16+; older snapshots deserialise empty.
2941 pub extra_column_positions: Vec<usize>,
2942}
2943
2944/// Default neighbor degree (M) for the NSW graph. Picked at construction
2945/// time and persisted with the index.
2946pub const NSW_DEFAULT_M: usize = 16;
2947
2948/// v5.2.2: outcome of a successful [`Catalog::freeze_oldest_to_cold`]
2949/// call. The catalog state has already been mutated by the time this
2950/// is returned (hot rows dropped + segment registered + Cold locators
2951/// flipped). The caller's only remaining concern is `segment_bytes` —
2952/// persist them to disk under `<db>.spg/segments/seg_<id>.spg` so a
2953/// future restart can reload via the v5.1 `SPG_PRELOAD_COLD_SEGMENT`
2954/// path. (v5.3's manifest will subsume this manual step.)
2955#[derive(Debug, Clone)]
2956pub struct FreezeReport {
2957 /// Id allocated by [`Catalog::load_segment_bytes`] for the new
2958 /// cold-tier segment. Stable across the call's success path.
2959 pub segment_id: u32,
2960 /// Number of rows that moved hot → cold. Equals the `max_rows`
2961 /// the caller asked for (the API is strict on the count).
2962 pub frozen_rows: usize,
2963 /// Hot-tier bytes reclaimed by the freeze — the
2964 /// [`Table::hot_bytes`] delta before vs after. Useful to feed
2965 /// back into the freezer's budget check on the next tick.
2966 pub bytes_freed: u64,
2967 /// Encoded segment bytes, byte-identical to what
2968 /// [`encode_segment`] produced. The catalog already owns a
2969 /// copy inside `cold_segments`; this hand-off lets the caller
2970 /// persist them without re-encoding.
2971 pub segment_bytes: Vec<u8>,
2972}
2973
2974/// v6.7.4 — read-only output of [`Catalog::prepare_freeze_slice`].
2975/// Carries every row body + key in a contiguous hot-row range,
2976/// already encoded and sorted by PK so the coordinator's merge
2977/// step is a k-way merge over already-sorted streams.
2978///
2979/// `Vec<FreezeSlice>` from N independent workers feeds
2980/// [`Catalog::commit_freeze_slices`], which concats + encodes the
2981/// merged segment + atomically swaps the catalog state.
2982#[derive(Debug, Clone)]
2983pub struct FreezeSlice {
2984 /// Hot-row index range this slice covered (half-open, in the
2985 /// table's `rows: PersistentVec` ordering at call time). The
2986 /// commit step uses this to compute the union range that
2987 /// gets passed to [`Table::delete_rows`].
2988 pub row_range: core::ops::Range<usize>,
2989 /// `(pk_u64, encoded_row_body, IndexKey)` triples, sorted
2990 /// ascending by `pk_u64`. Per-slice sort happens inside
2991 /// `prepare_freeze_slice`; the coordinator does only a
2992 /// k-way merge to reach the global PK ordering
2993 /// [`encode_segment`] requires.
2994 pub rows: Vec<(u64, Vec<u8>, IndexKey)>,
2995}
2996
2997/// v6.7.3 — outcome of a [`Catalog::compact_cold_segments`] call.
2998/// The catalog state has already been mutated when this is returned:
2999/// the merged segment is loaded into `cold_segments`, the source
3000/// segment slots are tombstoned (`None`), and every BTree-index
3001/// `RowLocator::Cold` that previously pointed at a source now
3002/// points at the merged segment. The caller's remaining job is to
3003/// persist `merged_segment_bytes` under
3004/// `<db>.spg/segments/seg_<merged_segment_id>.spg` and update the
3005/// in-memory `segment_id → path` map (remove the source ids, add
3006/// the merged id) so the next CHECKPOINT writes a manifest that
3007/// no longer lists the retired sources.
3008///
3009/// On a no-op (fewer than 2 candidate segments under the threshold),
3010/// `merged_segment_id` is `None` and `sources` is empty; the
3011/// catalog was not mutated.
3012#[derive(Debug, Clone)]
3013pub struct CompactReport {
3014 /// Source segment ids that were merged + tombstoned.
3015 pub sources: Vec<u32>,
3016 /// Id allocated for the merged segment. `None` on no-op.
3017 pub merged_segment_id: Option<u32>,
3018 /// Encoded merged-segment bytes (empty on no-op).
3019 pub merged_segment_bytes: Vec<u8>,
3020 /// Number of rows that landed in the merged segment.
3021 pub merged_rows: usize,
3022 /// `Σ source.num_rows − merged_rows`. Rows present in source
3023 /// segment payloads but unreferenced by any live BTree
3024 /// `Cold` locator — DELETE'd-but-still-frozen rows that
3025 /// compaction GC'd during the merge.
3026 pub deleted_rows_pruned: usize,
3027 /// `Σ source.bytes() − merged.bytes()`. Estimate of on-disk
3028 /// space the merge will reclaim once the source segment files
3029 /// are GC'd. Saturating subtract — never negative.
3030 pub bytes_reclaimed_estimate: u64,
3031}
3032
3033#[derive(Debug, Clone)]
3034pub enum IndexKind {
3035 /// v4.40: structural-sharing B-tree over `IndexKey`. Replaces the v0.8
3036 /// `BTreeMap<IndexKey, Vec<usize>>` — `Index::clone` is now an `Arc`
3037 /// bump regardless of index size, so `Catalog::clone` inside the
3038 /// v4.34 auto-commit wrap stays O(1) even for tables with secondary
3039 /// indices (the case that bottlenecked v4.39 at 1M rows in the
3040 /// sweep).
3041 ///
3042 /// v5.1: value type widened from `Vec<usize>` to `Vec<RowLocator>` so
3043 /// a single key can point to a mix of hot-tier rows (`RowLocator::Hot`,
3044 /// equivalent to the pre-v5 `usize` row index) and cold-tier rows
3045 /// (`RowLocator::Cold { segment_id, page_offset }`) once the v5.2
3046 /// freezer starts producing them. Pre-v5.2 only `Hot` entries appear
3047 /// — the on-disk encoding stays at `FILE_VERSION` 8 (raw u64 row index)
3048 /// because every locator round-trips through `RowLocator::from_legacy_v8_u64`
3049 /// without information loss. `FILE_VERSION` 9 with tagged encoding lands
3050 /// alongside the first freezer commit (v5.1 step 2b / v5.2).
3051 BTree(PersistentBTreeMap<IndexKey, crate::posting::PostingList>),
3052 /// Navigable-small-world graph for vector kNN search.
3053 Nsw(NswGraph),
3054 /// v6.7.1 — BRIN (Block Range INdex). Pure metadata: BRIN
3055 /// indexes carry NO in-memory key→locator map. The (min,
3056 /// max) summaries live in each cold-tier segment's v2
3057 /// envelope sidecar; the BRIN entry in `Table.indices` only
3058 /// records THAT a BRIN index exists on this column so the
3059 /// segment encoder + planner can opt into the summary path.
3060 Brin {
3061 /// The cell type at `column_position` at CREATE INDEX time.
3062 /// Used by the planner to type-check WHERE-clause range
3063 /// predicates against the BRIN-indexed column.
3064 column_type: DataType,
3065 /// v7.38.11 — one `(min, max)` per [`BRIN_RANGE_ROWS`] slots of
3066 /// the hot tier, so a range predicate can skip the ranges that
3067 /// cannot contain a match.
3068 ///
3069 /// Maintenance is WIDEN-ONLY and that is the whole safety
3070 /// argument: an insert widens its range, an update widens, and
3071 /// a delete leaves the range alone. A range left wider than the
3072 /// rows it now covers is correct and merely less selective —
3073 /// which is exactly PG's contract for a lossy index, since the
3074 /// predicate is re-checked on every row the summary lets
3075 /// through. A summary may over-report; it can never
3076 /// under-report, so no matching row can be skipped.
3077 ///
3078 /// `None` for a range whose rows carry no comparable key (all
3079 /// NULL, say), and such a range is never skipped.
3080 summaries: alloc::vec::Vec<Option<(i64, i64)>>,
3081 },
3082 /// v7.12.3 — GIN inverted index over a `tsvector` column.
3083 ///
3084 /// Storage shape: `lexeme word → Vec<RowLocator>`. The posting
3085 /// list per word is appended in row-order, so range scans are
3086 /// O(matching rows) once the per-word lookup is done. Multi-
3087 /// term queries intersect / union posting lists.
3088 ///
3089 /// `IndexKey::from_value(TsVector)` returns `None` — GIN doesn't
3090 /// participate in `try_index_seek` (which is BTree-equality-keyed).
3091 /// The engine consults this index through `try_gin_lookup` on
3092 /// `WHERE col @@ tsquery` predicates instead.
3093 ///
3094 /// Backed by a `PersistentBTreeMap` so `Catalog::clone` (the
3095 /// per-write snapshot) stays O(1) — same structural-sharing
3096 /// invariant as BTree.
3097 Gin(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3098 /// v7.15.0 — `USING gin (col gin_trgm_ops)` over a `TEXT`
3099 /// column. Posting lists map `trigram` (PG-compatible 3-byte
3100 /// shingle on the lower-cased + space-padded input) to row
3101 /// locators. The planner uses this index to accelerate
3102 /// `WHERE col LIKE '…'` / `ILIKE '…'` / `similarity(col, q) >
3103 /// t` — every literal run of length ≥ 1 in the pattern
3104 /// produces a trigram set, the engine intersects the posting
3105 /// lists, and the LIKE / similarity predicate is re-evaluated
3106 /// per candidate row to filter the over-approximation.
3107 /// Persisted via tag-4 index payload in `FILE_VERSION` 24+.
3108 GinTrgm(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3109 /// v7.17.0 Phase 2.2 — MySQL `FULLTEXT KEY (col)` over a
3110 /// `TEXT` / `VARCHAR` column. Posting lists map
3111 /// `tsvector('simple') lexeme` to row locators. At insert /
3112 /// build time the engine derives the lexemes from the cell
3113 /// via the same lower-case tokenisation rule as
3114 /// `to_tsvector('simple', ...)` — the column itself stays a
3115 /// plain text type on disk (mysqldump round-trips would be
3116 /// broken otherwise). The planner uses this index to
3117 /// accelerate MySQL-shape `MATCH(col) AGAINST('term')`
3118 /// queries by mapping them onto the existing tsquery `@@`
3119 /// walker. Persisted via tag-5 index payload in
3120 /// `FILE_VERSION` 33+.
3121 GinFulltext(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3122 /// v7.37.8(sentori Epic 5 P2)— `USING gin (col)` over a
3123 /// `JSON` / `JSONB` column. Posting lists map a canonical
3124 /// `(path, leaf)` token(see [`crate::jsonb_gin::extract_tokens`])
3125 /// to row locators so the planner can resolve
3126 /// `<col> @> <jsonb_literal>` to a candidate row set via
3127 /// posting-list intersection + per-row `json::contains`
3128 /// re-verification. Pre-7.37.8 the same DDL loaded as a
3129 /// BTree fallback so `pg_dump` JSONB-GIN scripts kept loading
3130 /// without query-time acceleration. Persisted via tag-6 index
3131 /// payload in `FILE_VERSION` 51+.
3132 GinJsonb(PersistentBTreeMap<alloc::string::String, crate::posting::PostingList>),
3133 /// v7.38.1 (L12) — a REAL multi-column B-tree: the key is the whole
3134 /// column tuple, `[leading, extras…]`, ordered lexicographically by
3135 /// slice `Ord`. That ordering is the entire design: every key
3136 /// sharing a prefix is contiguous, so an equality on a PREFIX of
3137 /// the columns is one `O(log N)` descent plus a bounded walk, and a
3138 /// full-tuple equality is a point `get`. The single-column `BTree`
3139 /// kind used to stand in for multi-column DDL by keying on the
3140 /// leading column only and carrying the rest as metadata — TPC-C's
3141 /// `customer (c_w_id, c_d_id, c_last, c_first)` then answered a
3142 /// three-column equality with every row of one warehouse and a
3143 /// per-row filter over 30 000 candidates.
3144 ///
3145 /// Rows where any component column is NULL (or of an unkeyable
3146 /// type) are NOT entered: this index serves `=` probes, and in SQL
3147 /// `col = v` never selects a NULL. Uniqueness keeps its own
3148 /// full-tuple walk with NULLS-DISTINCT semantics on the
3149 /// enforcement path, exactly as before.
3150 ///
3151 /// Persisted via tag-7 index payload in `FILE_VERSION` 91+.
3152 BTreeMulti(PersistentBTreeMap<alloc::boxed::Box<[IndexKey]>, crate::posting::PostingList>),
3153}
3154
3155impl IndexKind {
3156 /// v7.31 (memory campaign, C2) — bytes this index variant holds
3157 /// resident in RAM, computed by walking its OWN structure rather
3158 /// than a parametric guess made by the engine. Replaces the old
3159 /// `spg_admin::memory_stats` inline match, which charged NSW with
3160 /// a stale `m_max_0 * 8` per node (neighbour slots are `u32` = 4 B
3161 /// since v6.1.x, and most nodes never fill `m_max_0`) and lumped
3162 /// every GIN family index into a flat 1 KiB token — a gross
3163 /// undercount for the text-heavy posting lists that dominate
3164 /// mailrs' footprint. Per-entry container overhead uses the
3165 /// 3-word (24 B on 64-bit) `Vec`/`String` header as the charge.
3166 ///
3167 /// O(index entries): operator/monitoring surface (`memory_stats` /
3168 /// `spg_memory_stats`), not a query path.
3169 #[must_use]
3170 pub fn approx_resident_bytes(&self) -> u64 {
3171 const HEADER: usize = 24; // Vec/String 3-word header on 64-bit.
3172 let loc = core::mem::size_of::<RowLocator>();
3173 match self {
3174 IndexKind::BTree(map) => {
3175 let key = core::mem::size_of::<IndexKey>();
3176 map.iter()
3177 .map(|(_, locs)| (key + HEADER + locs.len() * loc) as u64)
3178 .sum()
3179 }
3180 // v7.38.1 (L12) — multi keys own a boxed slice of components.
3181 IndexKind::BTreeMulti(map) => {
3182 let key = core::mem::size_of::<IndexKey>();
3183 map.iter()
3184 .map(|(k, locs)| (HEADER + k.len() * key + HEADER + locs.len() * loc) as u64)
3185 .sum()
3186 }
3187 IndexKind::Nsw(g) => {
3188 // `levels` is one byte per node; each layer's adjacency
3189 // is a `Vec<u32>` per node whose actual length we walk
3190 // (the dense layer-0 list dominates, but upper layers
3191 // are sparse — the old estimate ignored that).
3192 let mut b = g.levels.len() as u64;
3193 for layer in &g.layers {
3194 for nbrs in layer.iter() {
3195 b += (HEADER + nbrs.len() * core::mem::size_of::<u32>()) as u64;
3196 }
3197 }
3198 b
3199 }
3200 // BRIN carries NO in-memory key→locator map (the (min,max)
3201 // summaries live in cold-segment sidecars on disk); the
3202 // resident footprint is just the column-type token.
3203 IndexKind::Brin { .. } => core::mem::size_of::<DataType>() as u64,
3204 IndexKind::Gin(map)
3205 | IndexKind::GinTrgm(map)
3206 | IndexKind::GinFulltext(map)
3207 | IndexKind::GinJsonb(map) => map
3208 .iter()
3209 .map(|(word, postings)| {
3210 (word.len() + HEADER + HEADER + postings.len() * loc) as u64
3211 })
3212 .sum(),
3213 }
3214 }
3215}
3216
3217/// Multi-layer HNSW graph (v2.13). Each node is assigned a `top_level`;
3218/// it appears in layers `0..=top_level`. Higher layers are sparser, so
3219/// search starts from the entry at the top layer, greedy-descends to
3220/// layer 0, and beam-searches there. Layer 0 keeps a larger neighbour
3221/// budget (`m_max_0 = 2 * m` per the HNSW paper); upper layers cap at
3222/// `m`. The struct name stays `NswGraph` so external users / on-disk
3223/// callers don't have to track a rename — the algorithm changed, the
3224/// data slot didn't.
3225#[derive(Debug, Clone)]
3226pub struct NswGraph {
3227 /// Max neighbours per node on layers ≥ 1.
3228 pub m: usize,
3229 /// Max neighbours on layer 0 (the dense bottom layer). HNSW
3230 /// convention: `m_max_0 = 2 * m`.
3231 pub m_max_0: usize,
3232 /// Entry point — the node that sits on the topmost layer. Search
3233 /// always starts here.
3234 pub entry: Option<usize>,
3235 /// Top layer of the entry node (== `layers.len() - 1` when populated).
3236 pub entry_level: u8,
3237 /// `levels[i]` = top layer of node `i`. Nodes whose vector cell is
3238 /// NULL / non-Vector have `levels[i] = 0` and no neighbour entries.
3239 ///
3240 /// v5.5.0: backed by `PersistentVec` so `NswGraph::clone` (and the
3241 /// `Catalog::clone` on every group-commit write that contains it) is O(1)
3242 /// structural-sharing instead of an O(N) element copy.
3243 pub levels: PersistentVec<u8>,
3244 /// `layers[l][i]` = neighbours of node `i` at layer `l`. Inner vec
3245 /// is empty when node `i` doesn't reach layer `l`.
3246 ///
3247 /// v5.5.0: the per-node middle dimension (the O(N) one) is a
3248 /// `PersistentVec`; the outer layer dimension stays a plain `Vec`
3249 /// (layer count ≤ 8, so its clone is O(1) in practice) and the inner
3250 /// neighbour list stays a `Vec` (bounded by `m_max_0`).
3251 ///
3252 /// v6.1.x: neighbour slot widened from `usize` (8 B on 64-bit) to
3253 /// `u32` (4 B). Row indices are catalog-bounded by `u32::MAX` (4G
3254 /// rows per table); the cast at the NSW boundary asserts this. At
3255 /// 1M dim-128 SQ8, layer 0 adjacency alone shrinks by ~128 MiB
3256 /// — the largest single contribution to the v6.0.5-measured
3257 /// 624 MiB ambition gap. On-disk format already used u32 LE, so
3258 /// this is a pure in-memory layout change; no `FILE_VERSION` bump.
3259 pub layers: Vec<PersistentVec<Vec<u32>>>,
3260}
3261
3262impl NswGraph {
3263 fn new(m: usize) -> Self {
3264 Self {
3265 m,
3266 m_max_0: m.saturating_mul(2),
3267 entry: None,
3268 entry_level: 0,
3269 levels: PersistentVec::new(),
3270 layers: alloc::vec![PersistentVec::new()],
3271 }
3272 }
3273
3274 /// Max-neighbour budget for layer `l`.
3275 pub const fn cap_for_layer(&self, layer: u8) -> usize {
3276 if layer == 0 { self.m_max_0 } else { self.m }
3277 }
3278}
3279
3280/// Deterministic level assignment, seeded on the row index so the same
3281/// insert order reproduces the same topology. Distribution is roughly
3282/// HNSW-flavoured with `mL ≈ 1/ln(M) ≈ 0.36` for M=16: each 4-bit
3283/// chunk that comes up zero promotes the node one layer (so P(level ≥
3284/// L) ≈ (1/16)^L).
3285#[allow(clippy::verbose_bit_mask)] // clippy suggests trailing_zeros(); we need an explicit MAX cap and a stable distribution shape.
3286pub fn nsw_assign_level(row_idx: usize) -> u8 {
3287 const MAX_LEVEL: u8 = 7; // 7 ⇒ ~16^7 ≈ 2.7e8 expected nodes between promotions; ample.
3288 // SplitMix-style mixer — cheap and seedable.
3289 let mut x = (row_idx as u64).wrapping_mul(0x9E37_79B9_7F4A_7C15);
3290 x ^= x >> 30;
3291 x = x.wrapping_mul(0xBF58_476D_1CE4_E5B9);
3292 x ^= x >> 27;
3293 x = x.wrapping_mul(0x94D0_49BB_1331_11EB);
3294 x ^= x >> 31;
3295 // Count contiguous low-end zero nibbles (4-bit chunks). Each zero
3296 // nibble has probability 1/16, mirroring HNSW's `mL ≈ 1/ln(M)` for
3297 // M=16. `trailing_zeros / 4` would lose the ordering when x = 0, so
3298 // a plain loop with a cap is clearer.
3299 let mut level: u8 = 0;
3300 while x & 0xF == 0 && level < MAX_LEVEL {
3301 level += 1;
3302 x >>= 4;
3303 }
3304 level
3305}
3306
3307/// v7.38.1 (L12) — the composite key `values` takes in a multi-column
3308/// B-tree over `[lead, extras…]`. A NULL component keys as
3309/// [`IndexKey::Null`] (declared to sort last, PG's NULLS LAST) so the
3310/// row stays findable by prefix probes on the columns before it. `None`
3311/// = some non-null component has no key form; the row is then not
3312/// entered, which is why creation gates every component column's type
3313/// through [`multi_component_type_ok`].
3314pub(crate) fn compose_multi_key(
3315 values: &[Value<'_>],
3316 lead: usize,
3317 extras: &[usize],
3318) -> Option<alloc::boxed::Box<[IndexKey]>> {
3319 let mut comps: Vec<IndexKey> = Vec::with_capacity(1 + extras.len());
3320 for pos in core::iter::once(lead).chain(extras.iter().copied()) {
3321 let v = values.get(pos)?;
3322 if matches!(v, Value::Null) {
3323 comps.push(IndexKey::Null);
3324 } else {
3325 comps.push(IndexKey::from_value(v)?);
3326 }
3327 }
3328 Some(comps.into_boxed_slice())
3329}
3330
3331/// v7.38.1 (L12) — component-type gate for multi-column B-trees: every
3332/// NON-NULL value of these types keys through `IndexKey::from_value`,
3333/// so a row can only be absent from the index when creation raced a
3334/// type this list does not name. Deliberately conservative — a type
3335/// outside the list simply keeps its index on the leading-column path.
3336pub(crate) fn multi_component_type_ok(ty: DataType) -> bool {
3337 matches!(
3338 ty,
3339 DataType::SmallInt
3340 | DataType::Int
3341 | DataType::BigInt
3342 | DataType::Text
3343 | DataType::Varchar(_)
3344 | DataType::Char(_)
3345 | DataType::Bool
3346 | DataType::Uuid
3347 | DataType::Date
3348 | DataType::Timestamp
3349 )
3350}
3351
3352impl Index {
3353 /// Any key this B-tree currently holds, or `None` if it holds none.
3354 ///
3355 /// A probe built from a query literal has to be the same SHAPE as the
3356 /// keys the maintenance side made, or `lookup_eq` misses every row and
3357 /// the caller reads the empty answer as "no rows match". One stored
3358 /// key settles it: an index keys one expression, whose values are one
3359 /// type.
3360 pub fn sample_key(&self) -> Option<&IndexKey> {
3361 match &self.kind {
3362 IndexKind::BTree(map) => map.iter().next().map(|(k, _)| k),
3363 _ => None,
3364 }
3365 }
3366
3367 fn new_btree(name: String, column_position: usize) -> Self {
3368 Self {
3369 name,
3370 column_position,
3371 kind: IndexKind::BTree(PersistentBTreeMap::new()),
3372 included_columns: Vec::new(),
3373 partial_predicate: None,
3374 expression: None,
3375 is_unique: false,
3376 nulls_not_distinct: false,
3377 descending: false,
3378 nulls_first: None,
3379 collation: None,
3380 extra_column_positions: Vec::new(),
3381 }
3382 }
3383
3384 /// v7.38.1 (L12) — a real multi-column B-tree shell. The caller
3385 /// sets `extra_column_positions` before the first row enters; the
3386 /// key arity is `1 + extras` from then on.
3387 fn new_btree_multi(name: String, column_position: usize) -> Self {
3388 Self {
3389 kind: IndexKind::BTreeMulti(PersistentBTreeMap::new()),
3390 ..Self::new_btree(name, column_position)
3391 }
3392 }
3393
3394 /// v7.38.1 (L12) — the composite key this row takes in a
3395 /// [`IndexKind::BTreeMulti`] index. NULL components key as
3396 /// [`IndexKey::Null`] so prefix probes still find the row; `None`
3397 /// only when a non-null component produces no key, which creation's
3398 /// component-type gate makes unreachable for well-formed indexes.
3399 pub fn multi_key_for_row(&self, values: &[Value<'_>]) -> Option<alloc::boxed::Box<[IndexKey]>> {
3400 compose_multi_key(values, self.column_position, &self.extra_column_positions)
3401 }
3402
3403 fn new_nsw(name: String, column_position: usize, m: usize) -> Self {
3404 Self {
3405 name,
3406 column_position,
3407 kind: IndexKind::Nsw(NswGraph::new(m)),
3408 included_columns: Vec::new(),
3409 partial_predicate: None,
3410 expression: None,
3411 is_unique: false,
3412 nulls_not_distinct: false,
3413 descending: false,
3414 nulls_first: None,
3415 collation: None,
3416 extra_column_positions: Vec::new(),
3417 }
3418 }
3419
3420 /// v6.7.1 — BRIN index constructor. BRIN carries no in-memory
3421 /// data; the `column_type` snapshot is used by the segment
3422 /// encoder + planner for type-checking range predicates.
3423 fn new_brin(name: String, column_position: usize, column_type: DataType) -> Self {
3424 Self {
3425 name,
3426 column_position,
3427 kind: IndexKind::Brin {
3428 column_type,
3429 summaries: alloc::vec::Vec::new(),
3430 },
3431 included_columns: Vec::new(),
3432 partial_predicate: None,
3433 expression: None,
3434 is_unique: false,
3435 nulls_not_distinct: false,
3436 descending: false,
3437 nulls_first: None,
3438 collation: None,
3439 extra_column_positions: Vec::new(),
3440 }
3441 }
3442
3443 /// v7.12.3 — GIN inverted-index constructor. Empty posting-list
3444 /// map; caller (typically [`Table::add_gin_index`] or
3445 /// [`Table::restore_gin_index`]) populates it from existing rows
3446 /// or from a deserialised snapshot.
3447 fn new_gin(name: String, column_position: usize) -> Self {
3448 Self {
3449 name,
3450 column_position,
3451 kind: IndexKind::Gin(PersistentBTreeMap::new()),
3452 included_columns: Vec::new(),
3453 partial_predicate: None,
3454 expression: None,
3455 is_unique: false,
3456 nulls_not_distinct: false,
3457 descending: false,
3458 nulls_first: None,
3459 collation: None,
3460 extra_column_positions: Vec::new(),
3461 }
3462 }
3463
3464 /// v7.15.0 — `gin_trgm_ops`-flavoured GIN constructor. Same
3465 /// shape as `new_gin` but the posting-list keys are 3-byte
3466 /// trigram shingles (`pg_trgm`-compatible) and the column
3467 /// type is `TEXT` / `VARCHAR` (not `TSVECTOR`).
3468 fn new_gin_trgm(name: String, column_position: usize) -> Self {
3469 Self {
3470 name,
3471 column_position,
3472 kind: IndexKind::GinTrgm(PersistentBTreeMap::new()),
3473 included_columns: Vec::new(),
3474 partial_predicate: None,
3475 expression: None,
3476 is_unique: false,
3477 nulls_not_distinct: false,
3478 descending: false,
3479 nulls_first: None,
3480 collation: None,
3481 extra_column_positions: Vec::new(),
3482 }
3483 }
3484
3485 /// v7.17.0 Phase 2.2 — MySQL `FULLTEXT KEY` GIN constructor.
3486 /// Same shape as `new_gin_trgm` but the posting-list keys
3487 /// are lower-cased word lexemes (`to_tsvector('simple', col)`
3488 /// equivalent) instead of trigrams, and the column type is
3489 /// `TEXT` / `VARCHAR` (not `TSVECTOR`).
3490 fn new_gin_fulltext(name: String, column_position: usize) -> Self {
3491 Self {
3492 name,
3493 column_position,
3494 kind: IndexKind::GinFulltext(PersistentBTreeMap::new()),
3495 included_columns: Vec::new(),
3496 partial_predicate: None,
3497 expression: None,
3498 is_unique: false,
3499 nulls_not_distinct: false,
3500 descending: false,
3501 nulls_first: None,
3502 collation: None,
3503 extra_column_positions: Vec::new(),
3504 }
3505 }
3506
3507 /// v7.37.8(sentori Epic 5 P2)— JSONB-GIN constructor. Same
3508 /// shape as the other GIN-family indexes; posting-list keys
3509 /// are the canonical `(path, leaf)` tokens emitted by
3510 /// `crate::jsonb_gin::extract_tokens`. Maintains posting
3511 /// lists from `Value::Json` cells(JSONB is a synonym for the
3512 /// same in-memory string-backed Value).
3513 fn new_gin_jsonb(name: String, column_position: usize) -> Self {
3514 Self {
3515 name,
3516 column_position,
3517 kind: IndexKind::GinJsonb(PersistentBTreeMap::new()),
3518 included_columns: Vec::new(),
3519 partial_predicate: None,
3520 expression: None,
3521 is_unique: false,
3522 nulls_not_distinct: false,
3523 descending: false,
3524 nulls_first: None,
3525 collation: None,
3526 extra_column_positions: Vec::new(),
3527 }
3528 }
3529
3530 /// v7.34.4 — descending-order iterator over `(IndexKey, locators)`
3531 /// pairs for a BTree index, with O(log N) descent to the rightmost
3532 /// leaf and lazy emission thereafter. Returns an empty iterator
3533 /// for non-BTree index kinds — callers handle both uniformly.
3534 /// Used by the ORDER BY `<indexed col>` DESC + LIMIT N executor
3535 /// path: walking only the first N matches off the rightmost leaf
3536 /// avoids the per-row materialisation + partial-sort cost on
3537 /// large tables (mailrs `content_worker` at 250 k rows).
3538 pub fn iter_desc(
3539 &self,
3540 ) -> alloc::boxed::Box<dyn Iterator<Item = (&IndexKey, &crate::posting::PostingList)> + '_>
3541 {
3542 match &self.kind {
3543 IndexKind::BTree(m) => alloc::boxed::Box::new(m.iter_rev()),
3544 // v7.38.1 (L12) — projecting the leading component of a
3545 // composite key preserves order: keys sort by the whole
3546 // tuple, so the leading component is non-increasing here
3547 // (non-decreasing in iter_asc), exactly what an ORDER BY
3548 // on the leading column needs.
3549 IndexKind::BTreeMulti(m) => {
3550 alloc::boxed::Box::new(m.iter_rev().map(|(k, l)| (&k[0], l)))
3551 }
3552 IndexKind::Nsw(_)
3553 | IndexKind::Brin { .. }
3554 | IndexKind::Gin(_)
3555 | IndexKind::GinTrgm(_)
3556 | IndexKind::GinFulltext(_)
3557 | IndexKind::GinJsonb(_) => alloc::boxed::Box::new(core::iter::empty()),
3558 }
3559 }
3560
3561 /// v7.34.4 — ascending-order iterator over `(IndexKey, locators)`
3562 /// pairs. Mirror of `iter_desc` for ORDER BY ... ASC + LIMIT N.
3563 pub fn iter_asc(
3564 &self,
3565 ) -> alloc::boxed::Box<dyn Iterator<Item = (&IndexKey, &crate::posting::PostingList)> + '_>
3566 {
3567 match &self.kind {
3568 IndexKind::BTree(m) => alloc::boxed::Box::new(m.iter()),
3569 // v7.38.1 (L12) — see iter_desc: the leading component of
3570 // a tuple-sorted walk is itself in order.
3571 IndexKind::BTreeMulti(m) => alloc::boxed::Box::new(m.iter().map(|(k, l)| (&k[0], l))),
3572 IndexKind::Nsw(_)
3573 | IndexKind::Brin { .. }
3574 | IndexKind::Gin(_)
3575 | IndexKind::GinTrgm(_)
3576 | IndexKind::GinFulltext(_)
3577 | IndexKind::GinJsonb(_) => alloc::boxed::Box::new(core::iter::empty()),
3578 }
3579 }
3580
3581 /// Look up the locators stored under `key` (B-tree only). Returns
3582 /// an empty slice when the key is absent or the index isn't a
3583 /// BTree — callers can treat both cases uniformly.
3584 ///
3585 /// v5.1: return type widened from `&[usize]` to `&[RowLocator]`.
3586 /// Pre-v5.2 callers can read the slice and `.as_hot().unwrap()`
3587 /// each entry (no `Cold` variants exist until the freezer lands);
3588 /// post-v5.2 callers dispatch hot vs. cold per locator.
3589 pub fn lookup_eq(&self, key: &IndexKey) -> &crate::posting::PostingList {
3590 match &self.kind {
3591 IndexKind::BTree(m) => m.get(key).map_or(&EMPTY_POSTINGS, |l| l),
3592 // BRIN / NSW / GIN / trigram-GIN / fulltext-GIN have
3593 // no IndexKey-keyed map; lookup is a no-op. GIN uses
3594 // [`Index::gin_lookup_word`] instead.
3595 IndexKind::Nsw(_)
3596 | IndexKind::Brin { .. }
3597 | IndexKind::Gin(_)
3598 | IndexKind::GinTrgm(_)
3599 | IndexKind::GinFulltext(_)
3600 | IndexKind::GinJsonb(_)
3601 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3602 }
3603 }
3604
3605 /// v7.37.43 (INSUBQ B-2) — specialised lookup for integer-PK probes.
3606 /// `try_count_star_pk_in_subquery_fast` already holds an `i64` (the
3607 /// inner survivor key); skip the `IndexKey::from_value` enum-dispatch
3608 /// trip and build the key inline. ~20 ns × N_survivors saved on
3609 /// the INSUBQ hot loop.
3610 #[inline]
3611 pub fn lookup_eq_i64(&self, n: i64) -> &crate::posting::PostingList {
3612 match &self.kind {
3613 IndexKind::BTree(m) => m.get(&IndexKey::Int(n)).map_or(&EMPTY_POSTINGS, |l| l),
3614 IndexKind::Nsw(_)
3615 | IndexKind::Brin { .. }
3616 | IndexKind::Gin(_)
3617 | IndexKind::GinTrgm(_)
3618 | IndexKind::GinFulltext(_)
3619 | IndexKind::GinJsonb(_)
3620 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3621 }
3622 }
3623
3624 /// v7.38 (perf, index range scan) — flatten the row locators for every key
3625 /// in `[lo, hi]` (bounds per `core::ops::Bound`) via the BTree's `O(log N +
3626 /// k)` range walk. Returns `None` once more than `cap` locators accumulate
3627 /// — a "this range isn't selective enough, seq-scan instead" signal that
3628 /// stops a wide range from materialising a near-full table's worth of rows
3629 /// through the index. BTree only (other kinds → None).
3630 pub fn lookup_range_capped(
3631 &self,
3632 lo: core::ops::Bound<&IndexKey>,
3633 hi: core::ops::Bound<&IndexKey>,
3634 cap: usize,
3635 ) -> Option<Vec<RowLocator>> {
3636 self.lookup_range_capped_by(lo, hi, cap, |_| true)
3637 }
3638
3639 /// v7.39 (round 490) — the same range walk, but the caller decides
3640 /// which locators are worth carrying, and the cap counts only those.
3641 ///
3642 /// A BTree index holds one locator per row VERSION. On a churned table
3643 /// the dead versions are still in there: round 490 measured a
3644 /// 1000-row range handing back 61 000 locators after 60
3645 /// delete-and-reinsert cycles with the background vacuum switched off.
3646 /// Every caller then dropped the dead ones — the mutation paths and the
3647 /// SELECT range path all test `is_row_visible` and `continue` — but only
3648 /// after they had been collected into a `Vec`, sorted, and walked.
3649 ///
3650 /// Handing the predicate down means the walk keeps ~1000, and the cap
3651 /// (which exists so an index walk never costs more than the scan it
3652 /// replaces) is once again measured in rows a caller will actually look
3653 /// at. Round 461 had to add the dead count to the budget to stop the
3654 /// seek being refused outright; with the filter here that compensation
3655 /// is no longer needed.
3656 pub fn lookup_range_capped_by(
3657 &self,
3658 lo: core::ops::Bound<&IndexKey>,
3659 hi: core::ops::Bound<&IndexKey>,
3660 cap: usize,
3661 keep: impl Fn(RowLocator) -> bool,
3662 ) -> Option<Vec<RowLocator>> {
3663 match &self.kind {
3664 IndexKind::BTree(m) => {
3665 let mut out: Vec<RowLocator> = Vec::new();
3666 for (_, locs) in m.range(lo, hi) {
3667 out.extend(locs.iter().copied().filter(|l| keep(*l)));
3668 if out.len() > cap {
3669 return None;
3670 }
3671 }
3672 Some(out)
3673 }
3674 IndexKind::Nsw(_)
3675 | IndexKind::Brin { .. }
3676 | IndexKind::Gin(_)
3677 | IndexKind::GinTrgm(_)
3678 | IndexKind::GinFulltext(_)
3679 | IndexKind::GinJsonb(_)
3680 | IndexKind::BTreeMulti(_) => None,
3681 }
3682 }
3683
3684 /// v7.38.1 (L12) — full-tuple point lookup on a [`IndexKind::BTreeMulti`]
3685 /// index. `key` must carry exactly as many components as the index
3686 /// has columns; anything else (including a probe against a
3687 /// non-multi index) finds nothing, and "nothing" here is safe
3688 /// because the caller falls back to a scan, never to an answer.
3689 pub fn lookup_eq_multi(&self, key: &[IndexKey]) -> &crate::posting::PostingList {
3690 match &self.kind {
3691 IndexKind::BTreeMulti(m) if key.len() == 1 + self.extra_column_positions.len() => {
3692 m.get_by(key).map_or(&EMPTY_POSTINGS, |l| l)
3693 }
3694 _ => &EMPTY_POSTINGS,
3695 }
3696 }
3697
3698 /// v7.38.1 (L12) — locators for every key whose leading components
3699 /// equal `prefix`, on a [`IndexKind::BTreeMulti`] index. Slice
3700 /// ordering keeps a prefix's keys contiguous, so this is one
3701 /// descent to `[prefix]` and a walk that stops at the first key
3702 /// leaving the prefix. Same cap/keep contract as
3703 /// [`Index::lookup_range_capped_by`]: `None` = not selective
3704 /// enough (or not a multi index), fall back.
3705 pub fn lookup_prefix_capped_by(
3706 &self,
3707 prefix: &[IndexKey],
3708 cap: usize,
3709 keep: impl Fn(RowLocator) -> bool,
3710 ) -> Option<Vec<RowLocator>> {
3711 let IndexKind::BTreeMulti(m) = &self.kind else {
3712 return None;
3713 };
3714 if prefix.is_empty() || prefix.len() > 1 + self.extra_column_positions.len() {
3715 return None;
3716 }
3717 let lo: alloc::boxed::Box<[IndexKey]> = prefix.to_vec().into_boxed_slice();
3718 let mut out: Vec<RowLocator> = Vec::new();
3719 for (k, locs) in m.range(core::ops::Bound::Included(&lo), core::ops::Bound::Unbounded) {
3720 if k.len() < prefix.len() || k[..prefix.len()] != *prefix {
3721 break;
3722 }
3723 out.extend(locs.iter().copied().filter(|l| keep(*l)));
3724 if out.len() > cap {
3725 return None;
3726 }
3727 }
3728 Some(out)
3729 }
3730
3731 /// v7.39 (round 560) — the index range as (key, locator) pairs.
3732 ///
3733 /// `lookup_range_capped_by` throws the KEY away and returns only
3734 /// locators, so a query whose projection is exactly the indexed
3735 /// column still goes to the row store for a value the walk already
3736 /// had in hand — paying per row for something the index knows.
3737 ///
3738 /// Uncapped on purpose: an index-only walk touches no row, so the
3739 /// selectivity ceiling that keeps a seek from being worse than the
3740 /// scan it replaces does not apply to it.
3741 ///
3742 /// v7.39 (round 562) — and it does not collect, either. This
3743 /// returned a `Vec<(IndexKey, RowLocator)>`: for a 100k-row range,
3744 /// 100k key clones into a `Vec::new()` that doubles its way up to
3745 /// several MB, all to be walked once and dropped. A profile of the
3746 /// server serving that query put 20% of the connection thread's CPU
3747 /// on the collect alone, with another 18% in the allocator beside
3748 /// it. The caller consumes the pairs in order and needs the key
3749 /// only by reference, so it can have the walk itself.
3750 pub fn range_keyed(
3751 &self,
3752 lo: core::ops::Bound<&IndexKey>,
3753 hi: core::ops::Bound<&IndexKey>,
3754 ) -> Option<impl Iterator<Item = (&IndexKey, RowLocator)> + '_> {
3755 match &self.kind {
3756 IndexKind::BTree(m) => Some(
3757 m.range(lo, hi)
3758 .flat_map(|(k, locs)| locs.iter().map(move |l| (k, *l))),
3759 ),
3760 IndexKind::Nsw(_)
3761 | IndexKind::Brin { .. }
3762 | IndexKind::Gin(_)
3763 | IndexKind::GinTrgm(_)
3764 | IndexKind::GinFulltext(_)
3765 | IndexKind::GinJsonb(_)
3766 | IndexKind::BTreeMulti(_) => None,
3767 }
3768 }
3769
3770 /// v7.12.3 — GIN posting-list lookup. Returns the row locators
3771 /// whose `tsvector` cell contains `word`. Empty when the word is
3772 /// absent from the index or this isn't a GIN index.
3773 pub fn gin_lookup_word(&self, word: &str) -> &crate::posting::PostingList {
3774 match &self.kind {
3775 // v7.17.0 Phase 2.2 — fulltext-GIN shares the same
3776 // lexeme-keyed posting list shape as the
3777 // tsvector-typed GIN, so the same lookup applies.
3778 IndexKind::Gin(m) | IndexKind::GinFulltext(m) => {
3779 m.get(&String::from(word)).map_or(&EMPTY_POSTINGS, |l| l)
3780 }
3781 IndexKind::BTree(_)
3782 | IndexKind::Nsw(_)
3783 | IndexKind::Brin { .. }
3784 | IndexKind::GinTrgm(_)
3785 | IndexKind::GinJsonb(_)
3786 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3787 }
3788 }
3789
3790 /// v7.15.0 — trigram-GIN posting-list lookup. Returns the row
3791 /// locators whose indexed `TEXT` cell contains the trigram
3792 /// `tri`. Empty when the trigram is absent or this isn't a
3793 /// trigram-GIN index.
3794 pub fn gin_trgm_lookup(&self, tri: &str) -> &crate::posting::PostingList {
3795 match &self.kind {
3796 IndexKind::GinTrgm(m) => m.get(&String::from(tri)).map_or(&EMPTY_POSTINGS, |l| l),
3797 IndexKind::BTree(_)
3798 | IndexKind::Nsw(_)
3799 | IndexKind::Brin { .. }
3800 | IndexKind::Gin(_)
3801 | IndexKind::GinFulltext(_)
3802 | IndexKind::GinJsonb(_)
3803 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3804 }
3805 }
3806
3807 /// v7.37.8(sentori Epic 5 P2)— JSONB-GIN posting-list lookup.
3808 /// Returns the row locators whose indexed JSONB cell carries
3809 /// the canonical `token`(see [`crate::jsonb_gin::extract_tokens`]).
3810 /// Empty when the token is absent or this isn't a JSONB-GIN
3811 /// index. Planners drive `<col> @> <jsonb_literal>` through here.
3812 pub fn gin_jsonb_lookup(&self, token: &str) -> &crate::posting::PostingList {
3813 match &self.kind {
3814 IndexKind::GinJsonb(m) => m.get(&String::from(token)).map_or(&EMPTY_POSTINGS, |l| l),
3815 IndexKind::BTree(_)
3816 | IndexKind::Nsw(_)
3817 | IndexKind::Brin { .. }
3818 | IndexKind::Gin(_)
3819 | IndexKind::GinTrgm(_)
3820 | IndexKind::GinFulltext(_)
3821 | IndexKind::BTreeMulti(_) => &EMPTY_POSTINGS,
3822 }
3823 }
3824
3825 /// Borrow the NSW graph (if this is an NSW index). Callers that need
3826 /// the graph for a kNN search go through here.
3827 pub const fn nsw(&self) -> Option<&NswGraph> {
3828 match &self.kind {
3829 IndexKind::Nsw(g) => Some(g),
3830 IndexKind::BTree(_)
3831 | IndexKind::Brin { .. }
3832 | IndexKind::Gin(_)
3833 | IndexKind::GinTrgm(_)
3834 | IndexKind::GinFulltext(_)
3835 | IndexKind::GinJsonb(_)
3836 | IndexKind::BTreeMulti(_) => None,
3837 }
3838 }
3839
3840 /// v6.7.1 — true when this index is a BRIN (block range) index.
3841 /// Used by the segment encoder to opt into BRIN sidecar emission
3842 /// at freeze time, and by the planner to opt into page-skipping
3843 /// on range predicates.
3844 pub const fn is_brin(&self) -> bool {
3845 matches!(self.kind, IndexKind::Brin { .. })
3846 }
3847
3848 /// v7.15.0 — true when this index is a trigram GIN
3849 /// (`gin_trgm_ops`-flavoured). Used by the LIKE planner to
3850 /// opt into trigram acceleration.
3851 pub const fn is_gin_trgm(&self) -> bool {
3852 matches!(self.kind, IndexKind::GinTrgm(_))
3853 }
3854
3855 /// v7.12.3 — true when this index is a GIN inverted index.
3856 /// Used by the planner to opt into posting-list acceleration on
3857 /// `WHERE col @@ tsquery` predicates.
3858 pub const fn is_gin(&self) -> bool {
3859 matches!(self.kind, IndexKind::Gin(_))
3860 }
3861
3862 /// v7.17.0 Phase 2.2 — true when this index is a fulltext
3863 /// GIN over a TEXT / VARCHAR column (MySQL `FULLTEXT KEY`
3864 /// surface). Used by the planner to opt the FULLTEXT-indexed
3865 /// column into MATCH AGAINST acceleration.
3866 pub const fn is_gin_fulltext(&self) -> bool {
3867 matches!(self.kind, IndexKind::GinFulltext(_))
3868 }
3869
3870 /// v7.37.8(sentori Epic 5 P2)— true when this index is a
3871 /// real JSONB-GIN(posting-list backed). Used by the planner
3872 /// to opt `<col> @> <jsonb_literal>` into posting-list seek.
3873 pub const fn is_gin_jsonb(&self) -> bool {
3874 matches!(self.kind, IndexKind::GinJsonb(_))
3875 }
3876}
3877
3878/// In-memory table: schema + a persistent row vector + secondary indices.
3879///
3880/// v4.39: `rows` is a [`PersistentVec`] (Bitmapped Vector Trie, 32-way) so
3881/// `Table::clone()` is `O(1)` — the whole reason for v4.39's existence is
3882/// to make `Catalog::clone()` cheap inside the v4.34 auto-commit wrap.
3883///
3884/// v5.2.1: `hot_bytes` tracks the encoded byte size of every row currently
3885/// in [`Self::rows`], summed over rows. Updated incrementally by `insert`
3886/// (+= encoded row size), `delete_rows` (-= removed rows' encoded sizes),
3887/// and `update_row` (-= old size, += new size). The value is what the
3888/// v5.2 freezer reads to decide when to demote cold rows — when the
3889/// catalog-wide sum crosses `SPG_HOT_TIER_BYTES` (default 4 GiB) the
3890/// freezer thread wakes. v5.2.1 ships measurement only; the freezer
3891/// itself lands in v5.2.2. Stored as `u64` so a single field clone in
3892/// `Catalog::clone` stays at the O(1) invariant v4.39 built.
3893/// v7.34 (crash-recovery P0 #2) — one row-level physical redo record.
3894/// Row-level redo replaces statement-based WAL replay (which re-executes
3895/// each SQL through the full engine — O(records × catalog_rows), the
3896/// superlinear recovery hang root-caused on the mailrs crash-recovery
3897/// P0). A `RowChange` is the exact storage mutation the engine applied
3898/// (`Table::insert` / `update_row` / `delete_rows`); replaying it on a
3899/// catalog restored from the matching checkpoint reproduces the state
3900/// WITHOUT re-validating uniqueness/FK/parse/plan — O(changed rows).
3901///
3902/// Positions are physical, not key-based: `serialize`/`deserialize`
3903/// preserve row order exactly (rows written + read back in `self.rows`
3904/// order) and the mutation ops are deterministic, so the same op sequence
3905/// replayed from the same checkpoint reproduces the same positions. This
3906/// matches PostgreSQL's physical redo and supports tables with no primary
3907/// key. (Caveat handled at replay integration: a post-checkpoint cold-tier
3908/// freeze shifts hot positions and must itself be logged or fenced by a
3909/// checkpoint — see `row-level-redo-design`.)
3910/// ## v7.37.15 (Epic W slice 1) — additive MVCC identity metadata
3911///
3912/// Each variant now also carries, additively, the stable
3913/// [`RowId`](row_header::RowId) of the affected row(s) and the
3914/// **writer version** (`xmin` for an insert, `xmax` for a
3915/// delete/update). This is the codec foundation for making
3916/// in-place MVCC tombstones durable across crash/upgrade recovery.
3917///
3918/// Two important properties for the durability path:
3919///
3920/// 1. **Replay resolution is UNCHANGED.** `apply_redo_run_on_table`
3921/// still resolves every change by physical `pos`/`positions`
3922/// exactly as before. The new metadata is *carried but unused*
3923/// by replay in this slice; resolving-by-`RowId` and
3924/// header-preserving replay are later slices.
3925/// 2. **Backward compatibility.** A redo payload written by
3926/// pre-Epic-W code carries no metadata; [`decode_redo_log`]
3927/// fills `rowid`/`rowids` with [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED)
3928/// (empty for `Delete`) and `writer_version` with `0`. See the
3929/// codec version gate in [`encode_redo_log`]/[`decode_redo_log`].
3930///
3931/// The `writer_version` is captured as `0` at the storage layer
3932/// (`Table::insert`/`delete_rows`/`update_row` don't have the
3933/// committing `TxId`), then **stamped with the real committing
3934/// version by the engine** after it drains the statement's changes
3935/// (Epic W slice 2 — [`RowChange::set_writer_version`], driven from
3936/// `Engine::writer_version_for_current_stmt`). All changes from one
3937/// statement share the one version. Replay still resolves by
3938/// physical position and does not read `writer_version` — that is a
3939/// later slice (header-preserving replay).
3940#[derive(Debug, Clone, PartialEq)]
3941pub enum RowChange {
3942 /// Append `row` to `table`.
3943 Insert {
3944 table: String,
3945 row: Row<'static>,
3946 /// Epic W: stable id the appended row will receive.
3947 /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) when
3948 /// decoded from a pre-Epic-W redo payload.
3949 rowid: row_header::RowId,
3950 /// Epic W: writer version (`xmin`). `0` until the writing
3951 /// `TxId` is threaded to the storage layer (later slice).
3952 writer_version: u64,
3953 },
3954 /// Replace the row at physical `pos` in `table` with `new_row`.
3955 Update {
3956 table: String,
3957 pos: usize,
3958 new_row: Vec<Value<'static>>,
3959 /// Epic W: stable id of the row at `pos`.
3960 /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) when
3961 /// decoded from a pre-Epic-W redo payload.
3962 rowid: row_header::RowId,
3963 /// Epic W: writer version (`xmax` of the superseded tuple).
3964 /// `0` until the writing `TxId` is threaded (later slice).
3965 writer_version: u64,
3966 },
3967 /// Remove the rows at the given physical `positions` from `table`.
3968 Delete {
3969 table: String,
3970 positions: Vec<usize>,
3971 /// Epic W: stable ids parallel to `positions` (same length,
3972 /// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) for an
3973 /// out-of-bounds input position). **Empty** when decoded from
3974 /// a pre-Epic-W redo payload (no metadata was recorded).
3975 rowids: Vec<row_header::RowId>,
3976 /// Epic W: writer version (`xmax`). `0` until the writing
3977 /// `TxId` is threaded to the storage layer (later slice).
3978 writer_version: u64,
3979 },
3980 /// v7.37.15 (Epic W durable-tombstone slice) — an **in-place MVCC
3981 /// delete**: the row(s) named by `rowids` are NOT physically
3982 /// removed; their header `xmax` is stamped so newer snapshots stop
3983 /// seeing them (vacuum reclaims later). This is the redo shape of
3984 /// the gate-on (`SPG_MVCC_INPLACE`) DELETE / UPDATE-old-version /
3985 /// ON-CONFLICT paths, which call [`Table::mark_row_deleted`]
3986 /// instead of `delete_rows`.
3987 ///
3988 /// Unlike `Delete`, the target is named by **stable `RowId`**, not
3989 /// physical position: a tombstone keeps the slot, so position would
3990 /// be ambiguous after later compaction, and the header-preserving
3991 /// replay must re-find the exact row the writer tombstoned. On
3992 /// replay the id is matched against the ids the same redo run
3993 /// produced (an `Insert`'s `rowid`, or the table's ids snapshotted
3994 /// at run start); an id that cannot be resolved is skipped and
3995 /// counted (see `apply_redo_run_on_table`) — this is the documented
3996 /// cross-checkpoint limitation until the V6 envelope persists ids.
3997 Tombstone {
3998 table: String,
3999 /// Stable ids of the tombstoned rows (from `self.rowids()[pos]`
4000 /// at capture). Never empty for a recorded tombstone.
4001 rowids: Vec<row_header::RowId>,
4002 /// The version stamped into each target row's header `xmax`
4003 /// (the deleting statement's writer version).
4004 xmax: u64,
4005 },
4006}
4007
4008impl RowChange {
4009 /// v7.39 (round 736) — which table this change applies to.
4010 #[must_use]
4011 pub fn table_name(&self) -> &str {
4012 match self {
4013 Self::Insert { table, .. }
4014 | Self::Update { table, .. }
4015 | Self::Delete { table, .. }
4016 | Self::Tombstone { table, .. } => table,
4017 }
4018 }
4019
4020 /// v7.37.15 (Epic W slice 2) — stamp the committing writer
4021 /// version onto this change. Every change drained from a single
4022 /// statement shares one version (the statement's `xmin`/`xmax`),
4023 /// so the engine calls this on each drained change with the value
4024 /// from [`Engine::writer_version_for_current_stmt`]. Additive
4025 /// metadata only: replay still resolves by physical position and
4026 /// does not read `writer_version` (that is a later slice).
4027 pub fn set_writer_version(&mut self, v: u64) {
4028 match self {
4029 RowChange::Insert { writer_version, .. }
4030 | RowChange::Update { writer_version, .. }
4031 | RowChange::Delete { writer_version, .. } => *writer_version = v,
4032 // A tombstone captures `xmax` directly from the deleting
4033 // statement's version at record time (via
4034 // `mark_row_deleted`), so it already equals `v`. Keep the
4035 // "one statement, one version" invariant mechanical by
4036 // asserting agreement in debug builds rather than silently
4037 // overwriting a possibly-different value.
4038 RowChange::Tombstone { xmax, .. } => {
4039 debug_assert_eq!(
4040 *xmax, v,
4041 "tombstone xmax must match the statement writer version"
4042 );
4043 *xmax = v;
4044 }
4045 }
4046 }
4047}
4048
4049/// v7.37.15 (Epic W slice 1) — leading marker byte of the
4050/// metadata-carrying redo layout. A **pre-Epic-W** redo payload leads
4051/// with `FILE_VERSION` (8..=52 today, rising ~1 per release); this
4052/// marker is `0xFF` and can therefore never collide with a real
4053/// `FILE_VERSION`, so [`decode_redo_log`] tells the two layouts apart
4054/// by inspecting the first byte alone. The compile-time assertion
4055/// below makes the "never collide" invariant a hard build gate: if
4056/// `FILE_VERSION` ever climbs toward `0xFF` the build breaks and forces
4057/// a redesign long before an ambiguity could ship.
4058const REDO_META_MARKER: u8 = 0xFF;
4059/// v7.37.15 (Epic W slice 1) — version of the metadata-carrying redo
4060/// layout that follows [`REDO_META_MARKER`]. Bumped when the per-change
4061/// metadata shape changes; an unknown value is a hard decode error.
4062const REDO_META_VERSION: u8 = 1;
4063
4064/// v7.37.15 (Epic W durable-tombstone slice) — process-wide count of
4065/// [`RowChange::Tombstone`] targets that `apply_redo` could NOT resolve
4066/// to a row by `RowId`. A non-zero value is expected only across a
4067/// checkpoint boundary (the table's ids are reassigned on deserialize
4068/// and the V6 envelope does not yet persist them), where a tombstone
4069/// naming a pre-checkpoint row is left visible rather than mis-applied.
4070/// Surfaced for observability; never affects correctness of the resolved
4071/// tombstones. Read via [`unresolved_tombstone_count`].
4072static UNRESOLVED_TOMBSTONES: core::sync::atomic::AtomicU64 = core::sync::atomic::AtomicU64::new(0);
4073
4074/// v7.39 (flip crash-replay P0) — observability read for the replay
4075/// tombstones that could not be resolved to a row (each one is a
4076/// resurrected delete).
4077#[must_use]
4078pub fn unresolved_tombstones() -> u64 {
4079 UNRESOLVED_TOMBSTONES.load(core::sync::atomic::Ordering::Relaxed)
4080}
4081
4082/// v7.37.15 (Epic W durable-tombstone slice) — read the process-wide
4083/// count of redo tombstones that could not be resolved to a row by
4084/// `RowId` during `apply_redo`. See [`UNRESOLVED_TOMBSTONES`].
4085#[must_use]
4086pub fn unresolved_tombstone_count() -> u64 {
4087 UNRESOLVED_TOMBSTONES.load(core::sync::atomic::Ordering::Relaxed)
4088}
4089// Provably-unambiguous old/new distinction: the pre-Epic-W layout's
4090// first byte is `FILE_VERSION`, which must stay strictly below the
4091// marker forever.
4092const _: () = assert!(FILE_VERSION < REDO_META_MARKER);
4093
4094/// v7.34 (crash-recovery P0 #2), extended v7.37.15 (Epic W slice 1) —
4095/// encode a row-level redo log to bytes for a WAL record.
4096///
4097/// ## Layout (Epic W metadata-carrying form, always emitted now)
4098///
4099/// `[u8 REDO_META_MARKER=0xFF][u8 REDO_META_VERSION][u8 FILE_VERSION]
4100/// [u32 count]` then per change `[u8 op][str table]` and, per op:
4101/// - `Insert [u32 n][value×n][u64 rowid][u64 writer_version]`
4102/// - `Update [u32 pos][u32 n][value×n][u64 rowid][u64 writer_version]`
4103/// - `Delete [u32 n][u32 pos×n][u64 rowid×n][u64 writer_version]`
4104/// - `Tombstone [u32 n][u64 rowid×n][u64 xmax]` (op byte 3; only ever
4105/// emitted under the metadata-carrying layout — the pre-Epic-W layout
4106/// had no in-place tombstone, so a legacy stream can never carry it)
4107///
4108/// Positions are physical (u32 ≤ 4 G rows). The `FILE_VERSION` byte
4109/// still rides along (now the 3rd byte) so the value codec decodes
4110/// string / BYTEA escapes exactly as before.
4111///
4112/// ## Backward compatibility
4113///
4114/// The **pre-Epic-W** layout was `[u8 FILE_VERSION][u32 count]…` with
4115/// no per-change metadata. [`decode_redo_log`] still decodes that form
4116/// (first byte < `0xFF`) byte-for-byte identically — every WAL file
4117/// written by released code replays unchanged.
4118#[must_use]
4119pub fn encode_redo_log(changes: &[RowChange]) -> Vec<u8> {
4120 let mut out = Vec::new();
4121 out.push(REDO_META_MARKER);
4122 out.push(REDO_META_VERSION);
4123 out.push(FILE_VERSION);
4124 codec::write_u32(&mut out, changes.len() as u32);
4125 let write_values = |out: &mut Vec<u8>, vals: &[Value<'static>]| {
4126 codec::write_u32(out, vals.len() as u32);
4127 for v in vals {
4128 codec::write_value(out, v);
4129 }
4130 };
4131 for change in changes {
4132 match change {
4133 RowChange::Insert {
4134 table,
4135 row,
4136 rowid,
4137 writer_version,
4138 } => {
4139 out.push(0);
4140 codec::write_str(&mut out, table);
4141 write_values(&mut out, &row.values);
4142 codec::write_u64(&mut out, rowid.0);
4143 codec::write_u64(&mut out, *writer_version);
4144 }
4145 RowChange::Update {
4146 table,
4147 pos,
4148 new_row,
4149 rowid,
4150 writer_version,
4151 } => {
4152 out.push(1);
4153 codec::write_str(&mut out, table);
4154 codec::write_u32(&mut out, *pos as u32);
4155 write_values(&mut out, new_row);
4156 codec::write_u64(&mut out, rowid.0);
4157 codec::write_u64(&mut out, *writer_version);
4158 }
4159 RowChange::Delete {
4160 table,
4161 positions,
4162 rowids,
4163 writer_version,
4164 } => {
4165 out.push(2);
4166 codec::write_str(&mut out, table);
4167 codec::write_u32(&mut out, positions.len() as u32);
4168 for p in positions {
4169 codec::write_u32(&mut out, *p as u32);
4170 }
4171 // Epic W: one RowId per position (parallel). Capture
4172 // sites always produce `rowids.len() == positions.len()`;
4173 // this assertion pins that invariant at encode time so a
4174 // mismatch is a loud bug, not a silently short payload.
4175 debug_assert_eq!(
4176 rowids.len(),
4177 positions.len(),
4178 "redo Delete: rowids must be parallel to positions"
4179 );
4180 for rid in rowids {
4181 codec::write_u64(&mut out, rid.0);
4182 }
4183 codec::write_u64(&mut out, *writer_version);
4184 }
4185 RowChange::Tombstone {
4186 table,
4187 rowids,
4188 xmax,
4189 } => {
4190 out.push(3);
4191 codec::write_str(&mut out, table);
4192 codec::write_u32(&mut out, rowids.len() as u32);
4193 for rid in rowids {
4194 codec::write_u64(&mut out, rid.0);
4195 }
4196 codec::write_u64(&mut out, *xmax);
4197 }
4198 }
4199 }
4200 out
4201}
4202
4203/// v7.34, extended v7.37.15 (Epic W slice 1) — decode a row-level redo
4204/// log written by [`encode_redo_log`].
4205///
4206/// Decodes **both** the Epic W metadata-carrying layout (first byte
4207/// `REDO_META_MARKER = 0xFF`) and the pre-Epic-W layout (first byte is
4208/// `FILE_VERSION`, always `< 0xFF`). For the old layout the per-change
4209/// metadata is absent, so `rowid`/`rowids` come back
4210/// [`RowId::UNASSIGNED`](row_header::RowId::UNASSIGNED) (empty for
4211/// `Delete`) and `writer_version` comes back `0`.
4212///
4213/// A truncated / corrupt buffer is a hard error — never a panic — the
4214/// embedding layer frames each record with its own length + CRC, so a
4215/// frame that decodes short is corruption, not a torn tail.
4216pub fn decode_redo_log(bytes: &[u8]) -> Result<Vec<RowChange>, StorageError> {
4217 let first = *bytes
4218 .first()
4219 .ok_or_else(|| StorageError::Corrupt("redo log: empty".into()))?;
4220 // Epic W: `0xFF` marker ⇒ metadata-carrying layout; anything else
4221 // is a pre-Epic-W `FILE_VERSION` byte (old layout, no metadata).
4222 let has_meta = first == REDO_META_MARKER;
4223 let (codec_version, header_len) = if has_meta {
4224 let meta_version = *bytes
4225 .get(1)
4226 .ok_or_else(|| StorageError::Corrupt("redo log: short header".into()))?;
4227 if meta_version != REDO_META_VERSION {
4228 return Err(StorageError::Corrupt(alloc::format!(
4229 "redo log: unknown metadata version {meta_version}"
4230 )));
4231 }
4232 let file_version = *bytes
4233 .get(2)
4234 .ok_or_else(|| StorageError::Corrupt("redo log: short header".into()))?;
4235 // header = [marker][meta_version][file_version]
4236 (file_version, 3usize)
4237 } else {
4238 // Old layout: the first byte IS the FILE_VERSION.
4239 (first, 1usize)
4240 };
4241 let mut cur = codec::Cursor::new(bytes).with_codec_version(codec_version);
4242 for _ in 0..header_len {
4243 cur.read_u8()?;
4244 }
4245 let count = cur.read_u32()? as usize;
4246 let mut read_values =
4247 |cur: &mut codec::Cursor<'_>| -> Result<Vec<Value<'static>>, StorageError> {
4248 let n = cur.read_u32()? as usize;
4249 let mut vals = Vec::with_capacity(n);
4250 for _ in 0..n {
4251 vals.push(cur.read_value()?);
4252 }
4253 Ok(vals)
4254 };
4255 let mut changes = Vec::with_capacity(count);
4256 for _ in 0..count {
4257 let op = cur.read_u8()?;
4258 let table = cur.read_str()?;
4259 let change = match op {
4260 0 => {
4261 let row = Row::new(read_values(&mut cur)?);
4262 let (rowid, writer_version) = if has_meta {
4263 (row_header::RowId(cur.read_u64()?), cur.read_u64()?)
4264 } else {
4265 (row_header::RowId::UNASSIGNED, 0)
4266 };
4267 RowChange::Insert {
4268 table,
4269 row,
4270 rowid,
4271 writer_version,
4272 }
4273 }
4274 1 => {
4275 let pos = cur.read_u32()? as usize;
4276 let new_row = read_values(&mut cur)?;
4277 let (rowid, writer_version) = if has_meta {
4278 (row_header::RowId(cur.read_u64()?), cur.read_u64()?)
4279 } else {
4280 (row_header::RowId::UNASSIGNED, 0)
4281 };
4282 RowChange::Update {
4283 table,
4284 pos,
4285 new_row,
4286 rowid,
4287 writer_version,
4288 }
4289 }
4290 2 => {
4291 let n = cur.read_u32()? as usize;
4292 let mut positions = Vec::with_capacity(n);
4293 for _ in 0..n {
4294 positions.push(cur.read_u32()? as usize);
4295 }
4296 let (rowids, writer_version) = if has_meta {
4297 let mut rowids = Vec::with_capacity(n);
4298 for _ in 0..n {
4299 rowids.push(row_header::RowId(cur.read_u64()?));
4300 }
4301 (rowids, cur.read_u64()?)
4302 } else {
4303 // Old layout carried no RowId metadata.
4304 (Vec::new(), 0)
4305 };
4306 RowChange::Delete {
4307 table,
4308 positions,
4309 rowids,
4310 writer_version,
4311 }
4312 }
4313 // Op 3 is the Epic W in-place tombstone — it only exists in
4314 // the metadata-carrying layout. Guarding on `has_meta` means
4315 // a legacy stream that happens to contain a `3` byte here is
4316 // reported as an unknown op (corruption), never mis-decoded.
4317 3 if has_meta => {
4318 let n = cur.read_u32()? as usize;
4319 let mut rowids = Vec::with_capacity(n);
4320 for _ in 0..n {
4321 rowids.push(row_header::RowId(cur.read_u64()?));
4322 }
4323 let xmax = cur.read_u64()?;
4324 RowChange::Tombstone {
4325 table,
4326 rowids,
4327 xmax,
4328 }
4329 }
4330 other => {
4331 return Err(StorageError::Corrupt(alloc::format!(
4332 "redo log: unknown op {other}"
4333 )));
4334 }
4335 };
4336 changes.push(change);
4337 }
4338 Ok(changes)
4339}
4340
4341/// v7.39 (pg_stat knife B) — per-table scan counters, bumped from
4342/// `&self` read paths. Clone (tx shadow catalogs clone tables) copies
4343/// the current values; the counters are volatile like PG's cumulative
4344/// stats.
4345#[derive(Debug, Default)]
4346pub struct ScanStats {
4347 pub seq_scan: core::sync::atomic::AtomicU64,
4348 pub seq_tup_read: core::sync::atomic::AtomicU64,
4349 pub idx_scan: core::sync::atomic::AtomicU64,
4350 pub idx_tup_fetch: core::sync::atomic::AtomicU64,
4351}
4352
4353impl Clone for ScanStats {
4354 fn clone(&self) -> Self {
4355 use core::sync::atomic::{AtomicU64, Ordering};
4356 Self {
4357 seq_scan: AtomicU64::new(self.seq_scan.load(Ordering::Relaxed)),
4358 seq_tup_read: AtomicU64::new(self.seq_tup_read.load(Ordering::Relaxed)),
4359 idx_scan: AtomicU64::new(self.idx_scan.load(Ordering::Relaxed)),
4360 idx_tup_fetch: AtomicU64::new(self.idx_tup_fetch.load(Ordering::Relaxed)),
4361 }
4362 }
4363}
4364
4365/// v7.39 (round 215) — the lower-bound sort key for a range value, used by
4366/// the range-exclusion index. The bound as an `i128` (unbounded lower =
4367/// `i128::MIN`, sorting first) plus an inclusivity rank (inclusive lower
4368/// sorts before exclusive at the same value, `[3` before `(3`). Returns
4369/// `None` for range kinds whose bound isn't an integer scalar (numrange's
4370/// numeric/bignum), for empty ranges, and for non-range values — the caller
4371/// then keeps the O(n) scan rather than risk an unsound order. Int4/Int8/
4372/// Date/Ts/TsTz all reduce here (tstzrange bounds are `Value::Timestamp`).
4373/// Maintenance (index build) and query (overlap probe) MUST agree on this
4374/// key, so both sides call exactly this function.
4375#[must_use]
4376pub fn range_excl_index_key(v: &Value<'_>) -> Option<(i128, u8)> {
4377 let Value::Range {
4378 lower,
4379 lower_inc,
4380 empty,
4381 ..
4382 } = v
4383 else {
4384 return None;
4385 };
4386 if *empty {
4387 return None;
4388 }
4389 let key = match lower {
4390 None => i128::MIN,
4391 Some(b) => match b.as_ref() {
4392 Value::SmallInt(n) => i128::from(*n),
4393 Value::Int(n) => i128::from(*n),
4394 Value::BigInt(n) => i128::from(*n),
4395 Value::Date(n) => i128::from(*n),
4396 Value::Timestamp(n) => i128::from(*n),
4397 _ => return None,
4398 },
4399 };
4400 Some((key, u8::from(!*lower_inc)))
4401}
4402
4403/// v7.39 (round 215) — a per-table range-exclusion index: an incrementally
4404/// maintained map from a range column's lower-bound key
4405/// ([`range_excl_index_key`]) to the physical row locators carrying that
4406/// bound. Lets EXCLUDE enforcement find the few candidate rows a new range
4407/// might overlap in O(log n) instead of scanning every row (measured O(N²),
4408/// r213). Because the stored ranges under a valid `EXCLUDE (col WITH &&)`
4409/// are pairwise disjoint, a candidate overlaps only its predecessor or the
4410/// successors whose lower bound precedes its upper — a handful of probes.
4411///
4412/// NOT persisted: rebuilt from the (persisted) exclusion constraints + rows
4413/// on catalog load, exactly like BRIN re-derives. Backed by a
4414/// `PersistentBTreeMap` so `Table::clone` (the per-write snapshot) stays
4415/// O(1). Locators to tombstoned rows are left in place and filtered by the
4416/// consumer via `is_deleted()` at query time — the established index pattern.
4417#[derive(Debug, Clone)]
4418pub struct ExclRangeIndex {
4419 /// The constrained range column's position in the table.
4420 pub column_position: usize,
4421 /// Lower-bound key → row locators. A key maps to a `Vec` because a
4422 /// tombstoned-then-reinserted bound can transiently collide; live rows
4423 /// under the constraint are disjoint so each key has one live locator.
4424 pub map: PersistentBTreeMap<(i128, u8), crate::posting::PostingList>,
4425}
4426
4427/// v7.38.2 (R2) — see [`Table::tx_write_track`]. Positions are the
4428/// insert-time slots (verified against the header's version at
4429/// extraction, so a shifted slot falls back to the scan); tombstones
4430/// carry the stable RowId, which is what the write-set wants anyway.
4431#[derive(Debug, Clone, Default)]
4432struct TxWriteTrack {
4433 version: u64,
4434 inserted: Vec<(usize, row_header::RowId)>,
4435 tombstoned: Vec<row_header::RowId>,
4436}
4437
4438/// v7.38.11 — hot-tier BRIN granularity: slots per summarised range.
4439///
4440/// 1024 keeps the summary vector three orders of magnitude smaller
4441/// than the table while staying fine enough that a one-day window over
4442/// a 90-day table skips ~99 % of it. A tuning constant, not a format:
4443/// summaries are rebuilt from the rows on load, so changing it costs
4444/// nothing on disk.
4445pub const BRIN_RANGE_ROWS: usize = 1024;
4446
4447/// The comparable scalar a BRIN summary tracks, or `None` for a value
4448/// with no ordering this index can use.
4449///
4450/// Deliberately narrow: only types whose ordering IS the i64 ordering
4451/// of this number. A type added here whose comparison is not that —
4452/// text under a collation, say — would make the summary under-report
4453/// and skip matching rows, which is the one failure this design must
4454/// not have.
4455#[must_use]
4456pub fn brin_scalar(v: &Value<'_>) -> Option<i64> {
4457 match v {
4458 Value::SmallInt(n) => Some(i64::from(*n)),
4459 Value::Int(n) => Some(i64::from(*n)),
4460 Value::BigInt(n) | Value::Timestamp(n) => Some(*n),
4461 Value::Date(d) => Some(i64::from(*d)),
4462 Value::Bool(b) => Some(i64::from(*b)),
4463 _ => None,
4464 }
4465}
4466
4467#[derive(Debug, Clone)]
4468pub struct Table {
4469 schema: TableSchema,
4470 /// v7.38.16 — names of the expression indexes whose B-tree currently
4471 /// holds keys derived from the EXPRESSION.
4472 ///
4473 /// Every catalog written before this version stored, under an
4474 /// expression index, the values of its leading column — keys no
4475 /// lookup could ever match, which is why every read path guarded
4476 /// itself with `expression.is_none()` and the index bought nothing
4477 /// while costing 1.9x a plain insert to maintain.
4478 ///
4479 /// Deliberately NOT persisted: a table read off disk starts with the
4480 /// set empty, so those old wrong keys can never answer a query. The
4481 /// engine, which owns the expression evaluator, refills it.
4482 expr_index_complete: alloc::collections::BTreeSet<String>,
4483 /// v7.37.15 (Phase C.1) — stable per-catalog relation identity.
4484 /// [`RelId::UNASSIGNED`](row_header::RelId::UNASSIGNED) until
4485 /// `Catalog::create_table` (or the deserialize dense-assign pass)
4486 /// stamps a real id. Keys the Phase C.4 row-lock table and the
4487 /// Phase C.5 `RelationStore`; survives `DROP TABLE` slot shifts.
4488 rel_id: row_header::RelId,
4489 rows: PersistentVec<Row<'static>>,
4490 /// v7.37.15 (Phase A.2) — per-row MVCC visibility headers
4491 /// parallel to `rows`. `headers.len() == rows.len()` is the
4492 /// load-bearing invariant; debug builds assert it on every
4493 /// scan boundary, release builds rely on it from
4494 /// disciplined insert / delete / update paths.
4495 ///
4496 /// Pre-v7.37.15-loaded tables (every row currently in the
4497 /// fleet) start as `RowHeader::frozen()` — `is_all_visible_fast()`
4498 /// returns `true`, so the per-row visibility gate Phase B
4499 /// adds is a no-op against any snapshot.
4500 ///
4501 /// Headers are NOT yet serialised into the envelope at this
4502 /// commit — on snapshot deserialize every row gets a fresh
4503 /// `RowHeader::frozen()`. Phase D adds the visibility-map
4504 /// + segment-freeze story which makes serialisation
4505 /// meaningful; until then the on-disk story is "the catalog
4506 /// is the set of visible rows."
4507 headers: PersistentVec<row_header::RowHeader>,
4508 /// v7.37.15 (Phase C.1) — stable per-relation row identity
4509 /// parallel to `rows` / `headers`. `rowids[i]` is the never-
4510 /// reused [`RowId`](row_header::RowId) of the row physically at
4511 /// slot `i`; `rowids.len() == rows.len()` joins the same load-
4512 /// bearing lock-step invariant as `headers`. Compaction (delete
4513 /// / vacuum) rebuilds all three vecs together so the id travels
4514 /// with the row while the slot shifts.
4515 ///
4516 /// Introduced additively: allocated + kept lock-step, but index
4517 /// locators still address rows by physical slot at this commit.
4518 /// Later phases migrate the lock table (C.4), HOT chains (D),
4519 /// and the WAL (Epic W) to address by `RowId`.
4520 ///
4521 /// Not yet serialised into the envelope — on load every row is
4522 /// assigned a fresh dense id `1..=len` (see `next_rowid`), which
4523 /// is sufficient while the id is process-local bookkeeping. The
4524 /// V6 envelope (Phase C.6) will persist ids so a WAL redo can
4525 /// name a row across restart.
4526 rowids: PersistentVec<row_header::RowId>,
4527 /// v7.37.15 (Phase C.1) — per-relation monotonic allocator for
4528 /// `rowids`. Starts at 1 (0 is the `RowId::UNASSIGNED` sentinel);
4529 /// every append takes `next_rowid` then increments. Never reused
4530 /// even after the row is deleted / vacuumed, so a stale lock /
4531 /// redo reference can be detected rather than silently aliasing a
4532 /// later row that reused the slot.
4533 ///
4534 /// 7.38.1 (S2.4, MATRIX #20 root cause) — the allocator is SHARED
4535 /// across every `clone()` of the relation (`Arc`), because the
4536 /// monotonic-never-reused promise is a LINEAGE invariant: each
4537 /// open transaction's shadow catalog is a clone, and when clones
4538 /// carried private counters two concurrent shadows minted the
4539 /// same id — duplicate rids in the base after both committed,
4540 /// aliasing every rid-addressed mechanism (locks, tombstones,
4541 /// redo, the rebase unique pre-check).
4542 next_rowid: alloc::sync::Arc<core::sync::atomic::AtomicU64>,
4543 /// v7.37.16 (autovacuum) — live count of tombstoned-but-present hot
4544 /// rows (`headers[i].xmax != XMAX_ALIVE`). Maintained incrementally:
4545 /// `mark_row_deleted` / `mark_rows_deleted` increment (the only
4546 /// tombstone producers), `delete_rows_no_index` recomputes over the
4547 /// survivors (it is the compaction hub every physical removal —
4548 /// including vacuum — flows through), and the v53 snapshot loader
4549 /// recounts verbatim-restored headers. Drives the engine's
4550 /// autovacuum threshold; not persisted (recomputed on load).
4551 dead_rows: u64,
4552 /// v7.39 (pg_stat knife A) — volatile per-table write counters
4553 /// backing `pg_stat_user_tables.n_tup_ins/upd/del`. Not persisted
4554 /// (PG's cumulative stats are shared-memory-volatile too — a
4555 /// restart zeroes them).
4556 stat_tup_ins: u64,
4557 stat_tup_upd: u64,
4558 stat_tup_del: u64,
4559 /// v7.39 (pg_stat knife B) — volatile scan counters
4560 /// (`seq_scan/seq_tup_read/idx_scan/idx_tup_fetch`). Atomics: the
4561 /// read paths that bump them hold only `&Table`.
4562 scan_stats: ScanStats,
4563 /// v7.39 (pg_stat knife C) — wall-clock stamps (unix µs, from the
4564 /// host ClockFn) for pg_stat_user_tables' last_autovacuum /
4565 /// last_analyze. Volatile, like PG's cumulative stats. SPG has no
4566 /// manual-VACUUM statement semantics, so last_vacuum stays NULL.
4567 last_autovacuum_us: Option<i64>,
4568 last_analyze_us: Option<i64>,
4569 indices: Vec<Index>,
4570 hot_bytes: u64,
4571 /// v6.7.0 — cached count of rows currently materialised in the
4572 /// cold tier via `RowLocator::Cold` entries across THIS table's
4573 /// indices. Populated by `ANALYZE` (walks every BTree index and
4574 /// counts Cold locators); the count survives until the next
4575 /// ANALYZE recomputes it. Surfaced via `spg_statistic.cold_row_count`
4576 /// and `spg_stat_segment.table_name`.
4577 ///
4578 /// Honest scope: this is a CACHED count, not a live one.
4579 /// Freezer / promote / DELETE don't currently update the cache
4580 /// incrementally — they invalidate it by setting the
4581 /// `cold_row_count_stale` flag, and the next ANALYZE re-walks.
4582 /// Incremental maintenance is a v6.7.x candidate if observation
4583 /// shows the ANALYZE walk cost dominates.
4584 cold_row_count: u64,
4585 /// v6.7.0 — set when the cached `cold_row_count` may be wrong
4586 /// because rows moved into / out of the cold tier since the last
4587 /// ANALYZE. The virtual-table surface reports the cached value
4588 /// regardless (operators run ANALYZE to refresh).
4589 cold_row_count_stale: bool,
4590 /// v7.34 (crash-recovery P0 #2) — row-level redo capture buffer.
4591 /// `None` (default, in-memory mode) captures nothing — zero overhead.
4592 /// `Some` (set by the engine when persistence is on, before a
4593 /// mutating call) makes `insert` / `update_row` / `delete_rows`
4594 /// record the physical [`RowChange`] they applied, which the engine
4595 /// drains after the statement and writes to the WAL in place of the
4596 /// SQL text. Transient: never serialized; a `Catalog::clone` between
4597 /// enable and drain copies it (cheap — empty in the steady state).
4598 redo_log: Option<Vec<RowChange>>,
4599 /// v7.39 (round 215) — per-`EXCLUDE`-constraint range-overlap indexes,
4600 /// one per single-`&&` constraint on an integer-keyable range column.
4601 /// Maintained incrementally on insert / update / rebuild (mirroring the
4602 /// BTree secondary indexes); NOT serialized — rebuilt from the schema's
4603 /// exclusion constraints on load. Empty for tables with no EXCLUDE
4604 /// constraint (the common case), so `Table::clone` pays nothing.
4605 excl_indexes: Vec<ExclRangeIndex>,
4606 /// v7.38.2 (R2) — incremental write-set track for the RC rebase.
4607 /// `extract_tx_writeset` used to full-scan every header per call —
4608 /// ~200 µs on a 20k-row table, per in-transaction statement, every
4609 /// time a concurrent COMMIT moved the epoch; on tpcb's 100k-row
4610 /// accounts that scan was the c2 concurrency cliff itself. The
4611 /// three version-marking funnels (`insert_with_xmin`,
4612 /// `mark_row_deleted`, `mark_rows_deleted`) record here instead.
4613 ///
4614 /// One track per table, keyed by the LAST writer version: a shadow
4615 /// belongs to one transaction, so a different version claiming the
4616 /// table simply replaces the track (on the committed base that
4617 /// makes memory bounded by the last writer's footprint). Extraction
4618 /// verifies every recorded position still carries the version —
4619 /// any mismatch (compaction, inherited track, pre-track rows)
4620 /// falls back to the full scan, so the fast path can be wrong
4621 /// about NOTHING, only slow.
4622 tx_write_track: Option<TxWriteTrack>,
4623 /// v7.39 (round 493) — the snapshot floor below which a deleted row
4624 /// version is invisible to everyone, as of the statement now running.
4625 ///
4626 /// Runtime only: never serialised, and `0` (the default) prunes
4627 /// nothing, so any path that forgets to set it is merely slower, not
4628 /// wrong. The engine sets it from `vacuum_oldest_active()` — the same
4629 /// floor `vacuum` itself takes — before the statement's inserts.
4630 prune_horizon: u64,
4631}
4632
4633/// Catalog: insertion-ordered `Vec<Table>` for stable iter / serialize,
4634/// plus a `BTreeMap<String, usize>` sidecar index so `get` / `get_mut`
4635/// run in O(log n) instead of the old linear scan with per-element
4636/// string compares.
4637///
4638/// A pure `BTreeMap<String, Table>` was tried in an interim version
4639/// of v3.1.2 and regressed the single-table catalog benches by ~10%
4640/// (the per-element `BTreeMap` overhead outweighs the lookup win
4641/// when n is small). The sidecar shape preserves the insertion-order
4642/// iteration the on-disk encoding relies on and keeps `last_mut`
4643/// (used by the deserialize hot path) cheap.
4644/// v7.39 (pg_stat blks knife) — catalog-wide cold-tier read counter
4645/// backing pg_stat_database.blks_read. Row-granular (SPG has no 8 KB
4646/// page notion): one cold-segment row resolution = one "block read",
4647/// one hot row access = one "block hit" — the hit RATIO monitoring
4648/// dashboards compute keeps its meaning. Volatile like PG's stats.
4649#[derive(Debug, Default)]
4650pub struct ColdReadStats {
4651 pub cold_reads: core::sync::atomic::AtomicU64,
4652}
4653
4654impl Clone for ColdReadStats {
4655 fn clone(&self) -> Self {
4656 Self {
4657 cold_reads: core::sync::atomic::AtomicU64::new(
4658 self.cold_reads.load(core::sync::atomic::Ordering::Relaxed),
4659 ),
4660 }
4661 }
4662}
4663
4664/// 7.38.1 S3.1 (D4) — the non-table catalog families that carry a
4665/// per-transaction dirty window (see `Catalog::dirty_nontable`). One
4666/// entry class per side-map the poisoned-commit merge reconciles.
4667#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
4668pub enum NonTableKind {
4669 Sequence,
4670 View,
4671 MaterializedView,
4672 EnumType,
4673 DomainType,
4674 CompositeType,
4675}
4676
4677#[derive(Debug, Clone, Default)]
4678pub struct Catalog {
4679 /// v7.39 (pg_stat blks knife) — see [`ColdReadStats`].
4680 pub cold_read_stats: ColdReadStats,
4681 tables: Vec<Table>,
4682 /// `name → tables[index]`. Kept in lock-step with `tables`.
4683 /// `create_table` is the only write path.
4684 by_name: BTreeMap<String, usize>,
4685 /// v7.39 (round 436) — the current session's temporary-table namespace.
4686 /// A temp table is stored under `<prefix><name>`, and every lookup tries
4687 /// that first: exactly PG's `pg_temp` search-path rule, and MySQL's
4688 /// "a TEMPORARY table shadows a permanent one of the same name".
4689 ///
4690 /// Process-local, never serialised: the engine sets it per session, and
4691 /// a catalog read back from disk starts with none. Kept here rather than
4692 /// at each of the ~170 engine call sites because `by_name` is private —
4693 /// this is the ONE place a table name becomes an index.
4694 temp_prefix: Option<String>,
4695 /// v7.39 (round 496) — the names of tables this catalog handle has had
4696 /// changed since the set was last cleared.
4697 ///
4698 /// Runtime only, never serialised. A transaction's shadow catalog
4699 /// clears it at BEGIN, so at COMMIT the set is exactly the tables the
4700 /// transaction changed — which is what lets a commit that cannot use
4701 /// the row-level merge install only those tables instead of the whole
4702 /// catalog, leaving another session's concurrent work in place.
4703 ///
4704 /// Recorded where the change actually happens (`get_mut`,
4705 /// `create_table`, `drop_table`) rather than from the statement
4706 /// classifier: round 494 tried classification for a correctness gate
4707 /// and it was wrong, because `SELECT lo_write(…)` reads as read-only.
4708 dirty_tables: alloc::collections::BTreeSet<String>,
4709 /// 7.38.1 S3.1 (D4) — the non-table twin of `dirty_tables`: which
4710 /// sequences / views / matviews / enum / domain / composite types
4711 /// THIS window created, altered, renamed or dropped. Counter
4712 /// advances (`nextval`) deliberately do NOT record — counter
4713 /// values merge via `sequence_counters` / `restore_sequence_
4714 /// counters`, and a tx that only consumed ids must not shadow a
4715 /// neighbour's ALTER SEQUENCE. Cleared by `clear_dirty_tables`
4716 /// (one window, both records).
4717 dirty_nontable: alloc::collections::BTreeSet<(NonTableKind, String)>,
4718 /// v7.37.15 (Phase C.1) — monotonic allocator for stable
4719 /// [`RelId`](row_header::RelId)s. Pre-incremented on each
4720 /// `create_table` so real ids start at 1 (0 is `UNASSIGNED`);
4721 /// never reused even after `DROP TABLE`, so a stale lock / redo
4722 /// reference is detectable. Process-local bookkeeping — not yet
4723 /// serialised; `deserialize` re-assigns dense ids on load (the
4724 /// V6 envelope, Phase C.6, will round-trip real ids).
4725 next_rel_id: u64,
4726 /// v5.1: in-memory cold-tier segments. Side-loaded via
4727 /// [`Catalog::load_segment_bytes`] — they live outside the
4728 /// catalog snapshot (caller persists them as separate files
4729 /// and re-loads on boot, until v5.3's `CatalogManifest` makes
4730 /// that wiring automatic). `RowLocator::Cold { segment_id, .. }`
4731 /// indexes this `Vec`. Cleared on `Catalog::new` / fresh
4732 /// `deserialize`.
4733 ///
4734 /// `Arc` wrap keeps `Catalog::clone` at O(N segments) bumps
4735 /// (rather than O(total segment bytes) memcpy) so the v4.42
4736 /// group-commit pre-image rollback invariant — clone is
4737 /// effectively free — survives the cold-tier addition.
4738 ///
4739 /// v6.7.3 — slots became `Option<…>` so cold-segment compaction
4740 /// can tombstone merged sources without breaking the
4741 /// `segment_id = index_into_vec` contract that on-disk
4742 /// `RowLocator::Cold { segment_id }` already serialized.
4743 /// `None` slot = the segment was retired by compaction; the
4744 /// physical file may still be on disk (next CHECKPOINT writes
4745 /// a manifest that no longer lists it, and the file becomes
4746 /// an orphan eligible for offline cleanup).
4747 cold_segments: Vec<Option<Arc<OwnedSegment>>>,
4748 /// v7.12.4 — user-defined functions (PL/pgSQL + SQL).
4749 /// Keyed by function name (PG overloading is out of scope).
4750 /// Bodies are stored as the raw source text the parser saw
4751 /// between `$$ ... $$`; the engine re-parses on each
4752 /// invocation. This keeps `spg-storage` free of `spg-sql`
4753 /// dependency — same pattern as partial-index predicates.
4754 functions: BTreeMap<String, FunctionDef>,
4755 /// v7.12.4 — triggers in insertion order. PG18-measured (round
4756 /// 753): PG fires same-event triggers in NAME order (a_trig
4757 /// before z_trig regardless of creation order); SPG fires in
4758 /// insertion order — a real divergence, ledgered as F31-B2.
4759 triggers: Vec<TriggerDef>,
4760 /// v7.39 (round 139) — query-rewrite RULEs, flat like triggers.
4761 rules: Vec<RuleDef>,
4762 /// v7.39 (round 280) — extended-statistics objects. Recorded so a
4763 /// pg_dump restores them and reflection reports them; the planner
4764 /// does not consult them yet.
4765 statistics_ext: Vec<StatisticsExtDef>,
4766 /// v7.39 (round 287) — server-side large objects, keyed by OID.
4767 /// PG stores them as 2 KB pages in `pg_largeobject`; the page split
4768 /// is a storage detail of ITS heap, so SPG holds the whole byte
4769 /// string and renders the pages on read. What must match is the
4770 /// observable surface: the OIDs, the bytes, and the page rows.
4771 large_objects: alloc::collections::BTreeMap<u32, Vec<u8>>,
4772 /// v7.17.0 — catalogued SEQUENCE objects (Phase 1.1). Each
4773 /// `nextval(name)` reaches in here, atomically increments
4774 /// `last_value` / flips `is_called`, returns the new value.
4775 /// Persisted in catalog FILE_VERSION 26+; older catalogs
4776 /// deserialise with an empty map.
4777 sequences: BTreeMap<String, SequenceDef>,
4778 /// v7.39 (read01 round 60) — the `public` schema's ACL (PG
4779 /// `pg_namespace.nspacl`). EMPTY = PG's default, which is not "nothing":
4780 /// PUBLIC holds USAGE and the owner holds USAGE + CREATE. Materialised on
4781 /// the first GRANT / REVOKE, exactly like a table's relacl.
4782 schema_acl: Vec<AclItem>,
4783 /// v7.39 (read01 round 60) — the database's ACL. EMPTY = PG's default:
4784 /// PUBLIC holds CONNECT + TEMPORARY, the owner holds all three.
4785 database_acl: Vec<AclItem>,
4786 /// v7.17.0 — catalogued VIEW objects (Phase 1.2). Each
4787 /// `SELECT FROM v` at engine exec-time looks up `v` here and
4788 /// prepends the view body as a synthetic CTE. Persisted in
4789 /// catalog FILE_VERSION 27+; older catalogs deserialise with
4790 /// an empty map.
4791 views: BTreeMap<String, ViewDef>,
4792 /// v7.17.0 — catalogued MATERIALIZED VIEW source registry
4793 /// (Phase 1.3). Maps name → SELECT source. The materialised
4794 /// rows themselves live as a regular `Table` with the same
4795 /// name; REFRESH re-parses + re-executes the source against
4796 /// the table. Persisted in catalog FILE_VERSION 28+;
4797 /// older catalogs deserialise with an empty map.
4798 materialized_views: BTreeMap<String, String>,
4799 /// v7.17.0 — catalogued user-defined ENUM types (Phase 1.4).
4800 /// Maps name → label list. Columns reference these by name
4801 /// via `ColumnSchema.user_enum_type`. Persisted in catalog
4802 /// FILE_VERSION 29+; older catalogs deserialise with an empty
4803 /// map.
4804 enum_types: BTreeMap<String, EnumDef>,
4805 /// v7.17.0 — catalogued user-defined DOMAIN types (Phase 1.5).
4806 /// Maps name → base + CHECK constraints. Columns reference
4807 /// these by name via `ColumnSchema.user_domain_type`.
4808 /// Persisted in catalog FILE_VERSION 30+; older catalogs
4809 /// deserialise with an empty map.
4810 domain_types: BTreeMap<String, DomainDef>,
4811 /// v7.39 (read01 round 50) — `COMMENT ON <kind> <obj> IS '…'` store.
4812 /// Keyed by a canonical `"<kind>:<name>"` string (`"table:t"`,
4813 /// `"column:t.c"`, `"index:i"`, `"view:v"`, …) so a new commentable
4814 /// object kind needs no schema change. `COMMENT … IS NULL` removes the
4815 /// entry. Persisted in catalog FILE_VERSION 61+; older catalogs
4816 /// deserialise with an empty map. Read back by obj_description /
4817 /// col_description and the pg_description view.
4818 comments: BTreeMap<String, String>,
4819 /// v7.39 (round 547) — PG's `pg_db_role_setting`: the GUC defaults
4820 /// `ALTER ROLE … SET` / `ALTER DATABASE … SET` record, applied when
4821 /// a session starts.
4822 ///
4823 /// Keyed exactly as PG keys it — `(database, role)` where an empty
4824 /// name is PG's oid 0, meaning "all". So `ALTER ROLE ALL SET` is
4825 /// `("", "")`, `ALTER DATABASE d SET` is `(d, "")`, `ALTER ROLE r
4826 /// SET` is `("", r)` and `ALTER ROLE r IN DATABASE d SET` is
4827 /// `(d, r)`. The value is that scope's parameter list.
4828 db_role_settings: BTreeMap<(String, String), BTreeMap<String, String>>,
4829 /// v7.39 (round 550) — replication slots, by name.
4830 ///
4831 /// A slot in PG is two things: a named record, and a reservation
4832 /// that holds WAL back. SPG keeps the record — which is what every
4833 /// setup script and monitoring query reads — and reports
4834 /// `wal_status = 'unreserved'`, PG's own word for a slot that no
4835 /// longer holds WAL. The whole family used to answer NULL and
4836 /// report success, so `pg_drop_replication_slot('nosuchslot')` said
4837 /// it worked and a setup script created nothing.
4838 ///
4839 /// Value: (plugin, slot_type). `plugin` is empty for a physical slot.
4840 replication_slots: BTreeMap<String, (String, String)>,
4841 /// v7.37.42-T2 ζ-B — catalogued user-defined COMPOSITE types
4842 /// (`CREATE TYPE name AS (field_name field_type, …)`). Columns
4843 /// reference these by name via
4844 /// `ColumnSchema.user_composite_type` (parallel to
4845 /// `user_enum_type` / `user_domain_type`). Persisted in catalog
4846 /// FILE_VERSION 52+; older catalogs deserialise with an empty
4847 /// map.
4848 composite_types: BTreeMap<String, CompositeDef>,
4849 /// v7.17.0 — schema-namespace registry (Phase 1.6). Tracks
4850 /// which schemas exist. `public`, `pg_catalog`, and
4851 /// `information_schema` are built-in and always present.
4852 /// Schema-qualified table references still strip the prefix
4853 /// at lookup time per v7.16-and-earlier — full
4854 /// schema-as-isolation is v7.18+ scope. Persisted in catalog
4855 /// FILE_VERSION 31+; older catalogs deserialise with just
4856 /// the built-ins.
4857 schemas: alloc::collections::BTreeSet<String>,
4858}
4859
4860/// v7.12.4 — catalogued user-defined function. `body` is the raw
4861/// source text between `$$ ... $$`; the engine re-parses it on
4862/// invocation. This keeps the storage codec stable when the
4863/// PL/pgSQL surface grows (no breaking-change risk on the disk
4864/// format).
4865// v7.39 (round 322, V46) — no longer `Eq`: COST / ROWS are f64, as in PG.
4866#[derive(Debug, Clone, PartialEq)]
4867pub struct FunctionDef {
4868 pub name: String,
4869 /// Display form of the argument list, e.g.
4870 /// `"(name TEXT, ts TIMESTAMP)"`. Empty `"()"` for the trigger
4871 /// function shape. Parser-side canonicalised before storage.
4872 pub args_repr: String,
4873 /// Display form of the return type, e.g. `"TRIGGER"` /
4874 /// `"INT"` / `"SETOF text"`. The engine special-cases
4875 /// `"TRIGGER"` (case-insensitive) to gate trigger-only
4876 /// semantics (NEW/OLD).
4877 pub returns: String,
4878 /// `LANGUAGE` clause, lowercased. `"plpgsql"` / `"sql"`.
4879 pub language: String,
4880 /// Source body of the function. PL/pgSQL: includes the
4881 /// surrounding `BEGIN ... END;`. SQL: includes the
4882 /// statement(s). The engine re-parses on invocation; bad
4883 /// bodies surface as a parse error at CALL time, not CREATE.
4884 pub body: String,
4885 /// v7.39 (read01 round 61) — the role that ran CREATE FUNCTION.
4886 pub owner: Option<String>,
4887 /// v7.39 (read01 round 61) — explicit GRANTs (PG `pg_proc.proacl`). EMPTY
4888 /// is NOT "nobody may call it": PG grants EXECUTE to PUBLIC by default, and
4889 /// leaves proacl NULL to say so. The list materialises on the first
4890 /// GRANT / REVOKE.
4891 pub acl: Vec<AclItem>,
4892 /// v7.39 (round 322, V46) — `IMMUTABLE` / `STRICT` / `PARALLEL SAFE` /
4893 /// `SECURITY DEFINER` / `LEAKPROOF` / `COST` / `ROWS`. `strict` is the
4894 /// only one with execution semantics today (a NULL argument yields a
4895 /// NULL result without running the body); the rest are recorded so
4896 /// `pg_get_functiondef` and `pg_proc` report what was declared.
4897 pub volatility: u8,
4898 pub strict: bool,
4899 pub security_definer: bool,
4900 pub leakproof: bool,
4901 pub parallel: u8,
4902 pub cost: Option<f64>,
4903 pub rows: Option<f64>,
4904}
4905
4906/// v7.39 (round 322, V46) — `FunctionDef.volatility` codes: PG's
4907/// `pg_proc.provolatile` letters.
4908pub const FN_VOLATILE: u8 = b'v';
4909pub const FN_IMMUTABLE: u8 = b'i';
4910pub const FN_STABLE: u8 = b's';
4911
4912/// v7.39 (round 322, V46) — `FunctionDef.parallel` codes: PG's
4913/// `pg_proc.proparallel` letters.
4914pub const FN_PARALLEL_UNSAFE: u8 = b'u';
4915pub const FN_PARALLEL_RESTRICTED: u8 = b'r';
4916pub const FN_PARALLEL_SAFE: u8 = b's';
4917
4918/// v7.39 (round 315, V19) — which catalogued function does a persisted
4919/// ACL key refer to?
4920///
4921/// The key was computed by whichever formula was current when the image
4922/// was written, and the multi-word fix changed that formula for bare
4923/// types like `double precision`. A miss therefore does NOT mean "no
4924/// such function": an older image's key would land nowhere and its owner
4925/// and grants would be dropped in silence. Exact match first, then the
4926/// pre-fix formula.
4927#[must_use]
4928pub fn resolve_stored_function_key(
4929 functions: &BTreeMap<String, FunctionDef>,
4930 stored: &str,
4931) -> Option<String> {
4932 if functions.contains_key(stored) {
4933 return Some(stored.to_string());
4934 }
4935 functions
4936 .values()
4937 .find(|f| function_signature_key_legacy(&f.name, &f.args_repr) == stored)
4938 .map(|f| function_signature_key(&f.name, &f.args_repr))
4939}
4940
4941/// v7.39 (round 344, V49) — re-exported from [`spg_sql`], which owns the
4942/// SQL type spellings. This crate carried a byte-identical copy because
4943/// the two were siblings that did not depend on each other; spg-sql is a
4944/// dependency-free leaf, so the dependency is acyclic and the publish
4945/// order already puts it first. One list, one place to keep it right.
4946pub use spg_sql::parser::is_multiword_type_phrase;
4947
4948/// v7.39 (round 315, V19) — the signature key as computed BEFORE the
4949/// multi-word fix, used only to recognise what an older image wrote.
4950///
4951/// The function catalogue recomputes its keys from the stored name and
4952/// argument text on load, so it needs no migration. The ACL block does
4953/// not: it persists the computed key as a string and matches on it. A
4954/// key that changed shape would simply fail to match, and the owner and
4955/// grants would be dropped without a word — so the loader falls back to
4956/// this when the stored key finds nothing.
4957#[must_use]
4958pub fn function_signature_key_legacy(name: &str, args_repr: &str) -> String {
4959 let inner = args_repr
4960 .trim()
4961 .trim_start_matches('(')
4962 .trim_end_matches(')');
4963 let types: Vec<String> = if inner.trim().is_empty() {
4964 Vec::new()
4965 } else {
4966 inner
4967 .split(',')
4968 .map(|part| {
4969 let mut words: Vec<&str> = part.split_whitespace().collect();
4970 if !words.is_empty()
4971 && (words[0].eq_ignore_ascii_case("OUT")
4972 || words[0].eq_ignore_ascii_case("INOUT"))
4973 {
4974 words.remove(0);
4975 }
4976 let ty = if words.len() >= 2 {
4977 words[1..].join(" ")
4978 } else {
4979 words.first().map_or(String::new(), |w| (*w).to_string())
4980 };
4981 normalize_type_name(&ty)
4982 })
4983 .collect()
4984 };
4985 format!("{}({})", name.to_ascii_lowercase(), types.join(","))
4986}
4987
4988pub fn function_signature_key(name: &str, args_repr: &str) -> String {
4989 let types = function_arg_types(args_repr);
4990 format!("{}({})", name.to_ascii_lowercase(), types.join(","))
4991}
4992
4993/// The declared argument TYPES of a function, out of its `args_repr`
4994/// (`"(x INT, y DOUBLE PRECISION)"` → `["int", "float"]`). An entry may be a
4995/// bare type with no name (`"(INT)"`).
4996#[must_use]
4997pub fn function_arg_types(args_repr: &str) -> Vec<String> {
4998 let inner = args_repr
4999 .trim()
5000 .trim_start_matches('(')
5001 .trim_end_matches(')');
5002 if inner.trim().is_empty() {
5003 return Vec::new();
5004 }
5005 inner
5006 .split(',')
5007 .map(|part| {
5008 let mut words: Vec<&str> = part.split_whitespace().collect();
5009 // `OUT x INT` / `INOUT x INT` — the mode is not part of the type.
5010 if !words.is_empty()
5011 && (words[0].eq_ignore_ascii_case("OUT") || words[0].eq_ignore_ascii_case("INOUT"))
5012 {
5013 words.remove(0);
5014 }
5015 // v7.39 (round 315, V19) — two or more words is USUALLY
5016 // `name TYPE`, but not when the type itself is spelled in
5017 // several words. `double precision` was read as a parameter
5018 // named "double" of type "precision", so it keyed differently
5019 // from `x double precision` — the same signature written two
5020 // ways did not resolve to the same function. Decide by asking
5021 // whether the whole phrase names a type first; only then is
5022 // the leading word a parameter name.
5023 let whole = words.join(" ");
5024 let ty = if words.len() >= 2 && !is_multiword_type_phrase(&whole) {
5025 words[1..].join(" ")
5026 } else {
5027 whole
5028 };
5029 normalize_type_name(&ty)
5030 })
5031 .collect()
5032}
5033
5034/// v7.39 (read01 round 65) — the declared argument NAMES of a function (`""` for
5035/// a bare type with no name).
5036#[must_use]
5037pub fn function_arg_names(args_repr: &str) -> Vec<String> {
5038 let inner = args_repr
5039 .trim()
5040 .trim_start_matches('(')
5041 .trim_end_matches(')');
5042 if inner.trim().is_empty() {
5043 return Vec::new();
5044 }
5045 inner
5046 .split(',')
5047 .map(|part| {
5048 let mut words: Vec<&str> = part.split_whitespace().collect();
5049 if !words.is_empty()
5050 && (words[0].eq_ignore_ascii_case("OUT") || words[0].eq_ignore_ascii_case("INOUT"))
5051 {
5052 words.remove(0);
5053 }
5054 if words.len() >= 2 {
5055 words[0].to_string()
5056 } else {
5057 String::new()
5058 }
5059 })
5060 .collect()
5061}
5062
5063/// Fold PG's type aliases so a signature key is stable across spellings.
5064/// Unknown names pass through lower-cased — consistency is what the key needs.
5065#[must_use]
5066pub fn normalize_type_name(ty: &str) -> String {
5067 let t = ty.trim().to_ascii_lowercase();
5068 // Peel a precision/length modifier: `numeric(10,2)`, `varchar(64)`.
5069 let base = t.split_once('(').map_or(t.as_str(), |(h, _)| h).trim();
5070 match base {
5071 "int" | "int4" | "integer" => "int",
5072 "bigint" | "int8" => "bigint",
5073 "smallint" | "int2" => "smallint",
5074 "text" | "varchar" | "character varying" | "char" | "character" | "bpchar" => "text",
5075 "bool" | "boolean" => "bool",
5076 "float" | "float8" | "double precision" => "float",
5077 "real" | "float4" => "real",
5078 "numeric" | "decimal" => "numeric",
5079 "timestamptz" | "timestamp with time zone" => "timestamptz",
5080 "timestamp" | "timestamp without time zone" => "timestamp",
5081 other => other,
5082 }
5083 .to_string()
5084}
5085
5086/// v7.12.4 — catalogued trigger. References its function by
5087/// name; the function must exist at TRIGGER creation time
5088/// (forward references are deferred to v7.12.5+).
5089#[derive(Debug, Clone, PartialEq, Eq)]
5090pub struct TriggerDef {
5091 pub name: String,
5092 /// Watched table. Trigger is dropped when the table drops.
5093 pub table: String,
5094 /// `"BEFORE"` / `"AFTER"` / `"INSTEAD OF"`. Stored as the
5095 /// uppercased keyword so deserialised catalogs round-trip
5096 /// without canonicalisation surprises.
5097 pub timing: String,
5098 /// Each entry is one of `"INSERT"` / `"UPDATE"` / `"DELETE"`
5099 /// / `"TRUNCATE"`. `INSERT OR UPDATE` parses to two entries.
5100 pub events: Vec<String>,
5101 /// `"ROW"` / `"STATEMENT"`. v7.12.4 ships `"ROW"` only;
5102 /// `"STATEMENT"` parses and persists but the executor
5103 /// refuses it at trigger fire time.
5104 pub for_each: String,
5105 /// Name of the PL/pgSQL function to invoke.
5106 pub function: String,
5107 /// v7.13.0 — `UPDATE OF col, col, …` column-list filter
5108 /// (mailrs round-5 G7). Non-empty means the trigger fires
5109 /// only when at least one of these columns appears in the
5110 /// UPDATE's SET list. Empty = no column filter. Stored in
5111 /// catalog FILE_VERSION 23+; older catalogs deserialise with
5112 /// an empty vec.
5113 pub update_columns: Vec<String>,
5114 /// v7.16.1 — whether the trigger fires when its watched
5115 /// event occurs. Toggled by `ALTER TABLE … { ENABLE |
5116 /// DISABLE } TRIGGER …`; pg_dump --disable-triggers wraps
5117 /// every data block with a DISABLE/ENABLE pair so the
5118 /// rows already-computed in prod don't get re-rewritten.
5119 /// Defaults to `true` at CREATE TRIGGER time. Stored in
5120 /// catalog FILE_VERSION 25+; older catalogs deserialise
5121 /// with `enabled = true`.
5122 pub enabled: bool,
5123 /// v7.39 (round 138) — the deparsed `WHEN ( condition )` predicate text
5124 /// (re-parsed at fire time to filter row triggers). Empty = no WHEN.
5125 /// Persisted from FILE_VERSION 70; older catalogs read back empty.
5126 pub when_condition: String,
5127}
5128
5129/// v7.39 (round 280) — one `CREATE STATISTICS` object.
5130#[derive(Debug, Clone, PartialEq, Eq)]
5131pub struct StatisticsExtDef {
5132 pub name: String,
5133 pub table: String,
5134 /// PG's single-letter kinds: `d` ndistinct, `f` dependencies,
5135 /// `m` mcv. PG's default set is all three.
5136 pub kinds: Vec<String>,
5137 pub columns: Vec<String>,
5138}
5139
5140/// v7.39 (round 139) — a catalogued query-rewrite RULE. Stored flat like
5141/// `TriggerDef`, keyed by `(name, table)`. Command / WHEN text is deparsed SQL
5142/// re-parsed at rewrite time (the same round-trip trick as
5143/// `TriggerDef.when_condition`). Persisted from FILE_VERSION 71.
5144#[derive(Debug, Clone, PartialEq, Eq)]
5145pub struct RuleDef {
5146 pub name: String,
5147 pub table: String,
5148 /// Event keyword, uppercased: `INSERT` / `UPDATE` / `DELETE` / `SELECT`.
5149 pub event: String,
5150 /// `true` = `DO INSTEAD`, `false` = `DO ALSO`.
5151 pub instead: bool,
5152 /// Deparsed `WHERE` predicate text; empty = unconditional.
5153 pub when_condition: String,
5154 /// Deparsed DO command statements; empty = `NOTHING`.
5155 pub commands: Vec<String>,
5156}
5157
5158/// v7.17.0 — catalogued SEQUENCE. PG semantics: a counter object
5159/// returning monotonically increasing values via `nextval(name)`.
5160/// `last_value` is the most recent value handed out; `is_called`
5161/// is false until the first `nextval`/`setval`. Stored separately
5162/// from tables in the catalog.
5163#[derive(Debug, Clone, PartialEq, Eq)]
5164pub struct SequenceDef {
5165 pub name: String,
5166 /// Data type — narrows the i64 range. PG default BIGINT.
5167 pub data_type: SequenceDataType,
5168 pub start: i64,
5169 pub increment: i64,
5170 pub min_value: i64,
5171 pub max_value: i64,
5172 pub cache: i64,
5173 pub cycle: bool,
5174 /// `OWNED BY` target — `(table, column)` or NONE.
5175 pub owned_by: Option<(String, String)>,
5176 /// Most recently handed-out value. Meaningless when
5177 /// `is_called == false`; in that case the NEXT `nextval`
5178 /// will return `start`.
5179 pub last_value: i64,
5180 pub is_called: bool,
5181 /// v7.39 (read01 round 60) — the role that ran CREATE SEQUENCE. `None` = an
5182 /// image written before FILE_VERSION 66, which predates sequence owners.
5183 pub owner: Option<String>,
5184 /// v7.39 (read01 round 60) — explicit GRANTs on this sequence. A sequence's
5185 /// meaningful privileges are SELECT (`currval`), UPDATE (`setval`) and
5186 /// USAGE (`nextval`).
5187 pub acl: Vec<AclItem>,
5188}
5189
5190/// v7.17.0 — sequence integer width.
5191#[derive(Debug, Clone, Copy, PartialEq, Eq)]
5192pub enum SequenceDataType {
5193 SmallInt,
5194 Int,
5195 BigInt,
5196}
5197
5198/// v7.17.0 Phase 1.6 — built-in schema names that every Catalog
5199/// understands without an explicit CREATE SCHEMA. Used by
5200/// [`Catalog::schema_exists`] and the engine's schema-qualified
5201/// lookup path.
5202#[must_use]
5203pub fn is_builtin_schema(name: &str) -> bool {
5204 name.eq_ignore_ascii_case("public")
5205 || name.eq_ignore_ascii_case("pg_catalog")
5206 || name.eq_ignore_ascii_case("information_schema")
5207}
5208
5209/// v7.17.0 — parse a PG-canonical UUID text representation into the
5210/// 16-byte network-order layout used by `Value::Uuid`. Accepted input
5211/// shapes (all case-insensitive):
5212/// * Canonical hyphenated 8-4-4-4-12 (`550e8400-e29b-41d4-a716-446655440000`)
5213/// * Unhyphenated 32-char hex (`550e8400e29b41d4a716446655440000`)
5214/// * Either form wrapped in `{ ... }`
5215///
5216/// Returns `None` for any malformed input (wrong length, non-hex
5217/// characters, misplaced hyphens). The caller surfaces a SQL error
5218/// at coercion time — silent acceptance of garbage would mask
5219/// application bugs and is exactly the divergence from PG that
5220/// breaks the 0-change cutover promise.
5221#[must_use]
5222pub fn parse_uuid_str(input: &str) -> Option<[u8; 16]> {
5223 let s = input.trim();
5224 // Strip surrounding braces if present.
5225 let s = if let Some(inner) = s.strip_prefix('{').and_then(|x| x.strip_suffix('}')) {
5226 inner
5227 } else {
5228 s
5229 };
5230 // Two valid shapes after braces are stripped: 32 hex chars or
5231 // the canonical 36-char hyphenated form.
5232 let hex: String = match s.len() {
5233 32 => s.to_ascii_lowercase(),
5234 36 => {
5235 // Hyphens must be exactly at positions 8, 13, 18, 23.
5236 let b = s.as_bytes();
5237 if b[8] != b'-' || b[13] != b'-' || b[18] != b'-' || b[23] != b'-' {
5238 return None;
5239 }
5240 let mut out = String::with_capacity(32);
5241 out.push_str(&s[0..8]);
5242 out.push_str(&s[9..13]);
5243 out.push_str(&s[14..18]);
5244 out.push_str(&s[19..23]);
5245 out.push_str(&s[24..36]);
5246 out.make_ascii_lowercase();
5247 out
5248 }
5249 _ => return None,
5250 };
5251 let bytes = hex.as_bytes();
5252 let mut out = [0u8; 16];
5253 for i in 0..16 {
5254 let hi = hex_nibble(bytes[i * 2])?;
5255 let lo = hex_nibble(bytes[i * 2 + 1])?;
5256 out[i] = (hi << 4) | lo;
5257 }
5258 Some(out)
5259}
5260
5261fn hex_nibble(b: u8) -> Option<u8> {
5262 match b {
5263 b'0'..=b'9' => Some(b - b'0'),
5264 b'a'..=b'f' => Some(10 + b - b'a'),
5265 b'A'..=b'F' => Some(10 + b - b'A'),
5266 _ => None,
5267 }
5268}
5269
5270/// v7.17.0 — render a `Value::Uuid` payload as the canonical
5271/// lowercase 8-4-4-4-12 hyphenated form PG `text` cast surfaces.
5272#[must_use]
5273pub fn format_uuid(b: &[u8; 16]) -> String {
5274 const HEX: &[u8; 16] = b"0123456789abcdef";
5275 let mut out = String::with_capacity(36);
5276 for (i, byte) in b.iter().enumerate() {
5277 if matches!(i, 4 | 6 | 8 | 10) {
5278 out.push('-');
5279 }
5280 out.push(HEX[(byte >> 4) as usize] as char);
5281 out.push(HEX[(byte & 0x0f) as usize] as char);
5282 }
5283 out
5284}
5285
5286/// v7.17.0 Phase 1.5 — catalogued user-defined DOMAIN. A domain
5287/// is a named CHECK-constrained alias over a built-in type;
5288/// columns bound to it inherit the base type plus the CHECK
5289/// predicates + NOT NULL + DEFAULT at INSERT/UPDATE time.
5290/// v7.37.17 (Phase E RC rebase) — the write-set one writer version left
5291/// on a table, addressed by stable [`row_header::RowId`]s so it can be
5292/// replayed onto a fresher clone of the relation whose physical slots
5293/// differ. Produced by [`Table::extract_tx_writeset`], consumed by
5294/// [`Table::replay_tx_writeset`].
5295#[derive(Debug, Clone, Default)]
5296pub struct TxWriteSet {
5297 /// INSERTs and UPDATE-new-versions (`header.xmin == v`).
5298 pub inserted: Vec<(row_header::RowId, Row<'static>)>,
5299 /// DELETE / UPDATE-old-version targets (`header.xmax == v`).
5300 pub tombstoned: Vec<row_header::RowId>,
5301}
5302
5303impl TxWriteSet {
5304 #[must_use]
5305 pub fn is_empty(&self) -> bool {
5306 self.inserted.is_empty() && self.tombstoned.is_empty()
5307 }
5308}
5309
5310/// v7.39 (round 260) — one named CHECK on a domain. PG auto-names an
5311/// unnamed one `<domain>_check`, then `_check1`, `_check2`, … (probed).
5312#[derive(Debug, Clone, PartialEq, Eq)]
5313pub struct DomainCheck {
5314 pub name: String,
5315 /// The predicate source, referencing the pseudo-column `VALUE`.
5316 pub expr: String,
5317}
5318
5319/// `default` / `checks` are stored as Display-form source so
5320/// `spg-storage` stays free of `spg-sql` dependency — same
5321/// pattern as FunctionDef / ViewDef.
5322#[derive(Debug, Clone, PartialEq, Eq)]
5323pub struct DomainDef {
5324 pub name: String,
5325 pub base_type: DataType,
5326 pub nullable: bool,
5327 pub default: Option<String>,
5328 /// v7.39 (round 260) — each CHECK carries its constraint NAME, so
5329 /// `ALTER DOMAIN … DROP CONSTRAINT <name>` can find it and the
5330 /// violation message can report the constraint that actually failed.
5331 /// PG's auto-naming for an unnamed check is `<domain>_check`, then
5332 /// `_check1`, `_check2`, … (probed).
5333 pub checks: Vec<DomainCheck>,
5334 /// v7.39 (round 258/259) — when this domain was declared over ANOTHER
5335 /// domain (`CREATE DOMAIN child AS parent CHECK (…)`), the parent's
5336 /// name. `base_type` is the ultimate scalar type either way, so
5337 /// without this the parent's constraints were invisible and a value
5338 /// violating them was silently accepted. PG checks the whole chain,
5339 /// base-first, and an `ALTER DOMAIN` on the parent takes effect for
5340 /// the child immediately (probed) — so the chain is walked at check
5341 /// time rather than copied at CREATE time. Catalog FILE_VERSION 74+.
5342 pub base_domain: Option<String>,
5343}
5344
5345/// v7.17.0 Phase 1.4 — catalogued user-defined ENUM type. The
5346/// label vector is order-preserving (PG enum ordering follows the
5347/// declared order). At INSERT/UPDATE on a column bound to this
5348/// enum, the engine looks up the value against `labels` and
5349/// rejects non-members.
5350#[derive(Debug, Clone, PartialEq, Eq)]
5351pub struct EnumDef {
5352 pub name: String,
5353 pub labels: Vec<String>,
5354}
5355
5356/// v7.37.42-T2 ζ-B — catalogued user-defined COMPOSITE type
5357/// (`CREATE TYPE name AS (field_name field_type, ...)`). Order
5358/// matters: PG composite literals are positional, and SPG mirrors
5359/// that. Stored as ordered `(name, DataType)` pairs to keep the
5360/// codec straightforward and to allow eventual `Value::Composite`
5361/// bodies to encode positionally. Persisted in catalog FILE_VERSION
5362/// 52+; older catalogs deserialise with an empty composite_types
5363/// map. Composite types can be used as a column type by spelling
5364/// the composite's name; the resolution from
5365/// `ColumnSchema.user_composite_type = Some(name)` happens at the
5366/// engine boundary (parallel to `user_enum_type` /
5367/// `user_domain_type`). The dense storage shape — JSON-text body
5368/// keyed by the composite's field list — keeps the codec free of
5369/// recursive `Value` bodies until the full Value::Composite arena
5370/// migration in a later phase.
5371#[derive(Debug, Clone, PartialEq, Eq)]
5372pub struct CompositeDef {
5373 pub name: String,
5374 /// Ordered `(field_name, field_type)` pairs. PG composite
5375 /// literals are positional, so order is part of the type's
5376 /// identity.
5377 pub fields: Vec<(String, DataType)>,
5378 /// v7.39 (round 264) — parallel to `fields`: the USER type name of
5379 /// each field when it is itself a composite (or another named user
5380 /// type). `DataType` has no room for one, so a nested composite
5381 /// field resolved to the parser's Text placeholder and the inner
5382 /// record stayed TEXT — `(x).inner.street` errored, `pg_typeof`
5383 /// said text, and `row_to_json` nested a string instead of an
5384 /// object. Same shape as `ColumnSchema.user_composite_type` and
5385 /// `DomainDef.base_domain`. Catalog FILE_VERSION 76+; an older
5386 /// catalog reads all-None, which is what it meant.
5387 pub field_user_types: Vec<Option<String>>,
5388}
5389
5390/// v7.17.0 Phase 1.2 — catalogued VIEW. The body is stored as the
5391/// raw source text the parser saw between `AS` and the statement
5392/// terminator; the engine re-parses on each invocation. Same
5393/// pattern as `FunctionDef` — keeps `spg-storage` free of
5394/// `spg-sql` dependency.
5395#[derive(Debug, Clone, PartialEq, Eq)]
5396pub struct ViewDef {
5397 pub name: String,
5398 /// Optional `(col, col, …)` rename list. Empty when the body's
5399 /// projected names are used directly.
5400 pub columns: Vec<String>,
5401 /// Raw SELECT source. Display-rendered at storage time so the
5402 /// catalog round-trips a deterministic form regardless of
5403 /// whitespace / comments in the original input. Re-parsed at
5404 /// SELECT-from-view time to materialise as a synthetic CTE.
5405 pub body: String,
5406 /// v7.39 (round 132) — `WITH CHECK OPTION`: 0 = none, 1 = LOCAL,
5407 /// 2 = CASCADED. A storage-local u8 (no dependency on the SQL AST).
5408 /// Persisted from FILE_VERSION 69; older catalogs read back as 0.
5409 pub check_option: u8,
5410}
5411
5412impl SequenceDataType {
5413 /// PG default min/max per AS clause.
5414 pub fn default_bounds(self, increment_positive: bool) -> (i64, i64) {
5415 match self {
5416 Self::SmallInt => {
5417 if increment_positive {
5418 (1, i64::from(i16::MAX))
5419 } else {
5420 (i64::from(i16::MIN), -1)
5421 }
5422 }
5423 Self::Int => {
5424 if increment_positive {
5425 (1, i64::from(i32::MAX))
5426 } else {
5427 (i64::from(i32::MIN), -1)
5428 }
5429 }
5430 Self::BigInt => {
5431 if increment_positive {
5432 (1, i64::MAX)
5433 } else {
5434 (i64::MIN, -1)
5435 }
5436 }
5437 }
5438 }
5439}
5440
5441impl Catalog {
5442 /// v7.37.15 (Phase D) — fleet-wide vacuum pass. Walks every
5443 /// user table and reclaims rows whose delete-commit version is
5444 /// older than `oldest_active_snapshot`. Returns an aggregated
5445 /// report with per-table breakdown so hosts can emit metrics.
5446 ///
5447 /// `dry_run = true` reports the work without doing it. Use it
5448 /// to estimate the cost before scheduling a real pass.
5449 pub fn vacuum_all(
5450 &mut self,
5451 oldest_active_snapshot: u64,
5452 dry_run: bool,
5453 ) -> vacuum::VacuumReport {
5454 let mut total = vacuum::VacuumReport::default();
5455 // Snapshot the table names so we don't hold an immutable
5456 // borrow during the get_mut loop.
5457 let names: Vec<String> = self
5458 .tables
5459 .iter()
5460 .map(|t| t.schema().name.clone())
5461 .collect();
5462 for name in names {
5463 let Some(t) = self.get_mut(&name) else {
5464 continue;
5465 };
5466 let r = t.vacuum(oldest_active_snapshot, dry_run);
5467 if r.rows_reclaimed > 0 {
5468 total.per_table.push((name, r.rows_reclaimed));
5469 }
5470 total.rows_reclaimed += r.rows_reclaimed;
5471 total.rows_examined += r.rows_examined;
5472 }
5473 total
5474 }
5475
5476 pub const fn new() -> Self {
5477 Self {
5478 cold_read_stats: ColdReadStats {
5479 cold_reads: core::sync::atomic::AtomicU64::new(0),
5480 },
5481 tables: Vec::new(),
5482 by_name: BTreeMap::new(),
5483 temp_prefix: None,
5484 dirty_tables: alloc::collections::BTreeSet::new(),
5485 dirty_nontable: alloc::collections::BTreeSet::new(),
5486 next_rel_id: 0,
5487 cold_segments: Vec::new(),
5488 functions: BTreeMap::new(),
5489 triggers: Vec::new(),
5490 rules: Vec::new(),
5491 statistics_ext: Vec::new(),
5492 large_objects: alloc::collections::BTreeMap::new(),
5493 sequences: BTreeMap::new(),
5494 schema_acl: Vec::new(),
5495 database_acl: Vec::new(),
5496 views: BTreeMap::new(),
5497 materialized_views: BTreeMap::new(),
5498 enum_types: BTreeMap::new(),
5499 domain_types: BTreeMap::new(),
5500 comments: BTreeMap::new(),
5501 db_role_settings: BTreeMap::new(),
5502 replication_slots: BTreeMap::new(),
5503 composite_types: BTreeMap::new(),
5504 schemas: alloc::collections::BTreeSet::new(),
5505 }
5506 }
5507
5508 /// v7.12.4 — read-only view of catalogued user-defined
5509 /// functions. Engine callers go through here to look up the
5510 /// function body before re-parsing it for invocation.
5511 pub const fn functions(&self) -> &BTreeMap<String, FunctionDef> {
5512 &self.functions
5513 }
5514
5515 /// v7.12.4 — register a new user-defined function. With
5516 /// `or_replace = false`, errors if the name is taken. The
5517 /// engine validates the body before passing it here.
5518 pub fn create_function(
5519 &mut self,
5520 def: FunctionDef,
5521 or_replace: bool,
5522 ) -> Result<(), StorageError> {
5523 // v7.39 (read01 round 62) — functions are keyed by SIGNATURE, not by
5524 // name: `f(int)` and `f(text)` are two functions, as in PG. Keying by
5525 // name alone made a second overload an "already exists" error — so a
5526 // pg_dump carrying an overload set could not restore — and, worse, a
5527 // call to one overload silently ran the other.
5528 let key = function_signature_key(&def.name, &def.args_repr);
5529 if !or_replace && self.functions.contains_key(&key) {
5530 return Err(StorageError::Corrupt(format!(
5531 "function {:?} already exists (drop or use CREATE OR REPLACE)",
5532 def.name
5533 )));
5534 }
5535 self.functions.insert(key, def);
5536 Ok(())
5537 }
5538
5539 /// v7.39 (read01 round 62) — every overload of `name`.
5540 #[must_use]
5541 pub fn functions_named(&self, name: &str) -> Vec<&FunctionDef> {
5542 self.functions
5543 .values()
5544 .filter(|f| f.name.eq_ignore_ascii_case(name))
5545 .collect()
5546 }
5547
5548 /// v7.39 (read01 round 62) — one overload, by its signature key.
5549 #[must_use]
5550 pub fn function_by_key(&self, key: &str) -> Option<&FunctionDef> {
5551 self.functions.get(key)
5552 }
5553
5554 /// v7.39 (read01 round 62) — drop ONE overload. `true` if it was there.
5555 pub fn drop_function_by_key(&mut self, key: &str) -> bool {
5556 self.functions.remove(key).is_some()
5557 }
5558
5559 /// v7.12.4 — remove a user-defined function by name. Returns
5560 /// `true` if a function was removed, `false` if none matched.
5561 /// Caller decides whether to surface `if_exists` semantics.
5562 /// v7.39 (read01 round 62) — with no signature, PG drops the function only
5563 /// when the name is unambiguous. SPG mirrors that: this removes EVERY
5564 /// overload of `name`, and the caller (ddl.rs) refuses the ambiguous case
5565 /// before getting here.
5566 pub fn drop_function(&mut self, name: &str) -> bool {
5567 let keys: Vec<String> = self
5568 .functions
5569 .iter()
5570 .filter(|(_, f)| f.name.eq_ignore_ascii_case(name))
5571 .map(|(k, _)| k.clone())
5572 .collect();
5573 let hit = !keys.is_empty();
5574 for k in keys {
5575 self.functions.remove(&k);
5576 }
5577 hit
5578 }
5579
5580 /// v7.17.0 — read-only handle to catalogued sequences.
5581 /// v7.39 (read01 round 60) — the `public` schema's ACL (PG nspacl).
5582 #[must_use]
5583 pub fn schema_acl(&self) -> &[AclItem] {
5584 &self.schema_acl
5585 }
5586
5587 pub fn schema_acl_mut(&mut self) -> &mut Vec<AclItem> {
5588 &mut self.schema_acl
5589 }
5590
5591 /// v7.39 (read01 round 60) — the database's ACL.
5592 #[must_use]
5593 pub fn database_acl(&self) -> &[AclItem] {
5594 &self.database_acl
5595 }
5596
5597 pub fn database_acl_mut(&mut self) -> &mut Vec<AclItem> {
5598 &mut self.database_acl
5599 }
5600
5601 /// v7.39 (read01 round 60) — mutable sequence access, for GRANT.
5602 /// v7.39 (round 469) — resolves the session's temporary sequence
5603 /// first, like its read-only twin. `nextval` and `setval` reach the
5604 /// map through here, so a temporary sequence shadowing a permanent one
5605 /// advances the temporary one — measured against PG18, where the
5606 /// permanent sequence's counter is untouched while the temp exists.
5607 pub fn sequence_mut(&mut self, name: &str) -> Option<&mut SequenceDef> {
5608 let key = self.sequence_key(name);
5609 self.sequences.get_mut(&key)
5610 }
5611
5612 /// v7.39 (read01 round 61) — mutable function access, for GRANT.
5613 pub fn function_mut(&mut self, name: &str) -> Option<&mut FunctionDef> {
5614 self.functions.get_mut(name)
5615 }
5616
5617 /// Every catalogued sequence, temp ones included under their mangled
5618 /// storage names. Listing code filters these through
5619 /// [`Self::listed_name`]; anything resolving ONE name by its logical
5620 /// spelling wants [`Self::sequence`] instead.
5621 pub const fn sequences_all(&self) -> &BTreeMap<String, SequenceDef> {
5622 &self.sequences
5623 }
5624
5625 /// v7.39 (round 469) — resolve one sequence by its logical name, the
5626 /// session's temporary one winning over a permanent one of the same
5627 /// name. The same rule [`Self::resolve_index`] applies to tables.
5628 #[must_use]
5629 pub fn sequence(&self, name: &str) -> Option<&SequenceDef> {
5630 if let Some(mangled) = self.temp_name_for(name)
5631 && let Some(def) = self.sequences.get(&mangled)
5632 {
5633 return Some(def);
5634 }
5635 self.sequences.get(name)
5636 }
5637
5638 /// Does a sequence of this logical name exist for this session?
5639 #[must_use]
5640 pub fn has_sequence(&self, name: &str) -> bool {
5641 self.sequence(name).is_some()
5642 }
5643
5644 /// The storage key a sequence of this logical name resolves to — the
5645 /// session's temp mangling when it has one, else the name itself.
5646 #[must_use]
5647 pub fn sequence_key(&self, name: &str) -> String {
5648 if let Some(mangled) = self.temp_name_for(name)
5649 && self.sequences.contains_key(&mangled)
5650 {
5651 return mangled;
5652 }
5653 name.into()
5654 }
5655
5656 /// v7.17.0 — register a new SEQUENCE. Errors if `name`
5657 /// collides with an existing sequence and `if_not_exists`
5658 /// is false.
5659 pub fn create_sequence(
5660 &mut self,
5661 def: SequenceDef,
5662 if_not_exists: bool,
5663 ) -> Result<(), StorageError> {
5664 if self.sequences.contains_key(&def.name) {
5665 if if_not_exists {
5666 return Ok(());
5667 }
5668 // v7.39 (read01 round 47) — a sequence is a relation to PG (42P07).
5669 return Err(StorageError::Corrupt(format!(
5670 "relation {:?} already exists",
5671 def.name
5672 )));
5673 }
5674 self.mark_nontable_dirty(NonTableKind::Sequence, &def.name);
5675 self.sequences.insert(def.name.clone(), def);
5676 Ok(())
5677 }
5678
5679 /// v7.17.0 — remove a SEQUENCE by name. Returns `true` if a
5680 /// sequence was removed, `false` if none matched. Caller
5681 /// surfaces IF EXISTS semantics.
5682 /// v7.39 (read01 round 49) — `ALTER SEQUENCE old RENAME TO new`.
5683 /// Errors when `old` is missing or `new` is taken; the SequenceDef's own
5684 /// `name` field is rewritten so it stays self-describing.
5685 pub fn rename_sequence(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
5686 if !self.sequences.contains_key(old) {
5687 return Err(StorageError::Corrupt(format!(
5688 "relation {old:?} does not exist"
5689 )));
5690 }
5691 if self.sequences.contains_key(new) {
5692 return Err(StorageError::Corrupt(format!(
5693 "relation {new:?} already exists"
5694 )));
5695 }
5696 self.mark_nontable_dirty(NonTableKind::Sequence, old);
5697 self.mark_nontable_dirty(NonTableKind::Sequence, new);
5698 if let Some(mut def) = self.sequences.remove(old) {
5699 def.name = new.to_string();
5700 self.sequences.insert(new.to_string(), def);
5701 }
5702 Ok(())
5703 }
5704
5705 pub fn drop_sequence(&mut self, name: &str) -> bool {
5706 self.mark_nontable_dirty(NonTableKind::Sequence, name);
5707 self.sequences.remove(name).is_some()
5708 }
5709
5710 /// v7.17.0 — atomic nextval. Increments `last_value` per
5711 /// `increment`, returns the new value, sets `is_called`.
5712 /// Returns an error on CYCLE-less overflow.
5713 /// v7.39 (round 497) — the counter state of every sequence, for
5714 /// carrying across a commit install.
5715 ///
5716 /// A sequence's VALUE is not transactional in PG: `nextval` advances
5717 /// shared state that a rollback does not give back, because two
5718 /// sessions must never receive the same number. SPG keeps sequences in
5719 /// the catalog, and a transaction works on a catalog CLONE, so
5720 /// installing that clone at COMMIT would restore whatever the counter
5721 /// was at BEGIN. These two let the install put the live counters back.
5722 #[must_use]
5723 pub fn sequence_counters(&self) -> Vec<(String, i64, bool)> {
5724 self.sequences
5725 .iter()
5726 .map(|(k, d)| (k.clone(), d.last_value, d.is_called))
5727 .collect()
5728 }
5729
5730 /// Restore counters saved by [`Self::sequence_counters`], for the
5731 /// sequences that still exist. A sequence the transaction CREATED is
5732 /// absent from the saved set and keeps the value it was given.
5733 pub fn restore_sequence_counters(&mut self, saved: &[(String, i64, bool)]) {
5734 for (k, last, called) in saved {
5735 if let Some(d) = self.sequences.get_mut(k) {
5736 d.last_value = *last;
5737 d.is_called = *called;
5738 }
5739 }
5740 }
5741
5742 pub fn sequence_next_value(&mut self, name: &str) -> Result<i64, StorageError> {
5743 let key = self.sequence_key(name);
5744 let Some(seq) = self.sequences.get_mut(&key) else {
5745 return Err(StorageError::TableNotFound { name: name.into() });
5746 };
5747 // PG semantics: when !is_called (fresh sequence or
5748 // setval(_, false)), the next nextval returns the stored
5749 // `last_value`. When is_called, it advances by `increment`
5750 // and CYCLE-wraps on overflow.
5751 let candidate = if seq.is_called {
5752 let next = seq.last_value.checked_add(seq.increment).ok_or_else(|| {
5753 StorageError::Corrupt(format!("sequence {name:?} arithmetic overflow"))
5754 })?;
5755 if seq.increment > 0 {
5756 if next > seq.max_value {
5757 if seq.cycle {
5758 seq.min_value
5759 } else {
5760 // v7.39 (round 220) — PG's 2200H wording, not a
5761 // Corrupt-classed error.
5762 return Err(StorageError::SequenceExhausted {
5763 name: name.into(),
5764 limit: seq.max_value,
5765 is_max: true,
5766 });
5767 }
5768 } else {
5769 next
5770 }
5771 } else if next < seq.min_value {
5772 if seq.cycle {
5773 seq.max_value
5774 } else {
5775 return Err(StorageError::SequenceExhausted {
5776 name: name.into(),
5777 limit: seq.min_value,
5778 is_max: false,
5779 });
5780 }
5781 } else {
5782 next
5783 }
5784 } else {
5785 seq.last_value
5786 };
5787 seq.last_value = candidate;
5788 seq.is_called = true;
5789 Ok(candidate)
5790 }
5791
5792 /// v7.17.0 — currval. Errors if the session has never called
5793 /// nextval on this sequence (PG semantics). At the catalog
5794 /// level we approximate "session" with "is_called persisted";
5795 /// the engine session-tracking layer can wrap this for the
5796 /// strict per-session semantics later.
5797 pub fn sequence_current_value(&self, name: &str) -> Result<i64, StorageError> {
5798 let Some(seq) = self.sequences.get(name) else {
5799 return Err(StorageError::TableNotFound { name: name.into() });
5800 };
5801 if !seq.is_called {
5802 return Err(StorageError::Corrupt(format!(
5803 "currval of sequence {name:?} is not yet defined in this session"
5804 )));
5805 }
5806 Ok(seq.last_value)
5807 }
5808
5809 /// v7.17.0 — setval(name, value [, is_called]). PG returns
5810 /// `value` regardless. `is_called=true` means the NEXT
5811 /// nextval will return `value + increment`; `is_called=false`
5812 /// means the next nextval will return `value`.
5813 pub fn sequence_set_value(
5814 &mut self,
5815 name: &str,
5816 value: i64,
5817 is_called: bool,
5818 ) -> Result<i64, StorageError> {
5819 let key = self.sequence_key(name);
5820 let Some(seq) = self.sequences.get_mut(&key) else {
5821 return Err(StorageError::TableNotFound { name: name.into() });
5822 };
5823 // v7.39 (round 244) — PG refuses a value outside the sequence's
5824 // range (22003); SPG accepted it silently, leaving last_value out
5825 // of bounds.
5826 if value < seq.min_value || value > seq.max_value {
5827 return Err(StorageError::Unsupported(format!(
5828 "setval: value {value} is out of bounds for sequence \"{name}\" ({}..{})",
5829 seq.min_value, seq.max_value
5830 )));
5831 }
5832 seq.last_value = value;
5833 seq.is_called = is_called;
5834 Ok(value)
5835 }
5836
5837 /// v7.17.0 Phase 1.2 — read-only handle to catalogued views. Temp ones
5838 /// are in here under their mangled storage names; listing code filters
5839 /// through [`Self::listed_name`], and anything resolving ONE name by
5840 /// its logical spelling wants [`Self::view`].
5841 pub const fn views_all(&self) -> &BTreeMap<String, ViewDef> {
5842 &self.views
5843 }
5844
5845 /// v7.39 (round 469) — resolve one view by its logical name, the
5846 /// session's temporary one winning over a permanent one of the same
5847 /// name.
5848 #[must_use]
5849 pub fn view(&self, name: &str) -> Option<&ViewDef> {
5850 if let Some(mangled) = self.temp_name_for(name)
5851 && let Some(def) = self.views.get(&mangled)
5852 {
5853 return Some(def);
5854 }
5855 self.views.get(name)
5856 }
5857
5858 /// Does a view of this logical name exist for this session?
5859 #[must_use]
5860 pub fn has_view(&self, name: &str) -> bool {
5861 self.view(name).is_some()
5862 }
5863
5864 /// The storage key a view of this logical name resolves to.
5865 #[must_use]
5866 pub fn view_key(&self, name: &str) -> String {
5867 if let Some(mangled) = self.temp_name_for(name)
5868 && self.views.contains_key(&mangled)
5869 {
5870 return mangled;
5871 }
5872 name.into()
5873 }
5874
5875 /// v7.17.0 Phase 1.2 — install a VIEW. `or_replace=true`
5876 /// overwrites an existing entry; `if_not_exists=true` is a
5877 /// silent no-op when the name is taken. Errors if both flags
5878 /// are off and the name collides.
5879 pub fn create_view(
5880 &mut self,
5881 def: ViewDef,
5882 or_replace: bool,
5883 if_not_exists: bool,
5884 ) -> Result<(), StorageError> {
5885 if self.views.contains_key(&def.name) {
5886 if or_replace {
5887 self.mark_nontable_dirty(NonTableKind::View, &def.name);
5888 self.mark_nontable_dirty(NonTableKind::View, &def.name);
5889 self.views.insert(def.name.clone(), def);
5890 return Ok(());
5891 }
5892 if if_not_exists {
5893 return Ok(());
5894 }
5895 // v7.39 (read01 round 47) — a view is a relation to PG (42P07).
5896 return Err(StorageError::Corrupt(format!(
5897 "relation {:?} already exists",
5898 def.name
5899 )));
5900 }
5901 // Reject name collision with tables / sequences — same
5902 // namespace per PG.
5903 if self.by_name.contains_key(&def.name) {
5904 return Err(StorageError::Corrupt(format!(
5905 "view {:?} would shadow an existing table",
5906 def.name
5907 )));
5908 }
5909 if self.sequences.contains_key(&def.name) {
5910 return Err(StorageError::Corrupt(format!(
5911 "view {:?} would shadow an existing sequence",
5912 def.name
5913 )));
5914 }
5915 self.views.insert(def.name.clone(), def);
5916 Ok(())
5917 }
5918
5919 /// v7.17.0 Phase 1.2 — remove a view by name. Returns true if
5920 /// a view was removed.
5921 pub fn drop_view(&mut self, name: &str) -> bool {
5922 self.mark_nontable_dirty(NonTableKind::View, name);
5923 self.views.remove(name).is_some()
5924 }
5925
5926 /// v7.17.0 Phase 1.3 — read-only handle to the materialised-
5927 /// view source registry. Each entry pairs with a regular
5928 /// table of the same name that holds the cached rows.
5929 pub const fn materialized_views(&self) -> &BTreeMap<String, String> {
5930 &self.materialized_views
5931 }
5932
5933 /// v7.17.0 Phase 1.3 — register a source for a materialised
5934 /// view. Caller has already created the backing table.
5935 pub fn register_materialized_view(&mut self, name: String, body: String) {
5936 self.mark_nontable_dirty(NonTableKind::MaterializedView, &name);
5937 self.materialized_views.insert(name, body);
5938 }
5939
5940 /// v7.17.0 Phase 1.3 — drop the source registry entry. Returns
5941 /// true if a source was unregistered. Caller separately drops
5942 /// the backing table.
5943 pub fn drop_materialized_view_source(&mut self, name: &str) -> bool {
5944 self.mark_nontable_dirty(NonTableKind::MaterializedView, name);
5945 self.materialized_views.remove(name).is_some()
5946 }
5947
5948 /// v7.17.0 Phase 1.4 — read-only handle to user-defined ENUM
5949 /// catalog.
5950 pub const fn enum_types(&self) -> &BTreeMap<String, EnumDef> {
5951 &self.enum_types
5952 }
5953
5954 /// v7.17.0 Phase 1.4 — install a new ENUM type. Errors if
5955 /// `name` collides with an existing enum (no IF NOT EXISTS
5956 /// per PG semantics for CREATE TYPE).
5957 pub fn create_enum_type(&mut self, def: EnumDef) -> Result<(), StorageError> {
5958 if self.enum_types.contains_key(&def.name) {
5959 return Err(StorageError::Corrupt(format!(
5960 "type {:?} already exists",
5961 def.name
5962 )));
5963 }
5964 self.mark_nontable_dirty(NonTableKind::EnumType, &def.name);
5965 self.enum_types.insert(def.name.clone(), def);
5966 Ok(())
5967 }
5968
5969 /// v7.17.0 Phase 1.4 — drop an ENUM type by name. Returns
5970 /// true if a type was removed.
5971 /// v7.37 D.55 — `ALTER TYPE … ADD VALUE`. Appends `label` to an existing
5972 /// enum's ordered label list, or inserts it before/after an existing label.
5973 /// `if_not_exists` makes a duplicate a no-op; otherwise a duplicate errors.
5974 /// Returns `Ok(true)` if a label was added, `Ok(false)` if it already existed
5975 /// (only possible under `if_not_exists`).
5976 /// v7.39 (read01 round 49) — `ALTER TYPE t RENAME VALUE 'old' TO 'new'`.
5977 /// The parser used to swallow this form as a no-op, so the rename was
5978 /// accepted and silently ignored. Renaming in place keeps the label's
5979 /// sort position, which is what PG does (enumsortorder is untouched).
5980 pub fn rename_enum_value(
5981 &mut self,
5982 type_name: &str,
5983 old: &str,
5984 new: &str,
5985 ) -> Result<(), StorageError> {
5986 let def = self
5987 .enum_types
5988 .get_mut(type_name)
5989 .ok_or_else(|| StorageError::Corrupt(format!("type {type_name:?} does not exist")))?;
5990 if def.labels.iter().any(|l| l == new) {
5991 return Err(StorageError::Corrupt(format!(
5992 "enum label {new:?} already exists"
5993 )));
5994 }
5995 let at = def.labels.iter().position(|l| l == old).ok_or_else(|| {
5996 StorageError::Corrupt(format!("{old:?} is not an existing enum label"))
5997 })?;
5998 def.labels[at] = new.to_string();
5999 Ok(())
6000 }
6001
6002 /// v7.39 (read01 round 50) — set (or, with `None`, remove) the comment on
6003 /// an object. `key` is the canonical `"<kind>:<name>"` form.
6004 pub fn set_comment(&mut self, key: &str, text: Option<&str>) {
6005 match text {
6006 Some(t) => {
6007 self.comments.insert(key.to_string(), t.to_string());
6008 }
6009 None => {
6010 self.comments.remove(key);
6011 }
6012 }
6013 }
6014
6015 /// v7.39 (read01 round 50) — the comment on an object, if any.
6016 #[must_use]
6017 pub fn comment(&self, key: &str) -> Option<&str> {
6018 self.comments.get(key).map(String::as_str)
6019 }
6020
6021 /// v7.39 (round 547) — record a GUC default for a scope. An empty
6022 /// database or role name is PG's oid 0 ("all"). `None` value
6023 /// removes just that parameter, as PG's RESET does.
6024 pub fn set_db_role_setting(
6025 &mut self,
6026 database: &str,
6027 role: &str,
6028 param: &str,
6029 value: Option<&str>,
6030 ) {
6031 let key = (database.to_string(), role.to_string());
6032 match value {
6033 Some(v) => {
6034 self.db_role_settings
6035 .entry(key)
6036 .or_default()
6037 .insert(param.to_ascii_lowercase(), v.to_string());
6038 }
6039 None => {
6040 if let Some(m) = self.db_role_settings.get_mut(&key) {
6041 m.remove(¶m.to_ascii_lowercase());
6042 if m.is_empty() {
6043 self.db_role_settings.remove(&key);
6044 }
6045 }
6046 }
6047 }
6048 }
6049
6050 /// v7.39 (round 550) — create a replication slot. `Err` carries
6051 /// PG's own message for a duplicate.
6052 ///
6053 /// # Errors
6054 /// When a slot of that name already exists.
6055 pub fn create_replication_slot(
6056 &mut self,
6057 name: &str,
6058 plugin: &str,
6059 slot_type: &str,
6060 ) -> Result<(), String> {
6061 if self.replication_slots.contains_key(name) {
6062 return Err(alloc::format!("replication slot \"{name}\" already exists"));
6063 }
6064 self.replication_slots.insert(
6065 name.to_string(),
6066 (plugin.to_string(), slot_type.to_string()),
6067 );
6068 Ok(())
6069 }
6070
6071 /// # Errors
6072 /// When no slot of that name exists — PG's message, and the case
6073 /// that used to report success.
6074 pub fn drop_replication_slot(&mut self, name: &str) -> Result<(), String> {
6075 if self.replication_slots.remove(name).is_none() {
6076 return Err(alloc::format!("replication slot \"{name}\" does not exist"));
6077 }
6078 Ok(())
6079 }
6080
6081 #[must_use]
6082 pub const fn replication_slots(&self) -> &BTreeMap<String, (String, String)> {
6083 &self.replication_slots
6084 }
6085
6086 /// PG's RESET ALL: drops this scope's whole entry, leaving the
6087 /// other scopes alone — measured on PG18, where `ALTER ROLE r RESET
6088 /// ALL` left the ALL, the database and the role-in-database rows.
6089 pub fn reset_db_role_settings(&mut self, database: &str, role: &str) {
6090 self.db_role_settings
6091 .remove(&(database.to_string(), role.to_string()));
6092 }
6093
6094 #[must_use]
6095 pub const fn db_role_settings(&self) -> &BTreeMap<(String, String), BTreeMap<String, String>> {
6096 &self.db_role_settings
6097 }
6098
6099 /// v7.39 (read01 round 50) — every `(key, text)` pair, for the
6100 /// pg_description view.
6101 #[must_use]
6102 pub const fn comments(&self) -> &BTreeMap<String, String> {
6103 &self.comments
6104 }
6105
6106 /// v7.39 (read01 round 50) — drop every comment whose key names `obj`
6107 /// (the object itself and, for a table, its columns). Called when the
6108 /// object is dropped so a later object of the same name doesn't inherit
6109 /// a stale comment.
6110 pub fn drop_comments_for(&mut self, kind: &str, name: &str) {
6111 let exact = alloc::format!("{kind}:{name}");
6112 let col_prefix = alloc::format!("column:{name}.");
6113 self.comments
6114 .retain(|k, _| *k != exact && !k.starts_with(&col_prefix));
6115 }
6116
6117 pub fn add_enum_value(
6118 &mut self,
6119 type_name: &str,
6120 label: &str,
6121 if_not_exists: bool,
6122 position: Option<(bool, String)>,
6123 ) -> Result<bool, StorageError> {
6124 self.mark_nontable_dirty(NonTableKind::EnumType, type_name);
6125 let def = self
6126 .enum_types
6127 .get_mut(type_name)
6128 .ok_or_else(|| StorageError::Corrupt(format!("type {type_name:?} does not exist")))?;
6129 if def.labels.iter().any(|l| l == label) {
6130 if if_not_exists {
6131 return Ok(false);
6132 }
6133 // v7.39 (read01 round 49) — PG wording (42710 at the wire).
6134 return Err(StorageError::Corrupt(format!(
6135 "enum label {label:?} already exists"
6136 )));
6137 }
6138 match position {
6139 None => def.labels.push(label.to_string()),
6140 Some((is_before, anchor)) => {
6141 let at = def
6142 .labels
6143 .iter()
6144 .position(|l| l == &anchor)
6145 .ok_or_else(|| {
6146 StorageError::Corrupt(format!(
6147 "enum label {anchor:?} does not exist in type {type_name:?}"
6148 ))
6149 })?;
6150 let idx = if is_before { at } else { at + 1 };
6151 def.labels.insert(idx, label.to_string());
6152 }
6153 }
6154 Ok(true)
6155 }
6156
6157 pub fn drop_enum_type(&mut self, name: &str) -> bool {
6158 self.mark_nontable_dirty(NonTableKind::EnumType, name);
6159 self.enum_types.remove(name).is_some()
6160 }
6161
6162 /// v7.17.0 Phase 1.5 — read-only handle to DOMAIN catalog.
6163 pub const fn domain_types(&self) -> &BTreeMap<String, DomainDef> {
6164 &self.domain_types
6165 }
6166
6167 /// v7.17.0 Phase 1.5 — install a DOMAIN. Errors on collision
6168 /// with an existing domain.
6169 pub fn create_domain_type(&mut self, def: DomainDef) -> Result<(), StorageError> {
6170 if self.domain_types.contains_key(&def.name) {
6171 return Err(StorageError::Corrupt(format!(
6172 "domain {:?} already exists",
6173 def.name
6174 )));
6175 }
6176 self.mark_nontable_dirty(NonTableKind::DomainType, &def.name);
6177 self.domain_types.insert(def.name.clone(), def);
6178 Ok(())
6179 }
6180
6181 /// v7.17.0 Phase 1.5 — drop a DOMAIN by name.
6182 pub fn drop_domain_type(&mut self, name: &str) -> bool {
6183 self.mark_nontable_dirty(NonTableKind::DomainType, name);
6184 self.domain_types.remove(name).is_some()
6185 }
6186
6187 /// v7.37.42-T2 ζ-B — read-only handle to user-defined COMPOSITE
6188 /// catalog. Used by the engine to resolve
6189 /// `ColumnSchema.user_composite_type` lookups + by
6190 /// information_schema-style introspection.
6191 pub const fn composite_types(&self) -> &BTreeMap<String, CompositeDef> {
6192 &self.composite_types
6193 }
6194
6195 /// v7.37.42-T2 ζ-B — install a new COMPOSITE type. Errors if
6196 /// `name` already exists in the composite registry (PG forbids
6197 /// IF NOT EXISTS on CREATE TYPE composite; the engine surfaces
6198 /// the collision with the existing name).
6199 pub fn create_composite_type(&mut self, def: CompositeDef) -> Result<(), StorageError> {
6200 if self.composite_types.contains_key(&def.name) {
6201 return Err(StorageError::Corrupt(format!(
6202 "type {:?} already exists",
6203 def.name
6204 )));
6205 }
6206 self.mark_nontable_dirty(NonTableKind::CompositeType, &def.name);
6207 self.composite_types.insert(def.name.clone(), def);
6208 Ok(())
6209 }
6210
6211 /// v7.37.42-T2 ζ-B — drop a COMPOSITE type by name. Returns
6212 /// true if a type was removed.
6213 pub fn drop_composite_type(&mut self, name: &str) -> bool {
6214 self.mark_nontable_dirty(NonTableKind::CompositeType, name);
6215 self.composite_types.remove(name).is_some()
6216 }
6217
6218 /// v7.17.0 Phase 1.6 — read-only handle to the user-created
6219 /// schema registry. Built-in schemas (`public`, `pg_catalog`,
6220 /// `information_schema`) are NOT included here; use
6221 /// [`schema_exists`](Self::schema_exists) for the full
6222 /// check.
6223 pub const fn user_schemas(&self) -> &alloc::collections::BTreeSet<String> {
6224 &self.schemas
6225 }
6226
6227 /// v7.17.0 Phase 1.6 — schema-name resolver. Returns true
6228 /// for built-in schemas + every user-CREATEd one. Used by
6229 /// CREATE SCHEMA collision checks and (future) by
6230 /// information_schema.schemata.
6231 pub fn schema_exists(&self, name: &str) -> bool {
6232 is_builtin_schema(name) || self.schemas.contains(name)
6233 }
6234
6235 /// v7.17.0 Phase 1.6 — register a new schema. Errors if the
6236 /// name already exists and `if_not_exists=false`. Built-in
6237 /// names cannot be redeclared.
6238 pub fn create_schema(&mut self, name: String, if_not_exists: bool) -> Result<(), StorageError> {
6239 if is_builtin_schema(&name) {
6240 if if_not_exists {
6241 return Ok(());
6242 }
6243 return Err(StorageError::Corrupt(format!(
6244 "schema {name:?} is built-in and cannot be redeclared"
6245 )));
6246 }
6247 if self.schemas.contains(&name) {
6248 if if_not_exists {
6249 return Ok(());
6250 }
6251 return Err(StorageError::Corrupt(format!(
6252 "schema {name:?} already exists"
6253 )));
6254 }
6255 self.schemas.insert(name);
6256 Ok(())
6257 }
6258
6259 /// v7.17.0 Phase 1.6 — drop a user-created schema. Returns
6260 /// true if a schema was removed. Built-in names always
6261 /// return false (cannot be dropped). Tables that previously
6262 /// used the schema as a prefix keep their bare name and stay
6263 /// queryable — this is the "prefix routing, not isolation"
6264 /// posture documented in v7.17 Phase 1.6.
6265 pub fn drop_schema(&mut self, name: &str) -> Result<bool, StorageError> {
6266 if is_builtin_schema(name) {
6267 return Err(StorageError::Corrupt(format!(
6268 "schema {name:?} is built-in and cannot be dropped"
6269 )));
6270 }
6271 Ok(self.schemas.remove(name))
6272 }
6273
6274 /// v7.17.0 — ALTER SEQUENCE option merge. Caller-provided
6275 /// updates overwrite the matching fields; unset fields keep
6276 /// their stored values. RESTART variants update last_value
6277 /// directly per PG: `RESTART` resets to current `start`;
6278 /// `RESTART WITH n` resets to `n`.
6279 #[allow(clippy::too_many_arguments)]
6280 pub fn alter_sequence(
6281 &mut self,
6282 name: &str,
6283 increment: Option<i64>,
6284 min_value: Option<i64>,
6285 max_value: Option<i64>,
6286 start: Option<i64>,
6287 restart: Option<Option<i64>>,
6288 cache: Option<i64>,
6289 cycle: Option<bool>,
6290 owned_by: Option<Option<(String, String)>>,
6291 ) -> Result<(), StorageError> {
6292 self.mark_nontable_dirty(NonTableKind::Sequence, name);
6293 let Some(seq) = self.sequences.get_mut(name) else {
6294 return Err(StorageError::TableNotFound { name: name.into() });
6295 };
6296 if let Some(v) = increment {
6297 seq.increment = v;
6298 }
6299 if let Some(v) = min_value {
6300 seq.min_value = v;
6301 }
6302 if let Some(v) = max_value {
6303 seq.max_value = v;
6304 }
6305 if let Some(v) = start {
6306 seq.start = v;
6307 }
6308 if let Some(restart_value) = restart {
6309 seq.last_value = restart_value.unwrap_or(seq.start);
6310 seq.is_called = false;
6311 }
6312 if let Some(v) = cache {
6313 seq.cache = v;
6314 }
6315 if let Some(v) = cycle {
6316 seq.cycle = v;
6317 }
6318 if let Some(v) = owned_by {
6319 seq.owned_by = v;
6320 }
6321 Ok(())
6322 }
6323
6324 /// v7.12.4 — read-only slice of all catalogued triggers.
6325 /// Engine row-write paths filter this by (table, event,
6326 /// timing) and fire matches in slice order.
6327 pub fn triggers(&self) -> &[TriggerDef] {
6328 &self.triggers
6329 }
6330
6331 /// v7.15.0 — mutable handle to the trigger slice for
6332 /// `ALTER TABLE … RENAME COLUMN`, which rewrites every
6333 /// `update_columns` entry that referenced the renamed
6334 /// column.
6335 pub fn triggers_mut(&mut self) -> &mut Vec<TriggerDef> {
6336 &mut self.triggers
6337 }
6338
6339 /// v7.12.4 — register a new trigger. With `or_replace = false`,
6340 /// errors when a trigger with the same name already exists on
6341 /// the same table (PG scoping rule — trigger names are
6342 /// per-table, not global). Trigger function must already
6343 /// exist in the catalog at registration time.
6344 pub fn create_trigger(
6345 &mut self,
6346 def: TriggerDef,
6347 or_replace: bool,
6348 ) -> Result<(), StorageError> {
6349 // v7.39 (round 137) — a trigger may target a base table (BEFORE / AFTER)
6350 // or a view (INSTEAD OF). The engine enforces the timing↔target rule;
6351 // storage only requires the relation to exist as one or the other.
6352 if !self.by_name.contains_key(&def.table) && !self.views.contains_key(&def.table) {
6353 return Err(StorageError::TableNotFound {
6354 name: def.table.clone(),
6355 });
6356 }
6357 // v7.39 (read01 round 62) — functions are keyed by SIGNATURE now. A
6358 // trigger names its function by NAME (a trigger function takes no
6359 // arguments), so the existence check goes through the name index.
6360 if self.functions_named(&def.function).is_empty() {
6361 // v7.39 (round 710) — PG's wording: the FUNCTION is what does
6362 // not exist (`function nosuch_fn() does not exist`), and the
6363 // old message rode `Corrupt`'s on-disk banner besides.
6364 return Err(StorageError::Corrupt(format!(
6365 "function {}() does not exist",
6366 def.function
6367 )));
6368 }
6369 let dup = self
6370 .triggers
6371 .iter()
6372 .position(|t| t.name == def.name && t.table == def.table);
6373 match (dup, or_replace) {
6374 (Some(_), false) => Err(StorageError::Corrupt(format!(
6375 "trigger {:?} already exists on table {:?}",
6376 def.name, def.table
6377 ))),
6378 (Some(i), true) => {
6379 self.triggers[i] = def;
6380 Ok(())
6381 }
6382 (None, _) => {
6383 self.triggers.push(def);
6384 Ok(())
6385 }
6386 }
6387 }
6388
6389 /// v7.12.4 — remove a trigger by `(name, table)`. Returns
6390 /// `true` if one was removed.
6391 pub fn drop_trigger(&mut self, name: &str, table: &str) -> bool {
6392 let before = self.triggers.len();
6393 self.triggers
6394 .retain(|t| !(t.name == name && t.table == table));
6395 before != self.triggers.len()
6396 }
6397
6398 /// v7.39 (round 139) — the catalogued query-rewrite RULEs.
6399 pub fn rules(&self) -> &[RuleDef] {
6400 &self.rules
6401 }
6402
6403 /// v7.39 (round 280) — the catalogued extended-statistics objects.
6404 #[must_use]
6405 pub fn statistics_ext(&self) -> &[StatisticsExtDef] {
6406 &self.statistics_ext
6407 }
6408
6409 /// v7.39 (round 287) — every large object, ascending by OID.
6410 #[must_use]
6411 pub fn large_objects(&self) -> &alloc::collections::BTreeMap<u32, Vec<u8>> {
6412 &self.large_objects
6413 }
6414
6415 /// The bytes of one large object, or `None` when no such OID exists.
6416 #[must_use]
6417 pub fn large_object(&self, oid: u32) -> Option<&[u8]> {
6418 self.large_objects.get(&oid).map(Vec::as_slice)
6419 }
6420
6421 /// Create a large object. `oid` of 0 means "pick one" — PG's
6422 /// `lo_create(0)` / `lo_creat(-1)` spelling. Errors when the
6423 /// requested OID is taken.
6424 pub fn create_large_object(&mut self, oid: u32, bytes: Vec<u8>) -> Result<u32, String> {
6425 let id = if oid == 0 {
6426 self.next_large_object_oid()
6427 } else {
6428 oid
6429 };
6430 if self.large_objects.contains_key(&id) {
6431 return Err(format!("large object {id} already exists"));
6432 }
6433 self.large_objects.insert(id, bytes);
6434 Ok(id)
6435 }
6436
6437 /// Overwrite `len` bytes at `offset` (0-based), growing the object
6438 /// with zero bytes if the write starts past the end — PG's
6439 /// `lo_put` semantics.
6440 pub fn put_large_object(&mut self, oid: u32, offset: usize, data: &[u8]) -> Result<(), String> {
6441 let Some(buf) = self.large_objects.get_mut(&oid) else {
6442 return Err(format!("large object {oid} does not exist"));
6443 };
6444 let end = offset.saturating_add(data.len());
6445 if buf.len() < end {
6446 buf.resize(end, 0);
6447 }
6448 buf[offset..end].copy_from_slice(data);
6449 Ok(())
6450 }
6451
6452 /// v7.39 (round 306) — `lo_truncate`. PG's truncate sets the object
6453 /// to exactly `len` bytes in BOTH directions: it shortens, and it
6454 /// GROWS with zero fill when `len` exceeds the current size
6455 /// (measured — `lo_truncate(fd, 8)` over a 4-byte object leaves
6456 /// eight bytes, the last four zero).
6457 pub fn truncate_large_object(&mut self, oid: u32, len: usize) -> Result<(), String> {
6458 let Some(buf) = self.large_objects.get_mut(&oid) else {
6459 return Err(format!("large object {oid} does not exist"));
6460 };
6461 buf.resize(len, 0);
6462 Ok(())
6463 }
6464
6465 /// Remove a large object. `false` when the OID was not there.
6466 pub fn unlink_large_object(&mut self, oid: u32) -> bool {
6467 self.large_objects.remove(&oid).is_some()
6468 }
6469
6470 /// The next free OID in PG's user band.
6471 /// v7.39 (round 343, V40) — large objects have their own oid band.
6472 /// It used to start at 16_384, which is where user TABLES start, so
6473 /// the first large object and the first table shared an oid — and
6474 /// `pg_largeobject_metadata.oid` is joinable against `pg_class.oid`,
6475 /// so a join across them matched a row that has nothing to do with
6476 /// it. (PG cannot collide: every oid there comes off one counter.)
6477 /// An object already stored keeps the oid it was given; only new
6478 /// ones land in the band.
6479 fn next_large_object_oid(&self) -> u32 {
6480 self.large_objects
6481 .keys()
6482 .next_back()
6483 .map_or(500_000, |m| m.saturating_add(1))
6484 }
6485
6486 /// Register one. `Err(name)` when the name is taken.
6487 pub fn create_statistics_ext(&mut self, def: StatisticsExtDef) -> Result<(), String> {
6488 if self.statistics_ext.iter().any(|s| s.name == def.name) {
6489 return Err(def.name);
6490 }
6491 self.statistics_ext.push(def);
6492 Ok(())
6493 }
6494
6495 /// Drop one by name; false when absent.
6496 pub fn drop_statistics_ext(&mut self, name: &str) -> bool {
6497 let before = self.statistics_ext.len();
6498 self.statistics_ext.retain(|s| s.name != name);
6499 before != self.statistics_ext.len()
6500 }
6501
6502 /// v7.39 (round 139) — register a RULE. Its target relation (table or view)
6503 /// must exist; `or_replace` overwrites a same-(name,table) rule.
6504 pub fn create_rule(&mut self, def: RuleDef, or_replace: bool) -> Result<(), StorageError> {
6505 if !self.by_name.contains_key(&def.table) && !self.views.contains_key(&def.table) {
6506 return Err(StorageError::TableNotFound {
6507 name: def.table.clone(),
6508 });
6509 }
6510 let dup = self
6511 .rules
6512 .iter()
6513 .position(|r| r.name == def.name && r.table == def.table);
6514 match (dup, or_replace) {
6515 (Some(_), false) => Err(StorageError::Corrupt(format!(
6516 "rule {:?} for relation {:?} already exists",
6517 def.name, def.table
6518 ))),
6519 (Some(i), true) => {
6520 self.rules[i] = def;
6521 Ok(())
6522 }
6523 (None, _) => {
6524 self.rules.push(def);
6525 Ok(())
6526 }
6527 }
6528 }
6529
6530 /// v7.39 (round 139) — drop a RULE by `(name, table)`.
6531 pub fn drop_rule(&mut self, name: &str, table: &str) -> bool {
6532 let before = self.rules.len();
6533 self.rules.retain(|r| !(r.name == name && r.table == table));
6534 before != self.rules.len()
6535 }
6536
6537 pub fn create_table(&mut self, schema: TableSchema) -> Result<(), StorageError> {
6538 if self.by_name.contains_key(&schema.name) {
6539 return Err(StorageError::DuplicateTable {
6540 name: schema.name.clone(),
6541 });
6542 }
6543 let idx = self.tables.len();
6544 let name = schema.name.clone();
6545 self.tables.push(Table::new(schema));
6546 self.by_name.insert(name.clone(), idx);
6547 // v7.39 (round 496) — see `dirty_tables`.
6548 self.dirty_tables.insert(name);
6549 // v7.37.15 (Phase C.1) — stamp the new relation with a stable,
6550 // monotonic, never-reused RelId. Pre-increment so ids start at
6551 // 1 (0 = UNASSIGNED); a later DROP TABLE frees the slot but not
6552 // the id.
6553 self.next_rel_id += 1;
6554 let rid = row_header::RelId(self.next_rel_id);
6555 self.tables[idx].set_rel_id(rid);
6556 Ok(())
6557 }
6558
6559 /// v7.39 (round 436) — the session's temporary table of this name wins
6560 /// over a permanent one, as `pg_temp` does in PG's search path and as
6561 /// MySQL's TEMPORARY shadowing does. Every name → index resolution in
6562 /// this catalog goes through here.
6563 fn resolve_index(&self, name: &str) -> Option<usize> {
6564 if let Some(prefix) = &self.temp_prefix {
6565 let mut mangled = String::with_capacity(prefix.len() + name.len());
6566 mangled.push_str(prefix);
6567 mangled.push_str(name);
6568 if let Some(idx) = self.by_name.get(&mangled) {
6569 return Some(*idx);
6570 }
6571 }
6572 self.by_name.get(name).copied()
6573 }
6574
6575 /// v7.39 (round 436) — install the calling session's temp namespace.
6576 /// `None` disables temp resolution entirely (a session that never made
6577 /// one pays a single `Option` check per lookup).
6578 pub fn set_temp_prefix(&mut self, prefix: Option<String>) {
6579 self.temp_prefix = prefix;
6580 }
6581
6582 /// The mangled storage name a temp table of `name` takes in this
6583 /// session, or `None` when the session has no temp namespace.
6584 #[must_use]
6585 pub fn temp_name_for(&self, name: &str) -> Option<String> {
6586 self.temp_prefix
6587 .as_ref()
6588 .map(|p| alloc::format!("{p}{name}"))
6589 }
6590
6591 pub fn get(&self, name: &str) -> Option<&Table> {
6592 let idx = self.resolve_index(name)?;
6593 self.tables.get(idx)
6594 }
6595
6596 pub fn get_mut(&mut self, name: &str) -> Option<&mut Table> {
6597 let idx = self.resolve_index(name)?;
6598 // v7.39 (round 496) — the choke point for changing a table, so the
6599 // record is taken here. Over-approximate on purpose: a caller that
6600 // takes the handle and writes nothing merely carries that table
6601 // through a commit, which is the old behaviour.
6602 let recorded = self.tables.get(idx).map(|t| t.schema().name.clone());
6603 if let Some(n) = recorded {
6604 self.dirty_tables.insert(n);
6605 }
6606 self.tables.get_mut(idx)
6607 }
6608
6609 /// v7.39 (round 496) — the tables changed through this handle since
6610 /// [`Self::clear_dirty_tables`]. See `dirty_tables`.
6611 #[must_use]
6612 pub fn dirty_tables(&self) -> &alloc::collections::BTreeSet<String> {
6613 &self.dirty_tables
6614 }
6615
6616 /// r1059 — mark one table dirty without taking its handle. The
6617 /// rebase/merge paths replace a tx's shadow with a fresh base
6618 /// clone and must carry the tx's OWN dirty window across (the
6619 /// base's set is an ever-growing history, never cleared).
6620 pub fn mark_table_dirty(&mut self, name: &str) {
6621 self.dirty_tables.insert(name.into());
6622 }
6623
6624 /// v7.39 (round 496) — start a fresh recording window. A transaction's
6625 /// shadow calls this at BEGIN so the set means "changed by this tx".
6626 /// 7.38.1 S3.1 — one window covers both records (tables and the
6627 /// non-table families).
6628 pub fn clear_dirty_tables(&mut self) {
6629 self.dirty_tables.clear();
6630 self.dirty_nontable.clear();
6631 }
6632
6633 /// 7.38.1 S3.1 (D4) — record a non-table object as changed by this
6634 /// window. Called from every create/alter/rename/drop of the six
6635 /// [`NonTableKind`] families; a rename records BOTH names.
6636 fn mark_nontable_dirty(&mut self, kind: NonTableKind, name: &str) {
6637 self.dirty_nontable.insert((kind, name.into()));
6638 }
6639
6640 /// 7.38.1 S3.1 (D4) — reconcile the six non-table families with
6641 /// `base` (the latest committed catalog): every entry this window
6642 /// did NOT touch is taken from base — existence, definition and
6643 /// absence alike — so a neighbour's CREATE / ALTER / DROP of a
6644 /// sequence, view, matview, enum, domain or composite type
6645 /// survives a poisoned transaction's COMMIT. Entries this window
6646 /// DID touch keep the shadow's version (the tx's own DDL wins its
6647 /// own objects, exactly like the dirty-table merge above it).
6648 pub fn merge_nontable_objects_from(&mut self, base: &Catalog) {
6649 use NonTableKind as K;
6650 fn merge_map<V: Clone>(
6651 kind: NonTableKind,
6652 dirty: &alloc::collections::BTreeSet<(NonTableKind, String)>,
6653 mine: &mut BTreeMap<String, V>,
6654 theirs: &BTreeMap<String, V>,
6655 ) {
6656 let names: alloc::vec::Vec<String> =
6657 mine.keys().chain(theirs.keys()).cloned().collect();
6658 for n in names {
6659 if dirty.contains(&(kind, n.clone())) {
6660 continue;
6661 }
6662 match theirs.get(&n) {
6663 Some(v) => {
6664 mine.insert(n, v.clone());
6665 }
6666 None => {
6667 mine.remove(&n);
6668 }
6669 }
6670 }
6671 }
6672 let dirty = self.dirty_nontable.clone();
6673 merge_map(K::Sequence, &dirty, &mut self.sequences, &base.sequences);
6674 merge_map(K::View, &dirty, &mut self.views, &base.views);
6675 merge_map(
6676 K::MaterializedView,
6677 &dirty,
6678 &mut self.materialized_views,
6679 &base.materialized_views,
6680 );
6681 merge_map(K::EnumType, &dirty, &mut self.enum_types, &base.enum_types);
6682 merge_map(
6683 K::DomainType,
6684 &dirty,
6685 &mut self.domain_types,
6686 &base.domain_types,
6687 );
6688 merge_map(
6689 K::CompositeType,
6690 &dirty,
6691 &mut self.composite_types,
6692 &base.composite_types,
6693 );
6694 }
6695
6696 /// v7.39 (round 496) — put `table` in at `name`, replacing any table
6697 /// already there and keeping the rest of the catalog untouched.
6698 ///
6699 /// The commit-time table-granularity merge needs exactly this: take
6700 /// the latest committed catalog, then overwrite only the tables the
6701 /// transaction changed.
6702 pub fn install_table(&mut self, name: &str, table: Table) {
6703 match self.by_name.get(name).copied() {
6704 Some(idx) => self.tables[idx] = table,
6705 None => {
6706 let idx = self.tables.len();
6707 self.tables.push(table);
6708 self.by_name.insert(name.into(), idx);
6709 }
6710 }
6711 self.dirty_tables.insert(name.into());
6712 }
6713
6714 /// v7.37.42 (docker-fair SCALARSQ attack) — resolve a table name to
6715 /// its insertion-order index ONCE, so callers that need to fetch the
6716 /// same table many times (per-row PK probes in correlated scalar
6717 /// subqueries) can avoid the per-call `BTreeMap<String, usize>` string
6718 /// descent. The returned index is stable for the lifetime of the
6719 /// catalog snapshot the caller holds (same engine read guard).
6720 pub fn tables_position_of(&self, name: &str) -> Option<usize> {
6721 self.resolve_index(name)
6722 }
6723
6724 /// Direct positional fetch counterpart to [`tables_position_of`].
6725 /// `idx` must come from `tables_position_of` against the same catalog
6726 /// snapshot — out-of-range returns `None`.
6727 pub fn tables_at(&self, idx: usize) -> Option<&Table> {
6728 self.tables.get(idx)
6729 }
6730
6731 /// v7.34 (crash-recovery P0 #2) — replay a row-level redo log onto
6732 /// this catalog (the [`RowChange`] physical-redo apply primitive that
6733 /// row-level WAL recovery will use in place of statement re-execution).
6734 /// Applies each change in order via the same `Table` mutators the
6735 /// engine used — no uniqueness/FK/parse/plan: the original execution
6736 /// already validated, replay trusts and applies. Positions are
6737 /// physical and only valid when replayed from the matching checkpoint
6738 /// baseline in original order (see [`RowChange`] docs).
6739 ///
6740 /// A change naming an absent table, or whose position is out of range,
6741 /// is a corrupt/misaligned log and surfaces as an error rather than a
6742 /// silent skip.
6743 pub fn apply_redo(&mut self, changes: &[RowChange]) -> Result<(), StorageError> {
6744 // v7.37.5 (mailrs crash-recovery Ask 3) — true batched replay.
6745 // Pre-v7.37.5 each `RowChange::Delete` record ran a fresh
6746 // O(N) PersistentVec rebuild + O(N × indices × log N)
6747 // `rebuild_indices()` — 5000 records × 100k rows × 13 indices
6748 // ≈ 27 min on the mailrs prod-shape WAL.
6749 //
6750 // The strategy: group consecutive changes by table, and for
6751 // each run, compose all the row-level mutations through a
6752 // single "live" tracking vector + a per-table operation log,
6753 // then apply rows + indices ONCE at the end. The result:
6754 // - DELETE blow-up: O(records × rows × indices × log rows)
6755 // → O(rows × indices × log rows) — one rebuild per run.
6756 // - Row-position semantics preserved: positions in a later
6757 // `Delete` / `Update` record reference the layout produced
6758 // by every earlier change; we walk the live-vector
6759 // forward as each change is processed so positions
6760 // translate correctly to the ORIGINAL row index space.
6761 //
6762 // For correctness, even with this batching `apply_redo`
6763 // remains in-order: a single per-table run only batches
6764 // a contiguous slice of changes targeting that table; a
6765 // mid-run change targeting a DIFFERENT table forces a
6766 // flush of the current run.
6767 let mut runs: alloc::vec::Vec<(String, alloc::vec::Vec<&RowChange>)> =
6768 alloc::vec::Vec::new();
6769 for change in changes {
6770 // v7.39 (flip crash-replay P0) — a replayed tombstone carries
6771 // the xmax the CRASHED process allocated, but this process's
6772 // version cursor restarted; without advancing it past every
6773 // replayed version, `Snapshot::visible`'s "deletion is in the
6774 // future" branch (xmax > snapshot.version) resurrects every
6775 // replayed delete. Same recovery contract as the snapshot
6776 // loader (`observe_persisted_version`, the pg_control-style
6777 // nextXid recovery).
6778 if let RowChange::Tombstone { xmax, .. } = change {
6779 row_header::observe_persisted_version(*xmax);
6780 }
6781 let table = match change {
6782 RowChange::Insert { table, .. }
6783 | RowChange::Update { table, .. }
6784 | RowChange::Delete { table, .. }
6785 | RowChange::Tombstone { table, .. } => table.clone(),
6786 };
6787 if runs.last().map(|(t, _)| t.as_str()) != Some(table.as_str()) {
6788 runs.push((table, alloc::vec::Vec::new()));
6789 }
6790 runs.last_mut().unwrap().1.push(change);
6791 }
6792 for (table_name, run) in runs {
6793 self.apply_redo_run_on_table(&table_name, &run)?;
6794 }
6795 Ok(())
6796 }
6797
6798 /// v7.37.5 — apply a contiguous slice of `RowChange`s all
6799 /// targeting the same `table_name`. Composes row mutations
6800 /// through a single live-tracking vector + a single tail
6801 /// for appended `Insert`s + a single in-place edit set for
6802 /// `Update`s, then writes the final row layout to
6803 /// `self.rows` and rebuilds indices ONCE.
6804 fn apply_redo_run_on_table(
6805 &mut self,
6806 table_name: &str,
6807 run: &[&RowChange],
6808 ) -> Result<(), StorageError> {
6809 // Look up the table once; the unchecked unwrap is safe
6810 // because the caller just resolved `table_name` for each
6811 // change.
6812 let table = self.get_mut(table_name).ok_or_else(|| {
6813 StorageError::Corrupt(alloc::format!("redo: unknown table {table_name:?}"))
6814 })?;
6815 // Live-tracking over both pre-existing rows and tail-
6816 // appended Insert rows. `live[i] = true` initially for
6817 // every existing row. Appended Inserts extend with `true`.
6818 // A `Delete` flips entries to `false` (using the position
6819 // mapping that walks live indices in order). An `Update`
6820 // edits in place — collected into an overlay map keyed by
6821 // ORIGINAL row position so later Updates win.
6822 let original_rows: alloc::vec::Vec<Row<'static>> = table.rows().iter().cloned().collect();
6823 let mut live: alloc::vec::Vec<bool> = alloc::vec![true; original_rows.len()];
6824 let mut tail: alloc::vec::Vec<Row<'static>> = alloc::vec::Vec::new();
6825 // Overlay: index into ORIGINAL row space (existing rows
6826 // 0..original_rows.len()) or into tail (offset
6827 // original_rows.len()). Map -> new values.
6828 let mut overlay: alloc::collections::BTreeMap<usize, alloc::vec::Vec<Value<'static>>> =
6829 alloc::collections::BTreeMap::new();
6830 // v7.37.15 (Epic W durable-tombstone slice) — extra bookkeeping
6831 // ONLY when this run actually carries an in-place `Tombstone`.
6832 // A tombstone keeps its row physically present but stamps `xmax`
6833 // on the header; the run finalizer `set_rows_and_rebuild_indices`
6834 // freezes every header (and reassigns ids), so we must re-stamp
6835 // in a post-pass keyed by RowId. When the run has no tombstone
6836 // (every default gate-off replay) this is all skipped and the
6837 // path below stays byte-for-byte the legacy one.
6838 let has_tomb = run.iter().any(|c| matches!(c, RowChange::Tombstone { .. }));
6839 // Ids of the pre-existing rows, snapshotted parallel to
6840 // `original_rows`, and ids of the tail rows filled from each
6841 // `Insert`'s carried `rowid`. Together they let a tombstone name
6842 // the exact row the writer stamped, independent of the ids the
6843 // finalizer will hand out. (When `!has_tomb`, both stay empty.)
6844 // v7.39 (flip crash-replay P0) — ids are tracked UNCONDITIONALLY
6845 // now: the finalizer preserves them so a later WAL record's
6846 // tombstone can still name rows this record produced.
6847 let orig_rowids: alloc::vec::Vec<row_header::RowId> =
6848 table.rowids().iter().copied().collect();
6849 // Headers snapshotted in lock-step: the finalizer preserves
6850 // them so earlier records' tombstone stamps survive.
6851 let orig_headers: alloc::vec::Vec<row_header::RowHeader> =
6852 table.headers().iter().copied().collect();
6853 let mut tail_rowids: alloc::vec::Vec<row_header::RowId> = alloc::vec::Vec::new();
6854 // (RowId, xmax) of every row this run tombstones.
6855 let mut tomb_targets: alloc::vec::Vec<(row_header::RowId, u64)> = alloc::vec::Vec::new();
6856 // Helper: given a "current" position (i.e. position in
6857 // the post-prior-deletes layout), translate to the
6858 // ABSOLUTE position in the unified live + tail space
6859 // by walking the live vector + tail. Returns None when
6860 // the position is out of range.
6861 fn translate(live: &[bool], tail_len: usize, current_pos: usize) -> Option<usize> {
6862 // Walk live[..] counting live entries until we hit
6863 // current_pos. Then if not yet matched, dip into tail.
6864 let mut seen = 0usize;
6865 for (i, &alive) in live.iter().enumerate() {
6866 if alive {
6867 if seen == current_pos {
6868 return Some(i);
6869 }
6870 seen += 1;
6871 }
6872 }
6873 // Position lives in tail. tail_len rows in the tail
6874 // are all live (we haven't deleted any tail rows in
6875 // this simplification; if we did, we'd extend `live`).
6876 let off = current_pos - seen;
6877 if off < tail_len {
6878 Some(live.len() + off)
6879 } else {
6880 None
6881 }
6882 }
6883 for change in run {
6884 match *change {
6885 RowChange::Insert { row, rowid, .. } => {
6886 // Validate against schema before recording the
6887 // change so a corrupt log surfaces as an error
6888 // rather than silently mis-applying.
6889 if row.len() != table.schema().columns.len() {
6890 return Err(StorageError::ArityMismatch {
6891 expected: table.schema().columns.len(),
6892 actual: row.len(),
6893 });
6894 }
6895 tail.push(row.clone());
6896 // Keep the id lock-step with `tail` so a later
6897 // tombstone (this run or a later WAL record) can
6898 // find the row by the id the writer captured.
6899 tail_rowids.push(*rowid);
6900 }
6901 RowChange::Update { pos, new_row, .. } => {
6902 if new_row.len() != table.schema().columns.len() {
6903 return Err(StorageError::ArityMismatch {
6904 expected: table.schema().columns.len(),
6905 actual: new_row.len(),
6906 });
6907 }
6908 let abs = translate(&live, tail.len(), *pos).ok_or_else(|| {
6909 StorageError::Corrupt(alloc::format!(
6910 "redo: update_row position {pos} out of bounds in table {table_name:?}",
6911 ))
6912 })?;
6913 // Tail edits are applied directly to `tail`
6914 // (we own it); existing-row edits land in
6915 // the overlay map keyed by original index.
6916 if abs < live.len() {
6917 overlay.insert(abs, new_row.clone());
6918 } else {
6919 tail[abs - live.len()] = Row::new(new_row.clone());
6920 }
6921 }
6922 RowChange::Delete { positions, .. } => {
6923 // De-dup + sort so the translate walk stays
6924 // monotone (the second translate doesn't have
6925 // to redo work the first one did, in principle;
6926 // we keep it simple here and re-walk per
6927 // position). Bounds-filter silently mirrors
6928 // `Table::delete_rows`.
6929 let mut sorted: alloc::vec::Vec<usize> = positions.clone();
6930 sorted.sort_unstable();
6931 sorted.dedup();
6932 // Walk live[] once per Delete record to
6933 // translate all positions in this record's
6934 // post-prior-deletes layout to absolute
6935 // indices. We MUST defer the live[] flip
6936 // until after all positions are translated
6937 // so two positions in the same record
6938 // (e.g. [3, 7]) reference the same layout.
6939 let mut to_flip_live: alloc::vec::Vec<usize> = alloc::vec::Vec::new();
6940 let mut to_flip_tail: alloc::vec::Vec<usize> = alloc::vec::Vec::new();
6941 // Two-pointer walk: live[i] scanned monotonically,
6942 // sorted positions consumed in order.
6943 let mut seen = 0usize;
6944 let mut sp = sorted.iter().peekable();
6945 for (i, &alive) in live.iter().enumerate() {
6946 if !alive {
6947 continue;
6948 }
6949 while let Some(&&p) = sp.peek() {
6950 if seen == p {
6951 to_flip_live.push(i);
6952 sp.next();
6953 } else {
6954 break;
6955 }
6956 }
6957 if sp.peek().is_none() {
6958 break;
6959 }
6960 seen += 1;
6961 }
6962 // Remaining positions fall into the tail.
6963 for &p in sp {
6964 // p >= seen and refers to the (p - seen)-th
6965 // entry in tail. Filter out-of-bounds.
6966 let off = p - seen;
6967 if off < tail.len() {
6968 to_flip_tail.push(off);
6969 }
6970 }
6971 for i in to_flip_live {
6972 live[i] = false;
6973 // Any pending overlay edit for this
6974 // index is moot — the row is gone.
6975 overlay.remove(&i);
6976 }
6977 // Tail deletes: remove in REVERSE order so
6978 // shifting indices stay valid.
6979 to_flip_tail.sort_unstable();
6980 to_flip_tail.dedup();
6981 for off in to_flip_tail.into_iter().rev() {
6982 tail.remove(off);
6983 {
6984 // Keep the id vector lock-step with `tail`.
6985 tail_rowids.remove(off);
6986 }
6987 // Re-key tail-relative overlay entries that
6988 // were past `off` — in practice tail edits
6989 // are applied directly so the overlay map
6990 // only holds existing-row keys; nothing to
6991 // do here.
6992 }
6993 }
6994 RowChange::Tombstone { rowids, xmax, .. } => {
6995 // An in-place tombstone leaves the row physically
6996 // present — it does not touch `live` / `tail` /
6997 // `overlay`. Record the (id, xmax) targets; the
6998 // post-finalizer pass re-stamps `xmax` onto the
6999 // matching row's (otherwise-frozen) header.
7000 for rid in rowids {
7001 tomb_targets.push((*rid, *xmax));
7002 }
7003 }
7004 }
7005 }
7006 // Compose the final row layout: keep existing rows where
7007 // live[i] = true, applying overlay edits in place; then
7008 // append the surviving tail.
7009 let mut new_rows: PersistentVec<Row> = PersistentVec::new();
7010 let mut new_hot_bytes: u64 = 0;
7011 let schema_snapshot = table.schema().clone();
7012 // Parallel to `new_rows` (only built when `has_tomb`): the RowId
7013 // of each row in its FINAL slot, so the post-pass can map a
7014 // tombstone target id → the slot to re-stamp `xmax` on.
7015 let mut final_rowids: alloc::vec::Vec<row_header::RowId> = alloc::vec::Vec::new();
7016 let mut final_headers: alloc::vec::Vec<row_header::RowHeader> = alloc::vec::Vec::new();
7017 for (i, row) in original_rows.into_iter().enumerate() {
7018 if !live[i] {
7019 continue;
7020 }
7021 let final_row = if let Some(new_values) = overlay.remove(&i) {
7022 Row::new(new_values)
7023 } else {
7024 row
7025 };
7026 new_hot_bytes = new_hot_bytes
7027 .saturating_add(row_body_encoded_len(&final_row, &schema_snapshot) as u64);
7028 new_rows.push_mut(final_row);
7029 final_rowids.push(
7030 orig_rowids
7031 .get(i)
7032 .copied()
7033 .unwrap_or(row_header::RowId::UNASSIGNED),
7034 );
7035 final_headers.push(
7036 orig_headers
7037 .get(i)
7038 .copied()
7039 .unwrap_or_else(row_header::RowHeader::frozen),
7040 );
7041 }
7042 for (off, row) in tail.into_iter().enumerate() {
7043 new_hot_bytes =
7044 new_hot_bytes.saturating_add(row_body_encoded_len(&row, &schema_snapshot) as u64);
7045 new_rows.push_mut(row);
7046 final_rowids.push(
7047 tail_rowids
7048 .get(off)
7049 .copied()
7050 .unwrap_or(row_header::RowId::UNASSIGNED),
7051 );
7052 final_headers.push(row_header::RowHeader::frozen());
7053 }
7054 // v7.39 (flip crash-replay P0) — id-preserving finalizer, so a
7055 // LATER WAL record's tombstone still resolves rows this record
7056 // produced (per-statement replay used to reassign ids between
7057 // records, orphaning every cross-record tombstone target).
7058 table.set_rows_and_rebuild_indices_with_rowids(
7059 new_rows,
7060 new_hot_bytes,
7061 &final_rowids,
7062 &final_headers,
7063 );
7064 // v7.37.15 (Epic W durable-tombstone slice) — header-preserving
7065 // re-stamp. `set_rows_and_rebuild_indices` above froze every
7066 // header, so any row this run tombstoned is currently all-
7067 // visible again. Re-apply the `xmax` stamp by matching the
7068 // tombstone's target RowId against the final-slot id map. This
7069 // is what makes a gate-on DELETE durable across replay without
7070 // changing the on-disk snapshot format (headers/ids are still
7071 // NOT serialised — that is the deferred V6 coupling; see below).
7072 if has_tomb && !tomb_targets.is_empty() {
7073 let mut id_to_slot: alloc::collections::BTreeMap<row_header::RowId, usize> =
7074 alloc::collections::BTreeMap::new();
7075 for (slot, rid) in final_rowids.iter().enumerate() {
7076 if *rid != row_header::RowId::UNASSIGNED {
7077 id_to_slot.insert(*rid, slot);
7078 }
7079 }
7080 let table = self.get_mut(table_name).ok_or_else(|| {
7081 StorageError::Corrupt(alloc::format!("redo: unknown table {table_name:?}"))
7082 })?;
7083 for (rid, xmax) in &tomb_targets {
7084 match id_to_slot.get(rid) {
7085 Some(&slot) => {
7086 // First-deleter-wins + bounds handled inside.
7087 let _ = table.mark_row_deleted(slot, *xmax);
7088 }
7089 None => {
7090 // The target row was not produced by THIS redo
7091 // run and its id was not in the run-start
7092 // snapshot — the documented cross-checkpoint
7093 // limitation: after a checkpoint restore the
7094 // table's ids are reassigned (not yet persisted
7095 // in the envelope), so a tombstone naming a
7096 // pre-checkpoint row cannot be resolved by id.
7097 // Skipping leaves the row visible (identical to
7098 // the pre-Epic-W non-durable behaviour); it is
7099 // never a correctness regression, only an
7100 // unclosed durability gap the V6 envelope slice
7101 // closes. Counted for observability.
7102 UNRESOLVED_TOMBSTONES.fetch_add(1, core::sync::atomic::Ordering::Relaxed);
7103 }
7104 }
7105 }
7106 }
7107 Ok(())
7108 }
7109
7110 fn table_for_redo(&mut self, name: &str) -> Result<&mut Table, StorageError> {
7111 self.get_mut(name)
7112 .ok_or_else(|| StorageError::Corrupt(alloc::format!("redo: unknown table {name:?}")))
7113 }
7114
7115 /// v7.34 (crash-recovery P0 #2) — enable row-level redo capture on
7116 /// every table (the engine calls this before a mutating statement
7117 /// when persistence is on; idempotent, keeps any in-flight capture).
7118 pub fn enable_redo_all(&mut self) {
7119 for t in &mut self.tables {
7120 t.enable_redo();
7121 }
7122 }
7123
7124 /// v7.34 — drain the row-level redo captured across all tables, in
7125 /// table order then per-table apply order, and stop capturing. The
7126 /// engine calls this after a successful mutating statement and writes
7127 /// the returned [`RowChange`]s to the WAL in place of the SQL text.
7128 pub fn drain_redo(&mut self) -> Vec<RowChange> {
7129 let mut all = Vec::new();
7130 for t in &mut self.tables {
7131 all.extend(t.take_redo());
7132 }
7133 all
7134 }
7135
7136 pub fn table_count(&self) -> usize {
7137 self.tables.len()
7138 }
7139
7140 /// v7.14.0 — remove a table by name. Returns `true` when the
7141 /// table existed (and is now gone), `false` when it didn't.
7142 /// Used by `DROP TABLE` from pg_dump / mysqldump preambles
7143 /// where the dump re-creates schema and starts with
7144 /// `DROP TABLE IF EXISTS`.
7145 pub fn drop_table(&mut self, name: &str) -> bool {
7146 // v7.39 (round 436) — resolve through the session's temp namespace
7147 // first, exactly as a read would: MariaDB's plain `DROP TABLE tmp`
7148 // drops the TEMPORARY one and leaves a permanent namesake standing
7149 // (measured). Removing by the raw name would have dropped the
7150 // permanent table out from under every other session.
7151 let key = match self.temp_prefix.as_ref() {
7152 Some(p) => {
7153 let mangled = alloc::format!("{p}{name}");
7154 if self.by_name.contains_key(&mangled) {
7155 mangled
7156 } else {
7157 name.into()
7158 }
7159 }
7160 None => name.into(),
7161 };
7162 let Some(idx) = self.by_name.remove(&key) else {
7163 return false;
7164 };
7165 // v7.39 (round 496) — see `dirty_tables`. Recorded under the
7166 // RESOLVED key, which is what a commit-time merge looks up.
7167 self.dirty_tables.insert(key.clone());
7168 // swap_remove invalidates the trailing index → rebuild
7169 // by_name for affected entries.
7170 self.tables.swap_remove(idx);
7171 // Re-stamp moved table's index slot in by_name.
7172 if idx < self.tables.len() {
7173 let moved_name = self.tables[idx].schema.name.clone();
7174 self.by_name.insert(moved_name, idx);
7175 }
7176 true
7177 }
7178
7179 /// v7.16.2 — rename a table (mailrs round-10 A.5). Updates
7180 /// the schema name, the catalog name → index map, and
7181 /// rewrites every reference dangling at the table name:
7182 /// * every FK on every OTHER table whose `parent_table`
7183 /// pointed at the old name now points at the new
7184 /// name, so FK enforcement keeps working
7185 /// * every trigger watching the table updates its `table`
7186 /// field
7187 /// Returns `Ok` on success; `Err(StorageError::TableNotFound)`
7188 /// when the old name isn't in the catalog and
7189 /// `Err(StorageError::DuplicateTable)` when the new name is
7190 /// already taken.
7191 pub fn rename_table(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
7192 if old == new {
7193 return Ok(());
7194 }
7195 if self.by_name.contains_key(new) {
7196 return Err(StorageError::Corrupt(format!(
7197 "rename_table: target name {new:?} already exists"
7198 )));
7199 }
7200 let idx = self
7201 .by_name
7202 .remove(old)
7203 .ok_or_else(|| StorageError::TableNotFound { name: old.into() })?;
7204 self.tables[idx].schema.name = new.to_string();
7205 self.by_name.insert(new.to_string(), idx);
7206 for t in &mut self.tables {
7207 for fk in &mut t.schema.foreign_keys {
7208 if fk.parent_table == old {
7209 fk.parent_table = new.to_string();
7210 }
7211 }
7212 }
7213 for trig in &mut self.triggers {
7214 if trig.table == old {
7215 trig.table = new.to_string();
7216 }
7217 }
7218 Ok(())
7219 }
7220
7221 /// v7.16.2 — rename an index by name. Walks every table
7222 /// since the index lives on its owning table; updates the
7223 /// name in place. Errors with `IndexNotFound` when no
7224 /// index matches. mailrs round-10 A.5.
7225 pub fn rename_index(&mut self, old: &str, new: &str) -> Result<(), StorageError> {
7226 if old == new {
7227 return Ok(());
7228 }
7229 // Reject the new name if it already exists anywhere.
7230 for t in &self.tables {
7231 if t.indices.iter().any(|i| i.name == new) {
7232 return Err(StorageError::Corrupt(format!(
7233 "rename_index: target name {new:?} already exists"
7234 )));
7235 }
7236 }
7237 for t in &mut self.tables {
7238 for i in &mut t.indices {
7239 if i.name == old {
7240 i.name = new.to_string();
7241 return Ok(());
7242 }
7243 }
7244 }
7245 Err(StorageError::IndexNotFound { name: old.into() })
7246 }
7247
7248 /// v7.14.0 — remove a named index across the catalog.
7249 /// Returns `true` when found + dropped.
7250 pub fn drop_named_index(&mut self, name: &str) -> bool {
7251 for t in &mut self.tables {
7252 let before = t.indices.len();
7253 t.indices.retain(|i| i.name != name);
7254 if t.indices.len() != before {
7255 return true;
7256 }
7257 }
7258 false
7259 }
7260
7261 /// Borrow-free copy of every table's name in catalog order
7262 /// (= insertion order, matching the on-disk encoding).
7263 pub fn table_names(&self) -> Vec<String> {
7264 self.tables.iter().map(|t| t.schema.name.clone()).collect()
7265 }
7266
7267 /// v7.39 (round 436) — the marker every session's temporary-table
7268 /// namespace starts with. Public so the catalog synths can tell a
7269 /// temp table from an ordinary one without knowing the session id.
7270 pub const TEMP_NAME_MARKER: &'static str = "__spg_temp_";
7271
7272 /// v7.39 (round 437) — how a stored table name should appear to the
7273 /// CALLING session in a catalog listing (SHOW TABLES, pg_class,
7274 /// information_schema, …):
7275 /// * an ordinary table → its own name
7276 /// * this session's temporary table → its logical name, prefix stripped
7277 /// * another session's temporary table → `None`, i.e. not listed
7278 ///
7279 /// Measured on both oracles: MariaDB 11 and PG 18 each list the calling
7280 /// session's own temporary tables and neither lists anybody else's.
7281 /// Round 436 stored temp tables under a prefix without teaching the
7282 /// listings about it, so the mangled names leaked to every client.
7283 #[must_use]
7284 pub fn listed_name<'a>(&self, stored: &'a str) -> Option<&'a str> {
7285 if !stored.starts_with(Self::TEMP_NAME_MARKER) {
7286 return Some(stored);
7287 }
7288 let prefix = self.temp_prefix.as_ref()?;
7289 stored.strip_prefix(prefix.as_str())
7290 }
7291
7292 /// The listing names of every table this session may see, in catalog
7293 /// order. See [`Catalog::listed_name`].
7294 #[must_use]
7295 pub fn visible_table_names(&self) -> Vec<String> {
7296 self.tables
7297 .iter()
7298 .filter_map(|t| self.listed_name(&t.schema.name).map(String::from))
7299 .collect()
7300 }
7301
7302 /// v5.1: register a cold-tier segment that already lives in
7303 /// memory (caller did the file read). Returns the
7304 /// `segment_id` that `RowLocator::Cold { segment_id, .. }`
7305 /// will reference — currently this is just the index into
7306 /// `cold_segments`, but treat it as an opaque token.
7307 ///
7308 /// Storage is `no_std`, so file I/O is the caller's
7309 /// responsibility — `spg-server` reads the file and forwards
7310 /// the bytes here. The bytes stay resident in the catalog
7311 /// for the life of the `Catalog`, parsed only once.
7312 pub fn load_segment_bytes(&mut self, bytes: Vec<u8>) -> Result<u32, StorageError> {
7313 let id = u32::try_from(self.cold_segments.len()).map_err(|_| {
7314 StorageError::Corrupt("cold segment count would exceed u32::MAX".into())
7315 })?;
7316 let seg = OwnedSegment::from_bytes(bytes)
7317 .map_err(|e| StorageError::Corrupt(format!("cold segment parse failed: {e}")))?;
7318 self.cold_segments.push(Some(Arc::new(seg)));
7319 Ok(id)
7320 }
7321
7322 /// v6.7.3 — register a cold-tier segment at a specific id. Used
7323 /// by the spg-server manifest-boot path so segments whose
7324 /// neighbouring ids were retired by compaction still get back
7325 /// the same `segment_id` they had pre-restart (the
7326 /// `RowLocator::Cold { segment_id }` baked into the BTree-index
7327 /// snapshot persists across restart and must continue to
7328 /// resolve).
7329 ///
7330 /// Pads the Vec with `None` slots up to `target_id` if needed.
7331 /// Errors when the target slot is already occupied (would
7332 /// stomp another segment), the parse fails, or `target_id`
7333 /// exceeds `u32::MAX`.
7334 pub fn load_segment_bytes_at(
7335 &mut self,
7336 target_id: u32,
7337 bytes: Vec<u8>,
7338 ) -> Result<(), StorageError> {
7339 let seg = OwnedSegment::from_bytes(bytes)
7340 .map_err(|e| StorageError::Corrupt(format!("cold segment parse failed: {e}")))?;
7341 let idx = target_id as usize;
7342 while self.cold_segments.len() <= idx {
7343 self.cold_segments.push(None);
7344 }
7345 if self.cold_segments[idx].is_some() {
7346 return Err(StorageError::Corrupt(format!(
7347 "load_segment_bytes_at: segment_id {target_id} already occupied"
7348 )));
7349 }
7350 self.cold_segments[idx] = Some(Arc::new(seg));
7351 Ok(())
7352 }
7353
7354 /// v6.7.3 — retire a cold-tier segment slot (compaction-driven).
7355 /// The physical file is the caller's concern (typically kept
7356 /// on disk until the next CHECKPOINT writes a manifest that
7357 /// no longer lists it); this just flips the in-memory slot
7358 /// to `None` so later cold lookups for `segment_id` resolve
7359 /// as "unknown" instead of returning a stale row.
7360 ///
7361 /// No-op when the slot is already `None`. Errors only when
7362 /// `segment_id` is out of bounds.
7363 pub fn tombstone_segment(&mut self, segment_id: u32) -> Result<(), StorageError> {
7364 let idx = segment_id as usize;
7365 if idx >= self.cold_segments.len() {
7366 return Err(StorageError::Corrupt(format!(
7367 "tombstone_segment: segment_id {segment_id} out of bounds (len={})",
7368 self.cold_segments.len()
7369 )));
7370 }
7371 self.cold_segments[idx] = None;
7372 Ok(())
7373 }
7374
7375 /// Number of *active* (non-tombstoned) cold segments.
7376 #[must_use]
7377 pub fn cold_segment_count(&self) -> usize {
7378 self.cold_segments.iter().filter(|s| s.is_some()).count()
7379 }
7380
7381 /// v7.37.42 (docker-fair SCALARSQ attack 3) — short-circuit guard
7382 /// for scan loops that conditionally walk the cold tier. Returns
7383 /// `false` when the catalog has never loaded a cold segment (or all
7384 /// segments are tombstoned), so callers can skip the per-table cold
7385 /// PK-index walk entirely on hot-only databases. O(N segments);
7386 /// typical N is small (single-digit) so the check is sub-µs.
7387 #[must_use]
7388 pub fn has_any_cold_segments(&self) -> bool {
7389 self.cold_segments.iter().any(Option::is_some)
7390 }
7391
7392 /// Slot count including tombstones (= the next id the
7393 /// no-arg `load_segment_bytes` would allocate).
7394 #[must_use]
7395 pub fn cold_segment_slot_count(&self) -> usize {
7396 self.cold_segments.len()
7397 }
7398
7399 /// v6.2.7 — list every *active* cold-tier segment id known to
7400 /// this catalog (skips compaction tombstones since v6.7.3).
7401 /// Used by EXPLAIN ANALYZE to annotate scan nodes with the
7402 /// segments they could have walked.
7403 #[must_use]
7404 pub fn cold_segment_ids_global(&self) -> Vec<u32> {
7405 self.cold_segments
7406 .iter()
7407 .enumerate()
7408 .filter_map(|(i, s)| s.as_ref().map(|_| i as u32))
7409 .collect()
7410 }
7411
7412 /// v5.2.1: sum of `Table::hot_bytes` across every table. The v5.2
7413 /// freezer compares this against `SPG_HOT_TIER_BYTES` (parsed at
7414 /// server startup; default 4 GiB) and wakes when the budget is
7415 /// crossed. Pre-freezer (v5.2.1) this is measurement-only — the
7416 /// counter exposes whether the budget is being approached without
7417 /// triggering any demotion.
7418 #[must_use]
7419 pub fn hot_tier_bytes(&self) -> u64 {
7420 self.tables
7421 .iter()
7422 .map(Table::hot_bytes)
7423 .fold(0u64, u64::saturating_add)
7424 }
7425
7426 /// v5.2.2: freeze the **first** `max_rows` rows of `table_name`'s
7427 /// hot tier into a brand-new cold-tier segment. The named `BTree`
7428 /// index supplies the per-row PK (its column must be an integer
7429 /// type — v5.2.2 only supports `IndexKey::Int` PKs, matching the
7430 /// `index_key_as_u64` constraint used by the cold-tier lookup
7431 /// path). On success returns a [`FreezeReport`] with the
7432 /// freshly-allocated segment id, the count of rows that moved,
7433 /// the encoded segment bytes (so the caller can persist them to
7434 /// disk for later reload via `SPG_PRELOAD_COLD_SEGMENT`), and the
7435 /// hot-tier byte delta that was reclaimed.
7436 ///
7437 /// **Semantics**:
7438 /// 1. The first `max_rows` rows (by hot-tier position — same as
7439 /// insertion order under v4.39 `PersistentVec`) are read.
7440 /// 2. Rows are sorted ascending by PK and serialised into a new
7441 /// segment via [`encode_segment`].
7442 /// 3. The hot rows are dropped via [`Table::delete_rows`]; the
7443 /// `rebuild_indices` it triggers regenerates `Hot` locators
7444 /// for every remaining row (their positions shift down by
7445 /// `max_rows`). Existing `Cold` locators in this index — from
7446 /// a previous freeze — are also rebuilt **but with empty
7447 /// payload** since rebuild reads only `self.rows`; this
7448 /// routine re-registers them at the end of the call so the
7449 /// user-visible state preserves all prior cold locators.
7450 /// 4. The new segment is loaded into `self.cold_segments` via
7451 /// [`Catalog::load_segment_bytes`] (allocating a fresh
7452 /// `segment_id`). New `Cold` locators are registered on the
7453 /// named index — one per frozen row.
7454 ///
7455 /// **v5.2.2 limits** (relaxed in later sub-versions):
7456 /// - INSERT-only flow: subsequent UPDATE/DELETE on a frozen row
7457 /// returns a stale-locator error (no promote-on-write until
7458 /// v5.2.3).
7459 /// - Single-table scope: callers iterate tables themselves.
7460 /// - All-or-nothing: returns `Err` and leaves catalog unchanged
7461 /// if any step fails before the atomic swap point.
7462 ///
7463 /// Errors:
7464 /// - [`StorageError::Corrupt`] for missing table/index, non-`BTree`
7465 /// index, non-integer PK column, `max_rows == 0`, or
7466 /// `max_rows > row_count`.
7467 /// - The encoder's [`SegmentError`] surfaces as `Corrupt` (the
7468 /// only realistic source is "a single row is larger than the
7469 /// page size"; SPG schemas don't hit it in practice).
7470 pub fn freeze_oldest_to_cold(
7471 &mut self,
7472 table_name: &str,
7473 index_name: &str,
7474 max_rows: usize,
7475 ) -> Result<FreezeReport, StorageError> {
7476 // --- validation phase: never mutates ---------------------
7477 if max_rows == 0 {
7478 return Err(StorageError::Corrupt(
7479 "freeze_oldest_to_cold: max_rows must be > 0".into(),
7480 ));
7481 }
7482 let table = self.get(table_name).ok_or_else(|| {
7483 StorageError::Corrupt(format!(
7484 "freeze_oldest_to_cold: table {table_name:?} not found"
7485 ))
7486 })?;
7487 if max_rows > table.rows.len() {
7488 return Err(StorageError::Corrupt(format!(
7489 "freeze_oldest_to_cold: max_rows {max_rows} > row_count {}",
7490 table.rows.len()
7491 )));
7492 }
7493 let idx = table
7494 .indices
7495 .iter()
7496 .find(|i| i.name == index_name)
7497 .ok_or_else(|| {
7498 StorageError::Corrupt(format!(
7499 "freeze_oldest_to_cold: index {index_name:?} not found on {table_name:?}"
7500 ))
7501 })?;
7502 if !matches!(idx.kind, IndexKind::BTree(_)) {
7503 return Err(StorageError::Corrupt(format!(
7504 "freeze_oldest_to_cold: index {index_name:?} is NSW; only BTree indices may freeze"
7505 )));
7506 }
7507 let column_position = idx.column_position;
7508
7509 // --- segment build phase: reads only --------------------
7510 let schema = table.schema.clone();
7511 let mut to_freeze: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(max_rows);
7512 for row_idx in 0..max_rows {
7513 let row = table.rows.get(row_idx).expect("bounds-checked above");
7514 let key = IndexKey::from_value(&row.values[column_position]).ok_or_else(|| {
7515 StorageError::Corrupt(format!(
7516 "freeze_oldest_to_cold: row {row_idx} has NULL / non-key value in index column"
7517 ))
7518 })?;
7519 let pk_u64 = index_key_as_u64(&key).ok_or_else(|| {
7520 StorageError::Corrupt(format!(
7521 "freeze_oldest_to_cold: index {index_name:?} column type is non-integer; \
7522 v5.2.2 cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
7523 ))
7524 })?;
7525 to_freeze.push((pk_u64, encode_row_body_dense(row, &schema), key));
7526 }
7527 // encode_segment requires ascending u64 keys. Sort by PK
7528 // before encoding; the caller's row-position order is not
7529 // necessarily PK order (e.g. workloads that insert random
7530 // PKs).
7531 to_freeze.sort_by_key(|(k, _, _)| *k);
7532 // Reject duplicate PKs — encode_segment also rejects them
7533 // (`SegmentError::UnsortedKey`), but the resulting error
7534 // message there is misleading. Surface a clearer one.
7535 for w in to_freeze.windows(2) {
7536 if w[0].0 == w[1].0 {
7537 return Err(StorageError::Corrupt(format!(
7538 "freeze_oldest_to_cold: duplicate PK {} in freeze batch",
7539 w[0].0
7540 )));
7541 }
7542 }
7543 // Snapshot the (key, locator) pairs that will be registered
7544 // post-swap. Cloning the IndexKey out before the move makes
7545 // the registration loop borrow-free.
7546 let post_swap_keys: Vec<IndexKey> = to_freeze.iter().map(|(_, _, k)| k.clone()).collect();
7547 // Segment encode is now infallible w.r.t. ordering. Map the
7548 // `SegmentError` into a `StorageError::Corrupt` so the
7549 // public surface stays one error type.
7550 let seg_rows: Vec<(u64, Vec<u8>)> = to_freeze
7551 .into_iter()
7552 .map(|(k, body, _)| (k, body))
7553 .collect();
7554 let frozen_rows = seg_rows.len();
7555 let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
7556 .map_err(|e| StorageError::Corrupt(format!("freeze_oldest_to_cold: encode: {e}")))?;
7557
7558 // --- atomic swap phase: mutations only past this point ---
7559 // v5.2.3 made `Table::rebuild_indices` preserve every Cold
7560 // locator across the per-table rebuild, so `delete_rows`
7561 // below no longer wipes prior-freeze cold entries. The pre-
7562 // v5.2.3 capture-then-re-register that used to live here
7563 // was removed in v5.3.1 — keeping it would double-count
7564 // every prior-frozen key's Cold locator on each subsequent
7565 // freeze.
7566 let bytes_before = self.get(table_name).expect("just validated").hot_bytes();
7567 let positions: Vec<usize> = (0..max_rows).collect();
7568 let t_mut = self
7569 .get_mut(table_name)
7570 .expect("just validated; still present");
7571 let removed = t_mut.delete_rows(&positions);
7572 debug_assert_eq!(removed, max_rows, "delete_rows count matches request");
7573 let bytes_after = t_mut.hot_bytes();
7574 let bytes_freed = bytes_before.saturating_sub(bytes_after);
7575
7576 let segment_id = self
7577 .load_segment_bytes(seg_bytes.clone())
7578 .map_err(|e| StorageError::Corrupt(format!("freeze_oldest_to_cold: load: {e}")))?;
7579 let new_cold = post_swap_keys.into_iter().map(|k| {
7580 (
7581 k,
7582 RowLocator::Cold {
7583 segment_id,
7584 page_offset: 0,
7585 },
7586 )
7587 });
7588 let t_mut = self.get_mut(table_name).expect("still present");
7589 t_mut.register_cold_locators(index_name, new_cold)?;
7590 // r944 — a freeze has to say that it froze something.
7591 //
7592 // `has_cold_rows_fast()` reads the cached count, and neither
7593 // freeze path touched it, so afterwards it answered "no cold
7594 // rows" while cold rows existed. That predicate gates four join
7595 // paths, and a gate that wrongly declines the cold-aware path
7596 // drops the frozen rows from the answer.
7597 //
7598 // Marking it stale rather than adding to it: stale reads as
7599 // true, which is the safe direction, and this function cannot
7600 // know the exact total (rows may already have been cold). ANALYZE
7601 // recomputes the number.
7602 t_mut.mark_cold_row_count_stale();
7603
7604 Ok(FreezeReport {
7605 segment_id,
7606 frozen_rows,
7607 bytes_freed,
7608 segment_bytes: seg_bytes,
7609 })
7610 }
7611
7612 /// v5.1: borrow the cold segment at `segment_id`. Used by the
7613 /// spg-server preload path to enumerate (key, locator) pairs
7614 /// after loading a segment, so it can call
7615 /// [`Table::register_cold_locators`] without re-parsing the
7616 /// bytes.
7617 #[must_use]
7618 pub fn cold_segment(&self, segment_id: u32) -> Option<&OwnedSegment> {
7619 self.cold_segments
7620 .get(segment_id as usize)
7621 .and_then(|s| s.as_deref())
7622 }
7623
7624 /// v5.1: resolve a single `RowLocator::Cold` to its underlying
7625 /// `Row`. Decoupled from [`Catalog::lookup_by_pk`] so callers
7626 /// iterating a multi-locator slice (e.g. the engine's index
7627 /// seek path) can dispatch per locator instead of getting back
7628 /// only the first row for a key. Returns `None` when the
7629 /// segment isn't registered, the key isn't `u64`-coercible, or
7630 /// the segment doesn't actually carry the key (bloom or page-
7631 /// index reject).
7632 pub fn resolve_cold_locator(
7633 &self,
7634 table_name: &str,
7635 segment_id: u32,
7636 key: &IndexKey,
7637 ) -> Option<Row<'static>> {
7638 let t = self.get(table_name)?;
7639 let u64_key = index_key_as_u64(key)?;
7640 let seg = self.cold_segments.get(segment_id as usize)?.as_ref()?;
7641 let payload = seg.lookup(u64_key)?;
7642 let (row, _) = decode_row_body_dense(&payload, &t.schema, seg.codec_version()).ok()?;
7643 // v7.39 (pg_stat blks knife) — one cold-tier "block read".
7644 self.cold_read_stats
7645 .cold_reads
7646 .fetch_add(1, core::sync::atomic::Ordering::Relaxed);
7647 Some(row)
7648 }
7649
7650 /// v5.1: indexed PK lookup that dispatches per locator,
7651 /// returning the first matching row from either the hot tier
7652 /// (`Table::rows`) or a registered cold segment.
7653 ///
7654 /// The cold path requires the index column to be coercible to
7655 /// a `u64` (the segment's PK type) and the segment payload to
7656 /// be a [`encode_row_body_dense`]-encoded row body for the
7657 /// same schema. v5.1 ships this for BIGINT / INT / SMALLINT
7658 /// PKs; other types fall through to hot-only behavior.
7659 ///
7660 /// Returns `None` if (a) the table or index doesn't exist,
7661 /// (b) the key isn't in the index at all, or (c) the key was
7662 /// resolved to a stale locator (Hot index out of range, Cold
7663 /// segment id unknown, segment lookup miss). Does not surface
7664 /// segment-decode errors — those would indicate corrupted
7665 /// cold-tier files and should be caught at
7666 /// [`Catalog::load_segment_bytes`] time.
7667 pub fn lookup_by_pk(&self, table: &str, index_name: &str, key: &IndexKey) -> Option<Row<'_>> {
7668 let t = self.get(table)?;
7669 let idx = t.indices.iter().find(|i| i.name == index_name)?;
7670 let locators = idx.lookup_eq(key);
7671 let cold_u64_key = index_key_as_u64(key);
7672 for loc in locators {
7673 match *loc {
7674 RowLocator::Hot(i) => {
7675 if let Some(row) = t.rows.get(i) {
7676 return Some(row.clone());
7677 }
7678 }
7679 RowLocator::Cold {
7680 segment_id,
7681 page_offset: _,
7682 } => {
7683 let Some(u64_key) = cold_u64_key else {
7684 // Key type not coercible to u64 — cold tier
7685 // only handles BIGINT/INT/SMALLINT in v5.1.
7686 continue;
7687 };
7688 let Some(seg) = self
7689 .cold_segments
7690 .get(segment_id as usize)
7691 .and_then(|s| s.as_deref())
7692 else {
7693 // v6.7.3 — `None` slot = compaction
7694 // retired this segment; the live locator
7695 // on a freshly-compacted index points to
7696 // the merged segment_id, so a Cold hit
7697 // here against a tombstone means the BTree
7698 // entry hasn't been swapped yet (mid-
7699 // compaction reader race) or the caller is
7700 // looking up a stale snapshot. Skip — the
7701 // next locator in the list, if any, is
7702 // typically the merged segment.
7703 continue;
7704 };
7705 let Some(payload) = seg.lookup(u64_key) else {
7706 continue;
7707 };
7708 let (row, _) =
7709 decode_row_body_dense(&payload, &t.schema, seg.codec_version()).ok()?;
7710 return Some(row);
7711 }
7712 }
7713 }
7714 None
7715 }
7716
7717 /// v5.2.3: promote a frozen row back to the hot tier so an
7718 /// UPDATE / DELETE can mutate it. Reads the cold-tier row body
7719 /// (decoded from its registered segment), pushes it into
7720 /// `table.rows` via [`Table::insert`] (which also adds a fresh
7721 /// `Hot(new_idx)` locator on `index_name`), then retires the
7722 /// shadowed `Cold` locator via
7723 /// [`Table::remove_cold_locators_for_key`]. The cold-tier row
7724 /// in the segment file becomes garbage — recoverable when a
7725 /// future cold-segment compaction job lands.
7726 ///
7727 /// Returns:
7728 /// - `Ok(Some(new_hot_idx))` when the key resolved through a
7729 /// cold locator and the promote completed. `new_hot_idx` is
7730 /// the position the row now occupies in `table.rows`.
7731 /// - `Ok(None)` when the key has no Cold locator on the index
7732 /// (already hot, or wasn't present at all). Callers treat this
7733 /// as "nothing to do here, fall back to the hot-only path".
7734 ///
7735 /// Errors when the table / index doesn't exist, the index isn't
7736 /// `BTree`, the cold segment is missing / can't decode the row,
7737 /// or the inferred row body fails `Table::insert` validation.
7738 pub fn promote_cold_row(
7739 &mut self,
7740 table_name: &str,
7741 index_name: &str,
7742 key: &IndexKey,
7743 ) -> Result<Option<usize>, StorageError> {
7744 let cold_loc = self.find_cold_locator(table_name, index_name, key)?;
7745 let Some((segment_id, _page_offset)) = cold_loc else {
7746 return Ok(None);
7747 };
7748 let u64_key = index_key_as_u64(key).ok_or_else(|| {
7749 StorageError::Corrupt(
7750 "promote_cold_row: key type not coercible to u64 (cold tier requires integer PK)"
7751 .into(),
7752 )
7753 })?;
7754 // Read the row body from the segment. Borrow the segment +
7755 // schema short-term so we can then take `&mut self` for the
7756 // hot-side insert.
7757 let schema = self
7758 .get(table_name)
7759 .ok_or_else(|| {
7760 StorageError::Corrupt(format!("promote_cold_row: table {table_name:?} not found"))
7761 })?
7762 .schema
7763 .clone();
7764 let seg = self
7765 .cold_segments
7766 .get(segment_id as usize)
7767 .and_then(|s| s.as_ref())
7768 .ok_or_else(|| {
7769 StorageError::Corrupt(format!(
7770 "promote_cold_row: segment {segment_id} not registered on catalog"
7771 ))
7772 })?;
7773 let payload = seg.lookup(u64_key).ok_or_else(|| {
7774 StorageError::Corrupt(format!(
7775 "promote_cold_row: key {u64_key} resolves to segment {segment_id} \
7776 but the segment's bloom/page lookup didn't return a row"
7777 ))
7778 })?;
7779 let (row, _consumed) = decode_row_body_dense(&payload, &schema, seg.codec_version())?;
7780 // Insert the promoted row into the hot tier. `Table::insert`
7781 // appends to `self.rows`, adds a `Hot(new_idx)` locator to
7782 // every BTree index covering the row's keyed columns, and
7783 // increments `hot_bytes`.
7784 let t = self
7785 .get_mut(table_name)
7786 .expect("table existed at lookup time");
7787 t.insert(row)?;
7788 let new_hot_idx =
7789 t.rows.len().checked_sub(1).ok_or_else(|| {
7790 StorageError::Corrupt("promote_cold_row: empty after insert".into())
7791 })?;
7792 // The hot insert added Hot(new_idx) alongside the still-
7793 // present Cold locator. Drop the Cold entry so future
7794 // lookups return only the fresh hot row.
7795 t.remove_cold_locators_for_key(index_name, key)?;
7796 Ok(Some(new_hot_idx))
7797 }
7798
7799 /// v5.2.3: shadow a frozen row's index entry. Used by DELETE
7800 /// when the row to remove lives in a cold-tier segment — the
7801 /// row body stays in the segment file (becoming garbage) but
7802 /// every `Cold` locator for `key` on `index_name` is removed
7803 /// so PK lookups stop returning it.
7804 ///
7805 /// Returns the number of cold locators retired (0 when the key
7806 /// has no cold entries — the DELETE fell on a hot row or a
7807 /// key that was already absent). Errors when the table /
7808 /// index doesn't exist or the index isn't `BTree`.
7809 ///
7810 /// Cold-segment compaction (which merges shadowed-heavy
7811 /// segments and reclaims their disk footprint) lands in a
7812 /// later v5.x sub-version; until then, repeated UPDATE/DELETE
7813 /// of cold rows can amplify cold-segment disk usage by up to
7814 /// 1-2× — still well under typical LSM-tree shadowing because
7815 /// SPG segments are bulk-baked, not write-merged.
7816 pub fn shadow_cold_row(
7817 &mut self,
7818 table_name: &str,
7819 index_name: &str,
7820 key: &IndexKey,
7821 ) -> Result<usize, StorageError> {
7822 let t = self.get_mut(table_name).ok_or_else(|| {
7823 StorageError::Corrupt(format!("shadow_cold_row: table {table_name:?} not found"))
7824 })?;
7825 t.remove_cold_locators_for_key(index_name, key)
7826 }
7827
7828 /// v6.7.4 — read-only slice preparation for the parallel
7829 /// freezer. Walks rows in `row_range`, builds the
7830 /// `(pk_u64, encoded_body, IndexKey)` triples that the
7831 /// coordinator's k-way merge consumes, sorts the slice by
7832 /// `pk_u64`, and returns a [`FreezeSlice`].
7833 ///
7834 /// Caller invariants:
7835 /// - `row_range.end <= table.rows.len()` (caller's job to
7836 /// compute the partition).
7837 /// - All slices passed to `commit_freeze_slices` must cover a
7838 /// contiguous half-open range `[0, total_max_rows)` with no
7839 /// gaps and no overlaps. The coordinator validates this
7840 /// invariant before committing.
7841 ///
7842 /// `&self`-only — multiple workers can run this concurrently
7843 /// against the same `Catalog` reference under the engine's
7844 /// write lock (workers don't mutate; the coordinator does).
7845 pub fn prepare_freeze_slice(
7846 &self,
7847 table_name: &str,
7848 index_name: &str,
7849 row_range: core::ops::Range<usize>,
7850 ) -> Result<FreezeSlice, StorageError> {
7851 let table = self.get(table_name).ok_or_else(|| {
7852 StorageError::Corrupt(format!(
7853 "prepare_freeze_slice: table {table_name:?} not found"
7854 ))
7855 })?;
7856 let idx = table
7857 .indices
7858 .iter()
7859 .find(|i| i.name == index_name)
7860 .ok_or_else(|| {
7861 StorageError::Corrupt(format!(
7862 "prepare_freeze_slice: index {index_name:?} not found on {table_name:?}"
7863 ))
7864 })?;
7865 if !matches!(idx.kind, IndexKind::BTree(_)) {
7866 return Err(StorageError::Corrupt(format!(
7867 "prepare_freeze_slice: index {index_name:?} is NSW; only BTree indices may freeze"
7868 )));
7869 }
7870 if row_range.end > table.rows.len() {
7871 return Err(StorageError::Corrupt(format!(
7872 "prepare_freeze_slice: row_range end {} > row_count {}",
7873 row_range.end,
7874 table.rows.len()
7875 )));
7876 }
7877 let column_position = idx.column_position;
7878 let schema = table.schema.clone();
7879 let mut rows: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(row_range.len());
7880 for row_idx in row_range.clone() {
7881 let row = table.rows.get(row_idx).expect("bounds-checked above");
7882 let key = IndexKey::from_value(&row.values[column_position]).ok_or_else(|| {
7883 StorageError::Corrupt(format!(
7884 "prepare_freeze_slice: row {row_idx} has NULL / non-key value in index column"
7885 ))
7886 })?;
7887 let pk_u64 = index_key_as_u64(&key).ok_or_else(|| {
7888 StorageError::Corrupt(format!(
7889 "prepare_freeze_slice: index {index_name:?} column type is non-integer; \
7890 v5.2.2 cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
7891 ))
7892 })?;
7893 rows.push((pk_u64, encode_row_body_dense(row, &schema), key));
7894 }
7895 rows.sort_by_key(|(k, _, _)| *k);
7896 Ok(FreezeSlice { row_range, rows })
7897 }
7898
7899 /// v6.7.4 — coordinator commit step. Merges N
7900 /// [`FreezeSlice`]s into one segment via the standard
7901 /// [`encode_segment`] path, atomically swaps the catalog
7902 /// state (delete the union row range + register Cold
7903 /// locators + load the segment).
7904 ///
7905 /// Validates that the slices cover a contiguous, gap-free,
7906 /// overlap-free half-open range starting at index 0 (the
7907 /// freezer always freezes "oldest first" — same semantics as
7908 /// the single-threaded [`Catalog::freeze_oldest_to_cold`]).
7909 ///
7910 /// Empty `slices` → no-op success (returns a zero-row report
7911 /// without mutating). Total row count = `Σ slice.rows.len()`.
7912 pub fn commit_freeze_slices(
7913 &mut self,
7914 table_name: &str,
7915 index_name: &str,
7916 slices: Vec<FreezeSlice>,
7917 ) -> Result<FreezeReport, StorageError> {
7918 // --- validation phase: never mutates ---------------------
7919 let table = self.get(table_name).ok_or_else(|| {
7920 StorageError::Corrupt(format!(
7921 "commit_freeze_slices: table {table_name:?} not found"
7922 ))
7923 })?;
7924 let idx = table
7925 .indices
7926 .iter()
7927 .find(|i| i.name == index_name)
7928 .ok_or_else(|| {
7929 StorageError::Corrupt(format!(
7930 "commit_freeze_slices: index {index_name:?} not found on {table_name:?}"
7931 ))
7932 })?;
7933 if !matches!(idx.kind, IndexKind::BTree(_)) {
7934 return Err(StorageError::Corrupt(format!(
7935 "commit_freeze_slices: index {index_name:?} is NSW; only BTree indices may freeze"
7936 )));
7937 }
7938 // Validate slice coverage: contiguous from 0, no gaps, no
7939 // overlaps. Allow the caller to pass slices in any order —
7940 // sort by row_range.start first.
7941 let mut ordered = slices;
7942 ordered.sort_by_key(|s| s.row_range.start);
7943 // Drop fully-empty slices that fell out of an uneven
7944 // partition; they carry no data but contribute to the
7945 // contiguity check, so keep them in line.
7946 let mut expected_start = 0usize;
7947 for s in &ordered {
7948 if s.row_range.start != expected_start {
7949 return Err(StorageError::Corrupt(format!(
7950 "commit_freeze_slices: gap/overlap at row {}; expected start {}",
7951 s.row_range.start, expected_start
7952 )));
7953 }
7954 expected_start = s.row_range.end;
7955 }
7956 let max_rows = expected_start;
7957 if max_rows > table.rows.len() {
7958 return Err(StorageError::Corrupt(format!(
7959 "commit_freeze_slices: total row range {} exceeds row_count {}",
7960 max_rows,
7961 table.rows.len()
7962 )));
7963 }
7964 if max_rows == 0 {
7965 return Ok(FreezeReport {
7966 segment_id: u32::MAX,
7967 frozen_rows: 0,
7968 bytes_freed: 0,
7969 segment_bytes: Vec::new(),
7970 });
7971 }
7972
7973 // --- segment build phase: reads only --------------------
7974 // K-way merge of already-sorted slices. Each slice's rows
7975 // are ascending by pk_u64; we keep a per-slice cursor and
7976 // pull the next-smallest head until every cursor drains.
7977 let total_rows: usize = ordered.iter().map(|s| s.rows.len()).sum();
7978 if total_rows != max_rows {
7979 return Err(StorageError::Corrupt(format!(
7980 "commit_freeze_slices: total slice rows {total_rows} ≠ row_range coverage {max_rows}"
7981 )));
7982 }
7983 let mut cursors: Vec<usize> = alloc::vec![0; ordered.len()];
7984 let mut merged: Vec<(u64, Vec<u8>, IndexKey)> = Vec::with_capacity(total_rows);
7985 loop {
7986 // Pick the slice whose head row has the smallest key
7987 // and isn't yet exhausted.
7988 let mut pick: Option<usize> = None;
7989 for (i, c) in cursors.iter().enumerate() {
7990 let slice = &ordered[i];
7991 if *c >= slice.rows.len() {
7992 continue;
7993 }
7994 match pick {
7995 None => pick = Some(i),
7996 Some(j) => {
7997 if slice.rows[*c].0 < ordered[j].rows[cursors[j]].0 {
7998 pick = Some(i);
7999 }
8000 }
8001 }
8002 }
8003 let Some(i) = pick else { break };
8004 let row = ordered[i].rows[cursors[i]].clone();
8005 cursors[i] += 1;
8006 merged.push(row);
8007 }
8008 // Reject duplicate PKs — same error as the single-threaded
8009 // path so callers get a uniform surface.
8010 for w in merged.windows(2) {
8011 if w[0].0 == w[1].0 {
8012 return Err(StorageError::Corrupt(format!(
8013 "commit_freeze_slices: duplicate PK {} across slices",
8014 w[0].0
8015 )));
8016 }
8017 }
8018 let post_swap_keys: Vec<IndexKey> = merged.iter().map(|(_, _, k)| k.clone()).collect();
8019 let seg_rows: Vec<(u64, Vec<u8>)> =
8020 merged.into_iter().map(|(k, body, _)| (k, body)).collect();
8021 let frozen_rows = seg_rows.len();
8022 let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
8023 .map_err(|e| StorageError::Corrupt(format!("commit_freeze_slices: encode: {e}")))?;
8024
8025 // --- atomic swap phase: mutations only past this point ---
8026 let bytes_before = self.get(table_name).expect("just validated").hot_bytes();
8027 let positions: Vec<usize> = (0..max_rows).collect();
8028 let t_mut = self
8029 .get_mut(table_name)
8030 .expect("just validated; still present");
8031 let removed = t_mut.delete_rows(&positions);
8032 debug_assert_eq!(removed, max_rows, "delete_rows count matches request");
8033 let bytes_after = t_mut.hot_bytes();
8034 let bytes_freed = bytes_before.saturating_sub(bytes_after);
8035
8036 let segment_id = self
8037 .load_segment_bytes(seg_bytes.clone())
8038 .map_err(|e| StorageError::Corrupt(format!("commit_freeze_slices: load: {e}")))?;
8039 let new_cold = post_swap_keys.into_iter().map(|k| {
8040 (
8041 k,
8042 RowLocator::Cold {
8043 segment_id,
8044 page_offset: 0,
8045 },
8046 )
8047 });
8048 let t_mut = self.get_mut(table_name).expect("still present");
8049 t_mut.register_cold_locators(index_name, new_cold)?;
8050 // r944 — a freeze has to say that it froze something.
8051 //
8052 // `has_cold_rows_fast()` reads the cached count, and neither
8053 // freeze path touched it, so afterwards it answered "no cold
8054 // rows" while cold rows existed. That predicate gates four join
8055 // paths, and a gate that wrongly declines the cold-aware path
8056 // drops the frozen rows from the answer.
8057 //
8058 // Marking it stale rather than adding to it: stale reads as
8059 // true, which is the safe direction, and this function cannot
8060 // know the exact total (rows may already have been cold). ANALYZE
8061 // recomputes the number.
8062 t_mut.mark_cold_row_count_stale();
8063
8064 Ok(FreezeReport {
8065 segment_id,
8066 frozen_rows,
8067 bytes_freed,
8068 segment_bytes: seg_bytes,
8069 })
8070 }
8071
8072 /// v6.7.3 — compact every cold segment on `(table, index)` whose
8073 /// `OwnedSegment::bytes().len()` is below `target_segment_bytes`
8074 /// into a single larger merged segment. Rows present in source
8075 /// segment payloads but no longer referenced by any
8076 /// `RowLocator::Cold` on the index (DELETE'd + frozen rows
8077 /// retired via [`Catalog::shadow_cold_row`]) are GC'd in the
8078 /// merge.
8079 ///
8080 /// **Semantics**:
8081 /// 1. Walk the BTree index to collect every Cold locator that
8082 /// targets a small (< threshold) segment. Each such
8083 /// `(key, segment_id)` becomes a row in the merged segment;
8084 /// payload is looked up from the source segment in-place.
8085 /// 2. Encode the collected rows into one new segment via
8086 /// [`encode_segment`]; register it via
8087 /// [`Catalog::load_segment_bytes`] (allocating a fresh
8088 /// `merged_segment_id` at the end of `cold_segments`).
8089 /// 3. Rewrite the BTree index in one pass: every
8090 /// `RowLocator::Cold { segment_id ∈ sources }` becomes
8091 /// `RowLocator::Cold { segment_id = merged_id, page_offset = 0 }`.
8092 /// Hot locators are untouched.
8093 /// 4. Tombstone every source slot via
8094 /// [`Catalog::tombstone_segment`]. Source segment payloads
8095 /// are no longer reachable through the catalog; the on-disk
8096 /// files are the caller's concern.
8097 ///
8098 /// On fewer than 2 candidate segments the catalog is **not**
8099 /// mutated and a no-op report (`merged_segment_id: None`,
8100 /// `sources: []`) is returned. This is the routine case — a
8101 /// freshly-frozen table has at most 1 small segment, no merge
8102 /// possible.
8103 ///
8104 /// Atomicity: every mutating step runs after the read-only
8105 /// gather phase, so a panic before the merge encode leaves the
8106 /// catalog unchanged. The mutation block itself (load + rewrite +
8107 /// tombstone) takes only `&mut self` — callers serialise the
8108 /// engine write lock outside this function.
8109 ///
8110 /// Errors when the table / index doesn't exist, the index isn't
8111 /// `BTree`, the index column type isn't u64-coercible (cold-tier
8112 /// pre-condition), or a source segment fails its in-place
8113 /// row-body lookup (would indicate prior catalog corruption).
8114 pub fn compact_cold_segments(
8115 &mut self,
8116 table_name: &str,
8117 index_name: &str,
8118 target_segment_bytes: u64,
8119 ) -> Result<CompactReport, StorageError> {
8120 // --- validation phase ----------------------------------
8121 let t = self.get(table_name).ok_or_else(|| {
8122 StorageError::Corrupt(format!(
8123 "compact_cold_segments: table {table_name:?} not found"
8124 ))
8125 })?;
8126 let idx = t
8127 .indices
8128 .iter()
8129 .find(|i| i.name == index_name)
8130 .ok_or_else(|| {
8131 StorageError::Corrupt(format!(
8132 "compact_cold_segments: index {index_name:?} not found on {table_name:?}"
8133 ))
8134 })?;
8135 let map = match &idx.kind {
8136 IndexKind::BTree(m) => m,
8137 IndexKind::Nsw(_)
8138 | IndexKind::Brin { .. }
8139 | IndexKind::Gin(_)
8140 | IndexKind::GinTrgm(_)
8141 | IndexKind::GinFulltext(_)
8142 | IndexKind::GinJsonb(_)
8143 | IndexKind::BTreeMulti(_) => {
8144 return Err(StorageError::Corrupt(format!(
8145 "compact_cold_segments: index {index_name:?} is not BTree; \
8146 compaction applies only to BTree cold-tier indices"
8147 )));
8148 }
8149 };
8150
8151 // --- gather phase --------------------------------------
8152 // Step A: every segment_id this BTree index Cold-references.
8153 let mut referenced_ids: BTreeSet<u32> = BTreeSet::new();
8154 for (_key, locators) in map.iter() {
8155 for loc in locators {
8156 if let RowLocator::Cold { segment_id, .. } = loc {
8157 referenced_ids.insert(*segment_id);
8158 }
8159 }
8160 }
8161 // Step B: keep only the small + still-active ones.
8162 let candidate_set: BTreeSet<u32> = referenced_ids
8163 .into_iter()
8164 .filter(|id| {
8165 self.cold_segments
8166 .get(*id as usize)
8167 .and_then(|s| s.as_deref())
8168 .is_some_and(|s| (s.bytes().len() as u64) < target_segment_bytes)
8169 })
8170 .collect();
8171 if candidate_set.len() < 2 {
8172 return Ok(CompactReport {
8173 sources: Vec::new(),
8174 merged_segment_id: None,
8175 merged_segment_bytes: Vec::new(),
8176 merged_rows: 0,
8177 deleted_rows_pruned: 0,
8178 bytes_reclaimed_estimate: 0,
8179 });
8180 }
8181 // Step C: pre-count source rows for the deleted-pruned metric.
8182 let mut source_row_count: usize = 0;
8183 let mut source_byte_total: u64 = 0;
8184 for &id in &candidate_set {
8185 let seg = self.cold_segments[id as usize]
8186 .as_ref()
8187 .expect("candidate selected only when slot is Some");
8188 source_row_count = source_row_count.saturating_add(seg.meta().num_rows as usize);
8189 source_byte_total = source_byte_total.saturating_add(seg.bytes().len() as u64);
8190 }
8191 // Step D: collect (key, body) pairs from every live Cold
8192 // locator pointing at a candidate. dedupe by key — one
8193 // BTree key resolves to at most one cold payload (the
8194 // freezer + promote/shadow flow keeps Cold locators
8195 // unique per key).
8196 let mut collected: BTreeMap<u64, (Vec<u8>, IndexKey)> = BTreeMap::new();
8197 for (key, locators) in map.iter() {
8198 for loc in locators {
8199 let RowLocator::Cold { segment_id, .. } = loc else {
8200 continue;
8201 };
8202 if !candidate_set.contains(segment_id) {
8203 continue;
8204 }
8205 let u64_key = index_key_as_u64(key).ok_or_else(|| {
8206 StorageError::Corrupt(format!(
8207 "compact_cold_segments: index {index_name:?} has non-integer Cold key; \
8208 cold tier requires IndexKey::Int (Text PK lands in v5.5+)"
8209 ))
8210 })?;
8211 let seg = self.cold_segments[*segment_id as usize]
8212 .as_ref()
8213 .expect("candidate slot guaranteed Some above");
8214 let payload = seg.lookup(u64_key).ok_or_else(|| {
8215 StorageError::Corrupt(format!(
8216 "compact_cold_segments: BTree {index_name:?} points key={u64_key} \
8217 at segment {segment_id} but the segment lookup missed"
8218 ))
8219 })?;
8220 collected.insert(u64_key, (payload, key.clone()));
8221 break;
8222 }
8223 }
8224 let merged_rows = collected.len();
8225 let deleted_rows_pruned = source_row_count.saturating_sub(merged_rows);
8226
8227 // Step E: encode the merged segment. `BTreeMap<u64, _>`
8228 // iteration is ascending by key, which is what
8229 // `encode_segment` requires.
8230 let seg_rows: Vec<(u64, Vec<u8>)> = collected
8231 .iter()
8232 .map(|(k, (body, _))| (*k, body.clone()))
8233 .collect();
8234 let (seg_bytes, _meta) = encode_segment(seg_rows.into_iter(), 0.01, SEGMENT_PAGE_BYTES)
8235 .map_err(|e| StorageError::Corrupt(format!("compact_cold_segments: encode: {e}")))?;
8236 let merged_bytes_len = seg_bytes.len() as u64;
8237
8238 // --- atomic mutation phase ------------------------------
8239 let merged_segment_id = self
8240 .load_segment_bytes(seg_bytes.clone())
8241 .map_err(|e| StorageError::Corrupt(format!("compact_cold_segments: load: {e}")))?;
8242
8243 // Rewrite the BTree index: every Cold locator pointing at
8244 // a candidate source becomes a Cold locator pointing at
8245 // the merged segment. Use a flat collect-then-replace
8246 // pattern so we never hold a `&self` borrow across the
8247 // `&mut self` write.
8248 let entries: Vec<(IndexKey, crate::posting::PostingList)> = {
8249 let t = self
8250 .get(table_name)
8251 .expect("table existed at the start of this fn");
8252 let idx = t
8253 .indices
8254 .iter()
8255 .find(|i| i.name == index_name)
8256 .expect("index existed at the start of this fn");
8257 let IndexKind::BTree(map) = &idx.kind else {
8258 unreachable!("validated above");
8259 };
8260 map.iter().map(|(k, v)| (k.clone(), v.clone())).collect()
8261 };
8262 let t_mut = self
8263 .get_mut(table_name)
8264 .expect("table existed at the start of this fn");
8265 let idx_mut = t_mut
8266 .indices
8267 .iter_mut()
8268 .find(|i| i.name == index_name)
8269 .expect("index existed at the start of this fn");
8270 let IndexKind::BTree(map_mut) = &mut idx_mut.kind else {
8271 unreachable!("validated above");
8272 };
8273 for (key, locators) in entries {
8274 let mut new_locs = crate::posting::PostingList::new();
8275 let mut changed = false;
8276 for loc in &locators {
8277 match *loc {
8278 RowLocator::Cold {
8279 segment_id,
8280 page_offset: _,
8281 } if candidate_set.contains(&segment_id) => {
8282 let replacement = RowLocator::Cold {
8283 segment_id: merged_segment_id,
8284 page_offset: 0,
8285 };
8286 if !new_locs.contains(replacement) {
8287 new_locs.push(replacement);
8288 }
8289 changed = true;
8290 }
8291 other => new_locs.push(other),
8292 }
8293 }
8294 if changed {
8295 map_mut.insert_mut(key, new_locs);
8296 }
8297 }
8298
8299 // Tombstone every source slot. Last step — failures here
8300 // would leave the segment double-referenced in both
8301 // memory + manifest, but `tombstone_segment` only errors
8302 // on out-of-bounds, which we've already validated.
8303 for &id in &candidate_set {
8304 self.tombstone_segment(id)?;
8305 }
8306
8307 let bytes_reclaimed_estimate = source_byte_total.saturating_sub(merged_bytes_len);
8308 Ok(CompactReport {
8309 sources: candidate_set.into_iter().collect(),
8310 merged_segment_id: Some(merged_segment_id),
8311 merged_segment_bytes: seg_bytes,
8312 merged_rows,
8313 deleted_rows_pruned,
8314 bytes_reclaimed_estimate,
8315 })
8316 }
8317
8318 /// Internal helper: scan `(table, index)` for a `Cold` locator
8319 /// keyed by `key`. Returns `Ok(Some((segment_id, page_offset)))`
8320 /// when found, `Ok(None)` when the key has only hot entries
8321 /// or no entries at all, `Err` on the same input-validation
8322 /// errors as the public `promote_cold_row` / `shadow_cold_row`.
8323 fn find_cold_locator(
8324 &self,
8325 table_name: &str,
8326 index_name: &str,
8327 key: &IndexKey,
8328 ) -> Result<Option<(u32, u32)>, StorageError> {
8329 let t = self.get(table_name).ok_or_else(|| {
8330 StorageError::Corrupt(format!("find_cold_locator: table {table_name:?} not found"))
8331 })?;
8332 let idx = t
8333 .indices
8334 .iter()
8335 .find(|i| i.name == index_name)
8336 .ok_or_else(|| {
8337 StorageError::Corrupt(format!(
8338 "find_cold_locator: index {index_name:?} not found on {table_name:?}"
8339 ))
8340 })?;
8341 if !matches!(idx.kind, IndexKind::BTree(_)) {
8342 return Err(StorageError::Corrupt(format!(
8343 "find_cold_locator: index {index_name:?} is NSW; promote-on-write only applies to BTree indices"
8344 )));
8345 }
8346 for loc in idx.lookup_eq(key) {
8347 if let RowLocator::Cold {
8348 segment_id,
8349 page_offset,
8350 } = *loc
8351 {
8352 return Ok(Some((segment_id, page_offset)));
8353 }
8354 }
8355 Ok(None)
8356 }
8357}
8358
8359/// Coerce an [`IndexKey`] to the `u64` that v5.1 cold-tier
8360/// segments use as their on-disk PK. Returns `None` for keys that
8361/// aren't representable as `u64` — Text PKs need a hash mapping
8362/// the segment writer baked in (deferred to v5.2+), Bool PKs are
8363/// almost never wide enough to be sharded into a cold tier.
8364fn index_key_as_u64(key: &IndexKey) -> Option<u64> {
8365 match key {
8366 // Reinterpret the i64 bit pattern as u64. Cold-tier segments
8367 // are sorted by this u64 view, so the chosen interpretation
8368 // only has to match between insert (bake_segment / freezer)
8369 // and lookup — using cast_unsigned keeps both sides honest
8370 // and silences clippy::cast_sign_loss.
8371 IndexKey::Int(n) => Some(n.cast_unsigned()),
8372 // Text / Bool / Uuid / Bytes / Numeric PKs aren't representable
8373 // as u64 and so can't participate in the u64-sorted cold-tier
8374 // segment PK layout. Same deferral story as Text — lookup falls
8375 // through the in-memory btree.
8376 IndexKey::Text(_)
8377 | IndexKey::Bool(_)
8378 | IndexKey::Uuid(_)
8379 | IndexKey::Bytes(_)
8380 | IndexKey::Numeric(_)
8381 | IndexKey::Null => None,
8382 }
8383}
8384
8385#[derive(Debug, Clone, PartialEq, Eq)]
8386#[non_exhaustive]
8387pub enum StorageError {
8388 DuplicateTable {
8389 name: String,
8390 },
8391 TableNotFound {
8392 name: String,
8393 },
8394 ArityMismatch {
8395 expected: usize,
8396 actual: usize,
8397 },
8398 TypeMismatch {
8399 column: String,
8400 expected: DataType,
8401 actual: DataType,
8402 position: usize,
8403 },
8404 NullInNotNull {
8405 column: String,
8406 },
8407 /// Index with this name already exists on the table.
8408 DuplicateIndex {
8409 name: String,
8410 },
8411 /// Column referenced by an index doesn't exist on the table.
8412 ColumnNotFound {
8413 column: String,
8414 },
8415 /// On-disk format failed to parse — corrupted file, wrong magic, truncated
8416 /// payload, or unknown tag bytes.
8417 Corrupt(String),
8418 /// v6.0.4 — ALTER INDEX targeted an index name that doesn't
8419 /// exist on any table in this catalog.
8420 IndexNotFound {
8421 name: String,
8422 },
8423 /// v6.0.4 — operation requested isn't supported on this index
8424 /// kind / column type (e.g. ALTER INDEX REBUILD on a `BTree`
8425 /// index, or REBUILD WITH (encoding=…) on a non-vector column).
8426 Unsupported(String),
8427 /// v7.39 (round 220) — a CYCLE-less sequence ran past its bound.
8428 /// PG's 2200H phrasing: `nextval: reached maximum value of
8429 /// sequence "s" (n)` (`is_max: false` = the MINVALUE direction).
8430 SequenceExhausted {
8431 name: String,
8432 limit: i64,
8433 is_max: bool,
8434 },
8435}
8436
8437impl fmt::Display for StorageError {
8438 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
8439 match self {
8440 // v7.39 (read01 round 47) — PG's 42P07 wording.
8441 Self::DuplicateTable { name } => write!(f, "relation \"{name}\" already exists"),
8442 // v7.39 (read01 round 47) — PG's wording for a missing relation
8443 // (42P01). DROP TABLE says "table" and raises its own error at
8444 // the engine; every other path (SELECT / ALTER / …) says
8445 // "relation", which is what this carries.
8446 Self::TableNotFound { name } => write!(f, "relation \"{name}\" does not exist"),
8447 Self::ArityMismatch { expected, actual } => write!(
8448 f,
8449 "row arity mismatch: expected {expected} columns, got {actual}"
8450 ),
8451 Self::TypeMismatch {
8452 column,
8453 expected,
8454 actual,
8455 position,
8456 } => write!(
8457 f,
8458 "type mismatch in column {column:?} (position {position}): expected {expected}, got {actual}"
8459 ),
8460 Self::NullInNotNull { column } => {
8461 // v7.39 (SQLSTATE fidelity) — PG's 23502 phrasing (the
8462 // relation-qualified long form is added by engine call
8463 // sites that know the table name).
8464 write!(
8465 f,
8466 "null value in column \"{column}\" violates not-null constraint"
8467 )
8468 }
8469 // v7.39 (read01 round 47) — an index is a relation to PG (42P07).
8470 Self::DuplicateIndex { name } => write!(f, "relation \"{name}\" already exists"),
8471 // v7.39 (round 701) — PG's wording, and the same fix `EvalError::
8472 // ColumnNotFound` took in read01 round 81 with the same reason:
8473 // "column not found: x" matches none of the wire layer's `does
8474 // not exist` patterns, so a missing column reached the client as
8475 // the generic error class. The eval-side variant was changed and
8476 // the storage-side one was not, so which sentence you got
8477 // depended on which layer noticed — `CREATE INDEX ix ON t(nope)`
8478 // came out of storage and kept the old spelling.
8479 Self::ColumnNotFound { column } => write!(f, "column \"{column}\" does not exist"),
8480 Self::Corrupt(detail) => write!(f, "corrupt on-disk format: {detail}"),
8481 Self::IndexNotFound { name } => write!(f, "index \"{name}\" does not exist"),
8482 Self::Unsupported(detail) => write!(f, "unsupported: {detail}"),
8483 // v7.39 (round 220) — PG's exact 2200H wording.
8484 Self::SequenceExhausted {
8485 name,
8486 limit,
8487 is_max,
8488 } => write!(
8489 f,
8490 "nextval: reached {} value of sequence \"{name}\" ({limit})",
8491 if *is_max { "maximum" } else { "minimum" }
8492 ),
8493 }
8494 }
8495}
8496
8497impl ColumnSchema {
8498 pub fn new(name: impl Into<String>, ty: DataType, nullable: bool) -> Self {
8499 Self {
8500 name: name.into(),
8501 ty,
8502 nullable,
8503 collation_name: None,
8504 default: None,
8505 runtime_default: None,
8506 auto_increment: false,
8507 user_enum_type: None,
8508 user_domain_type: None,
8509 user_composite_type: None,
8510 acl: Vec::new(),
8511 on_update_runtime: None,
8512 collation: Collation::Binary,
8513 is_unsigned: false,
8514 inline_enum_variants: None,
8515 inline_set_variants: None,
8516 generated_stored_expr: None,
8517 identity_always: false,
8518 default_text: None,
8519 auto_restart: None,
8520 scalar_row_source: false,
8521 mysql_int_width: None,
8522 mysql_fsp: None,
8523 }
8524 }
8525
8526 /// v7.38.14 — the SAME column, re-described.
8527 ///
8528 /// `ColumnSchema::new` is for SYNTHESISING a column: a catalog row, an
8529 /// admin view, a computed output. It sets twenty-two fields to their
8530 /// defaults, which is right when there is no source column to speak of.
8531 ///
8532 /// It is wrong, and quietly so, when there IS one -- a join's combined
8533 /// schema, an aggregate's synthetic keys, a derived table's output. Those
8534 /// sites re-describe an existing column under a new name or type, and
8535 /// have each been written as `new(..)` followed by hand-picking a few
8536 /// attributes to copy across. They all pick differently and none picks
8537 /// them all.
8538 ///
8539 /// Five fields have been lost through that shape so far -- enum identity,
8540 /// MySQL fsp, the PG collation name, `ProjectedItem::fold_exempt`, and
8541 /// the `collation` enum -- and v7.38.14 alone found four sites dropping
8542 /// the last of those. The failure is never loud: `collation` defaults to
8543 /// `Binary`, which downstream reads as "byte-wise ON PURPOSE" rather than
8544 /// as "unknown", so a dropped declaration presents as a deliberate one.
8545 ///
8546 /// This constructor copies everything by construction. A field added to
8547 /// `ColumnSchema` therefore reaches every re-describe site without anyone
8548 /// having to remember, which is the property the hand-written copy lists
8549 /// never had.
8550 ///
8551 /// The two fields a re-describe legitimately changes -- name and
8552 /// nullability -- are parameters. Callers that also retype the column
8553 /// assign `ty` afterwards.
8554 #[must_use]
8555 pub fn rederive(source: &Self, name: impl Into<String>, nullable: bool) -> Self {
8556 Self {
8557 name: name.into(),
8558 nullable,
8559 ..source.clone()
8560 }
8561 }
8562
8563 /// Builder-style helper to attach a default value to an otherwise
8564 /// plain column schema. Used by the engine when CREATE TABLE
8565 /// specifies `column TYPE DEFAULT <expr>`.
8566 #[must_use]
8567 pub fn with_default(mut self, default: Value<'static>) -> Self {
8568 self.default = Some(default);
8569 self
8570 }
8571
8572 /// v7.9.21 — builder for runtime-evaluated defaults
8573 /// (`DEFAULT now()`, `DEFAULT CURRENT_TIMESTAMP`, …).
8574 /// `expr` is the Expr's `Display` form, re-parsed by the
8575 /// engine at each INSERT.
8576 #[must_use]
8577 pub fn with_runtime_default(mut self, expr: impl Into<String>) -> Self {
8578 self.runtime_default = Some(expr.into());
8579 self
8580 }
8581
8582 /// Builder-style helper to mark a column as `AUTO_INCREMENT`.
8583 #[must_use]
8584 pub const fn with_auto_increment(mut self) -> Self {
8585 self.auto_increment = true;
8586 self
8587 }
8588}
8589
8590impl TableSchema {
8591 pub fn new(name: impl Into<String>, columns: Vec<ColumnSchema>) -> Self {
8592 Self {
8593 name: name.into(),
8594 columns,
8595 hot_tier_bytes: None,
8596 foreign_keys: Vec::new(),
8597 uniqueness_constraints: Vec::new(),
8598 exclusion_constraints: Vec::new(),
8599 checks: Vec::new(),
8600 partition_role: None,
8601 policies: Vec::new(),
8602 row_security: false,
8603 force_row_security: false,
8604 owner: None,
8605 acl: Vec::new(),
8606 }
8607 }
8608}
8609
8610// =========================================================================
8611// Persistent binary format for the catalog.
8612//
8613// Layout (little-endian throughout):
8614//
8615// [magic "SPGDB001" 8 bytes][version u8]
8616// [table_count u32]
8617// for each table:
8618// [name_len u16][name bytes]
8619// [col_count u16]
8620// for each col:
8621// [name_len u16][name bytes]
8622// [type_tag u8 + optional payload]
8623// 1=Int 2=BigInt 3=Float 4=Text 5=Bool
8624// 6=Vector(u32 dim)
8625// 7=SmallInt
8626// 8=Varchar(u32 max)
8627// 9=Char(u32 size)
8628// 10=Numeric(u8 precision, u8 scale)
8629// 11=Date
8630// 12=Timestamp
8631// [nullable u8] 0/1
8632// [default_tag u8] 0=none 1=value (followed by [value_tag u8] + bytes)
8633// [row_count u32]
8634// for each row, for each col, one [value_tag u8] + value bytes:
8635// tag 0 (Null) → no body
8636// tag 1 (Int) → i32 LE
8637// tag 2 (BigInt) → i64 LE
8638// tag 3 (Float) → f64 LE
8639// tag 4 (Text) → u16 LE len + UTF-8 bytes
8640// tag 5 (Bool) → u8 0/1
8641// tag 6 (Vector) → u32 LE dim + dim×f32 LE
8642// tag 7 (SmallInt) → i16 LE
8643// tag 8 (Numeric) → i128 LE (16 bytes) + u8 scale
8644// tag 9 (Date) → i32 LE (days since Unix epoch)
8645// tag 10 (Timestamp) → i64 LE (microseconds since Unix epoch)
8646//
8647// Bumped to version 3 when NUMERIC was added; to version 4 when
8648// AUTO_INCREMENT (per-column flag) + NSW index `kind` byte landed;
8649// to version 5 when DATE / TIMESTAMP were added; to version 6 when
8650// NSW graph topology started travelling on disk (v2.7); to version 7
8651// when the NSW topology became multi-layer HNSW (v2.13); to version 8
8652// when row encoding switched to schema-driven dense layout (v3.0.2 —
8653// per-row NULL bitmap + per-column fixed-width body, no per-cell type
8654// tag).
8655// =========================================================================
8656
8657const FILE_MAGIC: &[u8; 8] = b"SPGDB001";
8658/// Current catalog snapshot format version emitted by [`Catalog::serialize`].
8659///
8660/// v9 (v5.2) extends v8 by serialising `BTree` index entries directly — every
8661/// `(IndexKey, Vec<RowLocator>)` pair travels on disk with the v5.1
8662/// `RowLocator::write_le` tag-prefixed codec. v8 `BTree` indices stored no
8663/// entries at all (the map was rebuilt from `Table::rows` on load); v9
8664/// preserves on-disk Cold locators so freezer-produced cold-tier index
8665/// entries survive a catalog snapshot round-trip. v8 readers are accepted
8666/// by version dispatch in [`Catalog::deserialize`] — every entry decodes
8667/// as `RowLocator::Hot(_)` via `add_index` rebuild, identical to v5.1
8668/// behaviour.
8669/// v6.7.2 — bumped from 10 to 11 to append per-table
8670/// `hot_tier_bytes: Option<u64>` after the per-table indices
8671/// section. v10 catalogs (v6.7.1) load with `hot_tier_bytes =
8672/// None` for every table (the deserialiser short-circuits when
8673/// version < 11). v11 snapshots written by a pre-v6.7.2 binary
8674/// fail loudly at the version check, matching the v6.1.2 /
8675/// v6.1.4 / v6.2.0 / v6.7.1 envelope-bump upgrade fences.
8676///
8677/// v6.8.0 — bumped from 11 to 12: per-index
8678/// `included_columns: Vec<u16>` appended at the tail of each
8679/// index payload. v11 (= v6.7.2) catalogs load with
8680/// `included_columns = Vec::new()` for every index — same
8681/// "older readers, append-only extension" pattern as the v6.7.2
8682/// hot_tier_bytes byte.
8683/// v7.13.0 — bumped from 22 to 23. mailrs round-5 G3 / G10.
8684/// Per-table appendix gains two new sections:
8685/// * `checks: Vec<String>` — CHECK predicate sources (Display
8686/// form of the AST Expr); re-parsed on INSERT/UPDATE to
8687/// enforce against candidate rows. Same persistence pattern
8688/// as `Index::partial_predicate`.
8689/// * Per `UniquenessConstraint`: trailing `nulls_not_distinct:
8690/// u8` flag for PG 15+ `UNIQUE NULLS NOT DISTINCT (cols)`
8691/// semantics.
8692/// v22 catalogs deserialise with empty `checks` and every UC
8693/// at `nulls_not_distinct = false`.
8694/// v24 introduces:
8695/// * Index kind tag 4 = trigram-GIN (`gin_trgm_ops`-flavoured
8696/// `USING gin` over a TEXT/VARCHAR column). Payload shape is
8697/// identical to tag-3 GIN (String → Vec<RowLocator>); the
8698/// keys are PG-compatible 3-byte trigram shingles instead of
8699/// tsvector lexemes. v23 catalogs deserialise unchanged — no
8700/// v23 writer ever emitted tag 4.
8701/// v25 introduces:
8702/// * Per `TriggerDef`: trailing `enabled: u8` flag (mailrs
8703/// round-9 A.2.b — `ALTER TABLE … { ENABLE | DISABLE }
8704/// TRIGGER …`). v24 catalogs deserialise with every trigger
8705/// `enabled = true`, matching pre-v7.16.1 behaviour.
8706/// v26 introduces (v7.17.0 Phase 1.1):
8707/// * Trailing SEQUENCE catalog block after triggers. Encoded
8708/// as `u32 count` followed by per-sequence:
8709/// `name`, `data_type: u8` (0=SmallInt,1=Int,2=BigInt),
8710/// `start i64`, `increment i64`, `min_value i64`,
8711/// `max_value i64`, `cache i64`, `cycle u8`,
8712/// `owned_by_tag u8` (0=NONE, 1=Column → `table`,`column`),
8713/// `last_value i64`, `is_called u8`. v25-and-below catalogs
8714/// deserialise with an empty sequences map.
8715/// v27 introduces (v7.17.0 Phase 1.2):
8716/// * Trailing VIEW catalog block after sequences. Encoded as
8717/// `u32 count` followed by per-view:
8718/// `name`, `column_count u16`, then column names, then
8719/// `body` long-string. v26-and-below catalogs deserialise
8720/// with an empty views map.
8721/// v28 introduces (v7.17.0 Phase 1.3):
8722/// * Trailing MATERIALIZED VIEW source registry block after
8723/// views. Encoded as `u32 count` followed by per-entry:
8724/// `name`, `body` long-string. The materialised rows live
8725/// as a regular Table of the same name (already covered by
8726/// the pre-existing tables block). v27-and-below catalogs
8727/// deserialise with an empty map.
8728/// v29 introduces (v7.17.0 Phase 1.4):
8729/// * Per-table user_enum_type appendix (after the CHECK
8730/// appendix). Layout: `u16 count` followed by per-binding
8731/// `[u16 col_pos][str enum_name]`. Only columns whose
8732/// `user_enum_type` is Some land here; the catalog stays
8733/// compact for the common no-enum case.
8734/// * Trailing ENUM types catalog block after materialized
8735/// views. Encoded as `u32 count` followed by per-entry:
8736/// `name`, `u16 label_count`, then `label_count` short
8737/// strings. v28-and-below catalogs deserialise with an
8738/// empty enum_types map and every column's
8739/// `user_enum_type = None`.
8740/// v30 introduces (v7.17.0 Phase 1.5):
8741/// * Per-table user_domain_type appendix (after the
8742/// user_enum_type appendix). Same shape as the enum one.
8743/// * Trailing DOMAIN types catalog block after the enum
8744/// block. Encoded as `u32 count` followed by per-entry:
8745/// `name`, `data_type` byte, `nullable u8`,
8746/// `default_present u8` + optional default string,
8747/// `u16 check_count` then `check_count` Display-form
8748/// CHECK strings. v29-and-below catalogs deserialise with
8749/// an empty domain_types map and `user_domain_type = None`.
8750/// v31 introduces (v7.17.0 Phase 1.6):
8751/// * Trailing user-schemas block after the DOMAIN block.
8752/// Encoded as `u32 count` followed by `count` schema-name
8753/// short strings. Built-in schemas (`public`, `pg_catalog`,
8754/// `information_schema`) are NOT serialised — they're
8755/// hardcoded in `is_builtin_schema`. v30-and-below catalogs
8756/// deserialise with an empty user-schemas set.
8757/// v32 introduces (v7.17.0 Phase 2.1):
8758/// * Per-table on_update_runtime appendix (after the
8759/// user_domain_type appendix). Layout: `u16 count` followed
8760/// by per-binding `[u16 col_pos][str expr_src]`. Only
8761/// columns whose `on_update_runtime` is Some land here;
8762/// the catalog stays compact when no MySQL-shaped table
8763/// uses the attribute. v31-and-below catalogs deserialise
8764/// with every column's `on_update_runtime = None`.
8765/// v33 introduces (v7.17.0 Phase 2.2):
8766/// * Index kind tag 5 = fulltext-GIN (MySQL `FULLTEXT KEY`
8767/// surface over a TEXT / VARCHAR column). Payload shape is
8768/// identical to tag-3 / tag-4 GIN (`String → Vec<RowLocator>`);
8769/// the keys are lower-cased word lexemes (same rule as
8770/// `to_tsvector('simple', text)`). v32 catalogs deserialise
8771/// unchanged — no v32 writer ever emitted tag 5, and FULLTEXT
8772/// KEY was silently dropped pre-v7.17 so no rebuild shim is
8773/// needed for round-tripped catalogs.
8774/// v34 introduces (v7.17.0 Phase 2.5):
8775/// * Per-table collation appendix (after the on_update_runtime
8776/// appendix). Sparse layout: only columns whose `collation`
8777/// is non-Binary land here. `u16 count` then per-binding
8778/// `[u16 col_pos][u8 collation_tag]` where the tag matches
8779/// `Collation::TAG_*`. Snapshots written by v33-and-below
8780/// readers deserialise every column with `collation =
8781/// Binary`, preserving the prior byte-wise compare
8782/// semantics. Unknown tags read back as Binary too — keeps
8783/// a forward-compat path if a future v35 adds variants
8784/// and someone rolls back to a v34 reader.
8785/// v35 introduces (v7.17.0 Phase 4.4):
8786/// * Per-table is_unsigned appendix (after the collation
8787/// appendix). Sparse layout: only `is_unsigned = true`
8788/// columns land. `u16 count` then per-binding `[u16 col_pos]`.
8789/// v34-and-below catalogs deserialise every column as
8790/// `is_unsigned = false`, preserving the prior silent-
8791/// accept behaviour for negative inserts on UNSIGNED columns.
8792/// v46 introduces (v7.23, mailrs round-14):
8793/// * Escaped short-string codec — `write_str` lengths >= 0xFFFF
8794/// emit `[u16 0xFFFF][u32 real_len]` so TEXT cells (mail bodies,
8795/// document text) above 64 KiB encode instead of panicking.
8796/// One-way upgrade: v45-and-below readers reject v46 catalogs
8797/// loudly via the version gate; v46 readers decode v45 catalogs
8798/// with the plain-u16 rules (0xFFFF is a legitimate length
8799/// there).
8800/// v47 introduces (v7.27, mailrs round-21):
8801/// * Escaped lengths for the REMAINING u16-length cell payloads —
8802/// BYTEA cells, TEXT[] elements, tsvector lexemes and tsquery
8803/// terms — the same `[u16 0xFFFF][u32 real_len]` escape v46
8804/// gave short strings. Round-14 fixed TEXT and missed these;
8805/// round-21 fired the BYTEA twin during a production migration.
8806/// One-way upgrade, same posture as v46.
8807/// v48 introduces (v7.37.5 β-P2, sentori cutover window):
8808/// * `INTERVAL` becomes a real column type. Catalog tag 34 in
8809/// `write_data_type`; per-row body is a fixed 16 bytes
8810/// (i64 micros + i32 days + i32 months, LE, PG-byte-equal
8811/// field order). The runtime-only days collapse is gone —
8812/// `'1 day'` and `'24 hours'` are stored distinctly. One-way
8813/// upgrade: v47 catalogs without INTERVAL columns deserialise
8814/// identically; v47 readers fed a v48 catalog that contains
8815/// INTERVAL hit the explicit "unknown data type tag: 34"
8816/// fence in `read_data_type`.
8817/// v49 introduces (v7.37.6-B, sentori Epic 2 P0):
8818/// * Per-table partition role appendix(declarative
8819/// `PARTITION BY RANGE` parent / range child / DEFAULT
8820/// child)。Layout, written **after** the inline_set_variants
8821/// appendix and **before** the per-table block close:
8822/// `[u8 role_tag]`
8823/// 0 = `None`(普通表,后向兼容默认)
8824/// 1 = `Parent`: `[u8 kind_tag (0=Range)]`
8825/// `[u16 key_col_count]` `(× u16 col_pos)`
8826/// `[u16 tmpl_count]` `(× str source)`
8827/// 2 = `Range`: `[str parent_name]` `[Bound]` `[Bound]`
8828/// 3 = `Default`: `[str parent_name]`
8829/// `PartitionBound` codec:
8830/// `[u8 bound_tag]` 0=MinValue 1=MaxValue 2=TimestampTz(`[i64 LE micros]`)
8831/// v48-and-below readers stop after the inline_set_variants
8832/// block — they don't see this appendix and deserialise every
8833/// table with `partition_role = None`. v49 writers always emit
8834/// `[0]` for plain tables, so the encoding stays one-byte-cheap.
8835/// v50 introduces (v7.37.7, sentori Epic 3 P1):
8836/// * Per-table `generated_stored_expr` appendix(stored generated
8837/// columns — `GENERATED ALWAYS AS (<expr>) STORED`)。Layout,
8838/// written **after** the partition_role appendix and before
8839/// the per-table block close:
8840/// `[u16 binding_count]`
8841/// `binding_count × { [u16 col_pos][str expr_source] }`
8842/// Sparse — only generated columns land here, so plain-shape
8843/// catalogs stay byte-for-byte identical save for the new
8844/// u16 zero count. v49-and-below readers stop after the
8845/// partition_role appendix; v50 readers default every column
8846/// to `generated_stored_expr = None` when this block is absent.
8847/// v51 introduces (v7.37.8, sentori Epic 5 P2):
8848/// * Per-index tag byte 6 = `GinJsonb`(real posting-list GIN
8849/// over a JSONB column). Payload shape mirrors tag-3 / 4 / 5:
8850/// `[u32 posting_list_count]` then `(str token, u32 locator_count,
8851/// locators …)` per posting list. Same `write_str` /
8852/// `RowLocator::write_le` codec as the rest of the GIN family.
8853/// v50 catalogs never wrote tag 6(the same DDL loaded as a
8854/// BTree fallback); v51 readers see tag 6 explicitly and dispatch
8855/// into `IndexKind::GinJsonb`.
8856/// v52 introduces (v7.37.42-T2 ζ-B composite + domain metasystem):
8857/// * Trailing COMPOSITE-types catalog block after the
8858/// user-schemas block. Encoded as `u32 count` followed by
8859/// per-entry: `name`, `u16 field_count`, then `field_count`
8860/// `[str field_name][data_type]` pairs (`write_data_type` is
8861/// reused). v51-and-below catalogs deserialise with an empty
8862/// composite_types map; v52 readers tolerate v51 catalogs by
8863/// stopping at the schema block (no composite block present
8864/// ⇒ empty map). Composite types are referenced by columns
8865/// via `ColumnSchema.user_composite_type`, mirroring the
8866/// `user_enum_type` / `user_domain_type` pattern. The block
8867/// lands here (not as a per-table appendix) so dropping the
8868/// composite type registers globally and DROP TYPE can find it
8869/// without a table scan.
8870/// v53 introduces (v7.37.16 Epic W — cross-checkpoint tombstone
8871/// durability):
8872/// * Trailing per-table MVCC appendix carrying, for every row,
8873/// its `RowHeader` (`xmin:u64`, `xmax:u64`, `flags:u8`) and its
8874/// stable `RowId` (`u64`), followed by the relation's
8875/// `next_rowid:u64`. Layout per table (after the v50
8876/// generated_stored_expr block, before the table loop closes):
8877/// `[u32 row_count]` (== `Table::rows().len()`, cross-check)
8878/// per row in physical order:
8879/// `[u64 xmin][u64 xmax][u8 flags][u64 rowid]`
8880/// `[u64 next_rowid]`
8881/// v52-and-below catalogs never wrote this block; their reader
8882/// stops after the last per-table appendix and
8883/// `deserialize_rows` leaves every row `RowHeader::frozen()`
8884/// with dense 1..=N ids — the exact pre-v53 contract. A v53
8885/// reader instead reconstructs headers + ids VERBATIM, so a
8886/// tombstone-redo naming a row inserted before the last
8887/// checkpoint resolves by `RowId` across the base-snapshot
8888/// boundary (closing the coupling the Epic W WAL slices deferred
8889/// to this format bump). Because the reader routes on `version`,
8890/// the block is strictly backward-compatible: old images load
8891/// byte-for-byte as before. `SPG_MVCC_INPLACE` is unaffected —
8892/// a gate-off database's rows are all frozen/alive, so
8893/// persisting + restoring their headers is observationally a
8894/// no-op.
8895/// v7.38 (read01 P5.05) — v54 appends a CRC32C over the whole preceding
8896/// image so a corrupted `base.spg` is caught on load instead of silently
8897/// deserialising garbage. Older images (v8..=53) carry no trailer and load
8898/// unchanged.
8899/// v7.39 (round 210) — v72 appends a per-table EXCLUDE-constraint appendix
8900/// (sparse: only tables carrying an EXCLUDE write it) at the very end of the
8901/// per-table block, after the column-ACL appendix. A v71 reader stops before
8902/// it and its tables read back with no exclusion constraints, which is what
8903/// they were.
8904/// v7.39 (round 220) — v73 appends a per-table identity-RESTART appendix
8905/// (sparse: [u16 count] then per entry [u16 col_pos][i64 LE floor]) after
8906/// the EXCLUDE appendix. A v72 reader stops before it; its columns read
8907/// back with no RESTART floor, losing only an un-consumed
8908/// `ALTER … RESTART WITH` across a restart.
8909/// r1039 — v90 adds index-key tags 4 (bytea) and 5 (the canonical
8910/// numeric key), so BYTEA and NUMERIC columns carry a real B-tree
8911/// instead of falling back to a scan. A v89 reader meeting either tag
8912/// reports a corrupt catalog rather than mis-reading it, which is the
8913/// same forward-compatibility story tag 3 (uuid) had at v36.
8914const FILE_VERSION: u8 = 91;
8915
8916/// v7.37 (round 833) — the codec version to decode a row that
8917/// [`encode_row_body_dense`] has just produced.
8918///
8919/// That encoder always writes the newest form, and every decoder gate is
8920/// a `codec_version >= N` feature test, so a freshly encoded row must be
8921/// read at the current version. Cold segments carry their own version in
8922/// their header and keep passing that; this is for in-process round
8923/// trips — sort runs on temp storage — where the bytes never outlive the
8924/// build that wrote them.
8925pub const CURRENT_ROW_CODEC_VERSION: u8 = FILE_VERSION;
8926/// First version that appends the trailing CRC32C integrity trailer.
8927const FILE_VERSION_CRC_TRAILER: u8 = 54;
8928/// Oldest format version [`Catalog::deserialize`] still accepts. v8 is the
8929/// v3.0.2 dense-row layout; pre-v8 catalogs require an offline migration.
8930const MIN_SUPPORTED_FILE_VERSION: u8 = 8;
8931
8932// IndexKey wire format (v9):
8933// tag 0 = Int → [i64 LE]
8934// tag 1 = Text → [u16 LE len + UTF-8 bytes] (via write_str / read_str)
8935// tag 2 = Bool → [u8 0/1]
8936const INDEX_KEY_TAG_INT: u8 = 0;
8937const INDEX_KEY_TAG_TEXT: u8 = 1;
8938const INDEX_KEY_TAG_BOOL: u8 = 2;
8939/// v7.17.0 — `IndexKey::Uuid([u8; 16])`. Body = raw 16 bytes
8940/// (RFC 4122 byte order). Persisted only in FILE_VERSION 36+
8941/// catalogs.
8942const INDEX_KEY_TAG_UUID: u8 = 3;
8943/// r1039 — `IndexKey::Bytes`. Body = [u32 LE len][raw bytes].
8944/// Persisted only in FILE_VERSION 90+ catalogs.
8945const INDEX_KEY_TAG_BYTES: u8 = 4;
8946/// r1039 — `IndexKey::Numeric`. Body = [u8 class][u8 neg][i32 LE exp]
8947/// [u32 LE digit count][one byte per decimal digit, 0..=9, MSD first].
8948/// Persisted only in FILE_VERSION 90+ catalogs.
8949const INDEX_KEY_TAG_NUMERIC: u8 = 5;
8950/// v7.38.1 (L12) — `IndexKey::Null`, a NULL component inside a
8951/// composite key. No body. Persisted only inside tag-7 multi-index
8952/// payloads, FILE_VERSION 91+.
8953const INDEX_KEY_TAG_NULL: u8 = 6;
8954
8955impl Catalog {
8956 /// Serialize the whole catalog (schema + every row) into a self-contained
8957 /// byte buffer. Format is documented above the impl block.
8958 pub fn serialize(&self) -> Vec<u8> {
8959 let mut out = Vec::with_capacity(64);
8960 out.extend_from_slice(FILE_MAGIC);
8961 out.push(FILE_VERSION);
8962 write_u32(
8963 &mut out,
8964 u32::try_from(self.tables.len()).expect("≤ 4G tables"),
8965 );
8966 for t in &self.tables {
8967 write_str(&mut out, &t.schema.name);
8968 write_u16(
8969 &mut out,
8970 u16::try_from(t.schema.columns.len()).expect("≤ 65k columns/table"),
8971 );
8972 for c in &t.schema.columns {
8973 write_str(&mut out, &c.name);
8974 write_data_type(&mut out, c.ty);
8975 out.push(u8::from(c.nullable));
8976 match &c.default {
8977 None => out.push(0),
8978 Some(v) => {
8979 out.push(1);
8980 write_value(&mut out, v);
8981 }
8982 }
8983 out.push(u8::from(c.auto_increment));
8984 }
8985 write_u32(
8986 &mut out,
8987 u32::try_from(t.rows.len()).expect("≤ 4G rows/table"),
8988 );
8989 // v3.0.2 dense row encoding (FILE_VERSION 8): per-row NULL
8990 // bitmap, then tightly-packed bodies. Identical wire format
8991 // as before — extracted into `encode_row_body_dense` so cold-
8992 // tier segments (v5.1+) can share the encoding.
8993 for row in &t.rows {
8994 out.extend_from_slice(&encode_row_body_dense(row, &t.schema));
8995 }
8996 // Index definitions. Per-index payload:
8997 // [name][col_pos u16][kind u8]
8998 // kind 0 = B-tree (no params — rebuilt on load)
8999 // kind 1 = NSW graph (u16 M + serialized graph)
9000 // For NSW the graph topology travels on disk so startup
9001 // doesn't re-run the O(n²M) rebuild — see v2.7 notes.
9002 write_u16(
9003 &mut out,
9004 u16::try_from(t.indices.len()).expect("≤ 65k indices/table"),
9005 );
9006 for idx in &t.indices {
9007 write_str(&mut out, &idx.name);
9008 write_u16(
9009 &mut out,
9010 u16::try_from(idx.column_position).expect("≤ 65k columns/table"),
9011 );
9012 match &idx.kind {
9013 IndexKind::BTree(map) => {
9014 out.push(0);
9015 // v9: serialise the full PB map. Each entry's
9016 // RowLocator list travels with the tag-prefixed
9017 // codec from `row_locator::write_le`, so freezer-
9018 // produced Cold locators survive a snapshot
9019 // round-trip. v8 BTree wrote nothing here and
9020 // rebuilt from rows — v9 readers tolerate v8 by
9021 // version dispatch in `Catalog::deserialize`.
9022 write_u32(
9023 &mut out,
9024 u32::try_from(map.len()).expect("≤ 4G index entries/index"),
9025 );
9026 for (key, locators) in map {
9027 write_index_key(&mut out, key);
9028 write_u32(
9029 &mut out,
9030 u32::try_from(locators.len()).expect("≤ 4G locators/key"),
9031 );
9032 for loc in locators {
9033 loc.write_le(&mut out);
9034 }
9035 }
9036 }
9037 // v7.38.1 (L12) — tag byte 7 = BTreeMulti. Payload
9038 // mirrors the tag-0 BTree encoding, with each key
9039 // written as `[u16 arity]` followed by that many
9040 // `write_index_key` components. FILE_VERSION 91+;
9041 // older catalogs never carried a multi index, so no
9042 // migration shim is needed.
9043 IndexKind::BTreeMulti(map) => {
9044 out.push(7);
9045 write_u32(
9046 &mut out,
9047 u32::try_from(map.len()).expect("≤ 4G index entries/index"),
9048 );
9049 for (key, locators) in map {
9050 write_u16(
9051 &mut out,
9052 u16::try_from(key.len()).expect("≤ 65k key components"),
9053 );
9054 for component in key.iter() {
9055 write_index_key(&mut out, component);
9056 }
9057 write_u32(
9058 &mut out,
9059 u32::try_from(locators.len()).expect("≤ 4G locators/key"),
9060 );
9061 for loc in locators {
9062 loc.write_le(&mut out);
9063 }
9064 }
9065 }
9066 IndexKind::Nsw(g) => {
9067 out.push(1);
9068 write_u16(&mut out, u16::try_from(g.m).expect("≤ 65k NSW neighbours"));
9069 write_nsw_graph(&mut out, g);
9070 }
9071 IndexKind::Brin { column_type, .. } => {
9072 // v6.7.1 — tag byte 2 = BRIN. Payload is the
9073 // column type code (1 byte mapping to the
9074 // shared DataType numeric encoding); no
9075 // further data — BRIN summaries live in
9076 // cold segments, not the catalog.
9077 out.push(2);
9078 write_data_type(&mut out, *column_type);
9079 }
9080 IndexKind::Gin(map) => {
9081 // v7.12.3 — tag byte 3 = GIN. Payload mirrors
9082 // the BTree encoding but with String (lexeme
9083 // word) keys instead of IndexKey. Tag-prefixed
9084 // RowLocator codec so freezer-produced Cold
9085 // locators survive snapshot round-trip.
9086 // FILE_VERSION 21+; v20 catalogs never wrote a
9087 // GIN index (the AM degraded to BTree fallback
9088 // pre-v7.12.3), so no migration shim is needed.
9089 out.push(3);
9090 write_u32(
9091 &mut out,
9092 u32::try_from(map.len()).expect("≤ 4G GIN posting lists"),
9093 );
9094 for (word, locators) in map {
9095 write_str(&mut out, word);
9096 write_u32(
9097 &mut out,
9098 u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9099 );
9100 for loc in locators {
9101 loc.write_le(&mut out);
9102 }
9103 }
9104 }
9105 IndexKind::GinTrgm(map) => {
9106 // v7.15.0 — tag byte 4 = GinTrgm
9107 // (`gin_trgm_ops` GIN over a TEXT column).
9108 // Payload shape is identical to tag-3 GIN —
9109 // `String → Vec<RowLocator>` posting lists.
9110 // The String keys are 3-byte trigrams instead
9111 // of tsvector lexemes; the deserializer
9112 // dispatches on the tag, not the key shape.
9113 // FILE_VERSION 24+; v23 catalogs never wrote
9114 // a trigram-GIN.
9115 out.push(4);
9116 write_u32(
9117 &mut out,
9118 u32::try_from(map.len()).expect("≤ 4G trigram-GIN posting lists"),
9119 );
9120 for (tri, locators) in map {
9121 write_str(&mut out, tri);
9122 write_u32(
9123 &mut out,
9124 u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9125 );
9126 for loc in locators {
9127 loc.write_le(&mut out);
9128 }
9129 }
9130 }
9131 IndexKind::GinFulltext(map) => {
9132 // v7.17.0 Phase 2.2 — tag byte 5 =
9133 // GinFulltext (MySQL `FULLTEXT KEY` GIN
9134 // over a TEXT/VARCHAR column). Payload
9135 // shape mirrors tag-3 / tag-4 GIN —
9136 // `String → Vec<RowLocator>` posting
9137 // lists keyed by lower-cased word
9138 // lexemes. FILE_VERSION 33+; v32 catalogs
9139 // never wrote a fulltext-GIN (FULLTEXT
9140 // KEY was silently dropped pre-v7.17).
9141 out.push(5);
9142 write_u32(
9143 &mut out,
9144 u32::try_from(map.len()).expect("≤ 4G fulltext-GIN posting lists"),
9145 );
9146 for (lex, locators) in map {
9147 write_str(&mut out, lex);
9148 write_u32(
9149 &mut out,
9150 u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9151 );
9152 for loc in locators {
9153 loc.write_le(&mut out);
9154 }
9155 }
9156 }
9157 IndexKind::GinJsonb(map) => {
9158 // v7.37.8 — tag byte 6 = GinJsonb
9159 // (real posting-list GIN over a JSONB
9160 // column; sentori Epic 5 P2). Payload
9161 // shape mirrors tag-3 / 4 / 5 — keys are
9162 // the canonical `(path, leaf)` tokens
9163 // from `jsonb_gin::extract_tokens`.
9164 // FILE_VERSION 51+; v50 catalogs never
9165 // wrote a JSONB-GIN (the same DDL loaded
9166 // as a BTree fallback).
9167 out.push(6);
9168 write_u32(
9169 &mut out,
9170 u32::try_from(map.len()).expect("≤ 4G JSONB-GIN posting lists"),
9171 );
9172 for (token, locators) in map {
9173 write_str(&mut out, token);
9174 write_u32(
9175 &mut out,
9176 u32::try_from(locators.len()).expect("≤ 4G locators/posting list"),
9177 );
9178 for loc in locators {
9179 loc.write_le(&mut out);
9180 }
9181 }
9182 }
9183 }
9184 // v6.8.0 — included_columns appendix per index.
9185 // Layout: [u16 num_included][num × u16 column_position].
9186 // v11 readers stop before this u16 (deserialise loop
9187 // gated on version >= 12); v12+ readers always
9188 // consume it. Empty Vec serialises as a bare 0u16.
9189 write_u16(
9190 &mut out,
9191 u16::try_from(idx.included_columns.len()).expect("≤ 65k INCLUDE columns/index"),
9192 );
9193 for col_pos in &idx.included_columns {
9194 write_u16(
9195 &mut out,
9196 u16::try_from(*col_pos).expect("≤ 65k columns/table"),
9197 );
9198 }
9199 // v6.8.1 — partial_predicate appendix per index.
9200 // Layout: [u8 has_pred][u16 LE len][bytes (if has_pred)].
9201 // Same v12 gate as included_columns.
9202 match &idx.partial_predicate {
9203 None => out.push(0),
9204 Some(pred) => {
9205 out.push(1);
9206 write_str(&mut out, pred);
9207 }
9208 }
9209 // v6.8.2 — expression appendix. Same shape as
9210 // partial_predicate.
9211 match &idx.expression {
9212 None => out.push(0),
9213 Some(expr) => {
9214 out.push(1);
9215 write_str(&mut out, expr);
9216 }
9217 }
9218 // v7.9.29 — is_unique appendix (FILE_VERSION 16+).
9219 // Single byte 0/1. v15-and-below readers stop before
9220 // this byte; v16 readers always consume it. mailrs K1.
9221 out.push(u8::from(idx.is_unique));
9222 // v7.9.29 — extra_column_positions appendix.
9223 // Layout: [u16 count][count × u16 column_position].
9224 write_u16(
9225 &mut out,
9226 u16::try_from(idx.extra_column_positions.len())
9227 .expect("≤ 65k extra cols / index"),
9228 );
9229 for cp in &idx.extra_column_positions {
9230 write_u16(&mut out, u16::try_from(*cp).expect("≤ 65k columns/table"));
9231 }
9232 // v7.39 (read01 round 52) — nulls_not_distinct (FILE_VERSION
9233 // 62+). Appended at the end of the per-index block so the v16
9234 // layout above is untouched; v61-and-below readers stop before
9235 // this byte and default the flag to false (NULLS DISTINCT).
9236 out.push(u8::from(idx.nulls_not_distinct));
9237 // v7.39 (round 537) — the key column's ordering clause
9238 // (FILE_VERSION 83+).
9239 out.push(u8::from(idx.descending));
9240 out.push(match idx.nulls_first {
9241 None => 0,
9242 Some(true) => 1,
9243 Some(false) => 2,
9244 });
9245 // v7.39 (round 538) — the key's explicit collation
9246 // (FILE_VERSION 84+).
9247 match &idx.collation {
9248 Some(c) => {
9249 out.push(1);
9250 write_str(&mut out, c);
9251 }
9252 None => out.push(0),
9253 }
9254 }
9255 // v6.7.2 — per-table hot_tier_bytes Option<u64>.
9256 // Layout: [u8 has_value][u64 LE value (if has_value)].
9257 // v10 readers stop before this byte (deserialise loop
9258 // gated on version >= 11); v11+ readers always
9259 // consume it.
9260 match t.schema.hot_tier_bytes {
9261 None => out.push(0),
9262 Some(n) => {
9263 out.push(1);
9264 out.extend_from_slice(&n.to_le_bytes());
9265 }
9266 }
9267 // v7.6.1 — FOREIGN KEY appendix (catalog FILE_VERSION 13+).
9268 // Layout: [u16 LE fk_count]
9269 // per fk:
9270 // [u8 has_name] [str name (if has_name)]
9271 // [u16 LE local_arity] [u16 LE local_pos]*arity
9272 // [str parent_table]
9273 // [u16 LE parent_arity] [u16 LE parent_pos]*arity
9274 // [u8 on_delete_tag] [u8 on_update_tag]
9275 // Older catalogs (v12 and below) skip this block entirely;
9276 // their reader stops before this byte.
9277 write_u16(
9278 &mut out,
9279 u16::try_from(t.schema.foreign_keys.len()).expect("≤ 65k FKs/table"),
9280 );
9281 for fk in &t.schema.foreign_keys {
9282 match &fk.name {
9283 None => out.push(0),
9284 Some(n) => {
9285 out.push(1);
9286 write_str(&mut out, n);
9287 }
9288 }
9289 write_u16(
9290 &mut out,
9291 u16::try_from(fk.local_columns.len()).expect("≤ 65k FK columns"),
9292 );
9293 for &p in &fk.local_columns {
9294 write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9295 }
9296 write_str(&mut out, &fk.parent_table);
9297 write_u16(
9298 &mut out,
9299 u16::try_from(fk.parent_columns.len()).expect("≤ 65k FK parent columns"),
9300 );
9301 for &p in &fk.parent_columns {
9302 write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9303 }
9304 out.push(fk.on_delete.tag());
9305 out.push(fk.on_update.tag());
9306 // v7.38 (read01, T29) — MATCH type tag (FILE_VERSION 55+).
9307 out.push(fk.match_type.tag());
9308 // v7.39 (round 288) — constraint timing (FILE_VERSION 79+).
9309 // One byte, bit 0 = DEFERRABLE, bit 1 = INITIALLY DEFERRED.
9310 out.push(u8::from(fk.deferrable) | (u8::from(fk.initially_deferred) << 1));
9311 }
9312 // v7.9.19 — UniquenessConstraint appendix (catalog
9313 // FILE_VERSION 15+). Layout per table after the FK
9314 // block:
9315 // [u16 count]
9316 // per constraint:
9317 // [u8 is_primary_key]
9318 // [u16 arity][u16 col_pos]*arity
9319 // Older catalogs (v14 and below) skip this block.
9320 write_u16(
9321 &mut out,
9322 u16::try_from(t.schema.uniqueness_constraints.len())
9323 .expect("≤ 65k uniqueness constraints/table"),
9324 );
9325 for uc in &t.schema.uniqueness_constraints {
9326 out.push(u8::from(uc.is_primary_key));
9327 write_u16(
9328 &mut out,
9329 u16::try_from(uc.columns.len()).expect("≤ 65k cols in uniqueness constraint"),
9330 );
9331 for &p in &uc.columns {
9332 write_u16(&mut out, u16::try_from(p).expect("≤ 65k columns/table"));
9333 }
9334 // v7.13.0 — `nulls_not_distinct` flag
9335 // (FILE_VERSION 23+). Always written by writers at
9336 // version 23+; deserialise gates on `version >= 23`
9337 // so v22-and-below catalogs round-trip cleanly.
9338 out.push(u8::from(uc.nulls_not_distinct));
9339 }
9340 // v7.9.21 — runtime_default appendix per table.
9341 // Layout: [u16 count] then for each:
9342 // [u16 col_pos][str expr]
9343 // Only columns whose runtime_default is Some land here;
9344 // catalog stays compact for the common literal-default
9345 // case.
9346 let mut rt_defaults: Vec<(usize, &str)> = Vec::new();
9347 for (i, c) in t.schema.columns.iter().enumerate() {
9348 if let Some(e) = &c.runtime_default {
9349 rt_defaults.push((i, e.as_str()));
9350 }
9351 }
9352 write_u16(
9353 &mut out,
9354 u16::try_from(rt_defaults.len()).expect("≤ 65k runtime defaults/table"),
9355 );
9356 for (pos, expr) in rt_defaults {
9357 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9358 write_str(&mut out, expr);
9359 }
9360 // v7.13.0 — CHECK constraint appendix per table.
9361 // Layout: [u16 count] then `count` Display-form
9362 // expression strings. Re-parsed on every INSERT/UPDATE
9363 // by the engine. FILE_VERSION 23+ only; v22 readers
9364 // never reach this block because the writer also moves
9365 // to v23 in lock-step.
9366 write_u16(
9367 &mut out,
9368 u16::try_from(t.schema.checks.len()).expect("≤ 65k CHECK constraints/table"),
9369 );
9370 for c in &t.schema.checks {
9371 // v7.39 (read01 round 48) — the expr stays in this v23
9372 // appendix (byte layout unchanged for old readers); the
9373 // name rides the v60 constraint-name appendix at the tail.
9374 write_str(&mut out, c.expr.as_str());
9375 }
9376 // v7.17.0 Phase 1.4 — per-table user_enum_type
9377 // appendix. Layout: [u16 count] then
9378 // [u16 col_pos][str enum_name] per binding. Only
9379 // columns whose user_enum_type is Some land here.
9380 let mut enum_bindings: Vec<(usize, &str)> = Vec::new();
9381 for (i, c) in t.schema.columns.iter().enumerate() {
9382 if let Some(e) = &c.user_enum_type {
9383 enum_bindings.push((i, e.as_str()));
9384 }
9385 }
9386 write_u16(
9387 &mut out,
9388 u16::try_from(enum_bindings.len()).expect("≤ 65k enum-typed columns/table"),
9389 );
9390 for (pos, ename) in enum_bindings {
9391 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9392 write_str(&mut out, ename);
9393 }
9394 // v7.17.0 Phase 1.5 — per-table user_domain_type
9395 // appendix. Same layout as the enum one. v29-and-
9396 // below readers stop after the enum appendix.
9397 let mut domain_bindings: Vec<(usize, &str)> = Vec::new();
9398 for (i, c) in t.schema.columns.iter().enumerate() {
9399 if let Some(d) = &c.user_domain_type {
9400 domain_bindings.push((i, d.as_str()));
9401 }
9402 }
9403 write_u16(
9404 &mut out,
9405 u16::try_from(domain_bindings.len()).expect("≤ 65k domain-typed columns/table"),
9406 );
9407 for (pos, dname) in domain_bindings {
9408 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9409 write_str(&mut out, dname);
9410 }
9411 // v7.17.0 Phase 2.1 — per-table on_update_runtime
9412 // appendix. Sparse: only ON UPDATE-bound columns.
9413 let mut on_update_bindings: Vec<(usize, &str)> = Vec::new();
9414 for (i, c) in t.schema.columns.iter().enumerate() {
9415 if let Some(e) = &c.on_update_runtime {
9416 on_update_bindings.push((i, e.as_str()));
9417 }
9418 }
9419 write_u16(
9420 &mut out,
9421 u16::try_from(on_update_bindings.len()).expect("≤ 65k ON UPDATE columns/table"),
9422 );
9423 for (pos, expr_src) in on_update_bindings {
9424 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9425 write_str(&mut out, expr_src);
9426 }
9427 // v7.17.0 Phase 2.5 — per-table collation appendix.
9428 // Sparse: only non-Binary columns land. Layout:
9429 // `[u16 count][u16 col_pos][u8 tag] × count`.
9430 let mut coll_bindings: Vec<(usize, u8)> = Vec::new();
9431 for (i, c) in t.schema.columns.iter().enumerate() {
9432 let tag = match c.collation {
9433 Collation::Binary => continue,
9434 Collation::CaseInsensitive => Collation::TAG_CASE_INSENSITIVE,
9435 };
9436 coll_bindings.push((i, tag));
9437 }
9438 write_u16(
9439 &mut out,
9440 u16::try_from(coll_bindings.len()).expect("≤ 65k collation bindings/table"),
9441 );
9442 for (pos, tag) in coll_bindings {
9443 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9444 out.push(tag);
9445 }
9446 // v7.17.0 Phase 4.4 — per-table is_unsigned appendix.
9447 // Sparse: only UNSIGNED columns land. Layout:
9448 // `[u16 count][u16 col_pos] × count`.
9449 let mut unsigned_bindings: Vec<usize> = Vec::new();
9450 for (i, c) in t.schema.columns.iter().enumerate() {
9451 if c.is_unsigned {
9452 unsigned_bindings.push(i);
9453 }
9454 }
9455 write_u16(
9456 &mut out,
9457 u16::try_from(unsigned_bindings.len()).expect("≤ 65k UNSIGNED columns/table"),
9458 );
9459 for pos in unsigned_bindings {
9460 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9461 }
9462 // v7.17.0 Phase 3.P0-36 — per-table inline_enum_variants
9463 // appendix. Sparse: only ENUM columns land. Layout:
9464 // `[u16 count] then per binding [u16 col_pos]
9465 // [u16 variant_count] then variant strings`.
9466 // FILE_VERSION 41+; v40 readers never reach this block.
9467 let mut enum_inline_bindings: Vec<(usize, &[String])> = Vec::new();
9468 for (i, c) in t.schema.columns.iter().enumerate() {
9469 if let Some(vs) = &c.inline_enum_variants {
9470 enum_inline_bindings.push((i, vs.as_slice()));
9471 }
9472 }
9473 write_u16(
9474 &mut out,
9475 u16::try_from(enum_inline_bindings.len()).expect("≤ 65k inline-ENUM columns/table"),
9476 );
9477 for (pos, variants) in enum_inline_bindings {
9478 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9479 write_u16(
9480 &mut out,
9481 u16::try_from(variants.len()).expect("≤ 65k variants/ENUM"),
9482 );
9483 for v in variants {
9484 write_str(&mut out, v.as_str());
9485 }
9486 }
9487 // v7.17.0 Phase 3.P0-37 — per-table inline_set_variants
9488 // appendix. Same layout as the inline ENUM block.
9489 // FILE_VERSION 42+; v41 readers never reach this block.
9490 let mut set_inline_bindings: Vec<(usize, &[String])> = Vec::new();
9491 for (i, c) in t.schema.columns.iter().enumerate() {
9492 if let Some(vs) = &c.inline_set_variants {
9493 set_inline_bindings.push((i, vs.as_slice()));
9494 }
9495 }
9496 write_u16(
9497 &mut out,
9498 u16::try_from(set_inline_bindings.len()).expect("≤ 65k inline-SET columns/table"),
9499 );
9500 for (pos, variants) in set_inline_bindings {
9501 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9502 write_u16(
9503 &mut out,
9504 u16::try_from(variants.len()).expect("≤ 65k variants/SET"),
9505 );
9506 for v in variants {
9507 write_str(&mut out, v.as_str());
9508 }
9509 }
9510 // v7.37.6-B — partition role appendix(FILE_VERSION 49+)。
9511 // Layout 详见 FILE_VERSION 49 docstring。普通表 = 单字节 0。
9512 write_partition_role(&mut out, t.schema.partition_role.as_ref());
9513 // v7.37.7 — per-table generated_stored_expr appendix
9514 // (FILE_VERSION 50+). Sparse: only columns whose
9515 // generated_stored_expr is Some land here.
9516 let mut gen_bindings: Vec<(usize, &str)> = Vec::new();
9517 for (i, c) in t.schema.columns.iter().enumerate() {
9518 if let Some(src) = &c.generated_stored_expr {
9519 gen_bindings.push((i, src.as_str()));
9520 }
9521 }
9522 write_u16(
9523 &mut out,
9524 u16::try_from(gen_bindings.len()).expect("≤ 65k GENERATED STORED columns/table"),
9525 );
9526 for (pos, src) in gen_bindings {
9527 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9528 write_str(&mut out, src);
9529 }
9530 // v7.38 (read01) — per-table default_text appendix
9531 // (FILE_VERSION 58+). Sparse: only columns whose default_text
9532 // is Some land here. Mirrors the generated_stored_expr shape.
9533 let mut default_texts: Vec<(usize, &str)> = Vec::new();
9534 for (i, c) in t.schema.columns.iter().enumerate() {
9535 if let Some(src) = &c.default_text {
9536 default_texts.push((i, src.as_str()));
9537 }
9538 }
9539 write_u16(
9540 &mut out,
9541 u16::try_from(default_texts.len()).expect("≤ 65k defaulted columns/table"),
9542 );
9543 for (pos, src) in default_texts {
9544 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9545 write_str(&mut out, src);
9546 }
9547 // v7.39 (RLS) — per-table policy appendix + the two RLS flags
9548 // (FILE_VERSION 59+). Written after the default_text block and
9549 // before the MVCC row appendix, so a v58 reader stops before it.
9550 // Layout: [u8 row_security][u8 force] [u16 policy_count] then per
9551 // policy: [str name][u8 cmd][u8 permissive][u16 role_count]
9552 // (role_count × str) [u8 has_using](+str)[u8 has_check](+str).
9553 out.push(u8::from(t.schema.row_security));
9554 out.push(u8::from(t.schema.force_row_security));
9555 write_u16(
9556 &mut out,
9557 u16::try_from(t.schema.policies.len()).expect("≤ 65k policies/table"),
9558 );
9559 for p in &t.schema.policies {
9560 write_str(&mut out, &p.name);
9561 out.push(p.cmd.to_wire_byte());
9562 out.push(u8::from(p.permissive));
9563 write_u16(
9564 &mut out,
9565 u16::try_from(p.roles.len()).expect("≤ 65k roles/policy"),
9566 );
9567 for r in &p.roles {
9568 write_str(&mut out, r);
9569 }
9570 match &p.using_expr {
9571 Some(s) => {
9572 out.push(1);
9573 write_str(&mut out, s);
9574 }
9575 None => out.push(0),
9576 }
9577 match &p.with_check_expr {
9578 Some(s) => {
9579 out.push(1);
9580 write_str(&mut out, s);
9581 }
9582 None => out.push(0),
9583 }
9584 }
9585 // v7.37.16 (Epic W) — per-row MVCC header + stable RowId
9586 // appendix (FILE_VERSION 53+). Persists xmin/xmax/flags +
9587 // RowId for every row so a tombstone naming a pre-checkpoint
9588 // row survives a serialize→deserialize base restore
9589 // (cross-checkpoint tombstone durability). `headers` /
9590 // `rowids` are lock-step parallel to `rows` (invariant held
9591 // at every mutation boundary), so the count is `rows.len()`
9592 // and the zipped walk visits them in physical row order —
9593 // the same order the rows block above was written in. v52
9594 // readers never reach this block (the writer also moves to
9595 // v53 in lock-step); a v53 reader restores headers + ids
9596 // verbatim instead of freezing + dense-assigning.
9597 debug_assert_eq!(
9598 t.rows.len(),
9599 t.headers.len(),
9600 "headers must be lock-step with rows at serialize"
9601 );
9602 debug_assert_eq!(
9603 t.rows.len(),
9604 t.rowids.len(),
9605 "rowids must be lock-step with rows at serialize"
9606 );
9607 write_u32(
9608 &mut out,
9609 u32::try_from(t.rows.len()).expect("≤ 4G rows/table"),
9610 );
9611 for (h, rid) in t.headers.iter().zip(t.rowids.iter()) {
9612 out.extend_from_slice(&h.xmin.to_le_bytes());
9613 out.extend_from_slice(&h.xmax.to_le_bytes());
9614 out.push(h.flags);
9615 out.extend_from_slice(&rid.0.to_le_bytes());
9616 }
9617 out.extend_from_slice(
9618 &t.next_rowid
9619 .load(core::sync::atomic::Ordering::Relaxed)
9620 .to_le_bytes(),
9621 );
9622 // v7.39 (read01 round 48) — constraint-name appendix
9623 // (FILE_VERSION 60+). Index-aligned to the CHECK and
9624 // uniqueness-constraint appendices written above, so the
9625 // existing byte layouts stay untouched and a v59 catalog still
9626 // decodes (its constraints just come back unnamed).
9627 // Layout: [u16 check_count] then per check
9628 // [u8 has_name] ([str name] when has_name)
9629 // [u16 uc_count] then per uc the same pair.
9630 write_u16(
9631 &mut out,
9632 u16::try_from(t.schema.checks.len()).expect("≤ 65k CHECK constraints/table"),
9633 );
9634 for c in &t.schema.checks {
9635 match &c.name {
9636 Some(n) => {
9637 out.push(1);
9638 write_str(&mut out, n);
9639 }
9640 None => out.push(0),
9641 }
9642 }
9643 write_u16(
9644 &mut out,
9645 u16::try_from(t.schema.uniqueness_constraints.len())
9646 .expect("≤ 65k uniqueness constraints/table"),
9647 );
9648 for uc in &t.schema.uniqueness_constraints {
9649 match &uc.name {
9650 Some(n) => {
9651 out.push(1);
9652 write_str(&mut out, n);
9653 }
9654 None => out.push(0),
9655 }
9656 }
9657 // v7.39 (read01 round 56) — user_composite_type appendix
9658 // (FILE_VERSION 63+). Sparse, at the very end of the per-table
9659 // block: only composite-typed columns land here, so a v62 reader
9660 // stops before it and its composite columns stay plain JSON.
9661 let mut comp_bindings: Vec<(usize, &str)> = Vec::new();
9662 for (i, c) in t.schema.columns.iter().enumerate() {
9663 if let Some(n) = &c.user_composite_type {
9664 comp_bindings.push((i, n.as_str()));
9665 }
9666 }
9667 write_u16(
9668 &mut out,
9669 u16::try_from(comp_bindings.len()).expect("≤ 65k composite-typed columns/table"),
9670 );
9671 for (pos, n) in comp_bindings {
9672 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9673 write_str(&mut out, n);
9674 }
9675 // v7.39 (read01 round 57) — owner + ACL appendix (FILE_VERSION
9676 // 64+), at the very end of the per-table block so a v63 reader
9677 // stops before it (its tables then read back owner-less, i.e.
9678 // owned by the login role, with no grants — which is exactly what
9679 // they were).
9680 match &t.schema.owner {
9681 Some(o) => {
9682 out.push(1);
9683 write_str(&mut out, o);
9684 }
9685 None => out.push(0),
9686 }
9687 write_u16(
9688 &mut out,
9689 u16::try_from(t.schema.acl.len()).expect("≤ 65k aclitems/table"),
9690 );
9691 for a in &t.schema.acl {
9692 write_str(&mut out, &a.grantee);
9693 write_u16(&mut out, a.privs);
9694 write_u16(&mut out, a.grantable);
9695 write_str(&mut out, &a.grantor);
9696 }
9697 // v7.39 (read01 round 59) — COLUMN acl appendix (FILE_VERSION 65+),
9698 // sparse: only columns that carry a grant land here, so a v64 reader
9699 // stops before it and its columns read back un-granted, which is
9700 // what they were.
9701 let granted: Vec<(usize, &ColumnSchema)> = t
9702 .schema
9703 .columns
9704 .iter()
9705 .enumerate()
9706 .filter(|(_, c)| !c.acl.is_empty())
9707 .collect();
9708 write_u16(
9709 &mut out,
9710 u16::try_from(granted.len()).expect("≤ 65k granted columns/table"),
9711 );
9712 for (pos, c) in granted {
9713 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9714 write_u16(
9715 &mut out,
9716 u16::try_from(c.acl.len()).expect("≤ 65k aclitems/column"),
9717 );
9718 for a in &c.acl {
9719 write_str(&mut out, &a.grantee);
9720 write_u16(&mut out, a.privs);
9721 write_u16(&mut out, a.grantable);
9722 write_str(&mut out, &a.grantor);
9723 }
9724 }
9725 // v7.39 (round 210) — EXCLUDE-constraint appendix (FILE_VERSION
9726 // 72+), at the very end of the per-table block so a v71 reader
9727 // stops before it and its tables read back with no exclusion
9728 // constraints. Layout: [u16 excl_count] then per constraint
9729 // [str name] [u8 has_method](+str) [u16 elem_count] then per
9730 // element [u16 col_pos][str op].
9731 write_u16(
9732 &mut out,
9733 u16::try_from(t.schema.exclusion_constraints.len())
9734 .expect("≤ 65k exclusion constraints/table"),
9735 );
9736 for ex in &t.schema.exclusion_constraints {
9737 write_str(&mut out, &ex.name);
9738 match &ex.method {
9739 Some(m) => {
9740 out.push(1);
9741 write_str(&mut out, m);
9742 }
9743 None => out.push(0),
9744 }
9745 write_u16(
9746 &mut out,
9747 u16::try_from(ex.elements.len()).expect("≤ 65k elements/exclusion"),
9748 );
9749 for (pos, op) in &ex.elements {
9750 write_u16(&mut out, u16::try_from(*pos).expect("≤ 65k columns/table"));
9751 write_str(&mut out, op);
9752 }
9753 }
9754 // v7.39 (round 220) — identity-RESTART appendix (FILE_VERSION
9755 // 73+), sparse: only columns carrying a RESTART floor land here.
9756 let restarts: Vec<(usize, i64)> = t
9757 .schema
9758 .columns
9759 .iter()
9760 .enumerate()
9761 .filter_map(|(i, c)| c.auto_restart.map(|n| (i, n)))
9762 .collect();
9763 write_u16(
9764 &mut out,
9765 u16::try_from(restarts.len()).expect("≤ 65k restart columns/table"),
9766 );
9767 for (pos, n) in restarts {
9768 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9769 out.extend_from_slice(&n.to_le_bytes());
9770 }
9771 // v7.39 (round 386, type-fidelity epic P1) — per-table
9772 // mysql_int_width appendix (FILE_VERSION 81+). Sparse: only
9773 // TINYINT / MEDIUMINT columns land. Layout:
9774 // `[u16 count]([u16 col_pos][u8 width_tag]) × count`
9775 // (tag 0 = Tiny, 1 = Medium). v80-and-below readers stop after
9776 // the identity-RESTART appendix, leaving every column at None.
9777 let int_widths: Vec<(usize, u8)> = t
9778 .schema
9779 .columns
9780 .iter()
9781 .enumerate()
9782 .filter_map(|(i, c)| {
9783 c.mysql_int_width.map(|w| {
9784 let tag = match w {
9785 MysqlIntWidth::Tiny => 0u8,
9786 MysqlIntWidth::Medium => 1u8,
9787 MysqlIntWidth::Small => 2u8,
9788 MysqlIntWidth::Int => 3u8,
9789 MysqlIntWidth::Big => 4u8,
9790 };
9791 (i, tag)
9792 })
9793 })
9794 .collect();
9795 write_u16(
9796 &mut out,
9797 u16::try_from(int_widths.len()).expect("≤ 65k narrow-int columns/table"),
9798 );
9799 for (pos, tag) in int_widths {
9800 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9801 out.push(tag);
9802 }
9803 // v7.39 (round 424, type-fidelity epic) — per-table mysql_fsp
9804 // appendix (FILE_VERSION 82+). Sparse: only MySQL-declared
9805 // temporal columns land. Layout:
9806 // `[u16 count]([u16 col_pos][u8 fsp]) × count`, fsp in 0..=6.
9807 // v81-and-below readers stop after the int-width appendix,
9808 // leaving every column at None (PG microsecond behaviour).
9809 let fsps: Vec<(usize, u8)> = t
9810 .schema
9811 .columns
9812 .iter()
9813 .enumerate()
9814 .filter_map(|(i, c)| c.mysql_fsp.map(|p| (i, p)))
9815 .collect();
9816 write_u16(
9817 &mut out,
9818 u16::try_from(fsps.len()).expect("≤ 65k temporal columns/table"),
9819 );
9820 for (pos, fsp) in fsps {
9821 write_u16(&mut out, u16::try_from(pos).expect("≤ 65k columns/table"));
9822 out.push(fsp);
9823 }
9824 // v7.39 (round 652) — CHECK-validated appendix (FILE_VERSION
9825 // 87+). Sparse the other way round from the ones above: the
9826 // common case is every constraint validated, so only the
9827 // NOT VALID ones are written, by their index into the CHECK
9828 // appendix. Layout: `[u16 count]([u16 check_idx]) × count`.
9829 let unvalidated: Vec<usize> = t
9830 .schema
9831 .checks
9832 .iter()
9833 .enumerate()
9834 .filter_map(|(i, c)| (!c.validated).then_some(i))
9835 .collect();
9836 write_u16(
9837 &mut out,
9838 u16::try_from(unvalidated.len()).expect("≤ 65k CHECK constraints/table"),
9839 );
9840 for idx in unvalidated {
9841 write_u16(&mut out, u16::try_from(idx).expect("≤ 65k CHECK/table"));
9842 }
9843 // v7.39 (round 677) — per-column collation names (FILE_VERSION
9844 // 88+). Sparse: only the columns that were written with an
9845 // explicit `COLLATE` appear, so a table that declares none pays
9846 // two bytes. Layout: `[u16 count]([u16 col_idx][str]) × count`.
9847 //
9848 // Without this the declaration survives CREATE TABLE and dies
9849 // at the next restart — measured: a column declared
9850 // `COLLATE "C"` reported attcollation 950 in the session that
9851 // created it and 100 after a reload.
9852 let collated: Vec<(usize, &str)> = t
9853 .schema
9854 .columns
9855 .iter()
9856 .enumerate()
9857 .filter_map(|(i, c)| c.collation_name.as_deref().map(|n| (i, n)))
9858 .collect();
9859 write_u16(
9860 &mut out,
9861 u16::try_from(collated.len()).expect("≤ 65k columns/table"),
9862 );
9863 for (idx, name) in collated {
9864 write_u16(&mut out, u16::try_from(idx).expect("≤ 65k columns/table"));
9865 write_str(&mut out, name);
9866 }
9867 // v7.39 (round 711) — PK/UNIQUE constraint timing (FILE_VERSION
9868 // 89+). Dense, one byte per uniqueness constraint in
9869 // declaration order, the same bit layout the FK block has
9870 // carried since round 288: bit 0 = DEFERRABLE, bit 1 =
9871 // INITIALLY DEFERRED. A v88 reader stops before it.
9872 write_u16(
9873 &mut out,
9874 u16::try_from(t.schema.uniqueness_constraints.len())
9875 .expect("≤ 65k uniqueness constraints/table"),
9876 );
9877 for uc in &t.schema.uniqueness_constraints {
9878 out.push(u8::from(uc.deferrable) | (u8::from(uc.initially_deferred) << 1));
9879 }
9880 }
9881 // v7.12.4 — catalog-wide appendix: user-defined functions
9882 // then triggers. FILE_VERSION 22+ only. v21 and earlier
9883 // readers stop after the last table; v22 readers always
9884 // consume two `u32` counts (possibly zero).
9885 //
9886 // Function entry layout:
9887 // [str name] [str args_repr] [str returns]
9888 // [str language] [str body]
9889 // Trigger entry layout:
9890 // [str name] [str table] [str timing]
9891 // [u16 event_count] (event_count × str)
9892 // [str for_each] [str function]
9893 write_u32(
9894 &mut out,
9895 u32::try_from(self.functions.len()).expect("≤ 4G functions"),
9896 );
9897 for fd in self.functions.values() {
9898 write_str(&mut out, &fd.name);
9899 write_str(&mut out, &fd.args_repr);
9900 write_str(&mut out, &fd.returns);
9901 write_str(&mut out, &fd.language);
9902 write_str_long(&mut out, &fd.body);
9903 }
9904 write_u32(
9905 &mut out,
9906 u32::try_from(self.triggers.len()).expect("≤ 4G triggers"),
9907 );
9908 for td in &self.triggers {
9909 write_str(&mut out, &td.name);
9910 write_str(&mut out, &td.table);
9911 write_str(&mut out, &td.timing);
9912 write_u16(
9913 &mut out,
9914 u16::try_from(td.events.len()).expect("≤ 65k events / trigger"),
9915 );
9916 for ev in &td.events {
9917 write_str(&mut out, ev);
9918 }
9919 write_str(&mut out, &td.for_each);
9920 write_str(&mut out, &td.function);
9921 // v7.13.0 — `UPDATE OF cols` filter
9922 // (FILE_VERSION 23+). v22 readers omit; v23 writers
9923 // always emit (possibly zero).
9924 write_u16(
9925 &mut out,
9926 u16::try_from(td.update_columns.len()).expect("≤ 65k cols / trigger"),
9927 );
9928 for c in &td.update_columns {
9929 write_str(&mut out, c);
9930 }
9931 // v7.16.1 — TriggerDef.enabled (FILE_VERSION 25+).
9932 out.push(u8::from(td.enabled));
9933 // v7.39 (round 138) — WHEN condition text (FILE_VERSION 70+).
9934 write_str(&mut out, &td.when_condition);
9935 }
9936 // v7.17.0 Phase 1.1 — SEQUENCE catalog block (FILE_VERSION 26+).
9937 write_u32(
9938 &mut out,
9939 u32::try_from(self.sequences.len()).expect("≤ 4G sequences"),
9940 );
9941 for seq in self.sequences.values() {
9942 write_str(&mut out, &seq.name);
9943 out.push(match seq.data_type {
9944 SequenceDataType::SmallInt => 0,
9945 SequenceDataType::Int => 1,
9946 SequenceDataType::BigInt => 2,
9947 });
9948 out.extend_from_slice(&seq.start.to_le_bytes());
9949 out.extend_from_slice(&seq.increment.to_le_bytes());
9950 out.extend_from_slice(&seq.min_value.to_le_bytes());
9951 out.extend_from_slice(&seq.max_value.to_le_bytes());
9952 out.extend_from_slice(&seq.cache.to_le_bytes());
9953 out.push(u8::from(seq.cycle));
9954 match &seq.owned_by {
9955 None => out.push(0),
9956 Some((table, column)) => {
9957 out.push(1);
9958 write_str(&mut out, table);
9959 write_str(&mut out, column);
9960 }
9961 }
9962 out.extend_from_slice(&seq.last_value.to_le_bytes());
9963 out.push(u8::from(seq.is_called));
9964 }
9965 // v7.17.0 Phase 1.2 — VIEW catalog block (FILE_VERSION 27+).
9966 write_u32(
9967 &mut out,
9968 u32::try_from(self.views.len()).expect("≤ 4G views"),
9969 );
9970 for view in self.views.values() {
9971 write_str(&mut out, &view.name);
9972 write_u16(
9973 &mut out,
9974 u16::try_from(view.columns.len()).expect("≤ 65k cols / view"),
9975 );
9976 for c in &view.columns {
9977 write_str(&mut out, c);
9978 }
9979 write_str_long(&mut out, &view.body);
9980 // v7.39 (round 132, FILE_VERSION 69+) — WITH CHECK OPTION marker.
9981 out.push(view.check_option);
9982 }
9983 // v7.17.0 Phase 1.3 — MATERIALIZED VIEW source registry
9984 // (FILE_VERSION 28+). The backing rows live as a regular
9985 // table of the same name already in the tables block.
9986 write_u32(
9987 &mut out,
9988 u32::try_from(self.materialized_views.len()).expect("≤ 4G materialized views"),
9989 );
9990 for (name, body) in &self.materialized_views {
9991 write_str(&mut out, name);
9992 write_str_long(&mut out, body);
9993 }
9994 // v7.17.0 Phase 1.4 — ENUM types catalog block
9995 // (FILE_VERSION 29+).
9996 write_u32(
9997 &mut out,
9998 u32::try_from(self.enum_types.len()).expect("≤ 4G enum types"),
9999 );
10000 for e in self.enum_types.values() {
10001 write_str(&mut out, &e.name);
10002 write_u16(
10003 &mut out,
10004 u16::try_from(e.labels.len()).expect("≤ 65k labels / enum"),
10005 );
10006 for l in &e.labels {
10007 write_str(&mut out, l);
10008 }
10009 }
10010 // v7.17.0 Phase 1.5 — DOMAIN types catalog block
10011 // (FILE_VERSION 30+).
10012 write_u32(
10013 &mut out,
10014 u32::try_from(self.domain_types.len()).expect("≤ 4G domain types"),
10015 );
10016 for d in self.domain_types.values() {
10017 write_str(&mut out, &d.name);
10018 write_data_type(&mut out, d.base_type);
10019 out.push(u8::from(d.nullable));
10020 match &d.default {
10021 None => out.push(0),
10022 Some(s) => {
10023 out.push(1);
10024 write_str(&mut out, s);
10025 }
10026 }
10027 write_u16(
10028 &mut out,
10029 u16::try_from(d.checks.len()).expect("≤ 65k CHECKs / domain"),
10030 );
10031 for c in &d.checks {
10032 write_str(&mut out, &c.expr);
10033 // v7.39 (round 260) — the constraint name (FILE_VERSION 75+).
10034 write_str(&mut out, &c.name);
10035 }
10036 // v7.39 (round 259) — the parent domain (FILE_VERSION 74+).
10037 match &d.base_domain {
10038 None => out.push(0),
10039 Some(s) => {
10040 out.push(1);
10041 write_str(&mut out, s);
10042 }
10043 }
10044 }
10045 // v7.17.0 Phase 1.6 — user-schemas registry
10046 // (FILE_VERSION 31+). Built-ins are hardcoded in
10047 // `is_builtin_schema` and not persisted.
10048 write_u32(
10049 &mut out,
10050 u32::try_from(self.schemas.len()).expect("≤ 4G schemas"),
10051 );
10052 for name in &self.schemas {
10053 write_str(&mut out, name);
10054 }
10055 // v7.37.42-T2 ζ-B — COMPOSITE types catalog block
10056 // (FILE_VERSION 52+). Each entry: name, u16 field_count,
10057 // then field_count `[str field_name][data_type]` pairs.
10058 write_u32(
10059 &mut out,
10060 u32::try_from(self.composite_types.len()).expect("≤ 4G composite types"),
10061 );
10062 for c in self.composite_types.values() {
10063 write_str(&mut out, &c.name);
10064 write_u16(
10065 &mut out,
10066 u16::try_from(c.fields.len()).expect("≤ 65k fields / composite"),
10067 );
10068 for (i, (fname, fty)) in c.fields.iter().enumerate() {
10069 write_str(&mut out, fname);
10070 write_data_type(&mut out, *fty);
10071 // v7.39 (round 264) — the field's user type (v76+).
10072 match c.field_user_types.get(i).and_then(Option::as_ref) {
10073 None => out.push(0),
10074 Some(n) => {
10075 out.push(1);
10076 write_str(&mut out, n);
10077 }
10078 }
10079 }
10080 }
10081 // v7.39 (read01 round 50) — COMMENT store (FILE_VERSION 61+).
10082 // Catalog-wide, written last (before the CRC trailer) so every older
10083 // reader stops before it. Layout: [u32 count] then [str key][str text].
10084 write_u32(
10085 &mut out,
10086 u32::try_from(self.comments.len()).expect("≤ 4G comments"),
10087 );
10088 for (k, v) in &self.comments {
10089 write_str(&mut out, k);
10090 write_str_long(&mut out, v);
10091 }
10092 // v7.39 (read01 round 60) — non-table ACLs (FILE_VERSION 66+), catalog-
10093 // wide and written last so a v65 reader stops before them. The sequence
10094 // block itself sits mid-image and cannot grow without breaking older
10095 // readers, so a sequence's owner + ACL rides here, keyed by name.
10096 let acl_out = |out: &mut Vec<u8>, acl: &[AclItem]| {
10097 write_u16(out, u16::try_from(acl.len()).expect("≤ 65k aclitems"));
10098 for a in acl {
10099 write_str(out, &a.grantee);
10100 write_u16(out, a.privs);
10101 write_u16(out, a.grantable);
10102 write_str(out, &a.grantor);
10103 }
10104 };
10105 let owned: Vec<&SequenceDef> = self
10106 .sequences
10107 .values()
10108 .filter(|s| s.owner.is_some() || !s.acl.is_empty())
10109 .collect();
10110 write_u32(
10111 &mut out,
10112 u32::try_from(owned.len()).expect("≤ 4G sequences"),
10113 );
10114 for seq in owned {
10115 write_str(&mut out, &seq.name);
10116 match &seq.owner {
10117 Some(o) => {
10118 out.push(1);
10119 write_str(&mut out, o);
10120 }
10121 None => out.push(0),
10122 }
10123 acl_out(&mut out, &seq.acl);
10124 }
10125 acl_out(&mut out, &self.schema_acl);
10126 acl_out(&mut out, &self.database_acl);
10127 // v7.39 (read01 round 61) — FUNCTION owner + ACL (FILE_VERSION 67+).
10128 // The function block sits mid-image like the sequence one, so this
10129 // rides the catalog-wide tail too, keyed by name.
10130 let fns: Vec<&FunctionDef> = self
10131 .functions
10132 .values()
10133 .filter(|f| f.owner.is_some() || !f.acl.is_empty())
10134 .collect();
10135 write_u32(&mut out, u32::try_from(fns.len()).expect("≤ 4G functions"));
10136 for f in fns {
10137 // v7.39 (read01 round 62) — keyed by SIGNATURE now: two overloads
10138 // have two ACLs.
10139 write_str(&mut out, &function_signature_key(&f.name, &f.args_repr));
10140 match &f.owner {
10141 Some(o) => {
10142 out.push(1);
10143 write_str(&mut out, o);
10144 }
10145 None => out.push(0),
10146 }
10147 acl_out(&mut out, &f.acl);
10148 }
10149 // v7.39 (round 139) — RULE catalog block (FILE_VERSION 71+), catalog-
10150 // wide and written last (right before the CRC trailer) so every older
10151 // reader stops cleanly before it. Layout: [u32 count] then per rule
10152 // [str name][str table][str event][u8 instead][str when]
10153 // [u16 cmd_count]([str cmd] × cmd_count).
10154 write_u32(
10155 &mut out,
10156 u32::try_from(self.rules.len()).expect("≤ 4G rules"),
10157 );
10158 for r in &self.rules {
10159 write_str(&mut out, &r.name);
10160 write_str(&mut out, &r.table);
10161 write_str(&mut out, &r.event);
10162 out.push(u8::from(r.instead));
10163 write_str(&mut out, &r.when_condition);
10164 write_u16(
10165 &mut out,
10166 u16::try_from(r.commands.len()).expect("≤ 65k commands / rule"),
10167 );
10168 for c in &r.commands {
10169 write_str(&mut out, c);
10170 }
10171 }
10172 // v7.39 (round 280) — extended-statistics block (FILE_VERSION
10173 // 77+), appended after the RULE block for the same reason: an
10174 // older reader stops cleanly before it. Layout: [u32 count]
10175 // then per object [str name][str table][u16 n]([str kind] × n)
10176 // [u16 m]([str column] × m).
10177 write_u32(
10178 &mut out,
10179 u32::try_from(self.statistics_ext.len()).expect("≤ 4G statistics objects"),
10180 );
10181 for st in &self.statistics_ext {
10182 write_str(&mut out, &st.name);
10183 write_str(&mut out, &st.table);
10184 write_u16(
10185 &mut out,
10186 u16::try_from(st.kinds.len()).expect("≤ 65k kinds"),
10187 );
10188 for k in &st.kinds {
10189 write_str(&mut out, k);
10190 }
10191 write_u16(
10192 &mut out,
10193 u16::try_from(st.columns.len()).expect("≤ 65k columns"),
10194 );
10195 for c in &st.columns {
10196 write_str(&mut out, c);
10197 }
10198 }
10199 // v7.39 (round 287) — large-object block (FILE_VERSION 78+),
10200 // appended after the statistics block for the same reason: an
10201 // older reader stops cleanly before it. Layout: [u32 count]
10202 // then per object [u32 oid][u32 len][len bytes].
10203 write_u32(
10204 &mut out,
10205 u32::try_from(self.large_objects.len()).expect("≤ 4G large objects"),
10206 );
10207 for (oid, bytes) in &self.large_objects {
10208 write_u32(&mut out, *oid);
10209 write_u32(
10210 &mut out,
10211 u32::try_from(bytes.len()).expect("≤ 4G per object"),
10212 );
10213 out.extend_from_slice(bytes);
10214 }
10215 // v7.39 (round 322, V46) — function-attribute block (FILE_VERSION
10216 // 80+), appended last for the same reason as every block before
10217 // it: an older reader stops cleanly ahead of it and simply sees
10218 // functions with PG's default attributes. Only functions that
10219 // declared something non-default are written. Layout: [u32 count]
10220 // then per function [str signature_key][u8 volatility][u8 flags]
10221 // [u8 parallel][f64 cost or NaN][f64 rows or NaN], where flags bit
10222 // 0 = strict, 1 = security definer, 2 = leakproof.
10223 let attr_fns: Vec<(&String, &FunctionDef)> = self
10224 .functions
10225 .iter()
10226 .filter(|(_, f)| {
10227 f.volatility != FN_VOLATILE
10228 || f.strict
10229 || f.security_definer
10230 || f.leakproof
10231 || f.parallel != FN_PARALLEL_UNSAFE
10232 || f.cost.is_some()
10233 || f.rows.is_some()
10234 })
10235 .collect();
10236 write_u32(
10237 &mut out,
10238 u32::try_from(attr_fns.len()).expect("≤ 4G functions"),
10239 );
10240 for (key, f) in attr_fns {
10241 write_str(&mut out, key);
10242 out.push(f.volatility);
10243 let flags = u8::from(f.strict)
10244 | (u8::from(f.security_definer) << 1)
10245 | (u8::from(f.leakproof) << 2);
10246 out.push(flags);
10247 out.push(f.parallel);
10248 out.extend_from_slice(&f.cost.unwrap_or(f64::NAN).to_le_bytes());
10249 out.extend_from_slice(&f.rows.unwrap_or(f64::NAN).to_le_bytes());
10250 }
10251 // v7.38 (read01 P5.05) — CRC32C trailer over the whole image so a
10252 // corrupted snapshot is rejected on load. FILE_VERSION is >= the
10253 // trailer version, so this always runs for freshly-written images.
10254 // v7.39 (round 547) — pg_db_role_setting (FILE_VERSION 85+),
10255 // catalog-wide and written LAST so a v84 reader stops before it.
10256 // Layout: [u32 scopes] then [str database][str role][u32 params]
10257 // then [str name][str value] per param.
10258 write_u32(
10259 &mut out,
10260 u32::try_from(self.db_role_settings.len()).expect("≤ 4G scopes"),
10261 );
10262 for ((db, role), params) in &self.db_role_settings {
10263 write_str(&mut out, db);
10264 write_str(&mut out, role);
10265 write_u32(&mut out, u32::try_from(params.len()).expect("≤ 4G params"));
10266 for (name, value) in params {
10267 write_str(&mut out, name);
10268 write_str(&mut out, value);
10269 }
10270 }
10271 // v7.39 (round 550) — replication slots (FILE_VERSION 86+),
10272 // written LAST so a v85 reader stops before them.
10273 write_u32(
10274 &mut out,
10275 u32::try_from(self.replication_slots.len()).expect("≤ 4G slots"),
10276 );
10277 for (name, (plugin, slot_type)) in &self.replication_slots {
10278 write_str(&mut out, name);
10279 write_str(&mut out, plugin);
10280 write_str(&mut out, slot_type);
10281 }
10282 let crc = spg_crypto::crc32c::crc32c(&out);
10283 write_u32(&mut out, crc);
10284 out
10285 }
10286
10287 /// Deserialize a previously-serialized catalog. Rejects bad magic, version
10288 /// mismatch, unknown tags, truncation, and trailing bytes.
10289 pub fn deserialize(buf: &[u8]) -> Result<Self, StorageError> {
10290 let mut cur = Cursor::new(buf);
10291 let magic = cur.take(8)?;
10292 if magic != FILE_MAGIC {
10293 return Err(StorageError::Corrupt(format!(
10294 "bad magic: expected SPGDB001, got {magic:?}"
10295 )));
10296 }
10297 let version = cur.read_u8()?;
10298 if !(MIN_SUPPORTED_FILE_VERSION..=FILE_VERSION).contains(&version) {
10299 return Err(StorageError::Corrupt(format!(
10300 "unsupported file version: {version} (supported: {MIN_SUPPORTED_FILE_VERSION}..={FILE_VERSION})"
10301 )));
10302 }
10303 // v7.23/v7.27 — escape decoding is version-gated (see
10304 // STR_LEN_ESCAPE / Cursor::codec_version).
10305 cur.codec_version = version;
10306 let table_count = cur.read_u32()? as usize;
10307 let mut cat = Self::new();
10308 for _ in 0..table_count {
10309 deserialize_table(&mut cur, &mut cat, version)?;
10310 }
10311 // v7.37.15 (Phase C.1) — stamp dense stable RelIds on load.
10312 // Pre-V6 envelopes carry no ids; a dense 1..=N assignment is
10313 // sufficient while RelId is process-local bookkeeping (the V6
10314 // envelope, Phase C.6, will round-trip real ids). Sets the
10315 // allocator above the loaded ids so a post-load CREATE TABLE
10316 // never collides.
10317 for (i, t) in cat.tables.iter_mut().enumerate() {
10318 t.set_rel_id(row_header::RelId((i as u64) + 1));
10319 }
10320 cat.next_rel_id = cat.tables.len() as u64;
10321 // v7.12.4 — catalog-wide function + trigger appendix.
10322 // FILE_VERSION 22+ only; v21 and earlier catalogs stop
10323 // after the last table.
10324 if version >= 22 {
10325 let fn_count = cur.read_u32()? as usize;
10326 for _ in 0..fn_count {
10327 let name = cur.read_str()?;
10328 let args_repr = cur.read_str()?;
10329 let returns = cur.read_str()?;
10330 let language = cur.read_str()?;
10331 let body = cur.read_str_long()?;
10332 let key = function_signature_key(&name, &args_repr);
10333 cat.functions.insert(
10334 key,
10335 FunctionDef {
10336 name,
10337 args_repr,
10338 returns,
10339 language,
10340 body,
10341 owner: None,
10342 acl: Vec::new(),
10343 volatility: FN_VOLATILE,
10344 strict: false,
10345 security_definer: false,
10346 leakproof: false,
10347 parallel: FN_PARALLEL_UNSAFE,
10348 cost: None,
10349 rows: None,
10350 },
10351 );
10352 }
10353 let trg_count = cur.read_u32()? as usize;
10354 for _ in 0..trg_count {
10355 let name = cur.read_str()?;
10356 let table = cur.read_str()?;
10357 let timing = cur.read_str()?;
10358 let ev_count = cur.read_u16()? as usize;
10359 let mut events = Vec::with_capacity(ev_count);
10360 for _ in 0..ev_count {
10361 events.push(cur.read_str()?);
10362 }
10363 let for_each = cur.read_str()?;
10364 let function = cur.read_str()?;
10365 // v7.13.0 — trailing `UPDATE OF cols` filter
10366 // (FILE_VERSION 23+ only; v22 catalogs omit and
10367 // deserialise with an empty vec).
10368 let update_columns = if version >= 23 {
10369 let n = cur.read_u16()? as usize;
10370 let mut cols = Vec::with_capacity(n);
10371 for _ in 0..n {
10372 cols.push(cur.read_str()?);
10373 }
10374 cols
10375 } else {
10376 Vec::new()
10377 };
10378 // v7.16.1 — TriggerDef.enabled (FILE_VERSION 25+).
10379 // v24-and-below catalogs deserialise with `true`
10380 // — pre-v7.16.1 every trigger always fired.
10381 let enabled = if version >= 25 {
10382 cur.read_u8()? != 0
10383 } else {
10384 true
10385 };
10386 // v7.39 (round 138) — WHEN condition text added at FILE_VERSION
10387 // 70; older catalogs read back empty (no WHEN filter).
10388 let when_condition = if version >= 70 {
10389 cur.read_str()?
10390 } else {
10391 String::new()
10392 };
10393 cat.triggers.push(TriggerDef {
10394 name,
10395 table,
10396 timing,
10397 events,
10398 for_each,
10399 function,
10400 update_columns,
10401 enabled,
10402 when_condition,
10403 });
10404 }
10405 }
10406 // v7.17.0 Phase 1.1 — SEQUENCE block (FILE_VERSION 26+).
10407 // v25-and-below catalogs omit; we leave the map empty.
10408 if version >= 26 {
10409 let seq_count = cur.read_u32()? as usize;
10410 for _ in 0..seq_count {
10411 let name = cur.read_str()?;
10412 let data_type = match cur.read_u8()? {
10413 0 => SequenceDataType::SmallInt,
10414 1 => SequenceDataType::Int,
10415 2 => SequenceDataType::BigInt,
10416 other => {
10417 return Err(StorageError::Corrupt(format!(
10418 "unknown SEQUENCE data-type tag {other}"
10419 )));
10420 }
10421 };
10422 let start = cur.read_i64()?;
10423 let increment = cur.read_i64()?;
10424 let min_value = cur.read_i64()?;
10425 let max_value = cur.read_i64()?;
10426 let cache = cur.read_i64()?;
10427 let cycle = cur.read_u8()? != 0;
10428 let owned_by = match cur.read_u8()? {
10429 0 => None,
10430 1 => {
10431 let t = cur.read_str()?;
10432 let c = cur.read_str()?;
10433 Some((t, c))
10434 }
10435 other => {
10436 return Err(StorageError::Corrupt(format!(
10437 "unknown SEQUENCE owned-by tag {other}"
10438 )));
10439 }
10440 };
10441 let last_value = cur.read_i64()?;
10442 let is_called = cur.read_u8()? != 0;
10443 cat.sequences.insert(
10444 name.clone(),
10445 SequenceDef {
10446 name,
10447 data_type,
10448 start,
10449 increment,
10450 min_value,
10451 max_value,
10452 cache,
10453 cycle,
10454 owned_by,
10455 last_value,
10456 is_called,
10457 owner: None,
10458 acl: Vec::new(),
10459 },
10460 );
10461 }
10462 }
10463 // v7.17.0 Phase 1.2 — VIEW block (FILE_VERSION 27+).
10464 // v26-and-below catalogs omit; we leave the map empty.
10465 if version >= 27 {
10466 let view_count = cur.read_u32()? as usize;
10467 for _ in 0..view_count {
10468 let name = cur.read_str()?;
10469 let col_count = cur.read_u16()? as usize;
10470 let mut columns = Vec::with_capacity(col_count);
10471 for _ in 0..col_count {
10472 columns.push(cur.read_str()?);
10473 }
10474 let body = cur.read_str_long()?;
10475 // v7.39 (round 132) — check-option marker added at FILE_VERSION
10476 // 69; older catalogs default to 0 (no check option).
10477 let check_option = if version >= 69 { cur.read_u8()? } else { 0 };
10478 cat.views.insert(
10479 name.clone(),
10480 ViewDef {
10481 name,
10482 columns,
10483 body,
10484 check_option,
10485 },
10486 );
10487 }
10488 }
10489 // v7.17.0 Phase 1.3 — MATERIALIZED VIEW source registry
10490 // (FILE_VERSION 28+). v27-and-below catalogs omit.
10491 if version >= 28 {
10492 let mv_count = cur.read_u32()? as usize;
10493 for _ in 0..mv_count {
10494 let name = cur.read_str()?;
10495 let body = cur.read_str_long()?;
10496 cat.materialized_views.insert(name, body);
10497 }
10498 }
10499 // v7.17.0 Phase 1.4 — ENUM types catalog block
10500 // (FILE_VERSION 29+).
10501 if version >= 29 {
10502 let etype_count = cur.read_u32()? as usize;
10503 for _ in 0..etype_count {
10504 let name = cur.read_str()?;
10505 let label_count = cur.read_u16()? as usize;
10506 let mut labels = Vec::with_capacity(label_count);
10507 for _ in 0..label_count {
10508 labels.push(cur.read_str()?);
10509 }
10510 cat.enum_types
10511 .insert(name.clone(), EnumDef { name, labels });
10512 }
10513 }
10514 // v7.17.0 Phase 1.5 — DOMAIN types catalog block
10515 // (FILE_VERSION 30+).
10516 if version >= 30 {
10517 let dtype_count = cur.read_u32()? as usize;
10518 for _ in 0..dtype_count {
10519 let name = cur.read_str()?;
10520 let base_type = cur.read_data_type()?;
10521 let nullable = cur.read_u8()? != 0;
10522 let default = match cur.read_u8()? {
10523 0 => None,
10524 1 => Some(cur.read_str()?),
10525 other => {
10526 return Err(StorageError::Corrupt(format!(
10527 "unknown DOMAIN default tag {other}"
10528 )));
10529 }
10530 };
10531 let check_count = cur.read_u16()? as usize;
10532 let mut checks: Vec<DomainCheck> = Vec::with_capacity(check_count);
10533 for i in 0..check_count {
10534 let expr = cur.read_str()?;
10535 // v7.39 (round 260) — names arrived in FILE_VERSION 75.
10536 // An older catalog gets PG's auto-naming applied to the
10537 // checks it stored, which is what they would have been.
10538 let cname = if version >= 75 {
10539 cur.read_str()?
10540 } else if i == 0 {
10541 alloc::format!("{name}_check")
10542 } else {
10543 alloc::format!("{name}_check{i}")
10544 };
10545 checks.push(DomainCheck { name: cname, expr });
10546 }
10547 // v7.39 (round 259) — the parent domain. Absent before
10548 // FILE_VERSION 74; an older catalog reads as a domain over
10549 // a scalar, which is what it was.
10550 let base_domain = if version >= 74 {
10551 match cur.read_u8()? {
10552 0 => None,
10553 1 => Some(cur.read_str()?),
10554 other => {
10555 return Err(StorageError::Corrupt(alloc::format!(
10556 "domain base_domain tag {other}"
10557 )));
10558 }
10559 }
10560 } else {
10561 None
10562 };
10563 cat.domain_types.insert(
10564 name.clone(),
10565 DomainDef {
10566 name,
10567 base_type,
10568 nullable,
10569 default,
10570 checks,
10571 base_domain,
10572 },
10573 );
10574 }
10575 }
10576 // v7.17.0 Phase 1.6 — user-schemas registry
10577 // (FILE_VERSION 31+).
10578 if version >= 31 {
10579 let sch_count = cur.read_u32()? as usize;
10580 for _ in 0..sch_count {
10581 let name = cur.read_str()?;
10582 cat.schemas.insert(name);
10583 }
10584 }
10585 // v7.37.42-T2 ζ-B — COMPOSITE types catalog block
10586 // (FILE_VERSION 52+). v51-and-below readers stop at the
10587 // user-schemas block; v52 readers fed a v51 catalog see no
10588 // composite block and default to an empty map.
10589 if version >= 52 {
10590 let ctype_count = cur.read_u32()? as usize;
10591 for _ in 0..ctype_count {
10592 let name = cur.read_str()?;
10593 let field_count = cur.read_u16()? as usize;
10594 let mut fields = Vec::with_capacity(field_count);
10595 let mut field_user_types: Vec<Option<String>> = Vec::with_capacity(field_count);
10596 for _ in 0..field_count {
10597 let fname = cur.read_str()?;
10598 let fty = cur.read_data_type()?;
10599 // v7.39 (round 264) — present from FILE_VERSION 76.
10600 let ut = if version >= 76 {
10601 match cur.read_u8()? {
10602 0 => None,
10603 1 => Some(cur.read_str()?),
10604 other => {
10605 return Err(StorageError::Corrupt(alloc::format!(
10606 "composite field user-type tag {other}"
10607 )));
10608 }
10609 }
10610 } else {
10611 None
10612 };
10613 fields.push((fname, fty));
10614 field_user_types.push(ut);
10615 }
10616 cat.composite_types.insert(
10617 name.clone(),
10618 CompositeDef {
10619 name,
10620 fields,
10621 field_user_types,
10622 },
10623 );
10624 }
10625 }
10626 // v7.39 (read01 round 50) — COMMENT store (FILE_VERSION 61+).
10627 if version >= 61 {
10628 let comment_count = cur.read_u32()? as usize;
10629 for _ in 0..comment_count {
10630 let key = cur.read_str()?;
10631 let text = cur.read_str_long()?;
10632 cat.comments.insert(key, text);
10633 }
10634 }
10635 // v7.39 (read01 round 60) — non-table ACLs (FILE_VERSION 66+).
10636 if version >= 66 {
10637 let read_acl = |cur: &mut Cursor| -> Result<Vec<AclItem>, StorageError> {
10638 let n = cur.read_u16()? as usize;
10639 let mut acl = Vec::with_capacity(n);
10640 for _ in 0..n {
10641 let grantee = cur.read_str()?;
10642 let privs = cur.read_u16()?;
10643 let grantable = cur.read_u16()?;
10644 let grantor = cur.read_str()?;
10645 acl.push(AclItem {
10646 grantee,
10647 privs,
10648 grantable,
10649 grantor,
10650 });
10651 }
10652 Ok(acl)
10653 };
10654 let seq_count = cur.read_u32()? as usize;
10655 for _ in 0..seq_count {
10656 let name = cur.read_str()?;
10657 let owner = if cur.read_u8()? == 1 {
10658 Some(cur.read_str()?)
10659 } else {
10660 None
10661 };
10662 let acl = read_acl(&mut cur)?;
10663 if let Some(seq) = cat.sequences.get_mut(&name) {
10664 seq.owner = owner;
10665 seq.acl = acl;
10666 }
10667 }
10668 cat.schema_acl = read_acl(&mut cur)?;
10669 cat.database_acl = read_acl(&mut cur)?;
10670 // v7.39 (read01 round 61) — FUNCTION owner + ACL (v67+; keyed by
10671 // signature from v68, when overloads became possible).
10672 if version >= 67 {
10673 let fn_count = cur.read_u32()? as usize;
10674 for _ in 0..fn_count {
10675 let name = cur.read_str()?;
10676 let owner = if cur.read_u8()? == 1 {
10677 Some(cur.read_str()?)
10678 } else {
10679 None
10680 };
10681 let acl = read_acl(&mut cur)?;
10682 // v7.39 (round 315, V19) — the stored key was computed
10683 // by whichever formula was current when the image was
10684 // written. A miss is not "no such function": before the
10685 // multi-word fix, `f(double precision)` keyed as
10686 // `f(precision)`, so an older image's grants would land
10687 // nowhere and vanish silently. Fall back to matching by
10688 // the old formula, which re-attaches them.
10689 let target = resolve_stored_function_key(&cat.functions, &name);
10690 if let Some(k) = target
10691 && let Some(f) = cat.functions.get_mut(&k)
10692 {
10693 f.owner = owner;
10694 f.acl = acl;
10695 }
10696 }
10697 }
10698 }
10699 // v7.39 (round 139) — RULE catalog block (FILE_VERSION 71+), read from
10700 // the tail right before the CRC trailer. Pre-71 images stop before it.
10701 if version >= 71 {
10702 let rule_count = cur.read_u32()? as usize;
10703 for _ in 0..rule_count {
10704 let name = cur.read_str()?;
10705 let table = cur.read_str()?;
10706 let event = cur.read_str()?;
10707 let instead = cur.read_u8()? != 0;
10708 let when_condition = cur.read_str()?;
10709 let cmd_count = cur.read_u16()? as usize;
10710 let mut commands = Vec::with_capacity(cmd_count);
10711 for _ in 0..cmd_count {
10712 commands.push(cur.read_str()?);
10713 }
10714 cat.rules.push(RuleDef {
10715 name,
10716 table,
10717 event,
10718 instead,
10719 when_condition,
10720 commands,
10721 });
10722 }
10723 }
10724 // v7.39 (round 280) — extended-statistics block (FILE_VERSION
10725 // 77+). Pre-77 images stop before it.
10726 if version >= 77 {
10727 let count = cur.read_u32()? as usize;
10728 for _ in 0..count {
10729 let name = cur.read_str()?;
10730 let table = cur.read_str()?;
10731 let nk = cur.read_u16()? as usize;
10732 let mut kinds = Vec::with_capacity(nk);
10733 for _ in 0..nk {
10734 kinds.push(cur.read_str()?);
10735 }
10736 let nc = cur.read_u16()? as usize;
10737 let mut columns = Vec::with_capacity(nc);
10738 for _ in 0..nc {
10739 columns.push(cur.read_str()?);
10740 }
10741 cat.statistics_ext.push(StatisticsExtDef {
10742 name,
10743 table,
10744 kinds,
10745 columns,
10746 });
10747 }
10748 }
10749 // v7.39 (round 287) — large-object block (FILE_VERSION 78+).
10750 // Pre-78 images stop before it.
10751 if version >= 78 {
10752 let count = cur.read_u32()? as usize;
10753 for _ in 0..count {
10754 let oid = cur.read_u32()?;
10755 let len = cur.read_u32()? as usize;
10756 let bytes = cur.read_bytes(len)?;
10757 cat.large_objects.insert(oid, bytes);
10758 }
10759 }
10760 // v7.39 (round 322, V46) — function-attribute block (FILE_VERSION
10761 // 80+). Pre-80 images stop before it and keep PG's defaults.
10762 if version >= 80 {
10763 let count = cur.read_u32()? as usize;
10764 for _ in 0..count {
10765 let key = cur.read_str()?;
10766 let volatility = cur.read_u8()?;
10767 let flags = cur.read_u8()?;
10768 let parallel = cur.read_u8()?;
10769 let cost = f64::from_le_bytes(cur.read_bytes(8)?.try_into().unwrap_or([0; 8]));
10770 let rows = f64::from_le_bytes(cur.read_bytes(8)?.try_into().unwrap_or([0; 8]));
10771 if let Some(f) = cat.functions.get_mut(&key) {
10772 f.volatility = volatility;
10773 f.strict = flags & 1 != 0;
10774 f.security_definer = flags & 2 != 0;
10775 f.leakproof = flags & 4 != 0;
10776 f.parallel = parallel;
10777 f.cost = (!cost.is_nan()).then_some(cost);
10778 f.rows = (!rows.is_nan()).then_some(rows);
10779 }
10780 }
10781 }
10782 // v7.39 (round 547) — pg_db_role_setting (FILE_VERSION 85+).
10783 // Pre-85 images stop before it and carry no GUC defaults.
10784 if version >= 85 {
10785 let scopes = cur.read_u32()? as usize;
10786 for _ in 0..scopes {
10787 let db = cur.read_str()?;
10788 let role = cur.read_str()?;
10789 let params = cur.read_u32()? as usize;
10790 let mut m: BTreeMap<String, String> = BTreeMap::new();
10791 for _ in 0..params {
10792 let name = cur.read_str()?;
10793 let value = cur.read_str()?;
10794 m.insert(name, value);
10795 }
10796 if !m.is_empty() {
10797 cat.db_role_settings.insert((db, role), m);
10798 }
10799 }
10800 }
10801 // v7.39 (round 550) — replication slots (FILE_VERSION 86+).
10802 if version >= 86 {
10803 let count = cur.read_u32()? as usize;
10804 for _ in 0..count {
10805 let name = cur.read_str()?;
10806 let plugin = cur.read_str()?;
10807 let slot_type = cur.read_str()?;
10808 cat.replication_slots.insert(name, (plugin, slot_type));
10809 }
10810 }
10811 // v7.38 (read01 P5.05) — v54+ images end with a CRC32C over every
10812 // preceding byte; verify it before accepting the snapshot. Older
10813 // images have no trailer and fall through to the trailing-byte check.
10814 if version >= FILE_VERSION_CRC_TRAILER {
10815 let crc_start = cur.pos;
10816 let stored = cur.read_u32()?;
10817 let computed = spg_crypto::crc32c::crc32c(&buf[..crc_start]);
10818 if computed != stored {
10819 return Err(StorageError::Corrupt(format!(
10820 "base snapshot CRC mismatch: computed {computed:#010x}, stored {stored:#010x}"
10821 )));
10822 }
10823 }
10824 if cur.pos < buf.len() {
10825 return Err(StorageError::Corrupt(format!(
10826 "trailing bytes: {} unread",
10827 buf.len() - cur.pos
10828 )));
10829 }
10830 Ok(cat)
10831 }
10832}
10833
10834#[cfg(test)]
10835mod tests;