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의 결과에 적용할 일련의 집계입니다.

요구사항:

• 쿼리당 집계는 최소 1개에서 최대 5개입니다.

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

요구사항:

• 0보다 커야 합니다(있는 경우).

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