A Firestore BulkWriter that can be used to perform a large number of writes in parallel.
BulkWriter
Package
@google-cloud/firestoreConstructors
(constructor)(firestore, options)
constructor
(
firestore
:
Firestore
,
options
?:
firestore
.
BulkWriterOptions
);
Constructs a new instance of the BulkWriter
class
Methods
close()
close
()
:
Promise<void>
;
Commits all enqueued writes and marks the BulkWriter instance as closed.
After calling close()
, calling any method will throw an error. Any retries scheduled as part of an onWriteError()
handler will be run before the close()
promise resolves.
Returns a Promise that resolves when there are no more pending writes. The Promise will never be rejected. Calling this method will send all requests. The promise resolves immediately if there are no pending writes.
{Promise
Promise
<void>
let
bulkWriter
=
firestore
.
bulkWriter
();
bulkWriter
.
create
(
documentRef
,
{
foo
:
'bar'
});
bulkWriter
.
update
(
documentRef2
,
{
foo
:
'bar'
});
bulkWriter
.
delete
(
documentRef3
);
await
close
().
then
(()
=
>
{
console
.
log
(
'Executed all writes'
);
});
create(documentRef, data)
create<AppModelType
,
DbModelType
extends
firestore
.
DocumentData
> (
documentRef
:
firestore
.
DocumentReference<AppModelType
,
DbModelType
> ,
data
:
firestore
.
WithFieldValue<AppModelType>
)
:
Promise<WriteResult>
;
Create a document with the provided data. This single operation will fail if a document exists at its location.
documentRef
FirebaseFirestore.DocumentReference
<AppModelType, DbModelType>
A reference to the document to be created.
data
FirebaseFirestore.WithFieldValue
<AppModelType>
The object to serialize as the document.
AppModelType
DbModelType
let
bulkWriter
=
firestore
.
bulkWriter
();
let
documentRef
=
firestore
.
collection
(
'col'
).
doc
();
bulkWriter
.
create
(
documentRef
,
{
foo
:
'bar'
})
.
then
(
result
=
>
{
console
.
log
(
'Successfully executed write at: '
,
result
);
})
.
catch
(
err
=
>
{
console
.
log
(
'Write failed with: '
,
err
);
});
});
delete(documentRef, precondition)
delete<AppModelType
,
DbModelType
extends
firestore
.
DocumentData
> (
documentRef
:
firestore
.
DocumentReference<AppModelType
,
DbModelType
> ,
precondition
?:
firestore
.
Precondition
)
:
Promise<WriteResult>
;
Delete a document from the database.
documentRef
FirebaseFirestore.DocumentReference
<AppModelType, DbModelType>
A reference to the document to be deleted.
precondition
firestore.Precondition
A precondition to enforce for this delete.
AppModelType
DbModelType
let
bulkWriter
=
firestore
.
bulkWriter
();
let
documentRef
=
firestore
.
doc
(
'col/doc'
);
bulkWriter
.
delete
(
documentRef
)
.
then
(
result
=
>
{
console
.
log
(
'Successfully deleted document'
);
})
.
catch
(
err
=
>
{
console
.
log
(
'Delete failed with: '
,
err
);
});
});
flush()
flush
()
:
Promise<void>
;
Commits all writes that have been enqueued up to this point in parallel.
Returns a Promise that resolves when all currently queued operations have been committed. The Promise will never be rejected since the results for each individual operation are conveyed via their individual Promises.
The Promise resolves immediately if there are no pending writes. Otherwise, the Promise waits for all previously issued writes, but it does not wait for writes that were added after the method is called. If you want to wait for additional writes, call flush()
again.
{Promise
Promise
<void>
let
bulkWriter
=
firestore
.
bulkWriter
();
bulkWriter
.
create
(
documentRef
,
{
foo
:
'bar'
});
bulkWriter
.
update
(
documentRef2
,
{
foo
:
'bar'
});
bulkWriter
.
delete
(
documentRef3
);
await
flush
().
then
(()
=
>
{
console
.
log
(
'Executed all writes'
);
});
onWriteError(shouldRetryCallback)
onWriteError
(
shouldRetryCallback
:
(
error
:
BulkWriterError
)
=
>
boolean
)
:
void
;
Attaches an error handler listener that is run every time a BulkWriter operation fails.
BulkWriter has a default error handler that retries UNAVAILABLE and ABORTED errors up to a maximum of 10 failed attempts. When an error handler is specified, the default error handler will be overwritten.
shouldRetryCallback
(error: BulkWriterError
) => boolean
A callback to be called every time a BulkWriter operation fails. Returning true
will retry the operation. Returning false
will stop the retry loop.
void
let
bulkWriter
=
firestore
.
bulkWriter
();
bulkWriter
.
onWriteError
((
error
)
=
>
{
if
(
error
.
code
===
GrpcStatus
.
UNAVAILABLE
&&
error
.
failedAttempts
<
max_retry_attempts
=
""
)
=
""
{
=
""
return
=
""
true
;
=
""
}
=
""
else
=
""
{
=
""
console
.
log
(
'failed="" write="" at="" document:="" '
,
=
""
error
.
documentref
);
=
""
return
=
""
false
;
=
""
}
=
""
});
=
""
>
onWriteResult(successCallback)
onWriteResult
(
successCallback
:
(
documentRef
:
firestore
.
DocumentReference<any
,
any
> ,
result
:
WriteResult
)
=
>
void
)
:
void
;
Attaches a listener that is run every time a BulkWriter operation successfully completes.
successCallback
(documentRef: FirebaseFirestore.DocumentReference
<any, any>, result: WriteResult
) => void
A callback to be called every time a BulkWriter operation successfully completes.
void
let
bulkWriter
=
firestore
.
bulkWriter
();
bulkWriter
.
onWriteResult
((
documentRef
,
result
)
=
>
{
console
.
log
(
'Successfully executed write on document: '
,
documentRef
,
' at: '
,
result
);
});
set(documentRef, data, options)
set<AppModelType
,
DbModelType
extends
firestore
.
DocumentData
> (
documentRef
:
firestore
.
DocumentReference<AppModelType
,
DbModelType
> ,
data
:
Partial<AppModelType>
,
options
:
firestore
.
SetOptions
)
:
Promise<WriteResult>
;
documentRef
FirebaseFirestore.DocumentReference
<AppModelType, DbModelType>
data
Partial
<AppModelType>
options
firestore.SetOptions
AppModelType
DbModelType
set(documentRef, data)
set<AppModelType
,
DbModelType
extends
firestore
.
DocumentData
> (
documentRef
:
firestore
.
DocumentReference<AppModelType
,
DbModelType
> ,
data
:
AppModelType
)
:
Promise<WriteResult>
;
documentRef
FirebaseFirestore.DocumentReference
<AppModelType, DbModelType>
data
AppModelType
AppModelType
DbModelType
update(documentRef, dataOrField, preconditionOrValues)
update<AppModelType
,
DbModelType
extends
firestore
.
DocumentData
> (
documentRef
:
firestore
.
DocumentReference<AppModelType
,
DbModelType
> ,
dataOrField
:
firestore
.
UpdateData<DbModelType>
|
string
|
FieldPath
,
...
preconditionOrValues
:
Array
< {
lastUpdateTime
?:
Timestamp
;
}
|
unknown
|
string
|
FieldPath
> )
:
Promise<WriteResult>
;
Update fields of the document referred to by the provided [DocumentReference] DocumentReference . If the document doesn't yet exist, the update fails and the entire batch will be rejected.
The update() method accepts either an object with field paths encoded as keys and field values encoded as values, or a variable number of arguments that alternate between field paths and field values. Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.
A Precondition restricting this update can be specified as the last argument.
documentRef
FirebaseFirestore.DocumentReference
<AppModelType, DbModelType>
A reference to the document to be updated.
dataOrField
FirebaseFirestore.UpdateData
<DbModelType> | string | FieldPath
An object containing the fields and values with which to update the document or the path of the first field to update.
AppModelType
DbModelType
let
bulkWriter
=
firestore
.
bulkWriter
();
let
documentRef
=
firestore
.
doc
(
'col/doc'
);
bulkWriter
.
update
(
documentRef
,
{
foo
:
'bar'
})
.
then
(
result
=
>
{
console
.
log
(
'Successfully executed write at: '
,
result
);
})
.
catch
(
err
=
>
{
console
.
log
(
'Write failed with: '
,
err
);
});
});
