WriteConcern (mongo-java-driver 3.3.0-query-log-max-size API)

java.lang.Object
- com.mongodb.WriteConcern

所有已实现的接口:

java.io.Serializable

直接已知子类:

WriteConcern.Majority
```
@Immutable
public class WriteConcern
extends java.lang.Object
implements java.io.Serializable
```
Controls the acknowledgment of write operations with various options.

w
- 0: Don't wait for acknowledgement from the server
- 1: Wait for acknowledgement, but don't wait for secondaries to replicate
- >=2: Wait for one or more secondaries to also acknowledge
- "majority": Wait for a majority of secondaries to also acknowledge
- "<tag set name>": Wait for one or more secondaries to also acknowledge based on a tag set name
wtimeout - how long to wait for secondaries to acknowledge before failing
- 0: indefinite
- >0: time to wait in milliseconds
Other options:
- journal: If true block until write operations have been committed to the journal. Cannot be used in combination with fsync. Prior to MongoDB 2.6 this option was ignored if the server was running without journaling. Starting with MongoDB 2.6 write operations will fail with an exception if this option is used when the server is running without journaling.
另请参阅:

序列化表格

MongoDB documentation

Write Concern

Write Concern Reference

嵌套类概要

嵌套类
限定符和类型类和说明

static class WriteConcern.Majority
已过时。
Prefer MAJORITY, withWTimeout(long, TimeUnit), withJournal(Boolean)

嵌套类
限定符和类型	类和说明
`static class`	`WriteConcern.Majority` 已过时。 Prefer `MAJORITY`, `withWTimeout(long, TimeUnit)`, `withJournal(Boolean)`

字段概要

字段
限定符和类型	字段和说明
`static WriteConcern`	`ACKNOWLEDGED` Write operations that use this write concern will wait for acknowledgement, using the default write concern configured on the server.
`static WriteConcern`	`FSYNC_SAFE` 已过时。 Prefer `JOURNALED`
`static WriteConcern`	`FSYNCED` 已过时。 Prefer `JOURNALED`
`static WriteConcern`	`JOURNAL_SAFE` 已过时。 Prefer `JOURNALED`
`static WriteConcern`	`JOURNALED` Write operations wait for the server to group commit to the journal file on disk.
`static WriteConcern`	`MAJORITY` Exceptions are raised for network issues, and server errors; waits on a majority of servers for the write operation.
`static WriteConcern`	`NORMAL` 已过时。 Prefer `UNACKNOWLEDGED`
`static WriteConcern`	`REPLICA_ACKNOWLEDGED` 已过时。 Prefer WriteConcern#W2
`static WriteConcern`	`REPLICAS_SAFE` 已过时。 Prefer `W2`
`static WriteConcern`	`SAFE` 已过时。 Prefer `ACKNOWLEDGED`
`static WriteConcern`	`UNACKNOWLEDGED` Write operations that use this write concern will return as soon as the message is written to the socket.
`static WriteConcern`	`W1` Write operations that use this write concern will wait for acknowledgement from a single member.
`static WriteConcern`	`W2` Write operations that use this write concern will wait for acknowledgement from two members.
`static WriteConcern`	`W3` Write operations that use this write concern will wait for acknowledgement from three members.

构造器概要

构造器
构造器和说明
`WriteConcern()` 已过时。 Prefer `UNACKNOWLEDGED`
`WriteConcern(boolean fsync)` 已过时。 prefer `JOURNALED` or `withJournal(Boolean)`
`WriteConcern(int w)` Construct an instance with the given integer-based value for w.
`WriteConcern(int w, int wTimeoutMS)` Constructs an instance with the given integer-based value for w and the given value for wTimeoutMS.
`WriteConcern(int w, int wTimeoutMS, boolean fsync)` 已过时。 Prefer `withW(int)`, `withWTimeout(long, TimeUnit)`, `withJournal(Boolean)`
`WriteConcern(int w, int wTimeoutMS, boolean fsync, boolean journal)` 已过时。 Prefer `withW(int)`, `withWTimeout(long, TimeUnit)`, `withJournal(Boolean)`
`WriteConcern(java.lang.String w)` Construct an instance with the given tag set-based value for w.
`WriteConcern(java.lang.String w, int wTimeoutMS, boolean fsync, boolean journal)` 已过时。 Prefer `withW(String)`, `withWTimeout(long, TimeUnit)`, `withJournal(Boolean)`

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`BsonDocument`	`asDocument()` Gets this write concern as a document.
`boolean`	`callGetLastError()` 已过时。 Prefer `isAcknowledged()`
`boolean`	`equals(java.lang.Object o)`
`boolean`	`fsync()` 已过时。 Prefer `getJournal()`
`boolean`	`getFsync()` 已过时。 Prefer `getJournal()`
`boolean`	`getJ()` 已过时。 Prefer `getJournal()`
`java.lang.Boolean`	`getJournal()` Gets the journal property.
`int`	`getW()` Gets the w value as an integer.
`java.lang.Object`	`getWObject()` Gets the w value.
`java.lang.String`	`getWString()` Gets the w parameter as a String.
`int`	`getWtimeout()` 已过时。 Prefer `getWTimeout(TimeUnit)`
`java.lang.Integer`	`getWTimeout(java.util.concurrent.TimeUnit timeUnit)` Gets the wTimeout in the given time unit.
`int`	`hashCode()`
`boolean`	`isAcknowledged()` Returns true if this write concern indicates that write operations must be acknowledged.
`boolean`	`isServerDefault()` Gets whether this write concern indicates that the server's default write concern will be used.
`static WriteConcern.Majority`	`majorityWriteConcern(int wtimeout, boolean fsync, boolean j)` 已过时。 Prefer `MAJORITY`, `withWTimeout(long, TimeUnit)`, `withJournal(Boolean)`
`java.lang.String`	`toString()`
`static WriteConcern`	`valueOf(java.lang.String name)` Gets the WriteConcern constants by name (matching is done case insensitively).
`WriteConcern`	`withFsync(boolean fsync)` 已过时。 Prefer `withJournal(Boolean)`
`WriteConcern`	`withJ(boolean journal)` 已过时。 Prefer `withJournal(Boolean)`
`WriteConcern`	`withJournal(java.lang.Boolean journal)` Constructs a new WriteConcern from the current one and the specified journal value
`WriteConcern`	`withW(int w)` Constructs a new WriteConcern from the current one and the specified integer-based value for w
`WriteConcern`	`withW(java.lang.String w)` Constructs a new WriteConcern from the current one and the specified tag-set based value for w
`WriteConcern`	`withWTimeout(long wTimeout, java.util.concurrent.TimeUnit timeUnit)` Constructs a new WriteConcern from the current one and the specified wTimeout in the given time unit.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - ACKNOWLEDGED
```
public static final WriteConcern ACKNOWLEDGED
```
    Write operations that use this write concern will wait for acknowledgement, using the default write concern configured on the server.
    
    从以下版本开始:
    
    2.10.0
    
    MongoDB documentation
    
    Acknowledged
  - W1
```
public static final WriteConcern W1
```
    Write operations that use this write concern will wait for acknowledgement from a single member.
    
    从以下版本开始:
    
    3.2
    
    MongoDB documentation
    
    w option
  - W2
```
public static final WriteConcern W2
```
    Write operations that use this write concern will wait for acknowledgement from two members.
    
    从以下版本开始:
    
    3.2
    
    MongoDB documentation
    
    w option
  - W3
```
public static final WriteConcern W3
```
    Write operations that use this write concern will wait for acknowledgement from three members.
    
    从以下版本开始:
    
    3.2
    
    MongoDB documentation
    
    w option
  - UNACKNOWLEDGED
```
public static final WriteConcern UNACKNOWLEDGED
```
    Write operations that use this write concern will return as soon as the message is written to the socket. Exceptions are raised for network issues, but not server errors.
    
    从以下版本开始:
    
    2.10.0
    
    MongoDB documentation
    
    Unacknowledged
  - FSYNCED
```
@Deprecated
public static final WriteConcern FSYNCED
```
    已过时。 Prefer JOURNALED
    
    Write operations wait for the server to flush the data to disk.
  - JOURNALED
```
public static final WriteConcern JOURNALED
```
    Write operations wait for the server to group commit to the journal file on disk.
    
    MongoDB documentation
    
    Journaled
  - REPLICA_ACKNOWLEDGED
```
@Deprecated
public static final WriteConcern REPLICA_ACKNOWLEDGED
```
    已过时。 Prefer WriteConcern#W2
    
    Exceptions are raised for network issues, and server errors; waits for at least 2 servers for the write operation.
  - NORMAL
```
@Deprecated
public static final WriteConcern NORMAL
```
    已过时。 Prefer UNACKNOWLEDGED
    
    Write operations that use this write concern will return as soon as the message is written to the socket. Exceptions are raised for network issues, but not server errors.
    
    This field has been superseded by WriteConcern.UNACKNOWLEDGED, and may be deprecated in a future release.
    
    另请参阅:
    
    UNACKNOWLEDGED
  - SAFE
```
@Deprecated
public static final WriteConcern SAFE
```
    已过时。 Prefer ACKNOWLEDGED
    
    Write operations that use this write concern will wait for acknowledgement from the primary server before returning. Exceptions are raised for network issues, and server errors.
    
    This field has been superseded by WriteConcern.ACKNOWLEDGED, and may be deprecated in a future release.
    
    另请参阅:
    
    ACKNOWLEDGED
  - MAJORITY
```
public static final WriteConcern MAJORITY
```
    Exceptions are raised for network issues, and server errors; waits on a majority of servers for the write operation.
  - FSYNC_SAFE
```
@Deprecated
public static final WriteConcern FSYNC_SAFE
```
    已过时。 Prefer JOURNALED
    
    Exceptions are raised for network issues, and server errors; the write operation waits for the server to flush the data to disk.
    
    This field has been superseded by WriteConcern.FSYNCED, and may be deprecated in a future release.
    
    另请参阅:
    
    FSYNCED
  - JOURNAL_SAFE
```
@Deprecated
public static final WriteConcern JOURNAL_SAFE
```
    已过时。 Prefer JOURNALED
    
    Exceptions are raised for network issues, and server errors; the write operation waits for the server to group commit to the journal file on disk.
    
    This field has been superseded by WriteConcern.JOURNALED, and may be deprecated in a future release.
  - REPLICAS_SAFE
```
@Deprecated
public static final WriteConcern REPLICAS_SAFE
```
    已过时。 Prefer W2
    
    Exceptions are raised for network issues, and server errors; waits for at least 2 servers for the write operation.
    
    This field has been superseded by WriteConcern.REPLICA_ACKNOWLEDGED, and may be deprecated in a future release.
    
    另请参阅:
    
    W2
- 构造器详细资料
  - WriteConcern
```
@Deprecated
public WriteConcern()
```
    已过时。 Prefer UNACKNOWLEDGED
    
    Constructs an instance with all properties initialized to their default values, except for w, which is initialized to 0, making instances constructed this ways equivalent to WriteConcern#UNACKNOWLEDGED
    
    另请参阅:
    
    UNACKNOWLEDGED
  - WriteConcern
```
public WriteConcern(int w)
```
    Construct an instance with the given integer-based value for w.
    
    参数:
    
    w - number of servers to ensure write propagation to before acknowledgment, which must be >= 0
    
    MongoDB documentation
    
    w option
  - WriteConcern
```
public WriteConcern(java.lang.String w)
```
    Construct an instance with the given tag set-based value for w.
    
    参数:
    
    w - tag set name, or "majority", representing the servers to ensure write propagation to before acknowledgment. Do not use string representation of integer values for w
    
    MongoDB documentation
    
    Tag Sets
    
    w option
  - WriteConcern
```
public WriteConcern(int w,
                    int wTimeoutMS)
```
    Constructs an instance with the given integer-based value for w and the given value for wTimeoutMS.
    
    参数:
    
    w - the w value, which must be >= 0
    
    wTimeoutMS - the wTimeout in milliseconds, which must be >= 0
    
    MongoDB documentation
    
    w option
    
    wtimeout option
  - WriteConcern
```
@Deprecated
public WriteConcern(boolean fsync)
```
    已过时。 prefer JOURNALED or withJournal(Boolean)
    
    Constructs an instance with the given value for fsync.
    
    参数:
    
    fsync - whether or not to fsync
  - WriteConcern
```
@Deprecated
public WriteConcern(int w,
                                int wTimeoutMS,
                                boolean fsync)
```
    已过时。 Prefer withW(int), withWTimeout(long, TimeUnit), withJournal(Boolean)
    
    Constructs an instance with the given integer-based w value, wTimeout in milliseconds, and fsync value.
    
    参数:
    
    w - the w value, which must be >= 0
    
    wTimeoutMS - the wTimeout in milliseconds, which must be >= 0
    
    fsync - whether or not to fsync
    
    MongoDB documentation
    
    w option
    
    wtimeout option
  - WriteConcern
```
@Deprecated
public WriteConcern(int w,
                                int wTimeoutMS,
                                boolean fsync,
                                boolean journal)
```
    已过时。 Prefer withW(int), withWTimeout(long, TimeUnit), withJournal(Boolean)
    
    Constructs an instance with the given integer-based w value, wTimeout in milliseconds, fsync value, and journal value.
    
    参数:
    
    w - the w value, which must be >= 0
    
    wTimeoutMS - the wTimeout in milliseconds, which must be >= 0
    
    fsync - whether or not to fsync
    
    journal - whether writes should wait for a journaling group commit
    
    MongoDB documentation
    
    w option
    
    wtimeout option
    
    j option
  - WriteConcern
```
@Deprecated
public WriteConcern(java.lang.String w,
                                int wTimeoutMS,
                                boolean fsync,
                                boolean journal)
```
    已过时。 Prefer withW(String), withWTimeout(long, TimeUnit), withJournal(Boolean)
    
    Constructs an instance with the given String-based w value, wTimeout in milliseconds, fsync value, and journal value.
    
    参数:
    
    w - the w value, which must be non-null
    
    wTimeoutMS - the wTimeout in milliseconds, which must be >= 0
    
    fsync - whether or not to fsync
    
    journal - whether writes should wait for a journaling group commit
- 方法详细资料
  - getWObject
```
public java.lang.Object getWObject()
```
    Gets the w value.
    
    返回:
    
    w, either an instance of Integer or String or null
  - getW
```
public int getW()
```
    Gets the w value as an integer.
    
    返回:
    
    w as an int
    
    抛出:
    
    java.lang.IllegalStateException - if w is null or not an integer
  - getWString
```
public java.lang.String getWString()
```
    Gets the w parameter as a String.
    
    返回:
    
    w as a String
    
    抛出:
    
    java.lang.IllegalStateException - if w is null or not a String
  - getWTimeout
```
public java.lang.Integer getWTimeout(java.util.concurrent.TimeUnit timeUnit)
```
    Gets the wTimeout in the given time unit.
    
    参数:
    
    timeUnit - the non-null time unit for the result
    
    返回:
    
    the WTimeout, which may be null if a wTimeout has not been specified
    
    从以下版本开始:
    
    3.2
    
    MongoDB documentation
    
    wTimeout
  - getWtimeout
```
@Deprecated
public int getWtimeout()
```
    已过时。 Prefer getWTimeout(TimeUnit)
    
    Gets the wTimeout in milliseconds. If wTimeout has not been specified, returns 0.
    
    返回:
    
    the wTimeout in milliseconds
    
    MongoDB documentation
    
    wTimeout
  - getJournal
```
public java.lang.Boolean getJournal()
```
    Gets the journal property. The default value is null.
    
    返回:
    
    whether journal syncing is enabled, or null if unspecified.
    
    从以下版本开始:
    
    3.2
    
    MongoDB documentation
    
    Journaled
  - getJ
```
@Deprecated
public boolean getJ()
```
    已过时。 Prefer getJournal()
    
    Gets the journal property. If journal has not been specified, returns false.
    
    返回:
    
    true if journal is true, false if it false or unspecified.
    
    MongoDB documentation
    
    Journaled
  - getFsync
```
@Deprecated
public boolean getFsync()
```
    已过时。 Prefer getJournal()
    
    Gets the fsync property. If fsync has not been specified, returns false.
    
    返回:
    
    true if fsync is true, false if it false or unspecified
  - fsync
```
@Deprecated
public boolean fsync()
```
    已过时。 Prefer getJournal()
    
    Gets the fsync property. If fsync has not been specified, returns false.
    
    返回:
    
    true if fsync is true, false if it false or unspecified
  - callGetLastError
```
@Deprecated
public boolean callGetLastError()
```
    已过时。 Prefer isAcknowledged()
    
    Returns whether "getlasterror" should be called (w > 0)
    
    返回:
    
    whether this write concern will result in an an acknowledged write
  - isServerDefault
```
public boolean isServerDefault()
```
    Gets whether this write concern indicates that the server's default write concern will be used.
    
    返回:
    
    true if this write concern indicates that the server's default write concern will be used
    
    MongoDB documentation
    
    getLastErrorDefaults
  - asDocument
```
public BsonDocument asDocument()
```
    Gets this write concern as a document.
    
    返回:
    
    The write concern as a BsonDocument, even if w <= 0
  - isAcknowledged
```
public boolean isAcknowledged()
```
    Returns true if this write concern indicates that write operations must be acknowledged.
    
    返回:
    
    true w != null or w > 0 or journal is true or fsync is true
    
    MongoDB documentation
    
    Acknowledged
  - valueOf
```
public static WriteConcern valueOf(java.lang.String name)
```
    Gets the WriteConcern constants by name (matching is done case insensitively).
    
    参数:
    
    name - the name of the WriteConcern
    
    返回:
    
    the WriteConcern instance
  - equals
```
public boolean equals(java.lang.Object o)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - withW
```
public WriteConcern withW(int w)
```
    Constructs a new WriteConcern from the current one and the specified integer-based value for w
    
    参数:
    
    w - number of servers to ensure write propagation to before acknowledgment, which must be >= 0
    
    返回:
    
    the new WriteConcern
    
    MongoDB documentation
    
    Replica Acknowledged
  - withW
```
public WriteConcern withW(java.lang.String w)
```
    Constructs a new WriteConcern from the current one and the specified tag-set based value for w
    
    参数:
    
    w - tag set, or "majority", representing the servers to ensure write propagation to before acknowledgment. Do not use string representation of integer values for w
    
    返回:
    
    the new WriteConcern
    
    另请参阅:
    
    withW(int)
    
    MongoDB documentation
    
    Tag Sets
  - withFsync
```
@Deprecated
public WriteConcern withFsync(boolean fsync)
```
    已过时。 Prefer withJournal(Boolean)
    
    Constructs a new WriteConcern from the current one and the specified fsync value
    
    参数:
    
    fsync - true if the write concern needs to include fsync
    
    返回:
    
    the new WriteConcern
  - withJournal
```
public WriteConcern withJournal(java.lang.Boolean journal)
```
    Constructs a new WriteConcern from the current one and the specified journal value
    
    参数:
    
    journal - true if journalling is required for acknowledgement, false if not, or null if unspecified
    
    返回:
    
    the new WriteConcern
    
    从以下版本开始:
    
    3.2
    
    MongoDB documentation
    
    j option
  - withJ
```
@Deprecated
public WriteConcern withJ(boolean journal)
```
    已过时。 Prefer withJournal(Boolean)
    
    Constructs a new WriteConcern from the current one and the specified journal value
    
    参数:
    
    journal - true if journalling is required for acknowledgement
    
    返回:
    
    the new WriteConcern
    
    MongoDB documentation
    
    j option
  - withWTimeout
```
public WriteConcern withWTimeout(long wTimeout,
                                 java.util.concurrent.TimeUnit timeUnit)
```
    Constructs a new WriteConcern from the current one and the specified wTimeout in the given time unit.
    
    参数:
    
    wTimeout - the wTimeout, which must be >= 0 and <= Integer.MAX_VALUE after conversion to milliseconds
    
    timeUnit - the non-null time unit to apply to wTimeout
    
    返回:
    
    the WriteConcern with the given wTimeout
    
    从以下版本开始:
    
    3.2
    
    MongoDB documentation
    
    wtimeout option
  - majorityWriteConcern
```
@Deprecated
public static WriteConcern.Majority majorityWriteConcern(int wtimeout,
                                                                     boolean fsync,
                                                                     boolean j)
```
    已过时。 Prefer MAJORITY, withWTimeout(long, TimeUnit), withJournal(Boolean)
    
    Create a Majority Write Concern that requires a majority of servers to acknowledge the write.
    
    参数:
    
    wtimeout - timeout for write operation
    
    fsync - whether or not to fsync
    
    j - whether writes should wait for a journal group commit
    
    返回:
    
    Majority, a subclass of WriteConcern that represents the write concern requiring most servers to acknowledge the write

类 WriteConcern

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

ACKNOWLEDGED

W1

W2

W3

UNACKNOWLEDGED

FSYNCED

JOURNALED

REPLICA_ACKNOWLEDGED

NORMAL

SAFE

MAJORITY

FSYNC_SAFE

JOURNAL_SAFE

REPLICAS_SAFE

构造器详细资料

WriteConcern

WriteConcern

WriteConcern

WriteConcern

WriteConcern

WriteConcern

WriteConcern

WriteConcern

方法详细资料

getWObject

getW

getWString

getWTimeout

getWtimeout

getJournal

getJ

getFsync

fsync

callGetLastError

isServerDefault

asDocument

isAcknowledged

valueOf

equals

hashCode

toString

withW

withW

withFsync

withJournal

withJ

withWTimeout

majorityWriteConcern