Package com.mongodb.client.model.bulk

Interface ClientUpdateManyOptions

@Sealed public interface ClientUpdateManyOptions
The options to apply when updating documents.
Since:
5.3

  • Method Details

    • clientUpdateManyOptions

      static ClientUpdateManyOptions clientUpdateManyOptions()
      Creates the default options.
      Returns:
      The default options.

    • arrayFilters

      ClientUpdateManyOptions arrayFilters(@Nullable Iterable<? extends org.bson.conversions.Bson> arrayFilters)
      Sets the filters specifying to which array elements an update should apply.
      Parameters:
      arrayFilters - The array filters. null represents the server default.
      Returns:
      this.
      See Also:

    • collation

      ClientUpdateManyOptions collation(@Nullable Collation collation)
      Sets the collation.
      Parameters:
      collation - The collation. null represents the server default.
      Returns:
      this.

    • hint

      ClientUpdateManyOptions hint(@Nullable org.bson.conversions.Bson hint)
      Sets the index specification, null-ifies hint string.
      Parameters:
      hint - The index specification. null represents the server default.
      Returns:
      this.

    • hintString

      ClientUpdateManyOptions hintString(@Nullable String hintString)
      Sets the index name, null-ifies hint.
      Parameters:
      hintString - The index name. null represents the server default.
      Returns:
      this.

    • upsert

      ClientUpdateManyOptions upsert(@Nullable Boolean upsert)
      Enables or disables creation of a document if no documents match the filter.
      Parameters:
      upsert - The upsert flag. null represents the server default.
      Returns:
      this.