Cloud Firestore V1 Client - Class Aggregation (1.38.0)

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
NameDescription
data array

Optional. Data for populating the Message object.

↳ count Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation\Count

Count aggregator.

↳ sum Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation\Sum

Sum aggregator.

↳ avg Google\Cloud\Firestore\V1\StructuredAggregationQuery\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
TypeDescription
Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation\Count|null

hasCount

setCount

Count aggregator.

Parameter
NameDescription
var Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation\Count
Returns
TypeDescription
$this

getSum

Sum aggregator.

Returns
TypeDescription
Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation\Sum|null

hasSum

setSum

Sum aggregator.

Parameter
NameDescription
var Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation\Sum
Returns
TypeDescription
$this

getAvg

Average aggregator.

Returns
TypeDescription
Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation\Avg|null

hasAvg

setAvg

Average aggregator.

Parameter
NameDescription
var Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation\Avg
Returns
TypeDescription
$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:

Returns
TypeDescription
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:

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOperator

Returns
TypeDescription
string