Cloud Firestore Client - Class AggregateQuerySnapshot (1.31.0)

Version 1.31.0

• 1.47.2 (latest)
• 1.47.1
• 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 Client class AggregateQuerySnapshot.

Represents the result set of an AggregateQuery.

Example:

use Google\Cloud\Firestore\FirestoreClient;

$firestore = new FirestoreClient();
$collection = $firestore->collection('users');
$query = $collection->where('age', '>', 18);

$snapshot = $query->count();

Methods

__construct

An immutable snapshot of aggregate query results.

Parameter
Name	Description
snapshot	array Result of an AggregateQuery.

getTransaction

Get the transaction id.

Returns
Type	Description
string

getReadTime

Get the Aggregation read time.

Returns
Type	Description
Google\Cloud\Core\Timestamp

get

Get the Query Aggregation value.

Parameter
Name	Description
alias	string The aggregation alias.

Returns
Type	Description
int