grocksdb

func (*BackupEngine) Close ¶

func (b *BackupEngine) Close()

Close close the backup engine and cleans up state The backups already taken remain on storage.

func (*BackupEngine) CreateNewBackup ¶

func (b *BackupEngine) CreateNewBackup() (err error)

CreateNewBackup takes a new backup from db.

func (*BackupEngine) CreateNewBackupFlush ¶

func (b *BackupEngine) CreateNewBackupFlush(flushBeforeBackup bool) (err error)

CreateNewBackupFlush takes a new backup from db. Backup would be created after flushing.

func (*BackupEngine) GetInfo ¶

func (b *BackupEngine) GetInfo() (infos []BackupInfo)

GetInfo gets an object that gives information about the backups that have already been taken

func (*BackupEngine) PurgeOldBackups ¶

func (b *BackupEngine) PurgeOldBackups(numBackupsToKeep uint32) (err error)

PurgeOldBackups deletes old backups, where `numBackupsToKeep` is how many backups you’d like to keep.

func (*BackupEngine) RestoreDBFromBackup ¶ added in v1.6.21

func (b *BackupEngine) RestoreDBFromBackup(dbDir, walDir string, ro *RestoreOptions, backupID uint32) (err error)

RestoreDBFromBackup restores the backup (identified by its id) to dbDir. walDir is where the write ahead logs are restored to and usually the same as dbDir.

func (*BackupEngine) RestoreDBFromLatestBackup ¶

func (b *BackupEngine) RestoreDBFromLatestBackup(dbDir, walDir string, ro *RestoreOptions) (err error)

RestoreDBFromLatestBackup restores the latest backup to dbDir. walDir is where the write ahead logs are restored to and usually the same as dbDir.

func (*BackupEngine) VerifyBackup ¶

func (b *BackupEngine) VerifyBackup(backupID uint32) (err error)

VerifyBackup verifies a backup by its id.

func (*BackupEngineOptions) BackupLogFiles ¶ added in v1.7.0

func (b *BackupEngineOptions) BackupLogFiles(flag bool)

BackupLogFiles if false, we won't backup log files. This option can be useful for backing up in-memory databases where log file are persisted, but table files are in memory.

Default: true

func (*BackupEngineOptions) Destroy ¶ added in v1.7.0

func (b *BackupEngineOptions) Destroy()

Destroy releases these options.

func (*BackupEngineOptions) DestroyOldData ¶ added in v1.7.0

func (b *BackupEngineOptions) DestroyOldData(flag bool)

DestroyOldData if true, it will delete whatever backups there are already

Default: false

func (*BackupEngineOptions) GetBackupRateLimit ¶ added in v1.7.0

func (b *BackupEngineOptions) GetBackupRateLimit() uint64

GetBackupRateLimit gets max bytes that can be transferred in a second during backup. If 0, go as fast as you can.

func (*BackupEngineOptions) GetCallbackTriggerIntervalSize ¶ added in v1.7.0

func (b *BackupEngineOptions) GetCallbackTriggerIntervalSize() uint64

GetCallbackTriggerIntervalSize gets size (N) during backup user can get callback every time next N bytes being copied.

func (*BackupEngineOptions) GetMaxBackgroundOperations ¶ added in v1.7.0

func (b *BackupEngineOptions) GetMaxBackgroundOperations() int

GetMaxBackgroundOperations gets max number of background threads will copy files for CreateNewBackup() and RestoreDBFromBackup()

func (*BackupEngineOptions) GetMaxValidBackupsToOpen ¶ added in v1.7.0

func (b *BackupEngineOptions) GetMaxValidBackupsToOpen() int

GetMaxValidBackupsToOpen gets max number of valid backup to open.

For BackupEngineReadOnly, Open() will open at most this many of the latest non-corrupted backups.

Note: this setting is ignored (behaves like INT_MAX) for any kind of writable BackupEngine because it would inhibit accounting for shared files for proper backup deletion, including purging any incompletely created backups on creation of a new backup.

func (*BackupEngineOptions) GetRestoreRateLimit ¶ added in v1.7.0

func (b *BackupEngineOptions) GetRestoreRateLimit() uint64

GetRestoreRateLimit gets max bytes that can be transferred in a second during restore. If 0, go as fast as you can

func (*BackupEngineOptions) GetShareFilesWithChecksumNaming ¶ added in v1.7.0

func (b *BackupEngineOptions) GetShareFilesWithChecksumNaming() ShareFilesNaming

GetShareFilesWithChecksumNaming gets naming option for share_files_with_checksum table files. See ShareFilesNaming for details.

func (*BackupEngineOptions) IsBackupLogFiles ¶ added in v1.7.0

func (b *BackupEngineOptions) IsBackupLogFiles() bool

IsBackupLogFiles if false, we won't backup log files. This option can be useful for backing up in-memory databases where log file are persisted, but table files are in memory.

func (*BackupEngineOptions) IsDestroyOldData ¶ added in v1.7.0

func (b *BackupEngineOptions) IsDestroyOldData() bool

IsDestroyOldData indicates if we should delete whatever backups there are already.

func (*BackupEngineOptions) IsShareTableFiles ¶ added in v1.7.0

func (b *BackupEngineOptions) IsShareTableFiles() bool

IsShareTableFiles returns if backup will assume that table files with same name have the same contents. This enables incremental backups and avoids unnecessary data copies.

If false, each backup will be on its own and will not share any data with other backups.

func (*BackupEngineOptions) IsSync ¶ added in v1.7.0

func (b *BackupEngineOptions) IsSync() bool

IsSync if true, we can guarantee you'll get consistent backup even on a machine crash/reboot. Backup process is slower with sync enabled.

If false, we don't guarantee anything on machine reboot. However, chances are some of the backups are consistent.

func (*BackupEngineOptions) SetBackupDir ¶ added in v1.7.0

func (b *BackupEngineOptions) SetBackupDir(dir string)

SetBackupDir sets where to keep the backup files. Has to be different than dbname_ Best to set this to dbname_ + "/backups".

func (*BackupEngineOptions) SetBackupRateLimit ¶ added in v1.7.0

func (b *BackupEngineOptions) SetBackupRateLimit(limit uint64)

SetBackupRateLimit sets max bytes that can be transferred in a second during backup. If 0, go as fast as you can.

Default: 0

func (*BackupEngineOptions) SetCallbackTriggerIntervalSize ¶ added in v1.7.0

func (b *BackupEngineOptions) SetCallbackTriggerIntervalSize(size uint64)

SetCallbackTriggerIntervalSize sets size (N) during backup user can get callback every time next N bytes being copied.

Default: N=4194304

func (*BackupEngineOptions) SetEnv ¶ added in v1.7.0

func (b *BackupEngineOptions) SetEnv(env *Env)

SetEnv to be used for backup file I/O. If it's nullptr, backups will be written out using DBs Env. If it's non-nullptr, backup's I/O will be performed using this object. If you want to have backups on HDFS, use HDFS Env here!

func (*BackupEngineOptions) SetMaxBackgroundOperations ¶ added in v1.7.0

func (b *BackupEngineOptions) SetMaxBackgroundOperations(v int)

SetMaxBackgroundOperations sets max number of background threads will copy files for CreateNewBackup() and RestoreDBFromBackup()

Default: 1

func (*BackupEngineOptions) SetMaxValidBackupsToOpen ¶ added in v1.7.0

func (b *BackupEngineOptions) SetMaxValidBackupsToOpen(val int)

SetMaxValidBackupsToOpen sets max number of valid backup to open.

For BackupEngineReadOnly, Open() will open at most this many of the latest non-corrupted backups.

Note: this setting is ignored (behaves like INT_MAX) for any kind of writable BackupEngine because it would inhibit accounting for shared files for proper backup deletion, including purging any incompletely created backups on creation of a new backup.

Default: INT_MAX

func (*BackupEngineOptions) SetRestoreRateLimit ¶ added in v1.7.0

func (b *BackupEngineOptions) SetRestoreRateLimit(limit uint64)

SetRestoreRateLimit sets max bytes that can be transferred in a second during restore. If 0, go as fast as you can

Default: 0

func (*BackupEngineOptions) SetShareFilesWithChecksumNaming ¶ added in v1.7.0

func (b *BackupEngineOptions) SetShareFilesWithChecksumNaming(val ShareFilesNaming)

SetShareFilesWithChecksumNaming sets naming option for share_files_with_checksum table files. See ShareFilesNaming for details.

Modifying this option cannot introduce a downgrade compatibility issue because RocksDB can read, restore, and delete backups using different file names, and it's OK for a backup directory to use a mixture of table file naming schemes.

However, modifying this option and saving more backups to the same directory can lead to the same file getting saved again to that directory, under the new shared name in addition to the old shared name.

Default: UseDBSessionID | FlagIncludeFileSize | FlagMatchInterimNaming

func (*BackupEngineOptions) SetSync ¶ added in v1.7.0

func (b *BackupEngineOptions) SetSync(flag bool)

SetSync if true, we can guarantee you'll get consistent backup even on a machine crash/reboot. Backup process is slower with sync enabled.

If false, we don't guarantee anything on machine reboot. However, chances are some of the backups are consistent.

Default: true

func (*BackupEngineOptions) ShareTableFiles ¶ added in v1.7.0

func (b *BackupEngineOptions) ShareTableFiles(flag bool)

ShareTableFiles if set to true, backup will assume that table files with same name have the same contents. This enables incremental backups and avoids unnecessary data copies.

If false, each backup will be on its own and will not share any data with other backups.

Default: true

func (*BlockBasedTableOptions) Destroy ¶

func (opts *BlockBasedTableOptions) Destroy()

Destroy deallocates the BlockBasedTableOptions object.

func (*BlockBasedTableOptions) SetBlockCache ¶

func (opts *BlockBasedTableOptions) SetBlockCache(cache *Cache)

SetBlockCache sets the control over blocks (user data is stored in a set of blocks, and a block is the unit of reading from disk).

If set, use the specified cache for blocks. If nil, rocksdb will auoptsmatically create and use an 8MB internal cache. Default: nil

func (*BlockBasedTableOptions) SetBlockRestartInterval ¶

func (opts *BlockBasedTableOptions) SetBlockRestartInterval(blockRestartInterval int)

SetBlockRestartInterval sets the number of keys between restart points for delta encoding of keys. This parameter can be changed dynamically. Most clients should leave this parameter alone. Default: 16

func (*BlockBasedTableOptions) SetBlockSize ¶

func (opts *BlockBasedTableOptions) SetBlockSize(blockSize int)

SetBlockSize sets the approximate size of user data packed per block. Note that the block size specified here corresponds opts uncompressed data. The actual size of the unit read from disk may be smaller if compression is enabled. This parameter can be changed dynamically. Default: 4K

func (*BlockBasedTableOptions) SetBlockSizeDeviation ¶

func (opts *BlockBasedTableOptions) SetBlockSizeDeviation(blockSizeDeviation int)

SetBlockSizeDeviation sets the block size deviation. This is used opts close a block before it reaches the configured 'block_size'. If the percentage of free space in the current block is less than this specified number and adding a new record opts the block will exceed the configured block size, then this block will be closed and the new record will be written opts the next block. Default: 10

func (*BlockBasedTableOptions) SetCacheIndexAndFilterBlocks ¶

func (opts *BlockBasedTableOptions) SetCacheIndexAndFilterBlocks(value bool)

SetCacheIndexAndFilterBlocks is indicating if we'd put index/filter blocks to the block cache. If not specified, each "table reader" object will pre-load index/filter block during table initialization. Default: false

func (*BlockBasedTableOptions) SetCacheIndexAndFilterBlocksWithHighPriority ¶

func (opts *BlockBasedTableOptions) SetCacheIndexAndFilterBlocksWithHighPriority(value bool)

SetCacheIndexAndFilterBlocksWithHighPriority if cache_index_and_filter_blocks is enabled, cache index and filter blocks with high priority. If set to true, depending on implementation of block cache, index and filter blocks may be less likely to be evicted than data blocks.

Default: true.

func (*BlockBasedTableOptions) SetChecksum ¶ added in v1.7.11

func (opts *BlockBasedTableOptions) SetChecksum(csType int8)

SetChecksum sets checksum types.

enum ChecksumType : char {
  kNoChecksum = 0x0,
  kCRC32c = 0x1,
  kxxHash = 0x2,
  kxxHash64 = 0x3,
  kXXH3 = 0x4,  // Supported since RocksDB 6.27
};

func (*BlockBasedTableOptions) SetDataBlockHashRatio ¶ added in v1.6.17

func (opts *BlockBasedTableOptions) SetDataBlockHashRatio(value float64)

SetDataBlockHashRatio is valid only when data_block_hash_index_type is KDataBlockIndexTypeBinarySearchAndHash.

Default value: 0.75

func (*BlockBasedTableOptions) SetDataBlockIndexType ¶ added in v1.6.17

func (opts *BlockBasedTableOptions) SetDataBlockIndexType(value DataBlockIndexType)

SetDataBlockIndexType sets data block index type

func (*BlockBasedTableOptions) SetFilterPolicy ¶

func (opts *BlockBasedTableOptions) SetFilterPolicy(fp *NativeFilterPolicy)

SetFilterPolicy sets the filter policy opts reduce disk reads. Many applications will benefit from passing the result of NewBloomFilterPolicy() here.

Note: this op is `move`, fp is no longer usable.

Default: nil

func (*BlockBasedTableOptions) SetFormatVersion ¶

func (opts *BlockBasedTableOptions) SetFormatVersion(value int)

SetFormatVersion set format version. We currently have five options: 0 -- This version is currently written out by all RocksDB's versions by default. Can be read by really old RocksDB's. Doesn't support changing checksum (default is CRC32). 1 -- Can be read by RocksDB's versions since 3.0. Supports non-default checksum, like xxHash. It is written by RocksDB when BlockBasedTableOptions::checksum is something other than kCRC32c. (version 0 is silently upconverted) 2 -- Can be read by RocksDB's versions since 3.10. Changes the way we encode compressed blocks with LZ4, BZip2 and Zlib compression. If you don't plan to run RocksDB before version 3.10, you should probably use this. 3 -- Can be read by RocksDB's versions since 5.15. Changes the way we encode the keys in index blocks. If you don't plan to run RocksDB before version 5.15, you should probably use this. This option only affects newly written tables. When reading existing tables, the information about version is read from the footer. 4 -- Can be read by RocksDB's versions since 5.16. Changes the way we encode the values in index blocks. If you don't plan to run RocksDB before version 5.16 and you are using index_block_restart_interval > 1, you should probably use this as it would reduce the index size. This option only affects newly written tables. When reading existing tables, the information about version is read from the footer.

func (*BlockBasedTableOptions) SetIndexBlockRestartInterval ¶

func (opts *BlockBasedTableOptions) SetIndexBlockRestartInterval(value int)

SetIndexBlockRestartInterval same as block_restart_interval but used for the index block.

func (*BlockBasedTableOptions) SetIndexType ¶

func (opts *BlockBasedTableOptions) SetIndexType(value IndexType)

SetIndexType sets the index type used for this table. kBinarySearch: A space efficient index block that is optimized for binary-search-based index.

kHashSearch: The hash index, if enabled, will do the hash lookup when `Options.prefix_extractor` is provided.

kTwoLevelIndexSearch: A two-level index implementation. Both levels are binary search indexes. Default: kBinarySearch

func (*BlockBasedTableOptions) SetMetadataBlockSize ¶

func (opts *BlockBasedTableOptions) SetMetadataBlockSize(value uint64)

SetMetadataBlockSize sets block size for partitioned metadata. Currently applied to indexes when kTwoLevelIndexSearch is used and to filters when partition_filters is used. Note: Since in the current implementation the filters and index partitions are aligned, an index/filter block is created when either index or filter block size reaches the specified limit. Note: this limit is currently applied to only index blocks; a filter partition is cut right after an index block is cut.

func (*BlockBasedTableOptions) SetNoBlockCache ¶

func (opts *BlockBasedTableOptions) SetNoBlockCache(value bool)

SetNoBlockCache specify whether block cache should be used or not. Default: false

func (*BlockBasedTableOptions) SetOptimizeFiltersForMemory ¶ added in v1.7.16

func (opts *BlockBasedTableOptions) SetOptimizeFiltersForMemory(value bool)

SetOptimizeFiltersForMemory to generate Bloom/Ribbon filters that minimize memory internal fragmentation.

When false, malloc_usable_size is not available, or format_version < 5, filters are generated without regard to internal fragmentation when loaded into memory (historical behavior). When true (and malloc_usable_size is available and format_version >= 5), then filters are generated to "round up" and "round down" their sizes to minimize internal fragmentation when loaded into memory, assuming the reading DB has the same memory allocation characteristics as the generating DB. This option does not break forward or backward compatibility.

While individual filters will vary in bits/key and false positive rate when setting is true, the implementation attempts to maintain a weighted average FP rate for filters consistent with this option set to false.

With Jemalloc for example, this setting is expected to save about 10% of the memory footprint and block cache charge of filters, while increasing disk usage of filters by about 1-2% due to encoding efficiency losses with variance in bits/key.

NOTE: Because some memory counted by block cache might be unmapped pages within internal fragmentation, this option can increase observed RSS memory usage. With cache_index_and_filter_blocks=true, this option makes the block cache better at using space it is allowed. (These issues should not arise with partitioned filters.)

NOTE: Do not set to true if you do not trust malloc_usable_size. With this option, RocksDB might access an allocated memory object beyond its original size if malloc_usable_size says it is safe to do so. While this can be considered bad practice, it should not produce undefined behavior unless malloc_usable_size is buggy or broken.

Default: false

func (*BlockBasedTableOptions) SetPartitionFilters ¶

func (opts *BlockBasedTableOptions) SetPartitionFilters(value bool)

SetPartitionFilters use partitioned full filters for each SST file. This option is incompatible with block-based filters.

Note: currently this option requires kTwoLevelIndexSearch to be set as well.

func (*BlockBasedTableOptions) SetPinL0FilterAndIndexBlocksInCache ¶

func (opts *BlockBasedTableOptions) SetPinL0FilterAndIndexBlocksInCache(value bool)

SetPinL0FilterAndIndexBlocksInCache sets cache_index_and_filter_blocks. If is true and the below is true (hash_index_allow_collision), then filter and index blocks are stored in the cache, but a reference is held in the "table reader" object so the blocks are pinned and only evicted from cache when the table reader is freed.

func (*BlockBasedTableOptions) SetPinTopLevelIndexAndFilter ¶

func (opts *BlockBasedTableOptions) SetPinTopLevelIndexAndFilter(value bool)

SetPinTopLevelIndexAndFilter if cache_index_and_filter_blocks is true and the below is true, then the top-level index of partitioned filter and index blocks are stored in the cache, but a reference is held in the "table reader" object so the blocks are pinned and only evicted from cache when the table reader is freed. This is not limited to l0 in LSM tree.

Default: true.

func (*BlockBasedTableOptions) SetUseDeltaEncoding ¶

func (opts *BlockBasedTableOptions) SetUseDeltaEncoding(value bool)

SetUseDeltaEncoding uses delta encoding to compress keys in blocks. ReadOptions::pin_data requires this option to be disabled.

Default: true

func (*BlockBasedTableOptions) SetWholeKeyFiltering ¶

func (opts *BlockBasedTableOptions) SetWholeKeyFiltering(value bool)

SetWholeKeyFiltering specify if whole keys in the filter (not just prefixes) should be placed. This must generally be true for gets opts be efficient. Default: true

func (*COWList) Append ¶

func (c *COWList) Append(i interface{}) (index int)

Append appends an item to the COWList and returns the index for that item.

func (*COWList) Get ¶

func (c *COWList) Get(index int) interface{}

Get gets the item at index.

func (*Cache) Destroy ¶

func (c *Cache) Destroy()

Destroy deallocates the Cache object.

func (*Cache) DisownData ¶ added in v1.6.36

func (c *Cache) DisownData()

Disowndata call this on shutdown if you want to speed it up. Cache will disown any underlying data and will not free it on delete. This call will leak memory - call this only if you're shutting down the process. Any attempts of using cache after this call will fail terribly. Always delete the DB object before calling this method!

func (*Cache) GetCapacity ¶ added in v1.6.21

func (c *Cache) GetCapacity() uint64

GetCapacity returns capacity of the cache.

func (*Cache) GetPinnedUsage ¶

func (c *Cache) GetPinnedUsage() uint64

GetPinnedUsage returns the Cache pinned memory usage.

func (*Cache) GetUsage ¶

func (c *Cache) GetUsage() uint64

GetUsage returns the Cache memory usage.

func (*Cache) SetCapacity ¶

func (c *Cache) SetCapacity(value uint64)

SetCapacity sets capacity of the cache.

func (*Checkpoint) CreateCheckpoint ¶

func (checkpoint *Checkpoint) CreateCheckpoint(checkpointDir string, logSizeForFlush uint64) (err error)

CreateCheckpoint builds an openable snapshot of RocksDB on the same disk, which accepts an output directory on the same disk, and under the directory (1) hard-linked SST files pointing to existing live SST files SST files will be copied if output directory is on a different filesystem (2) a copied manifest files and other files The directory should not already exist and will be created by this API. The directory will be an absolute path log_size_for_flush: if the total log file size is equal or larger than this value, then a flush is triggered for all the column families. The default value is 0, which means flush is always triggered. If you move away from the default, the checkpoint may not contain up-to-date data if WAL writing is not always enabled. Flush will always trigger if it is 2PC.

func (*Checkpoint) Destroy ¶

func (checkpoint *Checkpoint) Destroy()

Destroy deallocates the Checkpoint object.

func (*ColumnFamilyHandle) Destroy ¶

func (h *ColumnFamilyHandle) Destroy()

Destroy calls the destructor of the underlying column family handle.

func (*ColumnFamilyHandle) ID ¶ added in v1.7.11

func (h *ColumnFamilyHandle) ID() uint32

ID returned id of Column family.

func (*ColumnFamilyHandle) Name ¶ added in v1.7.11

func (h *ColumnFamilyHandle) Name() string

Name returned name of Column family.

func (*ColumnFamilyMetadata) FileCount ¶ added in v1.7.6

func (cm *ColumnFamilyMetadata) FileCount() int

FileCount returns number of files in this column family.

func (*ColumnFamilyMetadata) LevelMetas ¶ added in v1.7.6

func (cm *ColumnFamilyMetadata) LevelMetas() []LevelMetadata

LevelMetas returns metadata(s) of each level.

func (*ColumnFamilyMetadata) Name ¶ added in v1.7.6

func (cm *ColumnFamilyMetadata) Name() string

Name returns name of this column family.

func (*ColumnFamilyMetadata) Size ¶ added in v1.7.6

func (cm *ColumnFamilyMetadata) Size() uint64

GetSize returns size of this column family in bytes, which is equal to the sum of the file size of its "levels".

func (*CompactRangeOptions) BottommostLevelCompaction ¶ added in v1.6.21

func (opts *CompactRangeOptions) BottommostLevelCompaction() BottommostLevelCompaction

BottommostLevelCompaction returns if bottommost level compaction feature is turned on.

func (*CompactRangeOptions) ChangeLevel ¶ added in v1.6.21

func (opts *CompactRangeOptions) ChangeLevel() bool

ChangeLevel if true, compacted files will be moved to the minimum level capable of holding the data or given level (specified non-negative target_level).

func (*CompactRangeOptions) Destroy ¶

func (opts *CompactRangeOptions) Destroy()

Destroy deallocates the CompactionOptions object.

func (*CompactRangeOptions) GetExclusiveManualCompaction ¶ added in v1.6.21

func (opts *CompactRangeOptions) GetExclusiveManualCompaction() bool

GetExclusiveManualCompaction returns if exclusive manual compaction is turned on.

func (*CompactRangeOptions) SetBottommostLevelCompaction ¶

func (opts *CompactRangeOptions) SetBottommostLevelCompaction(value BottommostLevelCompaction)

SetBottommostLevelCompaction sets bottommost level compaction.

Default: KIfHaveCompactionFilter

func (*CompactRangeOptions) SetChangeLevel ¶

func (opts *CompactRangeOptions) SetChangeLevel(value bool)

SetChangeLevel if true, compacted files will be moved to the minimum level capable of holding the data or given level (specified non-negative target_level).

func (*CompactRangeOptions) SetExclusiveManualCompaction ¶

func (opts *CompactRangeOptions) SetExclusiveManualCompaction(value bool)

SetExclusiveManualCompaction if more than one thread calls manual compaction, only one will actually schedule it while the other threads will simply wait for the scheduled manual compaction to complete. If exclusive_manual_compaction is set to true, the call will disable scheduling of automatic compaction jobs and wait for existing automatic compaction jobs to finish.

Default: true

func (*CompactRangeOptions) SetFullHistoryTsLow ¶ added in v1.7.5

func (opts *CompactRangeOptions) SetFullHistoryTsLow(ts []byte)

SetFullHistoryTsLow user-defined timestamp low bound, the data with older timestamp than low bound maybe GCed by compaction. Default: nullptr

func (*CompactRangeOptions) SetTargetLevel ¶

func (opts *CompactRangeOptions) SetTargetLevel(value int32)

SetTargetLevel if change_level is true and target_level have non-negative value, compacted files will be moved to target_level.

Default: -1 - dynamically

func (*CompactRangeOptions) TargetLevel ¶ added in v1.6.21

func (opts *CompactRangeOptions) TargetLevel() int32

TargetLevel returns target level.

func (*Comparator) Compare ¶

func (c *Comparator) Compare(a, b []byte) int

func (*Comparator) CompareTimestamp ¶ added in v1.7.5

func (c *Comparator) CompareTimestamp(a, b []byte) int

func (*Comparator) CompareWithoutTimestamp ¶ added in v1.7.5

func (c *Comparator) CompareWithoutTimestamp(a []byte, aHasTs bool, b []byte, bHasTs bool) int

func (*Comparator) Destroy ¶

func (c *Comparator) Destroy()

func (*Comparator) Name ¶

func (c *Comparator) Name() string

func (*Comparator) TimestampSize ¶ added in v1.7.5

func (c *Comparator) TimestampSize() uint64

func (*CuckooTableOptions) Destroy ¶

func (opts *CuckooTableOptions) Destroy()

Destroy options.

func (*CuckooTableOptions) SetCuckooBlockSize ¶

func (opts *CuckooTableOptions) SetCuckooBlockSize(value uint32)

SetCuckooBlockSize in case of collision while inserting, the builder attempts to insert in the next cuckoo_block_size locations before skipping over to the next Cuckoo hash function. This makes lookups more cache friendly in case of collisions.

Default: 5.

func (*CuckooTableOptions) SetHashRatio ¶

func (opts *CuckooTableOptions) SetHashRatio(value float64)

SetHashRatio determines the utilization of hash tables. Smaller values result in larger hash tables with fewer collisions.

Default: 0.9.

func (*CuckooTableOptions) SetIdentityAsFirstHash ¶

func (opts *CuckooTableOptions) SetIdentityAsFirstHash(value bool)

SetIdentityAsFirstHash if this option is enabled, user key is treated as uint64_t and its value is used as hash value directly. This option changes builder's behavior. Reader ignore this option and behave according to what specified in table property.

Default: false.

func (*CuckooTableOptions) SetMaxSearchDepth ¶

func (opts *CuckooTableOptions) SetMaxSearchDepth(value uint32)

SetMaxSearchDepth property used by builder to determine the depth to go to to search for a path to displace elements in case of collision. See Builder.MakeSpaceForKey method. Higher values result in more efficient hash tables with fewer lookups but take more time to build.

Default: 100.

func (*CuckooTableOptions) SetUseModuleHash ¶

func (opts *CuckooTableOptions) SetUseModuleHash(value bool)

SetUseModuleHash if this option is set to true, module is used during hash calculation. This often yields better space efficiency at the cost of performance. If this option is set to false, # of entries in table is constrained to be power of two, and bit and is used to calculate hash, which is faster in general.

Default: true

func (*DB) CancelAllBackgroundWork ¶ added in v1.6.20

func (db *DB) CancelAllBackgroundWork(wait bool)

CancelAllBackgroundWork requests stopping background work, if wait is true wait until it's done

func (*DB) Close ¶

func (db *DB) Close()

Close the database.

func (*DB) CompactRange ¶

func (db *DB) CompactRange(r Range)

CompactRange runs a manual compaction on the Range of keys given. This is not likely to be needed for typical usage.

func (*DB) CompactRangeCF ¶

func (db *DB) CompactRangeCF(cf *ColumnFamilyHandle, r Range)

CompactRangeCF runs a manual compaction on the Range of keys given on the given column family. This is not likely to be needed for typical usage.

func (*DB) CompactRangeCFOpt ¶

func (db *DB) CompactRangeCFOpt(cf *ColumnFamilyHandle, r Range, opt *CompactRangeOptions)

CompactRangeCFOpt runs a manual compaction on the Range of keys given on the given column family with provided options. This is not likely to be needed for typical usage.

func (*DB) CompactRangeOpt ¶

func (db *DB) CompactRangeOpt(r Range, opt *CompactRangeOptions)

CompactRangeOpt runs a manual compaction on the Range of keys given with provided options. This is not likely to be needed for typical usage.

func (*DB) CreateColumnFamilies ¶ added in v1.8.4

func (db *DB) CreateColumnFamilies(opts *Options, names []string) (handles []*ColumnFamilyHandle, err error)

CreateColumnFamilies creates new column families.

func (*DB) CreateColumnFamily ¶

func (db *DB) CreateColumnFamily(opts *Options, name string) (handle *ColumnFamilyHandle, err error)

CreateColumnFamily create a new column family.

func (*DB) CreateColumnFamilyWithTTL ¶ added in v1.6.21

func (db *DB) CreateColumnFamilyWithTTL(opts *Options, name string, ttl int) (handle *ColumnFamilyHandle, err error)

CreateColumnFamilyWithTTL create a new column family along with its ttl.

BEHAVIOUR: TTL is accepted in seconds (int32_t)Timestamp(creation) is suffixed to values in Put internally Expired TTL values deleted in compaction only:(Timestamp+ttl<time_now) Get/Iterator may return expired entries(compaction not run on them yet) Different TTL may be used during different Opens Example: Open1 at t=0 with ttl=4 and insert k1,k2, close at t=2 Open2 at t=3 with ttl=5. Now k1,k2 should be deleted at t>=5 read_only=true opens in the usual read-only mode. Compactions will not be triggered(neither manual nor automatic), so no expired entries removed

CONSTRAINTS: Not specifying/passing or non-positive TTL behaves like TTL = infinity

func (*DB) Delete ¶

func (db *DB) Delete(opts *WriteOptions, key []byte) (err error)

Delete removes the data associated with the key from the database.

func (*DB) DeleteCF ¶

func (db *DB) DeleteCF(opts *WriteOptions, cf *ColumnFamilyHandle, key []byte) (err error)

DeleteCF removes the data associated with the key from the database and column family.

func (*DB) DeleteCFWithTS ¶ added in v1.7.5

func (db *DB) DeleteCFWithTS(opts *WriteOptions, cf *ColumnFamilyHandle, key, ts []byte) (err error)

DeleteCFWithTS removes the data associated with the key and timestamp from the database and column family.

func (*DB) DeleteFile ¶

func (db *DB) DeleteFile(name string)

DeleteFile deletes the file name from the db directory and update the internal state to reflect that. Supports deletion of sst and log files only. 'name' must be path relative to the db directory. eg. 000001.sst, /archive/000003.log.

func (*DB) DeleteFileInRange ¶

func (db *DB) DeleteFileInRange(r Range) (err error)

DeleteFileInRange deletes SST files that contain keys between the Range, [r.Start, r.Limit]

func (*DB) DeleteFileInRangeCF ¶

func (db *DB) DeleteFileInRangeCF(cf *ColumnFamilyHandle, r Range) (err error)

DeleteFileInRangeCF deletes SST files that contain keys between the Range, [r.Start, r.Limit], and belong to a given column family

func (*DB) DeleteRangeCF ¶ added in v1.6.17

func (db *DB) DeleteRangeCF(opts *WriteOptions, cf *ColumnFamilyHandle, startKey []byte, endKey []byte) (err error)

DeleteRangeCF deletes keys that are between [startKey, endKey)

func (*DB) DeleteWithTS ¶ added in v1.7.5

func (db *DB) DeleteWithTS(opts *WriteOptions, key, ts []byte) (err error)

DeleteWithTS removes the data associated with the key and timestamp from the database.

func (*DB) DisableFileDeletions ¶

func (db *DB) DisableFileDeletions() (err error)

DisableFileDeletions disables file deletions and should be used when backup the database.

func (*DB) DisableManualCompaction ¶ added in v1.7.5

func (db *DB) DisableManualCompaction()

DisableManualCompaction disables manual compaction.

func (*DB) DropColumnFamily ¶

func (db *DB) DropColumnFamily(c *ColumnFamilyHandle) (err error)

DropColumnFamily drops a column family.

func (*DB) EnableFileDeletions ¶

func (db *DB) EnableFileDeletions(force bool) (err error)

EnableFileDeletions enables file deletions for the database.

func (*DB) EnableManualCompaction ¶ added in v1.7.5

func (db *DB) EnableManualCompaction()

EnableManualCompaction enables manual compaction.

func (*DB) Flush ¶

func (db *DB) Flush(opts *FlushOptions) (err error)

Flush triggers a manual flush for the database.

func (*DB) FlushCF ¶

func (db *DB) FlushCF(cf *ColumnFamilyHandle, opts *FlushOptions) (err error)

FlushCF triggers a manual flush for the database on specific column family.

func (*DB) FlushCFs ¶ added in v1.8.0

func (db *DB) FlushCFs(cfs []*ColumnFamilyHandle, opts *FlushOptions) (err error)

FlushCFs triggers a manual flush for the database on specific column families.

func (*DB) FlushWAL ¶ added in v1.6.37

func (db *DB) FlushWAL(sync bool) (err error)

FlushWAL flushes the WAL memory buffer to the file. If sync is true, it calls SyncWAL afterwards.

func (*DB) Get ¶

func (db *DB) Get(opts *ReadOptions, key []byte) (slice *Slice, err error)

Get returns the data associated with the key from the database.

func (*DB) GetApproximateSizes ¶

func (db *DB) GetApproximateSizes(ranges []Range) ([]uint64, error)

GetApproximateSizes returns the approximate number of bytes of file system space used by one or more key ranges.

The keys counted will begin at Range.Start and end on the key before Range.Limit.

func (*DB) GetApproximateSizesCF ¶

func (db *DB) GetApproximateSizesCF(cf *ColumnFamilyHandle, ranges []Range) ([]uint64, error)

GetApproximateSizesCF returns the approximate number of bytes of file system space used by one or more key ranges in the column family.

The keys counted will begin at Range.Start and end on the key before Range.Limit.

func (*DB) GetBytes ¶

func (db *DB) GetBytes(opts *ReadOptions, key []byte) (data []byte, err error)

GetBytes is like Get but returns a copy of the data.

func (*DB) GetBytesWithTS ¶ added in v1.7.5

func (db *DB) GetBytesWithTS(opts *ReadOptions, key []byte) (data, timestamp []byte, err error)

GetBytesWithTS is like Get but returns a copy of the data and timestamp.

func (*DB) GetCF ¶

func (db *DB) GetCF(opts *ReadOptions, cf *ColumnFamilyHandle, key []byte) (slice *Slice, err error)

GetCF returns the data associated with the key from the database and column family.

func (*DB) GetCFWithTS ¶ added in v1.7.5

func (db *DB) GetCFWithTS(opts *ReadOptions, cf *ColumnFamilyHandle, key []byte) (value, timestamp *Slice, err error)

GetCFWithTS returns the data and timestamp associated with the key from the database and column family.

func (*DB) GetColumnFamilyMetadata ¶ added in v1.7.6

func (db *DB) GetColumnFamilyMetadata() (m *ColumnFamilyMetadata)

GetColumnFamilyMetadata returns the metadata of the default column family.

func (*DB) GetColumnFamilyMetadataCF ¶ added in v1.7.6

func (db *DB) GetColumnFamilyMetadataCF(cf *ColumnFamilyHandle) (m *ColumnFamilyMetadata)

GetColumnFamilyMetadataCF returns the metadata of the specified column family.

func (*DB) GetFullHistoryTsLow ¶ added in v1.7.5

func (db *DB) GetFullHistoryTsLow(handle *ColumnFamilyHandle) (slice *Slice, err error)

GetFullHistoryTsLow returns current full_history_ts value.

func (*DB) GetIntProperty ¶

func (db *DB) GetIntProperty(propName string) (value uint64, success bool)

GetIntProperty similar to `GetProperty`, but only works for a subset of properties whose return value is an integer. Return the value by integer.

func (*DB) GetIntPropertyCF ¶

func (db *DB) GetIntPropertyCF(propName string, cf *ColumnFamilyHandle) (value uint64, success bool)

GetIntPropertyCF similar to `GetProperty`, but only works for a subset of properties whose return value is an integer. Return the value by integer.

func (*DB) GetLatestSequenceNumber ¶

func (db *DB) GetLatestSequenceNumber() uint64

GetLatestSequenceNumber returns sequence number of the most recent transaction.

func (*DB) GetLiveFilesMetaData ¶

func (db *DB) GetLiveFilesMetaData() []LiveFileMetadata

GetLiveFilesMetaData returns a list of all table files with their level, start key and end key.

func (*DB) GetPinned ¶

func (db *DB) GetPinned(opts *ReadOptions, key []byte) (handle *PinnableSliceHandle, err error)

GetPinned returns the data associated with the key from the database.

func (*DB) GetPinnedCF ¶

func (db *DB) GetPinnedCF(opts *ReadOptions, cf *ColumnFamilyHandle, key []byte) (handle *PinnableSliceHandle, err error)

GetPinnedCF returns the data associated with the key from the database, specific column family.

func (*DB) GetProperty ¶

func (db *DB) GetProperty(propName string) (value string)

GetProperty returns the value of a database property.

func (*DB) GetPropertyCF ¶

func (db *DB) GetPropertyCF(propName string, cf *ColumnFamilyHandle) (value string)

GetPropertyCF returns the value of a database property.

func (*DB) GetUpdatesSince ¶

func (db *DB) GetUpdatesSince(seqNumber uint64) (iter *WalIterator, err error)

GetUpdatesSince if the sequence number is non existent, it returns an iterator at the first available seq_no after the requested seq_no.

Must set WAL_ttl_seconds or WAL_size_limit_MB to large values to use this api, else the WAL files will get cleared aggressively and the iterator might keep getting invalid before an update is read.

Note: this API is not yet consistent with WritePrepared transactions. Sets iter to an iterator that is positioned at a write-batch containing seq_number.

func (*DB) GetWithTS ¶ added in v1.7.5

func (db *DB) GetWithTS(opts *ReadOptions, key []byte) (value, timestamp *Slice, err error)

GetWithTS returns the data and timestamp associated with the key from the database.

func (*DB) IncreaseFullHistoryTsLow ¶ added in v1.7.5

func (db *DB) IncreaseFullHistoryTsLow(handle *ColumnFamilyHandle, ts []byte) (err error)

IncreaseFullHistoryTsLow increases the full_history_ts of column family. The new ts_low value should be newer than current full_history_ts value. If another thread updates full_history_ts_low concurrently to a higher timestamp than the requested ts_low, a try again error will be returned.

func (*DB) IngestExternalFile ¶

func (db *DB) IngestExternalFile(filePaths []string, opts *IngestExternalFileOptions) (err error)

IngestExternalFile loads a list of external SST files.

func (*DB) IngestExternalFileCF ¶

func (db *DB) IngestExternalFileCF(handle *ColumnFamilyHandle, filePaths []string, opts *IngestExternalFileOptions) (err error)

IngestExternalFileCF loads a list of external SST files for a column family.

func (*DB) KeyMayExists ¶ added in v1.6.21

func (db *DB) KeyMayExists(opts *ReadOptions, key []byte, timestamp string) (slice *Slice)

KeyMayExists the value is only allocated (using malloc) and returned if it is found and value_found isn't NULL. In that case the user is responsible for freeing it.

func (*DB) KeyMayExistsCF ¶ added in v1.6.21

func (db *DB) KeyMayExistsCF(opts *ReadOptions, cf *ColumnFamilyHandle, key []byte, timestamp string) (slice *Slice)

KeyMayExistsCF the value is only allocated (using malloc) and returned if it is found and value_found isn't NULL. In that case the user is responsible for freeing it.

func (*DB) Merge ¶

func (db *DB) Merge(opts *WriteOptions, key []byte, value []byte) (err error)

Merge merges the data associated with the key with the actual data in the database.

func (*DB) MergeCF ¶

func (db *DB) MergeCF(opts *WriteOptions, cf *ColumnFamilyHandle, key []byte, value []byte) (err error)

MergeCF merges the data associated with the key with the actual data in the database and column family.

func (*DB) MultiGet ¶

func (db *DB) MultiGet(opts *ReadOptions, keys ...[]byte) (Slices, error)

MultiGet returns the data associated with the passed keys from the database

func (*DB) MultiGetCF ¶

func (db *DB) MultiGetCF(opts *ReadOptions, cf *ColumnFamilyHandle, keys ...[]byte) (Slices, error)

MultiGetCF returns the data associated with the passed keys from the column family

func (*DB) MultiGetCFMultiCF ¶

func (db *DB) MultiGetCFMultiCF(opts *ReadOptions, cfs ColumnFamilyHandles, keys [][]byte) (Slices, error)

MultiGetCFMultiCF returns the data associated with the passed keys and column families.

func (*DB) MultiGetCFWithTS ¶ added in v1.7.5

func (db *DB) MultiGetCFWithTS(opts *ReadOptions, cf *ColumnFamilyHandle, keys ...[]byte) (Slices, Slices, error)

MultiGetCFWithTS returns the data and timestamp associated with the passed keys from the column family

func (*DB) MultiGetMultiCFWithTS ¶ added in v1.7.5

func (db *DB) MultiGetMultiCFWithTS(opts *ReadOptions, cfs ColumnFamilyHandles, keys [][]byte) (Slices, Slices, error)

MultiGetMultiCFWithTS returns the data and timestamp associated with the passed keys and column families.

func (*DB) MultiGetWithTS ¶ added in v1.7.5

func (db *DB) MultiGetWithTS(opts *ReadOptions, keys ...[]byte) (Slices, Slices, error)

MultiGetWithTS returns the data and timestamps associated with the passed keys from the database

func (*DB) Name ¶

func (db *DB) Name() string

Name returns the name of the database.

func (*DB) NewCheckpoint ¶

func (db *DB) NewCheckpoint() (cp *Checkpoint, err error)

NewCheckpoint creates a new Checkpoint for this db.

func (*DB) NewIterator ¶

func (db *DB) NewIterator(opts *ReadOptions) *Iterator

NewIterator returns an Iterator over the the database that uses the ReadOptions given.

func (*DB) NewIteratorCF ¶

func (db *DB) NewIteratorCF(opts *ReadOptions, cf *ColumnFamilyHandle) *Iterator

NewIteratorCF returns an Iterator over the the database and column family that uses the ReadOptions given.

func (*DB) NewIterators ¶

func (db *DB) NewIterators(opts *ReadOptions, cfs []*ColumnFamilyHandle) (iters []*Iterator, err error)

NewIterators returns iterators from a consistent database state across multiple column families. Iterators are heap allocated and need to be deleted before the db is deleted

func (*DB) NewSnapshot ¶

func (db *DB) NewSnapshot() *Snapshot

NewSnapshot creates a new snapshot of the database.

func (*DB) Put ¶

func (db *DB) Put(opts *WriteOptions, key, value []byte) (err error)

Put writes data associated with a key to the database.

func (*DB) PutCF ¶

func (db *DB) PutCF(opts *WriteOptions, cf *ColumnFamilyHandle, key, value []byte) (err error)

PutCF writes data associated with a key to the database and column family.

func (*DB) PutCFWithTS ¶ added in v1.7.5

func (db *DB) PutCFWithTS(opts *WriteOptions, cf *ColumnFamilyHandle, key, ts, value []byte) (err error)

PutCFWithTS writes data associated with a key and timestamp to the database and column family.

func (*DB) PutWithTS ¶ added in v1.7.5

func (db *DB) PutWithTS(opts *WriteOptions, key, ts, value []byte) (err error)

PutWithTS writes data associated with a key and timestamp to the database.

func (*DB) ReleaseSnapshot ¶

func (db *DB) ReleaseSnapshot(snapshot *Snapshot)

ReleaseSnapshot releases the snapshot and its resources.

func (*DB) SetOptions ¶

func (db *DB) SetOptions(keys, values []string) (err error)

SetOptions dynamically changes options through the SetOptions API.

func (*DB) SetOptionsCF ¶

func (db *DB) SetOptionsCF(cf *ColumnFamilyHandle, keys, values []string) (err error)

SetOptionsCF dynamically changes options through the SetOptions API for specific Column Family.

func (*DB) SingleDelete ¶ added in v1.7.5

func (db *DB) SingleDelete(opts *WriteOptions, key []byte) (err error)

SingleDelete removes the database entry for "key". Requires that the key exists and was not overwritten. Returns OK on success, and a non-OK status on error. It is not an error if "key" did not exist in the database.

If a key is overwritten (by calling Put() multiple times), then the result of calling SingleDelete() on this key is undefined. SingleDelete() only behaves correctly if there has been only one Put() for this key since the previous call to SingleDelete() for this key.

This feature is currently an experimental performance optimization for a very specific workload. It is up to the caller to ensure that SingleDelete is only used for a key that is not deleted using Delete() or written using Merge(). Mixing SingleDelete operations with Deletes and Merges can result in undefined behavior.

Note: consider setting options.sync = true.

func (*DB) SingleDeleteCF ¶ added in v1.7.5

func (db *DB) SingleDeleteCF(opts *WriteOptions, cf *ColumnFamilyHandle, key []byte) (err error)

SingleDeleteCF removes the database entry for "key". Requires that the key exists and was not overwritten. Returns OK on success, and a non-OK status on error. It is not an error if "key" did not exist in the database.

If a key is overwritten (by calling Put() multiple times), then the result of calling SingleDelete() on this key is undefined. SingleDelete() only behaves correctly if there has been only one Put() for this key since the previous call to SingleDelete() for this key.

This feature is currently an experimental performance optimization for a very specific workload. It is up to the caller to ensure that SingleDelete is only used for a key that is not deleted using Delete() or written using Merge(). Mixing SingleDelete operations with Deletes and Merges can result in undefined behavior.

Note: consider setting options.sync = true.

func (*DB) SingleDeleteCFWithTS ¶ added in v1.7.5

func (db *DB) SingleDeleteCFWithTS(opts *WriteOptions, cf *ColumnFamilyHandle, key, ts []byte) (err error)

SingleDeleteCFWithTS removes the data associated with the key and timestamp from the database and column family.

func (*DB) SingleDeleteWithTS ¶ added in v1.7.5

func (db *DB) SingleDeleteWithTS(opts *WriteOptions, key, ts []byte) (err error)

SingleDeleteWithTS removes the data associated with the key and timestamp from the database.

func (*DB) SuggestCompactRange ¶ added in v1.7.6

func (db *DB) SuggestCompactRange(r Range) (err error)

SuggestCompactRange only for leveled compaction.

func (*DB) SuggestCompactRangeCF ¶ added in v1.7.6

func (db *DB) SuggestCompactRangeCF(cf *ColumnFamilyHandle, r Range) (err error)

SuggestCompactRangeCF only for leveled compaction.

func (*DB) TryCatchUpWithPrimary ¶

func (db *DB) TryCatchUpWithPrimary() (err error)

TryCatchUpWithPrimary to make the secondary instance catch up with primary (WAL tailing is NOT supported now) whenever the user feels necessary. Column families created by the primary after the secondary instance starts are currently ignored by the secondary instance. Column families opened by secondary and dropped by the primary will be dropped by secondary as well. However the user of the secondary instance can still access the data of such dropped column family as long as they do not destroy the corresponding column family handle. WAL tailing is not supported at present, but will arrive soon.

func (*DB) WaitForCompact ¶ added in v1.8.8

func (db *DB) WaitForCompact(opts *WaitForCompactOptions) (err error)

WaitForCompact waits for all flush and compactions jobs to finish. Jobs to wait include the unscheduled (queued, but not scheduled yet). If the db is shutting down, Status::ShutdownInProgress will be returned.

NOTE: This may also never return if there's sufficient ongoing writes that keeps flush and compaction going without stopping. The user would have to cease all the writes to DB to make this eventually return in a stable state. The user may also use timeout option in WaitForCompactOptions to make this stop waiting and return when timeout expires.

func (*DB) Write ¶

func (db *DB) Write(opts *WriteOptions, batch *WriteBatch) (err error)

Write a batch to the database.

func (*DB) WriteWI ¶

func (db *DB) WriteWI(opts *WriteOptions, batch *WriteBatchWI) (err error)

WriteWI writes a batch wi to the database.

func (*DBPath) Destroy ¶

func (dbpath *DBPath) Destroy()

Destroy deallocates the DBPath object.

func (*Env) Destroy ¶

func (env *Env) Destroy()

Destroy deallocates the Env object.

func (*Env) GetBackgroundThreads ¶ added in v1.6.28

func (env *Env) GetBackgroundThreads() int

GetBackgroundThreads sets the number of background worker threads of a specific thread pool for this environment. 'LOW' is the default pool.

func (*Env) GetBottomPriorityBackgroundThreads ¶ added in v1.6.28

func (env *Env) GetBottomPriorityBackgroundThreads() int

GetBottomPriorityBackgroundThreads gets the size of thread pool that can be used to prevent bottommost compactions from stalling memtable flushes.

func (*Env) GetHighPriorityBackgroundThreads ¶ added in v1.6.28

func (env *Env) GetHighPriorityBackgroundThreads() int

GetHighPriorityBackgroundThreads gets the size of the high priority thread pool that can be used to prevent compactions from stalling memtable flushes.

func (*Env) GetLowPriorityBackgroundThreads ¶ added in v1.6.28

func (env *Env) GetLowPriorityBackgroundThreads() int

GetLowPriorityBackgroundThreads gets the size of the low priority thread pool that can be used to prevent compactions from stalling memtable flushes.

func (*Env) JoinAllThreads ¶

func (env *Env) JoinAllThreads()

JoinAllThreads wait for all threads started by StartThread to terminate.

func (*Env) LowerHighPriorityThreadPoolCPUPriority ¶

func (env *Env) LowerHighPriorityThreadPoolCPUPriority()

LowerHighPriorityThreadPoolCPUPriority lower CPU priority for high priority thread pool.

func (*Env) LowerHighPriorityThreadPoolIOPriority ¶

func (env *Env) LowerHighPriorityThreadPoolIOPriority()

LowerHighPriorityThreadPoolIOPriority lower IO priority for high priority thread pool.

func (*Env) LowerThreadPoolCPUPriority ¶

func (env *Env) LowerThreadPoolCPUPriority()

LowerThreadPoolCPUPriority lower CPU priority for threads from the specified pool.

func (*Env) LowerThreadPoolIOPriority ¶

func (env *Env) LowerThreadPoolIOPriority()

LowerThreadPoolIOPriority lower IO priority for threads from the specified pool.

func (*Env) SetBackgroundThreads ¶

func (env *Env) SetBackgroundThreads(n int)

SetBackgroundThreads sets the number of background worker threads of a specific thread pool for this environment. 'LOW' is the default pool.

Default: 1

func (*Env) SetBottomPriorityBackgroundThreads ¶ added in v1.6.21

func (env *Env) SetBottomPriorityBackgroundThreads(n int)

SetBottomPriorityBackgroundThreads sets the size of thread pool that can be used to prevent bottommost compactions from stalling memtable flushes.

func (*Env) SetHighPriorityBackgroundThreads ¶

func (env *Env) SetHighPriorityBackgroundThreads(n int)

SetHighPriorityBackgroundThreads sets the size of the high priority thread pool that can be used to prevent compactions from stalling memtable flushes.

func (*Env) SetLowPriorityBackgroundThreads ¶ added in v1.6.21

func (env *Env) SetLowPriorityBackgroundThreads(n int)

SetLowPriorityBackgroundThreads sets the size of the low priority thread pool that can be used to prevent compactions from stalling memtable flushes.

func (*EnvOptions) Destroy ¶

func (opts *EnvOptions) Destroy()

Destroy deallocates the EnvOptions object.

func (*FIFOCompactionOptions) AllowCompaction ¶ added in v1.8.0

func (opts *FIFOCompactionOptions) AllowCompaction() bool

AllowCompaction checks if compaction is allowed.

func (*FIFOCompactionOptions) Destroy ¶

func (opts *FIFOCompactionOptions) Destroy()

Destroy deallocates the FIFOCompactionOptions object.

func (*FIFOCompactionOptions) GetMaxTableFilesSize ¶ added in v1.6.28

func (opts *FIFOCompactionOptions) GetMaxTableFilesSize() uint64

GetMaxTableFilesSize gets the max table file size. Once the total sum of table files reaches this, we will delete the oldest table file

func (*FIFOCompactionOptions) SetAllowCompaction ¶ added in v1.8.0

func (opts *FIFOCompactionOptions) SetAllowCompaction(allow bool)

SetAllowCompaction allows compaction or not.

func (*FIFOCompactionOptions) SetMaxTableFilesSize ¶

func (opts *FIFOCompactionOptions) SetMaxTableFilesSize(value uint64)

SetMaxTableFilesSize sets the max table file size. Once the total sum of table files reaches this, we will delete the oldest table file

Default: 1GB

func (*FlushOptions) Destroy ¶

func (opts *FlushOptions) Destroy()

Destroy deallocates the FlushOptions object.

func (*FlushOptions) IsWait ¶ added in v1.6.21

func (opts *FlushOptions) IsWait() bool

IsWait returns if the flush will wait until the flush is done.

func (*FlushOptions) SetWait ¶

func (opts *FlushOptions) SetWait(value bool)

SetWait specify if the flush will wait until the flush is done.

Default: true

func (*HyperClockCacheOptions) Destroy ¶ added in v1.8.0

func (h *HyperClockCacheOptions) Destroy()

Destroy the options.

func (*HyperClockCacheOptions) SetCapacity ¶ added in v1.8.0

func (h *HyperClockCacheOptions) SetCapacity(capacity int)

SetCapacity sets the capacity of the cache.

func (*HyperClockCacheOptions) SetEstimatedEntryCharge ¶ added in v1.8.0

func (h *HyperClockCacheOptions) SetEstimatedEntryCharge(v int)

SetEstimatedEntryCharge sets the estimated average `charge` associated with cache entries.

This is a critical configuration parameter for good performance from the hyper cache, because having a table size that is fixed at creation time greatly reduces the required synchronization between threads. * If the estimate is substantially too low (e.g. less than half the true average) then metadata space overhead with be substantially higher (e.g. 200 bytes per entry rather than 100). With kFullChargeCacheMetadata, this can slightly reduce cache hit rates, and slightly reduce access times due to the larger working memory size. * If the estimate is substantially too high (e.g. 25% higher than the true average) then there might not be sufficient slots in the hash table for both efficient operation and capacity utilization (hit rate). The hyper cache will evict entries to prevent load factors that could dramatically affect lookup times, instead letting the hit rate suffer by not utilizing the full capacity.

A reasonable choice is the larger of block_size and metadata_block_size. When WriteBufferManager (and similar) charge memory usage to the block cache, this can lead to the same effect as estimate being too low, which is better than the opposite. Therefore, the general recommendation is to assume that other memory charged to block cache could be negligible, and ignore it in making the estimate.

The best parameter choice based on a cache in use is given by GetUsage() / GetOccupancyCount(), ignoring metadata overheads such as with kDontChargeCacheMetadata. More precisely with kFullChargeCacheMetadata is (GetUsage() - 64 * GetTableAddressCount()) / GetOccupancyCount(). However, when the average value size might vary (e.g. balance between metadata and data blocks in cache), it is better to estimate toward the lower side than the higher side.

func (*HyperClockCacheOptions) SetMemoryAllocator ¶ added in v1.8.0

func (h *HyperClockCacheOptions) SetMemoryAllocator(m *MemoryAllocator)

SetMemoryAllocator for this cache.

func (*HyperClockCacheOptions) SetNumShardBits ¶ added in v1.8.0

func (h *HyperClockCacheOptions) SetNumShardBits(n int)

SetCapacity sets number of shards used for this cache.

func (*IngestExternalFileOptions) Destroy ¶

func (opts *IngestExternalFileOptions) Destroy()

Destroy deallocates the IngestExternalFileOptions object.

func (*IngestExternalFileOptions) SetAllowBlockingFlush ¶

func (opts *IngestExternalFileOptions) SetAllowBlockingFlush(flag bool)

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

func (*IngestExternalFileOptions) SetAllowGlobalSeqNo ¶

func (opts *IngestExternalFileOptions) SetAllowGlobalSeqNo(flag bool)

SetAllowGlobalSeqNo sets allow_global_seqno. If set to false,IngestExternalFile() will fail if the file key range overlaps with existing keys or tombstones in the DB. Default true.

func (*IngestExternalFileOptions) SetFailIfNotBottommostLevel ¶ added in v1.8.0

func (opts *IngestExternalFileOptions) SetFailIfNotBottommostLevel(flag bool)

SetFailIfNotBottommostLevel sets to TRUE if user wants file to be ingested to the bottommost level. An error of Status::TryAgain() will be returned if a file cannot fit in the bottommost level when calling DB::IngestExternalFile()/DB::IngestExternalFiles().

The user should clear the bottommost level in the overlapping range before re-attempt. Ingest_behind takes precedence over fail_if_not_bottommost_level.

func (*IngestExternalFileOptions) SetIngestionBehind ¶

func (opts *IngestExternalFileOptions) SetIngestionBehind(flag bool)

SetIngestionBehind sets ingest_behind Set to true if you would like duplicate keys in the file being ingested to be skipped rather than overwriting existing data under that key. Usecase: back-fill of some historical data in the database without over-writing existing newer version of data. This option could only be used if the DB has been running with allow_ingest_behind=true since the dawn of time. All files will be ingested at the bottommost level with seqno=0.

func (*IngestExternalFileOptions) SetMoveFiles ¶

func (opts *IngestExternalFileOptions) SetMoveFiles(flag bool)

SetMoveFiles specifies if it should move the files instead of copying them. Default to false.

func (*IngestExternalFileOptions) SetSnapshotConsistency ¶

func (opts *IngestExternalFileOptions) SetSnapshotConsistency(flag bool)

SetSnapshotConsistency if specifies the consistency. If set to false, an ingested file key could appear in existing snapshots that were created before the file was ingested. Default to true.

func (*Iterator) Close ¶

func (iter *Iterator) Close()

Close closes the iterator.

func (*Iterator) Err ¶

func (iter *Iterator) Err() (err error)

Err returns nil if no errors happened during iteration, or the actual error otherwise.

func (*Iterator) Key ¶

func (iter *Iterator) Key() *Slice

Key returns the key the iterator currently holds.

func (*Iterator) Next ¶

func (iter *Iterator) Next()

Next moves the iterator to the next sequential key in the database.

func (*Iterator) Prev ¶

func (iter *Iterator) Prev()

Prev moves the iterator to the previous sequential key in the database.

func (*Iterator) Seek ¶

func (iter *Iterator) Seek(key []byte)

Seek moves the iterator to the position greater than or equal to the key.

func (*Iterator) SeekForPrev ¶

func (iter *Iterator) SeekForPrev(key []byte)

SeekForPrev moves the iterator to the last key that less than or equal to the target key, in contrast with Seek.

func (*Iterator) SeekToFirst ¶

func (iter *Iterator) SeekToFirst()

SeekToFirst moves the iterator to the first key in the database.

func (*Iterator) SeekToLast ¶

func (iter *Iterator) SeekToLast()

SeekToLast moves the iterator to the last key in the database.

func (*Iterator) Timestamp ¶ added in v1.7.5

func (iter *Iterator) Timestamp() *Slice

Timestamp returns the timestamp in the database the iterator currently holds.

func (*Iterator) Valid ¶

func (iter *Iterator) Valid() bool

Valid returns false only when an Iterator has iterated past either the first or the last key in the database.

func (*Iterator) ValidForPrefix ¶

func (iter *Iterator) ValidForPrefix(prefix []byte) bool

ValidForPrefix returns false only when an Iterator has iterated past the first or the last key in the database or the specified prefix.

func (*Iterator) Value ¶

func (iter *Iterator) Value() *Slice

Value returns the value in the database the iterator currently holds.

func (*LRUCacheOptions) Destroy ¶ added in v1.6.37

func (l *LRUCacheOptions) Destroy()

Destroy lru cache options.

func (*LRUCacheOptions) SetCapacity ¶ added in v1.6.37

func (l *LRUCacheOptions) SetCapacity(s uint)

SetCapacity sets capacity for this lru cache.

func (*LRUCacheOptions) SetMemoryAllocator ¶ added in v1.6.37

func (l *LRUCacheOptions) SetMemoryAllocator(m *MemoryAllocator)

SetMemoryAllocator for this lru cache.

func (*LRUCacheOptions) SetNumShardBits ¶ added in v1.7.6

func (l *LRUCacheOptions) SetNumShardBits(n int)

SetCapacity sets number of shards used for this lru cache.

func (*LatestOptions) ColumnFamilyNames ¶ added in v1.7.7

func (l *LatestOptions) ColumnFamilyNames() []string

ColumnFamilyNames gets column family names.

func (*LatestOptions) ColumnFamilyOpts ¶ added in v1.7.7

func (l *LatestOptions) ColumnFamilyOpts() []Options

ColumnFamilyOpts returns corresponding options of column families.

func (*LatestOptions) Destroy ¶ added in v1.7.6

func (l *LatestOptions) Destroy()

Destroy release underlying db_options, column_family_names, and column_family_options.

func (*LatestOptions) Options ¶ added in v1.7.16

func (l *LatestOptions) Options() *Options

Options gets the latest options.

func (*LevelMetadata) Level ¶ added in v1.7.6

func (l *LevelMetadata) Level() int

Level returns level value.

func (*LevelMetadata) Size ¶ added in v1.7.6

func (l *LevelMetadata) Size() uint64

Size returns the sum of the file size in this level.

func (*LevelMetadata) SstMetas ¶ added in v1.7.6

func (l *LevelMetadata) SstMetas() []SstMetadata

SstMetas returns metadata(s) of sst-file(s) in this level.

func (*MemoryAllocator) Destroy ¶ added in v1.6.37

func (m *MemoryAllocator) Destroy()

Destroy this mem allocator.

func (*NativeFilterPolicy) Destroy ¶ added in v1.7.0

func (fp *NativeFilterPolicy) Destroy()

func (*OptimisticTransactionDB) Close ¶

func (db *OptimisticTransactionDB) Close()

Close closes the database.

func (*OptimisticTransactionDB) CloseBaseDB ¶

func (db *OptimisticTransactionDB) CloseBaseDB(base *DB)

CloseBaseDB closes base-database.

func (*OptimisticTransactionDB) GetBaseDB ¶

func (db *OptimisticTransactionDB) GetBaseDB() *DB

GetBaseDB returns base-database.

func (*OptimisticTransactionDB) NewCheckpoint ¶ added in v1.6.42

func (db *OptimisticTransactionDB) NewCheckpoint() (cp *Checkpoint, err error)

NewCheckpoint creates a new Checkpoint for this db.

func (*OptimisticTransactionDB) TransactionBegin ¶

func (db *OptimisticTransactionDB) TransactionBegin(
	opts *WriteOptions,
	transactionOpts *OptimisticTransactionOptions,
	oldTransaction *Transaction,
) *Transaction

TransactionBegin begins a new transaction with the WriteOptions and TransactionOptions given.

func (*OptimisticTransactionDB) Write ¶ added in v1.6.40

func (db *OptimisticTransactionDB) Write(opts *WriteOptions, batch *WriteBatch) (err error)

Write batch.

func (*OptimisticTransactionOptions) Destroy ¶

func (opts *OptimisticTransactionOptions) Destroy()

Destroy deallocates the TransactionOptions object.

func (*OptimisticTransactionOptions) SetSetSnapshot ¶

func (opts *OptimisticTransactionOptions) SetSetSnapshot(value bool)

SetSetSnapshot to true is the same as calling Transaction::SetSnapshot().

func (*Options) AddCompactOnDeletionCollectorFactory ¶ added in v1.6.37

func (opts *Options) AddCompactOnDeletionCollectorFactory(windowSize, numDelsTrigger uint)

AddCompactOnDeletionCollectorFactory marks a SST file as need-compaction when it observe at least "D" deletion entries in any "N" consecutive entries or the ratio of tombstone entries in the whole file >= the specified deletion ratio.

func (*Options) AddCompactOnDeletionCollectorFactoryWithRatio ¶ added in v1.8.3

func (opts *Options) AddCompactOnDeletionCollectorFactoryWithRatio(windowSize, numDelsTrigger uint, deletionRatio float64)

AddCompactOnDeletionCollectorFactoryWithRatio similar to AddCompactOnDeletionCollectorFactory with specific deletion ratio.

func (*Options) AdviseRandomOnOpen ¶ added in v1.6.21

func (opts *Options) AdviseRandomOnOpen() bool

AdviseRandomOnOpen returns whether we will hint the underlying file system that the file access pattern is random, when a sst file is opened.

func (*Options) AllowConcurrentMemtableWrites ¶ added in v1.6.21

func (opts *Options) AllowConcurrentMemtableWrites() bool

AllowConcurrentMemtableWrites whether to allow concurrent memtable writes. Conccurent writes are not supported by all memtable factories (currently only SkipList memtables). As of rocksdb 5.0.2 you must call `SetAllowConcurrentMemtableWrites(false)` if you use `OptimizeForPointLookup`.

func (*Options) AllowIngestBehind ¶ added in v1.6.20

func (opts *Options) AllowIngestBehind() bool

AllowIngestBehind checks if allow_ingest_behind is set

func (*Options) AllowMmapReads ¶ added in v1.6.21

func (opts *Options) AllowMmapReads() bool

AllowMmapReads returns setting for enable/disable mmap reads for sst tables.

func (*Options) AllowMmapWrites ¶ added in v1.6.21

func (opts *Options) AllowMmapWrites() bool

AllowMmapWrites returns setting for enable/disable mmap writes for sst tables.

func (*Options) AvoidUnnecessaryBlockingIO ¶ added in v1.7.13

func (opts *Options) AvoidUnnecessaryBlockingIO(v bool)

AvoidUnnecessaryBlockingIO if true, working thread may avoid doing unnecessary and long-latency operation (such as deleting obsolete files directly or deleting memtable) and will instead schedule a background job to do it. Use it if you're latency-sensitive.

If set to true, takes precedence over ReadOptions::background_purge_on_iterator_cleanup.

func (*Options) Clone ¶ added in v1.6.20

func (opts *Options) Clone() *Options

Clone the options

func (*Options) CompactionReadaheadSize ¶

func (opts *Options) CompactionReadaheadSize(value uint64)

CompactionReadaheadSize if non-zero, we perform bigger reads when doing compaction. If you're running RocksDB on spinning disks, you should set this to at least 2MB. That way RocksDB's compaction is doing sequential instead of random reads.

When non-zero, we also force new_table_reader_for_compaction_inputs to true.

Default: 0

Dynamically changeable through SetDBOptions() API.

func (*Options) CreateIfMissing ¶ added in v1.6.20

func (opts *Options) CreateIfMissing() bool

CreateIfMissing checks if create_if_mission option is set

func (*Options) CreateIfMissingColumnFamilies ¶ added in v1.6.20

func (opts *Options) CreateIfMissingColumnFamilies() bool

CreateIfMissingColumnFamilies checks if create_if_missing_cf option is set

func (*Options) Destroy ¶

func (opts *Options) Destroy()

Destroy deallocates the Options object.

func (*Options) DisabledAutoCompactions ¶ added in v1.6.21

func (opts *Options) DisabledAutoCompactions() bool

DisabledAutoCompactions returns if automatic compactions is disabled.

func (*Options) EnableBlobFiles ¶ added in v1.6.36

func (opts *Options) EnableBlobFiles(value bool)

EnableBlobFiles when set, large values (blobs) are written to separate blob files, and only pointers to them are stored in SST files. This can reduce write amplification for large-value use cases at the cost of introducing a level of indirection for reads. See also the options min_blob_size, blob_file_size, blob_compression_type, enable_blob_garbage_collection, and blob_garbage_collection_age_cutoff below.

Default: false

Dynamically changeable through the API.

func (*Options) EnableBlobGC ¶ added in v1.6.36

func (opts *Options) EnableBlobGC(value bool)

EnableBlobGC toggles garbage collection of blobs. Blob GC is performed as part of compaction. Valid blobs residing in blob files older than a cutoff get relocated to new files as they are encountered during compaction, which makes it possible to clean up blob files once they contain nothing but obsolete/garbage blobs. See also blob_garbage_collection_age_cutoff below.

Default: false

Dynamically changeable through the API.

func (*Options) EnableStatistics ¶

func (opts *Options) EnableStatistics()

EnableStatistics enable statistics.

func (*Options) EnabledPipelinedWrite ¶ added in v1.6.20

func (opts *Options) EnabledPipelinedWrite() bool

EnabledPipelinedWrite check if enable_pipelined_write is turned on.

func (*Options) EnabledWriteThreadAdaptiveYield ¶ added in v1.6.21

func (opts *Options) EnabledWriteThreadAdaptiveYield() bool

EnabledWriteThreadAdaptiveYield if true, threads synchronizing with the write batch group leader will wait for up to write_thread_max_yield_usec before blocking on a mutex. This can substantially improve throughput for concurrent workloads, regardless of whether allow_concurrent_memtable_write is enabled.

func (*Options) ErrorIfExists ¶ added in v1.6.20

func (opts *Options) ErrorIfExists() bool

ErrorIfExists checks if error_if_exist option is set

func (*Options) GetAccessHintOnCompactionStart ¶ added in v1.6.21

func (opts *Options) GetAccessHintOnCompactionStart() CompactionAccessPattern

GetAccessHintOnCompactionStart returns the file access pattern once a compaction is started.

func (*Options) GetArenaBlockSize ¶ added in v1.6.21

func (opts *Options) GetArenaBlockSize() uint64

GetArenaBlockSize returns the size of one block in arena memory allocation.

func (*Options) GetAvoidUnnecessaryBlockingIOFlag ¶ added in v1.7.13

func (opts *Options) GetAvoidUnnecessaryBlockingIOFlag() bool

GetAvoidUnnecessaryBlockingIOFlag returns value of avoid unnecessary blocking io flag.

func (*Options) GetBlobCompactionReadaheadSize ¶ added in v1.6.44

func (opts *Options) GetBlobCompactionReadaheadSize() uint64

GetBlobCompactionReadaheadSize returns compaction readahead size for blob files.

func (*Options) GetBlobCompressionType ¶ added in v1.6.36

func (opts *Options) GetBlobCompressionType() CompressionType

GetBlobCompressionType gets the compression algorithm to use for large values stored in blob files. Note that enable_blob_files has to be set in order for this option to have any effect.

func (*Options) GetBlobFileSize ¶ added in v1.6.36

func (opts *Options) GetBlobFileSize() uint64

GetBlobFileSize gets the size limit for blob files.

func (*Options) GetBlobFileStartingLevel ¶ added in v1.7.5

func (opts *Options) GetBlobFileStartingLevel() int

GetBlobFileStartingLevel returns blob starting level.

func (*Options) GetBlobGCAgeCutoff ¶ added in v1.6.36

func (opts *Options) GetBlobGCAgeCutoff() float64

GetBlobGCAgeCutoff returns the cutoff in terms of blob file age for garbage collection.

func (*Options) GetBlobGCForceThreshold ¶ added in v1.6.43

func (opts *Options) GetBlobGCForceThreshold() float64

GetBlobGCForceThreshold get the threshold for ratio of garbage in the oldest blob files. See also: `SetBlobGCForceThreshold`

Default: 1.0

func (*Options) GetBloomLocality ¶ added in v1.6.21

func (opts *Options) GetBloomLocality() uint32

GetBloomLocality returns control locality of bloom filter probes to improve cache miss rate. This option only applies to memtable prefix bloom and plaintable prefix bloom. It essentially limits the max number of cache lines each bloom filter check can touch. This optimization is turned off when set to 0. The number should never be greater than number of probes. This option can boost performance for in-memory workload but should use with care since it can cause higher false positive rate.

func (*Options) GetBottommostCompression ¶ added in v1.6.21

func (opts *Options) GetBottommostCompression() CompressionType

GetBottommostCompression returns the compression algorithm for bottommost level.

func (*Options) GetBottommostCompressionOptionsZstdDictTrainer ¶ added in v1.7.12

func (opts *Options) GetBottommostCompressionOptionsZstdDictTrainer() bool

GetBottommostCompressionOptionsZstdDictTrainer returns if zstd dict trainer is used or not.

func (*Options) GetBytesPerSync ¶ added in v1.6.21

func (opts *Options) GetBytesPerSync() uint64

GetBytesPerSync return setting for bytes (size) per sync.

func (*Options) GetCompactionReadaheadSize ¶ added in v1.6.20

func (opts *Options) GetCompactionReadaheadSize() uint64

GetCompactionReadaheadSize gets readahead size

func (*Options) GetCompactionStyle ¶ added in v1.6.21

func (opts *Options) GetCompactionStyle() CompactionStyle

GetCompactionStyle returns compaction style.

func (*Options) GetCompression ¶ added in v1.6.21

func (opts *Options) GetCompression() CompressionType

GetCompression returns the compression algorithm.

func (*Options) GetCompressionOptionsMaxDictBufferBytes ¶ added in v1.6.37

func (opts *Options) GetCompressionOptionsMaxDictBufferBytes() uint64

GetCompressionOptionsMaxDictBufferBytes returns the limit on data buffering when gathering samples to build a dictionary. Zero means no limit. When dictionary is disabled (`max_dict_bytes == 0`), enabling this limit (`max_dict_buffer_bytes != 0`) has no effect.

func (*Options) GetCompressionOptionsParallelThreads ¶ added in v1.6.37

func (opts *Options) GetCompressionOptionsParallelThreads() int

GetCompressionOptionsParallelThreads returns number of threads for parallel compression. Parallel compression is enabled only if threads > 1.

This option is valid only when BlockBasedTable is used. Default: 1.

Note: THE FEATURE IS STILL EXPERIMENTAL

func (*Options) GetCompressionOptionsZstdDictTrainer ¶ added in v1.7.4

func (opts *Options) GetCompressionOptionsZstdDictTrainer() bool

GetCompressionOptionsZstdDictTrainer returns if zstd dict trainer is used or not.

func (*Options) GetCompressionOptionsZstdMaxTrainBytes ¶ added in v1.6.37

func (opts *Options) GetCompressionOptionsZstdMaxTrainBytes() int

GetCompressionOptionsZstdMaxTrainBytes gets maximum size of training data passed to zstd's dictionary trainer. Using zstd's dictionary trainer can achieve even better compression ratio improvements than using `max_dict_bytes` alone.

func (*Options) GetDbWriteBufferSize ¶ added in v1.6.20

func (opts *Options) GetDbWriteBufferSize() uint64

GetDbWriteBufferSize gets db_write_buffer_size which is set in options

func (*Options) GetDeleteObsoleteFilesPeriodMicros ¶ added in v1.6.21

func (opts *Options) GetDeleteObsoleteFilesPeriodMicros() uint64

GetDeleteObsoleteFilesPeriodMicros returns the periodicity when obsolete files get deleted.

func (*Options) GetHardPendingCompactionBytesLimit ¶ added in v1.6.21

func (opts *Options) GetHardPendingCompactionBytesLimit() uint64

GetHardPendingCompactionBytesLimit returns the threshold at which all writes will be slowed down to at least delayed_write_rate if estimated bytes needed to be compaction exceed this threshold.

func (*Options) GetHistogramData ¶ added in v1.8.7

func (opts *Options) GetHistogramData(histogramType HistogramType) (histogram HistogramData)

func (*Options) GetInfoLogLevel ¶ added in v1.6.20

func (opts *Options) GetInfoLogLevel() InfoLogLevel

GetInfoLogLevel gets the info log level which options hold

func (*Options) GetInplaceUpdateNumLocks ¶ added in v1.6.21

func (opts *Options) GetInplaceUpdateNumLocks() uint

GetInplaceUpdateNumLocks returns number of locks used for inplace upddate.

func (*Options) GetKeepLogFileNum ¶ added in v1.6.21

func (opts *Options) GetKeepLogFileNum() uint

GetKeepLogFileNum return setting for maximum info log files to be kept.

func (*Options) GetLevel0FileNumCompactionTrigger ¶ added in v1.6.20

func (opts *Options) GetLevel0FileNumCompactionTrigger() int

GetLevel0FileNumCompactionTrigger gets the number of files to trigger level-0 compaction.

func (*Options) GetLevel0SlowdownWritesTrigger ¶ added in v1.6.20

func (opts *Options) GetLevel0SlowdownWritesTrigger() int

GetLevel0SlowdownWritesTrigger gets the soft limit on number of level-0 files. We start slowing down writes at this point.

func (*Options) GetLevel0StopWritesTrigger ¶ added in v1.6.20

func (opts *Options) GetLevel0StopWritesTrigger() int

GetLevel0StopWritesTrigger gets the maximum number of level-0 files. We stop writes at this point.

func (*Options) GetLevelCompactionDynamicLevelBytes ¶ added in v1.6.20

func (opts *Options) GetLevelCompactionDynamicLevelBytes() bool

GetLevelCompactionDynamicLevelBytes checks if level_compaction_dynamic_level_bytes option is set.

func (*Options) GetLogFileTimeToRoll ¶ added in v1.6.21

func (opts *Options) GetLogFileTimeToRoll() uint64

GetLogFileTimeToRoll returns the time for info log file to roll (in seconds).

func (*Options) GetManifestPreallocationSize ¶ added in v1.6.21

func (opts *Options) GetManifestPreallocationSize() uint64

GetManifestPreallocationSize returns the number of bytes to preallocate (via fallocate) the manifest files.

func (*Options) GetMaxBackgroundCompactions ¶ added in v1.6.21

func (opts *Options) GetMaxBackgroundCompactions() int

GetMaxBackgroundCompactions returns maximum number of concurrent background compaction jobs setting.

func (*Options) GetMaxBackgroundFlushes ¶ added in v1.6.21

func (opts *Options) GetMaxBackgroundFlushes() int

GetMaxBackgroundFlushes returns the maximum number of concurrent background memtable flush jobs setting.

func (*Options) GetMaxBackgroundJobs ¶ added in v1.6.21

func (opts *Options) GetMaxBackgroundJobs() int

GetMaxBackgroundJobs returns maximum number of concurrent background jobs setting.

func (*Options) GetMaxBytesForLevelBase ¶ added in v1.6.20

func (opts *Options) GetMaxBytesForLevelBase() uint64

GetMaxBytesForLevelBase gets the maximum total data size for a level.

func (*Options) GetMaxBytesForLevelMultiplier ¶ added in v1.6.20

func (opts *Options) GetMaxBytesForLevelMultiplier() float64

GetMaxBytesForLevelMultiplier gets the max bytes for level multiplier.

func (*Options) GetMaxCompactionBytes ¶ added in v1.6.21

func (opts *Options) GetMaxCompactionBytes() uint64

GetMaxCompactionBytes returns the maximum number of bytes in all compacted files. We try to limit number of bytes in one compaction to be lower than this threshold. But it's not guaranteed.

func (*Options) GetMaxFileOpeningThreads ¶ added in v1.6.20

func (opts *Options) GetMaxFileOpeningThreads() int

GetMaxFileOpeningThreads gets the maximum number of file opening threads.

func (*Options) GetMaxLogFileSize ¶ added in v1.6.21

func (opts *Options) GetMaxLogFileSize() uint64

GetMaxLogFileSize returns setting for maximum size of the info log file.

func (*Options) GetMaxManifestFileSize ¶ added in v1.6.21

func (opts *Options) GetMaxManifestFileSize() uint64

GetMaxManifestFileSize returns the maximum manifest file size until is rolled over. The older manifest file be deleted.

func (*Options) GetMaxOpenFiles ¶ added in v1.6.20

func (opts *Options) GetMaxOpenFiles() int

GetMaxOpenFiles gets the number of open files that can be used by the DB.

func (*Options) GetMaxSequentialSkipInIterations ¶ added in v1.6.21

func (opts *Options) GetMaxSequentialSkipInIterations() uint64

GetMaxSequentialSkipInIterations returns the number of keys (with the same userkey) that will be sequentially skipped before a reseek is issued.

func (*Options) GetMaxSubcompactions ¶ added in v1.6.20

func (opts *Options) GetMaxSubcompactions() uint32

GetMaxSubcompactions gets the maximum number of threads that will concurrently perform a compaction job by breaking it into multiple, smaller ones that are run simultaneously.

func (*Options) GetMaxSuccessiveMerges ¶ added in v1.6.21

func (opts *Options) GetMaxSuccessiveMerges() uint

GetMaxSuccessiveMerges returns the maximum number of successive merge operations on a key in the memtable.

When a merge operation is added to the memtable and the maximum number of successive merges is reached, the value of the key will be calculated and inserted into the memtable instead of the merge operation. This will ensure that there are never more than max_successive_merges merge operations in the memtable.

func (*Options) GetMaxTotalWalSize ¶ added in v1.6.20

func (opts *Options) GetMaxTotalWalSize() uint64

GetMaxTotalWalSize gets the maximum total wal size (in bytes).

func (*Options) GetMaxWriteBufferNumber ¶ added in v1.6.20

func (opts *Options) GetMaxWriteBufferNumber() int

GetMaxWriteBufferNumber gets the maximum number of write buffers that are built up in memory.

func (*Options) GetMaxWriteBufferSizeToMaintain ¶ added in v1.6.20

func (opts *Options) GetMaxWriteBufferSizeToMaintain() int64

GetMaxWriteBufferSizeToMaintain gets the total maximum size(bytes) of write buffers to maintain in memory including copies of buffers that have already been flushed. This parameter only affects trimming of flushed buffers and does not affect flushing. This controls the maximum amount of write history that will be available in memory for conflict checking when Transactions are used. The actual size of write history (flushed Memtables) might be higher than this limit if further trimming will reduce write history total size below this limit. For example, if max_write_buffer_size_to_maintain is set to 64MB, and there are three flushed Memtables, with sizes of 32MB, 20MB, 20MB. Because trimming the next Memtable of size 20MB will reduce total memory usage to 52MB which is below the limit, RocksDB will stop trimming.

func (*Options) GetMemTablePrefixBloomSizeRatio ¶ added in v1.6.21

func (opts *Options) GetMemTablePrefixBloomSizeRatio() float64

GetMemTablePrefixBloomSizeRatio returns memtable_prefix_bloom_size_ratio.

func (*Options) GetMempurgeThreshold ¶ added in v1.7.6

func (opts *Options) GetMempurgeThreshold() float64

GetMempurgeThreshold gets current mempurge threshold value.

func (*Options) GetMemtableHugePageSize ¶ added in v1.6.21

func (opts *Options) GetMemtableHugePageSize() uint64

GetMemtableHugePageSize returns the page size for huge page for arena used by the memtable.

func (*Options) GetMinBlobSize ¶ added in v1.6.36

func (opts *Options) GetMinBlobSize() uint64

GetMinBlobSize returns the size of the smallest value to be stored separately in a blob file.

func (*Options) GetMinWriteBufferNumberToMerge ¶ added in v1.6.20

func (opts *Options) GetMinWriteBufferNumberToMerge() int

GetMinWriteBufferNumberToMerge gets the minimum number of write buffers that will be merged together before writing to storage.

func (*Options) GetNumLevels ¶ added in v1.6.20

func (opts *Options) GetNumLevels() int

GetNumLevels gets the number of levels.

func (*Options) GetPeriodicCompactionSeconds ¶ added in v1.8.11

func (opts *Options) GetPeriodicCompactionSeconds() uint64

GetPeriodicCompactionSeconds gets periodic periodic_compaction_seconds option.

func (*Options) GetPrepopulateBlobCache ¶ added in v1.7.10

func (opts *Options) GetPrepopulateBlobCache() PrepopulateBlob

GetPrepopulateBlobCache gets prepopulate blob caching strategy

func (*Options) GetRecycleLogFileNum ¶ added in v1.6.21

func (opts *Options) GetRecycleLogFileNum() uint

GetRecycleLogFileNum returns setting for number of recycling log files.

func (*Options) GetSoftPendingCompactionBytesLimit ¶ added in v1.6.21