Clarify the dataloader integration (#1076)

absinthe-graphql · Jun 13, 2021 · fe02d15 · fe02d15
1 parent 6269157
commit fe02d15
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/guides/batching.md b/guides/batching.md
@@ -171,6 +171,11 @@ defmodule MyApp.Blog do
 end
 ```
 
+In this example, the query returned by `query/2` is used as a starting point by Dataloader to build the final query, which it does by traversing schema associations.
+In other words, Dataloader can determine that an author has many posts, and that to retrieve posts it needs to get those with the relevant `author_id`.
+If that's sufficient for your needs, `query/2` need not modify the query it's given.
+But if you only want to load published posts, `query/2` can narrow the query accordingly.
+
 When integrating Dataloader with GraphQL, we want to place it in our context so
 that we can access it in our resolvers. In your schema module add:
 

diff --git a/guides/dataloader.md b/guides/dataloader.md
@@ -50,6 +50,11 @@ defmodule MyApp.Blog do
 end
 ```
 
+In this example, the query returned by `query/2` is used as a starting point by Dataloader to build the final query, which it does by traversing schema associations.
+In other words, Dataloader can determine that an author has many posts, and that to retrieve posts it needs to get those with the relevant `author_id`.
+If that's sufficient for your needs, `query/2` need not modify the query it's given.
+But if you only want to load published posts, `query/2` can narrow the query accordingly.
+
 When integrating Dataloader with GraphQL, we want to place it in our context so
 that we can access it in our resolvers. In your schema module add: