amphp/postgres

Asynchronous PostgreSQL client for Amp.

v2.0.0-beta.4 2023-05-07 05:05 UTC

Requires

• php: >=8.1
• amphp/amp: ^3
• amphp/pipeline: ^1
• amphp/sql: ^2
• amphp/sql-common: ^2

Requires (Dev)

• ext-pgsql: *
• ext-pq: *
• amphp/php-cs-fixer-config: ^2-dev
• amphp/phpunit-util: ^3
• phpunit/phpunit: ^9
• psalm/phar: ^5.4

MIT

• Aaron Piotrowski

• database
• db
• postgresql
• pgsql
• async
• asynchronous
• postgre

README

Async PostgreSQL client for PHP built with Amp.

Installation

This package can be installed as a Composer dependency.

composer require amphp/postgres

Requirements

• PHP 7.1+
• ext-pgsql or pecl-pq

Note: pecl-ev is not compatible with ext-pgsql. If you wish to use pecl-ev for the event loop backend, you must use pecl-pq.

Documentation & Examples

Prepared statements and parameterized queries support named placeholders, as well as ? and standard numeric (i.e. $1) placeholders.

More examples can be found in the examples directory.

use Amp\Postgres;
use Amp\Postgres\PostgresConfig;
use Amp\Sql\Result;
use Amp\Sql\Statement;

Amp\Loop::run(function () {
    $config = PostgresConfig::fromString("host=localhost user=postgres db=test");

    /** @var Postgres\Pool $pool */
    $pool = Postgres\pool($config);

    /** @var Statement $statement */
    $statement = yield $pool->prepare("SELECT * FROM test WHERE id = :id");

    /** @var Result $result */
    $result = yield $statement->execute(['id' => 1337]);
    while (yield $result->advance()) {
        $row = $result->getCurrent();
        // $row is an array (map) of column values. e.g.: $row['column_name']
    }
});

Versioning

amphp/postgres follows the semver semantic versioning specification like all other amphp packages.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

License

The MIT License (MIT). Please see LICENSE for more information.