Struct simple_syrup::SchemaBuilder

pub struct SchemaBuilder<Query, Mutation, Subscription> { /* private fields */ }

Schema builder

Implementations

impl<Query, Mutation, Subscription> SchemaBuilder<Query, Mutation, Subscription>

pub fn register_input_type<T>(
    self
) -> SchemaBuilder<Query, Mutation, Subscription> where
    T: InputType, 

Manually register a input type in the schema.

You can use this function to register schema types that are not directly referenced.

pub fn register_output_type<T>(
    self
) -> SchemaBuilder<Query, Mutation, Subscription> where
    T: OutputType, 

Manually register a output type in the schema.

You can use this function to register schema types that are not directly referenced.

pub fn disable_introspection(
    self
) -> SchemaBuilder<Query, Mutation, Subscription>

Disable introspection queries.

pub fn limit_complexity(
    self,
    complexity: usize
) -> SchemaBuilder<Query, Mutation, Subscription>

Set the maximum complexity a query can have. By default, there is no limit.

pub fn limit_depth(
    self,
    depth: usize
) -> SchemaBuilder<Query, Mutation, Subscription>

Set the maximum depth a query can have. By default, there is no limit.

pub fn extension(
    self,
    extension: impl ExtensionFactory
) -> SchemaBuilder<Query, Mutation, Subscription>

Add an extension to the schema.

Examples

use async_graphql::*;

struct Query;

#[Object]
impl Query {
    async fn value(&self) -> i32 {
        100
    }
}

let schema = Schema::build(Query, EmptyMutation,EmptySubscription)
    .extension(extensions::Logger)
    .finish();

pub fn data<D>(self, data: D) -> SchemaBuilder<Query, Mutation, Subscription> where
    D: Any + Send + Sync, 

Add a global data that can be accessed in the Schema. You access it with Context::data.

pub fn validation_mode(
    self,
    validation_mode: ValidationMode
) -> SchemaBuilder<Query, Mutation, Subscription>

Set the validation mode, default is ValidationMode::Strict.

pub fn enable_federation(self) -> SchemaBuilder<Query, Mutation, Subscription>

Enable federation, which is automatically enabled if the Query has least one entity definition.

pub fn enable_subscription_in_federation(
    self
) -> SchemaBuilder<Query, Mutation, Subscription>

Make the Federation SDL include subscriptions.

Note: Not included by default, in order to be compatible with Apollo Server.

pub fn override_input_type_description<T>(
    self,
    desc: &'static str
) -> SchemaBuilder<Query, Mutation, Subscription> where
    T: InputType, 

Override the name of the specified input type.

pub fn override_output_type_description<T>(
    self,
    desc: &'static str
) -> SchemaBuilder<Query, Mutation, Subscription> where
    T: OutputType, 

Override the name of the specified output type.

pub fn directive<T>(
    self,
    directive: T
) -> SchemaBuilder<Query, Mutation, Subscription> where
    T: CustomDirectiveFactory, 

Register a custom directive.

Panics

Panics if the directive with the same name is already registered.

pub fn finish(self) -> Schema<Query, Mutation, Subscription>

Build schema.