DATAMONGO-1563 - Add fluent alternative for MongoOperations. #466
Conversation
We now provide an alternative API for MongoOperations that allows defining operations in a more fluent way. This reduces the number of methods and strips down the interface to a minimum while offering a more readable API.
// find all with filter query and projecting return type
template.query(Person.class)
.matching(query(where("firstname").is("luke")))
.as(Jedi.class)
.all();
// update with filter & upsert
template.update(Person.class)
.apply(new Update().set("firstname", "Han"))
.matching(query(where("id").is("han-solo")))
.upsert();
// remove all matching
template.remove(Jedi.class)
.inCollection(STAR_WARS)
.matching(query(where("name").is("luke")))
.all();
// aggregate
template.aggregateAndReturn(Jedi.class)
.inCollection("star-wars)
.by(newAggregation(project("name")))
.get();
| * | ||
| * @param <T> | ||
| */ | ||
| interface AggregateOperationBuilderTerminatingOperations<T> { |
There was a problem hiding this comment.
How about just AggregationOperations?
There was a problem hiding this comment.
had some back and forth on the names, generally it turned out that we already have similar named components for quite a few of the ones introduced here. So there'd already be AggregationOperation. I do see the point that for having eg. an instance var AggregateOperationBuilderTerminatingOperations findAllInStarWars; does not read nice compared to AggregationOperation findAllInStarWars;. Bottom line,
I'm really open for better naming as long as we can keep it consistent across the interfaces for this feature.
| * | ||
| * @return | ||
| */ | ||
| CloseableIterator<T> stream(); |
There was a problem hiding this comment.
I'm a bit torn on CloseableIterator. Streamable doesn't seem to be the right interface here because we expect an executed statement, which is Iterator. Iterator to Java 8 Stream adoption is sort of cumbersome and I wonder whether there might be an interface from our side that is Closeable and able to return a Stream
There was a problem hiding this comment.
The main goal here was to provide users with an alternative way of interacting with MongoOperations therefore I'd not surprise them with different return types for pretty much the same operation.
| * @return | ||
| * @throws IllegalArgumentException if resultType is {@literal null}. | ||
| */ | ||
| <T1> WithQueryBuilder<T1> as(Class<T1> resultType); |
There was a problem hiding this comment.
Minor: How about R instead of T1? (R -> Result)
There was a problem hiding this comment.
👍 , even @param in JavaDoc does not match <T1>.
Javadoc, rename RemoveOperationBuilderTerminatingOperations methods to DeleteResult remove() and List findAndRemove (was: all/allAndReturn). Add missing diamonds where necessary. Use lombok where appropriate.
|
|
||
| FindIterable<Document> target = delegate.prepare(cursor); | ||
|
|
||
| if (limit.isPresent()) { |
There was a problem hiding this comment.
Rather return limit.map(it -> target.limit(it)).orElse(target)?
|
I am very interested in leveraging this API in https://github.com/mixitconf/mixit, let me know when available in master (I can update DATAMONGO-1689 to add Kotlin extensions for this new API). |
…ntation. Get rid of 'Builder' within the fluent API interface names. Roll back method rename all() -> remove() -> all() in TerminatingRemoveOperation and fix position of collection name override in UpdateOperation which lead to a restructured operation flow.
We now provide an alternative API for MongoOperations that allows defining operations in a fluent way. FluentMongoOperations reduces the number of methods and strips down the interface to a minimum while offering a more readable API.
// find all with filter query and projecting return type
template.query(Person.class)
.matching(query(where("firstname").is("luke")))
.as(Jedi.class)
.all();
// insert
template.insert(Person.class)
.inCollection(STAR_WARS)
.one(luke);
// update with filter & upsert
template.update(Person.class)
.apply(new Update().set("firstname", "Han"))
.matching(query(where("id").is("han-solo")))
.upsert();
// remove all matching
template.remove(Jedi.class)
.inCollection(STAR_WARS)
.matching(query(where("name").is("luke")))
.all();
// aggregate
template.aggregateAndReturn(Jedi.class)
.inCollection("star-wars)
.by(newAggregation(project("name")))
.all();
Original pull request: #466.
Rename TerminatingAggregationOperation.get() to TerminatingAggregationOperation.all() to name methods consistently. Extract collection name retrieval to method. Javadoc, formatting, add generics where required/use diamond syntax where applicable. Original pull request: #466.
|
That's merged and polished now. |
We now provide an alternative API for
MongoOperationsthat allows defining operations in a more fluent way. This reduces the number of methods and strips down the interface to a minimum while offering a more readable API.