Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/leocavalcante/swoole-postgresql-doctrine-driver

🔌 A Doctrine DBAL Driver implementation on top of Swoole Coroutine PostgreSQL client
https://github.com/leocavalcante/swoole-postgresql-doctrine-driver

async connection-pool coroutine database dbal doctrine driver orm pool postgresql swoole

Last synced: 1 day ago
JSON representation

🔌 A Doctrine DBAL Driver implementation on top of Swoole Coroutine PostgreSQL client

Awesome Lists containing this project

README

        

# Swoole Coroutine PostgreSQL Doctrine DBAL Driver

A `Doctrine\DBAL\Driver` implementation on top of `Swoole\Coroutine\PostgreSQL`.

## Getting started

### Install

```shell
composer require leocavalcante/swoole-postgresql-doctrine-driver
```

### Usage

Doctrine parameters, for both DBAL and ORM projects, accepts the `driverClass` option; it is where we can inject this project's driver:

```php
use Doctrine\DBAL\{Driver, DriverManager};

$params = [
'dbname' => 'postgres',
'user' => 'postgres',
'password' => 'postgres',
'host' => 'db',
'driverClass' => Driver\Swoole\Coroutine\PostgreSQL\Driver::class,
'poolSize' => 8,
];

$conn = DriverManager::getConnection($params);
```

*Yes, I deliberately used the `Doctrine\DBAL\Driver` namespace + `Swoole\Coroutine\PostgreSQL` namespace, so it is not confusing.*

#### You are ready to rock inside Coroutines (Fibers):

```php
Co\run(static function() use ($conn): void {
$results = [];
$wg = new Co\WaitGroup();
$start_time = time();

Co::create(static function() use (&$results, $wg, $conn): void {
$wg->add();
$results[] = $conn->executeQuery('select 1, pg_sleep(1)')->fetchOne();
$wg->done();
});

Co::create(static function() use (&$results, $wg, $conn): void {
$wg->add();
$results[] = $conn->executeQuery('select 1, pg_sleep(1)')->fetchOne();
$wg->done();
});

$wg->wait();
$elapsed = time() - $start_time;
$sum = array_sum($results);

echo "Two pg_sleep(1) queries in $elapsed second, returning: $sum\n";
});
```

You should be seeing `Two pg_sleep(1) queries in 1 second, returning: 2` and the total time should **not** be 2 (the sum of `pg_sleep(1)`'s) because they ran concurrently.

```shell
real 0m1.228s
user 0m0.036s
sys 0m0.027s
```

## Developing

### Use Composer through Docker

```shell
docker-compose run --rm composer install
docker-compose run --rm composer test
```

It will build a development image with PHP, Swoole, Swoole's PostgreSQL extension and PCOV for coverage.