Method: projects.databases.documents.runAggregationQuery

string

مطلوب. اسم المورد الرئيسي. بالتنسيق: projects/{projectId}/databases/{databaseId}/documents أو projects/{projectId}/databases/{databaseId}/documents/{document_path}. على سبيل المثال: projects/my-project/databases/my-database/documents أو 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)

هذه السمة اختيارية. سلسلة من التجميعات المطلوب تطبيقها على نتائج structuredQuery.

يتطلب:

• ما لا يقل عن خمس تجميعات أو خمس مجموعات كحد أقصى لكل طلب بحث.

object (StructuredQuery)

استعلام منظم متداخل.

{
  "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

هذه السمة اختيارية. اسم اختياري للحقل لتخزين نتيجة التجميع فيه.

إذا لم يتم توفير الاسم، ستختار Firestore اسمًا تلقائيًا بالتنسيق field_<incremental_id++>. على سبيل المثال:

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 (
  ...
);

يصبح:

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 (
  ...
);

يتطلب:

• يجب أن يكون فريدًا على مستوى جميع الأسماء المستعارة للتجميع.
• يجب الامتثال لقيود document field name.

object (Count)

عدد مجمّع السلع.

object (Sum)

مجمّع السلع.

object (Avg)

متوسط مجمّع السلع.

{
  "upTo": string
}

string (Int64Value format)

هذه السمة اختيارية. قيد اختياري على الحد الأقصى لعدد المستندات المطلوب احتسابها.

يوفر ذلك طريقة لتعيين حد أقصى لعدد المستندات المطلوب مسحها ضوئيًا، والحد من وقت الاستجابة والتكلفة.

ويتم تفسير القيمة "غير محدّد" على أنّها غير مشروطة.

مثال على المستوى العالي:

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

يتطلب:

• يجب أن تكون القيمة أكبر من صفر عند وجودها.

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

object (FieldReference)

الحقل المطلوب تجميعه.

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

object (FieldReference)

الحقل المطلوب تجميعه.

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

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

نتيجة دوال التجميع، مثل: COUNT(*) AS total_docs.

المفتاح هو alias المعيّن لدالة التجميع عند الإدخال، ويساوي حجم هذه الخريطة عدد دوال التجميع في الاستعلام.

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }