{"id":20453293,"url":"https://github.com/umihico/microdb","last_synced_at":"2025-04-13T03:33:43.596Z","repository":{"id":57441405,"uuid":"162805107","full_name":"umihico/microdb","owner":"umihico","description":"In-memory, Hash-mapping, Disk-writable, Thread-safe database.","archived":false,"fork":false,"pushed_at":"2018-12-24T06:54:25.000Z","size":20,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T20:49:34.136Z","etag":null,"topics":["database","python"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/umihico.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-22T11:19:12.000Z","updated_at":"2021-03-18T04:08:56.000Z","dependencies_parsed_at":"2022-09-05T23:51:39.603Z","dependency_job_id":null,"html_url":"https://github.com/umihico/microdb","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umihico%2Fmicrodb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umihico%2Fmicrodb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umihico%2Fmicrodb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umihico%2Fmicrodb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/umihico","download_url":"https://codeload.github.com/umihico/microdb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248659830,"owners_count":21141189,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","python"],"created_at":"2024-11-15T11:12:22.422Z","updated_at":"2025-04-13T03:33:43.576Z","avatar_url":"https://github.com/umihico.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# microdb\nIn-memory, Hash-mapping, Disk-writable, Thread-safe database.  \n[![PyPI version](https://badge.fury.io/py/microdb.svg)](https://badge.fury.io/py/microdb)\n\nInstallation with pip\n```\n$ pip install microdb\n```\n\nThis database works as list of dictionaries.\n```\n\u003e\u003e\u003e import microdb\n\u003e\u003e\u003e mdb = microdb.MicroDB(\"testdata/mdb.json\", partition_keys=['job', 'name'])\n\u003e\u003e\u003e mdb.pprint_all()\n[{'job': 'clean', 'name': 'Alice', 'status': 'undone'},\n {'job': 'study', 'name': 'Alice', 'status': 'undone'},\n {'job': 'clean', 'name': 'Bob', 'status': 'undone'},\n {'job': 'study', 'name': 'Bob', 'status': 'undone'}]\n\u003e\u003e\u003e mdb.pprint_all_as_grid()\n[['name', 'status', 'job'],\n  ['Alice', 'undone', 'clean'],\n  ['Alice', 'undone', 'study'],\n  ['Bob', 'undone', 'clean'],\n  ['Bob', 'undone', 'study']]\n```  \nOnly 'upsert' method add data, or overwrite if the \"key\" is already in use.\n```\n\u003e\u003e\u003e mdb.upsert({'job': 'clean', 'name': 'Alice', 'status': 'finished'})\n\u003e\u003e\u003e mdb.upsert({'job': 'clean', 'name': 'Eve', 'status': 'undone'})\n\u003e\u003e\u003e mdb.pprint_all()\n[{'job': 'clean', 'name': 'Alice', 'status': 'finished'}, # overwritten\n {'job': 'study', 'name': 'Alice', 'status': 'undone'},\n {'job': 'clean', 'name': 'Bob', 'status': 'undone'},\n {'job': 'study', 'name': 'Bob', 'status': 'undone'},\n {'job': 'clean', 'name': 'Eve', 'status': 'undone'}] # new\n```  \nKey is tupled values of partition_keys. Use 'gen_key' method to see.  \n```\n\u003e\u003e\u003e # mdb = microdb.MicroDB(\"testdata/mdb.json\", partition_keys=['job', 'name'])\n\u003e\u003e\u003e mdb.gen_key({'job': 'clean', 'name': 'Bob', 'what': 'ever'})\n('clean', 'Bob')\n```\n'get' method and 'in' operator as same as dict\n```\n\u003e\u003e\u003e {'job': 'clean', 'name': 'Bob', 'what': 'ever'} in mdb\nTrue\n\u003e\u003e\u003e mdb.get({'job': 'study', 'name': 'Alice','whaat':'everr'})\n{'status': 'undone', 'job': 'study', 'name': 'Alice'}\n\u003e\u003e\u003e mdb.get({'wrong': 'key'},'when_not_exist') # same as dict.get\n'when_not_exist'\n```  \nWrite on disk when you want.\n```\n\u003e\u003e\u003e mdb.save()\n\n\u003e\u003e\u003e mdb.save_as_grid() # good to reduce amount when all keys are common\n$ cat testdata/mdb.json\n[['status', 'job', 'name'], ['undone', 'clean', 'Alice'], ['undone', 'study', 'Alice'], ['undone', 'clean', 'Bob'], ['undone', 'study', 'Bob']]\n\n\u003e\u003e\u003e mdb.save('another_file_name.json') # you can write anywhere\n$ cat another_file_name.json\n[{'job': 'clean', 'name': 'Alice', 'status': 'undone'}, {'job': 'study', 'name': 'Alice', 'status': 'undone'}, {'job': 'clean', 'name': 'Bob', 'status': 'undone'}, {'job': 'study', 'name': 'Bob', 'status': 'undone'}]\n```\n\nAll operation is already thread-safe by threading.rlock().\nIn case if you need to block while operations in a row,\n```\n\u003e\u003e\u003e with mdb.lock():\n...    bob_clean_status=mdb.get({'job': 'clean', 'name': 'Bob'})['status']\n...    if bob_clean_status != 'finished':\n...       mdb.upsert({'job': 'pay_penalty', 'name': 'Bob','status':'undone'})\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fumihico%2Fmicrodb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fumihico%2Fmicrodb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fumihico%2Fmicrodb/lists"}