SDK Client Reference
Classes
Aggregate
toProto
AggregateField
isEqual
average
count
sum
AggregateQuery
explain
get
isEqual
AggregateQuerySnapshot
data
isEqual
BulkWriter
close
create
delete
flush
onWriteError
onWriteResult
set
update
BulkWriterError
BundleBuilder
add
CollectionGroup
getPartitions
CollectionReference
add
aggregate
count
doc
endAt
endBefore
explain
explainStream
findNearest
get
getInequalityFilterFields
isEqual
limit
limitToLast
listDocuments
offset
onSnapshot
orderBy
select
startAfter
startAt
stream
withConverter
DocumentChange
isEqual
DocumentReference
collection
create
delete
get
isEqual
listCollections
onSnapshot
set
update
withConverter
DocumentSnapshot
data
get
isEqual
ExecutionStats
ExplainMetrics
ExplainResults
FieldPath
isEqual
documentId
FieldValue
isEqual
arrayRemove
arrayUnion
delete
increment
serverTimestamp
vector
Filter
and
or
where
Firestore
batch
bulkWriter
bundle
collection
collectionGroup
doc
getAll
listCollections
recursiveDelete
runTransaction
settings
terminate
toJSON
GeoPoint
isEqual
PlanSummary
Query
aggregate
count
endAt
endBefore
explain
explainStream
findNearest
get
getInequalityFilterFields
isEqual
limit
limitToLast
offset
onSnapshot
orderBy
select
startAfter
startAt
stream
withConverter
QueryDocumentSnapshot
data
get
isEqual
QueryPartition
toQuery
QuerySnapshot
docChanges
forEach
isEqual
Timestamp
isEqual
toDate
toMillis
valueOf
fromDate
fromMillis
now
Transaction
create
delete
get
getAll
set
update
VectorValue
isEqual
toArray
WriteBatch
commit
create
delete
set
update
WriteResult
isEqual
FirestoreAdminClient
backupPath
backupSchedulePath
cancelOperation
checkCreateDatabaseProgress
checkCreateIndexProgress
checkDeleteDatabaseProgress
checkExportDocumentsProgress
checkImportDocumentsProgress
checkRestoreDatabaseProgress
checkUpdateDatabaseProgress
checkUpdateFieldProgress
close
collectionGroupPath
databasePath
deleteOperation
fieldPath
getLocation
getOperation
getProjectId
indexPath
initialize
listFieldsAsync
listFieldsStream
listIndexesAsync
listIndexesStream
listLocationsAsync
listOperationsAsync
locationPath
matchBackupFromBackupName
matchBackupScheduleFromBackupScheduleName
matchCollectionFromCollectionGroupName
matchCollectionFromFieldName
matchCollectionFromIndexName
matchDatabaseFromBackupScheduleName
matchDatabaseFromCollectionGroupName
matchDatabaseFromDatabaseName
matchDatabaseFromFieldName
matchDatabaseFromIndexName
matchFieldFromFieldName
matchIndexFromIndexName
matchLocationFromBackupName
matchLocationFromLocationName
matchProjectFromBackupName
matchProjectFromBackupScheduleName
matchProjectFromCollectionGroupName
matchProjectFromDatabaseName
matchProjectFromFieldName
matchProjectFromIndexName
matchProjectFromLocationName
matchProjectFromProjectName
projectPath
v1.FirestoreClient
batchGetDocuments
close
getLocation
getProjectId
initialize
listCollectionIdsAsync
listCollectionIdsStream
listDocumentsAsync
listDocumentsStream
listLocationsAsync
listen
partitionQueryAsync
partitionQueryStream
runAggregationQuery
runQuery
write
v1beta1.FirestoreClient
batchGetDocuments
close
getProjectId
initialize
listCollectionIdsAsync
listCollectionIdsStream
listDocumentsAsync
listDocumentsStream
listen
partitionQueryAsync
partitionQueryStream
runQuery
write
Modules
@google-cloud/firestore
Global
gapicConfig
setLogFunction
PlanSummary
PlanSummary
new PlanSummary
()
PlanSummary contains information about the planning stage of a query.