Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefanotorresi/influxdb-php-async
An asyncronous client for InfluxDB, implemented via ReactPHP.
https://github.com/stefanotorresi/influxdb-php-async
guzzle influxdb php reactphp
Last synced: 18 days ago
JSON representation
An asyncronous client for InfluxDB, implemented via ReactPHP.
- Host: GitHub
- URL: https://github.com/stefanotorresi/influxdb-php-async
- Owner: stefanotorresi
- License: mit
- Created: 2017-02-22T10:11:50.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-19T14:46:12.000Z (almost 7 years ago)
- Last Synced: 2024-10-03T16:21:29.798Z (about 1 month ago)
- Topics: guzzle, influxdb, php, reactphp
- Language: PHP
- Homepage:
- Size: 93.8 KB
- Stars: 11
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# InfluxDB PHP Async
An asyncronous client for [InfluxDB][InfluxDB], implemented via [ReactPHP][ReactPHP].
[](https://travis-ci.org/stefanotorresi/influxdb-php-async)
[](https://packagist.org/packages/stefanotorresi/influxdb-php-async)
[](https://packagist.org/packages/stefanotorresi/influxdb-php-async)
### Installation
Use [Composer][Composer]
`composer require stefanotorresi/influxdb-php-async`
### Usage
Each client implementation exposes three main methods:
```php
interface AsyncClient
{
public function query(string $query, array $params = []): Promise;
public function write(string $payload, array $params = []): Promise;
public function ping(): Promise;
/* etc. */
}
```
The default implementation uses [Buzz React][Buzz React] and we'll use it throughout the rest of this document.
Here is a basic usage example where we first create a database, then write a line to it:
```php
$client = new ReactHttpClient();
$client
->query('CREATE DATABASE test')
->then(function($response) use ($client) {
return $client->write('measure,tag="foo" value="bar"', ['db' => 'test']);
})
->done()
;
$client->run();
```
Note that you need to run the ReactPHP event loop. If you don't inject your own, a default loop is composed by the client, and can be started via the `run` method.
This API assumes that you're familiar with [ReactPHP promises][ReactPHP promises].
#### Configuration
These are the default options:
```php
[
'host' => 'localhost',
'port' => 8086,
'database' => '',
'username' => '',
'password' => '',
'socket_options' => [],
];
```
You can change them at instantion time, defaults will be merged with the one passed:
```php
$options = [
'host' => 'influx-db.domain.tld',
'socket_options' => [
'tls' => true,
],
];
$client = new ReactHttpClient($options);
```
For details about the `socket_options` key, please refer to [react/socket documentation].
### Future developments / TO-DO list
- An UDP client implemented with [react/datagram](https://github.com/reactphp/datagram).
- A QueryBuilder, possibly identical to the one in the [official influxdb-php client].
- A set of response decoders that convert the JSON body from PSR-7 Responses to something more readily consumable.
- Explore the possibility of merging this package into the official sdk.
### License
This package is released under the [MIT](https://github.com/stefanotorresi/influxdb-php-async/blob/master/LICENSE) license.
[InfluxDB]: https://github.com/influxdata/influxdb
[ReactPHP]: http://reactphp.org
[Composer]: https://getcomposer.org
[Buzz React]: https://github.com/clue/php-buzz-react
[ReactPHP promises]: https://github.com/reactphp/promise
[official influxdb-php client]: https://github.com/influxdata/influxdb-php
[react/socket documentation]: https://github.com/reactphp/socket#connector