org.hibernate.ogm.datastore.mongodb.options

Annotation Type WriteConcern

@Target(value={TYPE,METHOD,FIELD})
 @Retention(value=RUNTIME)
public @interface WriteConcern

Specifies the write concern to be applied when performing write operations to the annotated entity or property. Can either be given using a pre-configured write concern such as WriteConcernType.JOURNALED or by specifying the type of a custom WriteConcern implementation.

When given on the property-level, this setting will only take effect when the property represents an association. If given for non-association properties, the setting on the property-level will be ignored and the setting from the entity will be applied.

Author:

Davide D'Alto <davide@hibernate.org>, Gunnar Morling

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
WriteConcernType	value Specifies the write concern to be applied when performing write operations to the annotated entity or property.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends com.mongodb.WriteConcern>	type Specifies a custom WriteConcern implementation.

Element Detail

value

public abstract WriteConcernType value

Specifies the write concern to be applied when performing write operations to the annotated entity or property.

Use WriteConcernType.CUSTOM in conjunction with type() to specify a custom WriteConcern implementation. This is useful in cases where the pre-defined configurations are not sufficient, e.g. if you want to ensure that writes are propagated to a specific number of replicas or given "tag set".

Returns:

the corresponding WriteConcernType

type

public abstract Class<? extends com.mongodb.WriteConcern> type

Specifies a custom WriteConcern implementation. Only takes effect if value() is set to WriteConcernType.CUSTOM. The specified type must have a default (no-args) constructor.

Returns:

the WriteConcern to use when WriteConcernType.CUSTOM is set

Default:

com.mongodb.WriteConcern.class