fraiseql_core/schema/compiled/mutation.rs
1use indexmap::IndexMap;
2use serde::{Deserialize, Serialize};
3
4use super::argument::ArgumentDefinition;
5use crate::schema::{field_type::DeprecationInfo, security_config::InjectedParamSource};
6
7/// A mutation definition compiled from `@fraiseql.mutation`.
8///
9/// Mutations are declarative bindings to database functions.
10/// They describe *which function* to call, not arbitrary logic.
11///
12/// # Example
13///
14/// ```
15/// use fraiseql_core::schema::{MutationDefinition, MutationOperation};
16///
17/// let mutation = MutationDefinition::new("createUser", "User");
18/// ```
19#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
20pub struct MutationDefinition {
21 /// Mutation name (e.g., "createUser").
22 pub name: String,
23
24 /// Return type name.
25 pub return_type: String,
26
27 /// Input arguments.
28 #[serde(default)]
29 pub arguments: Vec<ArgumentDefinition>,
30
31 /// Description.
32 #[serde(default, skip_serializing_if = "Option::is_none")]
33 pub description: Option<String>,
34
35 /// SQL operation type.
36 #[serde(default)]
37 pub operation: MutationOperation,
38
39 /// Deprecation information (from @deprecated directive).
40 /// When set, this mutation is marked as deprecated in the schema.
41 #[serde(default, skip_serializing_if = "Option::is_none")]
42 pub deprecation: Option<DeprecationInfo>,
43
44 /// PostgreSQL function name to call for this mutation.
45 ///
46 /// When set, the runtime calls `SELECT * FROM {sql_source}($1, $2, ...)` with the
47 /// mutation arguments in `ArgumentDefinition` order, and parses the result as an
48 /// `app.mutation_response` composite row.
49 #[serde(default, skip_serializing_if = "Option::is_none")]
50 pub sql_source: Option<String>,
51
52 /// Server-side parameters injected from JWT claims at runtime.
53 ///
54 /// Keys are SQL parameter names. Values describe where to source the runtime value.
55 /// These params are NOT exposed as GraphQL arguments.
56 ///
57 /// For mutations: injected params are appended to the positional function call args
58 /// **after** client-provided arguments, in map insertion order. The SQL function
59 /// signature must declare the injected parameters last.
60 ///
61 /// Works on PostgreSQL, SQL Server, and MySQL. SQLite has no stored-routine mechanism
62 /// and will return an error if inject is configured on a mutation.
63 #[serde(default, skip_serializing_if = "IndexMap::is_empty")]
64 pub inject_params: IndexMap<String, InjectedParamSource>,
65
66 /// Fact tables whose version counter should be bumped after this mutation succeeds.
67 ///
68 /// When the mutation PostgreSQL function returns successfully, the runtime calls
69 /// `SELECT bump_tf_version($1)` for each listed table, incrementing the version used
70 /// in fact-table cache keys. This ensures that analytic/aggregate queries backed by
71 /// `FactTableVersionStrategy::VersionTable` are automatically invalidated.
72 ///
73 /// Each entry must be a valid SQL identifier validated at compile time.
74 ///
75 /// # Example
76 ///
77 /// ```python
78 /// @fraiseql.mutation(
79 /// sql_source="fn_create_order",
80 /// invalidates_fact_tables=["tf_sales", "tf_order_count"],
81 /// )
82 /// def create_order(amount: Decimal) -> Order: ...
83 /// ```
84 #[serde(default, skip_serializing_if = "Vec::is_empty")]
85 pub invalidates_fact_tables: Vec<String>,
86
87 /// View names whose cached query results should be invalidated after this
88 /// mutation succeeds.
89 ///
90 /// When the `CachedDatabaseAdapter` is active, the runtime calls
91 /// `invalidate_views()` with these names, clearing all cache entries that
92 /// read from the specified views.
93 ///
94 /// If empty and the mutation return type has a `sql_source`, the runtime
95 /// infers the primary view from the return type.
96 ///
97 /// Each entry must be a valid SQL identifier validated at compile time.
98 #[serde(default, skip_serializing_if = "Vec::is_empty")]
99 pub invalidates_views: Vec<String>,
100
101 /// Custom REST path override (e.g., `"/users/{id}"`).
102 #[serde(default, skip_serializing_if = "Option::is_none")]
103 pub rest_path: Option<String>,
104
105 /// REST HTTP method override (e.g., `"POST"`, `"PUT"`, `"PATCH"`).
106 #[serde(default, skip_serializing_if = "Option::is_none")]
107 pub rest_method: Option<String>,
108
109 /// PostgreSQL upsert function name for `PUT` semantics (insert-or-update).
110 #[serde(default, skip_serializing_if = "Option::is_none")]
111 pub upsert_function: Option<String>,
112
113 /// Role required to execute this mutation and see it in introspection.
114 ///
115 /// When set, only users whose `SecurityContext.roles` contains this role can
116 /// discover and execute the mutation. Others receive `"Unknown mutation"`
117 /// (not `FORBIDDEN`) to prevent role enumeration — mirroring
118 /// [`QueryDefinition::requires_role`](super::query::QueryDefinition).
119 #[serde(default, skip_serializing_if = "Option::is_none")]
120 pub requires_role: Option<String>,
121
122 /// Whether a successful run of this mutation writes a Change-Spine change-log
123 /// row (default `true`).
124 ///
125 /// Composes as a logical AND with the global
126 /// [`RuntimeConfig.changelog_enabled`](crate::runtime::RuntimeConfig): a row
127 /// is written only when the global switch is on **and** this flag is `true`.
128 /// Set `false` to opt a single mutation out of the in-transaction outbox
129 /// write — e.g. a hot endpoint that need not appear in the Change Spine —
130 /// while leaving the rest of the schema logging. Serde-defaults to `true`, so
131 /// a compiled schema produced before this field existed keeps logging.
132 #[serde(default = "default_changelog")]
133 pub changelog: bool,
134}
135
136/// Serde default for [`MutationDefinition::changelog`]: log by default (opt-out).
137const fn default_changelog() -> bool {
138 true
139}
140
141impl MutationDefinition {
142 /// Create a new mutation definition.
143 #[must_use]
144 pub fn new(name: impl Into<String>, return_type: impl Into<String>) -> Self {
145 Self {
146 name: name.into(),
147 return_type: return_type.into(),
148 arguments: Vec::new(),
149 description: None,
150 operation: MutationOperation::default(),
151 deprecation: None,
152 sql_source: None,
153 inject_params: IndexMap::new(),
154 invalidates_fact_tables: Vec::new(),
155 invalidates_views: Vec::new(),
156 rest_path: None,
157 rest_method: None,
158 upsert_function: None,
159 requires_role: None,
160 changelog: true,
161 }
162 }
163
164 /// Mark this mutation as deprecated.
165 ///
166 /// # Example
167 ///
168 /// ```
169 /// use fraiseql_core::schema::MutationDefinition;
170 ///
171 /// let mutation = MutationDefinition::new("oldCreateUser", "User")
172 /// .deprecated(Some("Use 'createUser' instead".to_string()));
173 /// assert!(mutation.is_deprecated());
174 /// ```
175 #[must_use]
176 pub fn deprecated(mut self, reason: Option<String>) -> Self {
177 self.deprecation = Some(DeprecationInfo { reason });
178 self
179 }
180
181 /// Check if this mutation is deprecated.
182 #[must_use]
183 pub const fn is_deprecated(&self) -> bool {
184 self.deprecation.is_some()
185 }
186
187 /// Get the deprecation reason if deprecated.
188 #[must_use]
189 pub fn deprecation_reason(&self) -> Option<&str> {
190 self.deprecation.as_ref().and_then(|d| d.reason.as_deref())
191 }
192}
193
194/// Mutation operation types.
195///
196/// This enum describes what kind of database operation a mutation performs.
197#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
198#[serde(rename_all = "PascalCase")]
199#[non_exhaustive]
200pub enum MutationOperation {
201 /// INSERT into a table.
202 Insert {
203 /// Target table name.
204 table: String,
205 },
206
207 /// UPDATE a table.
208 Update {
209 /// Target table name.
210 table: String,
211 },
212
213 /// DELETE from a table.
214 Delete {
215 /// Target table name.
216 table: String,
217 },
218
219 /// Custom mutation (for complex operations).
220 #[default]
221 Custom,
222}
223
224impl MutationOperation {
225 /// Return a lowercase string label for the operation kind.
226 ///
227 /// Used in structured audit log events to identify the DML type.
228 ///
229 /// # Example
230 ///
231 /// ```
232 /// use fraiseql_core::schema::MutationOperation;
233 ///
234 /// assert_eq!(MutationOperation::Insert { table: "users".into() }.kind_str(), "insert");
235 /// assert_eq!(MutationOperation::Update { table: "users".into() }.kind_str(), "update");
236 /// assert_eq!(MutationOperation::Delete { table: "users".into() }.kind_str(), "delete");
237 /// assert_eq!(MutationOperation::Custom.kind_str(), "custom");
238 /// ```
239 #[must_use]
240 pub const fn kind_str(&self) -> &'static str {
241 match self {
242 Self::Insert { .. } => "insert",
243 Self::Update { .. } => "update",
244 Self::Delete { .. } => "delete",
245 Self::Custom => "custom",
246 }
247 }
248}