rhosocial-activerecord-mariadb 1.0.0.dev1

MariaDB backend implementation for rhosocial-activerecord, providing a robust and optimized MariaDB database support.

rhosocial ActiveRecord MariaDB Backend

MariaDB backend implementation for rhosocial-activerecord, providing a robust and optimized MariaDB database support.

Overview

This package provides MariaDB backend support for the rhosocial-activerecord ORM framework. It enables seamless integration with MariaDB databases while leveraging all the features of the ActiveRecord pattern implementation.

Features

This project is still under development and features are subject to change. Please stay tuned for the latest changes.

• 🚀 Optimized MariaDB-specific query generation
• 🔒 Full support for MariaDB's unique features
• 📦 Connection pooling support (optional)
• 🔄 Comprehensive transaction management
• 🔍 Advanced query capabilities specific to MariaDB
• 🔌 Simple configuration and setup

Requirements

• Python 3.8+
• rhosocial-activerecord 1.0.0+
• mariadb 1.1.0+

Installation

# Basic installation
pip install rhosocial-activerecord-mariadb

# With connection pooling support
pip install rhosocial-activerecord-mariadb[pooling]

# With development tools
pip install rhosocial-activerecord-mariadb[dev]

Usage

from rhosocial.activerecord import ActiveRecord
from rhosocial.activerecord.backend.impl.mariadb.backend import MariaDBBackend
from rhosocial.activerecord.backend.typing import ConnectionConfig
from datetime import datetime
from typing import Optional

class User(ActiveRecord):
    __table_name__ = 'users'
    
    id: int
    name: str
    email: str
    created_at: datetime
    deleted_at: Optional[datetime] = None

# Configure with MariaDB backend
User.configure(
    ConnectionConfig(
        host='localhost',
        port=3306,
        database='myapp',
        user='dbuser',
        password='dbpassword'
    ),
    backend_class=MariaDBBackend
)

# Create a table (if not exists)
User.create_table_if_not_exists()

# Create a new user
user = User(name='John Doe', email='[e-mail]', created_at=datetime.now())
user.save()

# Query users
active_users = User.query() \
    .where('deleted_at IS NULL') \
    .order_by('created_at DESC') \
    .all()

# Update user
user.name = 'Jane Doe'
user.save()

# Delete user (soft delete if implemented)
user.delete()

Advanced MariaDB Features

This backend supports MariaDB-specific features and optimizations:

# Using MariaDB fulltext search
results = User.query() \
    .where('MATCH(name, email) AGAINST(? IN BOOLEAN MODE)', ('+John -Doe', )) \
    .all()

# Using MariaDB JSON operations
results = User.query() \
    .where('JSON_EXTRACT(settings, "$.notifications") = ?', ('enabled', )) \
    .all()

# Batch insert with ON DUPLICATE KEY UPDATE
User.batch_insert_or_update([user1, user2, user3])

Documentation

Complete documentation is available at python-activerecord MariaDB Backend

Contributing

We welcome and value all forms of contributions! For details on how to contribute, please see our Contributing Guide.

License

Copyright © 2025 vistart