InfluxDB PHP Client
Public Member Functions | List of all members
InfluxDB2\QueryApi Class Reference
Inheritance diagram for InfluxDB2\QueryApi:
InfluxDB2\DefaultApi

Public Member Functions

 __construct (array $options)
 
 queryRaw ($query, ?string $org=null, ?Dialect $dialect=null)
 
 query ($query, ?string $org=null, ?Dialect $dialect=null)
 
 queryStream ($query, ?string $org=null, ?Dialect $dialect=null)
 
- Public Member Functions inherited from InfluxDB2\DefaultApi
 __construct (array $options)
 
 post ($payload, $uriPath, $queryParams, $timeout=null, bool $stream=false)
 
 get ($payload, $uriPath, $queryParams, $timeout=null)
 

Additional Inherited Members

- Static Public Member Functions inherited from InfluxDB2\DefaultApi
static log (string $level, string $message, array $options)
 
- Public Attributes inherited from InfluxDB2\DefaultApi
const DEFAULT_TIMEOUT = 10
 
 $options
 
 $http
 
- Protected Member Functions inherited from InfluxDB2\DefaultApi
 check ($key, $value)
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\QueryApi::__construct ( array  $options)

QueryApi constructor.

Parameters
array$options

Reimplemented from InfluxDB2\DefaultApi.

Member Function Documentation

◆ query()

InfluxDB2\QueryApi::query (   $query,
?string  $org = null,
?Dialect  $dialect = null 
)

Executes the Flux query against the InfluxDB 2.x and synchronously map the whole response to FluxTable[] NOTE: This method is not intended for large query results.

Parameters
string | Query$query
string | null$org
Dialect | null$dialect
Returns
FluxTable[]

◆ queryRaw()

InfluxDB2\QueryApi::queryRaw (   $query,
?string  $org = null,
?Dialect  $dialect = null 
)

Executes the Flux query and returns the unparsed raw result

Parameters
string | Query$queryflux query to execute. The data could be represent by string, Query
string | null$orgspecifies the source organization
Dialect | null$dialectcsv dialect
Returns
string

◆ queryStream()

InfluxDB2\QueryApi::queryStream (   $query,
?string  $org = null,
?Dialect  $dialect = null 
)

Executes the Flux query against the InfluxDB 2.x and returns generator to stream the result.

Parameters
string |  Query$query
string | null$org
Dialect | null$dialect
Returns
FluxCsvParser generator

The documentation for this class was generated from the following file: