Skip to main content

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

Project description

rhosocial ActiveRecord MySQL Backend

PyPI version Python Tests Coverage Status License Powered by vistart

rhosocial ActiveRecord Logo

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

Overview

This package provides MySQL backend support for the rhosocial-activerecord ORM framework. It enables seamless integration with MySQL 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 MySQL-specific query generation
  • 🔒 Full support for MySQL's unique features
  • 📦 Connection pooling support (optional)
  • 🔄 Comprehensive transaction management
  • 🔍 Advanced query capabilities specific to MySQL
  • 🔌 Simple configuration and setup

Requirements

  • Python 3.8+
  • rhosocial-activerecord 1.0.0+
  • mysql-connector-python 9.2.0+

Installation

# Basic installation
pip install rhosocial-activerecord-mysql

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

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

Usage

from rhosocial.activerecord import ActiveRecord
from rhosocial.activerecord.backend.impl.mysql.backend import MySQLBackend
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 MySQL backend
User.configure(
    ConnectionConfig(
        host='localhost',
        port=3306,
        database='myapp',
        user='dbuser',
        password='dbpassword'
    ),
    backend_class=MySQLBackend
)

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

# Create a new user
user = User(name='John Doe', email='john@example.com', 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 MySQL Features

This backend supports MySQL-specific features and optimizations:

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

# Using MySQL JSON operations
results = User.query() \
    .where('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 MySQL Backend

Contributing

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

License

license

Copyright © 2025 vistart

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rhosocial_activerecord_mysql-1.0.0.dev1.tar.gz (24.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file rhosocial_activerecord_mysql-1.0.0.dev1.tar.gz.

File metadata

File hashes

Hashes for rhosocial_activerecord_mysql-1.0.0.dev1.tar.gz
Algorithm Hash digest
SHA256 8963a92f6924e3d39880e93e5102d47ae3d642fb96bbb61173edc1617997526a
MD5 fc18f0779a73add40d4ec57dbf8c549e
BLAKE2b-256 5f6f2df3f14b2e232199563e4c3e14d0876ecf0572114305dfe4559978949c85

See more details on using hashes here.

Provenance

The following attestation bundles were made for rhosocial_activerecord_mysql-1.0.0.dev1.tar.gz:

Publisher: publish.yml on rhosocial/python-activerecord-mysql

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rhosocial_activerecord_mysql-1.0.0.dev1-py3-none-any.whl.

File metadata

File hashes

Hashes for rhosocial_activerecord_mysql-1.0.0.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 c276059b899e9f4696220800f6b7df95e7141bf25e268fee8279a6a45be922a3
MD5 e9b646c236e6541cf0c9cc99db765d33
BLAKE2b-256 611382e2c849b2385ee5a88dcdb93757c61bebb8c8f9751f5d842dbe244dfdab

See more details on using hashes here.

Provenance

The following attestation bundles were made for rhosocial_activerecord_mysql-1.0.0.dev1-py3-none-any.whl:

Publisher: publish.yml on rhosocial/python-activerecord-mysql

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page