WriteBatch

java.lang.Object
- org.rocksdb.AbstractNativeReference
- - org.rocksdb.AbstractImmutableNativeReference
  - - org.rocksdb.RocksObject
    - - org.rocksdb.AbstractWriteBatch
      - org.rocksdb.WriteBatch

所有已实现的接口:

java.lang.AutoCloseable, WriteBatchInterface
```
public class WriteBatch
extends AbstractWriteBatch
```
WriteBatch holds a collection of updates to apply atomically to a DB.
The updates are applied in the order in which they are added to the WriteBatch. For example, the value of "key" will be "v3" after the following batch is written:
batch.put("key", "v1"); batch.remove("key"); batch.put("key", "v2"); batch.put("key", "v3");
Multiple threads can invoke const methods on a WriteBatch without external synchronization, but if any of the threads may call a non-const method, all threads accessing the same WriteBatch must use external synchronization.

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`WriteBatch.Handler` Handler callback for iterating over the contents of a batch.
`static class`	`WriteBatch.SavePoint` A structure for describing the save point in the Write Batch.

字段概要
- 从类继承的字段 org.rocksdb.RocksObject
  nativeHandle_
- 从类继承的字段 org.rocksdb.AbstractImmutableNativeReference
  owningHandle_

构造器概要

构造器
构造器和说明
`WriteBatch()` Constructs a WriteBatch instance.
`WriteBatch(byte[] serialized)` Constructs a WriteBatch instance from a serialized representation as returned by `data()`.
`WriteBatch(int reserved_bytes)` Constructs a WriteBatch instance with a given size.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`byte[]`	`data()` Retrieve the serialized version of this batch.
`protected void`	`disposeInternal(long handle)`
`long`	`getDataSize()` Retrieve data size of the batch.
`WriteBatch.SavePoint`	`getWalTerminationPoint()` Gets the WAL termination point.
`WriteBatch`	`getWriteBatch()` Get the underlying Write Batch.
`boolean`	`hasBeginPrepare()` Returns true if MarkBeginPrepare will be called during Iterate.
`boolean`	`hasCommit()` Returns true if MarkCommit will be called during Iterate.
`boolean`	`hasDelete()` Returns true if Delete will be called during Iterate.
`boolean`	`hasDeleteRange()` Returns true if DeleteRange will be called during Iterate.
`boolean`	`hasEndPrepare()` Returns true if MarkEndPrepare will be called during Iterate.
`boolean`	`hasMerge()` Returns true if Merge will be called during Iterate.
`boolean`	`hasPut()` Returns true if Put will be called during Iterate.
`boolean`	`hasRollback()` Returns true if MarkRollback will be called during Iterate.
`boolean`	`hasSingleDelete()` Returns true if SingleDelete will be called during Iterate.
`void`	`iterate(WriteBatch.Handler handler)` Support for iterating over the contents of a batch.
`void`	`markWalTerminationPoint()` Marks this point in the WriteBatch as the last record to be inserted into the WAL, provided the WAL is enabled.

从类继承的方法 org.rocksdb.AbstractWriteBatch
clear, count, delete, delete, delete, delete, deleteRange, deleteRange, merge, merge, popSavePoint, put, put, put, put, putLogData, rollbackToSavePoint, setMaxBytes, setSavePoint, singleDelete, singleDelete

从类继承的方法 org.rocksdb.RocksObject
disposeInternal, getNativeHandle

从类继承的方法 org.rocksdb.AbstractImmutableNativeReference
close, disOwnNativeHandle, isOwningHandle

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

- 构造器详细资料
  - WriteBatch
```
public WriteBatch()
```
    Constructs a WriteBatch instance.
  - WriteBatch
```
public WriteBatch(int reserved_bytes)
```
    Constructs a WriteBatch instance with a given size.
    
    参数:
    
    reserved_bytes - reserved size for WriteBatch
  - WriteBatch
```
public WriteBatch(byte[] serialized)
```
    Constructs a WriteBatch instance from a serialized representation as returned by data().
    
    参数:
    
    serialized - the serialized representation.
- 方法详细资料
  - iterate
```
public void iterate(WriteBatch.Handler handler)
             throws RocksDBException
```
    Support for iterating over the contents of a batch.
    
    参数:
    
    handler - A handler that is called back for each update present in the batch
    
    抛出:
    
    RocksDBException - If we cannot iterate over the batch
  - data
```
public byte[] data()
            throws RocksDBException
```
    Retrieve the serialized version of this batch.
    
    返回:
    
    the serialized representation of this write batch.
    
    抛出:
    
    RocksDBException - if an error occurs whilst retrieving the serialized batch data.
  - getDataSize
```
public long getDataSize()
```
    Retrieve data size of the batch.
    
    返回:
    
    the serialized data size of the batch.
  - hasPut
```
public boolean hasPut()
```
    Returns true if Put will be called during Iterate.
    
    返回:
    
    true if Put will be called during Iterate.
  - hasDelete
```
public boolean hasDelete()
```
    Returns true if Delete will be called during Iterate.
    
    返回:
    
    true if Delete will be called during Iterate.
  - hasSingleDelete
```
public boolean hasSingleDelete()
```
    Returns true if SingleDelete will be called during Iterate.
    
    返回:
    
    true if SingleDelete will be called during Iterate.
  - hasDeleteRange
```
public boolean hasDeleteRange()
```
    Returns true if DeleteRange will be called during Iterate.
    
    返回:
    
    true if DeleteRange will be called during Iterate.
  - hasMerge
```
public boolean hasMerge()
```
    Returns true if Merge will be called during Iterate.
    
    返回:
    
    true if Merge will be called during Iterate.
  - hasBeginPrepare
```
public boolean hasBeginPrepare()
```
    Returns true if MarkBeginPrepare will be called during Iterate.
    
    返回:
    
    true if MarkBeginPrepare will be called during Iterate.
  - hasEndPrepare
```
public boolean hasEndPrepare()
```
    Returns true if MarkEndPrepare will be called during Iterate.
    
    返回:
    
    true if MarkEndPrepare will be called during Iterate.
  - hasCommit
```
public boolean hasCommit()
```
    Returns true if MarkCommit will be called during Iterate.
    
    返回:
    
    true if MarkCommit will be called during Iterate.
  - hasRollback
```
public boolean hasRollback()
```
    Returns true if MarkRollback will be called during Iterate.
    
    返回:
    
    true if MarkRollback will be called during Iterate.
  - getWriteBatch
```
public WriteBatch getWriteBatch()
```
    从接口复制的说明: WriteBatchInterface
    
    Get the underlying Write Batch.
    
    指定者:
    
    getWriteBatch 在接口中 WriteBatchInterface
    
    覆盖:
    
    getWriteBatch 在类中 AbstractWriteBatch
    
    返回:
    
    the underlying WriteBatch.
  - markWalTerminationPoint
```
public void markWalTerminationPoint()
```
    Marks this point in the WriteBatch as the last record to be inserted into the WAL, provided the WAL is enabled.
  - getWalTerminationPoint
```
public WriteBatch.SavePoint getWalTerminationPoint()
```
    Gets the WAL termination point.
    See markWalTerminationPoint()
    
    返回:
    
    the WAL termination point
  - disposeInternal
```
protected final void disposeInternal(long handle)
```
    指定者:
    
    disposeInternal 在类中 RocksObject

类 WriteBatch

嵌套类概要

字段概要

从类继承的字段 org.rocksdb.RocksObject

从类继承的字段 org.rocksdb.AbstractImmutableNativeReference

构造器概要

方法概要

从类继承的方法 org.rocksdb.AbstractWriteBatch

从类继承的方法 org.rocksdb.RocksObject

从类继承的方法 org.rocksdb.AbstractImmutableNativeReference

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

构造器详细资料

WriteBatch

WriteBatch

WriteBatch

方法详细资料

iterate

data

getDataSize

hasPut

hasDelete

hasSingleDelete

hasDeleteRange

hasMerge

hasBeginPrepare

hasEndPrepare

hasCommit

hasRollback

getWriteBatch

markWalTerminationPoint

getWalTerminationPoint

disposeInternal