FirebaseFirestore Framework Reference

AggregateFunction

public class AggregateFunction : AggregateBridgeWrapper, @unchecked Sendable

Represents an aggregate function in a pipeline.

An AggregateFunction is a function that computes a single value from a set of input values.

AggregateFunctions are typically used in the aggregate stage of a pipeline.


                    
                    
                    init(functionName:args:)

Creates a new AggregateFunction.

Swift

public init(functionName: String, args: [Expression])

`functionName`	The name of the aggregate function.
`args`	The arguments to the aggregate function.


                    
                    
                    as(_:)

Creates an AliasedAggregate from this aggregate function.

Swift

public func `as`(_ name: String) -> AliasedAggregate


                                name

The alias for the aggregate function.

An AliasedAggregate with the given alias.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-13 UTC.