Class MongoItemWriter<T>

java.lang.Object
org.springframework.batch.infrastructure.item.data.MongoItemWriter<T>
All Implemented Interfaces:
ItemWriter<T>
public class MongoItemWriter<T> extends Object implements ItemWriter<T>

A ItemWriter implementation that writes to a MongoDB store using an implementation of Spring Data's MongoOperations. Since MongoDB is not a transactional store, a best effort is made to persist written data at the last moment, yet still honor job status contracts. No attempt to roll back is made if an error occurs during writing.

This writer is thread-safe once all properties are set (normal singleton behavior) so it can be used in multiple concurrent transactions.

Author:
Michael Minella, Parikshit Dutta, Mahmoud Ben Hassine, Stefano Cordio

  • Constructor Details

    • MongoItemWriter

      public MongoItemWriter(org.springframework.data.mongodb.core.MongoOperations template)
      Create a new instance of MongoItemWriter with the provided MongoOperations template. The template is required.
      Parameters:
      template - the template implementation to be used. Must not be null.
      Since:
      6.0

  • Method Details

    • setMode

      public void setMode(MongoItemWriter.Mode mode)
      Set the operating MongoItemWriter.Mode to be applied by this writer. Defaults to MongoItemWriter.Mode.UPSERT.
      Parameters:
      mode - the mode to be used.
      Since:
      5.1

    • getMode

      public MongoItemWriter.Mode getMode()
      Get the operating MongoItemWriter.Mode of the item writer.
      Returns:
      the operating mode
      Since:
      5.1

    • setTemplate

      public void setTemplate(org.springframework.data.mongodb.core.MongoOperations template)
      Set the MongoOperations to be used to save items to be written.
      Parameters:
      template - the template implementation to be used.

    • getTemplate

      protected org.springframework.data.mongodb.core.MongoOperations getTemplate()
      Get the MongoOperations to be used to save items to be written. This can be called by a subclass if necessary.
      Returns:
      template the template implementation to be used.

    • setCollection

      public void setCollection(@Nullable String collection)
      Set the name of the Mongo collection to be written to.
      Parameters:
      collection - the name of the collection.

    • getCollection

      public @Nullable String getCollection()
      Get the Mongo collection name.
      Returns:
      the collection name
      Since:
      5.1

    • setPrimaryKeys

      public void setPrimaryKeys(List<String> primaryKeys)
      Set the primary keys to associate with the document being written. These fields should uniquely identify a single object.
      Parameters:
      primaryKeys - The primary keys to use.
      Since:
      5.2.3

    • getPrimaryKeys

      public List<String> getPrimaryKeys()
      Get the list of primary keys associated with the document being written.
      Returns:
      the list of primary keys
      Since:
      5.2.3

    • write

      public void write(Chunk<? extends T> chunk) throws Exception
      If a transaction is active, buffer items to be written just before commit. Otherwise write items using the provided template.
      Specified by:
      write in interface ItemWriter<T>
      Parameters:
      chunk - of items to be written. Must not be null.
      Throws:
      Exception - if there are errors. The framework will catch the exception and convert or rethrow it as appropriate.
      See Also:

    • doWrite

      protected void doWrite(Chunk<? extends T> chunk)
      Performs the actual write to the store via the template. This can be overridden by a subclass if necessary.
      Parameters:
      chunk - the chunk of items to be persisted.