BulkWriteOptions

io.github.zeal18.zio.mongodb.driver.model.BulkWriteOptions
final case class BulkWriteOptions(ordered: Boolean, bypassDocumentValidation: Option[Boolean], comment: Option[BsonValue], variables: Option[Bson])

The options to apply to a bulk write.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

def withBypassDocumentValidation(bypassDocumentValidation: Boolean): BulkWriteOptions

Sets the bypass document level validation flag.

Sets the bypass document level validation flag.

Attributes

bypassDocumentValidation

If true, allows the write to opt-out of document level validation.

def withComment(comment: BsonValue): BulkWriteOptions

Sets the comment for this operation.

Sets the comment for this operation.

Attributes

comment

the comment

def withOrdered(ordered: Boolean): BulkWriteOptions

If true, then when a write fails, return without performing the remaining writes. If false, then when a write fails, continue with the remaining writes, if any. Defaults to true.

If true, then when a write fails, return without performing the remaining writes. If false, then when a write fails, continue with the remaining writes, if any. Defaults to true.

Attributes

ordered

true if the writes should be ordered

def withVariables(variables: Bson): BulkWriteOptions

Add top-level variables for the operation

Add top-level variables for the operation

Allows for improved command readability by separating the variables from the query text. The value of let will be passed to all update and delete, but not insert, commands.

Attributes

variables

for the operation or null

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product