Method: googleapis.firestore.v1.projects.databases.documents.runQuery

Runs a query.

Arguments

Parameters

Parameters
`parent`	`string` Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
`body`	`object (RunQueryRequest)` Required.

parent

string

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

body

object (RunQueryRequest)

Required.

Raised exceptions

Exceptions
`ConnectionError`	In case of a network problem (such as DNS failure or refused connection).
`HttpError`	If the response status is >= 400 (excluding 429 and 503).
`TimeoutError`	If a long-running operation takes longer to finish than the specified timeout limit.
`TypeError`	If an operation or function receives an argument of the wrong type.
`ValueError`	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of RunQueryResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- runQuery:
    call: googleapis.firestore.v1.projects.databases.documents.runQuery
    args:
        parent: ...
        body:
            newTransaction:
                readOnly:
                    readTime: ...
                readWrite:
                    retryTransaction: ...
            readTime: ...
            structuredQuery:
                endAt:
                    before: ...
                    values: ...
                from: ...
                limit: ...
                offset: ...
                orderBy: ...
                select:
                    fields: ...
                startAt: ...
                where:
                    compositeFilter:
                        filters: ...
                        op: ...
                    fieldFilter:
                        field:
                            fieldPath: ...
                        op: ...
                        value:
                            arrayValue:
                                values: ...
                            booleanValue: ...
                            bytesValue: ...
                            doubleValue: ...
                            geoPointValue:
                                latitude: ...
                                longitude: ...
                            integerValue: ...
                            mapValue:
                                fields: ...
                            nullValue: ...
                            referenceValue: ...
                            stringValue: ...
                            timestampValue: ...
                    unaryFilter:
                        field: ...
                        op: ...
            transaction: ...
    result: runQueryResult

JSON

[
  {
    "runQuery": {
      "call": "googleapis.firestore.v1.projects.databases.documents.runQuery",
      "args": {
        "parent": "...",
        "body": {
          "newTransaction": {
            "readOnly": {
              "readTime": "..."
            },
            "readWrite": {
              "retryTransaction": "..."
            }
          },
          "readTime": "...",
          "structuredQuery": {
            "endAt": {
              "before": "...",
              "values": "..."
            },
            "from": "...",
            "limit": "...",
            "offset": "...",
            "orderBy": "...",
            "select": {
              "fields": "..."
            },
            "startAt": "...",
            "where": {
              "compositeFilter": {
                "filters": "...",
                "op": "..."
              },
              "fieldFilter": {
                "field": {
                  "fieldPath": "..."
                },
                "op": "...",
                "value": {
                  "arrayValue": {
                    "values": "..."
                  },
                  "booleanValue": "...",
                  "bytesValue": "...",
                  "doubleValue": "...",
                  "geoPointValue": {
                    "latitude": "...",
                    "longitude": "..."
                  },
                  "integerValue": "...",
                  "mapValue": {
                    "fields": "..."
                  },
                  "nullValue": "...",
                  "referenceValue": "...",
                  "stringValue": "...",
                  "timestampValue": "..."
                }
              },
              "unaryFilter": {
                "field": "...",
                "op": "..."
              }
            }
          },
          "transaction": "..."
        }
      },
      "result": "runQueryResult"
    }
  }
]