SDK Client Reference
Classes
AddFields
Aggregate
toProto
AggregateField
isEqual
average
count
sum
AggregateFunction
as
AggregateQuery
explain
get
isEqual
AggregateQuerySnapshot
data
isEqual
AliasedAggregate
AliasedExpression
ArrayFunctionExpr
BaseShouldGarbageCollectClientResult
toString
BooleanExpression
conditional
countIf
not
BsonObjectId
isEqual
BulkWriter
close
create
delete
flush
onWriteError
onWriteResult
set
update
BulkWriterError
BundleBuilder
add
Bytes
isEqual
toBase64
toString
toUint8Array
fromBase64String
fromUint8Array
CollectionGroup
getPartitions
CollectionGroupSource
CollectionReference
_isCollectionGroupQuery
add
aggregate
count
doc
endAt
endBefore
explain
explainStream
get
getInequalityFilterFields
isEqual
limit
limitToLast
listDocuments
offset
onSnapshot
orderBy
select
startAfter
startAt
stream
withConverter
CollectionSource
DatabaseSource
Define
DeleteStage
Distinct
DocumentChange
isEqual
DocumentReference
collection
create
delete
get
isEqual
listCollections
onSnapshot
set
update
withConverter
DocumentSnapshot
data
get
isEqual
DocumentsSource
ExecutionStats
ExplainMetrics
ExplainResults
Expression
abs
add
arrayAgg
arrayAggDistinct
arrayConcat
arrayFilter
arrayFirst
arrayLast
arrayLength
arrayMaximum
arrayMinimum
arrayReverse
arraySlice
arraySum
arrayTransform
arrayTransformWithIndex
as
asBoolean
ascending
average
byteLength
ceil
charLength
coalesce
collectionId
concat
count
countDistinct
descending
documentId
exists
exp
first
floor
getField
isAbsent
isError
isType
last
length
ln
log10
logicalMaximum
logicalMinimum
ltrim
mapEntries
mapGet
mapKeys
mapMerge
mapSet
mapValues
maximum
minimum
multiply
parent
reverse
rtrim
sqrt
stringConcat
stringIndexOf
stringRepeat
stringReplaceAll
stringReplaceOne
stringReverse
sum
timestampToUnixMicros
timestampToUnixMillis
timestampToUnixSeconds
toLower
toUpper
trim
type
unixMicrosToTimestamp
unixMillisToTimestamp
unixSecondsToTimestamp
vectorLength
FieldPath
isEqual
documentId
FieldValue
isEqual
arrayRemove
arrayUnion
delete
increment
maximum
minimum
serverTimestamp
vector
Filter
and
or
where
FindNearest
Firestore
batch
bulkWriter
bundle
collection
collectionGroup
doc
getAll
listCollections
pipeline
recursiveDelete
runTransaction
settings
terminate
toJSON
FunctionExpression
GeoPoint
isEqual
LazyLogStringForAllClientIds
Limit
ListOfExprs
MapFunctionExpr
MaxKey
MinKey
ObjectValue
applyChanges
getFieldsMap
set
setAll
Offset
OptionsUtil
getOptionsProto
Ordering
Pipeline
delete
execute
findNearest
rawStage
search
stream
toArrayExpression
toScalarExpression
PipelineSnapshot
PipelineSource
PipelineValueExpression
_toProto
_validateUserData
PlanSummary
Query
_isCollectionGroupQuery
aggregate
count
endAt
endBefore
explain
explainStream
get
getInequalityFilterFields
isEqual
limit
limitToLast
offset
onSnapshot
orderBy
select
startAfter
startAt
stream
withConverter
QueryDocumentSnapshot
data
get
isEqual
QueryPartition
toQuery
QuerySnapshot
docChanges
forEach
isEqual
RegexValue
isEqual
RemoveFields
ReplaceWith
Sample
Search
Select
SnippetExpression
Sort
StructuredPipeline
_toProto
SubcollectionSource
Timestamp
isEqual
toDate
toInstant
toMillis
valueOf
fromDate
fromInstant
fromMillis
now
Transaction
create
delete
execute
get
getAll
set
update
withLazyStartedTransaction
Union
Unnest
UpdateStage
VariableExpression
_toProto
_validateUserData
VectorValue
isEqual
toArray
Where
WriteBatch
commit
create
delete
set
update
WriteResult
isEqual
Modules
@google-cloud/firestore
Global
SERVICE
and
array
conditional
countAll
countDistinct
countIf
currentDocument
currentTimestamp
detectMapRepresentation
documentMatches
field
geoDistance
isError
isMapValue
isTemporalInstant
map
nor
not
or
pipelineValue
rand
score
selectablesToMap
setLogFunction
switchOn
validateUserDataHelper
variable
xor
MaxKey
MaxKey
new MaxKey
()
Represents the Firestore "Max Key" data type.