rocksdb-native 0.0.0 → 0.0.1

package/vendor/rocksdb/java/src/main/java/org/rocksdb/Slice.java

@@ -1,135 +0,0 @@
-// Copyright (c) 2011-present, Facebook, Inc.  All rights reserved.
-//  This source code is licensed under both the GPLv2 (found in the
-//  COPYING file in the root directory) and Apache 2.0 License
-//  (found in the LICENSE.Apache file in the root directory).
-
-package org.rocksdb;
-
-/**
- * <p>Base class for slices which will receive
- * byte[] based access to the underlying data.</p>
- *
- * <p>byte[] backed slices typically perform better with
- * small keys and values. When using larger keys and
- * values consider using {@link org.rocksdb.DirectSlice}</p>
- */
-public class Slice extends AbstractSlice<byte[]> {
-
-  /**
-   * Indicates whether we have to free the memory pointed to by the Slice
-   */
-  private volatile boolean cleared;
-  private volatile long internalBufferOffset = 0;
-
-  /**
-   * <p>Called from JNI to construct a new Java Slice
-   * without an underlying C++ object set
-   * at creation time.</p>
-   *
-   * <p>Note: You should be aware that
-   * {@see org.rocksdb.RocksObject#disOwnNativeHandle()} is intentionally
-   * called from the default Slice constructor, and that it is marked as
-   * private. This is so that developers cannot construct their own default
-   * Slice objects (at present). As developers cannot construct their own
-   * Slice objects through this, they are not creating underlying C++ Slice
-   * objects, and so there is nothing to free (dispose) from Java.</p>
-   */
-  @SuppressWarnings("unused")
-  private Slice() {
-    super();
-  }
-
-  /**
-   * <p>Package-private Slice constructor which is used to construct
-   * Slice instances from C++ side. As the reference to this
-   * object is also managed from C++ side the handle will be disowned.</p>
-   *
-   * @param nativeHandle address of native instance.
-   */
-  Slice(final long nativeHandle) {
-    this(nativeHandle, false);
-  }
-
-  /**
-   * <p>Package-private Slice constructor which is used to construct
-   * Slice instances using a handle. </p>
-   *
-   * @param nativeHandle address of native instance.
-   * @param owningNativeHandle true if the Java side owns the memory pointed to
-   *     by this reference, false if ownership belongs to the C++ side
-   */
-  Slice(final long nativeHandle, final boolean owningNativeHandle) {
-    super();
-    setNativeHandle(nativeHandle, owningNativeHandle);
-  }
-
-  /**
-   * <p>Constructs a slice where the data is taken from
-   * a String.</p>
-   *
-   * @param str String value.
-   */
-  public Slice(final String str) {
-    super(createNewSliceFromString(str));
-  }
-
-  /**
-   * <p>Constructs a slice where the data is a copy of
-   * the byte array from a specific offset.</p>
-   *
-   * @param data byte array.
-   * @param offset offset within the byte array.
-   */
-  public Slice(final byte[] data, final int offset) {
-    super(createNewSlice0(data, offset));
-  }
-
-  /**
-   * <p>Constructs a slice where the data is a copy of
-   * the byte array.</p>
-   *
-   * @param data byte array.
-   */
-  public Slice(final byte[] data) {
-    super(createNewSlice1(data));
-  }
-
-  @Override
-  public void clear() {
-    clear0(getNativeHandle(), !cleared, internalBufferOffset);
-    cleared = true;
-  }
-
-  @Override
-  public void removePrefix(final int n) {
-    removePrefix0(getNativeHandle(), n);
-    this.internalBufferOffset += n;
-  }
-
-  /**
-   * <p>Deletes underlying C++ slice pointer
-   * and any buffered data.</p>
-   *
-   * <p>
-   * Note that this function should be called only after all
-   * RocksDB instances referencing the slice are closed.
-   * Otherwise an undefined behavior will occur.</p>
-   */
-  @Override
-  protected void disposeInternal() {
-    final long nativeHandle = getNativeHandle();
-    if(!cleared) {
-      disposeInternalBuf(nativeHandle, internalBufferOffset);
-    }
-    super.disposeInternal(nativeHandle);
-  }
-
-  @Override protected final native byte[] data0(long handle);
-  private static native long createNewSlice0(final byte[] data, final int length);
-  private static native long createNewSlice1(final byte[] data);
-  private native void clear0(long handle, boolean internalBuffer,
-      long internalBufferOffset);
-  private native void removePrefix0(long handle, int length);
-  private native void disposeInternalBuf(final long handle,
-      long internalBufferOffset);
-}

package/vendor/rocksdb/java/src/main/java/org/rocksdb/Snapshot.java

@@ -1,41 +0,0 @@
-// Copyright (c) 2011-present, Facebook, Inc.  All rights reserved.
-//  This source code is licensed under both the GPLv2 (found in the
-//  COPYING file in the root directory) and Apache 2.0 License
-//  (found in the LICENSE.Apache file in the root directory).
-
-package org.rocksdb;
-
-/**
- * Snapshot of database
- */
-public class Snapshot extends RocksObject {
-  Snapshot(final long nativeHandle) {
-    super(nativeHandle);
-
-    // The pointer to the snapshot is always released
-    // by the database instance.
-    disOwnNativeHandle();
-  }
-
-  /**
-   * Return the associated sequence number;
-   *
-   * @return the associated sequence number of
-   *     this snapshot.
-   */
-  public long getSequenceNumber() {
-    return getSequenceNumber(nativeHandle_);
-  }
-
-  @Override
-  protected final void disposeInternal(final long handle) {
-    /*
-     * Nothing to release, we never own the pointer for a
-     * Snapshot. The pointer
-     * to the snapshot is released by the database
-     * instance.
-     */
-  }
-
-  private native long getSequenceNumber(long handle);
-}

package/vendor/rocksdb/java/src/main/java/org/rocksdb/SstFileManager.java

@@ -1,249 +0,0 @@
-// Copyright (c) 2011-present, Facebook, Inc.  All rights reserved.
-//  This source code is licensed under both the GPLv2 (found in the
-//  COPYING file in the root directory) and Apache 2.0 License
-//  (found in the LICENSE.Apache file in the root directory).
-
-package org.rocksdb;
-
-import java.util.Map;
-
-/**
- * SstFileManager is used to track SST files in the DB and control their
- * deletion rate.
- * <p>
- * All SstFileManager public functions are thread-safe.
- * <p>
- * SstFileManager is not extensible.
- */
-//@ThreadSafe
-public final class SstFileManager extends RocksObject {
-
-  public static final long RATE_BYTES_PER_SEC_DEFAULT = 0;
-  public static final boolean DELETE_EXISTING_TRASH_DEFAULT = true;
-  public static final double MAX_TRASH_DB_RATION_DEFAULT = 0.25;
-  public static final long BYTES_MAX_DELETE_CHUNK_DEFAULT = 64 * 1024 * 1024;
-
-  /**
-   * Create a new SstFileManager that can be shared among multiple RocksDB
-   * instances to track SST file and control there deletion rate.
-   *
-   * @param env the environment.
-   *
-   * @throws RocksDBException thrown if error happens in underlying native library.
-   */
-  public SstFileManager(final Env env) throws RocksDBException {
-    this(env, null);
-  }
-
-  /**
-   * Create a new SstFileManager that can be shared among multiple RocksDB
-   * instances to track SST file and control there deletion rate.
-   *
-   * @param env the environment.
-   * @param logger if not null, the logger will be used to log errors.
-   *
-   * @throws RocksDBException thrown if error happens in underlying native library.
-   */
-  public SstFileManager(final Env env, /*@Nullable*/  final Logger logger)
-      throws RocksDBException {
-    this(env, logger, RATE_BYTES_PER_SEC_DEFAULT);
-  }
-
-  /**
-   * Create a new SstFileManager that can be shared among multiple RocksDB
-   * instances to track SST file and control there deletion rate.
-   *
-   * @param env the environment.
-   * @param logger if not null, the logger will be used to log errors.
-   * <p>
-   * == Deletion rate limiting specific arguments ==
-   * @param rateBytesPerSec how many bytes should be deleted per second, If
-   *     this value is set to 1024 (1 Kb / sec) and we deleted a file of size
-   *     4 Kb in 1 second, we will wait for another 3 seconds before we delete
-   *     other files, Set to 0 to disable deletion rate limiting.
-   *
-   * @throws RocksDBException thrown if error happens in underlying native library.
-   */
-  public SstFileManager(final Env env, /*@Nullable*/  final Logger logger,
-      final long rateBytesPerSec) throws RocksDBException {
-    this(env, logger, rateBytesPerSec, MAX_TRASH_DB_RATION_DEFAULT);
-  }
-
-  /**
-   * Create a new SstFileManager that can be shared among multiple RocksDB
-   * instances to track SST file and control there deletion rate.
-   *
-   * @param env the environment.
-   * @param logger if not null, the logger will be used to log errors.
-   * <p>
-   * == Deletion rate limiting specific arguments ==
-   * @param rateBytesPerSec how many bytes should be deleted per second, If
-   *     this value is set to 1024 (1 Kb / sec) and we deleted a file of size
-   *     4 Kb in 1 second, we will wait for another 3 seconds before we delete
-   *     other files, Set to 0 to disable deletion rate limiting.
-   * @param maxTrashDbRatio if the trash size constitutes for more than this
-   *     fraction of the total DB size we will start deleting new files passed
-   *     to DeleteScheduler immediately.
-   *
-   *  @throws RocksDBException thrown if error happens in underlying native library.
-   */
-  public SstFileManager(final Env env, /*@Nullable*/ final Logger logger,
-      final long rateBytesPerSec, final double maxTrashDbRatio)
-      throws RocksDBException {
-    this(env, logger, rateBytesPerSec, maxTrashDbRatio,
-        BYTES_MAX_DELETE_CHUNK_DEFAULT);
-  }
-
-  /**
-   * Create a new SstFileManager that can be shared among multiple RocksDB
-   * instances to track SST file and control there deletion rate.
-   *
-   * @param env the environment.
-   * @param logger if not null, the logger will be used to log errors.
-   * <p>
-   * == Deletion rate limiting specific arguments ==
-   * @param rateBytesPerSec how many bytes should be deleted per second, If
-   *     this value is set to 1024 (1 Kb / sec) and we deleted a file of size
-   *     4 Kb in 1 second, we will wait for another 3 seconds before we delete
-   *     other files, Set to 0 to disable deletion rate limiting.
-   * @param maxTrashDbRatio if the trash size constitutes for more than this
-   *     fraction of the total DB size we will start deleting new files passed
-   *     to DeleteScheduler immediately.
-   * @param bytesMaxDeleteChunk if a single file is larger than delete chunk,
-   *     ftruncate the file by this size each time, rather than dropping the whole
-   *     file. 0 means to always delete the whole file.
-   *
-   * @throws RocksDBException thrown if error happens in underlying native library.
-   */
-  public SstFileManager(final Env env, /*@Nullable*/final Logger logger,
-      final long rateBytesPerSec, final double maxTrashDbRatio,
-      final long bytesMaxDeleteChunk) throws RocksDBException {
-    super(newSstFileManager(env.nativeHandle_,
-        logger != null ? logger.nativeHandle_ : 0,
-        rateBytesPerSec, maxTrashDbRatio, bytesMaxDeleteChunk));
-  }
-
-  /**
-   * Update the maximum allowed space that should be used by RocksDB, if
-   * the total size of the SST files exceeds {@code maxAllowedSpace}, writes to
-   * RocksDB will fail.
-   * <p>
-   * Setting {@code maxAllowedSpace} to 0 will disable this feature;
-   * maximum allowed space will be infinite (Default value).
-   *
-   * @param maxAllowedSpace the maximum allowed space that should be used by
-   *     RocksDB.
-   */
-  public void setMaxAllowedSpaceUsage(final long maxAllowedSpace) {
-    setMaxAllowedSpaceUsage(nativeHandle_, maxAllowedSpace);
-  }
-
-  /**
-   * Set the amount of buffer room each compaction should be able to leave.
-   * In other words, at its maximum disk space consumption, the compaction
-   * should still leave {@code compactionBufferSize} available on the disk so
-   * that other background functions may continue, such as logging and flushing.
-   *
-   * @param compactionBufferSize the amount of buffer room each compaction
-   *     should be able to leave.
-   */
-  public void setCompactionBufferSize(final long compactionBufferSize) {
-    setCompactionBufferSize(nativeHandle_, compactionBufferSize);
-  }
-
-  /**
-   * Determines if the total size of SST files exceeded the maximum allowed
-   * space usage.
-   *
-   * @return true when the maximum allows space usage has been exceeded.
-   */
-  public boolean isMaxAllowedSpaceReached() {
-    return isMaxAllowedSpaceReached(nativeHandle_);
-  }
-
-  /**
-   * Determines if the total size of SST files as well as estimated size
-   * of ongoing compactions exceeds the maximums allowed space usage.
-   *
-   * @return true when the total size of SST files as well as estimated size
-   * of ongoing compactions exceeds the maximums allowed space usage.
-   */
-  public boolean isMaxAllowedSpaceReachedIncludingCompactions() {
-    return isMaxAllowedSpaceReachedIncludingCompactions(nativeHandle_);
-  }
-
-  /**
-   * Get the total size of all tracked files.
-   *
-   * @return the total size of all tracked files.
-   */
-  public long getTotalSize() {
-    return getTotalSize(nativeHandle_);
-  }
-
-  /**
-   * Gets all tracked files and their corresponding sizes.
-   *
-   * @return a map containing all tracked files and there corresponding sizes.
-   */
-  public Map<String, Long> getTrackedFiles() {
-    return getTrackedFiles(nativeHandle_);
-  }
-
-  /**
-   * Gets the delete rate limit.
-   *
-   * @return the delete rate limit (in bytes per second).
-   */
-  public long getDeleteRateBytesPerSecond() {
-    return getDeleteRateBytesPerSecond(nativeHandle_);
-  }
-
-  /**
-   * Set the delete rate limit.
-   * <p>
-   * Zero means disable delete rate limiting and delete files immediately.
-   *
-   * @param deleteRate the delete rate limit (in bytes per second).
-   */
-  public void setDeleteRateBytesPerSecond(final long deleteRate) {
-    setDeleteRateBytesPerSecond(nativeHandle_, deleteRate);
-  }
-
-  /**
-   * Get the trash/DB size ratio where new files will be deleted immediately.
-   *
-   * @return the trash/DB size ratio.
-   */
-  public double getMaxTrashDBRatio() {
-    return getMaxTrashDBRatio(nativeHandle_);
-  }
-
-  /**
-   * Set the trash/DB size ratio where new files will be deleted immediately.
-   *
-   * @param ratio the trash/DB size ratio.
-   */
-  public void setMaxTrashDBRatio(final double ratio) {
-    setMaxTrashDBRatio(nativeHandle_, ratio);
-  }
-
-  private static native long newSstFileManager(final long handle, final long logger_handle,
-      final long rateBytesPerSec, final double maxTrashDbRatio, final long bytesMaxDeleteChunk)
-      throws RocksDBException;
-  private native void setMaxAllowedSpaceUsage(final long handle,
-      final long maxAllowedSpace);
-  private native void setCompactionBufferSize(final long handle,
-      final long compactionBufferSize);
-  private native boolean isMaxAllowedSpaceReached(final long handle);
-  private native boolean isMaxAllowedSpaceReachedIncludingCompactions(
-      final long handle);
-  private native long getTotalSize(final long handle);
-  private native Map<String, Long> getTrackedFiles(final long handle);
-  private native long getDeleteRateBytesPerSecond(final long handle);
-  private native void setDeleteRateBytesPerSecond(final long handle,
-        final long deleteRate);
-  private native double getMaxTrashDBRatio(final long handle);
-  private native void setMaxTrashDBRatio(final long handle, final double ratio);
-  @Override protected native void disposeInternal(final long handle);
-}

package/vendor/rocksdb/java/src/main/java/org/rocksdb/SstFileMetaData.java

@@ -1,162 +0,0 @@
-// Copyright (c) 2011-present, Facebook, Inc.  All rights reserved.
-//  This source code is licensed under both the GPLv2 (found in the
-//  COPYING file in the root directory) and Apache 2.0 License
-//  (found in the LICENSE.Apache file in the root directory).
-
-package org.rocksdb;
-
-/**
- * The metadata that describes a SST file.
- */
-public class SstFileMetaData {
-  private final String fileName;
-  private final String path;
-  private final long size;
-  private final long smallestSeqno;
-  private final long largestSeqno;
-  private final byte[] smallestKey;
-  private final byte[] largestKey;
-  private final long numReadsSampled;
-  private final boolean beingCompacted;
-  private final long numEntries;
-  private final long numDeletions;
-
-  /**
-   * Called from JNI C++
-   *
-   * @param fileName the file name
-   * @param path the file path
-   * @param size the size of the file
-   * @param smallestSeqno the smallest sequence number
-   * @param largestSeqno the largest sequence number
-   * @param smallestKey the smallest key
-   * @param largestKey the largest key
-   * @param numReadsSampled the number of reads sampled
-   * @param beingCompacted true if the file is being compacted, false otherwise
-   * @param numEntries the number of entries
-   * @param numDeletions the number of deletions
-   */
-  protected SstFileMetaData(
-      final String fileName,
-      final String path,
-      final long size,
-      final long smallestSeqno,
-      final long largestSeqno,
-      final byte[] smallestKey,
-      final byte[] largestKey,
-      final long numReadsSampled,
-      final boolean beingCompacted,
-      final long numEntries,
-      final long numDeletions) {
-    this.fileName = fileName;
-    this.path = path;
-    this.size = size;
-    this.smallestSeqno = smallestSeqno;
-    this.largestSeqno = largestSeqno;
-    this.smallestKey = smallestKey;
-    this.largestKey = largestKey;
-    this.numReadsSampled = numReadsSampled;
-    this.beingCompacted = beingCompacted;
-    this.numEntries = numEntries;
-    this.numDeletions = numDeletions;
-  }
-
-  /**
-   * Get the name of the file.
-   *
-   * @return the name of the file.
-   */
-  public String fileName() {
-    return fileName;
-  }
-
-  /**
-   * Get the full path where the file locates.
-   *
-   * @return the full path
-   */
-  public String path() {
-    return path;
-  }
-
-  /**
-   * Get the file size in bytes.
-   *
-   * @return file size
-   */
-  public long size() {
-    return size;
-  }
-
-  /**
-   * Get the smallest sequence number in file.
-   *
-   * @return the smallest sequence number
-   */
-  public long smallestSeqno() {
-    return smallestSeqno;
-  }
-
-  /**
-   * Get the largest sequence number in file.
-   *
-   * @return the largest sequence number
-   */
-  public long largestSeqno() {
-    return largestSeqno;
-  }
-
-  /**
-   * Get the smallest user defined key in the file.
-   *
-   * @return the smallest user defined key
-   */
-  public byte[] smallestKey() {
-    return smallestKey;
-  }
-
-  /**
-   * Get the largest user defined key in the file.
-   *
-   * @return the largest user defined key
-   */
-  public byte[] largestKey() {
-    return largestKey;
-  }
-
-  /**
-   * Get the number of times the file has been read.
-   *
-   * @return the number of times the file has been read
-   */
-  public long numReadsSampled() {
-    return numReadsSampled;
-  }
-
-  /**
-   * Returns true if the file is currently being compacted.
-   *
-   * @return true if the file is currently being compacted, false otherwise.
-   */
-  public boolean beingCompacted() {
-    return beingCompacted;
-  }
-
-  /**
-   * Get the number of entries.
-   *
-   * @return the number of entries.
-   */
-  public long numEntries() {
-    return numEntries;
-  }
-
-  /**
-   * Get the number of deletions.
-   *
-   * @return the number of deletions.
-   */
-  public long numDeletions() {
-    return numDeletions;
-  }
-}

package/vendor/rocksdb/java/src/main/java/org/rocksdb/SstFileReader.java

@@ -1,82 +0,0 @@
-// Copyright (c) 2011-present, Facebook, Inc.  All rights reserved.
-//  This source code is licensed under both the GPLv2 (found in the
-//  COPYING file in the root directory) and Apache 2.0 License
-//  (found in the LICENSE.Apache file in the root directory).
-
-package org.rocksdb;
-
-public class SstFileReader extends RocksObject {
-  static {
-    RocksDB.loadLibrary();
-  }
-
-  public SstFileReader(final Options options) {
-    super(newSstFileReader(options.nativeHandle_));
-  }
-
-  /**
-   * 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.
-   * <p>
-   * Setting {@link 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).
-   * <p>
-   * Caller is responsible for deleting the returned Iterator.
-   *
-   * @param readOptions Read options.
-   *
-   * @return instance of iterator object.
-   */
-  public SstFileReaderIterator newIterator(final ReadOptions readOptions) {
-    assert (isOwningHandle());
-    final long iter = newIterator(nativeHandle_, readOptions.nativeHandle_);
-    return new SstFileReaderIterator(this, iter);
-  }
-
-  /**
-   * Prepare SstFileReader to read a file.
-   *
-   * @param filePath the location of file
-   *
-   * @throws RocksDBException thrown if error happens in underlying
-   *    native library.
-   */
-  public void open(final String filePath) throws RocksDBException {
-    open(nativeHandle_, filePath);
-  }
-
-  /**
-   * Verify checksum
-   *
-   * @throws RocksDBException if the checksum is not valid
-   */
-  public void verifyChecksum() throws RocksDBException {
-    verifyChecksum(nativeHandle_);
-  }
-
-  /**
-   * Get the properties of the table.
-   *
-   * @return the properties
-   *
-   * @throws RocksDBException if an error occurs whilst getting the table
-   *     properties
-   */
-  public TableProperties getTableProperties() throws RocksDBException {
-    return getTableProperties(nativeHandle_);
-  }
-
-  @Override protected final native void disposeInternal(final long handle);
-  private native long newIterator(final long handle, final long readOptionsHandle);
-
-  private native void open(final long handle, final String filePath)
-      throws RocksDBException;
-
-  private static native long newSstFileReader(final long optionsHandle);
-  private native void verifyChecksum(final long handle) throws RocksDBException;
-  private native TableProperties getTableProperties(final long handle)
-      throws RocksDBException;
-}