Skip to main content

IntermediateMutation

Struct IntermediateMutation 

Source
pub struct IntermediateMutation {
Show 17 fields pub name: String, pub return_type: String, pub returns_list: bool, pub nullable: bool, pub arguments: Vec<IntermediateArgument>, pub description: Option<String>, pub sql_source: Option<String>, pub operation: Option<String>, pub deprecated: Option<IntermediateDeprecation>, pub inject: IndexMap<String, String>, pub requires_role: Option<String>, pub invalidates_fact_tables: Vec<String>, pub invalidates_views: Vec<String>, pub changelog: bool, pub input_style: InputStyle, pub changelog_pre_image: bool, pub cascade: bool,
}
Expand description

Mutation definition in intermediate format

Fields§

§name: String

Mutation name (e.g., “createUser”)

§return_type: String

Return type name (e.g., “User”)

§returns_list: bool

Returns a list?

§nullable: bool

Result is nullable?

§arguments: Vec<IntermediateArgument>

Mutation arguments

§description: Option<String>

Mutation description (from docstring)

§sql_source: Option<String>

SQL source (function name)

§operation: Option<String>

Operation type (CREATE, UPDATE, DELETE, CUSTOM)

§deprecated: Option<IntermediateDeprecation>

Deprecation info (from @deprecated directive)

§inject: IndexMap<String, String>

Server-injected parameters: SQL parameter name → source expression (e.g. "jwt:org_id"). Not exposed as GraphQL arguments.

§requires_role: Option<String>

Role required to execute this mutation and see it in introspection.

Mirrors IntermediateQuery::requires_role. Enforced at runtime with the same enumeration-hiding “not found” response as the query gate — a principal lacking the role cannot distinguish a forbidden mutation from a nonexistent one.

§invalidates_fact_tables: Vec<String>

Fact tables whose version counter should be bumped after this mutation succeeds.

Used for correct invalidation of analytic/aggregate cache entries.

§invalidates_views: Vec<String>

View names whose cached query results should be invalidated after this mutation succeeds.

§changelog: bool

Whether this mutation writes a Change-Spine change-log row (default true).

Set false (via the authoring SDK’s @fraiseql.mutation(changelog=False)) to opt a single mutation out of the in-transaction change-log outbox while the rest of the schema keeps logging. Defaults to true so a schema authored before this field existed keeps logging.

§input_style: InputStyle

How the GraphQL input argument is passed to the SQL function: "flatten" (positional columns, the default) or "jsonb" (the whole input as one jsonb arg). See InputStyle.

Orthogonal to operation: set "jsonb" (via the authoring SDK’s @fraiseql.mutation(input_style="jsonb")) so a backend using the single-jsonb-wrapper convention can register the real DML verb and still receive the whole input as one argument. Defaults to "flatten", byte-identical to a schema authored before this field existed.

§changelog_pre_image: bool

Whether a successful, state-changing run of this mutation also records the changed entity’s pre-image (before-state) into the Change-Spine object_data_before column, sourced from an optional entity_before on the mutation’s app.mutation_response.

Set true (via the authoring SDK’s @fraiseql.mutation(changelog_pre_image=True) or TOML changelog_pre_image = true) to opt an audit-sensitive mutation into an inline Debezium-style {before, after}. Defaults to false, byte-identical to a schema authored before this field existed.

§cascade: bool

Whether this mutation exposes the typed graphql-cascade cascade field on its success payload.

Set true via the authoring SDK’s @fraiseql.type(crud=True, cascade=True) / @fraiseql.mutation(cascade=True), or TOML cascade = true. Defaults to false, byte-identical to a schema authored before this field existed. Before this field, the compiler silently dropped the SDK flag.

Trait Implementations§

Source§

impl Clone for IntermediateMutation

Source§

fn clone(&self) -> IntermediateMutation

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for IntermediateMutation

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for IntermediateMutation

Source§

fn default() -> Self

Hand-written so changelog defaults to true (matching the serde default), not bool’s false. A #[derive(Default)] would silently opt ..Default::default()-built mutations out of the change log.

Source§

impl<'de> Deserialize<'de> for IntermediateMutation

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for IntermediateMutation

Source§

impl PartialEq for IntermediateMutation

Source§

fn eq(&self, other: &IntermediateMutation) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for IntermediateMutation

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for IntermediateMutation

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more