RocksDB

java.lang.Object
- org.rocksdb.RocksObject
- - org.rocksdb.RocksDB

Direct Known Subclasses:

BackupableDB
```
public class RocksDB
extends RocksObject
```
A RocksDB is a persistent ordered map from keys to values. It is safe for concurrent access from multiple threads without any external synchronization. All methods of this class could potentially throw RocksDBException, which indicates sth wrong at the RocksDB library side and the call failed.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String DEFAULT_COLUMN_FAMILY

static int NOT_FOUND

protected DBOptionsInterface options_
- Fields inherited from class org.rocksdb.RocksObject
  nativeHandle_

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_COLUMN_FAMILY`
`static int`	`NOT_FOUND`
`protected DBOptionsInterface`	`options_`

Constructor Summary

Constructors
Modifier Constructor and Description

protected RocksDB()
Private constructor.

Constructors
Modifier	Constructor and Description
`protected`	`RocksDB()` Private constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close the RocksDB instance.
`ColumnFamilyHandle`	`createColumnFamily(ColumnFamilyDescriptor columnFamilyDescriptor)` Creates a new column family with the name columnFamilyName and allocates a ColumnFamilyHandle within an internal structure.
`protected void`	`disposeInternal()` The helper function of `dispose()` which all subclasses of `RocksObject` must implement to release their associated C++ resource.
`void`	`dropColumnFamily(ColumnFamilyHandle columnFamilyHandle)` Drops the column family identified by columnFamilyName.
`void`	`flush(FlushOptions flushOptions)` Flush all memory table data.
`void`	`flush(FlushOptions flushOptions, ColumnFamilyHandle columnFamilyHandle)` Flush all memory table data.
`byte[]`	`get(byte[] key)` The simplified version of get which returns a new byte array storing the value associated with the specified input key if any.
`int`	`get(byte[] key, byte[] value)` Get the value associated with the specified key within column family*
`byte[]`	`get(ColumnFamilyHandle columnFamilyHandle, byte[] key)` The simplified version of get which returns a new byte array storing the value associated with the specified input key if any.
`int`	`get(ColumnFamilyHandle columnFamilyHandle, byte[] key, byte[] value)` Get the value associated with the specified key within column family.
`byte[]`	`get(ColumnFamilyHandle columnFamilyHandle, ReadOptions opt, byte[] key)` The simplified version of get which returns a new byte array storing the value associated with the specified input key if any.
`int`	`get(ColumnFamilyHandle columnFamilyHandle, ReadOptions opt, byte[] key, byte[] value)` Get the value associated with the specified key within column family.
`protected byte[]`	`get(long handle, byte[] key, int keyLen)`
`protected int`	`get(long handle, byte[] key, int keyLen, byte[] value, int valueLen)`
`protected int`	`get(long handle, byte[] key, int keyLen, byte[] value, int valueLen, long cfHandle)`
`protected byte[]`	`get(long handle, byte[] key, int keyLen, long cfHandle)`
`protected byte[]`	`get(long handle, long readOptHandle, byte[] key, int keyLen)`
`protected int`	`get(long handle, long readOptHandle, byte[] key, int keyLen, byte[] value, int valueLen)`
`protected int`	`get(long handle, long readOptHandle, byte[] key, int keyLen, byte[] value, int valueLen, long cfHandle)`
`protected byte[]`	`get(long handle, long readOptHandle, byte[] key, int keyLen, long cfHandle)`
`byte[]`	`get(ReadOptions opt, byte[] key)` The simplified version of get which returns a new byte array storing the value associated with the specified input key if any.
`int`	`get(ReadOptions opt, byte[] key, byte[] value)` Get the value associated with the specified key.
`long`	`getLongProperty(ColumnFamilyHandle columnFamilyHandle, java.lang.String property)` Similar to GetProperty(), but only works for a subset of properties whose return value is a numerical value.
`protected long`	`getLongProperty(long nativeHandle, long cfHandle, java.lang.String property, int propertyLength)`
`protected long`	`getLongProperty(long nativeHandle, java.lang.String property, int propertyLength)`
`long`	`getLongProperty(java.lang.String property)` Similar to GetProperty(), but only works for a subset of properties whose return value is a numerical value.
`java.lang.String`	`getProperty(ColumnFamilyHandle columnFamilyHandle, java.lang.String property)` DB implements can export properties about their state via this method on a per column family level.
`java.lang.String`	`getProperty(java.lang.String property)` DB implementations can export properties about their state via this method.
`protected java.lang.String`	`getProperty0(long nativeHandle, long cfHandle, java.lang.String property, int propertyLength)`
`protected java.lang.String`	`getProperty0(long nativeHandle, java.lang.String property, int propertyLength)`
`Snapshot`	`getSnapshot()` Return a handle to the current DB state.
`protected long`	`getSnapshot(long nativeHandle)`
`protected long`	`iterator0(long handle)`
`protected long`	`iterator0(long handle, long cfHandle)`
`protected long[]`	`iterators(long handle, java.util.List<ColumnFamilyHandle> columnFamilyNames)`
`protected boolean`	`keyMayExist(byte[] key, int keyLen, long cfHandle, java.lang.StringBuffer stringBuffer)`
`protected boolean`	`keyMayExist(byte[] key, int keyLen, java.lang.StringBuffer stringBuffer)`
`boolean`	`keyMayExist(byte[] key, java.lang.StringBuffer value)` If the key definitely does not exist in the database, then this method returns false, else true.
`boolean`	`keyMayExist(ColumnFamilyHandle columnFamilyHandle, byte[] key, java.lang.StringBuffer value)` If the key definitely does not exist in the database, then this method returns false, else true.
`protected boolean`	`keyMayExist(long optionsHandle, byte[] key, int keyLen, long cfHandle, java.lang.StringBuffer stringBuffer)`
`protected boolean`	`keyMayExist(long optionsHandle, byte[] key, int keyLen, java.lang.StringBuffer stringBuffer)`
`boolean`	`keyMayExist(ReadOptions readOptions, byte[] key, java.lang.StringBuffer value)` If the key definitely does not exist in the database, then this method returns false, else true.
`boolean`	`keyMayExist(ReadOptions readOptions, ColumnFamilyHandle columnFamilyHandle, byte[] key, java.lang.StringBuffer value)` If the key definitely does not exist in the database, then this method returns false, else true.
`protected static java.util.List<byte[]>`	`listColumnFamilies(long optionsHandle, java.lang.String path)`
`static java.util.List<byte[]>`	`listColumnFamilies(Options options, java.lang.String path)` Static method to determine all available column families for a rocksdb database identified by path
`static void`	`loadLibrary()` Loads the necessary library files.
`static void`	`loadLibrary(java.util.List<java.lang.String> paths)` Tries to load the necessary library files from the given list of directories.
`void`	`merge(byte[] key, byte[] value)` Add merge operand for key/value pair.
`void`	`merge(ColumnFamilyHandle columnFamilyHandle, byte[] key, byte[] value)` Add merge operand for key/value pair in a ColumnFamily.
`void`	`merge(ColumnFamilyHandle columnFamilyHandle, WriteOptions writeOpts, byte[] key, byte[] value)` Add merge operand for key/value pair.
`protected void`	`merge(long handle, byte[] key, int keyLen, byte[] value, int valueLen)`
`protected void`	`merge(long handle, byte[] key, int keyLen, byte[] value, int valueLen, long cfHandle)`
`protected void`	`merge(long handle, long writeOptHandle, byte[] key, int keyLen, byte[] value, int valueLen)`
`protected void`	`merge(long handle, long writeOptHandle, byte[] key, int keyLen, byte[] value, int valueLen, long cfHandle)`
`void`	`merge(WriteOptions writeOpts, byte[] key, byte[] value)` Add merge operand for key/value pair.
`java.util.Map<byte[],byte[]>`	`multiGet(java.util.List<byte[]> keys)` Returns a map of keys for which values were found in DB.
`java.util.Map<byte[],byte[]>`	`multiGet(java.util.List<ColumnFamilyHandle> columnFamilyHandleList, java.util.List<byte[]> keys)` Returns a map of keys for which values were found in DB.
`protected java.util.List<byte[]>`	`multiGet(long dbHandle, java.util.List<byte[]> keys, int keysCount)`
`protected java.util.List<byte[]>`	`multiGet(long dbHandle, java.util.List<byte[]> keys, int keysCount, java.util.List<ColumnFamilyHandle> cfHandles)`
`protected java.util.List<byte[]>`	`multiGet(long dbHandle, long rOptHandle, java.util.List<byte[]> keys, int keysCount)`
`protected java.util.List<byte[]>`	`multiGet(long dbHandle, long rOptHandle, java.util.List<byte[]> keys, int keysCount, java.util.List<ColumnFamilyHandle> cfHandles)`
`java.util.Map<byte[],byte[]>`	`multiGet(ReadOptions opt, java.util.List<byte[]> keys)` Returns a map of keys for which values were found in DB.
`java.util.Map<byte[],byte[]>`	`multiGet(ReadOptions opt, java.util.List<ColumnFamilyHandle> columnFamilyHandleList, java.util.List<byte[]> keys)` Returns a map of keys for which values were found in DB.
`RocksIterator`	`newIterator()` Return a heap-allocated iterator over the contents of the database.
`RocksIterator`	`newIterator(ColumnFamilyHandle columnFamilyHandle)` Return a heap-allocated iterator over the contents of the database.
`java.util.List<RocksIterator>`	`newIterators(java.util.List<ColumnFamilyHandle> columnFamilyHandleList)` Returns iterators from a consistent database state across multiple column families.
`static RocksDB`	`open(DBOptions options, java.lang.String path, java.util.List<ColumnFamilyDescriptor> columnFamilyDescriptors, java.util.List<ColumnFamilyHandle> columnFamilyHandles)` The factory constructor of RocksDB that opens a RocksDB instance given the path to the database using the specified options and db path and a list of column family names.
`protected void`	`open(long optionsHandle, java.lang.String path)`
`protected java.util.List<java.lang.Long>`	`open(long optionsHandle, java.lang.String path, java.util.List<ColumnFamilyDescriptor> columnFamilyDescriptors, int columnFamilyDescriptorsLength)`
`static RocksDB`	`open(Options options, java.lang.String path)` The factory constructor of RocksDB that opens a RocksDB instance given the path to the database using the specified options and db path.
`static RocksDB`	`open(java.lang.String path)` The factory constructor of RocksDB that opens a RocksDB instance given the path to the database using the default options w/ createIfMissing set to true.
`static RocksDB`	`open(java.lang.String path, java.util.List<ColumnFamilyDescriptor> columnFamilyDescriptors, java.util.List<ColumnFamilyHandle> columnFamilyHandles)` The factory constructor of RocksDB that opens a RocksDB instance given the path to the database using the specified options and db path and a list of column family names.
`static RocksDB`	`openReadOnly(DBOptions options, java.lang.String path, java.util.List<ColumnFamilyDescriptor> columnFamilyDescriptors, java.util.List<ColumnFamilyHandle> columnFamilyHandles)` The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the specified options and db path.
`static RocksDB`	`openReadOnly(Options options, java.lang.String path)` The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the specified options and db path.
`static RocksDB`	`openReadOnly(java.lang.String path)` The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the default options.
`static RocksDB`	`openReadOnly(java.lang.String path, java.util.List<ColumnFamilyDescriptor> columnFamilyDescriptors, java.util.List<ColumnFamilyHandle> columnFamilyHandles)` The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the default options.
`protected void`	`openROnly(long optionsHandle, java.lang.String path)`
`protected java.util.List<java.lang.Long>`	`openROnly(long optionsHandle, java.lang.String path, java.util.List<ColumnFamilyDescriptor> columnFamilyDescriptors, int columnFamilyDescriptorsLength)`
`void`	`put(byte[] key, byte[] value)` Set the database entry for "key" to "value".
`void`	`put(ColumnFamilyHandle columnFamilyHandle, byte[] key, byte[] value)` Set the database entry for "key" to "value" in the specified column family.
`void`	`put(ColumnFamilyHandle columnFamilyHandle, WriteOptions writeOpts, byte[] key, byte[] value)` Set the database entry for "key" to "value" for the specified column family.
`protected void`	`put(long handle, byte[] key, int keyLen, byte[] value, int valueLen)`
`protected void`	`put(long handle, byte[] key, int keyLen, byte[] value, int valueLen, long cfHandle)`
`protected void`	`put(long handle, long writeOptHandle, byte[] key, int keyLen, byte[] value, int valueLen)`
`protected void`	`put(long handle, long writeOptHandle, byte[] key, int keyLen, byte[] value, int valueLen, long cfHandle)`
`void`	`put(WriteOptions writeOpts, byte[] key, byte[] value)` Set the database entry for "key" to "value".
`protected void`	`releaseSnapshot(long nativeHandle, long snapshotHandle)`
`void`	`releaseSnapshot(Snapshot snapshot)` Release a previously acquired snapshot.
`void`	`remove(byte[] key)` Remove the database entry (if any) for "key".
`void`	`remove(ColumnFamilyHandle columnFamilyHandle, byte[] key)` Remove the database entry (if any) for "key".
`void`	`remove(ColumnFamilyHandle columnFamilyHandle, WriteOptions writeOpt, byte[] key)` Remove the database entry (if any) for "key".
`protected void`	`remove(long handle, byte[] key, int keyLen)`
`protected void`	`remove(long handle, byte[] key, int keyLen, long cfHandle)`
`protected void`	`remove(long handle, long writeOptHandle, byte[] key, int keyLen)`
`protected void`	`remove(long handle, long writeOptHandle, byte[] key, int keyLen, long cfHandle)`
`void`	`remove(WriteOptions writeOpt, byte[] key)` Remove the database entry (if any) for "key".
`protected void`	`write(long writeOptHandle, long batchHandle)`
`void`	`write(WriteOptions writeOpts, WriteBatch updates)` Apply the specified updates to the database.

Methods inherited from class org.rocksdb.RocksObject
disOwnNativeHandle, dispose, finalize, isInitialized, isOwningNativeHandle

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_COLUMN_FAMILY
```
public static final java.lang.String DEFAULT_COLUMN_FAMILY
```
    See Also:
    
    Constant Field Values
  - NOT_FOUND
```
public static final int NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - options_
```
protected DBOptionsInterface options_
```
- Constructor Detail
  - RocksDB
```
protected RocksDB()
```
    Private constructor.
- Method Detail
  - loadLibrary
```
public static void loadLibrary()
```
    Loads the necessary library files. Calling this method twice will have no effect. By default the method extracts the shared library for loading at java.io.tmpdir, however, you can override this temporary location by setting the environment variable ROCKSDB_SHAREDLIB_DIR.
  - loadLibrary
```
public static void loadLibrary(java.util.List<java.lang.String> paths)
```
    Tries to load the necessary library files from the given list of directories.
    
    Parameters:
    
    paths - a list of strings where each describes a directory of a library.
  - open
```
public static RocksDB open(java.lang.String path)
                    throws RocksDBException
```
    The factory constructor of RocksDB that opens a RocksDB instance given the path to the database using the default options w/ createIfMissing set to true.
    
    Parameters:
    
    path - the path to the rocksdb.
    
    Returns:
    
    a RocksDB instance on success, null if the specified RocksDB can not be opened.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
    
    See Also:
    
    Options.setCreateIfMissing(boolean)
  - open
```
public static RocksDB open(java.lang.String path,
                           java.util.List<ColumnFamilyDescriptor> columnFamilyDescriptors,
                           java.util.List<ColumnFamilyHandle> columnFamilyHandles)
                    throws RocksDBException
```
    The factory constructor of RocksDB that opens a RocksDB instance given the path to the database using the specified options and db path and a list of column family names.
    If opened in read write mode every existing column family name must be passed within the list to this method.
    
    If opened in read-only mode only a subset of existing column families must be passed to this method.
    
    Options instance *should* not be disposed before all DBs using this options instance have been closed. If user doesn't call options dispose explicitly, then this options instance will be GC'd automatically
    
    ColumnFamily handles are disposed when the RocksDB instance is disposed.
    
    Parameters:
    
    path - the path to the rocksdb.
    
    columnFamilyDescriptors - list of column family descriptors
    
    columnFamilyHandles - will be filled with ColumnFamilyHandle instances on open.
    
    Returns:
    
    a RocksDB instance on success, null if the specified RocksDB can not be opened.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
    
    See Also:
    
    DBOptions.setCreateIfMissing(boolean)
  - open
```
public static RocksDB open(Options options,
                           java.lang.String path)
                    throws RocksDBException
```
    The factory constructor of RocksDB that opens a RocksDB instance given the path to the database using the specified options and db path.
    Options instance *should* not be disposed before all DBs using this options instance have been closed. If user doesn't call options dispose explicitly, then this options instance will be GC'd automatically.
    
    Options instance can be re-used to open multiple DBs if DB statistics is not used. If DB statistics are required, then its recommended to open DB with new Options instance as underlying native statistics instance does not use any locks to prevent concurrent updates.
    
    Parameters:
    
    options - Options instance.
    
    path - the path to the rocksdb.
    
    Returns:
    
    a RocksDB instance on success, null if the specified RocksDB can not be opened.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
    
    See Also:
    
    Options.setCreateIfMissing(boolean)
  - open
```
public static RocksDB open(DBOptions options,
                           java.lang.String path,
                           java.util.List<ColumnFamilyDescriptor> columnFamilyDescriptors,
                           java.util.List<ColumnFamilyHandle> columnFamilyHandles)
                    throws RocksDBException
```
    The factory constructor of RocksDB that opens a RocksDB instance given the path to the database using the specified options and db path and a list of column family names.
    If opened in read write mode every existing column family name must be passed within the list to this method.
    
    If opened in read-only mode only a subset of existing column families must be passed to this method.
    
    Options instance *should* not be disposed before all DBs using this options instance have been closed. If user doesn't call options dispose explicitly, then this options instance will be GC'd automatically.
    
    Options instance can be re-used to open multiple DBs if DB statistics is not used. If DB statistics are required, then its recommended to open DB with new Options instance as underlying native statistics instance does not use any locks to prevent concurrent updates.
    
    ColumnFamily handles are disposed when the RocksDB instance is disposed.
    
    Parameters:
    
    options - DBOptions instance.
    
    path - the path to the rocksdb.
    
    columnFamilyDescriptors - list of column family descriptors
    
    columnFamilyHandles - will be filled with ColumnFamilyHandle instances on open.
    
    Returns:
    
    a RocksDB instance on success, null if the specified RocksDB can not be opened.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
    
    See Also:
    
    DBOptions.setCreateIfMissing(boolean)
  - openReadOnly
```
public static RocksDB openReadOnly(java.lang.String path)
                            throws RocksDBException
```
    The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the default options.
    
    Parameters:
    
    path - the path to the RocksDB.
    
    Returns:
    
    a RocksDB instance on success, null if the specified RocksDB can not be opened.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - openReadOnly
```
public static RocksDB openReadOnly(java.lang.String path,
                                   java.util.List<ColumnFamilyDescriptor> columnFamilyDescriptors,
                                   java.util.List<ColumnFamilyHandle> columnFamilyHandles)
                            throws RocksDBException
```
    The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the default options.
    
    Parameters:
    
    path - the path to the RocksDB.
    
    columnFamilyDescriptors - list of column family descriptors
    
    columnFamilyHandles - will be filled with ColumnFamilyHandle instances on open.
    
    Returns:
    
    a RocksDB instance on success, null if the specified RocksDB can not be opened.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - openReadOnly
```
public static RocksDB openReadOnly(Options options,
                                   java.lang.String path)
                            throws RocksDBException
```
    The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the specified options and db path. Options instance *should* not be disposed before all DBs using this options instance have been closed. If user doesn't call options dispose explicitly, then this options instance will be GC'd automatically.
    
    Parameters:
    
    options - Options instance.
    
    path - the path to the RocksDB.
    
    Returns:
    
    a RocksDB instance on success, null if the specified RocksDB can not be opened.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - openReadOnly
```
public static RocksDB openReadOnly(DBOptions options,
                                   java.lang.String path,
                                   java.util.List<ColumnFamilyDescriptor> columnFamilyDescriptors,
                                   java.util.List<ColumnFamilyHandle> columnFamilyHandles)
                            throws RocksDBException
```
    The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the specified options and db path.
    This open method allows to open RocksDB using a subset of available column families
    
    Options instance *should* not be disposed before all DBs using this options instance have been closed. If user doesn't call options dispose explicitly,then this options instance will be GC'd automatically.
    
    Parameters:
    
    options - DBOptions instance.
    
    path - the path to the RocksDB.
    
    columnFamilyDescriptors - list of column family descriptors
    
    columnFamilyHandles - will be filled with ColumnFamilyHandle instances on open.
    
    Returns:
    
    a RocksDB instance on success, null if the specified RocksDB can not be opened.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - listColumnFamilies
```
public static java.util.List<byte[]> listColumnFamilies(Options options,
                                                        java.lang.String path)
                                                 throws RocksDBException
```
    Static method to determine all available column families for a rocksdb database identified by path
    
    Parameters:
    
    options - Options for opening the database
    
    path - Absolute path to rocksdb database
    
    Returns:
    
    List<byte[]> List containing the column family names
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - disposeInternal
```
protected void disposeInternal()
```
    Description copied from class: RocksObject
    
    The helper function of dispose() which all subclasses of RocksObject must implement to release their associated C++ resource.
    
    Specified by:
    
    disposeInternal in class RocksObject
  - close
```
public void close()
```
    Close the RocksDB instance. This function is equivalent to dispose().
  - put
```
public void put(byte[] key,
                byte[] value)
         throws RocksDBException
```
    Set the database entry for "key" to "value".
    
    Parameters:
    
    key - the specified key to be inserted.
    
    value - the value associated with the specified key.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - put
```
public void put(ColumnFamilyHandle columnFamilyHandle,
                byte[] key,
                byte[] value)
         throws RocksDBException
```
    Set the database entry for "key" to "value" in the specified column family.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    key - the specified key to be inserted.
    
    value - the value associated with the specified key. throws IllegalArgumentException if column family is not present
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - put
```
public void put(WriteOptions writeOpts,
                byte[] key,
                byte[] value)
         throws RocksDBException
```
    Set the database entry for "key" to "value".
    
    Parameters:
    
    writeOpts - WriteOptions instance.
    
    key - the specified key to be inserted.
    
    value - the value associated with the specified key.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - put
```
public void put(ColumnFamilyHandle columnFamilyHandle,
                WriteOptions writeOpts,
                byte[] key,
                byte[] value)
         throws RocksDBException
```
    Set the database entry for "key" to "value" for the specified column family.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    writeOpts - WriteOptions instance.
    
    key - the specified key to be inserted.
    
    value - the value associated with the specified key. throws IllegalArgumentException if column family is not present
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
    
    See Also:
    
    IllegalArgumentException
  - keyMayExist
```
public boolean keyMayExist(byte[] key,
                           java.lang.StringBuffer value)
```
    If the key definitely does not exist in the database, then this method returns false, else true. This check is potentially lighter-weight than invoking DB::Get(). One way to make this lighter weight is to avoid doing any IOs.
    
    Parameters:
    
    key - byte array of a key to search for
    
    value - StringBuffer instance which is a out parameter if a value is found in block-cache.
    
    Returns:
    
    boolean value indicating if key does not exist or might exist.
  - keyMayExist
```
public boolean keyMayExist(ColumnFamilyHandle columnFamilyHandle,
                           byte[] key,
                           java.lang.StringBuffer value)
```
    If the key definitely does not exist in the database, then this method returns false, else true. This check is potentially lighter-weight than invoking DB::Get(). One way to make this lighter weight is to avoid doing any IOs.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    key - byte array of a key to search for
    
    value - StringBuffer instance which is a out parameter if a value is found in block-cache.
    
    Returns:
    
    boolean value indicating if key does not exist or might exist.
  - keyMayExist
```
public boolean keyMayExist(ReadOptions readOptions,
                           byte[] key,
                           java.lang.StringBuffer value)
```
    If the key definitely does not exist in the database, then this method returns false, else true. This check is potentially lighter-weight than invoking DB::Get(). One way to make this lighter weight is to avoid doing any IOs.
    
    Parameters:
    
    readOptions - ReadOptions instance
    
    key - byte array of a key to search for
    
    value - StringBuffer instance which is a out parameter if a value is found in block-cache.
    
    Returns:
    
    boolean value indicating if key does not exist or might exist.
  - keyMayExist
```
public boolean keyMayExist(ReadOptions readOptions,
                           ColumnFamilyHandle columnFamilyHandle,
                           byte[] key,
                           java.lang.StringBuffer value)
```
    If the key definitely does not exist in the database, then this method returns false, else true. This check is potentially lighter-weight than invoking DB::Get(). One way to make this lighter weight is to avoid doing any IOs.
    
    Parameters:
    
    readOptions - ReadOptions instance
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    key - byte array of a key to search for
    
    value - StringBuffer instance which is a out parameter if a value is found in block-cache.
    
    Returns:
    
    boolean value indicating if key does not exist or might exist.
  - write
```
public void write(WriteOptions writeOpts,
                  WriteBatch updates)
           throws RocksDBException
```
    Apply the specified updates to the database.
    
    Parameters:
    
    writeOpts - WriteOptions instance
    
    updates - WriteBatch instance
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - merge
```
public void merge(byte[] key,
                  byte[] value)
           throws RocksDBException
```
    Add merge operand for key/value pair.
    
    Parameters:
    
    key - the specified key to be merged.
    
    value - the value to be merged with the current value for the specified key.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - merge
```
public void merge(ColumnFamilyHandle columnFamilyHandle,
                  byte[] key,
                  byte[] value)
           throws RocksDBException
```
    Add merge operand for key/value pair in a ColumnFamily.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    key - the specified key to be merged.
    
    value - the value to be merged with the current value for the specified key.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - merge
```
public void merge(WriteOptions writeOpts,
                  byte[] key,
                  byte[] value)
           throws RocksDBException
```
    Add merge operand for key/value pair.
    
    Parameters:
    
    writeOpts - WriteOptions for this write.
    
    key - the specified key to be merged.
    
    value - the value to be merged with the current value for the specified key.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - merge
```
public void merge(ColumnFamilyHandle columnFamilyHandle,
                  WriteOptions writeOpts,
                  byte[] key,
                  byte[] value)
           throws RocksDBException
```
    Add merge operand for key/value pair.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    writeOpts - WriteOptions for this write.
    
    key - the specified key to be merged.
    
    value - the value to be merged with the current value for the specified key.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - get
```
public int get(byte[] key,
               byte[] value)
        throws RocksDBException
```
    Get the value associated with the specified key within column family*
    
    Parameters:
    
    key - the key to retrieve the value.
    
    value - the out-value to receive the retrieved value.
    
    Returns:
    
    The size of the actual value that matches the specified key in byte. If the return value is greater than the length of value, then it indicates that the size of the input buffer value is insufficient and partial result will be returned. RocksDB.NOT_FOUND will be returned if the value not found.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - get
```
public int get(ColumnFamilyHandle columnFamilyHandle,
               byte[] key,
               byte[] value)
        throws RocksDBException,
               java.lang.IllegalArgumentException
```
    Get the value associated with the specified key within column family.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    key - the key to retrieve the value.
    
    value - the out-value to receive the retrieved value.
    
    Returns:
    
    The size of the actual value that matches the specified key in byte. If the return value is greater than the length of value, then it indicates that the size of the input buffer value is insufficient and partial result will be returned. RocksDB.NOT_FOUND will be returned if the value not found.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
    
    java.lang.IllegalArgumentException
  - get
```
public int get(ReadOptions opt,
               byte[] key,
               byte[] value)
        throws RocksDBException
```
    Get the value associated with the specified key.
    
    Parameters:
    
    opt - ReadOptions instance.
    
    key - the key to retrieve the value.
    
    value - the out-value to receive the retrieved value.
    
    Returns:
    
    The size of the actual value that matches the specified key in byte. If the return value is greater than the length of value, then it indicates that the size of the input buffer value is insufficient and partial result will be returned. RocksDB.NOT_FOUND will be returned if the value not found.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - get
```
public int get(ColumnFamilyHandle columnFamilyHandle,
               ReadOptions opt,
               byte[] key,
               byte[] value)
        throws RocksDBException
```
    Get the value associated with the specified key within column family.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    opt - ReadOptions instance.
    
    key - the key to retrieve the value.
    
    value - the out-value to receive the retrieved value.
    
    Returns:
    
    The size of the actual value that matches the specified key in byte. If the return value is greater than the length of value, then it indicates that the size of the input buffer value is insufficient and partial result will be returned. RocksDB.NOT_FOUND will be returned if the value not found.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - get
```
public byte[] get(byte[] key)
           throws RocksDBException
```
    The simplified version of get which returns a new byte array storing the value associated with the specified input key if any. null will be returned if the specified key is not found.
    
    Parameters:
    
    key - the key retrieve the value.
    
    Returns:
    
    a byte array storing the value associated with the input key if any. null if it does not find the specified key.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - get
```
public byte[] get(ColumnFamilyHandle columnFamilyHandle,
                  byte[] key)
           throws RocksDBException
```
    The simplified version of get which returns a new byte array storing the value associated with the specified input key if any. null will be returned if the specified key is not found.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    key - the key retrieve the value.
    
    Returns:
    
    a byte array storing the value associated with the input key if any. null if it does not find the specified key.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - get
```
public byte[] get(ReadOptions opt,
                  byte[] key)
           throws RocksDBException
```
    The simplified version of get which returns a new byte array storing the value associated with the specified input key if any. null will be returned if the specified key is not found.
    
    Parameters:
    
    key - the key retrieve the value.
    
    opt - Read options.
    
    Returns:
    
    a byte array storing the value associated with the input key if any. null if it does not find the specified key.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - get
```
public byte[] get(ColumnFamilyHandle columnFamilyHandle,
                  ReadOptions opt,
                  byte[] key)
           throws RocksDBException
```
    The simplified version of get which returns a new byte array storing the value associated with the specified input key if any. null will be returned if the specified key is not found.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    key - the key retrieve the value.
    
    opt - Read options.
    
    Returns:
    
    a byte array storing the value associated with the input key if any. null if it does not find the specified key.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - multiGet
```
public java.util.Map<byte[],byte[]> multiGet(java.util.List<byte[]> keys)
                                      throws RocksDBException
```
    Returns a map of keys for which values were found in DB.
    
    Parameters:
    
    keys - List of keys for which values need to be retrieved.
    
    Returns:
    
    Map where key of map is the key passed by user and value for map entry is the corresponding value in DB.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - multiGet
```
public java.util.Map<byte[],byte[]> multiGet(java.util.List<ColumnFamilyHandle> columnFamilyHandleList,
                                             java.util.List<byte[]> keys)
                                      throws RocksDBException,
                                             java.lang.IllegalArgumentException
```
    Returns a map of keys for which values were found in DB.
    Note: Every key needs to have a related column family name in columnFamilyHandleList.
    
    Parameters:
    
    columnFamilyHandleList - List containing ColumnFamilyHandle instances.
    
    keys - List of keys for which values need to be retrieved.
    
    Returns:
    
    Map where key of map is the key passed by user and value for map entry is the corresponding value in DB.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
    
    java.lang.IllegalArgumentException - thrown if the size of passed keys is not equal to the amount of passed column family handles.
  - multiGet
```
public java.util.Map<byte[],byte[]> multiGet(ReadOptions opt,
                                             java.util.List<byte[]> keys)
                                      throws RocksDBException
```
    Returns a map of keys for which values were found in DB.
    
    Parameters:
    
    opt - Read options.
    
    keys - of keys for which values need to be retrieved.
    
    Returns:
    
    Map where key of map is the key passed by user and value for map entry is the corresponding value in DB.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - multiGet
```
public java.util.Map<byte[],byte[]> multiGet(ReadOptions opt,
                                             java.util.List<ColumnFamilyHandle> columnFamilyHandleList,
                                             java.util.List<byte[]> keys)
                                      throws RocksDBException
```
    Returns a map of keys for which values were found in DB.
    Note: Every key needs to have a related column family name in columnFamilyHandleList.
    
    Parameters:
    
    opt - Read options.
    
    columnFamilyHandleList - List containing ColumnFamilyHandle instances.
    
    keys - of keys for which values need to be retrieved.
    
    Returns:
    
    Map where key of map is the key passed by user and value for map entry is the corresponding value in DB.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
    
    java.lang.IllegalArgumentException - thrown if the size of passed keys is not equal to the amount of passed column family handles.
  - remove
```
public void remove(byte[] key)
            throws RocksDBException
```
    Remove the database entry (if any) for "key". Returns OK on success, and a non-OK status on error. It is not an error if "key" did not exist in the database.
    
    Parameters:
    
    key - Key to delete within database
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - remove
```
public void remove(ColumnFamilyHandle columnFamilyHandle,
                   byte[] key)
            throws RocksDBException
```
    Remove the database entry (if any) for "key". Returns OK on success, and a non-OK status on error. It is not an error if "key" did not exist in the database.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    key - Key to delete within database
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - remove
```
public void remove(WriteOptions writeOpt,
                   byte[] key)
            throws RocksDBException
```
    Remove the database entry (if any) for "key". Returns OK on success, and a non-OK status on error. It is not an error if "key" did not exist in the database.
    
    Parameters:
    
    writeOpt - WriteOptions to be used with delete operation
    
    key - Key to delete within database
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - remove
```
public void remove(ColumnFamilyHandle columnFamilyHandle,
                   WriteOptions writeOpt,
                   byte[] key)
            throws RocksDBException
```
    Remove the database entry (if any) for "key". Returns OK on success, and a non-OK status on error. It is not an error if "key" did not exist in the database.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    writeOpt - WriteOptions to be used with delete operation
    
    key - Key to delete within database
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - getProperty
```
public java.lang.String getProperty(ColumnFamilyHandle columnFamilyHandle,
                                    java.lang.String property)
                             throws RocksDBException
```
    DB implements can export properties about their state via this method on a per column family level.
    If property is a valid property understood by this DB implementation, fills value with its current value and returns true. Otherwise returns false.
    
    Valid property names include:
    - "rocksdb.num-files-at-level<N>" - return the number of files at level <N>, where <N> is an ASCII representation of a level number (e.g. "0").
    - "rocksdb.stats" - returns a multi-line string that describes statistics about the internal operation of the DB.
    - "rocksdb.sstables" - returns a multi-line string that describes all of the sstables that make up the db contents.
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    property - to be fetched. See above for examples
    
    Returns:
    
    property value
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - getProperty
```
public java.lang.String getProperty(java.lang.String property)
                             throws RocksDBException
```
    DB implementations can export properties about their state via this method. If "property" is a valid property understood by this DB implementation, fills "*value" with its current value and returns true. Otherwise returns false.
    Valid property names include:
    - "rocksdb.num-files-at-level<N>" - return the number of files at level <N>, where <N> is an ASCII representation of a level number (e.g. "0").
    - "rocksdb.stats" - returns a multi-line string that describes statistics about the internal operation of the DB.
    - "rocksdb.sstables" - returns a multi-line string that describes all of the sstables that make up the db contents.
    Parameters:
    
    property - to be fetched. See above for examples
    
    Returns:
    
    property value
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - getLongProperty
```
public long getLongProperty(java.lang.String property)
                     throws RocksDBException
```
    Similar to GetProperty(), but only works for a subset of properties whose return value is a numerical value. Return the value as long.
    
    Note: As the returned property is of type uint64_t on C++ side the returning value can be negative because Java supports in Java 7 only signed long values.
    
    Java 7: To mitigate the problem of the non existent unsigned long tpye, values should be encapsulated using BigInteger to reflect the correct value. The correct behavior is guaranteed if 2^64 is added to negative values.
    
    Java 8: In Java 8 the value should be treated as unsigned long using provided methods of type Long.
    
    Parameters:
    
    property - to be fetched.
    
    Returns:
    
    numerical property value.
    
    Throws:
    
    RocksDBException - if an error happens in the underlying native code.
  - getLongProperty
```
public long getLongProperty(ColumnFamilyHandle columnFamilyHandle,
                            java.lang.String property)
                     throws RocksDBException
```
    Similar to GetProperty(), but only works for a subset of properties whose return value is a numerical value. Return the value as long.
    
    Note: As the returned property is of type uint64_t on C++ side the returning value can be negative because Java supports in Java 7 only signed long values.
    
    Java 7: To mitigate the problem of the non existent unsigned long tpye, values should be encapsulated using BigInteger to reflect the correct value. The correct behavior is guaranteed if 2^64 is added to negative values.
    
    Java 8: In Java 8 the value should be treated as unsigned long using provided methods of type Long.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    property - to be fetched.
    
    Returns:
    
    numerical property value
    
    Throws:
    
    RocksDBException - if an error happens in the underlying native code.
  - newIterator
```
public RocksIterator newIterator()
```
    Return a heap-allocated iterator over the contents of the database. The result of newIterator() is initially invalid (caller must call one of the Seek methods on the iterator before using it). Caller should close the iterator when it is no longer needed. The returned iterator should be closed before this db is closed.
    
    Returns:
    
    instance of iterator object.
  - getSnapshot
```
public Snapshot getSnapshot()
```
    Return a handle to the current DB state. Iterators created with this handle will all observe a stable snapshot of the current DB state. The caller must call ReleaseSnapshot(result) when the snapshot is no longer needed.
    
    nullptr will be returned if the DB fails to take a snapshot or does not support snapshot.
    
    Returns:
    
    Snapshot Snapshot instance
  - releaseSnapshot
```
public void releaseSnapshot(Snapshot snapshot)
```
    Release a previously acquired snapshot. The caller must not use "snapshot" after this call.
    
    Parameters:
    
    snapshot - Snapshot instance
  - newIterator
```
public RocksIterator newIterator(ColumnFamilyHandle columnFamilyHandle)
```
    Return a heap-allocated iterator over the contents of the database. The result of newIterator() is initially invalid (caller must call one of the Seek methods on the iterator before using it). Caller should close the iterator when it is no longer needed. The returned iterator should be closed before this db is closed.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    Returns:
    
    instance of iterator object.
  - newIterators
```
public java.util.List<RocksIterator> newIterators(java.util.List<ColumnFamilyHandle> columnFamilyHandleList)
                                           throws RocksDBException
```
    Returns iterators from a consistent database state across multiple column families. Iterators are heap allocated and need to be deleted before the db is deleted
    
    Parameters:
    
    columnFamilyHandleList - List containing ColumnFamilyHandle instances.
    
    Returns:
    
    List containing RocksIterator instances
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - createColumnFamily
```
public ColumnFamilyHandle createColumnFamily(ColumnFamilyDescriptor columnFamilyDescriptor)
                                      throws RocksDBException
```
    Creates a new column family with the name columnFamilyName and allocates a ColumnFamilyHandle within an internal structure. The ColumnFamilyHandle is automatically disposed with DB disposal.
    
    Parameters:
    
    columnFamilyDescriptor - column family to be created.
    
    Returns:
    
    ColumnFamilyHandle instance.
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
  - dropColumnFamily
```
public void dropColumnFamily(ColumnFamilyHandle columnFamilyHandle)
                      throws RocksDBException,
                             java.lang.IllegalArgumentException
```
    Drops the column family identified by columnFamilyName. Internal handles to this column family will be disposed. If the column family is not known removal will fail.
    
    Parameters:
    
    columnFamilyHandle - ColumnFamilyHandle instance
    
    Throws:
    
    RocksDBException - thrown if error happens in underlying native library.
    
    java.lang.IllegalArgumentException
  - flush
```
public void flush(FlushOptions flushOptions)
           throws RocksDBException
```
    Flush all memory table data.
    
    Note: it must be ensured that the FlushOptions instance is not GC'ed before this method finishes. If the wait parameter is set to false, flush processing is asynchronous.
    
    Parameters:
    
    flushOptions - FlushOptions instance.
    
    Throws:
    
    RocksDBException - thrown if an error occurs within the native part of the library.
  - flush
```
public void flush(FlushOptions flushOptions,
                  ColumnFamilyHandle columnFamilyHandle)
           throws RocksDBException
```
    Flush all memory table data.
    
    Note: it must be ensured that the FlushOptions instance is not GC'ed before this method finishes. If the wait parameter is set to false, flush processing is asynchronous.
    
    Parameters:
    
    flushOptions - FlushOptions instance.
    
    columnFamilyHandle - ColumnFamilyHandle instance.
    
    Throws:
    
    RocksDBException - thrown if an error occurs within the native part of the library.
  - open
```
protected void open(long optionsHandle,
                    java.lang.String path)
             throws RocksDBException
```
    Throws:
    
    RocksDBException
  - open
```
protected java.util.List<java.lang.Long> open(long optionsHandle,
                                              java.lang.String path,
                                              java.util.List<ColumnFamilyDescriptor> columnFamilyDescriptors,
                                              int columnFamilyDescriptorsLength)
                                       throws RocksDBException
```
    Throws:
    
    RocksDBException
  - listColumnFamilies
```
protected static java.util.List<byte[]> listColumnFamilies(long optionsHandle,
                                                           java.lang.String path)
                                                    throws RocksDBException
```
    Throws:
    
    RocksDBException
  - openROnly
```
protected void openROnly(long optionsHandle,
                         java.lang.String path)
                  throws RocksDBException
```
    Throws:
    
    RocksDBException
  - openROnly
```
protected java.util.List<java.lang.Long> openROnly(long optionsHandle,
                                                   java.lang.String path,
                                                   java.util.List<ColumnFamilyDescriptor> columnFamilyDescriptors,
                                                   int columnFamilyDescriptorsLength)
                                            throws RocksDBException
```
    Throws:
    
    RocksDBException
  - put
```
protected void put(long handle,
                   byte[] key,
                   int keyLen,
                   byte[] value,
                   int valueLen)
            throws RocksDBException
```
    Throws:
    
    RocksDBException
  - put
```
protected void put(long handle,
                   byte[] key,
                   int keyLen,
                   byte[] value,
                   int valueLen,
                   long cfHandle)
            throws RocksDBException
```
    Throws:
    
    RocksDBException
  - put
```
protected void put(long handle,
                   long writeOptHandle,
                   byte[] key,
                   int keyLen,
                   byte[] value,
                   int valueLen)
            throws RocksDBException
```
    Throws:
    
    RocksDBException
  - put
```
protected void put(long handle,
                   long writeOptHandle,
                   byte[] key,
                   int keyLen,
                   byte[] value,
                   int valueLen,
                   long cfHandle)
            throws RocksDBException
```
    Throws:
    
    RocksDBException
  - write
```
protected void write(long writeOptHandle,
                     long batchHandle)
              throws RocksDBException
```
    Throws:
    
    RocksDBException
  - keyMayExist
```
protected boolean keyMayExist(byte[] key,
                              int keyLen,
                              java.lang.StringBuffer stringBuffer)
```
  - keyMayExist
```
protected boolean keyMayExist(byte[] key,
                              int keyLen,
                              long cfHandle,
                              java.lang.StringBuffer stringBuffer)
```
  - keyMayExist
```
protected boolean keyMayExist(long optionsHandle,
                              byte[] key,
                              int keyLen,
                              java.lang.StringBuffer stringBuffer)
```
  - keyMayExist
```
protected boolean keyMayExist(long optionsHandle,
                              byte[] key,
                              int keyLen,
                              long cfHandle,
                              java.lang.StringBuffer stringBuffer)
```
  - merge
```
protected void merge(long handle,
                     byte[] key,
                     int keyLen,
                     byte[] value,
                     int valueLen)
              throws RocksDBException
```
    Throws:
    
    RocksDBException
  - merge
```
protected void merge(long handle,
                     byte[] key,
                     int keyLen,
                     byte[] value,
                     int valueLen,
                     long cfHandle)
              throws RocksDBException
```
    Throws:
    
    RocksDBException
  - merge
```
protected void merge(long handle,
                     long writeOptHandle,
                     byte[] key,
                     int keyLen,
                     byte[] value,
                     int valueLen)
              throws RocksDBException
```
    Throws:
    
    RocksDBException
  - merge
```
protected void merge(long handle,
                     long writeOptHandle,
                     byte[] key,
                     int keyLen,
                     byte[] value,
                     int valueLen,
                     long cfHandle)
              throws RocksDBException
```
    Throws:
    
    RocksDBException
  - get
```
protected int get(long handle,
                  byte[] key,
                  int keyLen,
                  byte[] value,
                  int valueLen)
           throws RocksDBException
```
    Throws:
    
    RocksDBException
  - get
```
protected int get(long handle,
                  byte[] key,
                  int keyLen,
                  byte[] value,
                  int valueLen,
                  long cfHandle)
           throws RocksDBException
```
    Throws:
    
    RocksDBException
  - get
```
protected int get(long handle,
                  long readOptHandle,
                  byte[] key,
                  int keyLen,
                  byte[] value,
                  int valueLen)
           throws RocksDBException
```
    Throws:
    
    RocksDBException
  - get
```
protected int get(long handle,
                  long readOptHandle,
                  byte[] key,
                  int keyLen,
                  byte[] value,
                  int valueLen,
                  long cfHandle)
           throws RocksDBException
```
    Throws:
    
    RocksDBException
  - multiGet
```
protected java.util.List<byte[]> multiGet(long dbHandle,
                                          java.util.List<byte[]> keys,
                                          int keysCount)
```
  - multiGet
```
protected java.util.List<byte[]> multiGet(long dbHandle,
                                          java.util.List<byte[]> keys,
                                          int keysCount,
                                          java.util.List<ColumnFamilyHandle> cfHandles)
```
  - multiGet
```
protected java.util.List<byte[]> multiGet(long dbHandle,
                                          long rOptHandle,
                                          java.util.List<byte[]> keys,
                                          int keysCount)
```
  - multiGet
```
protected java.util.List<byte[]> multiGet(long dbHandle,
                                          long rOptHandle,
                                          java.util.List<byte[]> keys,
                                          int keysCount,
                                          java.util.List<ColumnFamilyHandle> cfHandles)
```
  - get
```
protected byte[] get(long handle,
                     byte[] key,
                     int keyLen)
              throws RocksDBException
```
    Throws:
    
    RocksDBException
  - get
```
protected byte[] get(long handle,
                     byte[] key,
                     int keyLen,
                     long cfHandle)
              throws RocksDBException
```
    Throws:
    
    RocksDBException
  - get
```
protected byte[] get(long handle,
                     long readOptHandle,
                     byte[] key,
                     int keyLen)
              throws RocksDBException
```
    Throws:
    
    RocksDBException
  - get
```
protected byte[] get(long handle,
                     long readOptHandle,
                     byte[] key,
                     int keyLen,
                     long cfHandle)
              throws RocksDBException
```
    Throws:
    
    RocksDBException
  - remove
```
protected void remove(long handle,
                      byte[] key,
                      int keyLen)
               throws RocksDBException
```
    Throws:
    
    RocksDBException
  - remove
```
protected void remove(long handle,
                      byte[] key,
                      int keyLen,
                      long cfHandle)
               throws RocksDBException
```
    Throws:
    
    RocksDBException
  - remove
```
protected void remove(long handle,
                      long writeOptHandle,
                      byte[] key,
                      int keyLen)
               throws RocksDBException
```
    Throws:
    
    RocksDBException
  - remove
```
protected void remove(long handle,
                      long writeOptHandle,
                      byte[] key,
                      int keyLen,
                      long cfHandle)
               throws RocksDBException
```
    Throws:
    
    RocksDBException
  - getProperty0
```
protected java.lang.String getProperty0(long nativeHandle,
                                        java.lang.String property,
                                        int propertyLength)
                                 throws RocksDBException
```
    Throws:
    
    RocksDBException
  - getProperty0
```
protected java.lang.String getProperty0(long nativeHandle,
                                        long cfHandle,
                                        java.lang.String property,
                                        int propertyLength)
                                 throws RocksDBException
```
    Throws:
    
    RocksDBException
  - getLongProperty
```
protected long getLongProperty(long nativeHandle,
                               java.lang.String property,
                               int propertyLength)
                        throws RocksDBException
```
    Throws:
    
    RocksDBException
  - getLongProperty
```
protected long getLongProperty(long nativeHandle,
                               long cfHandle,
                               java.lang.String property,
                               int propertyLength)
                        throws RocksDBException
```
    Throws:
    
    RocksDBException
  - iterator0
```
protected long iterator0(long handle)
```
  - iterator0
```
protected long iterator0(long handle,
                         long cfHandle)
```
  - iterators
```
protected long[] iterators(long handle,
                           java.util.List<ColumnFamilyHandle> columnFamilyNames)
                    throws RocksDBException
```
    Throws:
    
    RocksDBException
  - getSnapshot
```
protected long getSnapshot(long nativeHandle)
```
  - releaseSnapshot
```
protected void releaseSnapshot(long nativeHandle,
                               long snapshotHandle)
```

Class RocksDB

Field Summary

Fields inherited from class org.rocksdb.RocksObject

Constructor Summary

Method Summary

Methods inherited from class org.rocksdb.RocksObject

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_COLUMN_FAMILY

NOT_FOUND

options_

Constructor Detail

RocksDB

Method Detail

loadLibrary

loadLibrary

open

open

open

open

openReadOnly

openReadOnly

openReadOnly

openReadOnly

listColumnFamilies

disposeInternal

close

put

put

put

put

keyMayExist

keyMayExist

keyMayExist

keyMayExist

write

merge

merge

merge

merge

get

get

get

get

get

get

get

get

multiGet

multiGet

multiGet

multiGet

remove

remove

remove

remove

getProperty

getProperty

getLongProperty

getLongProperty

newIterator

getSnapshot

releaseSnapshot

newIterator

newIterators

createColumnFamily

dropColumnFamily

flush

flush

open

open

listColumnFamilies

openROnly

openROnly

put

put

put

put

write

keyMayExist