Method: projects.databases.documents.runAggregationQuery

string

Bắt buộc. Tên tài nguyên gốc. Theo định dạng: projects/{projectId}/databases/{databaseId}/documents hoặc projects/{projectId}/databases/{databaseId}/documents/{document_path}. Ví dụ: projects/my-project/databases/my-database/documents hoặc projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

{
  "aggregations": [
    {
      object (Aggregation)
    }
  ],

  // Union field query_type can be only one of the following:
  "structuredQuery": {
    object (StructuredQuery)
  }
  // End of list of possible types for union field query_type.
}

object (Aggregation)

Không bắt buộc. Một loạt các phép tổng hợp để áp dụng cho các kết quả của structuredQuery.

Yêu cầu:

• Tối thiểu một và tối đa là năm tổng hợp cho mỗi truy vấn.

object (StructuredQuery)

Truy vấn có cấu trúc lồng nhau.

{
  "alias": string,

  // Union field operator can be only one of the following:
  "count": {
    object (Count)
  },
  "sum": {
    object (Sum)
  },
  "avg": {
    object (Avg)
  }
  // End of list of possible types for union field operator.
}

string

Không bắt buộc. Tên không bắt buộc của trường để lưu trữ kết quả tổng hợp.

Nếu không được cung cấp, Firestore sẽ chọn một tên mặc định theo định dạng field_<incremental_id++>. Ví dụ:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2),
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*)
OVER (
  ...
);

sẽ trở thành:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2) AS field_1,
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*) AS field_2
OVER (
  ...
);

Yêu cầu:

• Phải là duy nhất trên tất cả các bí danh tổng hợp.
• Tuân thủ các giới hạn của document field name.

object (Count)

Tổng hợp dữ liệu.

object (Sum)

Trang web tổng hợp.

object (Avg)

Trang web tổng hợp trung bình.

{
  "upTo": string
}

string (Int64Value format)

Không bắt buộc. Giới hạn tùy chọn về số lượng tài liệu tối đa cần đếm.

Đây là một cách để đặt giới hạn trên cho số lượng tài liệu cần quét, giúp hạn chế độ trễ và chi phí.

Chưa xác định được hiểu là không có ràng buộc.

Ví dụ cấp cao:

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

Yêu cầu:

• Phải lớn hơn 0 khi hiển thị.

{
  "field": {
    object (FieldReference)
  }
}

object (FieldReference)

Trường cần tổng hợp.

{
  "field": {
    object (FieldReference)
  }
}

object (FieldReference)

Trường cần tổng hợp.

{
  "aggregateFields": {
    string: {
      object (Value)
    },
    ...
  }
}

map (key: string, value: object (Value))

Kết quả của các hàm tổng hợp, ví dụ: COUNT(*) AS total_docs.

Khoá là alias được gán cho hàm tổng hợp trên dữ liệu đầu vào và kích thước của tập hợp map này bằng số lượng hàm tổng hợp trong truy vấn.

Đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.