Cloud Firestore API (firestore:v1)

2022-04-07

1 new method

Additions

    Methods
  • firestore.projects.databases.documents.runAggregationQuery

      Description: Runs an aggregation query. Rather than producing Document results like Firestore.RunQuery, this API allows running an aggregation to produce a series of AggregationResult server-side. High-Level Example: ``` -- Return the number of documents in table given a filter. SELECT COUNT(*) FROM ( SELECT * FROM k where a = true ); ```

      HTTP Method: POST

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/datastore
    • Flat Path: v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runAggregationQuery

      Parameters:

        parent

          Description: 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`

          Location: path

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$

      Parameter Order: parent

      Path: v1/{+parent}:runAggregationQuery