umbral_core/orm/model.rs
1//! The `Model` trait: the abstraction every umbral model implements.
2//!
3//! At M2 the trait is implemented by hand (`impl Model for Post` lives
4//! in `post.rs`). At M3 the same impl is generated by a
5//! `#[derive(Model)]` proc macro. M4 hooks into `FIELDS` for the
6//! field/backend compatibility system check. M5 hooks into `FIELDS` for
7//! the migration engine's snapshot diff. The trait is intentionally
8//! narrow at M2 — primary-key type, table name, field metadata, and
9//! that's it.
10//!
11//! Through Phase 2 of the Postgres rollout `Model` carried
12//! `for<'r> sqlx::FromRow<'r, SqliteRow>` as a supertrait so the
13//! QuerySet terminals could blanket on `T: Model`. Phase 2.5 drops
14//! that supertrait: the user struct still uses `#[derive(sqlx::FromRow)]`
15//! (which emits a generic `impl<'r, R: Row> FromRow<'r, R>` covering
16//! both SQLite and Postgres rows), and the QuerySet terminals carry
17//! the FromRow bound on the method, not the trait — so the same
18//! `Manager<T>` works on either backend.
19//!
20//! See `docs/specs/04-orm-model-and-fields.md` for the target shape and
21//! the M2→M3→M4→M5 progression.
22
23/// Trait for eagerly hydrating `ForeignKey<U>.resolved` fields by name.
24///
25/// `#[derive(Model)]` emits this impl for every model. Models with no FK
26/// fields get a no-op impl; models with FK fields get a `hydrate_fk` body
27/// that matches on `field_name` and a `fk_id_for` body that returns the raw
28/// FK integer for a named field.
29///
30/// The `select_related` machinery in `QuerySet` calls these two methods in
31/// sequence: first `fk_id_for` to collect the IDs to batch-fetch, then
32/// `hydrate_fk` with the fetched JSON to populate `ForeignKey<U>.resolved`.
33///
34/// `U` must implement `serde::Deserialize` for `hydrate_fk` to succeed.
35/// All umbral models already derive `Deserialize`, so this bound is always
36/// satisfied in practice.
37pub trait HydrateRelated {
38 /// Return the raw FK value stored in the field named `field_name`,
39 /// or `None` if the field doesn't exist on this model or is not a FK.
40 ///
41 /// Used by `select_related` to collect all FK ids from the result
42 /// set before running the batch `IN (...)` lookup.
43 ///
44 /// PK lift Pass D: returns `Option<serde_json::Value>` (was
45 /// `Option<i64>`) so FK targets keyed by `String` / `Uuid` /
46 /// composite codename flow through the typed select_related
47 /// path. The macro emits `serde_json::to_value(self.<field>.id())`
48 /// — works for any `Serialize` PK type without per-target
49 /// specialization. Integer-PK targets carry through as
50 /// `Value::Number`; the existing i64 hot path is unchanged at
51 /// the JSON layer.
52 fn fk_id_for(&self, field_name: &str) -> Option<serde_json::Value>;
53
54 /// Set `ForeignKey<U>.resolved` for the field named `field_name` by
55 /// deserialising `row` as the target model type.
56 ///
57 /// A field name that doesn't match any FK on this model is silently
58 /// ignored (a noop). Deserialisation errors are also silently swallowed —
59 /// the FK keeps its raw-integer form without a resolved object. This
60 /// is intentional: a bad `select_related` name is a
61 /// programming error caught in tests, not a runtime panic.
62 fn hydrate_fk(&mut self, field_name: &str, row: &serde_json::Value);
63
64 /// Set the `parent_id` cache on every `M2M<U>` field this model
65 /// owns. Closes the second BUG-16 gap: without this, `m2m.add(&t)`
66 /// silently writes a junction row with `parent_id = 0` because the
67 /// macro skips M2M fields in the `FromRow` decode path.
68 ///
69 /// Called by QuerySet terminals after each row is decoded. The
70 /// macro emits a body that walks the model's M2M fields and calls
71 /// `set_parent_id(self.<pk>)` on each — so loading a `Group`
72 /// gives every `M2M<U>` slot on it the right `parent_id` to write
73 /// against.
74 ///
75 /// Default: no-op. The macro-emitted body shadows this for any
76 /// model that declares an M2M field. A model with no M2M fields
77 /// inherits the default and pays nothing.
78 ///
79 /// PK-agnostic: the macro sets each `M2M<Child, P>` field's parent id
80 /// from `self.<pk>` via the typed [`crate::orm::M2M::set_parent_id`],
81 /// so it works for **any** parent PK type — `i64`, `String`,
82 /// `uuid::Uuid`. A non-i64-PK parent declares the field with the
83 /// matching `P` (e.g. `M2M<Student, String>`); `P` defaults to `i64`.
84 fn set_m2m_parent_ids(&mut self) {}
85
86 /// Return this row's primary key as a `serde_json::Value`, whatever
87 /// the PK type — `i64`, `String`, `uuid::Uuid`, a custom newtype.
88 /// The relation-hydration paths (`prefetch_related`, reverse-FK and
89 /// reverse-OneToOne collection) bucket children by the parent's PK,
90 /// and keying those buckets on a `Value` (canonicalised via
91 /// [`crate::orm::pk_key`]) lets UUID- and slug-PK models flow through
92 /// too, not just i64.
93 ///
94 /// Default: `None`. The `#[derive(Model)]` macro emits an override for
95 /// every model that returns `to_value(&self.<pk>)` — so a hand-written
96 /// `Model` impl that doesn't override it simply opts out of the
97 /// Value-keyed hydration (a forgive-and-skip posture).
98 fn pk_as_json(&self) -> Option<serde_json::Value> {
99 None
100 }
101
102 /// Attach a list of pre-fetched child rows to the named `M2M<U>`
103 /// field's `resolved` slot. Called by `QuerySet::prefetch_related`
104 /// (gap #19) after a batched JOIN through the junction table
105 /// returns one Vec<U> per parent.
106 ///
107 /// `rows` carries the child rows as JSON objects ready for
108 /// `serde_json::from_value::<U>(...)`. Decoding failures (e.g. a
109 /// row that doesn't match the target struct shape) silently drop
110 /// that one row from the resolved set — same forgive-and-continue
111 /// posture as `hydrate_fk` for `select_related`.
112 ///
113 /// A field name that doesn't match any M2M field on this model is
114 /// a no-op. The macro-emitted body pattern-matches the M2M fields
115 /// declared on this struct; the default below is empty so models
116 /// without M2M fields pay nothing.
117 fn set_m2m_resolved_json(&mut self, _field_name: &str, _rows: Vec<serde_json::Value>) {}
118
119 /// Gap #44 — attach a list of pre-fetched child rows to the
120 /// named `ReverseSet<C>` field's `resolved` slot. Counterpart
121 /// to `set_m2m_resolved_json` but for reverse-FK collections
122 /// (one parent, many children pointing at it via a FK column).
123 ///
124 /// Called by `QuerySet::prefetch_related` after the batched
125 /// `SELECT * FROM <child> WHERE <fk_col> IN (parent_pks)` query
126 /// returns child rows grouped by `<fk_col>` value.
127 ///
128 /// `rows` carries the child rows as JSON objects ready for
129 /// `serde_json::from_value::<C>(...)`. Decoding failures
130 /// silently drop that one row — same forgive-and-continue
131 /// posture as the M2M variant.
132 ///
133 /// A field name that doesn't match any `ReverseSet` field on
134 /// this model is a no-op. The macro-emitted body pattern-
135 /// matches the ReverseSet fields declared on this struct; the
136 /// default below is empty so models without reverse-FK fields
137 /// pay nothing.
138 fn set_reverse_fk_resolved_json(&mut self, _field_name: &str, _rows: Vec<serde_json::Value>) {}
139
140 /// Reverse-OneToOne counterpart to
141 /// `set_reverse_fk_resolved_json`. Called by `prefetch_related`
142 /// with `Some(child_json)` when the runtime FK lookup found
143 /// exactly one matching child, or `None` when no child matched
144 /// (the slot still flips `is_loaded()` to `true`).
145 ///
146 /// Default: no-op. The macro emits per-field arms for any model
147 /// declaring `pub <name>: OneToOne<C>` fields.
148 fn set_one_to_one_resolved_json(&mut self, _field_name: &str, _row: Option<serde_json::Value>) {
149 }
150
151 /// Move form-staged M2M pending ids from `self` into `dest`,
152 /// field by field. The typed `create()` builds its INSERT from the
153 /// caller's instance, then reads a *fresh* row back from the DB
154 /// (carrying the autoincremented PK) — the pending ids staged by the
155 /// Form derive live on the caller's instance, not the readback row.
156 /// This hook transfers them across so `write_pending_m2m` on the
157 /// readback row (which has the real parent_id seeded) finds them.
158 /// Default: no-op for models with no M2M fields.
159 fn take_pending_m2m_into(&mut self, _dest: &mut Self) {}
160
161 /// Flush form-staged M2M selections to their junction tables after
162 /// the parent row was inserted. The macro emits a body that walks
163 /// this model's M2M fields, reads `parent_id` + `junction_table`
164 /// (seeded by `set_m2m_parent_ids`) and the pending child ids, and
165 /// calls `set_junction_dynamic`. Default: no-op for models with no
166 /// M2M fields.
167 ///
168 /// Async + boxed (rather than `#[async_trait]` on the whole trait)
169 /// so `HydrateRelated`'s existing non-async methods stay as they
170 /// are. Junction writes hit the DB, so this is kept off the hot
171 /// decode path — only the typed `create()` calls it.
172 fn write_pending_m2m<'a>(
173 &'a mut self,
174 ) -> std::pin::Pin<
175 Box<
176 dyn std::future::Future<Output = Result<(), crate::orm::write::WriteError>> + Send + 'a,
177 >,
178 > {
179 Box::pin(async { Ok(()) })
180 }
181}
182
183/// The trait every model implements.
184///
185/// Read at runtime to build queries (`T::TABLE`, `T::FIELDS`), at boot
186/// to validate field/backend compatibility (M4), and at migration time
187/// to diff against the last snapshot (M5).
188///
189/// `Model` is metadata-only — it carries no row-materialization bound.
190/// QuerySet terminals add `for<'r> FromRow<'r, R>` for the row type
191/// they need at the call site (sqlite or postgres). User structs pick
192/// up both impls via a single `#[derive(sqlx::FromRow)]` because
193/// sqlx's derive emits a generic-over-`R` impl.
194pub trait Model: Sized + Send + Sync + Unpin + 'static {
195 /// The primary-key type. M2 supports `i64` only; UUID lands later.
196 type PrimaryKey: PrimaryKey;
197
198 /// The struct name, used by the migration engine (M5) to label
199 /// snapshot entries and to map autodetected operations back to
200 /// the model that produced them. The M3 derive emits the struct
201 /// ident verbatim ("Post", "Comment", etc.).
202 const NAME: &'static str;
203
204 /// The SQL table name. M3's derive defaults this to the
205 /// `snake_case` of the struct name unless `#[umbral(table = "...")]`
206 /// overrides it.
207 const TABLE: &'static str;
208
209 /// The app label (the owning plugin's name) this model belongs to.
210 ///
211 /// Sourced from `#[umbral(plugin = "...")]`; defaults to `"app"` (the
212 /// registry's default key) when the attribute is absent. Authoritative
213 /// for permission codenames (gaps2 #80g): `umbral-permissions` reads this
214 /// to build `<app_label>.<verb>_<model>` codenames, instead of splitting
215 /// the table name at the first `_` (which collided distinct models).
216 const APP_LABEL: &'static str = "app";
217
218 /// Static metadata for every field on the model.
219 ///
220 /// One [`FieldSpec`] per field, in declaration order. Read by the
221 /// QuerySet (to build the SELECT column list), by the system check
222 /// (M4) for field/backend compatibility, and by the migration
223 /// engine (M5) for snapshot diffing.
224 const FIELDS: &'static [FieldSpec];
225
226 /// Human-readable display name for this model, used by the admin
227 /// sidebar as the default label. Defaults to `Self::NAME`.
228 ///
229 /// Override via `#[umbral(display = "Users")]` on the struct.
230 const DISPLAY: &'static str = Self::NAME;
231
232 /// Lucide icon slug shown next to this model in the admin sidebar.
233 /// Defaults to `"database"`. Any valid Lucide icon name works; unknown
234 /// names are silently ignored by Lucide at render time.
235 ///
236 /// Override via `#[umbral(icon = "users")]` on the struct.
237 const ICON: &'static str = "database";
238
239 /// Database alias this model lives on, when the app registers more
240 /// than one pool via `AppBuilder::database(...)`. `None` (the
241 /// default) means "use whatever the owning plugin chose via
242 /// `Plugin::database()`, or `\"default\"` if neither side
243 /// overrode."
244 ///
245 /// Override via `#[umbral(database = "analytics")]` on the struct.
246 /// Per-model wins over per-plugin — useful for a single plugin
247 /// that owns one model on the primary DB and another on an
248 /// archive/analytics DB.
249 const DATABASE: Option<&'static str> = None;
250
251 /// Single-row-marker. When `true`, the admin auto-redirects the
252 /// list view to the (sole) row's edit form, hides the "+ New"
253 /// button, and surfaces the model as a settings-style screen.
254 /// The single-row settings model pattern. Set via
255 /// `#[umbral(singleton)]` on the struct. Closes BUG-9 in
256 /// `bugs/tests/testBugs.md`.
257 ///
258 /// Default `false`. Default-row seeding (so the first admin
259 /// visit doesn't 404) is the user's responsibility — typically
260 /// a one-liner in `Plugin::on_ready` that calls
261 /// `T::objects().create(T::default()).await` if the count is
262 /// zero. A future framework helper could automate that; for v1
263 /// the trait const is enough to let admin and any third-party
264 /// tool know the model is singleton-shaped.
265 const SINGLETON: bool = false;
266
267 /// Feature #72 — soft-delete marker. Set via
268 /// `#[umbral(soft_delete)]` on the struct. When true, the
269 /// framework treats this model as having a `deleted_at:
270 /// Option<DateTime<Utc>>` column (which the user MUST declare
271 /// — derive macros can't add fields to the input struct), and:
272 ///
273 /// - Every `QuerySet<T>` terminal auto-injects
274 /// `WHERE deleted_at IS NULL` so soft-deleted rows are
275 /// invisible by default.
276 /// - `Manager::delete_instance(&row)` and `QuerySet::delete()`
277 /// issue `UPDATE table SET deleted_at = NOW() WHERE ...`
278 /// instead of a hard `DELETE FROM table WHERE ...`.
279 /// - Callers who actually want the soft-deleted rows (admin
280 /// trash views, audit dumps, undelete flows) opt back in
281 /// per-query via `.with_deleted()` or `.only_deleted()`.
282 /// - Callers who need a hard DELETE (GDPR purge, etc.) use
283 /// `.hard_delete()` to bypass the soft path on a per-call
284 /// basis.
285 ///
286 /// Default false so existing models compile unchanged.
287 const SOFT_DELETE: bool = false;
288
289 /// Composite-UNIQUE constraints. Each inner slice names a
290 /// constraint over the listed column names. Set via
291 /// `#[umbral(unique_together = [["a", "b"]])]`. Closes BUG-6 in
292 /// `bugs/tests/testBugs.md`. Default empty; the migration engine
293 /// emits one `UNIQUE (col1, col2)` clause per inner group on
294 /// `CREATE TABLE`.
295 const UNIQUE_TOGETHER: &'static [&'static [&'static str]] = &[];
296
297 /// Multi-column indexes. Each inner slice names an index over
298 /// the listed columns. Set via
299 /// `#[umbral(indexes = [["tenant_id", "created_at"]])]`. Closes
300 /// BUG-7. Default empty; the migration engine emits
301 /// `CREATE INDEX IF NOT EXISTS idx_<table>_<col1>_<col2>` after
302 /// the `CREATE TABLE`. Single-column indexes stay on the field
303 /// attribute (`#[umbral(index)]`).
304 const INDEXES: &'static [&'static [&'static str]] = &[];
305
306 /// Default `ORDER BY` clause, applied when a QuerySet terminates
307 /// without an explicit `order_by`. Each tuple is `(column_name,
308 /// is_descending)`. Set via
309 /// `#[umbral(ordering = ["-published_at", "id"])]` (leading `-`
310 /// flips to DESC). Closes BUG-8. Default empty.
311 const ORDERING: &'static [(&'static str, bool)] = &[];
312
313 /// Many-to-many relations declared on this model. Each entry names
314 /// a field and its target model. The migration engine uses this to
315 /// auto-generate junction tables; the admin uses it to render M2M
316 /// pickers. Default empty.
317 const M2M_RELATIONS: &'static [M2MRelationSpec] = &[];
318
319 /// Gap #44 — reverse-FK collections declared on this model via
320 /// `#[umbral(reverse_fk = "<fk_col>")] pub <name>: ReverseSet<C>`.
321 /// Each entry tells `prefetch_related` how to fetch the children:
322 /// `SELECT * FROM <target_table> WHERE <fk_column> IN (parent_pks)`
323 /// then group by `<fk_column>` value, populate each parent's
324 /// `ReverseSet.resolved`. Default empty; the macro emits one
325 /// entry per declared `ReverseSet<C>` field.
326 const REVERSE_FK_RELATIONS: &'static [ReverseFkRelationSpec] = &[];
327
328 /// Reverse OneToOne accessors declared on this model via
329 /// `pub <name>: OneToOne<C>` (no umbral attribute required).
330 /// Unlike `REVERSE_FK_RELATIONS`, the FK column on the child is
331 /// not named at macro time — `prefetch_related` looks it up at
332 /// runtime by scanning the child's `FIELDS` for the UNIQUE FK
333 /// pointing back at this model's table. Exactly one match
334 /// required; 0 or 2+ matches surface a loud error naming the
335 /// ambiguity.
336 const ONE_TO_ONE_RELATIONS: &'static [OneToOneRelationSpec] = &[];
337
338 /// Return the primary key of this instance.
339 fn primary_key(&self) -> Self::PrimaryKey;
340}
341
342/// Static metadata for one many-to-many relation declared on a model.
343///
344/// Carried by `Model::M2M_RELATIONS`. The migration engine uses this
345/// to emit `CREATE TABLE` for the junction table; the admin uses it
346/// to know which fields render as multi-select pickers.
347#[derive(Debug, Clone, PartialEq, Eq)]
348pub struct M2MRelationSpec {
349 /// The Rust field name (e.g. `"tags"`).
350 pub field_name: &'static str,
351 /// The target model's table name (e.g. `"tag"`).
352 pub target_table: &'static str,
353 /// The target model's struct name (e.g. `"Tag"`). Used for reverse
354 /// accessor lookups and OpenAPI schema references.
355 pub target_name: &'static str,
356}
357
358/// Static metadata for one reverse OneToOne field on a model. The
359/// FK column on the child is intentionally omitted — `prefetch_related`
360/// resolves it at runtime by scanning the child's `FIELDS` for the
361/// UNIQUE FK pointing back at `target_table`. Carried by
362/// [`Model::ONE_TO_ONE_RELATIONS`].
363///
364/// Example: `pub struct User { pub profile: OneToOne<Profile>, ... }`
365/// emits one entry: `{ field_name: "profile", target_table:
366/// "profile", target_name: "Profile" }`. At prefetch time the loader
367/// finds the column on Profile (`pub user: ForeignKey<User>` with
368/// `#[umbral(unique)]`) and issues `SELECT * FROM profile WHERE user
369/// IN (parent_pks)`.
370#[derive(Debug, Clone, PartialEq, Eq)]
371pub struct OneToOneRelationSpec {
372 /// The Rust field name on the parent (e.g. `"profile"`).
373 pub field_name: &'static str,
374 /// The child model's table name (e.g. `"profile"`).
375 pub target_table: &'static str,
376 /// The child model's struct name (e.g. `"Profile"`). Reserved
377 /// for symmetry with `M2MRelationSpec` / `ReverseFkRelationSpec`.
378 pub target_name: &'static str,
379}
380
381/// Static metadata for one reverse-FK collection field on a model
382/// (gap #44). Carried by `Model::REVERSE_FK_RELATIONS`.
383///
384/// Example: `pub struct Post` with
385/// `#[umbral(reverse_fk = "post")] pub comment_set: ReverseSet<Comment>`
386/// emits one entry: `{ field_name: "comment_set", target_table:
387/// "comment", target_name: "Comment", fk_column: "post" }`.
388///
389/// `prefetch_related("comment_set")` uses this to issue
390/// `SELECT * FROM comment WHERE post IN (parent_pks)` then group
391/// rows by `post` value, populating each parent's `ReverseSet`.
392#[derive(Debug, Clone, PartialEq, Eq)]
393pub struct ReverseFkRelationSpec {
394 /// The Rust field name on the parent (e.g. `"comment_set"`).
395 pub field_name: &'static str,
396 /// The child model's table name (e.g. `"comment"`).
397 pub target_table: &'static str,
398 /// The child model's struct name (e.g. `"Comment"`). Reserved
399 /// for symmetry with `M2MRelationSpec`.
400 pub target_name: &'static str,
401 /// Name of the FK column on the child that points back at the
402 /// parent (e.g. `"post"`). The prefetch loader filters on this
403 /// column: `WHERE <fk_column> IN (parent_pks)`.
404 pub fk_column: &'static str,
405 /// Mirrors the CHILD model's `Model::SOFT_DELETE`. `annotate_count`
406 /// folds `AND <child>.deleted_at IS NULL` into the correlated
407 /// count subquery when this is `true`, so a trashed child stops
408 /// inflating the parent's count. Filled by the Model derive from
409 /// `<Child as Model>::SOFT_DELETE`.
410 pub soft_delete: bool,
411}
412
413/// Types that can serve as a model's primary key.
414///
415/// Built-in impls cover the integer widths sea-query has native
416/// `Value` variants for (i8 / i16 / i32 / i64, u8 / u16 / u32 / u64),
417/// `uuid::Uuid`, and `String` (for slug-style keys). The bound is
418/// `Clone + Send + Sync + 'static + Into<sea_query::Value>` — the
419/// `Into<Value>` requirement lets the M2M junction-table CRUD path
420/// bind the PK through sea-query without a per-type adapter, on both
421/// SQLite and Postgres. Closes BUG-16 phase 2.
422///
423/// 128-bit integers (`i128` / `u128`) are deliberately not in the
424/// catalogue: sea-query's `Value` enum has no native variant for them
425/// and neither shipped backend exposes a 128-bit integer column type.
426/// Use `i64` or `String` instead.
427///
428/// User crates extend the catalogue with one line as long as the
429/// custom type already lowers to a `sea_query::Value`:
430///
431/// ```ignore
432/// #[derive(Clone)]
433/// pub struct UserId(pub u64);
434///
435/// impl From<UserId> for sea_query::Value {
436/// fn from(id: UserId) -> Self { id.0.into() }
437/// }
438/// impl umbral::orm::PrimaryKey for UserId {}
439/// ```
440pub trait PrimaryKey:
441 Clone + Send + Sync + 'static + Into<sea_query::Value> + std::fmt::Display
442{
443}
444
445// Integer widths sea-query has Value variants for. Postgres exposes
446// SMALLINT / INT / BIGINT for the signed half; the unsigned widths
447// upcast (sea-query lowers u8/u16/u32 to the next signed width, u64
448// to BIGINT, matching what both backends actually store).
449impl PrimaryKey for i8 {}
450impl PrimaryKey for i16 {}
451impl PrimaryKey for i32 {}
452impl PrimaryKey for i64 {}
453impl PrimaryKey for u8 {}
454impl PrimaryKey for u16 {}
455impl PrimaryKey for u32 {}
456impl PrimaryKey for u64 {}
457
458// Non-integer built-ins. UUIDs and slug-style String keys are the
459// two non-integer shapes the porting catalogue calls out.
460impl PrimaryKey for uuid::Uuid {}
461impl PrimaryKey for String {}
462
463/// Static metadata for one column on a model.
464///
465/// Constructed once per field as a const, lives in `Model::FIELDS`.
466/// Carries enough information for the QuerySet, the system check, and
467/// the migration engine to do their jobs without the model needing any
468/// runtime introspection.
469#[derive(Debug, Clone, Copy, PartialEq, Eq)]
470pub struct FieldSpec {
471 /// The SQL column name — always the Rust field name. Only the table name
472 /// is overridable (via `#[umbral(table = "...")]`); there is no field-level
473 /// column-rename attribute, so the column is whatever the field is called.
474 pub name: &'static str,
475
476 /// The SQL type kind. M2 ships the minimum set needed for the
477 /// hardcoded `Post` model (`BigInt`, `Text`, `Timestamptz`);
478 /// additional variants land as the M3 derive's field-type
479 /// catalogue grows.
480 pub ty: SqlType,
481
482 /// Whether the column is part of the primary key.
483 pub primary_key: bool,
484
485 /// Whether the column accepts SQL NULL. Maps from `Option<T>` in
486 /// the struct definition; the only path to NULL is `Option<T>`,
487 /// per the `04-orm-model-and-fields.md` invariant.
488 pub nullable: bool,
489
490 /// Which backends this field type works on. Empty slice means "all
491 /// backends." Non-empty restricts the field to those listed; the
492 /// M4 boot system check rejects models that use a field on an
493 /// unsupported backend.
494 pub supported_backends: &'static [&'static str],
495
496 /// For `SqlType::ForeignKey` fields: the SQL table name of the
497 /// referenced model (i.e. `T::TABLE`). The migration engine reads
498 /// this at DDL-emit time to produce `REFERENCES "<target>"("id")`.
499 /// `None` for all non-FK fields.
500 pub fk_target: Option<&'static str>,
501
502 /// When `true`, this field is never rendered on any form (create or
503 /// edit) AND the REST plugin drops it from POST/PUT/PATCH request
504 /// bodies before write. This is the framework's "server-managed,
505 /// never accepts client input" flag — `password_hash`,
506 /// `internal_token`, audit timestamps the database owns.
507 /// Set via `#[umbral(noform)]`.
508 ///
509 /// OpenAPI emits `readOnly: true` for `noform` columns so Swagger
510 /// UI / generated clients honour the contract too. If you only
511 /// want the admin to render the field disabled — without affecting
512 /// the REST API or the spec — use `noedit` below.
513 ///
514 /// If `noform` is true, `noedit` is moot (noform takes precedence).
515 pub noform: bool,
516
517 /// For `SqlType::ForeignKey` fields: whether the migration engine
518 /// emits a *physical* `FOREIGN KEY ... REFERENCES` constraint.
519 /// Toggles the physical FK constraint. Set via
520 /// `#[umbral(db_constraint = false)]`; defaults to `true` (today's
521 /// behaviour — emit the constraint).
522 ///
523 /// When `false`, the FK stays a *logical* relation: the column +
524 /// `fk_target` are unchanged, so joins, `select_related`, and the
525 /// app-level `check_fk_row_exists` pre-validation all keep working —
526 /// but no `REFERENCES` clause is rendered. This is the only way to
527 /// model an FK whose target lives on a *different* database (a real
528 /// DB constraint can't span databases). The boot-time guard in
529 /// `App::build` rejects a cross-database FK that has NOT opted out
530 /// via this flag (`BuildError::CrossDatabaseForeignKey`). Closes
531 /// gaps2 #22. Ignored for non-FK fields.
532 pub db_constraint: bool,
533
534 /// When `true`, the admin shows this field disabled on the edit
535 /// form. Pure UX hint — no effect on the REST API or the OpenAPI
536 /// spec; clients can still POST/PUT/PATCH the column normally.
537 /// Set via `#[umbral(noedit)]`.
538 ///
539 /// Use case: a value the user supplies once at signup (`email`,
540 /// `username`) but isn't supposed to change later through the
541 /// admin. The REST API may still accept updates — gate that
542 /// separately via `ResourceConfig::hide(...)` or a permission
543 /// class if you want hard enforcement. To block writes entirely,
544 /// use `noform` instead.
545 ///
546 /// Has no effect when `noform` is also set.
547 pub noedit: bool,
548
549 /// When `true`, this field is the display string for the
550 /// model — the admin uses it as the default label in
551 /// `list_display` when the developer hasn't specified one
552 /// explicitly. Set via `#[umbral(string)]` /
553 /// `#[umbral(string = true)]`. Only meaningful on `String`-typed
554 /// columns; on non-string columns the admin falls back to the PK.
555 pub is_string_repr: bool,
556
557 /// Soft length cap for display. The admin truncates the value at
558 /// this many characters when rendering it in `list_display` so a
559 /// long body doesn't blow out a column. `0` means no truncation.
560 /// Set via `#[umbral(max_length = N)]`.
561 pub max_length: u32,
562
563 /// Closed-set values for a choices column, in declaration order.
564 /// Populated by the `#[derive(Model)]` macro for fields tagged
565 /// `#[umbral(choices)]` by reading `<T as ChoiceField>::VALUES` at
566 /// derive time. Empty slice means "not a choices field" — every
567 /// non-choices column uses the empty default.
568 ///
569 /// The migration engine emits a Postgres `CHECK (col IN (...))`
570 /// constraint when this slice is non-empty; the admin renders a
571 /// `<select>` widget with these as the `<option>` values.
572 pub choices: &'static [&'static str],
573
574 /// Human-readable labels matching `choices` position-for-position.
575 /// Used by the admin to render the `<select>` widget's option text.
576 /// Empty when `choices` is empty.
577 pub choice_labels: &'static [&'static str],
578
579 /// SQL `DEFAULT` clause for this column. Set via
580 /// `#[umbral(default = "...")]` — accepts a string literal that
581 /// the DDL pass passes verbatim into `DEFAULT '<value>'`. Empty
582 /// string means no default. Carried through to the migration
583 /// engine, which emits the `DEFAULT` on both `CREATE TABLE` and
584 /// `ALTER TABLE ADD COLUMN`.
585 pub default: &'static str,
586
587 /// When `true`, this column is a [`MultiChoice<E>`] field: TEXT
588 /// storage holding a CSV of the variants of `E`. The `choices` and
589 /// `choice_labels` slices carry the same metadata as a single-valued
590 /// choices field — the admin uses `is_multichoice` to pick the
591 /// checkbox-chip widget over the `<select>` widget.
592 ///
593 /// [`MultiChoice<E>`]: crate::orm::MultiChoice
594 pub is_multichoice: bool,
595
596 /// When `true`, the migration engine emits a `UNIQUE` constraint
597 /// on this column at `CREATE TABLE` time. Set via
598 /// `#[umbral(unique)]`. Closes gap #65.
599 ///
600 /// Scope at v1: applies to *new* tables only. Toggling `unique`
601 /// on an existing column does not generate an automatic
602 /// `ALTER TABLE ADD CONSTRAINT` — SQLite cannot add a unique
603 /// constraint without rebuilding the table, and the M8 diff
604 /// engine only watches `ty` and `nullable`. Add or remove
605 /// uniqueness on a live table via a hand-written migration
606 /// until the diff engine grows constraint-level ops.
607 ///
608 /// Primary-key columns are already implicitly unique, so this
609 /// flag is a no-op on a PK field. Set it on every other column
610 /// that needs database-enforced uniqueness (`username`,
611 /// `email`, opaque tokens, slugs, etc.) so handler-level
612 /// pre-checks become unnecessary.
613 pub unique: bool,
614
615 /// Referential action emitted on `DELETE` of the FK target row.
616 /// Only meaningful when `ty == ForeignKey`; ignored for every
617 /// other column. Set via `#[umbral(on_delete = "...")]`. Closes
618 /// gap #68. Defaults to `NoAction` so existing migrations
619 /// don't change shape.
620 pub on_delete: FkAction,
621
622 /// Referential action emitted on `UPDATE` of the FK target row's
623 /// primary key. Same FK-only semantics as `on_delete`; almost
624 /// nobody touches this in practice (PKs rarely move) but the
625 /// symmetry matches `REFERENCES ... ON UPDATE ...` and the
626 /// `on_delete` / `on_update` pair. Set via
627 /// `#[umbral(on_update = "...")]`.
628 pub on_update: FkAction,
629
630 /// When `true`, the migration engine emits a single-column
631 /// `CREATE INDEX` statement alongside the `CREATE TABLE`. Set
632 /// via `#[umbral(index)]`. Closes BUG-4 in
633 /// `bugs/tests/testBugs.md`.
634 ///
635 /// Index name convention: `idx_<table>_<column>`. Apps that
636 /// need a custom name, a multi-column index, or a partial
637 /// index write the `CREATE INDEX` by hand in a follow-up
638 /// migration.
639 pub index: bool,
640
641 /// When `true`, the column gets populated with `Utc::now()` at
642 /// row-creation time *only*. Set via `#[umbral(auto_now_add)]`.
643 /// Closes BUG-5 in `bugs/tests/testBugs.md`.
644 ///
645 /// **Where this fires:** the dynamic write path
646 /// (`DynQuerySet::insert_json`, used by `umbral-rest` /
647 /// `umbral-admin`). The typed `Manager::create(instance)` path
648 /// is user-controlled — the caller passes whatever value they
649 /// chose at the struct-init site. v1 scope: the framework
650 /// auto-populates only when the body / form omits the field.
651 pub auto_now_add: bool,
652
653 /// When `true`, the column gets populated with `Utc::now()` on
654 /// every write (create AND update). Set via `#[umbral(auto_now)]`. Closes
655 /// BUG-5 in `bugs/tests/testBugs.md`.
656 ///
657 /// **Where this fires:** the dynamic write path
658 /// (`DynQuerySet::insert_json` and `update_json`, used by
659 /// `umbral-rest` / `umbral-admin`). The typed paths stay
660 /// user-controlled at v1. Body-supplied values are kept —
661 /// users can override `auto_now` columns on the dynamic
662 /// path, matching the lenient "fill if missing" shape of
663 /// `auto_now_add`. An "always override" shape lands as
664 /// a future v2 toggle if a real consumer asks.
665 pub auto_now: bool,
666
667 /// Human-readable column description (help text).
668 /// Set via `#[umbral(help = "...")]`. Flows
669 /// through to:
670 ///
671 /// - OpenAPI `description` on the property schema (closes
672 /// playground-openapi-gaps item 5).
673 /// - Admin form field hint (the small line below the
674 /// input).
675 /// - Doc-comment-style introspection for any future code
676 /// generator.
677 ///
678 /// Empty string means "no description" — the OpenAPI
679 /// emitter and admin form skip the surrounding markup
680 /// when this is unset.
681 pub help: &'static str,
682
683 /// Presentation hint for form-rendering surfaces. Set via
684 /// `#[umbral(widget = "markdown" | "rte" | "textarea" | ...)]`;
685 /// `None` (the default) means "let the renderer pick by
686 /// `SqlType`". features.md #4.
687 ///
688 /// It is **metadata only** — the column's `SqlType`, DDL, and
689 /// stored value are unchanged. A `widget = "markdown"` field is
690 /// still `TEXT`; the widget only tells the admin (or any plugin
691 /// form) to render a markdown editor instead of a bare
692 /// `<textarea>`, and pairs with the `{{ value | markdown }}`
693 /// filter on the display side. Excluded from the migration diff
694 /// for the same reason `help` / `example` are: no DB effect.
695 ///
696 /// Renderers fall back to the `SqlType`-derived input for any
697 /// widget name they don't recognise, so an unknown widget is a
698 /// soft no-op rather than an error — third-party plugins can ship
699 /// new widget names without the core knowing them.
700 pub widget: Option<&'static str>,
701
702 /// Sample value rendered as OpenAPI `example` on the property
703 /// schema. Set via `#[umbral(example = "...")]`. Closes
704 /// playground-openapi-gaps item 6.
705 ///
706 /// Empty string means no example. Emitted as a JSON string in
707 /// the spec — clients that want typed examples can coerce on
708 /// their end. Pairs naturally with `help` to make a column's
709 /// purpose clear in Swagger UI.
710 pub example: &'static str,
711
712 /// Optional numeric lower bound. Set via `#[umbral(min = N)]`.
713 /// Closes IMP-3 from `bugs/tests/testBugs.md`. Flows to:
714 ///
715 /// - OpenAPI `minimum` on the property schema.
716 /// - REST plugin's dynamic write path pre-validation (400
717 /// response with a structured message).
718 /// - Future: HTML5 `min` attribute on admin form inputs.
719 ///
720 /// `i64::MIN` sentinel means "no minimum"; the DDL +
721 /// OpenAPI emitters skip the constraint when this is the
722 /// sentinel value. Macro accepts integer literals only at
723 /// v1 (a `Decimal`-aware shape can land when there's a real
724 /// consumer for decimal-typed validators).
725 pub min: Option<i64>,
726
727 /// Optional numeric upper bound. Set via `#[umbral(max = N)]`.
728 /// Mirror of `min`; same plumbing on the OpenAPI / REST /
729 /// admin sides.
730 pub max: Option<i64>,
731
732 /// Constrained-text marker. `None` is a plain `String` /
733 /// `SqlType::Text` column; `Some("slug" | "email" | "url")` is
734 /// one of the validator wrapper types from
735 /// [`crate::orm::validators`]. Closes BUG-11/12/13. Flows to:
736 ///
737 /// - OpenAPI `format: email` / `format: uri` / `pattern` on the
738 /// property schema (the standard 3.0 markers).
739 /// - REST plugin's dynamic write path: `validate_text_format`
740 /// pre-checks the body value and returns a structured 400
741 /// on a bad input.
742 /// - Admin form: HTML5 `type="email"` / `type="url"` widget
743 /// (when those land).
744 ///
745 /// The marker is set by the macro classifier from the field type
746 /// — `Slug` → `Some("slug")`, `Email` → `Some("email")`,
747 /// `Url` → `Some("url")`. The wrapper type + marker stay in sync
748 /// because they're produced from the same single match arm in
749 /// `umbral-macros::classify_field_type`.
750 pub text_format: Option<&'static str>,
751
752 /// Source column for an auto-derived slug. Set via
753 /// `#[umbral(slug_from = "title")]` on a `Slug` / `String` field;
754 /// names a sibling column on the same model whose value seeds
755 /// this column at write time. Gap 109.
756 ///
757 /// **Where this fires:** the dynamic write path
758 /// ([`crate::orm::DynQuerySet::insert_json`] +
759 /// [`crate::orm::DynQuerySet::update_json`]). On insert, an empty
760 /// or absent slug column is replaced by `slugify(source_value)`
761 /// derived from the source column in the same body. On update,
762 /// the slug is regenerated only when the source column is also
763 /// in the update payload, so callers who edit nothing but the
764 /// slug itself keep their hand-tuned value.
765 ///
766 /// `None` is the default — no auto-derive. The string is a
767 /// column name (snake_case), not a Rust field name, so it must
768 /// match exactly what ends up in `FieldSpec::name`.
769 pub slug_from: Option<&'static str>,
770}
771
772/// Referential action emitted in the SQL `REFERENCES ... ON
773/// {DELETE,UPDATE} <action>` clause. Mirrors the standard SQL set.
774///
775/// Copy + 'static so it can live on `FieldSpec` (which is itself
776/// `Copy` for storage in `&'static [FieldSpec]`).
777#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, serde::Serialize, serde::Deserialize)]
778pub enum FkAction {
779 /// SQL `NO ACTION` — the default. The migration engine emits no
780 /// clause at all (which means "default" on both backends; sqlite
781 /// and Postgres both default to NO ACTION when omitted).
782 #[default]
783 NoAction,
784 /// SQL `CASCADE` — when the FK target row is deleted/updated,
785 /// the referencing row is deleted/updated too. The right answer
786 /// for "owned" relationships (an `AuthToken` follows its
787 /// owning `AuthUser` to the grave).
788 Cascade,
789 /// SQL `RESTRICT` — block the delete/update of the FK target
790 /// row if any referencing row exists. Checked immediately;
791 /// doesn't defer to commit. Right for "you can't drop a
792 /// category that still has products in it."
793 Restrict,
794 /// SQL `SET NULL` — null the referencing column. Only valid on
795 /// nullable FK columns; the migration engine doesn't currently
796 /// check this at boot, so a mismatched pair (NOT NULL + SET NULL)
797 /// will fail at FK action time, not at CREATE TABLE.
798 SetNull,
799}
800
801impl FkAction {
802 /// SQL keyword for the `ON {DELETE,UPDATE} <kw>` clause.
803 /// Returns `None` for `NoAction` so the DDL builder can skip
804 /// the clause entirely (rather than emitting the redundant
805 /// `NO ACTION` literal).
806 pub fn sql_keyword(self) -> Option<&'static str> {
807 match self {
808 Self::NoAction => None,
809 Self::Cascade => Some("CASCADE"),
810 Self::Restrict => Some("RESTRICT"),
811 Self::SetNull => Some("SET NULL"),
812 }
813 }
814
815 /// Parse the attribute string supplied to `#[umbral(on_delete = "...")]`.
816 /// Case-insensitive; accepts both `set_null` and `set null` for
817 /// the multi-word case so users can write whichever feels
818 /// natural.
819 pub fn from_attr_str(s: &str) -> Option<Self> {
820 match s.to_lowercase().as_str() {
821 "no_action" | "no action" => Some(Self::NoAction),
822 "cascade" => Some(Self::Cascade),
823 "restrict" => Some(Self::Restrict),
824 "set_null" | "set null" => Some(Self::SetNull),
825 _ => None,
826 }
827 }
828}
829
830/// The SQL type kind of a column.
831///
832/// The dialect-specific rendering (`BIGINT` vs `INTEGER` vs whatever
833/// the backend calls it) is the backend's responsibility, set up by
834/// the M4 `DatabaseBackend` abstraction. This enum is the abstract
835/// classification umbral reasons about.
836///
837/// The catalogue follows spec 04 §4.1: each variant covers one
838/// field type. Rust types in the field declaration map to a
839/// variant via the M3 derive's `classify_field_type`; the table is in
840/// `umbral-macros/src/lib.rs` alongside the derive.
841///
842/// Backend-specific variants (Postgres `Array`, `HStore`, `Jsonb`) land
843/// at M4 when the system check exists to gate them at boot.
844#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
845pub enum SqlType {
846 /// A foreign-key reference to another table. Stored as `i64` (the
847 /// referenced row's primary key). Renders as `BIGINT REFERENCES
848 /// "<target_table>"("id")` on both Postgres and SQLite.
849 ///
850 /// The referenced table name is carried separately in
851 /// [`FieldSpec::fk_target`] so this enum stays `Copy`. The migration
852 /// engine reads `fk_target` at DDL-emit time.
853 ///
854 /// Out of scope at v1: non-`i64` FK targets, `ON DELETE` behaviours
855 /// beyond the default RESTRICT, reverse accessors (`User::posts`),
856 /// and many-to-many join tables. See `docs/specs/relationships.md`.
857 ForeignKey,
858 /// 16-bit signed integer. `i8` / `i16` / `u8` in Rust.
859 SmallInt,
860 /// 32-bit signed integer. `i32` / `u16` in Rust.
861 Integer,
862 /// 64-bit signed integer. `i64` / `u32` in Rust.
863 BigInt,
864 /// 32-bit floating point. `f32` in Rust.
865 Real,
866 /// 64-bit floating point. `f64` in Rust.
867 Double,
868 /// Boolean. `bool` in Rust.
869 Boolean,
870 /// Variable-length string. `String` in Rust.
871 Text,
872 /// Date without time. `chrono::NaiveDate` in Rust.
873 Date,
874 /// Time without date. `chrono::NaiveTime` in Rust.
875 Time,
876 /// Timestamp with timezone. `chrono::DateTime<chrono::Utc>` in Rust.
877 Timestamptz,
878 /// 128-bit UUID. `uuid::Uuid` in Rust.
879 Uuid,
880 /// JSON document. `serde_json::Value` in Rust.
881 ///
882 /// Cross-backend: Postgres stores native `JSONB` (binary form with
883 /// index / operator support); SQLite stores `TEXT` (JSON-as-string).
884 /// `serde_json::Value` round-trips through both via sqlx's `json`
885 /// feature, so a user model with a `Value` field works on either
886 /// backend without code changes: a portable JSON field with a
887 /// portable shape and dialect-specific storage. Native JSONB-only
888 /// operators (`@>`, `->`, `->>` etc.) are a deferred follow-on
889 /// landed alongside Postgres-specific column predicates.
890 Json,
891 /// Array column. `Vec<T>` in Rust where `T` is one of the
892 /// [`ArrayElement`] variants.
893 ///
894 /// **Postgres-only.** SQLite has no native array type; the M4
895 /// system check fails at boot if an Array field is registered
896 /// against the SQLite backend. For portable list storage, declare
897 /// the field as `serde_json::Value` (the [`Self::Json`] variant)
898 /// and store a JSON array inside.
899 ///
900 /// The inner type is restricted to [`ArrayElement`] rather than
901 /// `Box<SqlType>` so the outer enum stays `Copy` and `SqlType`
902 /// values can live in `const FIELDS` slices the derive emits.
903 /// Multi-dim arrays (`Vec<Vec<T>>`), nullable elements
904 /// (`Vec<Option<T>>`), and nested JSON arrays (`Vec<Value>`) are
905 /// out of scope for v1.
906 Array(ArrayElement),
907 /// `INET` — Postgres IP address column with optional netmask.
908 /// Maps to `ipnetwork::IpNetwork` in Rust. **Postgres-only.**
909 /// Stores a generic IP address.
910 Inet,
911 /// `CIDR` — Postgres network address column. Same Rust type as
912 /// `Inet` (`ipnetwork::IpNetwork`) but with the constraint that
913 /// the host bits must be zero. **Postgres-only.**
914 Cidr,
915 /// `MACADDR` — Postgres MAC address column. Maps to
916 /// `mac_address::MacAddress` in Rust. **Postgres-only.**
917 MacAddr,
918 /// `XML` — Postgres XML document column. Maps to `String` in Rust
919 /// (umbral stores and round-trips the serialized XML text; it does
920 /// not parse or validate the document at the framework level —
921 /// Postgres does that on insert). **Postgres-only.** Reach for this
922 /// over `Text` only when you want Postgres' `xml` type checking and
923 /// the `xpath` / `xmlexists` operator surface; otherwise `Text`
924 /// stores XML strings just fine (XML is otherwise modelled as plain
925 /// text).
926 Xml,
927 /// `LTREE` — Postgres hierarchical label-path column (the `ltree`
928 /// extension). Maps to `String` in Rust (the dotted path, e.g.
929 /// `"Top.Science.Astronomy"`). **Postgres-only**, and requires the
930 /// `ltree` extension (`CREATE EXTENSION ltree`) to be installed in
931 /// the target database. The umbral migration engine emits the bare
932 /// `ltree` column type; the extension itself is the operator's
933 /// responsibility (a hand-written migration or a DB bootstrap step).
934 Ltree,
935 /// `BIT VARYING` — Postgres bit-string column. Maps to `String` in
936 /// Rust (the textual `"0"`/`"1"` representation, e.g. `"101"`).
937 /// **Postgres-only.** v1 renders as `BIT VARYING` (variable-length);
938 /// a fixed-width `BIT(n)` needs a hand-written migration after the
939 /// initial create until a `#[umbral(bit_len = N)]` attribute lands
940 /// for a real consumer. There is otherwise no dedicated bit-string
941 /// type; the fallback is plain text.
942 Bit,
943 /// `TSVECTOR` — Postgres full-text search lexeme vector. Maps to
944 /// [`crate::orm::TsVector`] in Rust (a thin newtype around
945 /// `String` with sqlx Type/Encode/Decode impls). **Postgres-only.**
946 ///
947 /// The column is typically populated by a Postgres trigger or
948 /// `GENERATED ALWAYS AS (to_tsvector(...)) STORED` clause; umbral's
949 /// migration engine emits the bare `tsvector` type, leaving the
950 /// population mechanism to the user. Queries against a
951 /// `FullTextCol` use the `@@` match operator with `to_tsquery` /
952 /// `websearch_to_tsquery`.
953 FullText,
954 /// `BLOB` (SQLite) / `BYTEA` (Postgres) — arbitrary binary payload.
955 /// Maps to `Vec<u8>` in Rust. Used by anything that stores opaque
956 /// bytes: file uploads, the cache backend's value column, encrypted
957 /// envelopes, etc.
958 ///
959 /// `Vec<u8>` was previously routed to `SqlType::Array(SmallInt)`
960 /// because the array detection treated `u8` as a small int. The
961 /// detection now checks for `Vec<u8>` specifically first and
962 /// routes to `Bytes`; `Vec<i8>` / `Vec<i16>` still map to
963 /// `Array(SmallInt)`.
964 Bytes,
965 /// `NUMERIC(19, 4)` — fixed-point decimal. Maps to
966 /// `rust_decimal::Decimal` in Rust. Closes BUG-10 from
967 /// `bugs/tests/testBugs.md`. Money / price columns must use
968 /// this, not `f64` (binary float drops cents) or `String`
969 /// (no DB-level arithmetic).
970 ///
971 /// **Postgres-only at v1.** sqlx's `rust_decimal` feature
972 /// adds Encode/Decode for Postgres `NUMERIC` only; SQLite has
973 /// no native decimal type (every numeric value is INTEGER /
974 /// REAL / TEXT affinity). The boot system check rejects
975 /// Decimal models against SQLite the same way it rejects
976 /// `Array(_)` — apps deploying to SQLite either pick a
977 /// portable type (`Real` or `Text` with manual formatting) or
978 /// use Postgres for the parts of their schema that need
979 /// decimal arithmetic. A fixed-precision decimal column.
980 ///
981 /// **v1 scope.** Precision and scale are fixed at `(19, 4)` —
982 /// 19 significant digits, 4 after the decimal point. That's
983 /// enough headroom for currency values up to one quadrillion
984 /// dollars (with sub-cent precision) and matches sqlx's
985 /// `Decimal` default. Apps that need a different precision
986 /// alter the column via a hand-written migration after the
987 /// initial create. A `#[umbral(precision = N, scale = M)]`
988 /// attribute lands when there's a real consumer that needs
989 /// dimensions outside the default.
990 Decimal,
991}
992
993/// Element types valid inside [`SqlType::Array`].
994///
995/// A strict subset of the [`SqlType`] catalogue: the value types
996/// Postgres supports as `T[]` and that umbral knows how to bind / decode
997/// through sqlx. Stays `Copy` so the outer `SqlType::Array(ArrayElement)`
998/// remains usable in `const FIELDS` slices.
999///
1000/// Catalogue:
1001///
1002/// | Variant | Postgres type | Rust inner type |
1003/// |-------------|---------------|-------------------|
1004/// | `SmallInt` | `int2[]` | `Vec<i16>` |
1005/// | `Integer` | `int4[]` | `Vec<i32>` |
1006/// | `BigInt` | `int8[]` | `Vec<i64>` |
1007/// | `Real` | `float4[]` | `Vec<f32>` |
1008/// | `Double` | `float8[]` | `Vec<f64>` |
1009/// | `Boolean` | `bool[]` | `Vec<bool>` |
1010/// | `Text` | `text[]` | `Vec<String>` |
1011/// | `Uuid` | `uuid[]` | `Vec<uuid::Uuid>` |
1012///
1013/// Other element types (Date / Time / Timestamptz / Json) land as
1014/// follow-ons when there's a real consumer; the binding semantics for
1015/// chrono types as Postgres array elements need a deliberate pass.
1016#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
1017pub enum ArrayElement {
1018 SmallInt,
1019 Integer,
1020 BigInt,
1021 Real,
1022 Double,
1023 Boolean,
1024 Text,
1025 Uuid,
1026}
1027
1028impl ArrayElement {
1029 /// Lift this element type back to its [`SqlType`] equivalent. Used
1030 /// when a per-element decision needs to dispatch through the same
1031 /// SqlType match the rest of umbral uses (e.g. picking a
1032 /// `sea_query::ColumnType` for the element).
1033 pub fn to_sql_type(self) -> SqlType {
1034 match self {
1035 ArrayElement::SmallInt => SqlType::SmallInt,
1036 ArrayElement::Integer => SqlType::Integer,
1037 ArrayElement::BigInt => SqlType::BigInt,
1038 ArrayElement::Real => SqlType::Real,
1039 ArrayElement::Double => SqlType::Double,
1040 ArrayElement::Boolean => SqlType::Boolean,
1041 ArrayElement::Text => SqlType::Text,
1042 ArrayElement::Uuid => SqlType::Uuid,
1043 }
1044 }
1045}