MaseDB Python Client is a powerful library for interacting with the Mase Database API. It provides both synchronous and asynchronous interfaces for database operations, supporting MongoDB-style queries, transactions, indexing, and comprehensive error handling.
pip install masedb
# Clone the repository
git clone https://github.com/maseai/masedb.git
# Navigate to the project directory
cd masedb
# Install in development mode
pip install -e .
from masedb import MaseDBClient
# Initialize client with your API key
client = MaseDBClient(api_key="your_api_key")
# Create a collection
client.create_collection("users", "Collection for user data")
# Create a document
document = {
"name": "John Doe",
"email": "john@example.com",
"age": 30
}
result = client.create_document("users", document)
# Query documents using MongoDB-style operators
users = client.list_documents("users", {
"age": { "$gt": 25 },
"status": { "$in": ["active", "pending"] },
"$or": [
{ "email": { "$exists": true } },
{ "phone": { "$exists": true } }
]
})
Check out the examples directory for complete working examples:
basic_usage.py - Basic CRUD operations and collection managementadvanced_queries.py - Complex MongoDB-style query operators and array operationstransactions.py - Transaction management and money transfer examplesasync_usage.py - Asynchronous operations with asyncioEach example demonstrates different aspects of the library:
# basic_usage.py demonstrates:
- Creating and managing collections
- Basic CRUD operations with documents
- Using MongoDB-style query operators
- Error handling
# advanced_queries.py demonstrates:
- Complex MongoDB-style query operators:
- Comparison: $eq, $ne, $gt, $gte, $lt, $lte
- Array: $in, $nin
- Existence: $exists
- Type: $type
- Regex: $regex
- Logical: $or, $and, $not, $nor
- Array operations
- Logical operators
- Type checking
- Regular expressions
- Nested document queries
# transactions.py demonstrates:
- Starting and managing transactions
- Performing multiple operations within a transaction
- Handling transaction rollbacks
- Error handling in transactions
- Transaction status monitoring
# async_usage.py demonstrates:
- Using the async client with asyncio
- Managing collections asynchronously
- Performing CRUD operations asynchronously
- Using transactions
- Error handling in async context
To run an example:
python examples/basic_usage.py
# List all collections
collections = client.list_collections()
# Get detailed collection list
detailed_collections = client.list_collections_detailed()
# Create a new collection
client.create_collection("users", "Collection for user data")
# Get collection details
collection = client.get_collection("users")
# Delete a collection
client.delete_collection("users")
# List documents with MongoDB-style queries
documents = client.list_documents("users", {
"age": { "$gt": 25 },
"status": { "$in": ["active", "pending"] },
"$or": [
{ "email": { "$exists": true } },
{ "phone": { "$exists": true } }
]
}, sort={"age": 1, "name": -1}, limit=10)
# Create a new document
document = {
"name": "John Doe",
"email": "john@example.com",
"age": 30
}
result = client.create_document("users", document)
# Get a specific document
document = client.get_document("users", "document_id")
# Update a document with MongoDB-style operators
update = {
"$set": { "name": "John Doe" },
"$inc": { "visits": 1 },
"$push": { "tags": { "$each": ["new", "user"] } },
"$currentDate": { "lastModified": true }
}
client.update_document("users", "document_id", update)
# Delete a document
client.delete_document("users", "document_id")
# Create an index
client.create_index("users", ["email", "age"])
# List all indexes
indexes = client.list_indexes("users")
# Start a transaction
transaction = client.start_transaction()
transaction_id = transaction["transaction_id"]
# Commit a transaction
client.commit_transaction(transaction_id)
# Rollback a transaction
client.rollback_transaction(transaction_id)
# Get transaction status
status = client.get_transaction_status(transaction_id)
# Get database statistics
stats = client.get_stats()
# Get detailed statistics (admin only)
detailed_stats = client.get_detailed_stats()
$eq, $ne, $gt, $gte, $lt, $lte$in, $nin$exists$type$regex$or, $and, $not, $nor$set: Set field values$inc: Increment numeric values$mul: Multiply numeric values$rename: Rename fields$unset: Remove fields$min: Set minimum value$max: Set maximum value$currentDate: Set current date$addToSet: Add unique elements to array$push: Add elements to array$pop: Remove first/last element from array$pull: Remove elements from array by condition$pullAll: Remove all specified elements from arrayThe client provides comprehensive error handling with specific exception types for different error scenarios:
from masedb.exceptions import MaseDBError, BadRequestError, UnauthorizedError
try:
client.create_document("users", {"name": "John"})
except BadRequestError as e:
print(f"Invalid request: {e}")
except UnauthorizedError as e:
print(f"Authentication failed: {e}")
except MaseDBError as e:
print(f"Database error: {e}")
Contributions are welcome! Please feel free to submit a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.
MaseDB Python Client - это мощная библиотека для взаимодействия с API базы данных Mase. Она предоставляет как синхронный, так и асинхронный интерфейсы для операций с базой данных, поддерживает MongoDB-подобные запросы, транзакции, индексацию и комплексную обработку ошибок.
pip install masedb
# Клонировать репозиторий
git clone https://github.com/maseai/masedb.git
# Перейти в директорию проекта
cd masedb
# Установить в режиме разработки
pip install -e .
from masedb import MaseDBClient
# Инициализация клиента с вашим API ключом
client = MaseDBClient(api_key="ваш_api_ключ")
# Создание коллекции
client.create_collection("users", "Коллекция для данных пользователей")
# Создание документа
document = {
"name": "Иван Иванов",
"email": "ivan@example.com",
"age": 30
}
result = client.create_document("users", document)
В директории examples вы найдете полные рабочие примеры:
basic_usage.py - Базовые операции CRUD и управление коллекциямиadvanced_queries.py - Сложные MongoDB-подобные операторы запросов и операции с массивамиtransactions.py - Управление транзакциями и примеры денежных переводовasync_usage.py - Асинхронные операции с asyncioКаждый пример демонстрирует различные аспекты библиотеки:
# basic_usage.py демонстрирует:
- Создание и управление коллекциями
- Базовые операции CRUD с документами
- Использование MongoDB-подобных операторов запросов
- Обработку ошибок
# advanced_queries.py демонстрирует:
- Сложные MongoDB-подобные операторы запросов
- Операции с массивами
- Логические операторы
- Проверку типов
- Регулярные выражения
- Запросы к вложенным документам
# transactions.py демонстрирует:
- Начало и управление транзакциями
- Выполнение множественных операций в транзакции
- Обработку откатов транзакций
- Обработку ошибок в транзакциях
- Мониторинг статуса транзакций
# async_usage.py демонстрирует:
- Использование асинхронного клиента с asyncio
- Асинхронное управление коллекциями
- Асинхронное выполнение операций CRUD
- Использование транзакций
- Обработку ошибок в асинхронном контексте
FAQs
Python client library for Mase Database API
We found that masedb demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Popular npm packages like eslint-config-prettier were compromised after a phishing attack stole a maintainer’s token, spreading malicious updates.
Security News
/Research
A phishing attack targeted developers using a typosquatted npm domain (npnjs.com) to steal credentials via fake login pages - watch out for similar scams.
Security News
Knip hits 500 releases with v5.62.0, refining TypeScript config detection and updating plugins as monthly npm downloads approach 12M.