Struct async_graphql::SchemaBuilder

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

Schema builder

Implementations

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

pub fn register_type<T: Type>(self) -> Self

Manually register a type in the schema.

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

pub fn disable_introspection(self) -> Self

Disable introspection queries.

pub fn limit_complexity(self, complexity: usize) -> Self

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

pub fn limit_depth(self, depth: usize) -> Self

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

pub fn extension(self, extension: impl ExtensionFactory) -> Self

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: Any + Send + Sync>(self, data: D) -> Self

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) -> Self

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

pub fn enable_federation(self) -> Self

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

pub fn enable_subscription_in_federation(self) -> Self

Make the Federation SDL include subscriptions.

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

pub fn override_description<T: Type>(self, desc: &'static str) -> Self

Override the name of the specified type.

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

Build schema.