lbry-rocksdb/README.rst

Note
=========
The original pyrocksdb (https://pypi.python.org/pypi/pyrocksdb/0.4) has not been updated for long time. I update pyrocksdb to support the latest rocksdb. Please open issues in github if you have any problem.

News (2019/04/18)
=========
Currently I am refactoring the code, and more features like TTL are coming soon. And the installation with cmake will be much more easily. 

News (2019/04/19)
=========
I have created a branch named `pybind11` which provides the basic functions (`put`, `get` and `delete`) now. And the installtion is much more easily!  you can try it if you encounter any installtion issues in the current version of `python-rocksdb`.

The branch is under development and will be released to PypI after I migrate most of the existing features. 

pyrocksdb
=========

Python bindings for RocksDB.
See http://python-rocksdb.readthedocs.io/en/latest/ for a more comprehensive install and usage description.


Quick Install
-------------

Quick install for debian/ubuntu like linux distributions.

.. code-block:: bash

    $ apt-get install build-essential libsnappy-dev zlib1g-dev libbz2-dev libgflags-dev liblz4-dev
    $ git clone https://github.com/facebook/rocksdb.git
    $ cd rocksdb
    $ mkdir build && cd build
    $ cmake ..
    $ make
    $ cd ..
    $ export CPLUS_INCLUDE_PATH=${CPLUS_INCLUDE_PATH}${CPLUS_INCLUDE_PATH:+:}`pwd`/include/
    $ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}${LD_LIBRARY_PATH:+:}`pwd`/build/
    $ export LIBRARY_PATH=${LIBRARY_PATH}${LIBRARY_PATH:+:}`pwd`/build/

    $ apt-get install python-virtualenv python-dev
    $ virtualenv pyrocks_test
    $ cd pyrocks_test
    $ . bin/active
    $ pip install python-rocksdb


Quick Usage Guide
-----------------

.. code-block:: pycon

    >>> import rocksdb
    >>> db = rocksdb.DB("test.db", rocksdb.Options(create_if_missing=True))
    >>> db.put(b'a', b'data')
    >>> print db.get(b'a')
    b'data'
now support rocksdb 5.3.0 2017-03-23 15:13:45 +01:00			`Note`
			`=========`
Merge options source_compaction_factor, max_grandparent_overlap_bytes and expanded_compaction_factor into max_compaction_bytes 2017-04-07 18:18:38 +02:00			`The original pyrocksdb (https://pypi.python.org/pypi/pyrocksdb/0.4) has not been updated for long time. I update pyrocksdb to support the latest rocksdb. Please open issues in github if you have any problem.`
now support rocksdb 5.3.0 2017-03-23 15:13:45 +01:00
Update README.rst 2019-04-18 15:12:00 +02:00			`News (2019/04/18)`
Update README.rst 2019-04-06 14:39:55 +02:00			`=========`
Update README.rst 2019-04-18 15:12:00 +02:00			`Currently I am refactoring the code, and more features like TTL are coming soon. And the installation with cmake will be much more easily.`
now support rocksdb 5.3.0 2017-03-23 15:13:45 +01:00
Update README.rst 2019-04-19 11:42:30 +02:00			`News (2019/04/19)`
Update README.rst 2019-04-19 11:42:51 +02:00			`=========`
Update README.rst 2019-04-19 11:42:30 +02:00			I have created a branch named `pybind11` which provides the basic functions (`put`, `get` and `delete`) now. And the installtion is much more easily! you can try it if you encounter any installtion issues in the current version of `python-rocksdb`.

			`The branch is under development and will be released to PypI after I migrate most of the existing features.`

Initial commit 2014-01-13 19:42:31 +01:00			`pyrocksdb`
			`=========`

Improve the README.rst by adding a quick install/using guide. 2015-08-17 10:44:28 +02:00			`Python bindings for RocksDB.`
add seekForPrev 2017-04-23 13:32:41 +02:00			`See http://python-rocksdb.readthedocs.io/en/latest/ for a more comprehensive install and usage description.`
Improve the README.rst by adding a quick install/using guide. 2015-08-17 10:44:28 +02:00

			`Quick Install`
			`-------------`

			`Quick install for debian/ubuntu like linux distributions.`

			`.. code-block:: bash`

Added liblz4-dev as a package to be installed 2018-04-17 11:56:22 +02:00			`$ apt-get install build-essential libsnappy-dev zlib1g-dev libbz2-dev libgflags-dev liblz4-dev`
Improve the README.rst by adding a quick install/using guide. 2015-08-17 10:44:28 +02:00			`$ git clone https://github.com/facebook/rocksdb.git`
			`$ cd rocksdb`
fix typo 2017-07-15 16:19:13 +02:00			`$ mkdir build && cd build`
bump to 0.6.1 2017-03-23 18:02:46 +01:00			`$ cmake ..`
add missing part in the installation guide 2017-07-17 08:51:56 +02:00			`$ make`
Modified docs to export CPLUS_INCLUDE_PATH, LD_LIBRARY_PATH and LIBRARY_PATH correctly even if they weren't originally assigned 2018-04-16 12:04:23 +02:00			`$ cd ..`
			$ export CPLUS_INCLUDE_PATH=${CPLUS_INCLUDE_PATH}${CPLUS_INCLUDE_PATH:+:}`pwd`/include/
			$ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}${LD_LIBRARY_PATH:+:}`pwd`/build/
			$ export LIBRARY_PATH=${LIBRARY_PATH}${LIBRARY_PATH:+:}`pwd`/build/
Improve the README.rst by adding a quick install/using guide. 2015-08-17 10:44:28 +02:00
			`$ apt-get install python-virtualenv python-dev`
			`$ virtualenv pyrocks_test`
			`$ cd pyrocks_test`
			`$ . bin/active`
bump to 0.6.1 2017-03-23 18:02:46 +01:00			`$ pip install python-rocksdb`
Improve the README.rst by adding a quick install/using guide. 2015-08-17 10:44:28 +02:00

			`Quick Usage Guide`
			`-----------------`

			`.. code-block:: pycon`

			`>>> import rocksdb`
			`>>> db = rocksdb.DB("test.db", rocksdb.Options(create_if_missing=True))`
			`>>> db.put(b'a', b'data')`
			`>>> print db.get(b'a')`
			`b'data'`