pymingledb 1.0.0

Lightweight file-based NoSQL engine (Python port of mingleDB). BSON + zlib, schema, query operators, auth.

pymingleDB

Lightweight file-based NoSQL engine — Python port of mingleDB. Same format as the JavaScript and gomingleDB implementations: BSON serialization, zlib compression, optional schema validation, query operators, and basic authentication.

Install (uv)

cd pymingleDB
uv sync

Or add to your project:

uv add pymingleDB

Usage

from pymingledb import MingleDB, ValidationError, UsernameExistsError, AuthFailedError

db = MingleDB("./mydb")  # or any path

# Schema (optional)
db.define_schema("users", {
    "name": {"type": "string", "required": True},
    "email": {"type": "string", "required": True, "unique": True},
    "age": {"type": "number"},
})

# CRUD
db.insert_one("users", {"name": "Alice", "email": "[e-mail]", "age": 30})
db.insert_one("users", {"name": "Bob", "email": "[e-mail]", "age": 17})

db.find_all("users")
db.find_one("users", {"email": "[e-mail]"})
db.find("users", {"age": {"$gte": 18, "$lt": 60}})
db.find("users", {"name": {"$regex": "ali", "$options": "i"}})
db.find("users", {"email": {"$in": ["[e-mail]", "[e-mail]"]}})

db.update_one("users", {"name": "Alice"}, {"age": 31})
db.delete_one("users", {"email": "[e-mail]"})

# Auth (uses internal _auth collection)
db.register_user("admin", "secure123")
db.login("admin", "secure123")
db.is_authenticated("admin")  # True
db.logout("admin")

# Reset (wipe all collections and schemas)
db.reset()

Query operators

• $gt, $gte, $lt, $lte — numeric comparison
• $eq, $ne — equality
• $in, $nin — in list / not in list
• $regex, $options — regex (e.g. "i" for case-insensitive)

You can also pass a compiled re.Pattern as a filter value for regex match.

Exceptions

• MingleDBError — base
• UsernameExistsError — register with existing username
• AuthFailedError — login failed
• ValidationError — schema validation (required, type, unique)

File format

Collections are stored as <collection>.mgdb files: header MINGLEDBv1, 4-byte meta length, JSON meta, then for each document: 4-byte length + zlib(BSON(doc)). Compatible with mingleDB (JS) and gomingleDB (Go).

Tests

uv sync --extra dev
uv run pytest tests/ -v

License

Use under the same terms as mingleDB / gomingleDB.