NeoSQLite

NeoSQLite is a pure Python library that introduces NoSQL capabilities to SQLite through a PyMongo-like API. This innovative library allows seamless interaction with SQLite databases by utilizing a schemaless, document-based architecture, which is intended for developers familiar with MongoDB's operational style.

Key Features

• Familiar API: The library mirrors the PyMongo interface, enabling easy transition for those experienced with MongoDB.
• Schemaless Document Storage: Developers can store flexible JSON-like documents without the constraints of traditional schema.
• Lazy Cursors: The find() method returns a memory-efficient cursor for iterating over results to optimize memory usage.
• Raw Batch Processing: Utilize find_raw_batches() for fetching raw JSON data in efficient batches suitable for large datasets.
• Enhanced Indexing Options: Support for single-key, compound-key, and nested-key indexes that significantly boost query performance.
• Full-Text Search: Utilizes SQLite's FTS5 extension, providing powerful search capabilities through the $text operator.
• Modern API Practices: Aligns with contemporary pymongo practices, featuring methods like insert_one, update_one, and delete_many.
• Automatic JSON/JSONB Support: The library detects and optimizes for JSONB column types when available, enhancing performance.
• GridFS Compatibility: Allows storage and retrieval of large files via a PyMongo-compatible GridFS implementation.

Drop-in Replacement for PyMongo

For many common use cases, NeoSQLite can act as a drop-in replacement for PyMongo. Minimal code adjustments are needed for transitioning from MongoDB, as the underlying API functions remain intact. Whether connecting with a local database or a remote one, the interface remains consistent across both libraries, ensuring a smooth developer experience.

Performance Benchmarks

NeoSQLite is designed with performance in mind, showcasing significant optimizations through extensive benchmarking. Key efficiency metrics include:

• Optimized three-tier aggregation pipeline processing, covering over 85% of common aggregation scenarios.
• Advanced SQL optimizations for efficient text searching within arrays.

JSON/JSONB Support and Binary Data Handling

The library smartly manages database connectivity based on the JSON function support of SQLite installations, ensuring robust performance in any environment. Additionally, NeoSQLite provides comprehensive support for binary data storage and retrieval, balancing ease of use and functionality in handling diverse data types.

Memory-Constrained Processing

For intensive applications, NeoSQLite offers memory-constrained processing options via integration with the quez library. This feature allows efficient handling of large result sets by employing compression techniques that significantly reduce memory usage.

Contribution and Community

Originally derived from the project shaunduncan/nosqlite, NeoSQLite has grown through community support and continuous enhancements. Contributions are welcome, promoting an environment of collective improvement and innovation.

For further details and usage examples, visit the examples directory in the repository.