Cloud Firestore Enterprise edition in Native mode is now available!Learn more.

Arithmetic functions

Preview:Firestore in Native mode (with Pipeline operations) for Enterpriseedition is subject to the "Pre-GA Offerings Terms" in the GeneralService Terms section of the Service SpecificTerms. You can process personaldata for this feature as outlined in theCloud Data Processing Addendum, subjectto the obligations and restrictions described in the agreement under which youaccess Google Cloud. Pre-GA features are available "as is" and might havelimited support. For more information, see thelaunch stagedescriptions.

Arithmetic Functions

All arithmetic functions inCloud Firestore have the following behaviors:

Evaluates toNULL if any of the input parameters isNULL.
Evaluates toNaN if any of the arguments isNaN.
Generates an error if an overflow or underflow occurs.

Additionally, when an arithmetic function takes multiple numeric arguments ofdifferent types (for example:add(5.0, 6)),Cloud Firestore implicitlyconverts arguments to the widest input type. If onlyINT32 inputs are provided, the return type will beINT64.

Name	Description
`ABS`	Returns the absolute value of a`number`
`ADD`	Returns the value of`x + y`
`SUBTRACT`	Returns the value of`x - y`
`MULTIPLY`	Returns the value of`x * y`
`DIVIDE`	Returns the value of`x / y`
`MOD`	Returns the remainder of the division of`x / y`
`CEIL`	Returns the ceiling of a`number`
`FLOOR`	Returns the floor of a`number`
`ROUND`	Rounds a`number` to`places` decimal places
`POW`	Returns the value of`base^exponent`
`SQRT`	Returns the square root of a`number`
`EXP`	Returns Euler's number raised to the power of`exponent`
`LN`	Returns the natural logarithm of a`number`
`LOG`	Returns the logarithm of a`number`
`LOG10`	Returns the logarithm of a`number` to base`10`
`RAND`	Returns a pseudo-random floating point number

ABS

Syntax:

abs[N <: INT32 | INT64 | FLOAT64](number: N) -> N

Description:

Returns the absolute value of anumber.

Throws an error when the function would overflow anINT32 orINT64 value.

Examples:

number	`abs(number)`
10	10
-10	10
10L	10L
-0.0	0.0
10.5	10.5
-10.5	10.5
-2³¹	`[error]`
-2⁶³	`[error]`

ADD

Syntax:

add[N <: INT32 | INT64 | FLOAT64](x: N, y: N) -> N

Description:

Returns the value ofx + y.

Examples:

x	y	`add(x, y)`
20	3	23
10.0	1	11.0
22.5	2.0	24.5
INT64.MAX	1	`[error]`
INT64.MIN	-1	`[error]`

Node.js

constresult=awaitdb.pipeline().collection("books").select(field("soldBooks").add(field("unsoldBooks")).as("totalBooks")).execute();test.firestore.js

Web

constresult=awaitexecute(db.pipeline().collection("books").select(field("soldBooks").add(field("unsoldBooks")).as("totalBooks")));test.firestore.js

Swift

letresult=tryawaitdb.pipeline().collection("books").select([Field("soldBooks").add(Field("unsoldBooks")).as("totalBooks")]).execute()PipelineSnippets.swift

Kotlin

valresult=db.pipeline().collection("books").select(Expression.add(field("soldBooks"),field("unsoldBooks")).alias("totalBooks")).execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot>result=db.pipeline().collection("books").select(Expression.add(field("soldBooks"),field("unsoldBooks")).alias("totalBooks")).execute();DocSnippets.java

Python

fromgoogle.cloud.firestore_v1.pipeline_expressionsimportFieldresult=(client.pipeline().collection("books").select(Field.of("soldBooks").add(Field.of("unsoldBooks")).as_("totalBooks")).execute())firestore_pipelines.py

Java

Pipeline.Snapshotresult=firestore.pipeline().collection("books").select(add(field("soldBooks"),field("unsoldBooks")).as("totalBooks")).execute().get();PipelineSnippets.java

SUBTRACT

Syntax:

subtract[N <: INT32 | INT64 | FLOAT64](x: N, y: N) -> N

Description:

Returns the value ofx - y.

Examples:

x	y	`subtract(x, y)`
20	3	17
10.0	1	9.0
22.5	2.0	20.5
INT64.MAX	-1	`[error]`
INT64.MIN	1	`[error]`

Node.js

conststoreCredit=7;constresult=awaitdb.pipeline().collection("books").select(field("price").subtract(constant(storeCredit)).as("totalCost")).execute();test.firestore.js

Web

conststoreCredit=7;constresult=awaitexecute(db.pipeline().collection("books").select(field("price").subtract(constant(storeCredit)).as("totalCost")));test.firestore.js

Swift

letstoreCredit=7letresult=tryawaitdb.pipeline().collection("books").select([Field("price").subtract(Constant(storeCredit)).as("totalCost")]).execute()PipelineSnippets.swift

Kotlin

valstoreCredit=7valresult=db.pipeline().collection("books").select(Expression.subtract(field("price"),storeCredit).alias("totalCost")).execute()DocSnippets.kt

Java

intstoreCredit=7;Task<Pipeline.Snapshot>result=db.pipeline().collection("books").select(Expression.subtract(field("price"),storeCredit).alias("totalCost")).execute();DocSnippets.java

Python

fromgoogle.cloud.firestore_v1.pipeline_expressionsimportFieldstore_credit=7result=(client.pipeline().collection("books").select(Field.of("price").subtract(store_credit).as_("totalCost")).execute())firestore_pipelines.py

Java

intstoreCredit=7;Pipeline.Snapshotresult=firestore.pipeline().collection("books").select(subtract(field("price"),storeCredit).as("totalCost")).execute().get();PipelineSnippets.java

MULTIPLY

Syntax:

multiply[N <: INT32 | INT64 | FLOAT64](x: N, y: N) -> N

Description:

Returns the value ofx * y.

Examples:

x	y	`multiply(x, y)`
20	3	60
10.0	1	10.0
22.5	2.0	45.0
INT64.MAX	2	`[error]`
INT64.MIN	2	`[error]`
FLOAT64.MAX	FLOAT64.MAX	`+inf`

Node.js

constresult=awaitdb.pipeline().collection("books").select(field("price").multiply(field("soldBooks")).as("revenue")).execute();test.firestore.js

Web

constresult=awaitexecute(db.pipeline().collection("books").select(field("price").multiply(field("soldBooks")).as("revenue")));test.firestore.js

Swift

letresult=tryawaitdb.pipeline().collection("books").select([Field("price").multiply(Field("soldBooks")).as("revenue")]).execute()PipelineSnippets.swift

Kotlin

valresult=db.pipeline().collection("books").select(Expression.multiply(field("price"),field("soldBooks")).alias("revenue")).execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot>result=db.pipeline().collection("books").select(Expression.multiply(field("price"),field("soldBooks")).alias("revenue")).execute();DocSnippets.java

Python

fromgoogle.cloud.firestore_v1.pipeline_expressionsimportFieldresult=(client.pipeline().collection("books").select(Field.of("price").multiply(Field.of("soldBooks")).as_("revenue")).execute())firestore_pipelines.py

Java

Pipeline.Snapshotresult=firestore.pipeline().collection("books").select(multiply(field("price"),field("soldBooks")).as("revenue")).execute().get();PipelineSnippets.java

DIVIDE

Syntax:

divide[N <: INT32 | INT64 | FLOAT64](x: N, y: N) -> N

Description:

Returns the value ofx / y. Integer division is truncated.

Examples:

x	y	`divide(x, y)`
20	3	6
10.0	3	3.333...
22.5	2	11.25
10	0	`[error]`
1.0	0.0	`+inf`
-1.0	0.0	`-inf`

Node.js

constresult=awaitdb.pipeline().collection("books").select(field("ratings").divide(field("soldBooks")).as("reviewRate")).execute();test.firestore.js

Web

constresult=awaitexecute(db.pipeline().collection("books").select(field("ratings").divide(field("soldBooks")).as("reviewRate")));test.firestore.js

Swift

letresult=tryawaitdb.pipeline().collection("books").select([Field("ratings").divide(Field("soldBooks")).as("reviewRate")]).execute()PipelineSnippets.swift

Kotlin

valresult=db.pipeline().collection("books").select(Expression.divide(field("ratings"),field("soldBooks")).alias("reviewRate")).execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot>result=db.pipeline().collection("books").select(Expression.divide(field("ratings"),field("soldBooks")).alias("reviewRate")).execute();DocSnippets.java

Python

fromgoogle.cloud.firestore_v1.pipeline_expressionsimportFieldresult=(client.pipeline().collection("books").select(Field.of("ratings").divide(Field.of("soldBooks")).as_("reviewRate")).execute())firestore_pipelines.py

Java

Pipeline.Snapshotresult=firestore.pipeline().collection("books").select(divide(field("ratings"),field("soldBooks")).as("reviewRate")).execute().get();PipelineSnippets.java

MOD

Syntax:

mod[N <: INT32 | INT64 | FLOAT64](x: N, y: N) -> N

Description:

Returns the remainder ofx / y.

Throws anerror wheny is zero for integer types (INT64).
ReturnsNaN wheny is zero for float types (FLOAT64).

Examples:

x	y	`mod(x, y)`
20	3	2
-10	3	-1
10	-3	1
-10	-3	-1
10	1	0
22.5	2	0.5
22.5	0.0	`NaN`
25	0	`[error]`

Node.js

constdisplayCapacity=1000;constresult=awaitdb.pipeline().collection("books").select(field("unsoldBooks").mod(constant(displayCapacity)).as("warehousedBooks")).execute();test.firestore.js

Web

constdisplayCapacity=1000;constresult=awaitexecute(db.pipeline().collection("books").select(field("unsoldBooks").mod(constant(displayCapacity)).as("warehousedBooks")));test.firestore.js

Swift

letdisplayCapacity=1000letresult=tryawaitdb.pipeline().collection("books").select([Field("unsoldBooks").mod(Constant(displayCapacity)).as("warehousedBooks")]).execute()PipelineSnippets.swift

Kotlin

valdisplayCapacity=1000valresult=db.pipeline().collection("books").select(Expression.mod(field("unsoldBooks"),displayCapacity).alias("warehousedBooks")).execute()DocSnippets.kt

Java

intdisplayCapacity=1000;Task<Pipeline.Snapshot>result=db.pipeline().collection("books").select(Expression.mod(field("unsoldBooks"),displayCapacity).alias("warehousedBooks")).execute();DocSnippets.java

Python

fromgoogle.cloud.firestore_v1.pipeline_expressionsimportFielddisplay_capacity=1000result=(client.pipeline().collection("books").select(Field.of("unsoldBooks").mod(display_capacity).as_("warehousedBooks")).execute())firestore_pipelines.py

Java

intdisplayCapacity=1000;Pipeline.Snapshotresult=firestore.pipeline().collection("books").select(mod(field("unsoldBooks"),displayCapacity).as("warehousedBooks")).execute().get();PipelineSnippets.java

CEIL

Syntax:

ceil[N <: INT32 | INT64 | FLOAT64](number: N) -> N

Description:

Returns the smallest integer value that isn't less thannumber.

Examples:

number	`ceil(number)`
20	20
10	10
0	0
24L	24L
-0.4	-0.0
0.4	1.0
22.5	23.0
`+inf`	`+inf`
`-inf`	`-inf`

Node.js

constbooksPerShelf=100;constresult=awaitdb.pipeline().collection("books").select(field("unsoldBooks").divide(constant(booksPerShelf)).ceil().as("requiredShelves")).execute();test.firestore.js

Web

constbooksPerShelf=100;constresult=awaitexecute(db.pipeline().collection("books").select(field("unsoldBooks").divide(constant(booksPerShelf)).ceil().as("requiredShelves")));test.firestore.js

Swift

letbooksPerShelf=100letresult=tryawaitdb.pipeline().collection("books").select([Field("unsoldBooks").divide(Constant(booksPerShelf)).ceil().as("requiredShelves")]).execute()PipelineSnippets.swift

Kotlin

valbooksPerShelf=100valresult=db.pipeline().collection("books").select(Expression.divide(field("unsoldBooks"),booksPerShelf).ceil().alias("requiredShelves")).execute()DocSnippets.kt

Java

intbooksPerShelf=100;Task<Pipeline.Snapshot>result=db.pipeline().collection("books").select(Expression.divide(field("unsoldBooks"),booksPerShelf).ceil().alias("requiredShelves")).execute();DocSnippets.java

Python

fromgoogle.cloud.firestore_v1.pipeline_expressionsimportFieldbooks_per_shelf=100result=(client.pipeline().collection("books").select(Field.of("unsoldBooks").divide(books_per_shelf).ceil().as_("requiredShelves")).execute())firestore_pipelines.py

Java

intbooksPerShelf=100;Pipeline.Snapshotresult=firestore.pipeline().collection("books").select(ceil(divide(field("unsoldBooks"),booksPerShelf)).as("requiredShelves")).execute().get();PipelineSnippets.java

FLOOR

Syntax:

floor[N <: INT32 | INT64 | FLOAT64](number: N) -> N

Description:

Returns the largest integer value that isn't greater thannumber.

Examples:

number	`floor(number)`
20	20
10	10
0	0
2147483648	2147483648
-0.4	-1.0
0.4	0.0
22.5	22.0
`+inf`	`+inf`
`-inf`	`-inf`

Node.js

constresult=awaitdb.pipeline().collection("books").addFields(field("wordCount").divide(field("pages")).floor().as("wordsPerPage")).execute();test.firestore.js

Web

constresult=awaitexecute(db.pipeline().collection("books").addFields(field("wordCount").divide(field("pages")).floor().as("wordsPerPage")));test.firestore.js

Swift

letresult=tryawaitdb.pipeline().collection("books").addFields([Field("wordCount").divide(Field("pages")).floor().as("wordsPerPage")]).execute()PipelineSnippets.swift

Kotlin

valresult=db.pipeline().collection("books").addFields(Expression.divide(field("wordCount"),field("pages")).floor().alias("wordsPerPage")).execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot>result=db.pipeline().collection("books").addFields(Expression.divide(field("wordCount"),field("pages")).floor().alias("wordsPerPage")).execute();DocSnippets.java

Python

fromgoogle.cloud.firestore_v1.pipeline_expressionsimportFieldresult=(client.pipeline().collection("books").add_fields(Field.of("wordCount").divide(Field.of("pages")).floor().as_("wordsPerPage")).execute())firestore_pipelines.py

Java

Pipeline.Snapshotresult=firestore.pipeline().collection("books").addFields(floor(divide(field("wordCount"),field("pages"))).as("wordsPerPage")).execute().get();PipelineSnippets.java

ROUND

Syntax:

round[N <: INT32 | INT64 | FLOAT64 | DECIMAL128](number: N) -> Nround[N <: INT32 | INT64 | FLOAT64 | DECIMAL128](number: N, places: INT64) -> N

Description:

Roundsplaces digits off anumber. Rounds digits from the right of the decimal point ifplaces is positive, and to the left of the decimal point if it is negative.

If onlynumber is provided, rounds to the nearest whole value.
Rounds away from zero in halfway cases.
Anerror is thrown if rounding with a negativeplaces value results in overflow.

Examples:

number	places	`round(number, places)`
15.5	0	16.0
-15.5	0	-16.0
15	1	15
15	0	15
15	-1	20
15	-2	0
15.48924	1	15.5
2³¹-1	-1	`[error]`
2⁶³-1L	-1	`[error]`

Node.js

constresult=awaitdb.pipeline().collection("books").select(field("soldBooks").multiply(field("price")).round().as("partialRevenue")).aggregate(field("partialRevenue").sum().as("totalRevenue")).execute();test.firestore.js

Web

constresult=awaitexecute(db.pipeline().collection("books").select(field("soldBooks").multiply(field("price")).round().as("partialRevenue")).aggregate(field("partialRevenue").sum().as("totalRevenue")));test.firestore.js

Swift

letresult=tryawaitdb.pipeline().collection("books").select([Field("soldBooks").multiply(Field("price")).round().as("partialRevenue")]).aggregate([Field("partialRevenue").sum().as("totalRevenue")]).execute()PipelineSnippets.swift

Kotlin

valresult=db.pipeline().collection("books").select(Expression.multiply(field("soldBooks"),field("price")).round().alias("partialRevenue")).aggregate(AggregateFunction.sum("partialRevenue").alias("totalRevenue")).execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot>result=db.pipeline().collection("books").select(Expression.multiply(field("soldBooks"),field("price")).round().alias("partialRevenue")).aggregate(AggregateFunction.sum("partialRevenue").alias("totalRevenue")).execute();DocSnippets.java

Python

fromgoogle.cloud.firestore_v1.pipeline_expressionsimportFieldresult=(client.pipeline().collection("books").select(Field.of("soldBooks").multiply(Field.of("price")).round().as_("partialRevenue")).aggregate(Field.of("partialRevenue").sum().as_("totalRevenue")).execute())firestore_pipelines.py

Java

Pipeline.Snapshotresult=firestore.pipeline().collection("books").select(round(multiply(field("soldBooks"),field("price"))).as("partialRevenue")).aggregate(sum("partialRevenue").as("totalRevenue")).execute().get();PipelineSnippets.java

POW

Syntax:

pow(base: FLOAT64, exponent: FLOAT64) -> FLOAT64

Description:

Returns the valuebase raised to the power ofexponent.

Throws an error ifbase <= 0 andexponent is negative.
For anyexponent,pow(1, exponent) is 1.
For anybase,pow(base, 0) is 1.

Examples:

base	exponent	`pow(base, exponent)`
2	3	8.0
2	-3	0.125
`+inf`	0	1.0
1	`+inf`	1.0
-1	0.5	`[error]`
0	-1	`[error]`

Node.js

constgoogleplex={latitude:37.4221,longitude:122.0853};constresult=awaitdb.pipeline().collection("cities").addFields(field("lat").subtract(constant(googleplex.latitude)).multiply(111/* km per degree */).pow(2).as("latitudeDifference"),field("lng").subtract(constant(googleplex.longitude)).multiply(111/* km per degree */).pow(2).as("longitudeDifference")).select(field("latitudeDifference").add(field("longitudeDifference")).sqrt()// Inaccurate for large distances or close to poles.as("approximateDistanceToGoogle")).execute();test.firestore.js

Web

constgoogleplex={latitude:37.4221,longitude:122.0853};constresult=awaitexecute(db.pipeline().collection("cities").addFields(field("lat").subtract(constant(googleplex.latitude)).multiply(111/* km per degree */).pow(2).as("latitudeDifference"),field("lng").subtract(constant(googleplex.longitude)).multiply(111/* km per degree */).pow(2).as("longitudeDifference")).select(field("latitudeDifference").add(field("longitudeDifference")).sqrt()// Inaccurate for large distances or close to poles.as("approximateDistanceToGoogle")));test.firestore.js

Swift

letgoogleplex=CLLocation(latitude:37.4221,longitude:122.0853)letresult=tryawaitdb.pipeline().collection("cities").addFields([Field("lat").subtract(Constant(googleplex.coordinate.latitude)).multiply(111/* km per degree */).pow(2).as("latitudeDifference"),Field("lng").subtract(Constant(googleplex.coordinate.latitude)).multiply(111/* km per degree */).pow(2).as("longitudeDifference")]).select([Field("latitudeDifference").add(Field("longitudeDifference")).sqrt()// Inaccurate for large distances or close to poles.as("approximateDistanceToGoogle")]).execute()PipelineSnippets.swift

Kotlin

valgoogleplex=GeoPoint(37.4221,-122.0853)valresult=db.pipeline().collection("cities").addFields(field("lat").subtract(googleplex.latitude).multiply(111/* km per degree */).pow(2).alias("latitudeDifference"),field("lng").subtract(googleplex.longitude).multiply(111/* km per degree */).pow(2).alias("longitudeDifference")).select(field("latitudeDifference").add(field("longitudeDifference")).sqrt()// Inaccurate for large distances or close to poles.alias("approximateDistanceToGoogle")).execute()DocSnippets.kt

Java

GeoPointgoogleplex=newGeoPoint(37.4221,-122.0853);Task<Pipeline.Snapshot>result=db.pipeline().collection("cities").addFields(field("lat").subtract(googleplex.getLatitude()).multiply(111/* km per degree */).pow(2).alias("latitudeDifference"),field("lng").subtract(googleplex.getLongitude()).multiply(111/* km per degree */).pow(2).alias("longitudeDifference")).select(field("latitudeDifference").add(field("longitudeDifference")).sqrt()// Inaccurate for large distances or close to poles.alias("approximateDistanceToGoogle")).execute();DocSnippets.java

Python

fromgoogle.cloud.firestore_v1.pipeline_expressionsimportFieldgoogleplexLat=37.4221googleplexLng=-122.0853result=(client.pipeline().collection("cities").add_fields(Field.of("lat").subtract(googleplexLat).multiply(111)# km per degree.pow(2).as_("latitudeDifference"),Field.of("lng").subtract(googleplexLng).multiply(111)# km per degree.pow(2).as_("longitudeDifference"),).select(Field.of("latitudeDifference").add(Field.of("longitudeDifference")).sqrt()# Inaccurate for large distances or close to poles.as_("approximateDistanceToGoogle")).execute())firestore_pipelines.py

Java

doublegoogleplexLat=37.4221;doublegoogleplexLng=-122.0853;Pipeline.Snapshotresult=firestore.pipeline().collection("cities").addFields(pow(multiply(subtract(field("lat"),googleplexLat),111),2).as("latitudeDifference"),pow(multiply(subtract(field("lng"),googleplexLng),111),2).as("longitudeDifference")).select(sqrt(add(field("latitudeDifference"),field("longitudeDifference")))// Inaccurate for large distances or close to poles.as("approximateDistanceToGoogle")).execute().get();PipelineSnippets.java

SQRT

Syntax:

sqrt[N <: FLOAT64 | DECIMAL128](number: N) -> N

Description:

Returns the square root of anumber.

Throws anerror ifnumber is negative.

Examples:

number	`sqrt(number)`
25	5.0
12.002	3.464...
0.0	0.0
`NaN`	`NaN`
`+inf`	`+inf`
`-inf`	`[error]`
`x < 0`	`[error]`

Node.js

constgoogleplex={latitude:37.4221,longitude:122.0853};constresult=awaitdb.pipeline().collection("cities").addFields(field("lat").subtract(constant(googleplex.latitude)).multiply(111/* km per degree */).pow(2).as("latitudeDifference"),field("lng").subtract(constant(googleplex.longitude)).multiply(111/* km per degree */).pow(2).as("longitudeDifference")).select(field("latitudeDifference").add(field("longitudeDifference")).sqrt()// Inaccurate for large distances or close to poles.as("approximateDistanceToGoogle")).execute();test.firestore.js

Web

constgoogleplex={latitude:37.4221,longitude:122.0853};constresult=awaitexecute(db.pipeline().collection("cities").addFields(field("lat").subtract(constant(googleplex.latitude)).multiply(111/* km per degree */).pow(2).as("latitudeDifference"),field("lng").subtract(constant(googleplex.longitude)).multiply(111/* km per degree */).pow(2).as("longitudeDifference")).select(field("latitudeDifference").add(field("longitudeDifference")).sqrt()// Inaccurate for large distances or close to poles.as("approximateDistanceToGoogle")));test.firestore.js

Swift

letgoogleplex=CLLocation(latitude:37.4221,longitude:122.0853)letresult=tryawaitdb.pipeline().collection("cities").addFields([Field("lat").subtract(Constant(googleplex.coordinate.latitude)).multiply(111/* km per degree */).pow(2).as("latitudeDifference"),Field("lng").subtract(Constant(googleplex.coordinate.latitude)).multiply(111/* km per degree */).pow(2).as("longitudeDifference")]).select([Field("latitudeDifference").add(Field("longitudeDifference")).sqrt()// Inaccurate for large distances or close to poles.as("approximateDistanceToGoogle")]).execute()PipelineSnippets.swift

Kotlin

valgoogleplex=GeoPoint(37.4221,-122.0853)valresult=db.pipeline().collection("cities").addFields(field("lat").subtract(googleplex.latitude).multiply(111/* km per degree */).pow(2).alias("latitudeDifference"),field("lng").subtract(googleplex.longitude).multiply(111/* km per degree */).pow(2).alias("longitudeDifference")).select(field("latitudeDifference").add(field("longitudeDifference")).sqrt()// Inaccurate for large distances or close to poles.alias("approximateDistanceToGoogle")).execute()DocSnippets.kt

Java

GeoPointgoogleplex=newGeoPoint(37.4221,-122.0853);Task<Pipeline.Snapshot>result=db.pipeline().collection("cities").addFields(field("lat").subtract(googleplex.getLatitude()).multiply(111/* km per degree */).pow(2).alias("latitudeDifference"),field("lng").subtract(googleplex.getLongitude()).multiply(111/* km per degree */).pow(2).alias("longitudeDifference")).select(field("latitudeDifference").add(field("longitudeDifference")).sqrt()// Inaccurate for large distances or close to poles.alias("approximateDistanceToGoogle")).execute();DocSnippets.java

Python

fromgoogle.cloud.firestore_v1.pipeline_expressionsimportFieldgoogleplexLat=37.4221googleplexLng=-122.0853result=(client.pipeline().collection("cities").add_fields(Field.of("lat").subtract(googleplexLat).multiply(111)# km per degree.pow(2).as_("latitudeDifference"),Field.of("lng").subtract(googleplexLng).multiply(111)# km per degree.pow(2).as_("longitudeDifference"),).select(Field.of("latitudeDifference").add(Field.of("longitudeDifference")).sqrt()# Inaccurate for large distances or close to poles.as_("approximateDistanceToGoogle")).execute())firestore_pipelines.py

Java

doublegoogleplexLat=37.4221;doublegoogleplexLng=-122.0853;Pipeline.Snapshotresult=firestore.pipeline().collection("cities").addFields(pow(multiply(subtract(field("lat"),googleplexLat),111),2).as("latitudeDifference"),pow(multiply(subtract(field("lng"),googleplexLng),111),2).as("longitudeDifference")).select(sqrt(add(field("latitudeDifference"),field("longitudeDifference")))// Inaccurate for large distances or close to poles.as("approximateDistanceToGoogle")).execute().get();PipelineSnippets.java

EXP

Syntax:

exp(exponent: FLOAT64) -> FLOAT64

Description:

Returns the value of Euler's number raised to the power ofexponent, also called the natural exponential function.

Examples:

exponent	`exp(exponent)`
0.0	1.0
10	`e^10` (`FLOAT64`)
`+inf`	`+inf`
`-inf`	0

Node.js

constresult=awaitdb.pipeline().collection("books").select(field("rating").exp().as("expRating")).execute();test.firestore.js

Web

constresult=awaitexecute(db.pipeline().collection("books").select(field("rating").exp().as("expRating")));test.firestore.js

Swift

letresult=tryawaitdb.pipeline().collection("books").select([Field("rating").exp().as("expRating")]).execute()PipelineSnippets.swift

Kotlin

valresult=db.pipeline().collection("books").select(field("rating").exp().alias("expRating")).execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot>result=db.pipeline().collection("books").select(field("rating").exp().alias("expRating")).execute();DocSnippets.java

Python

fromgoogle.cloud.firestore_v1.pipeline_expressionsimportFieldresult=(client.pipeline().collection("books").select(Field.of("rating").exp().as_("expRating")).execute())firestore_pipelines.py

Java

Pipeline.Snapshotresult=firestore.pipeline().collection("books").select(exp(field("rating")).as("expRating")).execute().get();PipelineSnippets.java

LN

Syntax:

ln(number: FLOAT64) -> FLOAT64

Description:

Returns the natural logarithm ofnumber. This function is equivalent tolog(number).

Examples:

number	`ln(number)`
1	0.0
2L	0.693...
1.0	0.0
`e` (`FLOAT64`)	1.0
`-inf`	`NaN`
`+inf`	`+inf`
`x <= 0`	`[error]`

Node.js

constresult=awaitdb.pipeline().collection("books").select(field("rating").ln().as("lnRating")).execute();test.firestore.js

Web

constresult=awaitexecute(db.pipeline().collection("books").select(field("rating").ln().as("lnRating")));test.firestore.js

Swift

letresult=tryawaitdb.pipeline().collection("books").select([Field("rating").ln().as("lnRating")]).execute()PipelineSnippets.swift

Kotlin

valresult=db.pipeline().collection("books").select(field("rating").ln().alias("lnRating")).execute()DocSnippets.kt

Java

Task<Pipeline.Snapshot>result=db.pipeline().collection("books").select(field("rating").ln().alias("lnRating")).execute();DocSnippets.java

Python

fromgoogle.cloud.firestore_v1.pipeline_expressionsimportFieldresult=(client.pipeline().collection("books").select(Field.of("rating").ln().as_("lnRating")).execute())firestore_pipelines.py

Java

Pipeline.Snapshotresult=firestore.pipeline().collection("books").select(ln(field("rating")).as("lnRating")).execute().get();PipelineSnippets.java

LOG

Syntax:

log(number: FLOAT64, base: FLOAT64) -> FLOAT64log(number: FLOAT64) -> FLOAT64

Description:

Returns the logarithm of anumber tobase.

If onlynumber is provided, returns the logarithm ofnumber tobase (synonymous toln(number)).

Examples:

number	base	`log(number, base)`
100	10	2.0
`-inf`	`Numeric`	`NaN`
`Numeric`.	`+inf`	`NaN`
`number <= 0`	`Numeric`	`[error]`
`Numeric`	`base <= 0`	`[error]`
`Numeric`	1.0	`[error]`

LOG10

Syntax:

log10(x: FLOAT64) -> FLOAT64

Description:

Returns the logarithm of anumber to base10.

Examples:

number	`log10(number)`
100	2.0
`-inf`	`NaN`
`+inf`	`+inf`
`x <= 0`	`[error]`

RAND

Syntax:

rand()->FLOAT64

Description:

Return a pseudo-random floating point number, chosen uniformly between0.0 (inclusive) and1.0 (exclusive).

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-02-18 UTC.

Movatterモバイル変換

Arithmetic functions Stay organized with collections Save and categorize content based on your preferences.

Arithmetic Functions

ABS

ADD

Node.js

Web

Swift

Kotlin

Java

Python

Java

SUBTRACT

Node.js

Web

Swift

Kotlin

Java

Python

Java

MULTIPLY

Node.js

Web

Swift

Kotlin

Java

Python

Java

DIVIDE

Node.js

Web

Swift

Kotlin

Java

Python

Java

MOD

Node.js

Web

Swift

Kotlin

Java

Python

Java

CEIL

Node.js

Web

Swift

Kotlin

Java

Python

Java

FLOOR

Node.js

Web

Swift

Kotlin

Java

Python

Java

ROUND

Node.js

Web

Swift

Kotlin

Java

Python

Java

POW

Node.js

Web

Swift

Kotlin

Java

Python

Java

SQRT

Node.js

Web

Swift

Arithmetic functions