crowdstar/vertica-swoole-adapter

Provides a DB layer for Swoole-based application to communicate to HP Vertica databases.

1.0.0 2020-08-25 22:12 UTC

Requires

• php: >=7.1
• ext-swoole: >=4.4
• crowdstar/exponential-backoff: ~3.0.0
• skatrych/vertica-php-adapter: @dev

Requires (Dev)

• phpunit/phpunit: ~7.0
• psr/log: ^1.1
• swoole/ide-helper: @dev

Suggests

• psr/log: Allow to log errors for debugging purpose.

Apache-2.0

• vertica
• swoole

README

Summary

This library provides a DB layer to communicate to HP Vertica databases for Swoole based applications.

Features supported:

• Connection pool.
• Auto-reconnect.
• Retry with exponential backoff (for failed operations).
• Logging support.

Vertica connections are made through package skatrych/vertica-php-adapter, which is implemented using ODBC. It is not coroutine-friendly, and works in blocking mode only.

This package was derived from our work at Glu Mobile. It has been used in one of our internal microservices talking to Vertica 7.2.0 and 9.3.0 servers, and ran smoothly for months.

Installation

composer require crowdstar/vertica-swoole-adapter

Sample Usage

Following example creates a Vertica connection pool, gets a connection from the pool, makes a database query, then puts the connection back to the pool:

<?php
use CrowdStar\VerticaSwooleAdapter\VerticaAdapter;
use CrowdStar\VerticaSwooleAdapter\VerticaProxy;
use Swoole\ConnectionPool;

$pool = new ConnectionPool(
    function () {
        return new VerticaAdapter($config);
    },
    ConnectionPool::DEFAULT_SIZE,
    VerticaProxy::class
);
/** @var VerticaAdapter $conn */
$conn = $pool->get();
$data = $conn->fetchAll($conn->query($sql)) ?: [];
$pool->put($conn);
?>

For more examples, please check source code under folder examples/. To run the examples, you will need to run following two commands first to install Composer packages and start Docker containers:

docker run --rm -v $(pwd):/var/www -ti phpswoole/swoole:latest-dev composer update -n
docker-compose up --build -d # or "docker-compose up -d" if you don't need to rebuild the image.

Once done, you can run the example(s) using following command(s):

docker exec -ti $(docker ps -qf "name=app") ./examples/example.php
docker exec -ti $(docker ps -qf "name=app") ./examples/benchmark.php
docker exec -ti $(docker ps -qf "name=app") ./examples/test-coroutine-capability.php