RocksDBOptions.h

//
//  RocksDBOptions.h
//  ObjectiveRocks
//
//  Created by Iska on 20/11/14.
//  Copyright (c) 2014 BrainCookie. All rights reserved.
//

#import <Foundation/Foundation.h>
#import "RocksDBDatabaseOptions.h"
#import "RocksDBColumnFamilyOptions.h"

@class RocksDBComparator;
@class RocksDBMergeOperator;
@class RocksDBPrefixExtractor;

NS_ASSUME_NONNULL_BEGIN

#pragma mark - Options

/**
 A proxy object for `RocksDBDatabaseOptions` and `RocksDBColumnFamilyOptions`.
 */
@interface RocksDBOptions : NSObject

/**
 Initializes a new instance of `RocksDBOptions`.

 @param dbOptions The DB options.
 @param columnFamilyOptions The Column Family options.
 @return A newly-initialized instance of `RocksDBOptions`.

 @warning When creating multiple instances of `RocksDBOptions` for different Column
 Families, make sure to pass an "equal" DB options object across all instances.
 */
- (instancetype)initWithDatabaseOptions:(RocksDBDatabaseOptions *)dbOptions
				 andColumnFamilyOptions:(RocksDBColumnFamilyOptions *)columnFamilyOptions;

@end

#pragma mark - DB Options

/**
 Options to control the behavior of the DB.
 */
@interface RocksDBOptions (DBOptions)

/** @brief If true, the database will be created if it is missing. 
 The default is false. */
@property (nonatomic, assign) BOOL createIfMissing;

/** @brief If true, missing column families will be automatically created. 
 The default is false. */
@property (nonatomic, assign) BOOL createMissingColumnFamilies;

/** @brief An error is raised if the database already exists.
 The default is false. */
@property (nonatomic, assign) BOOL errorIfExists;

/** @brief If true, RocksDB will aggressively check consistency of the data.
  Also, if any of the  writes to the database fails (Put, Delete, Merge,
  Write), the database will switch to read-only mode and fail all other
  Write operations.
 The default is true.
 */
@property (nonatomic, assign) BOOL paranoidChecks;

/** @brief The info log level. */
@property (nonatomic, assign) RocksDBLogLevel infoLogLevel;

/** @brief Number of open files that can be used by the DB.
 The default is 5000. */
@property (nonatomic, assign) int maxOpenFiles;

/** @brief Once write-ahead logs exceed this size, column families whose 
 memtables are  backed by the oldest live WAL file will be forced to flush.
 The default is 0. */
@property (nonatomic, assign) uint64_t maxWriteAheadLogSize;

#if !(defined(ROCKSDB_LITE) && defined(TARGET_OS_IPHONE))
/** @brief If non-nil, metrics about database operations will be collected.
 Statistics objects should not be shared between DB instances. 
 The default is nil. 
 
 @see RocksDBStatistics
 */
@property (nonatomic, strong, nullable) RocksDBStatistics *statistics;
#endif

/** @brief If true, then the contents of manifest and data files are not 
 synced to stable storage.
 The default is false. */
@property (nonatomic, assign) BOOL disableDataSync;

/** @brief If true, then every store to stable storage will issue a fsync.
 The default is false. */
@property (nonatomic, assign) BOOL useFSync;

/** @brief Specify the maximal size of the info log file. If maxLogFileSize == 0,
 all logs will be written to one log file.
 The default is 0. */
@property (nonatomic, assign) size_t maxLogFileSize;

/** @brief Time for the info log file to roll (in seconds).
 The default is 0 (disabled). */
@property (nonatomic, assign) size_t logFileTimeToRoll;

/** @brief Maximal info log files to be kept.
 The default is 1000. */
@property (nonatomic, assign) size_t keepLogFileNum;

/** @brief Allows OS to incrementally sync files to disk while they are being
 written, asynchronously, in the background.
 The default is 0. */
@property (nonatomic, assign) uint64_t bytesPerSync;

/** @brief Recovery mode to control the consistency while replaying WAL
 Default: kPointInTimeRecovery */
@property (nonatomic, assign) RocksDBWALRecoveryMode walRecoveryMode;

@end

#pragma mark - Column Family Options

/**
 Options to control the behaviour of Column Families.
 @RocksDBColumnFamily
 */
@interface RocksDBOptions (ColumnFamilyOptions)

/** @brief Comparator used to define the order of keys in the table.
 Default: a comparator that uses lexicographic byte-wise ordering. 
 
 @see RocksDBComparator
 */
@property (nonatomic, strong, nullable) RocksDBComparator *comparator;

/** @brief The client must provide a merge operator if Merge operation
 needs to be accessed.
 Default: nil

 @warning The client must ensure that the merge operator supplied here has 
 the same name and *exactly* the same semantics as the merge operator provided 
 to previous open calls on the same DB.

 @see RocksDBMergeOperator
 */
@property (nonatomic, strong, nullable) RocksDBMergeOperator *mergeOperator;

/** @brief Amount of data to build up in memory (backed by an unsorted log
 on disk) before converting to a sorted on-disk file.
 Default: 4MB.
 */
@property (nonatomic, assign) size_t writeBufferSize;

/** @brief The maximum number of write buffers that are built up in memory.
 Default: 2
 */
@property (nonatomic, assign) int maxWriteBufferNumber;

/** @brief The minimum number of write buffers that will be merged together
 before writing to storage.
 Default: 1
 */
@property (nonatomic, assign) int minWriteBufferNumberToMerge;

/** @brief Compress blocks using the specified compression algorithm.
 Default: RocksDBCompressionSnappy, which gives lightweight but fast compression.
 */
@property (nonatomic, assign) RocksDBCompressionType compressionType;

/** @brief Set compaction style for DB.
 Default: RocksDBCompactionStyleLevel
 */
@property (nonatomic, assign) RocksDBCompactionStyle compactionStyle;

/** @brief If non-nil, the specified function to determine the
 prefixes for keys will be used. These prefixes will be placed in the filter.

 @see RocksDBPrefixExtractor
 */
@property (nonatomic, strong, nullable) RocksDBPrefixExtractor *prefixExtractor;

/** @brief Number of levels for this DB. */
@property (nonatomic, assign) int numLevels;

/** @brief Number of files to trigger level-0 compaction.
 Default: 4
 */
@property (nonatomic, assign) int level0FileNumCompactionTrigger;

/** @brief Soft limit on number of level-0 files. */
@property (nonatomic, assign) int level0SlowdownWritesTrigger;

/** @brief Maximum number of level-0 files. */
@property (nonatomic, assign) int level0StopWritesTrigger;

/** @brief Maximum level to which a new compacted memtable is pushed if it
 does not create overlap. */
@property (nonatomic, assign) int maxMemCompactionLevel;

/** @brief Target file size for compaction.
 Default: 2MB
 */
@property (nonatomic, assign) uint64_t targetFileSizeBase;

/** @brief By default target_file_size_multiplier is 1, which means
 by default files in different levels will have similar size. */
@property (nonatomic, assign) int targetFileSizeMultiplier;

/** @brief Control maximum total data size for a level.
 Default: 10MB
 */
@property (nonatomic, assign) uint64_t maxBytesForLevelBase;

/** @brief Default: 10 */
@property (nonatomic, assign) double maxBytesForLevelMultiplier;

/** @brief  Maximum number of bytes in all compacted files. */
@property (nonatomic, assign) int expandedCompactionFactor;

/** @brief Maximum number of bytes in all source files to be compacted in a
 single compaction run. */
@property (nonatomic, assign) int sourceCompactionFactor;

/** @brief Control maximum bytes of overlaps in grandparent (i.e., level+2) */
@property (nonatomic, assign) int maxGrandparentOverlapFactor;

/** @brief Puts are delayed 0-1 ms when any level has a compaction score that
 exceeds this limit.
 Default: 0 (disabled)
 */
@property (nonatomic, assign) double softRateLimit;

/** @brief Puts are delayed 1ms at a time when any level has a compaction 
 score that exceeds this limit.
 Default: 0 (disabled)
 */
@property (nonatomic, assign) double hardRateLimit;

/** @brief Size of one block in arena memory allocation.
 Default: 0
 */
@property (nonatomic, assign) size_t arenaBlockSize;

/** @brief Disable automatic compactions. Manual compactions can still be issued 
 on the column family. */
@property (nonatomic, assign) BOOL disableAutoCompactions;

/** @brief Purge duplicate/deleted keys when a memtable is flushed to storage. */
@property (nonatomic, assign) BOOL purgeRedundantKvsWhileFlush;

/** @brief If true, compaction will verify checksum on every read that happens 
 as part of compaction.
 Default: true
 */
@property (nonatomic, assign) BOOL verifyChecksumsInCompaction;

/** @brief Use KeyMayExist API to filter deletes when this is true.
 Default: false
 */
@property (nonatomic, assign) BOOL filterDeletes;

/** @brief An iteration->Next() sequentially skips over keys with the same
 user-key unless this option is set.
 Default: 0
 */
@property (nonatomic, assign) uint64_t maxSequentialSkipInIterations;

/** @brief This is a factory that provides MemTableRep objects.
 Default: A factory that provides a skip-list-based implementation of MemTableRep.

 @see RocksDBMemTableRepFactory
 */
@property (nonatomic, strong, nullable) RocksDBMemTableRepFactory *memTableRepFactory;

/** @brief This is a factory that provides TableFactory objects.
 Default: A block-based table factory that provides a default
 implementation of TableBuilder and TableReader with default
 BlockBasedTableOptions.

 @see RocksDBTableFactory
 */
@property (nonatomic, strong, nullable) RocksDBTableFactory *tableFacotry;

/** @brief If prefixExtractor is set and bloom_bits is not 0, create prefix bloom
 for memtable

 @see RocksDBPrefixExtractor
*/
@property (nonatomic, assign) uint32_t memtablePrefixBloomBits;

/** @brief Number of hash probes per key. */
@property (nonatomic, assign) uint32_t memtablePrefixBloomProbes;

/** @brief Page size for huge page TLB for bloom in memtable. */
@property (nonatomic, assign) size_t memtablePrefixBloomHugePageTlbSize;

/** @brief Control locality of bloom filter probes to improve cache miss rate.
 Default: 0
 */
@property (nonatomic, assign) uint32_t bloomLocality;

/** @brief Maximum number of successive merge operations on a key in the memtable. 
 Default: 0 (disabled)
 */
@property (nonatomic, assign) size_t maxSuccessiveMerges;

/** @brief The number of partial merge operands to accumulate before partial
 merge will be performed.
 Default: 2
 */
@property (nonatomic, assign) uint32_t minPartialMergeOperands;

@end

NS_ASSUME_NONNULL_END