You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-20Lines changed: 8 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ An important use case for `DataLoader` is improving the efficiency of GraphQL qu
15
15
many other use cases where you can benefit from using this utility.
16
16
17
17
Most of the code is ported directly from Facebook's reference implementation, with one IMPORTANT adaptation to make
18
-
it work for Java 8 and Vert.x. ([Find more on this in the paragraphs below]).
18
+
it work for Java 8 and Vert.x. ([more on this below](manual-dispatching)).
19
19
20
20
But before reading on, be sure to take a short dive into the
21
21
[original documentation](https://github.com/facebook/dataloader/blob/master/README.md) provided by Lee Byron (@leebyron)
@@ -26,14 +26,12 @@ and Nicholas Schrock (@schrockn) from [Facebook](https://www.facebook.com/), the
26
26
-[Features](#features)
27
27
-[Differences to reference implementation](#differences-to-reference-implementation)
28
28
-[Manual dispatching](#manual-dispatching)
29
-
-[Additional features!](#additional-features)
30
29
-[Let's get started!](#lets-get-started)
31
30
-[Installing](#installing)
32
31
-[Building](#building)
33
32
-[Project plans](#project-plans)
34
33
-[Current releases](#current-releases)
35
34
-[Known issues](#known-issues)
36
-
-[Upcoming features](#upcoming-features)
37
35
-[Future ideas](#future-ideas)
38
36
-[Other information sources](#other-information-sources)
39
37
-[Contributing](#contributing)
@@ -62,8 +60,6 @@ Vert.x `DataLoader` is a feature-complete port of the Facebook reference impleme
62
60
- Can supply your own [`CacheMap<K, V>`](https://github.com/engagingspaces/vertx-dataloader/blob/master/src/main/java/io/engagingspaces/vertx/dataloader/CacheMap.java) implementations
63
61
- Has very high test coverage (see [Acknowledgements](#acknowlegdements))
64
62
65
-
Then Vert.x `DataLoader` has some very interesting [Additional features](#additional-features) that result from it being based on Vert.x
66
-
67
63
## Differences to reference implementation
68
64
69
65
### Manual dispatching
@@ -97,15 +93,6 @@ and there are also gains to this different mode of operation:
97
93
However, with batch execution control comes responsibility! If you forget to make the call to `dispatch()` then the futures
98
94
in the load request queue will never be batched, and thus _will never complete_! So be careful when crafting your loader designs.
99
95
100
-
**Note**: In future releases the danger of not invoking dispatch will be greatly diminished. There will be an optional dispatch timeout,
101
-
and some other optional features that ensure all load requests eventually complete. See [Project plans](#project-plans) for upcoming features and ideas.
102
-
103
-
### Additional features
104
-
105
-
- Initial release is a feature-complete port of the reference implementation (only change being [Manual dispatching](#manual-dispatching)).
106
-
- Sorry, no additional features yet :flushed:, but this is where _you_:hand: come into the picture: By giving your [feedback](https://github.com/vertx-dataloader/issues) and [contribute](#contributing)! You are most welcome.
107
-
- See [Project plans](#project-plans) for [upcoming features](#upcoming-features) and [future ideas](#future-ideas).
0 commit comments