https://github.com/mrtg-codebot/soradblite
SoraDBlite is a Python class designed to simplify interactions with MongoDB databases. And the operation are similar to the pymongo, and it is easy to understand. It is the lite version of pymongo.
https://github.com/mrtg-codebot/soradblite
mongodb pymongo python python3 sora soradblite
Last synced: 5 months ago
JSON representation
SoraDBlite is a Python class designed to simplify interactions with MongoDB databases. And the operation are similar to the pymongo, and it is easy to understand. It is the lite version of pymongo.
- Host: GitHub
- URL: https://github.com/mrtg-codebot/soradblite
- Owner: MrTG-CodeBot
- License: gpl-3.0
- Created: 2024-11-10T10:01:36.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-01-11T15:07:18.000Z (9 months ago)
- Last Synced: 2025-03-30T23:20:03.237Z (6 months ago)
- Topics: mongodb, pymongo, python, python3, sora, soradblite
- Language: Python
- Homepage:
- Size: 449 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SoraDBlite
[](https://pypi.org/project/pymongo) [](https://pypi.org/project/SoraDBlite)
## 🌐 contact me:
[](https://t.me/MrTG_Coder)
## SoraDBlite Docs
[](https://soradblite-docs.netlify.app/)
## About
*SoraDBlite* is a Python class designed to simplify interactions with MongoDB databases. And the operation are similar to the mongodb, and it is easy to understand. It is just a lite version of mongodb. It providing the interface for performing essential CRUD (Create, Read, Update, Delete) operations. With SoraDBlite, developers can easily manage and manipulate data within their MongoDB collections, making it ideal for both simple and complex database tasks.
### Key Features:
◘ *Easy Connection Management*: Simplifies connecting to MongoDB databases.
◘ CRUD Operations: Perform basic CRUD operations effortlessly.
* Insert single or multiple documents.
* Find single or multiple documents with flexible query options.
* Update single or multiple documents.
* Delete single or multiple documents.
* Collection Management: Drop collections with ease.
◘ Sorting Capabilities: Sort documents by specified fields in ascending or descending order.
◘ *Error Handling*: Custom exceptions for better error.
◘ *Sora AI integration*: For error detection and solution.
◘ *SoraDBlite updatation*: A function fetches the latest SoraDBlite version from PyPI and upgrades the local installation using pip.
◘ *Export to json*: Exports collection data to JSON file.
◘ *Import from json*: Imports data from JSON file.
◘ *Audit_logs*: Retrieves audit logs within date range.
◘ *Backup_collection*: Creates a backup of the current collection.
## How to get db url and collection
### Video Tutorial
For a detailed video tutorial, check out this link: [video](https://youtu.be/mD9veNL7KoE?si=nTb5GbfDINNy5TCQ)
## Differences Between `pymongo` and `SoraDBlite`
| Feature | pymongo | SoraDBlite |
|--------------------|---------------------------------------------------|----------------------------------------------|
| **Library Type** | Low-level MongoDB driver | High-level wrapper for `pymongo` |
| **Usage** | Directly interacts with MongoDB | Simplified methods for common operations |
| **Flexibility** | Complete control over MongoDB operations | Abstracts complexity, less granular control |
| **Error Handling** | Developers implement their own error handling | Built-in error handling |
| **Code Complexity**| More complex and verbose | User-friendly and concise |
## Installation
Make sure you have `SoraDBlite` installed. You can install it using pip if you haven't already:
```sh
pip install SoraDBlite
```
# Usage of SoraDBlite
𝗦𝗼𝗿𝗮𝗗𝗕𝗹𝗶𝘁𝗲
## Importing the Library
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError, is_collection_available, sora_ai, get_all_collection, update_SoraDBlite
```
## Updating the latest version through local installation using pip
```python
import SoraDBlite
from SoraDBlite import update_SoraDBlite
update_SoraDBlite() #pip install --upgrade SoraDBlite==latest_version
```
## Get all collection
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError, get_all_collection
db_url = "your_mongodb_url"
db_password = "your_db_password"
get_all_collection(db_url, db_password)
```
## Checking the collection name is available or not
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError, is_collection_available
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
is_collection_available(db_url, db_password, db_collection) # Pass the db_url, db_pass, db_collection_name
```
## Importing the Exception class
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
try:
db.connect(db_url, db_password, db_collection)
except SoraDBLiteError as e:
print(e)
```
## Importing the Exception Class and Using sora_ai()
Sora_ai() will given how to solve the error/ give the solution.
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError, sora_ai
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
try:
db.connect(db_url, db_password, db_collection)
except SoraDBLiteError as e:
print(e)
sora_ai(e) # Pass the error message to sora_ai() for a solution
```
## Connecting to the Database
To connect to your MongoDB database, use the `connect` method:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
```
## Inserting Documents
Insert a single document:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
document = {"name": "Alice", "age": 30, "city": "New York"}
inserted_id = db.insert_one(document)
print("Inserted document with ID:", inserted_id)
```
Insert multiple documents:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
documents = [
{"name": "Alice", "age": 30, "city": "New York"},
{"name": "Bob", "age": 25, "city": "Los Angeles"},
{"name": "Charlie", "age": 35, "city": "Chicago"}
]
inserted_ids = db.insert_many(documents)
print("Inserted document IDs:", inserted_ids)
```
## Finding Documents
Find a single document:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
query = {"name": "Alice"}
result = db.find_one(query)
print("Found document:", result)
```
Find multiple documents:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
query = {"age": {"$gt": 25}}
results = db.find_many(query)
print("Found documents:", results)
```
## Updating Documents
Update a single document:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
filter = {"name": "Alice"}
update = {"$set": {"city": "Los Angeles"}}
updated_count = db.update_one(filter, update)
print("Updated documents:", updated_count)
```
Update multiple documents:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
filter = {"city": "New York"}
update = {"$set": {"city": "New York City"}}
updated_count = db.update_many(filter, update)
print("Updated documents:", updated_count)
```
## Deleting Documents
Delete a single document:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
filter = {"name": "Alice"}
deleted_count = db.delete_one(filter)
print("Deleted documents:", deleted_count)
```
Delete multiple documents:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
filter = {"age": {"$lt": 25}}
deleted_count = db.delete_many(filter)
print("Deleted documents:", deleted_count)
```
## Backup Collection
Creates a backup of the current collection:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
from datetime import datetime,timedelta
# main db
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
db.backup_collection(collectionname) #you can pass collection name or other name
#backup collection db
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "backup_collection_name"
# then do your operators.
```
## Import From Json File
Imports data from JSON file.
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
from datetime import datetime, timedelta
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
db.import_from_json('filename.json')
```
## Export To Json File
Exports collection data to JSON file.
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
from datetime import datetime,timedelta
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
db.export_to_json('filename.json')
```
## Get Audit Logs
Retrieves audit logs within date range.
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
from datetime import datetime,timedelta
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
# Get audit logs for the last 24 hours
end_date = datetime.utcnow()
start_date = end_date - timedelta(days=1)
audit_logs = db.get_audit_logs(start_date , end_date)
print("Recent audit logs:" , audit_logs)
```
## Get Collection Stats
Returns statistics about the collection.
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
from datetime import datetime,timedelta
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
print(db.get_collection_stats())
```
## Sorting Documents
Sort documents by a field in ascending order:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
results = db.sort_by("age", True)
print("Sorted by age (ascending):", results)
```
Sort documents by a field in descending order:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
results = db.sort_by("name", False)
print("Sorted by name (descending):", results)
```
## Dropping a Collection
To drop a collection, use the drop_collection method:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError, is_collection_available
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
db.drop_collection("your_db_collection_name")
is_collection_available(db_url, db_password, db_collection) # Pass the db_url, db_pass, db_collection_name
```
## counting the documents
Get the count of the documents:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
count = db.count({"name":"Alice"})
print(count)
```
## Fetch all values
Fetch all values for a specific key name:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
d=db.fetch_values_by_key("name")
print(d)
```
## Get the version
Get the version of pymongo and soradb:
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
db.version()
```
## Example Code
```python
import SoraDBlite
from SoraDBlite import SoraDBlite, SoraDBLiteError, is_collection_available, sora_ai, get_all_collection, update_SoraDBlite
from datetime import datetime,timedelta
update_SoraDBlite()
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "your_db_collection_name"
db = SoraDBlite()
db.connect(db_url, db_password, db_collection)
# Insert a document
document = {"name": "Alice", "age": 30, "city": "New York"}
inserted_id = db.insert_one(document)
print("Inserted document with ID:", inserted_id)
# Find a document
query = {"name": "Alice"}
result = db.find_one(query)
print("Found document:", result)
# Find multiple documents
query = {"age": {"$gt": 25}}
results = db.find_many(query)
print("Found documents:", results)
# Update a document
filter = {"name": "Alice"}
update = {"$set": {"city": "Los Angeles"}}
updated_count = db.update_one(filter, update)
print("Updated documents:", updated_count)
# Delete a document
filter = {"name": "Alice"}
deleted_count = db.delete_one(filter)
print("Deleted documents:", deleted_count)
# Insert multiple documents
documents = [
{"name": "Alice", "age": 30, "city": "New York"},
{"name": "Bob", "age": 25, "city": "Los Angeles"},
{"name": "Charlie", "age": 35, "city": "Chicago"}
]
inserted_ids = db.insert_many(documents)
print("Inserted document IDs:", inserted_ids)
# Find multiple documents
query = {"age": {"$gt": 25}}
results = db.find_many(query)
print("Found documents:", results)
# Update multiple documents
filter = {"city": "New York"}
update = {"$set": {"city": "New York City"}}
updated_count = db.update_many(filter, update)
print("Updated documents:", updated_count)
# Delete multiple documents
filter = {"age": {"$lt": 25}}
deleted_count = db.delete_many(filter)
print("Deleted documents:", deleted_count)
# Backup collection
db.backup_collection(collectionname) #you can pass collection name or other name
#backup collection db
db_url = "your_mongodb_url"
db_password = "your_db_password"
db_collection = "backup_collection_name"
# then do your operators.
# Import from json file
db.import_from_json('filename.json')
# Export to json file
db.export_to_json('filename.json')
# Get audit logs for the last 24 hours
end_date = datetime.utcnow()
start_date = end_date - timedelta(days=1)
audit_logs = db.get_audit_logs(start_date , end_date)
print("Recent audit logs:" , audit_logs)
# Get collection stats
print(db.get_collection_stats())
# Sort documents by age ascending order
results = db.sort_by("age", True)
print("Sorted by age (ascending):", results)
# Sort documents by name descending order
results = db.sort_by("name", False)
print("Sorted by name (descending):", results)
# Count the documents
count = db.count({"name":"Alice"})
print(count)
# Fetch all values for a specific key
d = db.fetch_values_by_key("name")
print(d)
#Get the version of pymongo and soradb
db.version()
# Drop a collection
db.drop_collection(db_collection)
# Check the collection is dropped or not
is_collection_available(db_url, db_password, db_collection) # Pass the db_url, db_pass, db_collection_name
```