firebase / firebase-admin-python

Firebase Admin Python SDK
https://firebase.google.com/docs/admin/setup
Apache License 2.0
988 stars 300 forks source link

Querying Firestore documents by nested key-value in an array field using Python #781

Open Vicbi opened 3 months ago

Vicbi commented 3 months ago

Is your feature request related to a problem? Please describe. I'm working with Firestore in Python and have a data query challenge I'm hoping to get some advice on.

My documents in Firestore are structured as follows:

{
  "key1": "value1",
  "key2": {
    "subKey1": [
      {
        "arrayKey1": "arrayValue1",
        "arrayKey2": "arrayValue2"
      },
      {
        "arrayKey3": "arrayValue3",
        "arrayKey4": "arrayValue4"
      }
    ],
    "subKey2": "subValue2"
  }
}

My goal is to query documents where the value of arrayKey1 within the subKey1 array matches a specific value (for example, target_arrayValue1), regardless of the arrayKey2 in the same dictionary.

Here's an example of what my query currently looks like:

docs = query.where(
    filter=FieldFilter(
        "key2.subKey1",
        "array_contains",
        {
            "arrayKey1": "target_arrayValue1",
            "arrayKey2": "arrayValue2"
        }
    )
).stream()

This approach, however, requires a full match of the dictionary, which is not ideal.

Describe the solution you'd like My “ideal” code would do something like this:

docs = query.where(
    filter=FieldFilter(
        "key2.subKey1.0.arrayKey1", 
        "==",
        "target_arrayValue1"
    )
).stream()

Is there an appropriate way to structure my query to achieve this? Any insights or examples would be greatly appreciated! Thanks in advance.

google-oss-bot commented 3 months ago

I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.