Cloud Firestore V1 Client - Class Aggregation (1.31.0)

Version 1.31.0

• 1.47.1 (latest)
• 1.47.0
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

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

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ count	Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation\Count Count 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
Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation\Count|null

hasCount

setCount

Count aggregator.

Parameter
Name	Description
var	Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation\Count

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