Like this project? it on
Welcome to Blitz-DB!¶
BlitzDB, or just Blitz ,  is a document-based, object-oriented, transactional database written purely in Python. Among other things, it provides a powerful querying language, deep indexing of documents, compressed data storage and automatic referencing of embedded documents. It is reasonably fast, can be easily embedded in any Python application and does not have any external dependencies (except when using a third-party backend). In addition, you can use it as a frontend to other database engines such as MongoDB in case you should need more power.
- Document-based, object-oriented interface.
- Powerful and rich querying language.
- Deep document indexes on arbitrary fields.
- Compressed storage of documents.
- Support for multiple backends (e.g. file-based storage, MongoDB).
- Support for database transactions (currently only for the file-based backend).
Please be aware that this is an early development version of BlitzDB, so there are probably still some bugs in the code and the documentation is not very extensive for the moment.
We are currently looking for contributors and people that are passionate about building BlitzDB with us, so if you’re interested in joining our quest or if you have any suggestions, remarks or complaints, feel free to get in touch, e.g. via email or Github. Thanks!
For detailed installation instructions, have a look at the documentation. The easiest way to install checkmate is via pip or easy_install:
pip install blitzdb #or easy_install blitzdb
Alternatively, you can just download the source from Github and install it manually by running (in the project directory):
git clone firstname.lastname@example.org:adewes/blitzdb.git cd blitzdb sudo python setup.py install
Blitz has been designed as an embeddable, easy-to-use and reasonably fast database. In general, it performs well even with moderately large (>100.000 entries) collections of documents, provided you make good use of its indexing capabilities.
It is NOT a fully-fledged database system like MySQL or MongoDB:
- In the current version it does not provide any support for concurrent writes/reads to the database.
- It uses a relatively simple indexing mechanism based on hash tables and stores documents in flat files on the disk, hence querying performance will usually not be comparable to state-of-the art database systems.
However, for more demanding use cases, Blitz can be used as a frontend to a third-party backends, most notably MongoDB.
Sometimes you just want to store some structured data (think dictionaries) in a local database and get it out again when needed. For this, you could use e.g. the shelve module, or an embedded database like sqlite, or resort to an external database like MongoDB. The problem with these is that they either don’t support rich querying of the data (shelve), require you to specify the data format beforehand (sqlite) or require additional software running on your machine (MongoDB).
Blitz provides a new approach to this problem by giving you an embeddable database with a flexible data format and rich querying capabilities.
|||Blitz is the German word for ligthning. “blitzschnell” means “really fast”.|