blrf/dbal

Async DBAL for ReactPHP.

v1.0.3 2024-04-25 05:31 UTC

Requires

• php: >=8.1.0
• react/mysql: ^0.6

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^11 || ^10
• react/async: ^4.2

MIT

• database
• dbal
• mysql
• async
• reactphp

README

Async database abstraction layer for ReactPHP.

Full example is available in Bookstore respository. Bookstore example uses blrf/dbal, blrf/orm and framework-x to showcase current DBAL/ORM development.

DBAL documentation is available at https://blrf.net/dbal/.

Table of contents

• Example
• Streaming example
• Usage
• Install
• Tests
• License

Example

<?php
require __DIR__ . '/vendor/autoload.php';
$config  = new Blrf\Dbal\Config('mysql://user:pass@localhost/bookstore');

$config->create()->then(
    function (Blrf\Dbal\Connection $db) {
        // start query builder
        $qb = $db->query()
            ->select('*')
            ->from('book')
            ->where(
                fn(Blrf\Dbal\Query\ConditionBuilder $cb) => $cb->or(
                    $cb->and(
                        $cb->eq('isbn13'),
                        $cb->eq('language_id'),
                    ),
                    $cb->eq('title')
                )
            )
            ->setParameters(['9789998691568', 1, 'Moby Dick'])
            ->limit(3);
        // $qb->getSql(): SELECT * FROM book WHERE ((isbn13 = ? AND language_id = ?) OR title = ?) LIMIT 3
        return $qb->execute();
    }
)->then(
    function (Blrf\Dbal\Result $result) {
        print_r($result->rows);
    }
);

Streaming example

This method returns a readable stream that will emit each row of the result set as a data event. It will only buffer data to complete a single row in memory and will not store the whole result set. This allows you to process result sets of unlimited size that would not otherwise fit into memory.

require __DIR__ . '/../vendor/autoload.php';
$config  = new Blrf\Dbal\Config('mysql://user:pass@localhost/bookstore');

$config->create()->then(
    function (Blrf\Dbal\Connection $db) {
        // start query builder
        $qb = $db->query()
            ->select('*')
            ->from('book')
            ->where(
                fn(Blrf\Dbal\Query\ConditionBuilder $cb) => $cb->or(
                    $cb->and(
                        $cb->eq('isbn13'),
                        $cb->eq('language_id'),
                    ),
                    $cb->eq('title')
                )
            )
            ->setParameters(['9789998691568', 1, 'Moby Dick'])
            ->limit(3);
        // sql: SELECT * FROM book WHERE ((isbn13 = ? AND language_id = ?) OR title = ?) LIMIT 3
        $stream = $qb->stream();
        $stream->on('data', function (array $row) {
            echo " - received row: \n";
            print_r($row);
        });
        $stream->on('error', function (\Throwable $e) {
            echo " ! error: " . $e->getMessage() . "\n";
        });
        $stream->on('close', function () {
            echo " - Stream done\n";
        });
    }
);

Usage

Please see the DBAL documentation site.

Install

composer require blrf/dbal

Tests

To run the test suite, go to project root and run:

vendor/bin/phpunit

License

MIT, see LICENSE file.

Todo

• Write more examples
• Write having
• Schema manager