Great that you’ve taken time to check out the TinyDB docs! Before we begin looking at TinyDB itself, let’s take some time to see whether you should use TinyDB.
Why Use TinyDB?¶
- tiny: The current source code has 1200 lines of code (with about 40% documentation) and 1000 lines tests. For comparison: Buzhug has about 2500 lines of code (w/o tests), CodernityDB has about 7000 lines of code (w/o tests).
- document oriented: Like MongoDB, you can store any document
dict) in TinyDB.
- optimized for your happiness: TinyDB is designed to be simple and fun to use by providing a simple and clean API.
- written in pure Python: TinyDB neither needs an external server (as e.g. PyMongo) nor any dependencies from PyPI.
- works on Python 2.6 + 2.7 and 3.3 – 3.5 and PyPy: TinyDB works on all modern versions of Python and PyPy.
- powerfully extensible: You can easily extend TinyDB by writing new storages or modify the behaviour of storages with Middlewares.
- 100% test coverage: No explanation needed.
In short: If you need a simple database with a clean API that just works without lots of configuration, TinyDB might be the right choice for you.
Why Not Use TinyDB?¶
- You need advanced features like:
- access from multiple processes or threads,
- creating indexes for tables,
- a HTTP server,
- managing relationships between tables or similar.
- You are really concerned about performance and need a high speed database.