SstFileManager

java.lang.Object
- org.rocksdb.AbstractNativeReference
- - org.rocksdb.AbstractImmutableNativeReference
  - - org.rocksdb.RocksObject
    - - org.rocksdb.SstFileManager

所有已实现的接口:

java.lang.AutoCloseable
```
public final class SstFileManager
extends RocksObject
```
SstFileManager is used to track SST files in the DB and control their deletion rate.
All SstFileManager public functions are thread-safe.
SstFileManager is not extensible.

字段概要

字段
限定符和类型	字段和说明
`static long`	`BYTES_MAX_DELETE_CHUNK_DEFAULT`
`static boolean`	`DELETE_EXISTING_TRASH_DEFAULT`
`static double`	`MAX_TRASH_DB_RATION_DEFAULT`
`static long`	`RATE_BYTES_PER_SEC_DEFAULT`

从类继承的字段 org.rocksdb.RocksObject
nativeHandle_

从类继承的字段 org.rocksdb.AbstractImmutableNativeReference
owningHandle_

构造器概要

构造器
构造器和说明
`SstFileManager(Env env)` Create a new SstFileManager that can be shared among multiple RocksDB instances to track SST file and control there deletion rate.
`SstFileManager(Env env, Logger logger)` Create a new SstFileManager that can be shared among multiple RocksDB instances to track SST file and control there deletion rate.
`SstFileManager(Env env, Logger logger, long rateBytesPerSec)` Create a new SstFileManager that can be shared among multiple RocksDB instances to track SST file and control there deletion rate.
`SstFileManager(Env env, Logger logger, long rateBytesPerSec, double maxTrashDbRatio)` Create a new SstFileManager that can be shared among multiple RocksDB instances to track SST file and control there deletion rate.
`SstFileManager(Env env, Logger logger, long rateBytesPerSec, double maxTrashDbRatio, long bytesMaxDeleteChunk)` Create a new SstFileManager that can be shared among multiple RocksDB instances to track SST file and control there deletion rate.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected void`	`disposeInternal(long handle)`
`long`	`getDeleteRateBytesPerSecond()` Gets the delete rate limit.
`double`	`getMaxTrashDBRatio()` Get the trash/DB size ratio where new files will be deleted immediately.
`long`	`getTotalSize()` Get the total size of all tracked files.
`java.util.Map<java.lang.String,java.lang.Long>`	`getTrackedFiles()` Gets all tracked files and their corresponding sizes.
`boolean`	`isMaxAllowedSpaceReached()` Determines if the total size of SST files exceeded the maximum allowed space usage.
`boolean`	`isMaxAllowedSpaceReachedIncludingCompactions()` Determines if the total size of SST files as well as estimated size of ongoing compactions exceeds the maximums allowed space usage.
`void`	`setCompactionBufferSize(long compactionBufferSize)` Set the amount of buffer room each compaction should be able to leave.
`void`	`setDeleteRateBytesPerSecond(long deleteRate)` Set the delete rate limit.
`void`	`setMaxAllowedSpaceUsage(long maxAllowedSpace)` Update the maximum allowed space that should be used by RocksDB, if the total size of the SST files exceeds `maxAllowedSpace`, writes to RocksDB will fail.
`void`	`setMaxTrashDBRatio(double ratio)` Set the trash/DB size ratio where new files will be deleted immediately.

从类继承的方法 org.rocksdb.RocksObject
disposeInternal, getNativeHandle

从类继承的方法 org.rocksdb.AbstractImmutableNativeReference
close, disOwnNativeHandle, isOwningHandle

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - RATE_BYTES_PER_SEC_DEFAULT
```
public static final long RATE_BYTES_PER_SEC_DEFAULT
```
    另请参阅:
    
    常量字段值
  - DELETE_EXISTING_TRASH_DEFAULT
```
public static final boolean DELETE_EXISTING_TRASH_DEFAULT
```
    另请参阅:
    
    常量字段值
  - MAX_TRASH_DB_RATION_DEFAULT
```
public static final double MAX_TRASH_DB_RATION_DEFAULT
```
    另请参阅:
    
    常量字段值
  - BYTES_MAX_DELETE_CHUNK_DEFAULT
```
public static final long BYTES_MAX_DELETE_CHUNK_DEFAULT
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - SstFileManager
```
public SstFileManager(Env env)
               throws RocksDBException
```
    Create a new SstFileManager that can be shared among multiple RocksDB instances to track SST file and control there deletion rate.
    
    参数:
    
    env - the environment.
    
    抛出:
    
    RocksDBException - thrown if error happens in underlying native library.
  - SstFileManager
```
public SstFileManager(Env env,
                      Logger logger)
               throws RocksDBException
```
    Create a new SstFileManager that can be shared among multiple RocksDB instances to track SST file and control there deletion rate.
    
    参数:
    
    env - the environment.
    
    logger - if not null, the logger will be used to log errors.
    
    抛出:
    
    RocksDBException - thrown if error happens in underlying native library.
  - SstFileManager
```
public SstFileManager(Env env,
                      Logger logger,
                      long rateBytesPerSec)
               throws RocksDBException
```
    Create a new SstFileManager that can be shared among multiple RocksDB instances to track SST file and control there deletion rate.
    
    参数:
    
    env - the environment.
    
    logger - if not null, the logger will be used to log errors.
    == Deletion rate limiting specific arguments ==
    
    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.
    
    抛出:
    
    RocksDBException - thrown if error happens in underlying native library.
  - SstFileManager
```
public SstFileManager(Env env,
                      Logger logger,
                      long rateBytesPerSec,
                      double maxTrashDbRatio)
               throws RocksDBException
```
    Create a new SstFileManager that can be shared among multiple RocksDB instances to track SST file and control there deletion rate.
    
    参数:
    
    env - the environment.
    
    logger - if not null, the logger will be used to log errors.
    == Deletion rate limiting specific arguments ==
    
    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.
    
    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.
    
    抛出:
    
    RocksDBException - thrown if error happens in underlying native library.
  - SstFileManager
```
public SstFileManager(Env env,
                      Logger logger,
                      long rateBytesPerSec,
                      double maxTrashDbRatio,
                      long bytesMaxDeleteChunk)
               throws RocksDBException
```
    Create a new SstFileManager that can be shared among multiple RocksDB instances to track SST file and control there deletion rate.
    
    参数:
    
    env - the environment.
    
    logger - if not null, the logger will be used to log errors.
    == Deletion rate limiting specific arguments ==
    
    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.
    
    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.
    
    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.
    
    抛出:
    
    RocksDBException - thrown if error happens in underlying native library.
- 方法详细资料
  - setMaxAllowedSpaceUsage
```
public void setMaxAllowedSpaceUsage(long maxAllowedSpace)
```
    Update the maximum allowed space that should be used by RocksDB, if the total size of the SST files exceeds maxAllowedSpace, writes to RocksDB will fail.
    Setting maxAllowedSpace to 0 will disable this feature; maximum allowed space will be infinite (Default value).
    
    参数:
    
    maxAllowedSpace - the maximum allowed space that should be used by RocksDB.
  - setCompactionBufferSize
```
public void setCompactionBufferSize(long compactionBufferSize)
```
    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 compactionBufferSize available on the disk so that other background functions may continue, such as logging and flushing.
    
    参数:
    
    compactionBufferSize - the amount of buffer room each compaction should be able to leave.
  - isMaxAllowedSpaceReached
```
public boolean isMaxAllowedSpaceReached()
```
    Determines if the total size of SST files exceeded the maximum allowed space usage.
    
    返回:
    
    true when the maximum allows space usage has been exceeded.
  - isMaxAllowedSpaceReachedIncludingCompactions
```
public boolean isMaxAllowedSpaceReachedIncludingCompactions()
```
    Determines if the total size of SST files as well as estimated size of ongoing compactions exceeds the maximums allowed space usage.
    
    返回:
    
    true when the total size of SST files as well as estimated size of ongoing compactions exceeds the maximums allowed space usage.
  - getTotalSize
```
public long getTotalSize()
```
    Get the total size of all tracked files.
    
    返回:
    
    the total size of all tracked files.
  - getTrackedFiles
```
public java.util.Map<java.lang.String,java.lang.Long> getTrackedFiles()
```
    Gets all tracked files and their corresponding sizes.
    
    返回:
    
    a map containing all tracked files and there corresponding sizes.
  - getDeleteRateBytesPerSecond
```
public long getDeleteRateBytesPerSecond()
```
    Gets the delete rate limit.
    
    返回:
    
    the delete rate limit (in bytes per second).
  - setDeleteRateBytesPerSecond
```
public void setDeleteRateBytesPerSecond(long deleteRate)
```
    Set the delete rate limit.
    Zero means disable delete rate limiting and delete files immediately.
    
    参数:
    
    deleteRate - the delete rate limit (in bytes per second).
  - getMaxTrashDBRatio
```
public double getMaxTrashDBRatio()
```
    Get the trash/DB size ratio where new files will be deleted immediately.
    
    返回:
    
    the trash/DB size ratio.
  - setMaxTrashDBRatio
```
public void setMaxTrashDBRatio(double ratio)
```
    Set the trash/DB size ratio where new files will be deleted immediately.
    
    参数:
    
    ratio - the trash/DB size ratio.
  - disposeInternal
```
protected void disposeInternal(long handle)
```
    指定者:
    
    disposeInternal 在类中 RocksObject

类 SstFileManager

字段概要

从类继承的字段 org.rocksdb.RocksObject

从类继承的字段 org.rocksdb.AbstractImmutableNativeReference

构造器概要

方法概要

从类继承的方法 org.rocksdb.RocksObject

从类继承的方法 org.rocksdb.AbstractImmutableNativeReference

从类继承的方法 java.lang.Object

字段详细资料

RATE_BYTES_PER_SEC_DEFAULT

DELETE_EXISTING_TRASH_DEFAULT

MAX_TRASH_DB_RATION_DEFAULT

BYTES_MAX_DELETE_CHUNK_DEFAULT

构造器详细资料

SstFileManager

SstFileManager

SstFileManager

SstFileManager

SstFileManager

方法详细资料

setMaxAllowedSpaceUsage

setCompactionBufferSize

isMaxAllowedSpaceReached

isMaxAllowedSpaceReachedIncludingCompactions

getTotalSize

getTrackedFiles

getDeleteRateBytesPerSecond

setDeleteRateBytesPerSecond

getMaxTrashDBRatio

setMaxTrashDBRatio

disposeInternal