README

⚠️ IMPORTANT: This repository is automatically generated from the ody repo and is read-only.

A high-performance database integration framework for PHP applications leveraging Swoole's coroutines.

Overview

The ODY Database module provides a connection pool implementation that works with popular PHP ORM solutions. It's designed to maximize performance in Swoole environments by efficiently managing database connections across coroutines.

Features

• Connection pooling with Swoole coroutine awareness
• Support for Doctrine ORM, and standalone DBAL
• Automatic connection binding to coroutines
• Built-in connection lifecycle management
• Connection health checks and leak detection
• Configurable pool size and connection settings

Installation

composer require ody/database

Doctrine ORM

composer require doctrine/orm doctrine/dbal symfony/cache

DBAL

composer require doctrine/dbal

Basic Usage

Configuration

Define your database configuration:

// config/database.php
return [
    'environments' => [
        'local' => [
            'driver' => 'mysql',
            'host' => 'localhost',
            'port' => 3306,
            'database' => 'your_database',
            'username' => 'your_username',
            'password' => 'your_password',
            'charset' => 'utf8mb4',
        ],
    ],
    'connection_pool_enabled' => true,
    'pool_size' => 10,
];

Using with Doctrine ORM

use Ody\DB\Doctrine\Facades\ORM;
use App\Entities\User;

// Get entity manager
$entityManager = ORM::entityManager();

// Working with entities
$user = $entityManager->find(User::class, 1);
$entityManager->persist($user);
$entityManager->flush();

Using with Doctrine DBAL

use Ody\DB\Doctrine\Facades\DBAL;

// Execute queries
$users = $this->connection->fetchAllAssociative('SELECT * FROM users WHERE active = ?', [1]);

// Using query builder
$queryBuilder = $this->connection->createQueryBuilder();
$result = $queryBuilder
    ->select('u.*')
    ->from('users', 'u')
    ->where('u.active = :active')
    ->setParameter('active', 1)
    ->executeQuery()
    ->fetchAllAssociative();

Direct Connection Pool Access

use Ody\DB\ConnectionManager;

// Initialize the pool
ConnectionManager::initPool($config);

// Get a connection from the pool
$connection = ConnectionManager::getConnection();

// Use the PDO connection
$stmt = $connection->prepare('SELECT * FROM users WHERE id = ?');
$stmt->execute([1]);
$user = $stmt->fetch(PDO::FETCH_ASSOC);

// No need to return the connection - it's automatically returned when the coroutine ends

Advanced Configuration

The connection pool can be finely tuned with options for:

• Minimum idle connections
• Idle timeout
• Maximum connection lifetime
• Borrowing timeout
• Connection health checks
• Leak detection threshold

For detailed documentation on advanced configuration and usage, refer to the full documentation.

Performance Benefits

• Connections are reused across requests, eliminating the overhead of establishing new connections
• Automatic binding to coroutines ensures connection safety in concurrent environments
• Connection health checks prevent using broken connections
• Leak detection helps identify and fix connection leaks
• Configurable pool size matches your application needs and server resources

License

This package is licensed under the MIT License.