React Native Firebase
    Preparing search index...

    Functions

    abs

    Absolute value of a numeric expression.

    add

    Creates an expression that adds two or more expressions together.

    and

    Logical AND of boolean expressions.

    array

    Array expression.

    arrayAgg

    Collects all values of an expression across stage inputs into an array (aggregate).

    arrayAggDistinct

    Collects distinct values of an expression across stage inputs into an array (aggregate).

    arrayConcat

    Concatenates two or more arrays.

    arrayContains

    Checks if an array contains an element.

    arrayContainsAll

    Checks if an array contains all of the given values.

    arrayContainsAny

    Checks if an array contains any of the given values.

    arrayGet

    Gets element at offset in an array field or expression.

    arrayLength

    Length of an array (field or expression).

    arraySum

    Sum of numeric values in an array (aggregate-like for arrays).

    ascending

    Ascending ordering (standalone). Use in sort().

    average

    Creates an aggregation that calculates the average (mean) of values from an expression. SDK name: average (avg is RN alias).

    avg

    Average aggregation (e.g. avg(field('rating')).as('avgRating')).

    byteLength
    ceil

    Rounds up to the nearest integer.

    charLength
    collectionId
    concat

    Concatenates two or more expressions (e.g. strings or arrays).

    conditional

    Conditional expression: if condition then thenExpr else elseExpr.

    constant

    Creates a constant expression for a number value.

    cosineDistance
    count

    Creates an aggregation that counts stage inputs with valid evaluations of the expression.

    countAll

    Count-all aggregation (e.g. countAll().as('total')).

    countDistinct

    Count distinct values of an expression or field.

    countIf
    currentTimestamp

    Server timestamp at execution time.

    descending

    Descending ordering (standalone). Use in sort().

    divide

    Creates an expression that divides the first by the second.

    documentId

    Creates an expression that evaluates to the document ID (and optionally path).

    dotProduct
    endsWith

    Checks if a string ends with a suffix.

    eq

    Equality comparison.

    equal

    Equality comparison (alias for eq).

    equalAny
    euclideanDistance
    exists

    Checks if a field exists (or expression evaluates to a value).

    exp
    field

    Returns a Field reference for use in pipeline expressions.

    first

    First value of the expression in each group (aggregate).

    floor

    Rounds down to the nearest integer.

    greaterThan

    Greater-than comparison (alias for gt).

    greaterThanOrEqual

    Greater-than-or-equal comparison (alias for gte).

    gt

    Greater-than comparison.

    gte

    Greater-than-or-equal comparison.

    ifAbsent

    If ifExpr is present use it, else use elseExpr/elseValue.

    ifError

    If tryExpr errors, return catchExpr/catchValue (error handling expression).

    isAbsent
    isError
    isType
    join
    last

    Last value of the expression in each group (aggregate).

    length

    Length of string, array, map, vector, or bytes (field or expression).

    lessThan

    Less-than comparison (alias for lt).

    lessThanOrEqual

    Less-than-or-equal comparison (alias for lte).

    like
    ln
    log
    log10
    logicalMaximum
    logicalMinimum
    lt

    Less-than comparison.

    lte

    Less-than-or-equal comparison.

    ltrim
    map

    Map expression for replaceWith etc.

    mapEntries
    mapGet
    mapKeys
    mapMerge
    mapRemove
    mapSet
    mapValues
    maximum
    minimum
    mod

    Remainder (modulo) of left divided by right.

    multiply

    Creates an expression that multiplies two or more expressions.

    not

    Logical NOT of a boolean expression.

    notEqual

    Inequality comparison.

    notEqualAny
    or

    Logical OR of boolean expressions.

    pow
    rand
    regexContains
    regexFind
    regexFindAll
    regexMatch
    reverse
    round

    Rounds to the nearest integer (or to decimalPlaces when provided).

    rtrim
    split
    sqrt

    Square root of a numeric expression.

    startsWith

    Checks if a string starts with a prefix.

    stringConcat
    stringContains
    stringIndexOf
    stringRepeat
    stringReplaceAll
    stringReplaceOne
    stringReverse
    substring

    Substring from position with optional length.

    subtract

    Creates an expression that subtracts the second from the first.

    sum

    Creates an aggregation that sums values from an expression across stage inputs.

    timestampAdd
    timestampSubtract
    timestampToUnixMicros
    timestampToUnixMillis
    timestampToUnixSeconds
    timestampTruncate
    toLower

    Converts string to lower case.

    toUpper

    Converts string to upper case.

    trim

    Trims whitespace (or optional valueToTrim) from string.

    trunc
    type
    unixMicrosToTimestamp
    unixMillisToTimestamp
    unixSecondsToTimestamp
    vectorLength
    xor

    Interfaces

    Accumulator

    Accumulator for pipeline aggregate() (e.g. avg(field('rating')).as('avgRating'), countAll().as('total')).

    AliasedAggregate

    An aggregate function with an output alias.

    AliasedExpression

    An expression with an output alias (implements Selectable).

    BooleanExpression

    Selectable for pipeline field selection/expressions (e.g. field('a').as('b'), expressions).

    ConstantExpression

    Constant/literal expression returned by constant(...).

    Field

    Field reference for pipeline stages.

    FunctionExpression

    Function expression (e.g. map(...), array(...)). Used as return type and in Expression union.

    Ordering

    Ordering for pipeline sort() (e.g. Ordering.of(field('rating')).descending()).

    Selectable

    Selectable for pipeline field selection/expressions (e.g. field('a').as('b'), expressions).

    Type Aliases

    AggregateFunction

    Aggregate function (e.g. countAll()). Alias for Accumulator.

    Expression

    Expression type for pipeline parameters (field refs, literals, function results).

    ExpressionType

    Expression type kind (for internal/backend use).

    TimeGranularity

    Time granularity for timestampTruncate.

    Type

    Firestore value type for isType() checks.

    Variables

    OrderingHelper

    Ordering helper (e.g. Ordering.of(field('rating')).descending()).