LMDB API Reference¶
Note
Status: This page is under development.
Complete API reference for the low-level LMDB API (zlmdb.lmdb).
Overview¶
This reference documents all classes, methods, and functions in the zlmdb.lmdb module.
Coming Soon¶
This page will provide detailed API documentation for:
Module Functions -
lmdb.open()- Open an LMDB environment -lmdb.version()- Get LMDB library versionEnvironment Class - Constructor parameters -
begin()- Start a transaction -open_db()- Open/create a database -close()- Close the environment -sync()- Flush buffers to disk -stat()- Get environment statistics -info()- Get environment information -copy()- Backup operationsTransaction Class -
get()- Retrieve a value -put()- Store a value -delete()- Remove a key -cursor()- Open a cursor -commit()- Commit changes -abort()- Discard changes -drop()- Clear databaseCursor Class - Navigation methods (
first(),last(),next(),prev()) - Positioning methods (set_key(),set_range()) - Data access (item(),key(),value()) - Modification methods (put(),delete()) - Iteration supportDatabase Handle - Database flags - Statistics methods
Exceptions -
Error- Base exception -KeyNotFoundError-MapFullError- Other LMDB errors
For now, see the main Reference for auto-generated API documentation.
See Also¶
Low-Level LMDB API - LMDB API overview
LMDB API Quick Start - Getting started
py-lmdb documentation - Compatible API reference