PHP Класс InfluxDB\Client

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$admin InfluxDB\Client\Admin
$lastQuery null Stores the last query that ran

Защищенные свойства (Protected)

Свойство Тип Описание
$baseURI
$driver InfluxDB\Driver\DriverInterface
$host string
$options array
$password string
$port integer
$scheme boolean
$timeout float
$udpPort integer
$useUdp boolean
$username string
$verifySSL boolean

Открытые методы

Метод Описание
__construct ( string $host, integer $port = 8086, string $username = '', string $password = '', boolean $ssl = false, boolean $verifySSL = false, integer $timeout )
fromDSN ( string $dsn, integer $timeout, boolean $verifySSL = false ) : Client | Database Build the client from a dsn Examples:
getBaseURI ( ) : mixed
getDriver ( ) : InfluxDB\Driver\DriverInterface | InfluxDB\Driver\QueryDriverInterface
getHost ( ) : string
getLastQuery ( ) : null | string Returns the last executed query
getTimeout ( ) : float
listDatabases ( ) List all the databases
listUsers ( ) : array List all the users
query ( string $database, string $query, array $parameters = [] ) : influxdb\ResultSet Query influxDB
selectDB ( string $name ) : Database Use the given database
setDriver ( InfluxDB\Driver\DriverInterface $driver )
write ( array $parameters, string | array $payload ) : boolean Write data

Защищенные методы

Метод Описание
pointsToArray ( array $points ) : array

Описание методов

__construct() публичный Метод

public __construct ( string $host, integer $port = 8086, string $username = '', string $password = '', boolean $ssl = false, boolean $verifySSL = false, integer $timeout )
$host string
$port integer
$username string
$password string
$ssl boolean
$verifySSL boolean
$timeout integer

fromDSN() публичный статический Метод

https+influxdb://username:pass@localhost:8086/databasename udp+influxdb://username:pass@localhost:4444/databasename
public static fromDSN ( string $dsn, integer $timeout, boolean $verifySSL = false ) : Client | Database
$dsn string
$timeout integer
$verifySSL boolean
Результат Client | Database

getBaseURI() публичный Метод

public getBaseURI ( ) : mixed
Результат mixed

getDriver() публичный Метод

public getDriver ( ) : InfluxDB\Driver\DriverInterface | InfluxDB\Driver\QueryDriverInterface
Результат InfluxDB\Driver\DriverInterface | InfluxDB\Driver\QueryDriverInterface

getHost() публичный Метод

public getHost ( ) : string
Результат string

getLastQuery() публичный Метод

Returns the last executed query
public getLastQuery ( ) : null | string
Результат null | string

getTimeout() публичный Метод

public getTimeout ( ) : float
Результат float

listDatabases() публичный Метод

List all the databases
public listDatabases ( )

listUsers() публичный Метод

List all the users
public listUsers ( ) : array
Результат array

pointsToArray() защищенный Метод

protected pointsToArray ( array $points ) : array
$points array
Результат array

query() публичный Метод

Query influxDB
public query ( string $database, string $query, array $parameters = [] ) : influxdb\ResultSet
$database string
$query string
$parameters array
Результат influxdb\ResultSet

selectDB() публичный Метод

Use the given database
public selectDB ( string $name ) : Database
$name string
Результат Database

setDriver() публичный Метод

public setDriver ( InfluxDB\Driver\DriverInterface $driver )
$driver InfluxDB\Driver\DriverInterface

write() публичный Метод

Write data
public write ( array $parameters, string | array $payload ) : boolean
$parameters array
$payload string | array InfluxDB payload (Or array of payloads) that conform to the Line syntax.
Результат boolean

Описание свойств

$admin публичное свойство

public Admin,InfluxDB\Client $admin
Результат InfluxDB\Client\Admin

$baseURI защищенное свойство

protected $baseURI

$driver защищенное свойство

protected DriverInterface,InfluxDB\Driver $driver
Результат InfluxDB\Driver\DriverInterface

$host защищенное свойство

protected string $host
Результат string

$lastQuery публичное статическое свойство

Stores the last query that ran
public static null $lastQuery
Результат null

$options защищенное свойство

protected array $options
Результат array

$password защищенное свойство

protected string $password
Результат string

$port защищенное свойство

protected int $port
Результат integer

$scheme защищенное свойство

protected bool $scheme
Результат boolean

$timeout защищенное свойство

protected float $timeout
Результат float

$udpPort защищенное свойство

protected int $udpPort
Результат integer

$useUdp защищенное свойство

protected bool $useUdp
Результат boolean

$username защищенное свойство

protected string $username
Результат string

$verifySSL защищенное свойство

protected bool $verifySSL
Результат boolean