Changelog

Version 0.8

Yet Another Fork, started by Martina Ferrari, collecting loose commits from the many forks of the original project. Summary of commits:

  • Alexander Böhn

    • Allow rocksdb.DB instances to be manually closed.

  • @iFA88

    • Many tidying changes.

    • Added support for many parameters in different interfaces.

    • Create statistics.pxd

    • Fixing closing

  • Andrey Martyanov

    • Build wheel packages

    • Update README with simplified installation procedure

  • Martina Ferrari

    • Fix a few typos.

    • Add as_dict option to multi_get.

    • Update README, set myself as current author/maintainer, and move most of setup.py to the configuration file.

Version 0.7

Version released by Ming-Hsuan-Tu; summary of commits:

  • Ming-Hsuan-Tu

    • remove full_scan_mode

    • change default compaction_pri

  • meridianz

    • Docs: fix typo in installation command line

  • Roman Zeyde

    • Remove fetch=False unsupported keyword from db.iter{items,keys,values} documentation

  • Abhiram R

    • Modified docs to export CPLUS_INCLUDE_PATH, LD_LIBRARY_PATH and LIBRARY_PATH correctly even if they weren’t originally assigned

    • Added liblz4-dev as a package to be installed

  • Jason Fried

    • Column Family Support. Add support for Column Families in a runtime safe way. Add unittests to test functionality Insure all unittests are passing. Cleaned up unittests to not use a fixed directory in tmp, but use tempfile

Version 0.6

Version released by Ming-Hsuan-Tu; summary of commits:

  • Ming-Hsuan-Tu

    • now support rocksdb 5.3.0

    • Merge options source_compaction_factor, max_grandparent_overlap_bytes and expanded_compaction_factor into max_compaction_bytes

    • add default merge operator

    • add compaction_pri

    • add seekForPrev

    • update the usage of default operators

    • fix memtable_factory crash

    • add testcase for memtable

  • George Mossessian

    • allow snappy_compression as a default option in test_options.py::TestOptions::test_simple

  • RIMPY BHAROT

    • Update installation.rst. Missing steps need to be added for clean installation.

  • Chris Hager

    • OSX support for ‘pip install’

  • Mehdi Abaakouk

    • Allow to compile the extension everywhere.

Version 0.5

Last version released by Stephan Hofmockel; summary of commits:

  • Remove prints from the tests.

  • Use another compiler flag wich works for clang and gcc.

  • Wrap the RepairDB function.

  • Get rid of this extension_defaults variable.

  • Only cythonize if Cython is installed.

  • Add the .hpp .pxd .pyx files for the sdist.

  • Rename README.md to README.rst so setup.py can pick it up.

  • Update the installation page by mentioning a “system wide” rocksdb installation.

  • Improve the README.rst by adding a quick install/using guide.

  • Don’t set a theme explicitly. Let readthedocs decide itself.

  • Change API of compact_range to be compatible with the change of rocksdb.

  • No need for the get_ob methods on PyCache.

  • Add row_cache to options.

  • Document the new row_cache option.

  • Update the versions (python, rocksdb) pyrocksdb 0.4 was tested with.

  • Mention in the changelog that this version is avaialable on pypi.

Version 0.4

This version works with RocksDB v3.12.

Backward Incompatible Changes:

  • Changed API of rocksdb.DB.compact_range().

    • Only allow keyword arguments.

    • Changed reduce_level to change_level.

    • Add new argument called bottommost_level_compaction.

Version 0.3

This version works with RocksDB version v3.11.

Backward Incompatible Changes:

Prefix Seeks:

According to this page https://github.com/facebook/rocksdb/wiki/Prefix-Seek-API-Changes, all the prefix related parameters on ReadOptions are removed. Rocksdb realizes now if Options.prefix_extractor is set and uses then prefix-seeks automatically. This means the following changes on pyrocksdb.

  • DB.iterkeys, DB.itervalues, DB.iteritems have no prefix parameter anymore.

  • DB.get, DB.multi_get, DB.key_may_exist, DB.iterkeys, DB.itervalues, DB.iteritems have no prefix_seek parameter anymore.

Which means all the iterators walk now always to the end of the database. So if you need to stay within a prefix, write your own code to ensure that. For DB.iterkeys and DB.iteritems itertools.takewhile is a possible solution.

from itertools import takewhile

it = self.db.iterkeys()
it.seek(b'00002')
print list(takewhile(lambda key: key.startswith(b'00002'), it))

it = self.db.iteritems()
it.seek(b'00002')
print dict(takewhile(lambda item: item[0].startswith(b'00002'), it))

SST Table Builders:

  • Removed NewTotalOrderPlainTableFactory, because rocksdb drops it too.

Changed Options:

In newer versions of rocksdb a bunch of options were moved or removed.

  • Rename bloom_bits_per_prefix of rocksdb.PlainTableFactory to bloom_bits_per_key

  • Removed Options.db_stats_log_interval.

  • Removed Options.disable_seek_compaction

  • Moved Options.no_block_cache to BlockBasedTableFactory

  • Moved Options.block_size to BlockBasedTableFactory

  • Moved Options.block_size_deviation to BlockBasedTableFactory

  • Moved Options.block_restart_interval to BlockBasedTableFactory

  • Moved Options.whole_key_filtering to BlockBasedTableFactory

  • Removed Options.table_cache_remove_scan_count_limit

  • Removed rm_scan_count_limit from LRUCache

New:

Version 0.2

This version works with RocksDB version 2.8.fb. Now you have access to the more advanced options of rocksdb. Like changing the memtable or SST representation. It is also possible now to enable Universal Style Compaction.

  • Fixed issue 3. Which fixed the change of prefix_extractor from raw-pointer to smart-pointer.

  • Support the new rocksdb.Options.verify_checksums_in_compaction option.

  • Add rocksdb.Options.table_factory option. So you could use the new ‘PlainTableFactories’ which are optimized for in-memory-databases.

  • Add rocksdb.Options.memtable_factory option.

  • Add options rocksdb.Options.compaction_style and rocksdb.Options.compaction_options_universal to change the compaction style.

  • Update documentation to the new default values

    • allow_mmap_reads=true

    • allow_mmap_writes=false

    • max_background_flushes=1

    • max_open_files=5000

    • paranoid_checks=true

    • disable_seek_compaction=true

    • level0_stop_writes_trigger=24

    • level0_slowdown_writes_trigger=20

  • Document new property names for rocksdb.DB.get_property().

Version 0.1

Initial version. Works with rocksdb version 2.7.fb.