SDK Client Reference

Classes

BulkWriter
BulkWriterError
CollectionGroup
- getPartitions
- withConverter
CollectionReference
DocumentChange
- isEqual
DocumentReference
DocumentSnapshot
FieldPath
- documentId
- isEqual
FieldValue
Firestore
BundledDocumentMetadata
BundledQuery
BundleElement
BundleMetadata
NamedQuery
GeoPoint
- isEqual
google.api.CustomHttpPattern
google.api.Http
google.api.HttpRule
google.api.ResourceDescriptor
google.api.ResourceReference
CreateIndexRequest
DeleteIndexRequest
ExportDocumentsMetadata
ExportDocumentsRequest
ExportDocumentsResponse
Field
IndexConfig
FieldOperationMetadata
IndexConfigDelta
FirestoreAdmin
GetFieldRequest
GetIndexRequest
ImportDocumentsMetadata
ImportDocumentsRequest
Index
IndexField
IndexOperationMetadata
ListFieldsRequest
ListFieldsResponse
ListIndexesRequest
ListIndexesResponse
LocationMetadata
Progress
UpdateFieldRequest
google.firestore.v1.ArrayValue
google.firestore.v1.BatchGetDocumentsRequest
google.firestore.v1.BatchGetDocumentsResponse
BatchWriteRequest
BatchWriteResponse
google.firestore.v1.BeginTransactionRequest
google.firestore.v1.BeginTransactionResponse
google.firestore.v1beta1.ArrayValue
google.firestore.v1beta1.BatchGetDocumentsRequest
google.firestore.v1beta1.BatchGetDocumentsResponse
google.firestore.v1beta1.BeginTransactionRequest
google.firestore.v1beta1.BeginTransactionResponse
google.firestore.v1beta1.CommitRequest
google.firestore.v1beta1.CommitResponse
google.firestore.v1beta1.CreateDocumentRequest
google.firestore.v1beta1.Cursor
google.firestore.v1beta1.DeleteDocumentRequest
google.firestore.v1beta1.Document
google.firestore.v1beta1.DocumentChange
google.firestore.v1beta1.DocumentDelete
google.firestore.v1beta1.DocumentMask
google.firestore.v1beta1.DocumentRemove
google.firestore.v1beta1.DocumentTransform
google.firestore.v1beta1.DocumentTransform.FieldTransform
google.firestore.v1beta1.ExistenceFilter
google.firestore.v1beta1.Firestore
google.firestore.v1beta1.GetDocumentRequest
google.firestore.v1beta1.ListCollectionIdsRequest
google.firestore.v1beta1.ListCollectionIdsResponse
google.firestore.v1beta1.ListDocumentsRequest
google.firestore.v1beta1.ListDocumentsResponse
google.firestore.v1beta1.ListenRequest
google.firestore.v1beta1.ListenResponse
google.firestore.v1beta1.MapValue
google.firestore.v1beta1.Precondition
google.firestore.v1beta1.RollbackRequest
google.firestore.v1beta1.RunQueryRequest
google.firestore.v1beta1.RunQueryResponse
google.firestore.v1beta1.StructuredQuery
google.firestore.v1beta1.StructuredQuery.CollectionSelector
google.firestore.v1beta1.StructuredQuery.CompositeFilter
google.firestore.v1beta1.StructuredQuery.FieldFilter
google.firestore.v1beta1.StructuredQuery.FieldReference
google.firestore.v1beta1.StructuredQuery.Filter
google.firestore.v1beta1.StructuredQuery.Order
google.firestore.v1beta1.StructuredQuery.Projection
google.firestore.v1beta1.StructuredQuery.UnaryFilter
google.firestore.v1beta1.Target
google.firestore.v1beta1.Target.DocumentsTarget
google.firestore.v1beta1.Target.QueryTarget
google.firestore.v1beta1.TargetChange
google.firestore.v1beta1.TransactionOptions
google.firestore.v1beta1.TransactionOptions.ReadOnly
google.firestore.v1beta1.TransactionOptions.ReadWrite
google.firestore.v1beta1.UpdateDocumentRequest
google.firestore.v1beta1.Value
google.firestore.v1beta1.Write
google.firestore.v1beta1.WriteRequest
google.firestore.v1beta1.WriteResponse
google.firestore.v1beta1.WriteResult
google.firestore.v1.CommitRequest
google.firestore.v1.CommitResponse
google.firestore.v1.CreateDocumentRequest
google.firestore.v1.Cursor
google.firestore.v1.DeleteDocumentRequest
google.firestore.v1.Document
google.firestore.v1.DocumentChange
google.firestore.v1.DocumentDelete
google.firestore.v1.DocumentMask
google.firestore.v1.DocumentRemove
google.firestore.v1.DocumentTransform
google.firestore.v1.DocumentTransform.FieldTransform
google.firestore.v1.ExistenceFilter
google.firestore.v1.Firestore
google.firestore.v1.GetDocumentRequest
google.firestore.v1.ListCollectionIdsRequest
google.firestore.v1.ListCollectionIdsResponse
google.firestore.v1.ListDocumentsRequest
google.firestore.v1.ListDocumentsResponse
google.firestore.v1.ListenRequest
google.firestore.v1.ListenResponse
google.firestore.v1.MapValue
PartitionQueryRequest
PartitionQueryResponse
google.firestore.v1.Precondition
google.firestore.v1.RollbackRequest
google.firestore.v1.RunQueryRequest
google.firestore.v1.RunQueryResponse
google.firestore.v1.StructuredQuery
google.firestore.v1.StructuredQuery.CollectionSelector
google.firestore.v1.StructuredQuery.CompositeFilter
google.firestore.v1.StructuredQuery.FieldFilter
google.firestore.v1.StructuredQuery.FieldReference
google.firestore.v1.StructuredQuery.Filter
google.firestore.v1.StructuredQuery.Order
google.firestore.v1.StructuredQuery.Projection
google.firestore.v1.StructuredQuery.UnaryFilter
google.firestore.v1.Target
google.firestore.v1.Target.DocumentsTarget
google.firestore.v1.Target.QueryTarget
google.firestore.v1.TargetChange
google.firestore.v1.TransactionOptions
google.firestore.v1.TransactionOptions.ReadOnly
google.firestore.v1.TransactionOptions.ReadWrite
google.firestore.v1.UpdateDocumentRequest
google.firestore.v1.Value
google.firestore.v1.Write
google.firestore.v1.WriteRequest
google.firestore.v1.WriteResponse
google.firestore.v1.WriteResult
google.longrunning.CancelOperationRequest
google.longrunning.DeleteOperationRequest
google.longrunning.GetOperationRequest
google.longrunning.ListOperationsRequest
google.longrunning.ListOperationsResponse
google.longrunning.Operation
google.longrunning.OperationInfo
google.longrunning.Operations
google.longrunning.WaitOperationRequest
google.protobuf.Any
google.protobuf.BoolValue
google.protobuf.BytesValue
google.protobuf.DescriptorProto
google.protobuf.DescriptorProto.ExtensionRange
google.protobuf.DescriptorProto.ReservedRange
google.protobuf.DoubleValue
google.protobuf.Duration
google.protobuf.Empty
google.protobuf.EnumDescriptorProto
google.protobuf.EnumOptions
google.protobuf.EnumValueDescriptorProto
google.protobuf.EnumValueOptions
google.protobuf.FieldDescriptorProto
google.protobuf.FieldMask
google.protobuf.FieldOptions
google.protobuf.FileDescriptorProto
google.protobuf.FileDescriptorSet
google.protobuf.FileOptions
google.protobuf.FloatValue
google.protobuf.GeneratedCodeInfo
google.protobuf.GeneratedCodeInfo.Annotation
google.protobuf.Int32Value
google.protobuf.Int64Value
google.protobuf.ListValue
google.protobuf.MessageOptions
google.protobuf.MethodDescriptorProto
google.protobuf.MethodOptions
google.protobuf.OneofDescriptorProto
google.protobuf.OneofOptions
google.protobuf.ServiceDescriptorProto
google.protobuf.ServiceOptions
google.protobuf.SourceCodeInfo
google.protobuf.SourceCodeInfo.Location
google.protobuf.StringValue
google.protobuf.Struct
google.protobuf.Timestamp
google.protobuf.UInt32Value
google.protobuf.UInt64Value
google.protobuf.UninterpretedOption
google.protobuf.UninterpretedOption.NamePart
google.protobuf.Value
google.rpc.Status
google.type.LatLng
Query
QueryDocumentSnapshot
QueryPartition
- toQuery
QuerySnapshot
Timestamp
Transaction
v1beta1.FirestoreClient
FirestoreAdminClient
v1.FirestoreClient
WriteBatch
WriteResult
- isEqual

Modules

@google-cloud/firestore

Global

getRetryCodes
getRetryParams
setLogFunction
silencePromise
WATCH_IDLE_TIMEOUT_MS

BulkWriterError

BulkWriterError

new BulkWriterError()

BulkWriterError

new BulkWriterError()

The error thrown when a BulkWriter operation fails.

Documentation generated by JSDoc 3.6.6