PHP Класс InfluxDB\Database

Автор: Stephen "TheCodeAssassin" Hoogendijk

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

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

Свойство	Тип	Описание
$client	Client
$name	string	The name of the Database

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

Метод	Описание
__construct ( string $name, Client $client )	Construct a database object
alterRetentionPolicy ( InfluxDB\Database\RetentionPolicy $retentionPolicy )
create ( InfluxDB\Database\RetentionPolicy $retentionPolicy = null, boolean $createIfNotExists = true ) : influxdb\ResultSet	Create this database
createRetentionPolicy ( InfluxDB\Database\RetentionPolicy $retentionPolicy ) : influxdb\ResultSet
drop ( )	Drop this database
exists ( ) : boolean
getClient ( ) : Client
getName ( ) : string
getQueryBuilder ( ) : InfluxDB\Query\Builder	Retrieve the query builder
listRetentionPolicies ( ) : array
query ( string $query, array $params = [] ) : influxdb\ResultSet	Query influxDB
writePayload ( string \| array $payload, string $precision = self::PRECISION_NANOSECONDS, string \| null $retentionPolicy = null ) : boolean	Write a payload into InfluxDB using the current driver. This method is similar to `writePoints()`, except it takes a string payload instead of an array of Points. This is useful in the following situations:
writePoints ( array $points, string $precision = self::PRECISION_NANOSECONDS, string \| null $retentionPolicy = null ) : boolean	Write points into InfluxDB using the current driver. This is the recommended method for inserting data into InfluxDB.

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

Метод	Описание
getRetentionPolicyQuery ( string $method, InfluxDB\Database\RetentionPolicy $retentionPolicy ) : string

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

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

Construct a database object

public __construct ( string $name, Client $client )
$name	string
$client	Client

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

public alterRetentionPolicy ( InfluxDB\Database\RetentionPolicy $retentionPolicy )
$retentionPolicy	InfluxDB\Database\RetentionPolicy

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

Create this database

public create ( InfluxDB\Database\RetentionPolicy $retentionPolicy = null, boolean $createIfNotExists = true ) : influxdb\ResultSet
$retentionPolicy	InfluxDB\Database\RetentionPolicy
$createIfNotExists	boolean	Only create the database if it does not yet exist
Результат	influxdb\ResultSet

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

public createRetentionPolicy ( InfluxDB\Database\RetentionPolicy $retentionPolicy ) : influxdb\ResultSet
$retentionPolicy	InfluxDB\Database\RetentionPolicy
Результат	influxdb\ResultSet

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

Drop this database

public drop ( )

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

public exists ( ) : boolean
Результат	boolean

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

public getClient ( ) : Client
Результат	Client

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

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

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

Retrieve the query builder

public getQueryBuilder ( ) : InfluxDB\Query\Builder
Результат	InfluxDB\Query\Builder

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

protected getRetentionPolicyQuery ( string $method, InfluxDB\Database\RetentionPolicy $retentionPolicy ) : string
$method	string
$retentionPolicy	InfluxDB\Database\RetentionPolicy
Результат	string

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

public listRetentionPolicies ( ) : array
Результат	array

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

Query influxDB

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

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

1) Performing unique queries that may not conform to the current Point standard. 2) Inserting very large set of points into a measurement where looping via array_map() actually hurts performance as the payload may be calculated in advance by caller.

public writePayload ( string \| array $payload, string $precision = self::PRECISION_NANOSECONDS, string \| null $retentionPolicy = null ) : boolean
$payload	string \| array	InfluxDB payload (Or array of payloads) that conform to the Line syntax.
$precision	string	The timestamp precision (defaults to nanoseconds).
$retentionPolicy	string \| null	Specifies an explicit retention policy to use when writing all points. If not set, the default retention period will be used. This is only applicable for the Guzzle driver. The UDP driver utilizes the endpoint configuration defined in the server's influxdb configuration file.
Результат	boolean

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

Write points into InfluxDB using the current driver. This is the recommended method for inserting data into InfluxDB.

public writePoints ( array $points, string $precision = self::PRECISION_NANOSECONDS, string \| null $retentionPolicy = null ) : boolean
$points	array	Array of Point objects
$precision	string	The timestamp precision (defaults to nanoseconds).
$retentionPolicy	string \| null	Specifies an explicit retention policy to use when writing all points. If not set, the default retention period will be used. This is only applicable for the Guzzle driver. The UDP driver utilizes the endpoint configuration defined in the server's influxdb configuration file.
Результат	boolean

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

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

protected Client,influxdb $client
Результат	Client

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

The name of the Database

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