Package com.mongodb

Class InsertOptions

java.lang.Object

com.mongodb.InsertOptions

public final class InsertOptions
extends Object

Options related to insertion of documents into MongoDB. The setter methods return this so that a chaining style can be used.

Since:

2.13

MongoDB documentation

Insert Tutorial

Constructor Summary

Constructors

Constructor	Description
InsertOptions()

Method Summary

Modifier and Type	Method	Description
InsertOptions	bypassDocumentValidation(Boolean bypassDocumentValidation)	Sets whether to bypass document validation.
InsertOptions	continueOnError(boolean continueOnError)	Set whether documents will continue to be inserted after a failure to insert one.
InsertOptions	dbEncoder(DBEncoder dbEncoder)	Set the encoder to use for the documents.
Boolean	getBypassDocumentValidation()	Gets whether to bypass document validation, or null if unspecified.
DBEncoder	getDbEncoder()	The encoder to use for the documents.
WriteConcern	getWriteConcern()	The write concern to use for the insertion.
boolean	isContinueOnError()	Whether documents will continue to be inserted after a failure to insert one (most commonly due to a duplicate key error).
InsertOptions	writeConcern(WriteConcern writeConcern)	Set the write concern to use for the insert.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InsertOptions

public InsertOptions()

Method Detail

writeConcern

public InsertOptions writeConcern(@Nullable
                                  WriteConcern writeConcern)

Set the write concern to use for the insert.

Parameters:

writeConcern - the write concern

Returns:

this

continueOnError

public InsertOptions continueOnError(boolean continueOnError)

Set whether documents will continue to be inserted after a failure to insert one.

Parameters:

continueOnError - whether to continue on error

Returns:

this

dbEncoder

public InsertOptions dbEncoder(@Nullable
                               DBEncoder dbEncoder)

Set the encoder to use for the documents.

Parameters:

dbEncoder - the encoder

Returns:

this

getWriteConcern

@Nullable
public WriteConcern getWriteConcern()

The write concern to use for the insertion. By default the write concern configured for the DBCollection instance will be used.

Returns:

the write concern, or null if the default will be used.

isContinueOnError

public boolean isContinueOnError()

Whether documents will continue to be inserted after a failure to insert one (most commonly due to a duplicate key error). Note that this only is relevant for multi-document inserts. The default value is false.

Returns:

whether insertion will continue on error.

getDbEncoder

@Nullable
public DBEncoder getDbEncoder()

The encoder to use for the documents. By default the codec configured for the DBCollection instance will be used.

Returns:

the encoder, or null if the default will be used

getBypassDocumentValidation

@Nullable
public Boolean getBypassDocumentValidation()

Gets whether to bypass document validation, or null if unspecified. The default is null.

Returns:

whether to bypass document validation, or null if unspecified.

Since:

2.14

Since server release

3.2

bypassDocumentValidation

public InsertOptions bypassDocumentValidation(@Nullable
                                              Boolean bypassDocumentValidation)

Sets whether to bypass document validation.

Parameters:

bypassDocumentValidation - whether to bypass document validation, or null if unspecified

Returns:

this

Since:

2.14

Since server release

3.2