is a Simple, FileBase and Document Oriented database
Project description
Introduction
PantherDB is a Simple, FileBase and Document Oriented database that you can use in your projects.
Features:
- Document Oriented
- Easy to use
- Written in pure Python +3.8 based on standard type hints
- Handle Database Encryption
- Singleton connection per
db_name
Usage
Database:
-
Create a database:
db: PantherDB = PantherDB('database.pdb')
-
Create an encrypted database:
Required
cyptography
install it withpip install pantherdb[full]
from cryptography.fernet import Fernet key = Fernet.generate_key() # Should be static (You should not generate new key on every run) db: PantherDB = PantherDB('database.pdb', secret_key=key)
-
Access to a collection:
user_collection: PantherCollection = db.collection('User')
-
Delete a collection:
db.collection('User').drop()
Create:
-
Insert document:
user: PantherDocument = db.collection('User').insert_one(first_name='Ali', last_name='Rn')
Get:
-
Find one document:
user: PantherDocument = db.collection('User').find_one(first_name='Ali', last_name='Rn')
or
user: PantherDocument = db.collection('User').find_one()
-
Find first document (alias of
find_one()
):user: PantherDocument = db.collection('User').first(first_name='Ali', last_name='Rn')
or
user: PantherDocument = db.collection('User').first()
-
Find last document:
user: PantherDocument = db.collection('User').last(first_name='Ali', last_name='Rn')
or
user: PantherDocument = db.collection('User').last()
-
Find documents:
users: list[PantherDocument] = db.collection('User').find(last_name='Rn')
-
All documents:
users: list[PantherDocument] = db.collection('User').all()
-
Count documents:
users_count: int = db.collection('User').count(first_name='Ali')
Update:
-
Update a document:
user: PantherDocument = db.collection('User').find_one(first_name='Ali', last_name='Rn') user.update(name='Saba')
-
Filter and Update a document:
_filter = {'first_name': 'Ali', 'last_name': 'Rn'} is_updated: bool = db.collection('User').update_one(_filter, first_name='Saba')
-
Filter and Update many:
_filter = {'first_name': 'Ali'} updated_count: int = db.collection('User').update_many(_filter, first_name='Saba')
Delete:
-
Delete a document:
user: PantherDocument = db.collection('User').first(first_name='Ali', last_name='Rn') user.delete()
-
Filter and Delete a document:
is_deleted: bool = db.collection('User').delete_one(first_name='Ali', last_name='Rn')
-
Filter and Delete many:
deleted_count: int = db.collection('User').delete_many(last_name='Rn')
TODO:
- Add encryption
- Complete tests TODO
- Add B+ tree
- Find better encryption solution
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pantherdb-1.3.6.tar.gz
(8.0 kB
view hashes)
Built Distribution
Close
Hashes for pantherdb-1.3.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8208c6207489a83b1d24b63f3241eb281d7ef408228ee6ff136cc5c14dc5dfd2 |
|
MD5 | 2fb724128311c29369d6280d037bac5f |
|
BLAKE2b-256 | 6f87aa4ef40d35a954bf1a7cf1b8f5b20725356ec9b30acae26498bec9246ff4 |