org.rocksdb

Class SstFileReader

java.lang.Object

org.rocksdb.AbstractNativeReference

org.rocksdb.AbstractImmutableNativeReference

org.rocksdb.RocksObject

org.rocksdb.SstFileReader

All Implemented Interfaces:

java.lang.AutoCloseable

public class SstFileReader
extends RocksObject

Field Summary

Fields inherited from class org.rocksdb.RocksObject

nativeHandle_

Fields inherited from class org.rocksdb.AbstractImmutableNativeReference

owningHandle_

Constructor Summary

Constructors

Constructor and Description
SstFileReader(Options options)

Method Summary

Modifier and Type	Method and Description
protected void	disposeInternal(long handle)
TableProperties	getTableProperties() Get the properties of the table.
SstFileReaderIterator	newIterator(ReadOptions readOptions) Returns an iterator that will iterate on all keys in the default column family including both keys in the DB and uncommitted keys in this transaction.
void	open(java.lang.String filePath) Prepare SstFileReader to read a file.
void	verifyChecksum() Verify checksum

Methods inherited from class org.rocksdb.RocksObject

disposeInternal, getNativeHandle

Methods inherited from class org.rocksdb.AbstractImmutableNativeReference

close, disOwnNativeHandle, isOwningHandle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SstFileReader

public SstFileReader(Options options)

Method Detail

newIterator

public SstFileReaderIterator newIterator(ReadOptions readOptions)

Returns an iterator that will iterate on all keys in the default column family including both keys in the DB and uncommitted keys in this transaction.

Setting ReadOptions.setSnapshot(Snapshot) will affect what is read from the DB but will NOT change which keys are read from this transaction (the keys in this transaction do not yet belong to any snapshot and will be fetched regardless).

Caller is responsible for deleting the returned Iterator.

Parameters:

readOptions - Read options.

Returns:

instance of iterator object.

open

public void open(java.lang.String filePath)
          throws RocksDBException

Prepare SstFileReader to read a file.

Parameters:

filePath - the location of file

Throws:

RocksDBException - thrown if error happens in underlying native library.

verifyChecksum

public void verifyChecksum()
                    throws RocksDBException

Verify checksum

Throws:

RocksDBException - if the checksum is not valid

getTableProperties

public TableProperties getTableProperties()
                                   throws RocksDBException

Get the properties of the table.

Returns:

the properties

Throws:

RocksDBException - if an error occurs whilst getting the table properties

disposeInternal

protected final void disposeInternal(long handle)

Specified by:

disposeInternal in class RocksObject