graphql-php/docs/how-it-works.md

36 lines
1.3 KiB
Markdown
Raw Normal View History

2017-08-17 16:35:58 +03:00
# Overview
Following reading describes implementation details of query execution process. It may clarify some
internals of GraphQL runtime but is not required to use it.
# Parsing
TODOC
# Validating
TODOC
# Executing
TODOC
# Errors explained
There are 3 types of errors in GraphQL:
- **Syntax**: query has invalid syntax and could not be parsed;
- **Validation**: query is incompatible with type system (e.g. unknown field is requested);
- **Execution**: occurs when some field resolver throws (or returns unexpected value).
2017-08-20 18:10:37 +03:00
Obviously, when **Syntax** or **Validation** error is detected - the process is interrupted and
the query is not executed.
2017-08-17 16:35:58 +03:00
2017-08-20 18:10:37 +03:00
Execution process never throws exceptions. Instead, all errors are caught and collected in
execution result.
2017-08-17 16:35:58 +03:00
GraphQL is forgiving to **Execution** errors which occur in resolvers of nullable fields.
If such field throws or returns unexpected value the value of the field in response will be simply
2017-08-20 18:10:37 +03:00
replaced with **null** and error entry will be registered.
2017-08-17 16:35:58 +03:00
2017-08-20 18:10:37 +03:00
If an exception is thrown in the non-null field - error bubbles up to the first nullable field.
This nullable field is replaced with **null** and error entry is added to the result.
If all fields up to the root are non-null - **data** entry will be removed from the result
and only **errors** key will be presented.