Struct 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: InputType>(self) -> Self

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: OutputType>(self) -> Self

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

Disable introspection queries.

pub fn introspection_only(self) -> Self

Only process introspection queries, everything else is processed as an error.

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 limit_recursive_depth(self, depth: usize) -> Self

Set the maximum recursive depth a query can have. (default: 32)

If the value is too large, stack overflow may occur, usually 32 is enough.

pub fn limit_directives(self, max_directives: usize) -> Self

Set the maximum number of directives on a single field. (default: 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_input_type_description<T: InputType>( self, desc: &'static str, ) -> Self

Override the name of the specified input type.

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

Override the name of the specified output type.

pub fn directive<T: CustomDirectiveFactory>(self, directive: T) -> Self

Register a custom directive.

Panics

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

pub fn disable_suggestions(self) -> Self

Disable field suggestions.

pub fn with_sorted_fields(self) -> Self

Make all fields sorted on introspection queries.

pub fn with_sorted_enums(self) -> Self

Make all enum variants sorted on introspection queries.

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

Consumes this builder and returns a schema.