![\"drawing\"](\"artwork/logo.png\"){kind=logo}
\n\n#### Monty, Mongo tinified. MongoDB implemented in Python !\n\n[](https://travis-ci.org/davidlatwe/MontyDB)\n\n[](https://pypi.python.org/pypi/MontyDB)\n[](https://codeclimate.com/github/davidlatwe/MontyDB/maintainability)\n\n###### Inspired by [TinyDB](https://github.com/msiemens/tinydb) and it's extension [TinyMongo](https://github.com/schapman1974/tinymongo).\n\n---\n\n### MontyDB is:\n* A tiny version of MongoDB, against to **MongoDB 3.6.4** *(4.0 soon)*\n* Written in pure Python, testing on **Python 2.7, 3.6, 3.7, PyPy, PyPy3.5**\n* Literally serverless.\n* Similar to [mongomock](https://github.com/mongomock/mongomock), but a bit more than that.\n\n> All those implemented functions and operators, should behaved just like you were working with MongoDB. Even raising error for same cause.\n\n### Install\n`pip install montydb`\n\n ##### Requirements\n - *`pymongo` (for `bson`)*\n\n### Example Code\n```python\n>>> from montydb import MontyClient\n>>> col = MontyClient(\":memory:\").db.test\n>>> col.insert_many([{\"stock\": \"A\", \"qty\": 6}, {\"stock\": \"A\", \"qty\": 2}])\n\n>>> cur = col.find({\"stock\": \"A\", \"qty\": {\"$gt\": 4}})\n>>> next(cur)\n{'_id': ObjectId('5ad34e537e8dd45d9c61a456'), 'stock': 'A', 'qty': 6}\n```\n\n### Development\n* Adopting [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) branching model.\n* Adopting Test-driven development.\n* You may visit [Projects' TODO](https://github.com/davidlatwe/montydb/projects/1) to see what's going on.\n* You may visit [This Issue](https://github.com/davidlatwe/montydb/issues/14) to see what's been implemented and what's not.\n\n\n### Storage Engine Configurations\n\nThe configuration process only required on repository creation or modification.\n\n**Currently, one repository can only assign one storage engine.**\n\n - **Memory**\n\n Memory storage does not need nor have any configuration, nothing saved to disk.\n\n ```python\n >>> from montydb import MontyClient\n >>> client = MontyClient(\":memory:\")\n ```\n\n - **FlatFile**\n\n FlatFile is the default on-disk storage engine.\n\n ```python\n >>> from montydb import MontyClient\n >>> client = MontyClient(\"/db/repo\")\n ```\n\n FlatFile config:\n\n ```yaml\n [flatfile]\n cache_modified: 0 # how many document CRUD cached before flush to disk.\n ```\n\n - **SQLite**\n\n SQLite is NOT the default on-disk storage, need configuration first before get client.\n\n ```python\n >>> from montydb import set_storage, MontyClient\n >>> set_storage(\"/db/repo\", storage=\"sqlite\")\n >>> client = MontyClient(\"/db/repo\")\n ```\n\n SQLite config:\n\n ```yaml\n [sqlite]\n journal_mode: WAL\n ```\n\n SQLite write concern:\n\n ```python\n >>> client = MontyClient(\"/db/repo\",\n >>> synchronous=1,\n >>> automatic_index=False,\n >>> busy_timeout=5000)\n ```\n\n### MontyDB URI\n\nYou could prefix the repository path with montydb URI scheme.\n\n```python\n >>> client = MontyClient(\"montydb:///db/repo\")\n```\n\n### Utilities\n\n* #### `montyimport`\n\n Imports content from an Extended JSON file into a MontyCollection instance.\n The JSON file could be generated from `montyexport` or `mongoexport`.\n\n ```python\n >>> from montydb import open_repo, utils\n >>> with open_repo(\"foo/bar\"):\n >>> utils.montyimport(\"db\", \"col\", \"/path/dump.json\")\n >>>\n ```\n\n* #### `montyexport`\n\n Produces a JSON export of data stored in a MontyCollection instance.\n The JSON file could be loaded by `montyimport` or `mongoimport`.\n\n ```python\n >>> from montydb import open_repo, utils\n >>> with open_repo(\"foo/bar\"):\n >>> utils.montyexport(\"db\", \"col\", \"/data/dump.json\")\n >>>\n ```\n\n* #### `montyrestore`\n\n Loads a binary database dump into a MontyCollection instance.\n The BSON file could be generated from `montydump` or `mongodump`.\n\n ```python\n >>> from montydb import open_repo, utils\n >>> with open_repo(\"foo/bar\"):\n >>> utils.montyrestore(\"db\", \"col\", \"/path/dump.bson\")\n >>>\n ```\n\n* #### `montydump`\n\n Creates a binary export from a MontyCollection instance.\n The BSON file could be loaded by `montyrestore` or `mongorestore`.\n\n ```python\n >>> from montydb import open_repo, utils\n >>> with open_repo(\"foo/bar\"):\n >>> utils.montydump(\"db\", \"col\", \"/data/dump.bson\")\n >>>\n ```\n\n* #### `MongoQueryRecorder`\n\n Record MongoDB query results in a period of time.\n *Requires to access databse profiler.*\n\n This works via filtering the database profile data and reproduce the queries of `find` and `distinct` commands.\n\n ```python\n >>> from pymongo import MongoClient\n >>> from montydb.utils import MongoQueryRecorder\n >>> client = MongoClient()\n >>> recorder = MongoQueryRecorder(client[\"mydb\"])\n >>> recorder.start()\n >>> # Make some queries or run the App...\n >>> recorder.stop()\n >>> recorder.extract()\n {\n ![\"drawing\"](\"artwork/icon.png\"){kind=icon}
\n