MongoTemplate upsert - easy way to make Update from pojo (which user has editted)?

Question

Here is a simple pojo:

public class Description {
    private String code;
    private String name;
    private String norwegian;
    private String english;
}

And please see the following code to apply an upsert to MongoDb via spring MongoTemplate:

Query query = new Query(Criteria.where("code").is(description.getCode()));
Update update = new Update().set("name", description.getName()).set("norwegian", description.getNorwegian()).set("english", description.getEnglish());
mongoTemplate.upsert(query, update, "descriptions");

The line to generate the Update object specifies every field of the Item class manually.

But if my Item object changes then my Dao layer breaks.

So is there a way to avoid doing this, so that all fields from my Item class are applied automatically to the update?

E.g.

Update update = new Update().fromObject(item);

Note that my pojo does not extend DBObject.

PaniniGelato · Answer 1 · 2016-04-14T08:44:05.473

I found a pretty good solution for this question

//make a new description here
Description d = new Description();
d.setCode("no");
d.setName("norwegian");
d.setNorwegian("norwegian");
d.setEnglish("english");

//build query
Query query = new Query(Criteria.where("code").is(description.getCode()));

//build update
DBObject dbDoc = new BasicDBObject();
mongoTemplate.getConverter().write(d, dbDoc); //it is the one spring use for convertions.
Update update = Update.fromDBObject(dbDoc);

//run it!
mongoTemplate.upsert(query, update, "descriptions");

Plz note that Update.fromDBObject return an update object with all fields in dbDoc. If you just want to update non-null fields, you should code a new method to exclude null fields.

For example, the front-end post a doc like below:

//make a new description here
Description d = new Description();
d.setCode("no");
d.setEnglish("norwegian");

We only need to update the field 'language':

//return Update object
public static Update fromDBObjectExcludeNullFields(DBObject object) {
    Update update = new Update();       
    for (String key : object.keySet()) {
        Object value = object.get(key);
        if(value!=null){
            update.set(key, value);
        }
    }
    return update;
}

//build udpate
Update update = fromDBObjectExcludeNullFields(dbDoc);

@starkk92 plz note that Update.fromDBObject will replace all fields in dbDoc. If u just want to create Update with non-null fields, u have to code it yourself. — PaniniGelato, Apr 14 '16 at 08:32
OK for the answer, but this also sets null objects. If you don't want null objects to be updated, you have to include an ObjectMapper with the option to ignore inlcudes. This is @gogstad comment on Vivek Sethi's answer. Thanks by the way. — javadev, Mar 01 '17 at 10:16

score 15 · Answer 2 · answered Jul 09 '18 at 08:31

15

The solution for a new spring-data-mongodb version 2.X.X.

The API has evolved, since 2.X.X version there is:

Update.fromDocument(org.bson.Document object, String... exclude)

instead of (1.X.X):

Update.fromDBObject(com.mongodb.DBObject object, String... exclude)

The full solution:

//make a new description here
Description d = new Description();
d.setCode("no");
d.setName("norwegian");
d.setNorwegian("norwegian");
d.setEnglish("english");
Query query = new Query(Criteria.where("code").is(description.getCode()));

Document doc = new Document(); // org.bson.Document
mongoTemplate.getConverter().write(item, doc);
Update update = Update.fromDocument(doc);

mongoTemplate.upsert(query, update, "descriptions");

It works!

answered Jul 09 '18 at 08:31

Dawid Naczke

1,144
12
11

1

why does this fail to work for BulkOperations any idea here is a snippet of my code https://pastebin.com/t0mZDZd8 java.lang.IllegalArgumentException: Invalid BSON field name code – madcolonel10 Oct 01 '19 at 10:42
@madcolonel10 did you find any solution to this? I have the same problem. – chris115379 Nov 12 '19 at 08:17
@chris115379 check if this helps https://pastebin.com/LxEPym3S – madcolonel10 Nov 13 '19 at 11:17

score 6 · Answer 3 · edited Dec 22 '15 at 10:57

6

you can use save : (if non exist = insert else = upsert)

save(Object objectToSave, String collectionName)

read : javadoc

edited Dec 22 '15 at 10:57

JSK NS

3,346
2
25
42

answered Oct 07 '14 at 08:34

Nimrod007

9,825
8
48
71

score 6 · Answer 4 · answered Nov 27 '19 at 09:27

6

Just like previous answers said, use mongoTemplate.getConverter().write() and Update.fromDocument() functions. But i found Update.fromDocument() won't add "$set" key and won't work directly, the solution is to add "$set" yourself, like below (PS: I'm using 2.2.1.RELEASE version):

public static Update updateFromObject(Object object, MongoTemplate mongoTemplate) {
    Document doc = new Document();
    mongoTemplate.getConverter().write(object, doc);
    return Update.fromDocument(new Document("$set", doc));
}

answered Nov 27 '19 at 09:27

arthurdai

71
1
2

As surprising as it looks, this solutions helps us out ! Why would we have to manually add the $set key to the update definition ? – gfyhser Dec 28 '21 at 20:55
1

@gfyhser Because not all updates are using "$set", so it makes sense to let the user to add it if needed. – arthurdai Apr 17 '22 at 10:20
Thanks. Helped me to get difference between UPDATED and ALREADY_UPDATED – antonmarin Sep 06 '22 at 09:45

score 3 · Answer 5 · answered Sep 02 '16 at 10:41

If you want to upsert Pojos incl. property String id; you have to exclude the _id field in the fromDBObject method Update.fromDBObject(dbDoc,"_id").

Otherwise you get the Exception:

org.springframework.dao.DuplicateKeyException: { "serverUsed" : "127.0.0.1:27017" , "ok" : 1 , "n" : 0 , "updatedExisting" : false , "err" : "E11000 duplicate key error collection: db.description index: _id_ dup key: { : null }" , "code" : 11000}; nested exception is com.mongodb.MongoException$DuplicateKey: { "serverUsed" : "127.0.0.1:27017" , "ok" : 1 , "n" : 0 , "updatedExisting" : false , "err" : "E11000 duplicate key error collection: db.description index: _id_ dup key: { : null }" , "code" : 11000}

because the _id field of the first is null

{
    "_id" : null,
...

}

Fullcode based on @PaniniGelato answer would be

public class Description(){
    public String id;
...
}

Description d = new Description();
d.setCode("no");
d.setName("norwegian");
d.setNorwegian("norwegian");
d.setEnglish("english");

//build query
Query query = new Query(Criteria.where("code").is(description.getCode()));

//build update
DBObject dbDoc = new BasicDBObject();
mongoTemplate.getConverter().write(d, dbDoc); //it is the one spring use for convertions.
Update update = Update.fromDBObject(dbDoc, "_id");

//run it!
mongoTemplate.upsert(query, update, "descriptions");

Then the upsert is working in the cases of insert and update. Corrections & thoughts are welcome ;)

caveat: If you are using a `@Version` - tagged field in your entity, this approach will interfere with spring's version incrementation, producing an exception "Invalid BSON field name $inc". In this case, one must iterate over the dbDoc and use `update.set` like in @PaniniGelatos answer. — Mr.Radar, Mar 20 '17 at 18:32

score 1 · Answer 6 · answered Aug 06 '15 at 16:23

This is what I am doing for the time being. Not so much elegant way to do it, but it does save a precious DB call:

import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.query.Query;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.mongodb.BasicDBObject;
import com.mongodb.DB;
import com.mongodb.DBCollection;
import com.mongodb.DBObject;
import com.mongodb.util.JSON;

/**
 * Perform an upsert operation to update ALL FIELDS in an object using native mongo driver's methods
 * since mongoTemplate's upsert method doesn't allow it
 * @param upsertQuery
 * @param object
 * @param collectionName
 */
private void performUpsert(Query upsertQuery, Object object, String collectionName){

    ObjectMapper mapper = new ObjectMapper();

    try {
        String jsonStr = mapper.writeValueAsString(object);
        DB db = mongoTemplate.getDb();
        DBCollection collection = db.getCollection(collectionName);
        DBObject query = upsertQuery.getQueryObject();
        DBObject update = new BasicDBObject("$set", JSON.parse(jsonStr));
        collection.update(query, update, true, false);
    } catch (IOException e) {
        LOGGER.error("Unable to persist the metrics in DB. Error while parsing object: {}", e);
    }
}

You need to make sure the `ObjectMapper` doesn't serialize nulls: `String jsonStr = objectMapper.copy().setSerializationInclusion(JsonInclude.Include.NON_NULL).writeValueAsString(object);` — gogstad, Apr 22 '16 at 12:18

score 1 · Answer 7 · answered Dec 26 '16 at 20:42

There are two cases here that need to be distinguished:

Update an item that was previously fetched from the DB.
Update or insert (upsert) an item you created by code.

In Case 1) You can simply use mongoTemplate.save(pojo, "collection"), because your POJO will already have a filled ObjectID in its id field.

In case 2) You have to explain to mongo what "already exists" means in case of your domain model: By default the mongoTemplate.save() method updates an existing item, if there is one with that same ObjectId. But with a newly instantiated POJO you do not have that id. Therefore the mongoTemplate.upsert() method has a query parameter that you can create like this:

MyDomainClass pojo = new MyDomainClass(...);

Query query = Query.query(Criteria.where("email").is("user1@domain.com"));

DBObject dbDoc = new BasicDBObject();
mongoTemplate.getConverter().write(pojo, dbDoc);   //it is the one spring use for convertions.
dbDoc.removeField("_id");    // just to be sure to not create any duplicates
Update update = Update.fromDBObject(dbDoc);

WriteResult writeResult = mongoTemplate.upsert(query, update, UserModel.class);

score 0 · Accepted Answer · answered Mar 05 '14 at 23:51

I ran into the same problem. In het current Spring Data MongoDB version no such thing is available. You have to update the seperate fields by hand.

However it is possible with another framework: Morphia.

This framework has a wrapper for DAO functionality: https://github.com/mongodb/morphia/wiki/DAOSupport

You can use the DAO API to do things like this:

SomePojo pojo = daoInstance.findOne("some-field", "some-value");
pojo.setAProperty("changing this property");
daoInstance.save(pojo);

score 0 · Answer 9 · answered May 14 '14 at 09:44

0

I think that: Description add a property

@Id
private String id;

then get a document by the query condition,set Description's id by document's id. and save

answered May 14 '14 at 09:44

stoneHah

63
1
7

score 0 · Answer 10 · answered Jun 07 '16 at 01:10

0

Just use ReflectionDBObject - if you make Description extend it, you should just get your object's fields transferred to Update reflectively, automagically. The note from above about null fields included in the update still holds true.

answered Jun 07 '16 at 01:10

V. F.

1

score 0 · Answer 11 · answered Mar 22 '18 at 17:50

public void saveOrUpdate(String json) {
    try {
        JSONObject jsonObject = new JSONObject(json);
        DBObject update1 = new BasicDBObject("$set", JSON.parse(json));
        mongoTemplate.getCollection("collectionName").update(new Query(Criteria.where("name").is(jsonObject.getString("name"))).getQueryObject(), update1, true, false);
    } catch (Exception e) {
        throw new GenericServiceException("Error while save/udpate. Error msg: " + e.getMessage(), e);
    }

}

this is very simple way to save json string into collection using mongodb and spring. This method can be override to use as JSONObject.

score -1 · Answer 12 · answered Oct 30 '18 at 12:00

-1

@Override
public void updateInfo(UpdateObject algorithm) {
    Document document = new Document();
    mongoTemplate.getConverter().write(algorithm, document);
    Update update = Update.fromDocument(document);
    mongoTemplate.updateFirst(query(where("_id").is(algorithm.get_id())), update, UpdateObject.class);
}

answered Oct 30 '18 at 12:00

字云龙

11
1

1

Code only answers are really discouraged. To help future readers, please explain what you are doing too! – itsmysterybox Oct 30 '18 at 12:16

score -1 · Answer 13 · answered Oct 31 '22 at 06:44

-1

After upsert, I was Tring to fetch same record but it was given me the old one.

But in dB I am having new records.

answered Oct 31 '22 at 06:44

virat suresh

1

Can someone help me with this. – virat suresh Oct 31 '22 at 06:45
If you have a new question, please ask it by clicking the [Ask Question](https://stackoverflow.com/questions/ask) button. Include a link to this question if it helps provide context. - [From Review](/review/late-answers/33068793) – teik Nov 03 '22 at 03:42

MongoTemplate upsert - easy way to make Update from pojo (which user has editted)?

13 Answers13

Linked