public final class BulkWriter implements AutoCloseableA Firestore BulkWriter that can be used to perform a large number of writes in parallel.
Implements
AutoCloseableStatic Fields
MAX_BATCH_SIZE
public static final int MAX_BATCH_SIZEThe maximum number of writes that can be in a single batch.
| Type | Description |
| int |
MAX_RETRY_ATTEMPTS
public static final int MAX_RETRY_ATTEMPTSThe maximum number of retries that will be attempted with backoff before stopping all retry attempts.
| Type | Description |
| int |
RETRY_MAX_BATCH_SIZE
public static final int RETRY_MAX_BATCH_SIZEThe maximum number of writes that can be in a batch containing retries.
| Type | Description |
| int |
Methods
addWriteErrorListener(BulkWriter.WriteErrorCallback onError)
public void addWriteErrorListener(BulkWriter.WriteErrorCallback onError)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.
For example, see the sample code:
BulkWriter bulkWriter = firestore.bulkWriter();
bulkWriter.addWriteErrorListener(
(BulkWriterException error) -> {
if (error.getStatus() == Status.UNAVAILABLE
&& error.getFailedAttempts() < MAX_RETRY_ATTEMPTS) {
return true;
} else {
System.out.println("Failed write at document: " + error.getDocumentReference());
return false;
}
}
);
| Name | Description |
| onError | BulkWriter.WriteErrorCallbackA callback to be called every time a BulkWriter operation fails. Returning
|
addWriteErrorListener(Executor executor, BulkWriter.WriteErrorCallback onError)
public void addWriteErrorListener(Executor executor, BulkWriter.WriteErrorCallback onError)Attaches an error handler listener that is run every time a BulkWriter operation fails.
The executor cannot be changed once writes have been enqueued onto the BulkWriter.
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.
For example, see the sample code:
BulkWriter bulkWriter = firestore.bulkWriter();
bulkWriter.addWriteErrorListener(
(BulkWriterException error) -> {
if (error.getStatus() == Status.UNAVAILABLE
&& error.getFailedAttempts() < MAX_RETRY_ATTEMPTS) {
return true;
} else {
System.out.println("Failed write at document: " + error.getDocumentReference());
return false;
}
}
);
| Name | Description |
| executor | ExecutorThe executor to run the provided callback on. |
| onError | BulkWriter.WriteErrorCallbackA callback to be called every time a BulkWriter operation fails. Returning
|
addWriteResultListener(BulkWriter.WriteResultCallback writeResultCallback)
public void addWriteResultListener(BulkWriter.WriteResultCallback writeResultCallback)Attaches a listener that is run every time a BulkWriter operation successfully completes. The
listener will be run before close() completes.
For example, see the sample code:
BulkWriter bulkWriter = firestore.bulkWriter();
bulkWriter.addWriteResultListener(
(DocumentReference documentReference, WriteResult result) -> {
System.out.println(
"Successfully executed write on document: "
- documentReference
- " at: "
- result.getUpdateTime()); } );
| Name | Description |
| writeResultCallback | BulkWriter.WriteResultCallbackA callback to be called every time a BulkWriter operation successfully completes. |
addWriteResultListener(Executor executor, BulkWriter.WriteResultCallback writeResultCallback)
public void addWriteResultListener(Executor executor, BulkWriter.WriteResultCallback writeResultCallback)Attaches a listener that is run every time a BulkWriter operation successfully completes.
The executor cannot be changed once writes have been enqueued onto the BulkWriter.
For example, see the sample code:
BulkWriter bulkWriter = firestore.bulkWriter();
bulkWriter.addWriteResultListener(
(DocumentReference documentReference, WriteResult result) -> {
System.out.println(
"Successfully executed write on document: "
- documentReference
- " at: "
- result.getUpdateTime()); } );
| Name | Description |
| executor | ExecutorThe executor to run the provided callback on. |
| writeResultCallback | BulkWriter.WriteResultCallbackA callback to be called every time a BulkWriter operation successfully completes. |
close()
public void close()Commits all enqueued writes and marks the BulkWriter instance as closed.
After calling close(), calling any method will return an error. Any retries scheduled with
addWriteErrorListener() will be run before close() completes.
This method completes when there are no more pending writes. Calling this method will send all requests.
| Type | Description |
| InterruptedException | |
| ExecutionException |
create(DocumentReference documentReference, Object pojo)
public ApiFuture<WriteResult> create(DocumentReference documentReference, Object pojo)Create a document with the provided data. This single operation will fail if a document exists at its location.
| Name | Description |
| documentReference | DocumentReferenceA reference to the document to be created. |
| pojo | ObjectThe POJO that will be used to populate the document contents. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing the result of the write. Contains a BulkWriterException if the write fails. |
create(DocumentReference documentReference, Map<String,Object> fields)
public ApiFuture<WriteResult> create(DocumentReference documentReference, Map<String,Object> fields)Create a document with the provided data. This single operation will fail if a document exists at its location.
| Name | Description |
| documentReference | DocumentReferenceA reference to the document to be created. |
| fields | Map<String,Object>A map of the fields and values for the document. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing the result of the write. Contains a BulkWriterException if the write fails. |
delete(DocumentReference documentReference)
public ApiFuture<WriteResult> delete(DocumentReference documentReference)Delete a document from the database.
| Name | Description |
| documentReference | DocumentReferenceThe DocumentReference to delete. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing a sentinel value (Timestamp(0)) for the delete operation. Contains a BulkWriterException if the delete fails. |
delete(DocumentReference documentReference, Precondition precondition)
public ApiFuture<WriteResult> delete(DocumentReference documentReference, Precondition precondition)Delete a document from the database.
| Name | Description |
| documentReference | DocumentReferenceThe DocumentReference to delete. |
| precondition | PreconditionPrecondition to enforce for this delete. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing a sentinel value (Timestamp(0)) for the delete operation. Contains a BulkWriterException if the delete fails. |
flush()
public ApiFuture<Void> flush()Commits all writes that have been enqueued up to this point in parallel.
Returns an ApiFuture that completes when all currently queued operations have been committed. The ApiFuture will never return an error since the results for each individual operation are conveyed via their individual ApiFutures.
The ApiFuture completes immediately if there are no pending writes. Otherwise, the ApiFuture
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.
| Type | Description |
| ApiFuture<Void> | An ApiFuture that completes when all enqueued writes up to this point have been committed. |
set(DocumentReference documentReference, Object pojo)
public ApiFuture<WriteResult> set(DocumentReference documentReference, Object pojo)Write to the document referred to by the provided DocumentReference. If the document does not exist yet, it will be created.
| Name | Description |
| documentReference | DocumentReferenceA reference to the document to be set. |
| pojo | ObjectThe POJO that will be used to populate the document contents. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing the result of the write. Contains a BulkWriterException if the write fails. |
set(DocumentReference documentReference, Object pojo, SetOptions options)
public ApiFuture<WriteResult> set(DocumentReference documentReference, Object pojo, SetOptions options)Write to the document referred to by the provided DocumentReference. If the document does not exist yet, it will be created. If you pass a SetOptions, the provided data can be merged into an existing document.
| Name | Description |
| documentReference | DocumentReferenceA reference to the document to be set. |
| pojo | ObjectThe POJO that will be used to populate the document contents. |
| options | SetOptionsAn object to configure the set behavior. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing the result of the write. Contains a BulkWriterException if the write fails. |
set(DocumentReference documentReference, Map<String,Object> fields)
public ApiFuture<WriteResult> set(DocumentReference documentReference, Map<String,Object> fields)Write to the document referred to by the provided DocumentReference. If the document does not exist yet, it will be created.
| Name | Description |
| documentReference | DocumentReferenceA reference to the document to be set. |
| fields | Map<String,Object>A map of the fields and values for the document. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing the result of the write. Contains a BulkWriterException if the write fails. |
set(DocumentReference documentReference, Map<String,Object> fields, SetOptions options)
public ApiFuture<WriteResult> set(DocumentReference documentReference, Map<String,Object> fields, SetOptions options)Write to the document referred to by the provided DocumentReference. If the document does not exist yet, it will be created. If you pass a SetOptions, the provided data can be merged into an existing document.
| Name | Description |
| documentReference | DocumentReferenceA reference to the document to be set. |
| fields | Map<String,Object>A map of the fields and values for the document. |
| options | SetOptionsAn object to configure the set behavior. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing the result of the write. Contains a BulkWriterException if the write fails. |
update(DocumentReference documentReference, FieldPath fieldPath, Object value, Object[] moreFieldsAndValues)
public ApiFuture<WriteResult> update(DocumentReference documentReference, FieldPath fieldPath, Object value, Object[] moreFieldsAndValues)Update fields of the document referred to by the provided DocumentReference. If the document doesn't yet exist, the update will fail.
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.
| Name | Description |
| documentReference | DocumentReferenceA reference to the document to be updated. |
| fieldPath | FieldPathThe first field to set. |
| value | ObjectThe first value to set. |
| moreFieldsAndValues | Object[]String and Object pairs with more fields to be set. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing the result of the write. Contains a BulkWriterException if the write fails. |
update(DocumentReference documentReference, Precondition precondition, FieldPath fieldPath, Object value, Object[] moreFieldsAndValues)
public ApiFuture<WriteResult> update(DocumentReference documentReference, Precondition precondition, FieldPath fieldPath, Object value, Object[] moreFieldsAndValues)Update fields of the document referred to by the provided DocumentReference. If the document doesn't yet exist, the update will fail.
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.
| Name | Description |
| documentReference | DocumentReferenceA reference to the document to be updated. |
| precondition | PreconditionPrecondition to enforce on this update. |
| fieldPath | FieldPathThe first field to set. |
| value | ObjectThe first value to set. |
| moreFieldsAndValues | Object[]String and Object pairs with more fields to be set. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing the result of the write. Contains a BulkWriterException if the write fails. |
update(DocumentReference documentReference, Precondition precondition, String field, Object value, Object[] moreFieldsAndValues)
public ApiFuture<WriteResult> update(DocumentReference documentReference, Precondition precondition, String field, Object value, Object[] moreFieldsAndValues)Update fields of the document referred to by the provided DocumentReference. If the document doesn't yet exist, the update will fail.
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.
| Name | Description |
| documentReference | DocumentReferenceA reference to the document to be updated. |
| precondition | Precondition |
| field | StringThe first field to set. |
| value | ObjectThe first value to set. |
| moreFieldsAndValues | Object[]String and Object pairs with more fields to be set. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing the result of the write. Contains a BulkWriterException if the write fails. |
update(DocumentReference documentReference, String field, Object value, Object[] moreFieldsAndValues)
public ApiFuture<WriteResult> update(DocumentReference documentReference, String field, Object value, Object[] moreFieldsAndValues)Update fields of the document referred to by the provided DocumentReference. If the document doesn't yet exist, the update will fail.
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.
| Name | Description |
| documentReference | DocumentReferenceA reference to the document to be updated. |
| field | StringThe first field to set. |
| value | ObjectThe first value to set. |
| moreFieldsAndValues | Object[]String and Object pairs with more fields to be set. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing the result of the write. Contains a BulkWriterException if the write fails. |
update(DocumentReference documentReference, Map<String,Object> fields)
public ApiFuture<WriteResult> update(DocumentReference documentReference, Map<String,Object> fields)Update fields of the document referred to by the provided DocumentReference. If the document doesn't yet exist, the update will fail.
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.
| Name | Description |
| documentReference | DocumentReferenceA reference to the document to be updated. |
| fields | Map<String,Object>A map of the fields and values for the document. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing the result of the write. Contains a BulkWriterException if the write fails. |
update(DocumentReference documentReference, Map<String,Object> fields, Precondition precondition)
public ApiFuture<WriteResult> update(DocumentReference documentReference, Map<String,Object> fields, Precondition precondition)Update fields of the document referred to by the provided DocumentReference. If the document doesn't yet exist, the update will fail.
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.
| Name | Description |
| documentReference | DocumentReferenceA reference to the document to be updated. |
| fields | Map<String,Object>A map of the fields and values for the document. |
| precondition | PreconditionPrecondition to enforce on this update. |
| Type | Description |
| ApiFuture<WriteResult> | An ApiFuture containing the result of the write. Contains a BulkWriterException if the write fails. |