Package com.mongodb.client.model

Class InsertManyOptions

java.lang.Object
com.mongodb.client.model.InsertManyOptions
public final class InsertManyOptions extends Object
The options to apply to an operation that inserts multiple documents into a collection.
Since:
3.0
MongoDB documentation
Insert Tutorial
Insert Command

  • Constructor Details

    • InsertManyOptions

      public InsertManyOptions()

  • Method Details

    • isOrdered

      public boolean isOrdered()
      Gets whether the documents should be inserted in the order provided, stopping on the first failed insertion. The default is true. If false, the server will attempt to insert all the documents regardless of an failures.
      Returns:
      whether the documents should be inserted in order

    • ordered

      public InsertManyOptions ordered(boolean ordered)
      Sets whether the server should insert the documents in the order provided.
      Parameters:
      ordered - true if documents should be inserted in order
      Returns:
      this

    • getBypassDocumentValidation

      @Nullable public Boolean getBypassDocumentValidation()
      Gets the bypass document level validation flag
      Returns:
      the bypass document level validation flag
      Since:
      3.2
      Since server release
      3.2

    • bypassDocumentValidation

      public InsertManyOptions bypassDocumentValidation(@Nullable Boolean bypassDocumentValidation)
      Sets the bypass document level validation flag.

      For bulk operations use: BulkWriteOptions.bypassDocumentValidation(Boolean)

      Parameters:
      bypassDocumentValidation - If true, allows the write to opt-out of document level validation.
      Returns:
      this
      Since:
      3.2
      Since server release
      3.2

    • getComment

      @Nullable public BsonValue getComment()
      Returns:
      the comment for this operation. A null value means no comment is set.
      Since:
      4.6
      Since server release
      4.4

    • comment

      public InsertManyOptions comment(@Nullable String comment)
      Sets the comment for this operation. A null value means no comment is set.

      For bulk operations use: BulkWriteOptions.comment(String)

      Parameters:
      comment - the comment
      Returns:
      this
      Since:
      4.6
      Since server release
      4.4

    • comment

      public InsertManyOptions comment(@Nullable BsonValue comment)
      Sets the comment for this operation. A null value means no comment is set.

      For bulk operations use: BulkWriteOptions.comment(BsonValue)

      Parameters:
      comment - the comment
      Returns:
      this
      Since:
      4.6
      Since server release
      4.4

    • toString

      public String toString()
      Overrides:
      toString in class Object