Skip to content

dazzle-php/mysql

Repository files navigation

Dazzle Async MySQL Driver

Build Status Code Coverage Code Quality Latest Stable Version Latest Unstable Version License

Note: This repository is part of Dazzle Project - the next-gen library for PHP. The project's purpose is to provide PHP developers with a set of complete tools to build functional async applications. Please, make sure you read the attached README carefully and it is guaranteed you will be surprised how easy to use and powerful it is. In the meantime, you might want to check out the rest of our async libraries in Dazzle repository for the full extent of Dazzle experience.


Description

TODO

Feature Highlights

Dazzle MySQL features:

TODO

Provided Example(s)

Quickstart

This example demonstrates how to connect to MySQL database and print all tables stored inside it.

$loop = new Loop(new SelectLoop);

$mysql = new Database($loop, [
    'endpoint' => 'tcp://127.0.0.1:3306',
    'user'     => 'root',
    'pass'     => 'root',
    'dbname'   => 'dazzle',
]);

$mysql
    ->start()
    ->then(function() use($mysql) {
        printf("Connection has been established!\n");
        printf("Connection state is %s\n", $mysql->getState());
    })
    ->done(null, function($ex) {
        printf("Error: %s\n", var_export((string) $ex, true));
    });

$mysql->query('SHOW TABLES')
    ->then(function ($command) use ($loop) {
        $results = $command->resultRows;
        $fields  = $command->resultFields;

        printf("|%-60s|\n", str_repeat('-', 60));
        printf("|%-60s|\n", ' ' . $fields[0]['name']);
        printf("|%-60s|\n", str_repeat('-', 60));

        foreach ($results as $result)
        {
            printf("| # %-56s |\n", $result[$fields[0]['name']]);
        }
        printf("|%-60s|\n", str_repeat('-', 60));
    })
    ->then(null, function($ex) {
        printf("Error: %s\n", var_export((string) $ex, true));
    })
    ->done(function() use($loop) {
        $loop->stop();
    });

$loop->start();

Additional

TODO

Comparison

This section contains Dazzle vs React comparison many users requested. If you are wondering why this section has been created, see the author's note at the end of it.

Performance

TODO

Details

TODO

Note from the author

Note is available in NOTE file.

Requirements

Dazzle MySQL requires:

  • PHP-5.6 or PHP-7.0+,
  • UNIX or Windows OS.

Installation

To install this library make sure you have composer installed, then run following command:

$> composer require dazzle-php/mysql

Tests

Tests can be run via:

$> vendor/bin/phpunit -d memory_limit=1024M

Versioning

Versioning of Dazzle libraries is being shared between all packages included in Dazzle Project. That means the releases are being made concurrently for all of them. On one hand this might lead to "empty" releases for some packages at times, but don't worry. In the end it is far much easier for contributors to maintain and -- what's the most important -- much more straight-forward for users to understand the compatibility and inter-operability of the packages.

Contributing

Thank you for considering contributing to this repository!

License

Dazzle MySQL is open-sourced software licensed under the MIT license.


"Everything is possible. The impossible just takes longer." ― Dan Brown