Field

@Beta
public final classField extendsSelectable


Represents a reference to a field in a Firestore document.

Field references are used to access document field values in expressions and to specify fields for sorting, filtering, and projecting data in Firestore pipelines.

You can create aField instance using the staticExpression.field method:

Summary

Nested types

public static classField.Companion

Public methods

boolean
equals(Object other)
int

Inherited methods

Fromcom.google.firebase.firestore.pipeline.Expression
final @NonNullExpression
abs()

Creates an expression that returns the absolute value of this expression.

final @NonNullExpression

Creates an expression that adds this numeric expression to another numeric expression.

final @NonNullExpression
add(@NonNullNumber second)

Creates an expression that adds this numeric expression to a constants.

@NonNullSelectable

Assigns an alias to this expression.

final @NonNullExpression
arrayConcat(@NonNullObject secondArray, @NonNullObject otherArrays)

Creates an expression that concatenates a field's array value with other arrays.

final @NonNullExpression
arrayConcat(@NonNullExpression secondArray, @NonNullObject otherArrays)

Creates an expression that concatenates a field's array value with other arrays.

final @NonNullBooleanExpression

Creates an expression that checks if array contains a specificelement.

final @NonNullBooleanExpression

Creates an expression that checks if array contains a specificelement.

final @NonNullBooleanExpression

Creates an expression that checks if array contains all elements ofarrayExpression.

final @NonNullBooleanExpression

Creates an expression that checks if array contains all the specifiedvalues.

final @NonNullBooleanExpression

Creates an expression that checks if array contains any elements ofarrayExpression.

final @NonNullBooleanExpression

Creates an expression that checks if array contains any of the specifiedvalues.

final @NonNullExpression

Creates an expression that indexes into an array from the beginning or end and return the element.

final @NonNullExpression
arrayGet(int offset)

Creates an expression that indexes into an array from the beginning or end and return the element.

final @NonNullExpression

Creates an expression that calculates the length of an array expression.

final @NonNullExpression

Reverses the order of elements in the array.

final @NonNullExpression

Creates an expression that returns the sum of the elements in this array expression.

final @NonNullBooleanExpression

Casts the expression to aBooleanExpression.

final @NonNullOrdering

Create anOrdering that sorts documents in ascending order based on value of this expression

final @NonNullAggregateFunction

Creates an aggregation that calculates the average (mean) of this numeric expression across multiple stage inputs.

final @NonNullExpression
bitAnd(@NonNull byte[] bitsOther)

Creates an expression that applies a bitwise AND operation with a constant.

final @NonNullExpression

Creates an expression that applies a bitwise AND operation with other expression.

final @NonNullExpression
bitLeftShift(int number)

Creates an expression that applies a bitwise left shift operation with a constant.

final @NonNullExpression

Creates an expression that applies a bitwise left shift operation with an expression.

final @NonNullExpression

Creates an expression that applies a bitwise NOT operation to this expression.

final @NonNullExpression
bitOr(@NonNull byte[] bitsOther)

Creates an expression that applies a bitwise OR operation with a constant.

final @NonNullExpression

Creates an expression that applies a bitwise OR operation with other expression.

final @NonNullExpression
bitRightShift(int number)

Creates an expression that applies a bitwise right shift operation with a constant.

final @NonNullExpression

Creates an expression that applies a bitwise right shift operation with an expression.

final @NonNullExpression
bitXor(@NonNull byte[] bitsOther)

Creates an expression that applies a bitwise XOR operation with a constant.

final @NonNullExpression

Creates an expression that applies a bitwise XOR operation with an expression.

final @NonNullExpression

Creates an expression that calculates the length of a string in UTF-8 bytes, or just the length of a Blob.

final @NonNullExpression

Creates an expression that returns the smallest integer that isn't less than this numeric expression.

final @NonNullExpression

Creates an expression that calculates the character length of this string expression in UTF8.

final @NonNullExpression

Creates an expression that returns the collection ID from this path expression.

final @NonNullExpression
concat(@NonNullObject second, @NonNullObject others)

Creates an expression that concatenates this expression's value with others.

final @NonNullExpression

Creates an expression that concatenates this expression's value with others.

final @NonNullExpression
cosineDistance(@NonNull double[] vector)

Calculates the Cosine distance between this vector expression and a vector literal.

final @NonNullExpression

Calculates the Cosine distance between this and another vector expressions.

final @NonNullExpression

Calculates the Cosine distance between this vector expression and a vector literal.

final @NonNullAggregateFunction

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

final @NonNullAggregateFunction

Creates an aggregation that counts the number of distinct values of an expression across multiple stage inputs.

final @NonNullOrdering

Create anOrdering that sorts documents in descending order based on value of this expression

final @NonNullExpression

Creates an expression that divides this numeric expression by another numeric expression.

final @NonNullExpression

Creates an expression that divides this numeric expression by a constant.

final @NonNullExpression

Creates an expression that returns the document ID from this path expression.

final @NonNullExpression
dotProduct(@NonNull double[] vector)

Calculates the dot product distance between this vector expression and a vector literal.

final @NonNullExpression

Calculates the dot product distance between this and another vector expression.

final @NonNullExpression

Calculates the dot product distance between this vector expression and a vector literal.

final @NonNullBooleanExpression

Creates an expression that checks if this string expression ends with a givensuffix.

final @NonNullBooleanExpression

Creates an expression that checks if this string expression ends with a givensuffix.

final @NonNullBooleanExpression

Creates an expression that checks if this andother expression are equal.

final @NonNullBooleanExpression

Creates an expression that checks if this expression is equal to avalue.

final @NonNullBooleanExpression
equalAny(@NonNullExpression arrayExpression)

Creates an expression that checks if this expression, when evaluated, is equal to any of the elements ofarrayExpression.

final @NonNullBooleanExpression

Creates an expression that checks if this expression, when evaluated, is equal to any of the providedvalues.

final @NonNullExpression
euclideanDistance(@NonNull double[] vector)

Calculates the Euclidean distance between this vector expression and a vector literal.

final @NonNullExpression

Calculates the Euclidean distance between this and another vector expression.

final @NonNullExpression

Calculates the Euclidean distance between this vector expression and a vector literal.

final @NonNullBooleanExpression

Creates an expression that checks if this expression evaluates to a name of the field that exists.

final @NonNullExpression
exp()

Creates an expression that returns Euler's number e raised to the power of this expression.

final @NonNullExpression

Creates an expression that returns the largest integer that is not greater than this numeric expression.

final @NonNullBooleanExpression

Creates an expression that checks if this expression is greater than theother expression.

final @NonNullBooleanExpression

Creates an expression that checks if this expression is greater than avalue.

final @NonNullBooleanExpression

Creates an expression that checks if this expression is greater than or equal to theother expression.

final @NonNullBooleanExpression

Creates an expression that checks if this expression is greater than or equal to avalue.

final @NonNullExpression

Creates an expression that returns theelseExpr argument if this expression is absent, else return the result of this expression.

final @NonNullExpression
ifAbsent(@NonNullObject elseValue)

Creates an expression that returns theelseValue argument if this expression is absent, else return the result of this expression.

final @NonNullExpression

Creates an expression that returns thecatchExpr argument if there is an error, else return the result of this expression.

final @NonNullExpression
ifError(@NonNullObject catchValue)

Creates an expression that returns thecatchValue argument if there is an error, else return the result of this expression.

final @NonNullBooleanExpression

Creates an expression that returns true if the result of this expression is absent.

final @NonNullBooleanExpression

Creates an expression that checks if this expression produces an error.

final @NonNullExpression
join(@NonNullString delimiter)

Creates an expression that joins the elements of an array into a string.

final @NonNullExpression
join(@NonNullExpression delimiterExpression)

Creates an expression that joins the elements of an array into a string.

final @NonNullExpression

Creates an expression that calculates the length of a string, array, map, vector, or blob expression.

final @NonNullBooleanExpression

Creates an expression that checks if this expression is less than theother expression.

final @NonNullBooleanExpression

Creates an expression that checks if this expression is less than a value.

final @NonNullBooleanExpression

Creates an expression that checks if this expression is less than or equal to theother expression.

final @NonNullBooleanExpression

Creates an expression that checks if this expression is less than or equal to avalue.

final @NonNullBooleanExpression

Creates an expression that performs a case-sensitive wildcard string comparison.

final @NonNullBooleanExpression
like(@NonNullString pattern)

Creates an expression that performs a case-sensitive wildcard string comparison.

final @NonNullExpression
ln()

Creates an expression that returns the natural logarithm of this numeric expression.

final @NonNullExpression

Creates an expression that returns the base-10 logarithm of this numeric expression.

final @NonNullExpression

Creates an expression that returns the largest value between multiple input expressions or literal values.

final @NonNullExpression

Creates an expression that returns the largest value between multiple input expressions or literal values.

final @NonNullExpression

Creates an expression that returns the smallest value between multiple input expressions or literal values.

final @NonNullExpression

Creates an expression that returns the smallest value between multiple input expressions or literal values.

final @NonNullExpression

Accesses a map (object) value using the providedkey.

final @NonNullExpression
mapGet(@NonNullExpression keyExpression)

Accesses a map (object) value using the providedkeyExpression.

final @NonNullExpression

Creates an expression that merges multiple maps into a single map.

final @NonNullExpression

Creates an expression that removes a key from this map expression.

final @NonNullExpression
mapRemove(@NonNullExpression keyExpression)

Creates an expression that removes a key from this map expression.

final @NonNullAggregateFunction

Creates an aggregation that finds the maximum value of this expression across multiple stage inputs.

final @NonNullAggregateFunction

Creates an aggregation that finds the minimum value of this expression across multiple stage inputs.

final @NonNullExpression

Creates an expression that calculates the modulo (remainder) of dividing this numeric expressions by another numeric expression.

final @NonNullExpression
mod(@NonNullNumber divisor)

Creates an expression that calculates the modulo (remainder) of dividing this numeric expressions by a constant.

final @NonNullExpression

Creates an expression that multiplies this numeric expression with another numeric expression.

final @NonNullExpression

Creates an expression that multiplies this numeric expression with a constant.

final @NonNullBooleanExpression

Creates an expression that checks if this expressions is not equal to theother expression.

final @NonNullBooleanExpression

Creates an expression that checks if this expression is not equal to avalue.

final @NonNullBooleanExpression
notEqualAny(@NonNullExpression arrayExpression)

Creates an expression that checks if this expression, when evaluated, is not equal to all the elements ofarrayExpression.

final @NonNullBooleanExpression

Creates an expression that checks if this expression, when evaluated, is not equal to all the providedvalues.

final @NonNullExpression

Creates an expression that returns this numeric expression raised to the power of theexponent.

final @NonNullExpression
pow(@NonNullNumber exponent)

Creates an expression that returns this numeric expression raised to the power of theexponent.

final @NonNullBooleanExpression

Creates an expression that checks if this string expression contains a specified regular expression as a substring.

final @NonNullBooleanExpression

Creates an expression that checks if this string expression contains a specified regular expression as a substring.

final @NonNullBooleanExpression

Creates an expression that checks if this string expression matches a specified regular expression.

final @NonNullBooleanExpression

Creates an expression that checks if this string expression matches a specified regular expression.

final @NonNullExpression

Creates an expression that reverses this string expression.

final @NonNullExpression

Creates an expression that rounds this numeric expression to nearest integer.

final @NonNullExpression

Creates an expression that rounds off this numeric expression todecimalPlace decimal places ifdecimalPlace is positive, rounds off digits to the left of the decimal point ifdecimalPlace is negative.

final @NonNullExpression
roundToPrecision(int decimalPlace)

Creates an expression that rounds off this numeric expression todecimalPlace decimal places ifdecimalPlace is positive, rounds off digits to the left of the decimal point ifdecimalPlace is negative.

final @NonNullExpression
split(@NonNullBlob delimiter)

Creates an expression that splits this blob expression by a blob delimiter.

final @NonNullExpression

Creates an expression that splits this string or blob expression by a delimiter.

final @NonNullExpression
split(@NonNullString delimiter)

Creates an expression that splits this string or blob expression by a string delimiter.

final @NonNullExpression

Creates an expression that returns the square root of this numeric expression.

final @NonNullBooleanExpression

Creates an expression that checks if this string expression starts with a givenprefix.

final @NonNullBooleanExpression

Creates an expression that checks if this string expression starts with a givenprefix.

final @NonNullExpression
stringConcat(@NonNullExpression stringExpressions)

Creates an expression that concatenates string expressions together.

final @NonNullExpression

Creates an expression that concatenates string expressions and string constants together.

final @NonNullExpression

Creates an expression that concatenates this string expression with string constants.

final @NonNullBooleanExpression

Creates an expression that checks if this string expression contains a specified substring.

final @NonNullBooleanExpression

Creates an expression that checks if this string expression contains a specified substring.

final @NonNullExpression

Creates an expression that performs a reverse operation on this string expression.

final @NonNullExpression

Creates an expression that returns a substring of the given string.

final @NonNullExpression
substring(int start, int length)

Creates an expression that returns a substring of the given string.

final @NonNullExpression

Creates an expression that subtracts a constant from this numeric expression.

final @NonNullExpression
subtract(@NonNullNumber subtrahend)

Creates an expression that subtracts a numeric expressions from this numeric expression.

final @NonNullAggregateFunction
sum()

Creates an aggregation that calculates the sum of this numeric expression across multiple stage inputs.

final @NonNullExpression

Creates an expression that adds a specified amount of time to this timestamp expression.

final @NonNullExpression
timestampAdd(@NonNullString unit, long amount)

Creates an expression that adds a specified amount of time to this timestamp expression.

final @NonNullExpression

Creates an expression that subtracts a specified amount of time to this timestamp expression.

final @NonNullExpression
timestampSubtract(@NonNullString unit, long amount)

Creates an expression that subtracts a specified amount of time to this timestamp expression.

final @NonNullExpression

Creates an expression that converts this timestamp expression to the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC).

final @NonNullExpression

Creates an expression that converts this timestamp expression to the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC).

final @NonNullExpression

Creates an expression that converts this timestamp expression to the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC).

final @NonNullExpression

Creates an expression that truncates this timestamp expression to a specified granularity.

final @NonNullExpression

Creates an expression that truncates this timestamp expression to a specified granularity.

final @NonNullExpression

Creates an expression that converts this string expression to lowercase.

final @NonNullExpression

Creates an expression that converts this string expression to uppercase.

final @NonNullExpression

Creates an expression that removes leading and trailing whitespace from this string expression.

final @NonNullExpression

Creates an expression that removes leading and trailing value from this expression.

final @NonNullExpression
trimValue(@NonNullString valueToTrim)

Creates an expression that removes leading and trailing characters from this string expression.

final @NonNullExpression

Creates an expression that returns a string indicating the type of the value this expression evaluates to.

final @NonNullExpression

Creates an expression that interprets this expression as the number of microseconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.

final @NonNullExpression

Creates an expression that interprets this expression as the number of milliseconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.

final @NonNullExpression

Creates an expression that interprets this expression as the number of seconds since the Unix epoch (1970-01-01 00:00:00 UTC) and returns a timestamp.

final @NonNullExpression

Creates an expression that calculates the length (dimension) of a Firestore Vector.

Public methods

equals

public boolean equals(Object other)

hashCode

public int hashCode()

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

Last updated 2026-01-15 UTC.