Struct IntermediateType 

pub struct IntermediateType {
    pub name: String,
    pub fields: Vec<IntermediateField>,
    pub description: Option<String>,
    pub sql_source: Option<String>,
    pub implements: Vec<String>,
    pub requires_role: Option<String>,
    pub is_error: bool,
    pub relay: bool,
    pub subscribable_tables: Option<Vec<String>>,
    pub subscribable_pre_image: bool,
}

Type definition in intermediate format

Fields

name: String

Type name (e.g., “User”)

fields: Vec<IntermediateField>

Type fields

description: Option<String>

Type description (from docstring)

sql_source: Option<String>

Type-level SQL source (backing table/view), e.g. v_organization.

Owned types bind their relation on the query that returns them, so this is normally absent. It is emitted by the authoring SDK only for an owner-split extend type … @key federation entity: a subgraph that does not own the entity exposes no root query returning it, so the federation _entities resolver has no query to source the backing relation from and would otherwise guess lower(typename) and resolve to null (#507). When present it flows through to TypeDefinition.sql_source and is used as the _entities fallback relation.

implements: Vec<String>

Interfaces this type implements (GraphQL spec §3.6)

requires_role: Option<String>

Role required to see this type in introspection and access queries returning it.

is_error: bool

Whether this type is a mutation error type (tagged with @fraiseql.error).

relay: bool

Whether this type implements the Relay Node interface. When true, the compiler generates global node IDs (base64("TypeName:uuid")) and validates that pk_{entity} (BIGINT) is present in the view’s data JSONB.

subscribable_tables: Option<Vec<String>>

@subscribable(tables=[...]) — the underlying base table(s) whose external writes should be captured onto the Change Spine (#366).

The compiler aggregates the set of (name, tables) for every type carrying this into CompiledSchema.subscribable, which the generate_capture_trigger_ddl generator turns into per-table capture triggers. None/absent (the default) when the type is not subscribable.

Example

{
  "name": "Post",
  "fields": [],
  "subscribable_tables": ["tb_post"]
}

subscribable_pre_image: bool

@subscribable(..., pre_image=True) — whether the capture triggers on this type’s tables also record the changed entity’s pre-image (OLD) into object_data_before, the out-of-band parity for a mutation’s changelog_pre_image. Only meaningful alongside subscribable_tables; false/absent (the default) captures the after-image only.

Trait Implementations

impl Clone for IntermediateType

fn clone(&self) -> IntermediateType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IntermediateType

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

Formats the value using the given formatter.

impl Default for IntermediateType

fn default() -> IntermediateType

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IntermediateType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for IntermediateType

impl PartialEq for IntermediateType

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for IntermediateType

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for IntermediateType