yume/juniper
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update schemas_and_mutations.md

Browse source
This commit is contained in:
Christian Legnitto 2020-07-14 20:45:42 -10:00 • committed by GitHub
parent 480eda9846
commit 8c3857d772
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 12 deletions

20
docs/book/content/schema/schemas_and_mutations.md
View file

@ -8,22 +8,18 @@ These three define the root query fields, mutations and subscriptions of the sch
The usage of subscriptions is a little different from the mutation and query objects, so there is a specific [section][section] that discusses them. The usage of subscriptions is a little different from the mutation and query objects, so there is a specific [section][section] that discusses them.
Both query and mutation objects are regular GraphQL objects, defined like any Both query and mutation objects are regular GraphQL objects, defined like any
other object in Juniper. The mutation and subscription object, however, is optional since schemas other object in Juniper. The mutation and subscription objects, however, are 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]. can be read-only and do not require subscriptions. If mutation/subscription functionality is not needed, consider using [EmptyMutation][EmptyMutation]/[EmptySubscription][EmptySubscription].
In Juniper, the `RootNode` type represents a schema. You usually don't have to In Juniper, the `RootNode` type represents a schema. When the schema is first created,
create this object yourself: see the framework integrations for [Iron](../servers/iron.md) Juniper will traverse the entire object graph
and [Rocket](../servers/rocket.md) how schemas are created together with the handlers
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 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. object somewhere but never reference it, it will not be exposed in a schema.
## The query root ## The query root
The query root is just a GraphQL object. You define it like any other GraphQL The query root is just a GraphQL object. You define it like any other GraphQL
object in Juniper, most commonly using the `object` proc macro: object in Juniper, most commonly using the `graphql_object` proc macro:
```rust ```rust
# use juniper::FieldResult; # use juniper::FieldResult;
@ -43,8 +39,8 @@ impl Root {
## Mutations ## Mutations
Mutations are _also_ just GraphQL objects. Each mutation is a single field that Mutations are _also_ just GraphQL objects. Each mutation is a single field
usually performs some mutating side-effect, such as updating a database. that performs some mutating side-effect such as updating a database.
```rust ```rust
# use juniper::FieldResult; # use juniper::FieldResult;