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
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,24 +43,28 @@ and Nicholas Schrock (@schrockn) from [Facebook](https://www.facebook.com/), the
43
43
44
44
## Features
45
45
46
+
Vert.x `DataLoader` is a feature-complete port of the Facebook reference implementation with [one major difference](#manual-dispatching). These features are:
47
+
46
48
- Simple, intuitive API, using generics and fluent coding
47
49
- Define batch load function with lambda expression
48
50
- Schedule a load request in queue for batching
49
51
- Add load requests from anywhere in code
50
52
- Request returns [`Future<V>`](http://vertx.io/docs/apidocs/io/vertx/core/Future.html) of requested value
51
53
- Can create multiple requests at once, returns [`CompositeFuture`](http://vertx.io/docs/apidocs/io/vertx/core/CompositeFuture.html)
52
54
- Caches load requests, so data is only fetched once
53
-
- Can clear individual cache keys, so data is fetched on next load request dispatch
55
+
- Can clear individual cache keys, so data is fetched on next batch queue dispatch
54
56
- Can prime the cache with key/values, to avoid data being fetched needlessly
55
57
- Can configure cache key function with lambda expression to extract cache key from complex data loader key types
56
-
- Dispatch load request queue when batch is prepared, returns `CompositeFuture`
57
-
- Individual batch futures complete as batch is processed
58
+
- Dispatch load request queue after batch is prepared, also returns [`CompositeFuture`](http://vertx.io/docs/apidocs/io/vertx/core/CompositeFuture.html)
59
+
- Individual batch futures complete / resolve as batch is processed
58
60
-`CompositeFuture`s results are ordered according to insertion order of load requests
59
61
- Deals with partial errors when a batch future fails
60
62
- Can disable batching and/or caching in configuration
61
63
- 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
62
64
- Has very high test coverage (see [Acknowledgements](#acknowlegdements))
63
65
66
+
Then Vert.x `DataLoader` has some very interesting [Additional features](#additional-features) that result from it being based on Vert.x
67
+
64
68
## Differences to reference implementation
65
69
66
70
### Manual dispatching
@@ -100,7 +104,8 @@ and some other optional features that ensure all load requests eventually comple
100
104
### Additional features
101
105
102
106
- Initial release is a feature-complete port of the reference implementation (only change being [Manual dispatching](#manual-dispatching)).
103
-
- See [Project plans](#project-plans) for upcoming features and ideas.
107
+
- 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.
108
+
- See [Project plans](#project-plans) for [upcoming features](#upcoming-features) and [future ideas](#future-ideas).
0 commit comments