lbry-rocksdb/docs/index.rst

44 lines
1 KiB
ReStructuredText
Raw Normal View History

2014-01-13 19:52:22 +01:00
Welcome to pyrocksdb's documentation!
=====================================
Overview
--------
Python bindings to the C++ interface of http://rocksdb.org/ using cython::
import rocksdb
db = rocksdb.DB("test.db", rocksdb.Options(create_if_missing=True))
db.put(b"a", b"b")
print db.get(b"a")
2014-01-13 19:52:22 +01:00
Tested with python2.7 and python3.3
2014-01-13 19:52:22 +01:00
.. toctree::
:maxdepth: 2
Instructions how to install <installation>
Tutorial <tutorial/index>
API <api/index>
2014-01-21 17:28:38 +01:00
Contributing
------------
Source can be found on `github <https://github.com/stephan-hof/pyrocksdb>`_.
Feel free to fork and send pull-requests or create issues on the
`github issue tracker <https://github.com/stephan-hof/pyrocksdb/issues>`_
2014-01-13 19:52:22 +01:00
RoadMap/TODO
------------
2014-01-21 17:28:38 +01:00
* wrap Backup/Restore https://github.com/facebook/rocksdb/wiki/How-to-backup-RocksDB%3F
* wrap DestroyDB
* wrap RepairDB
* Links from tutorial to API pages (for example merge operator)
2014-01-13 19:52:22 +01:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`