org.rocksdb

Class IngestExternalFileOptions

java.lang.Object

org.rocksdb.AbstractNativeReference

org.rocksdb.AbstractImmutableNativeReference

org.rocksdb.RocksObject

org.rocksdb.IngestExternalFileOptions

All Implemented Interfaces:

java.lang.AutoCloseable

public class IngestExternalFileOptions
extends RocksObject

IngestExternalFileOptions is used by RocksDB.ingestExternalFile(ColumnFamilyHandle, List, IngestExternalFileOptions)

Field Summary

Fields inherited from class org.rocksdb.RocksObject

nativeHandle_

Constructor Summary

Constructors

Constructor and Description
IngestExternalFileOptions()
IngestExternalFileOptions(boolean moveFiles, boolean snapshotConsistency, boolean allowGlobalSeqNo, boolean allowBlockingFlush)

Method Summary

Modifier and Type	Method and Description
boolean	allowBlockingFlush() If set to false and the file key range overlaps with the memtable key range (memtable flush required), IngestExternalFile will fail.
boolean	allowGlobalSeqNo() If set to false, RocksDB.ingestExternalFile(ColumnFamilyHandle, List, IngestExternalFileOptions) will fail if the file key range overlaps with existing keys or tombstones in the DB.
protected void	disposeInternal(long handle)
boolean	moveFiles() Can be set to true to move the files instead of copying them.
void	setAllowBlockingFlush(boolean allowBlockingFlush) If set to false and the file key range overlaps with the memtable key range (memtable flush required), IngestExternalFile will fail.
void	setAllowGlobalSeqNo(boolean allowGlobalSeqNo) If set to false, RocksDB.ingestExternalFile(ColumnFamilyHandle, List, IngestExternalFileOptions) will fail if the file key range overlaps with existing keys or tombstones in the DB.
void	setMoveFiles(boolean moveFiles) Can be set to true to move the files instead of copying them.
void	setSnapshotConsistency(boolean snapshotConsistency) If set to false, an ingested file keys could appear in existing snapshots that where created before the file was ingested.
boolean	snapshotConsistency() If set to false, an ingested file keys could appear in existing snapshots that where created before the file was ingested.

Methods inherited from class org.rocksdb.RocksObject

disposeInternal

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

IngestExternalFileOptions

public IngestExternalFileOptions()

IngestExternalFileOptions

public IngestExternalFileOptions(boolean moveFiles,
                                 boolean snapshotConsistency,
                                 boolean allowGlobalSeqNo,
                                 boolean allowBlockingFlush)

Parameters:

moveFiles - setMoveFiles(boolean)

snapshotConsistency - setSnapshotConsistency(boolean)

allowGlobalSeqNo - setAllowGlobalSeqNo(boolean)

allowBlockingFlush - setAllowBlockingFlush(boolean)

Method Detail

moveFiles

public boolean moveFiles()

Can be set to true to move the files instead of copying them.

Returns:

true if files will be moved

setMoveFiles

public void setMoveFiles(boolean moveFiles)

Can be set to true to move the files instead of copying them.

Parameters:

moveFiles - true if files should be moved instead of copied

snapshotConsistency

public boolean snapshotConsistency()

If set to false, an ingested file keys could appear in existing snapshots that where created before the file was ingested.

Returns:

true if snapshot consistency is assured

setSnapshotConsistency

public void setSnapshotConsistency(boolean snapshotConsistency)

If set to false, an ingested file keys could appear in existing snapshots that where created before the file was ingested.

Parameters:

snapshotConsistency - true if snapshot consistency is required

allowGlobalSeqNo

public boolean allowGlobalSeqNo()

If set to false, RocksDB.ingestExternalFile(ColumnFamilyHandle, List, IngestExternalFileOptions) will fail if the file key range overlaps with existing keys or tombstones in the DB.

Returns:

true if global seq numbers are assured

setAllowGlobalSeqNo

public void setAllowGlobalSeqNo(boolean allowGlobalSeqNo)

If set to false, RocksDB.ingestExternalFile(ColumnFamilyHandle, List, IngestExternalFileOptions) will fail if the file key range overlaps with existing keys or tombstones in the DB.

Parameters:

allowGlobalSeqNo - true if global seq numbers are required

allowBlockingFlush

public boolean allowBlockingFlush()

If set to false and the file key range overlaps with the memtable key range (memtable flush required), IngestExternalFile will fail.

Returns:

true if blocking flushes may occur

setAllowBlockingFlush

public void setAllowBlockingFlush(boolean allowBlockingFlush)

If set to false and the file key range overlaps with the memtable key range (memtable flush required), IngestExternalFile will fail.

Parameters:

allowBlockingFlush - true if blocking flushes are allowed

disposeInternal

protected final void disposeInternal(long handle)

Specified by:

disposeInternal in class RocksObject