Cloud Firestore V1 Client - Class Aggregation (1.47.1)

Reference documentation and code samples for the Cloud Firestore V1 Client class Aggregation.

Defines an aggregation that produces a single result.

Generated from protobuf message google.firestore.v1.StructuredAggregationQuery.Aggregation

Namespace

Google \ Cloud \ Firestore \ V1 \ StructuredAggregationQuery

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ count`	`Aggregation\Count` Count aggregator.
`↳ sum`	`Aggregation\Sum` Sum aggregator.
`↳ avg`	`Aggregation\Avg` Average aggregator.
`↳ alias`	`string` Optional. Optional name of the field to store the result of the aggregation into. If not provided, Firestore will pick a default name following the format `field_<incremental_id++>`. For example: `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 ( ... );` becomes: `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 ( ... );` Requires: * * Must be unique across all aggregation aliases. * * Conform to document field name limitations.

getCount

Count aggregator.

Returns
Type	Description
`Aggregation\Count\|null`

hasCount

setCount

Count aggregator.

Parameter
Name	Description
`var`	`Aggregation\Count`

Returns
Type	Description
`$this`

getSum

Sum aggregator.

Returns
Type	Description
`Aggregation\Sum\|null`

hasSum

setSum

Sum aggregator.

Parameter
Name	Description
`var`	`Aggregation\Sum`

Returns
Type	Description
`$this`

getAvg

Average aggregator.

Returns
Type	Description
`Aggregation\Avg\|null`

hasAvg

setAvg

Average aggregator.

Parameter
Name	Description
`var`	`Aggregation\Avg`

Returns
Type	Description
`$this`

getAlias

Optional. Optional name of the field to store the result of the aggregation into.

If not provided, Firestore will pick a default name following the format field_<incremental_id++>. For example:

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

becomes:

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

Requires:

Must be unique across all aggregation aliases.
Conform to document field name limitations.

Returns
Type	Description
`string`

setAlias

Optional. Optional name of the field to store the result of the aggregation into.

If not provided, Firestore will pick a default name following the format field_<incremental_id++>. For example:

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

becomes:

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

Requires:

Must be unique across all aggregation aliases.
Conform to document field name limitations.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOperator

Returns
Type	Description
`string`