rocksdb-native 0.0.0 → 0.0.1

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

@@ -1,101 +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.List;
-
-public class OptionsUtil {
-  /**
-   * A static method to construct the DBOptions and ColumnFamilyDescriptors by
-   * loading the latest RocksDB options file stored in the specified rocksdb
-   * database.
-   * <p>
-   * Note that the all the pointer options (except table_factory, which will
-   * be described in more details below) will be initialized with the default
-   * values.  Developers can further initialize them after this function call.
-   * Below is an example list of pointer options which will be initialized.
-   * <p>
-   * - env
-   * - memtable_factory
-   * - compaction_filter_factory
-   * - prefix_extractor
-   * - comparator
-   * - merge_operator
-   * - compaction_filter
-   * <p>
-   * For table_factory, this function further supports deserializing
-   * BlockBasedTableFactory and its BlockBasedTableOptions except the
-   * pointer options of BlockBasedTableOptions (flush_block_policy_factory,
-   * and block_cache), which will be initialized with
-   * default values.  Developers can further specify these three options by
-   * casting the return value of TableFactoroy::GetOptions() to
-   * BlockBasedTableOptions and making necessary changes.
-   *
-   * @param dbPath the path to the RocksDB.
-   * @param configOptions {@link org.rocksdb.ConfigOptions} instance.
-   * @param dbOptions {@link org.rocksdb.DBOptions} instance. This will be
-   *     filled and returned.
-   * @param cfDescs A list of {@link org.rocksdb.ColumnFamilyDescriptor}'s be
-   *     returned.
-   * @throws RocksDBException thrown if error happens in underlying
-   *     native library.
-   */
-  public static void loadLatestOptions(final ConfigOptions configOptions, final String dbPath,
-      final DBOptions dbOptions, final List<ColumnFamilyDescriptor> cfDescs)
-      throws RocksDBException {
-    loadLatestOptions(configOptions.nativeHandle_, dbPath, dbOptions.nativeHandle_, cfDescs);
-  }
-
-  /**
-   * Similar to LoadLatestOptions, this function constructs the DBOptions
-   * and ColumnFamilyDescriptors based on the specified RocksDB Options file.
-   * See LoadLatestOptions above.
-   *
-   * @param optionsFileName the RocksDB options file path.
-   * @param configOptions {@link org.rocksdb.ConfigOptions} instance.
-   * @param dbOptions {@link org.rocksdb.DBOptions} instance. This will be
-   *     filled and returned.
-   * @param cfDescs A list of {@link org.rocksdb.ColumnFamilyDescriptor}'s be
-   *     returned.
-   * @throws RocksDBException thrown if error happens in underlying
-   *     native library.
-   */
-  public static void loadOptionsFromFile(final ConfigOptions configOptions,
-      final String optionsFileName, final DBOptions dbOptions,
-      final List<ColumnFamilyDescriptor> cfDescs) throws RocksDBException {
-    loadOptionsFromFile(
-        configOptions.nativeHandle_, optionsFileName, dbOptions.nativeHandle_, cfDescs);
-  }
-
-  /**
-   * Returns the latest options file name under the specified RocksDB path.
-   *
-   * @param dbPath the path to the RocksDB.
-   * @param env {@link org.rocksdb.Env} instance.
-   * @return the latest options file name under the db path.
-   *
-   * @throws RocksDBException thrown if error happens in underlying
-   *     native library.
-   */
-  public static String getLatestOptionsFileName(final String dbPath, final Env env)
-      throws RocksDBException {
-    return getLatestOptionsFileName(dbPath, env.nativeHandle_);
-  }
-
-  /**
-   * Private constructor.
-   * This class has only static methods and shouldn't be instantiated.
-   */
-  private OptionsUtil() {}
-
-  // native methods
-  private static native void loadLatestOptions(long cfgHandle, String dbPath, long dbOptionsHandle,
-      List<ColumnFamilyDescriptor> cfDescs) throws RocksDBException;
-  private static native void loadOptionsFromFile(long cfgHandle, String optionsFileName,
-      long dbOptionsHandle, List<ColumnFamilyDescriptor> cfDescs) throws RocksDBException;
-  private static native String getLatestOptionsFileName(String dbPath, long envHandle)
-      throws RocksDBException;
-}

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

@@ -1,26 +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;
-
-/**
- * Persistent cache for caching IO pages on a persistent medium. The
- * cache is specifically designed for persistent read cache.
- */
-public class PersistentCache extends RocksObject {
-
-  public PersistentCache(final Env env, final String path, final long size,
-      final Logger logger, final boolean optimizedForNvm)
-      throws RocksDBException {
-    super(newPersistentCache(env.nativeHandle_, path, size,
-        logger.nativeHandle_, optimizedForNvm));
-  }
-
-  private static native long newPersistentCache(final long envHandle, final String path,
-      final long size, final long loggerHandle, final boolean optimizedForNvm)
-      throws RocksDBException;
-
-  @Override protected final native void disposeInternal(final long handle);
-}

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

@@ -1,251 +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 config for plain table sst format.
- *
- * <p>PlainTable is a RocksDB's SST file format optimized for low query
- * latency on pure-memory or really low-latency media.</p>
- *
- * <p>It also support prefix hash feature.</p>
- */
-public class PlainTableConfig extends TableFormatConfig {
-  public static final int VARIABLE_LENGTH = 0;
-  public static final int DEFAULT_BLOOM_BITS_PER_KEY = 10;
-  public static final double DEFAULT_HASH_TABLE_RATIO = 0.75;
-  public static final int DEFAULT_INDEX_SPARSENESS = 16;
-  public static final int DEFAULT_HUGE_TLB_SIZE = 0;
-  public static final EncodingType DEFAULT_ENCODING_TYPE =
-      EncodingType.kPlain;
-  public static final boolean DEFAULT_FULL_SCAN_MODE = false;
-  public static final boolean DEFAULT_STORE_INDEX_IN_FILE
-      = false;
-
-  public PlainTableConfig() {
-    keySize_ = VARIABLE_LENGTH;
-    bloomBitsPerKey_ = DEFAULT_BLOOM_BITS_PER_KEY;
-    hashTableRatio_ = DEFAULT_HASH_TABLE_RATIO;
-    indexSparseness_ = DEFAULT_INDEX_SPARSENESS;
-    hugePageTlbSize_ = DEFAULT_HUGE_TLB_SIZE;
-    encodingType_ = DEFAULT_ENCODING_TYPE;
-    fullScanMode_ = DEFAULT_FULL_SCAN_MODE;
-    storeIndexInFile_ = DEFAULT_STORE_INDEX_IN_FILE;
-  }
-
-  /**
-   * <p>Set the length of the user key. If it is set to be
-   * VARIABLE_LENGTH, then it indicates the user keys are
-   * of variable length.</p>
-   *
-   * <p>Otherwise,all the keys need to have the same length
-   * in byte.</p>
-   *
-   * <p>DEFAULT: VARIABLE_LENGTH</p>
-   *
-   * @param keySize the length of the user key.
-   * @return the reference to the current config.
-   */
-  public PlainTableConfig setKeySize(final int keySize) {
-    keySize_ = keySize;
-    return this;
-  }
-
-  /**
-   * @return the specified size of the user key.  If VARIABLE_LENGTH,
-   *     then it indicates variable-length key.
-   */
-  public int keySize() {
-    return keySize_;
-  }
-
-  /**
-   * Set the number of bits per key used by the internal bloom filter
-   * in the plain table sst format.
-   *
-   * @param bitsPerKey the number of bits per key for bloom filer.
-   * @return the reference to the current config.
-   */
-  public PlainTableConfig setBloomBitsPerKey(final int bitsPerKey) {
-    bloomBitsPerKey_ = bitsPerKey;
-    return this;
-  }
-
-  /**
-   * @return the number of bits per key used for the bloom filter.
-   */
-  public int bloomBitsPerKey() {
-    return bloomBitsPerKey_;
-  }
-
-  /**
-   * hashTableRatio is the desired utilization of the hash table used
-   * for prefix hashing.  The ideal ratio would be the number of
-   * prefixes / the number of hash buckets.  If this value is set to
-   * zero, then hash table will not be used.
-   *
-   * @param ratio the hash table ratio.
-   * @return the reference to the current config.
-   */
-  public PlainTableConfig setHashTableRatio(final double ratio) {
-    hashTableRatio_ = ratio;
-    return this;
-  }
-
-  /**
-   * @return the hash table ratio.
-   */
-  public double hashTableRatio() {
-    return hashTableRatio_;
-  }
-
-  /**
-   * Index sparseness determines the index interval for keys inside the
-   * same prefix.  This number is equal to the maximum number of linear
-   * search required after hash and binary search.  If it's set to 0,
-   * then each key will be indexed.
-   *
-   * @param sparseness the index sparseness.
-   * @return the reference to the current config.
-   */
-  public PlainTableConfig setIndexSparseness(final int sparseness) {
-    indexSparseness_ = sparseness;
-    return this;
-  }
-
-  /**
-   * @return the index sparseness.
-   */
-  public long indexSparseness() {
-    return indexSparseness_;
-  }
-
-  /**
-   * <p>huge_page_tlb_size: if &le;0, allocate hash indexes and blooms
-   * from malloc otherwise from huge page TLB.</p>
-   *
-   * <p>The user needs to reserve huge pages for it to be allocated,
-   * like: {@code sysctl -w vm.nr_hugepages=20}</p>
-   *
-   * <p>See linux doc Documentation/vm/hugetlbpage.txt</p>
-   *
-   * @param hugePageTlbSize huge page tlb size
-   * @return the reference to the current config.
-   */
-  public PlainTableConfig setHugePageTlbSize(final int hugePageTlbSize) {
-    this.hugePageTlbSize_ = hugePageTlbSize;
-    return this;
-  }
-
-  /**
-   * Returns the value for huge page tlb size
-   *
-   * @return hugePageTlbSize
-   */
-  public int hugePageTlbSize() {
-    return hugePageTlbSize_;
-  }
-
-  /**
-   * Sets the encoding type.
-   *
-   * <p>This setting determines how to encode
-   * the keys. See enum {@link EncodingType} for
-   * the choices.</p>
-   *
-   * <p>The value will determine how to encode keys
-   * when writing to a new SST file. This value will be stored
-   * inside the SST file which will be used when reading from
-   * the file, which makes it possible for users to choose
-   * different encoding type when reopening a DB. Files with
-   * different encoding types can co-exist in the same DB and
-   * can be read.</p>
-   *
-   * @param encodingType {@link org.rocksdb.EncodingType} value.
-   * @return the reference to the current config.
-   */
-  public PlainTableConfig setEncodingType(final EncodingType encodingType) {
-    this.encodingType_ = encodingType;
-    return this;
-  }
-
-  /**
-   * Returns the active EncodingType
-   *
-   * @return currently set encoding type
-   */
-  public EncodingType encodingType() {
-    return encodingType_;
-  }
-
-  /**
-   * Set full scan mode, if true the whole file will be read
-   * one record by one without using the index.
-   *
-   * @param fullScanMode boolean value indicating if full
-   *     scan mode shall be enabled.
-   * @return the reference to the current config.
-   */
-  public PlainTableConfig setFullScanMode(final boolean fullScanMode) {
-    this.fullScanMode_ = fullScanMode;
-    return this;
-  }
-
-  /**
-   * Return if full scan mode is active
-   * @return boolean value indicating if the full scan mode is
-   *     enabled.
-   */
-  public boolean fullScanMode() {
-    return fullScanMode_;
-  }
-
-  /**
-   * <p>If set to true: compute plain table index and bloom
-   * filter during file building and store it in file.
-   * When reading file, index will be mmaped instead
-   * of doing recomputation.</p>
-   *
-   * @param storeIndexInFile value indicating if index shall
-   *     be stored in a file
-   * @return the reference to the current config.
-   */
-  public PlainTableConfig setStoreIndexInFile(final boolean storeIndexInFile) {
-    this.storeIndexInFile_ = storeIndexInFile;
-    return this;
-  }
-
-  /**
-   * Return a boolean value indicating if index shall be stored
-   * in a file.
-   *
-   * @return currently set value for store index in file.
-   */
-  public boolean storeIndexInFile() {
-    return storeIndexInFile_;
-  }
-
-  @Override protected long newTableFactoryHandle() {
-    return newTableFactoryHandle(keySize_, bloomBitsPerKey_,
-        hashTableRatio_, indexSparseness_, hugePageTlbSize_,
-        encodingType_.getValue(), fullScanMode_,
-        storeIndexInFile_);
-  }
-
-  private native long newTableFactoryHandle(
-      int keySize, int bloomBitsPerKey,
-      double hashTableRatio, int indexSparseness,
-      int hugePageTlbSize, byte encodingType,
-      boolean fullScanMode, boolean storeIndexInFile);
-
-  private int keySize_;
-  private int bloomBitsPerKey_;
-  private double hashTableRatio_;
-  private int indexSparseness_;
-  private int hugePageTlbSize_;
-  private EncodingType encodingType_;
-  private boolean fullScanMode_;
-  private boolean storeIndexInFile_;
-}

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

@@ -1,117 +0,0 @@
-//  Copyright (c) Meta Platforms, Inc. and affiliates.
-//  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;
-
-/**
- * Enum PrepopulateBlobCache
- *
- * <p>Prepopulate warm/hot blobs which are already in memory into blob
- * cache at the time of flush. On a flush, the blob that is in memory
- * (in memtables) get flushed to the device. If using Direct IO,
- * additional IO is incurred to read this blob back into memory again,
- * which is avoided by enabling this option. This further helps if the
- * workload exhibits high temporal locality, where most of the reads go
- * to recently written data. This also helps in case of the remote file
- * system since it involves network traffic and higher latencies.</p>
- */
-public enum PrepopulateBlobCache {
-  PREPOPULATE_BLOB_DISABLE((byte) 0x0, "prepopulate_blob_disable", "kDisable"),
-  PREPOPULATE_BLOB_FLUSH_ONLY((byte) 0x1, "prepopulate_blob_flush_only", "kFlushOnly");
-
-  /**
-   * <p>Get the PrepopulateBlobCache enumeration value by
-   * passing the library name to this method.</p>
-   *
-   * <p>If library cannot be found the enumeration
-   * value {@code PREPOPULATE_BLOB_DISABLE} will be returned.</p>
-   *
-   * @param libraryName prepopulate blob cache library name.
-   *
-   * @return PrepopulateBlobCache instance.
-   */
-  public static PrepopulateBlobCache getPrepopulateBlobCache(String libraryName) {
-    if (libraryName != null) {
-      for (PrepopulateBlobCache prepopulateBlobCache : PrepopulateBlobCache.values()) {
-        if (prepopulateBlobCache.getLibraryName() != null
-            && prepopulateBlobCache.getLibraryName().equals(libraryName)) {
-          return prepopulateBlobCache;
-        }
-      }
-    }
-    return PrepopulateBlobCache.PREPOPULATE_BLOB_DISABLE;
-  }
-
-  /**
-   * <p>Get the PrepopulateBlobCache enumeration value by
-   * passing the byte identifier to this method.</p>
-   *
-   * @param byteIdentifier of PrepopulateBlobCache.
-   *
-   * @return PrepopulateBlobCache instance.
-   *
-   * @throws IllegalArgumentException If PrepopulateBlobCache cannot be found for the
-   *   provided byteIdentifier
-   */
-  public static PrepopulateBlobCache getPrepopulateBlobCache(byte byteIdentifier) {
-    for (final PrepopulateBlobCache prepopulateBlobCache : PrepopulateBlobCache.values()) {
-      if (prepopulateBlobCache.getValue() == byteIdentifier) {
-        return prepopulateBlobCache;
-      }
-    }
-
-    throw new IllegalArgumentException("Illegal value provided for PrepopulateBlobCache.");
-  }
-
-  /**
-   * <p>Get a PrepopulateBlobCache value based on the string key in the C++ options output.
-   * This gets used in support of getting options into Java from an options string,
-   * which is generated at the C++ level.
-   * </p>
-   *
-   * @param internalName the internal (C++) name by which the option is known.
-   *
-   * @return PrepopulateBlobCache instance (optional)
-   */
-  static PrepopulateBlobCache getFromInternal(final String internalName) {
-    for (final PrepopulateBlobCache prepopulateBlobCache : PrepopulateBlobCache.values()) {
-      if (prepopulateBlobCache.internalName_.equals(internalName)) {
-        return prepopulateBlobCache;
-      }
-    }
-
-    throw new IllegalArgumentException(
-        "Illegal internalName '" + internalName + " ' provided for PrepopulateBlobCache.");
-  }
-
-  /**
-   * <p>Returns the byte value of the enumerations value.</p>
-   *
-   * @return byte representation
-   */
-  public byte getValue() {
-    return value_;
-  }
-
-  /**
-   * <p>Returns the library name of the prepopulate blob cache mode
-   * identified by the enumeration value.</p>
-   *
-   * @return library name
-   */
-  public String getLibraryName() {
-    return libraryName_;
-  }
-
-  PrepopulateBlobCache(final byte value, final String libraryName, final String internalName) {
-    value_ = value;
-    libraryName_ = libraryName;
-    internalName_ = internalName;
-  }
-
-  private final byte value_;
-  private final String libraryName_;
-  private final String internalName_;
-}

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

@@ -1,49 +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 Thread Pool priority.
- */
-public enum Priority {
-  BOTTOM((byte) 0x0),
-  LOW((byte) 0x1),
-  HIGH((byte)0x2),
-  TOTAL((byte)0x3);
-
-  private final byte value;
-
-  Priority(final byte value) {
-    this.value = value;
-  }
-
-  /**
-   * <p>Returns the byte value of the enumerations value.</p>
-   *
-   * @return byte representation
-   */
-  byte getValue() {
-    return value;
-  }
-
-  /**
-   * Get Priority by byte value.
-   *
-   * @param value byte representation of Priority.
-   *
-   * @return {@link org.rocksdb.Priority} instance.
-   * @throws java.lang.IllegalArgumentException if an invalid
-   *     value is provided.
-   */
-  static Priority getPriority(final byte value) {
-    for (final Priority priority : Priority.values()) {
-      if (priority.getValue() == value){
-        return priority;
-      }
-    }
-    throw new IllegalArgumentException("Illegal value provided for Priority.");
-  }
-}

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

@@ -1,19 +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;
-
-/**
- * Range from start to limit.
- */
-public class Range {
-  final Slice start;
-  final Slice limit;
-
-  public Range(final Slice start, final Slice limit) {
-    this.start = start;
-    this.limit = limit;
-  }
-}