Skip to main content

A lightweight local JSON database

Project description

JSONLite

Build Status PyPI License Issues PRs Welcome

JSONLite is a lightweight, local JSON database for simple data storage.

  • Like SQLite, it's a local database.
  • Its API is 100% modeled after MongoDB, making it easy to migrate between MongoDB and JSONLite.

Features

  • Zero dependency
  • Store JSON data locally
  • MongoDB-like API, Compatible with pymongo
  • Allows multiple processes to read/write concurrently

Table of Contents

Installation

pip install jsonlite

Data Layout in json file

{
    "data": [
        {   "_id": 1,
            "name": "Alice",
            "age": 30
        },
        {   "_id": 2,
            "name": "Bob",
            "age": 25
        },
        {   "_id": 3,
            "name": "Charlie",
            "age": 20
        }
    ]
}

Direct Usage

You can use JSONlite directly to perform CRUD operations.

>>> from jsonlite import JSONlite

>>> # Initialize the database
>>> db = JSONlite('mydatabase.json')

>>> # Inserting one document
>>> result = db.insert_one({"name": "John Doe", "age": 30})
>>> result.inserted_id
1

>>> # Inserting multiple documents
>>> result = db.insert_many([
...     {"name": "Jane Doe", "age": 25},
...     {"name": "Alice", "age": 28}
... ])
>>> result.inserted_ids
[2, 3]

>>> # Finding one document
>>> document = db.find_one({"name": "John Doe"})
>>> document
{'_id': 1, 'name': 'John Doe', 'age': 30}

>>> # Finding multiple documents
>>> documents = db.find({"age": {"$gte": 25}})
>>> documents
[
    {'_id': 1, 'name': 'John Doe', 'age': 30},
    {'_id': 2, 'name': 'Jane Doe', 'age': 25},
    {'_id': 3, 'name': 'Alice', 'age': 28}
]

>>> # Updating one document
>>> result = db.update_one({"name": "John Doe"}, {"$set": {"age": 31}})
>>> result.matched_count, result.modified_count
(1, 1)

>>> # Updating multiple documents
>>> result = db.update_many({"age": {"$gte": 25}}, {"$set": {"status": "active"}})
>>> result.matched_count, result.modified_count
(3, 3)

>>> # Deleting one document
>>> result = db.delete_one({"name": "John Doe"})
>>> result.deleted_count
1

>>> # Deleting multiple documents
>>> result = db.delete_many({"age": {"$lt": 30}})
>>> result.deleted_count
2

Patching pymongo to use JSONlite

Alternatively, you can patch pymongo to use JSONlite and interact with JSON files as if you were using MongoDB. This allows you to use the familiar pymongo API with JSON data.

>>> from jsonlite import pymongo_patch

>>> pymongo_patch()

>>> from pymongo import MongoClient

>>> client = MongoClient('jsonlite://database')
>>> db = client.test_database
>>> collection = db.test_collection
>>> insert_result = collection.insert_one({"name": "Alice", "age": 30})
>>> # Just like using pymongo
>>> collection.drop()

License

JSONLite is licensed under the MIT License. See the LICENSE file for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jsonlite-0.0.11.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

jsonlite-0.0.11-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file jsonlite-0.0.11.tar.gz.

File metadata

  • Download URL: jsonlite-0.0.11.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for jsonlite-0.0.11.tar.gz
Algorithm Hash digest
SHA256 7c7422316c84b7677947055c2a98203e09bacd8c970573f991bfbea04f8aad6d
MD5 74bad0c60050259511bf513f59750365
BLAKE2b-256 106164d2c51dfe9775b423dc738735f87065f9daa7577870ae62308cd166b185

See more details on using hashes here.

File details

Details for the file jsonlite-0.0.11-py3-none-any.whl.

File metadata

  • Download URL: jsonlite-0.0.11-py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for jsonlite-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 d6aca4f416f9d7c15dacf1fb50525ae68a9d70510e067cb438fb6e14c8d42959
MD5 4c3cf92d6d44839c667f0360a86787bb
BLAKE2b-256 273b472e57587ed1c311efddfb3a3c06a7aa8c849fd493e6b1acf0ad75b03c26

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page