How to query documents using "_id" field in Java mongodb driver?

Question

I am trying to find documents in MongoDB by searching on "_id" key. My document looks like this-

{
  "_id" : ObjectId("4f693d40e4b04cde19f17205"),
  "hostname" : "hostnameGoesHere",
  "OSType" : "OSTypeGoesHere"
}

I am trying to search this document as-

ObjectId id= new ObjectId("4f693d40e4b04cde19f17205");        
BasicDBObject obj = new BasicDBObject();        
obj.append("_id", id);        
BasicDBObject query = new BasicDBObject();        
query.putAll(query);

But I get below error-

error: reference to putAll is ambiguous, both method putAll(Map) in BasicBSONObject and method putAll(BSONObject) in BasicBSONObject match
        query.putAll(query);

The append method of BasicDBObject supports (String Key, Value) and if I pass "_id" as String to this method, no documents are matched.

So my question is how do I pass "_id"?

score 70 · Answer 1 · edited Jul 12 '17 at 10:20

70

Not sure if others might be searching for answers on this topic, but here is the easiest way to search for a MongoDB record based on "_id". The MongoDB documentation is not updated and still shows ObjectId as being part of the com.mongodb package (it also generally does not give a lot of information on searching by ObjectId).

import org.bson.types.ObjectId;

public DBObject findDocumentById(String id) {

    BasicDBObject query = new BasicDBObject();
    query.put("_id", new ObjectId(id));

    DBObject dbObj = collection.findOne(query);
    return dbObj;
}

edited Jul 12 '17 at 10:20

Andrii Abramov

10,019
9
74
96

answered Oct 08 '12 at 20:09

Chris

727
5
7

Is it outdated? – Stu_Dent Oct 11 '20 at 11:55

score 32 · Answer 2 · answered Nov 09 '17 at 10:57

32

For those who are seeking a more up to date method, especially with 3.4:

import com.mongodb.client.MongoCollection;
import com.mongodb.client.MongoDatabase;
import org.bson.Document;
import org.bson.types.ObjectId;

import static com.mongodb.client.model.Filters.eq;

//......
MongoCollection<Document> myCollection = database.getCollection("myCollection");
Document document = myCollection.find(eq("_id", new ObjectId("4f693d40e4b04cde19f17205"))).first();
if (document == null) {
    //Document does not exist
} else {
    //We found the document
}

answered Nov 09 '17 at 10:57

bogolyandras

418
4
7

can we use findOne here? – neoexpert Apr 09 '19 at 19:24
I don't think that we can use that method anymore. That was part of the old API http://api.mongodb.com/java/2.14/com/mongodb/DBCollection.html The new is a slightly different one http://api.mongodb.com/java/3.0/com/mongodb/async/client/MongoCollection.html – bogolyandras Apr 10 '19 at 09:31
1

the eq is not applicable to 3.12? – Stu_Dent Oct 11 '20 at 11:55

score 6 · Answer 3 · edited Jul 12 '16 at 10:09

6

You can do this

 ObjectId id= new ObjectId("4f693d40e4b04cde19f17205");        
    BasicDBObject obj = new BasicDBObject();        
    obj.append("_id", id);        
    BasicDBObject query = new BasicDBObject();        
    query.putAll((BSONObject)query);

edited Jul 12 '16 at 10:09

Rich Benner

7,873
9
33
39

answered Jul 12 '16 at 09:53

Nifras Nipy

101
1
3

score 1 · Accepted Answer · edited Jul 12 '17 at 10:20

1

Solved it by using query as-

query.putAll((BSONObject)query);

edited Jul 12 '17 at 10:20

Andrii Abramov

10,019
9
74
96

answered Mar 21 '12 at 03:01

user837208

2,487
7
37
54

score 0 · Answer 5 · answered Sep 12 '22 at 14:39

The more simple way to do this is:

Bson filter = Filters.eq("_id", new ObjectId("4f693d40e4b04cde19f17205"));
mongoConfig.getMongoTemplate().getCollection("myCollection").find(filter);

Reference here: https://www.baeldung.com/mongodb-query-documents-id

score 0 · Answer 6 · edited Sep 30 '22 at 00:20

I found a way around, with a little bit more of code, requires a string representing the id to be found passed as argument.

import com.mongodb.client.MongoDatabase;
import com.mongodb.client.MongoClient;
import com.mongodb.client.MongoClients;
import com.mongodb.client.MongoCollection;
import com.mongodb.client.model.Filters;
import org.bson.conversions.Bson;
import org.bson.Document;
import org.bson.types.ObjectId;   

[...]

public static void findCustomerById(String id) {
    try (MongoClient mongoClient = MongoClients.create("mongodb://localhost:27017")) {
        MongoDatabase database = mongoClient.getDatabase("database_name");
        Bson filter = Filters.eq("_id", new ObjectId(id));
        MongoCollection<Document> collection = database.getCollection("customer");

        //Tries to find the document
        Document doc = collection. Find(filter).first();
        //prints the document
        System.out.println(doc.toJson());
    } catch (Exception e) {
        System.out.println("Error finding document");
        System.out.println("Error in: " + e.getMessage());
        e.printStackTrace();
    }

score 0 · Answer 7 · answered May 17 '23 at 13:37

0

Don't forget to add the collectionName parameter if your class and collectionName don't match. I landed on this question because my _id query wasn't working even though it looked good at first blush.

answered May 17 '23 at 13:37

Michael

1,177
15
15

score -2 · Answer 8 · edited Jul 08 '20 at 13:37

-2

You can try this snippet:

ObjectId id= new ObjectId("4f693d40e4b04cde19f17205");        
BasicDBObject obj = new BasicDBObject();        
obj.append("_id", id);        
BasicDBObject query = new BasicDBObject();        
query.putAll((BSONObject)obj);

edited Jul 08 '20 at 13:37

Shabbir Hussain

2,600
2
17
25

answered Jul 08 '20 at 11:13

Srushti Maladkar

1

How is this different from [Nifras Nipy's answer](https://stackoverflow.com/a/38325486/14732669)? – ray Sep 12 '22 at 17:19

How to query documents using "_id" field in Java mongodb driver?

8 Answers8

Linked

Related