org.rocksdb

Class SstFileWriter

java.lang.Object

org.rocksdb.AbstractNativeReference

org.rocksdb.AbstractImmutableNativeReference

org.rocksdb.RocksObject

org.rocksdb.SstFileWriter

All Implemented Interfaces:

AutoCloseable

public class SstFileWriter
extends RocksObject

SstFileWriter is used to create sst files that can be added to the database later. All keys in files generated by SstFileWriter will have sequence number = 0.

Field Summary

Fields inherited from class org.rocksdb.RocksObject

nativeHandle_

Fields inherited from class org.rocksdb.AbstractImmutableNativeReference

owningHandle_

Constructor Summary

Constructors

Constructor and Description
SstFileWriter(EnvOptions envOptions, Options options) SstFileWriter Constructor.
SstFileWriter(EnvOptions envOptions, Options options, AbstractComparator comparator) Deprecated. Use SstFileWriter(EnvOptions, Options). Passing an explicit comparator is deprecated in lieu of passing the comparator as part of options. Use the other constructor instead.

Method Summary

Modifier and Type	Method and Description
void	add(DirectSlice key, DirectSlice value) Deprecated. Use put(DirectSlice, DirectSlice)
void	add(Slice key, Slice value) Deprecated. Use put(Slice, Slice)
void	delete(byte[] key) Add a deletion key to currently opened file.
void	delete(DirectSlice key) Add a deletion key to currently opened file.
void	delete(Slice key) Add a deletion key to currently opened file.
protected void	disposeInternal(long handle)
long	fileSize() Return the current file size.
void	finish() Finish the process and close the sst file.
void	merge(byte[] key, byte[] value) Add a Merge key with value to currently opened file.
void	merge(DirectSlice key, DirectSlice value) Add a Merge key with value to currently opened file.
void	merge(Slice key, Slice value) Add a Merge key with value to currently opened file.
void	open(String filePath) Prepare SstFileWriter to write to a file.
void	put(byte[] key, byte[] value) Add a Put key with value to currently opened file.
void	put(ByteBuffer key, ByteBuffer value) Add a Put key with value to currently opened file.
void	put(DirectSlice key, DirectSlice value) Add a Put key with value to currently opened file.
void	put(Slice key, Slice value) Add a Put key with value to currently opened file.

Methods inherited from class org.rocksdb.RocksObject

disposeInternal, getNativeHandle

Methods inherited from class org.rocksdb.AbstractImmutableNativeReference

close, disOwnNativeHandle, isOwningHandle

Methods inherited from class org.rocksdb.AbstractNativeReference

dispose, finalize

Methods inherited from class java.lang.Object

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

Constructor Detail

SstFileWriter

@Deprecated
public SstFileWriter(EnvOptions envOptions,
                                  Options options,
                                  AbstractComparator comparator)

Deprecated. Use SstFileWriter(EnvOptions, Options). Passing an explicit comparator is deprecated in lieu of passing the comparator as part of options. Use the other constructor instead.

SstFileWriter Constructor.

Parameters:

envOptions - EnvOptions instance.

options - Options instance.

comparator - the comparator to specify the ordering of keys.

SstFileWriter

public SstFileWriter(EnvOptions envOptions,
                     Options options)

SstFileWriter Constructor.

Parameters:

envOptions - EnvOptions instance.

options - Options instance.

Method Detail

open

public void open(String filePath)
          throws RocksDBException

Prepare SstFileWriter to write to a file.

Parameters:

filePath - the location of file

Throws:

RocksDBException - thrown if error happens in underlying native library.

add

@Deprecated
public void add(Slice key,
                             Slice value)
                      throws RocksDBException

Deprecated. Use put(Slice, Slice)

Add a Put key with value to currently opened file.

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.

add

@Deprecated
public void add(DirectSlice key,
                             DirectSlice value)
                      throws RocksDBException

Deprecated. Use put(DirectSlice, DirectSlice)

Add a Put key with value to currently opened file.

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(Slice key,
                Slice value)
         throws RocksDBException

Add a Put key with value to currently opened file.

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(DirectSlice key,
                DirectSlice value)
         throws RocksDBException

Add a Put key with value to currently opened file.

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(ByteBuffer key,
                ByteBuffer value)
         throws RocksDBException

Add a Put key with value to currently opened file.

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(byte[] key,
                byte[] value)
         throws RocksDBException

Add a Put key with value to currently opened file.

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.

merge

public void merge(Slice key,
                  Slice value)
           throws RocksDBException

Add a Merge key with value to currently opened file.

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(byte[] key,
                  byte[] value)
           throws RocksDBException

Add a Merge key with value to currently opened file.

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(DirectSlice key,
                  DirectSlice value)
           throws RocksDBException

Add a Merge key with value to currently opened file.

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.

delete

public void delete(Slice key)
            throws RocksDBException

Add a deletion key to currently opened file.

Parameters:

key - the specified key to be deleted.

Throws:

RocksDBException - thrown if error happens in underlying native library.

delete

public void delete(DirectSlice key)
            throws RocksDBException

Add a deletion key to currently opened file.

Parameters:

key - the specified key to be deleted.

Throws:

RocksDBException - thrown if error happens in underlying native library.

delete

public void delete(byte[] key)
            throws RocksDBException

Add a deletion key to currently opened file.

Parameters:

key - the specified key to be deleted.

Throws:

RocksDBException - thrown if error happens in underlying native library.

finish

public void finish()
            throws RocksDBException

Finish the process and close the sst file.

Throws:

RocksDBException - thrown if error happens in underlying native library.

fileSize

public long fileSize()
              throws RocksDBException

Return the current file size.

Returns:

the current file size

Throws:

RocksDBException - thrown if error happens in underlying native library.

disposeInternal

protected final void disposeInternal(long handle)

Specified by:

disposeInternal in class RocksObject