Repository files navigation

• Example Code
• Supported Python Versions
• Documentation
• Changelog
• Extensions
• Contributing

TinyDB is a lightweight document oriented database optimized for your happiness :)It's written in pure Python and has no external dependencies. The target aresmall apps that would be blown away by a SQL-DB or an external database server.

TinyDB is:

• tiny: The current source code has 1800 lines of code (with about 40%documentation) and 1600 lines tests.
• document oriented: LikeMongoDB, you can store any document(represented asdict) in TinyDB.
• optimized for your happiness: TinyDB is designed to be simple andfun to use by providing a simple and clean API.
• written in pure Python: TinyDB neither needs an external server (ase.g.PyMongo) nor any dependenciesfrom PyPI.
• works on Python 3.8+ and PyPy3: TinyDB works on all modern versions of Pythonand PyPy.
• powerfully extensible: You can easily extend TinyDB by writing newstorages or modify the behaviour of storages with Middlewares.
• 100% test coverage: No explanation needed.

To dive straight into all the details, head over to theTinyDB docs. You can also discuss everything relatedto TinyDB like general development, extensions or showcase your TinyDB-basedprojects on thediscussion forum.

TinyDB has been tested with Python 3.8 - 3.13 and PyPy3.

This project is in maintenance mode. It has reached a mature, stable statewhere significant new features or architectural changes are not planned. Thatsaid, there will still be releases for bugfixes or features contributed bythe community. Read more about what this means in particularhere.

>>>fromtinydbimportTinyDB,Query>>>db=TinyDB('/path/to/db.json')>>>db.insert({'int':1,'char':'a'})>>>db.insert({'int':1,'char':'b'})

>>>User=Query()>>># Search for a field value>>>db.search(User.name=='John')[{'name':'John','age':22}, {'name':'John','age':37}]>>># Combine two queries with logical and>>>db.search((User.name=='John')& (User.age<=30))[{'name':'John','age':22}]>>># Combine two queries with logical or>>>db.search((User.name=='John')| (User.name=='Bob'))[{'name':'John','age':22}, {'name':'John','age':37}, {'name':'Bob','age':42}]>>># Negate a query with logical not>>>db.search(~(User.name=='John'))[{'name':'Megan','age':27}, {'name':'Bob','age':42}]>>># Apply transformation to field with `map`>>>db.search((User.age.map(lambdax:x+x)==44))>>> [{'name':'John','age':22}]>>># More possible comparisons:  !=  <  >  <=  >=>>># More possible checks: where(...).matches(regex), where(...).test(your_test_func)

>>>table=db.table('name')>>>table.insert({'value':True})>>>table.all()[{'value':True}]

>>>fromtinydb.storagesimportJSONStorage>>>fromtinydb.middlewaresimportCachingMiddleware>>>db=TinyDB('/path/to/db.json',storage=CachingMiddleware(JSONStorage))

Whether reporting bugs, discussing improvements and new ideas or writingextensions: Contributions to TinyDB are welcome! Here's how to get started:

1. Check for open issues or open a fresh issue to start a discussion arounda feature idea or a bug
2. Forkthe repository on Github,create a new branch off the master branch and start making your changes(known asGitHub Flow)
3. Write a test which shows that the bug was fixed or that the feature worksas expected
4. Send a pull request and bug the maintainer until it gets merged andpublished ☺