2018-12-23 14:41:50 -06:00
# Schemas
2020-04-17 01:16:00 -05:00
A schema consists of three types: a query object, a mutation object, and a subscription object.
These three define the root query fields, mutations and subscriptions of the schema, respectively.
The usage of subscriptions is a little different from the mutation and query objects, so there is a specific [section][section] that discusses them.
2018-12-23 14:41:50 -06:00
Both query and mutation objects are regular GraphQL objects, defined like any
2020-04-17 01:16:00 -05:00
other object in Juniper. The mutation and subscription object, however, is optional since schemas
can be read-only and without subscriptions as well. If mutations/subscriptions functionality is not needed, consider using [EmptyMutation][EmptyMutation]/[EmptySubscription][EmptySubscription].
2018-12-23 14:41:50 -06:00
In Juniper, the `RootNode` type represents a schema. You usually don't have to
2019-04-09 18:02:14 -05:00
create this object yourself: see the framework integrations for [Iron ](../servers/iron.md )
and [Rocket ](../servers/rocket.md ) how schemas are created together with the handlers
2018-12-23 14:41:50 -06:00
themselves.
When the schema is first created, Juniper will traverse the entire object graph
and register all types it can find. This means that if you define a GraphQL
object somewhere but never references it, it will not be exposed in a schema.
## The query root
The query root is just a GraphQL object. You define it like any other GraphQL
2019-05-13 11:33:45 -05:00
object in Juniper, most commonly using the `object` proc macro:
2018-12-23 14:41:50 -06:00
```rust
# use juniper::FieldResult;
2019-01-11 10:16:21 -06:00
# #[derive(juniper::GraphQLObject)] struct User { name: String }
2018-12-23 14:41:50 -06:00
struct Root;
2019-11-15 19:43:39 -06:00
#[juniper::graphql_object]
2019-05-07 03:56:06 -05:00
impl Root {
fn userWithUsername(username: String) -> FieldResult< Option < User > > {
2018-12-23 14:41:50 -06:00
// Look up user in database...
# unimplemented!()
}
2019-05-07 03:56:06 -05:00
}
2018-12-23 14:41:50 -06:00
# fn main() { }
```
## Mutations
Mutations are _also_ just GraphQL objects. Each mutation is a single field that
usually performs some mutating side-effect, such as updating a database.
```rust
# use juniper::FieldResult;
2019-01-11 10:16:21 -06:00
# #[derive(juniper::GraphQLObject)] struct User { name: String }
2018-12-23 14:41:50 -06:00
struct Mutations;
2019-11-15 19:43:39 -06:00
#[juniper::graphql_object]
2019-05-07 03:56:06 -05:00
impl Mutations {
fn signUpUser(name: String, email: String) -> FieldResult< User > {
2018-12-23 14:41:50 -06:00
// Validate inputs and save user in database...
# unimplemented!()
}
2019-05-07 03:56:06 -05:00
}
2018-12-23 14:41:50 -06:00
# fn main() { }
```
2020-04-17 01:16:00 -05:00
[section]: ../advanced/subscriptions.md
[EmptyMutation]: https://docs.rs/juniper/0.14.2/juniper/struct.EmptyMutation.html
<!-- TODO: Fix This URL when the EmptySubscription become available in the Documentation -->
[EmptySubscription]: https://docs.rs/juniper/0.14.2/juniper/struct.EmptySubscription.html