Cannot query by document id

[LucasAschenbach]

Apparently, at the moment there is no functioning python client which can filter query results by document id. To my understanding, this should work by simply putting __name__ as field value in any where/order clause like in this example:

from google.cloud import firestore_v1

db = firestore_v1.Client()

# query user data
query = db.collection('users').where(firestore_v1.field_path.FieldPath.document_id(), '==', '...').stream()
dicts = []
for doc in query:
  dicts.append(doc.to_dict())
 
print(dicts)

However, this code will throw the following exception:

__key__ filter value must be a Key

[HemangChothani]

@LucasAschenbach You can also get the document by id like:

doc_ref = db.collection(u'aaa').document(u'bbb')

doc = doc_ref.get()
if doc.exists:
    print(f'Document data: {doc.to_dict()}')
else:
    print(u'No such document!')

@BenWhitehead @crwilcox Any changes from the back-end side, because when fixed FieldPath.document_id() in this PR googleapis/google-cloud-python#8543 it was working fine and now it's also not working with the older versions of firestore.

[LucasAschenbach]

@HemangChothani Yes, however, I need to make an 'in' query for the document id. For this, the only workaround I've come up with so far is to simply add the document id as a separate field to the document.

[BenWhitehead]

I'm not aware of any behavior change in the backend. I wonder if something odd is happening with the query proto being sent to the server?

I'm able to send this query in the java client and get the expected documents in the results

fs.collection("Book")
  .whereIn("__name__", Arrays.asList("0008A256", "11074958", "20221BBF", "3013908C"));

RunQueryRequest proto:

{
  parent: "projects/proj/databases/(default)/documents"
  structured_query {
    from {
      collection_id: "Book"
    }
    where {
      field_filter {
        field {
          field_path: "__name__"
        }
        op: IN
        value {
          array_value {
            values {
              reference_value: "projects/proj/databases/(default)/documents/Book/0008A256"
            }
            values {
              reference_value: "projects/proj/databases/(default)/documents/Book/11074958"
            }
            values {
              reference_value: "projects/proj/databases/(default)/documents/Book/20221BBF"
            }
            values {
              reference_value: "projects/proj/databases/(default)/documents/Book/3013908C"
            }
          }
        }
      }
    }
  }
}

Query Results:

update {
  name: "projects/proj/databases/(default)/documents/Book/0008A256"
  fields {
    key: "author"
    value {
      string_value: "Mozart, Wolfgang Amadeus,"
    }
  }
  fields {
    key: "publishedDate"
    value {
      string_value: "1922."
    }
  }
  fields {
    key: "title"
    value {
      string_value: "Wolfgang Amadeus Mozarts Briefe /"
    }
  }
}
update {
  name: "projects/proj/databases/(default)/documents/Book/11074958"
  fields {
    key: "author"
    value {
      string_value: "Mozart, Wolfgang Amadeus,"
    }
  }
  fields {
    key: "publishedDate"
    value {
      string_value: "1986-1988, p1979-1983."
    }
  }
  fields {
    key: "title"
    value {
      string_value: "The symphonies"
    }
  }
}
update {
  name: "projects/proj/databases/(default)/documents/Book/20221BBF"
  fields {
    key: "author"
    value {
      string_value: "Mozart, Wolfgang Amadeus,"
    }
  }
  fields {
    key: "publishedDate"
    value {
      string_value: "1911."
    }
  }
  fields {
    key: "title"
    value {
      string_value: "The magic flute."
    }
  }
}
update {
  name: "projects/proj/databases/(default)/documents/Book/3013908C"
  fields {
    key: "author"
    value {
      string_value: "Mozart, Wolfgang Amadeus,"
    }
  }
  fields {
    key: "publishedDate"
    value {
      string_value: "1815."
    }
  }
  fields {
    key: "title"
    value {
      string_value: "Le nozze di Figaro, op\303\251ra buffa in quattro atti."
    }
  }
}

[crwilcox]

It seems the type of the right hand side of the filter isn't a match. Our tests look like

query = db.collection('users').where(firestore_v1.field_path.FieldPath.document_id(), '==', db.document( 'users/...').stream()

When I run your code with that change the error goes away and I am able to retrieve documents matching the where clause.

>>> query = db.collection('users').where(firestore_v1.field_path.FieldPath.document_id(), '>=', db.document('users/afifth')).stream()
>>> for doc in query:
...   dicts.append(doc.to_dict())
...
>>> dicts
[{'first': 'Ada', 'born': 1815, 'last': 'lovelace'}, {'last': 'FourthLovelace', 'first': 'Ada', 'born': 1815}, {'first': 'Ada', 'last': 'Lovelace', 'born': 1815}, {'last': 'SecondLovelace', 'born': 1815, 'first': 'Ada'}, {'first': 'Ada', 'born': 1815, 'last': 'ThirdLovelace'}]

[HemangChothani]

@LucasAschenbach Closing this issue as an example give above is working perfectly fine.

[LucasAschenbach]

Yes, the query in my project works now, thanks!

Is there any reason why the python client implements this so differently from all the other clients? The chosen syntax seems unnecessarily complicated.

[LaughDonor]

I'm in the same boat here. We should be able to pass in the document_id(s) as value instead of a DocumentReference (or list of DocumentReferences) to make this work like other clients.

The issue only occurs when executing the query via. .get() or .stream().