InfluxDB PHP Client
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\QueryService Class Reference

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 getQuerySuggestions ($zap_trace_span=null)
 
 getQuerySuggestionsWithHttpInfo ($zap_trace_span=null)
 
 getQuerySuggestionsAsync ($zap_trace_span=null)
 
 getQuerySuggestionsAsyncWithHttpInfo ($zap_trace_span=null)
 
 getQuerySuggestionsName ($name, $zap_trace_span=null)
 
 getQuerySuggestionsNameWithHttpInfo ($name, $zap_trace_span=null)
 
 getQuerySuggestionsNameAsync ($name, $zap_trace_span=null)
 
 getQuerySuggestionsNameAsyncWithHttpInfo ($name, $zap_trace_span=null)
 
 postQuery ($zap_trace_span=null, $accept_encoding='identity', $content_type=null, $org=null, $org_id=null, $unknown_base_type=null)
 
 postQueryWithHttpInfo ($zap_trace_span=null, $accept_encoding='identity', $content_type=null, $org=null, $org_id=null, $unknown_base_type=null)
 
 postQueryAsync ($zap_trace_span=null, $accept_encoding='identity', $content_type=null, $org=null, $org_id=null, $unknown_base_type=null)
 
 postQueryAsyncWithHttpInfo ($zap_trace_span=null, $accept_encoding='identity', $content_type=null, $org=null, $org_id=null, $unknown_base_type=null)
 
 postQueryAnalyze ($zap_trace_span=null, $content_type=null, $query=null)
 
 postQueryAnalyzeWithHttpInfo ($zap_trace_span=null, $content_type=null, $query=null)
 
 postQueryAnalyzeAsync ($zap_trace_span=null, $content_type=null, $query=null)
 
 postQueryAnalyzeAsyncWithHttpInfo ($zap_trace_span=null, $content_type=null, $query=null)
 
 postQueryAst ($zap_trace_span=null, $content_type=null, $language_request=null)
 
 postQueryAstWithHttpInfo ($zap_trace_span=null, $content_type=null, $language_request=null)
 
 postQueryAstAsync ($zap_trace_span=null, $content_type=null, $language_request=null)
 
 postQueryAstAsyncWithHttpInfo ($zap_trace_span=null, $content_type=null, $language_request=null)
 

Protected Member Functions

 getQuerySuggestionsRequest ($zap_trace_span=null)
 
 getQuerySuggestionsNameRequest ($name, $zap_trace_span=null)
 
 postQueryRequest ($zap_trace_span=null, $accept_encoding='identity', $content_type=null, $org=null, $org_id=null, $unknown_base_type=null)
 
 postQueryAnalyzeRequest ($zap_trace_span=null, $content_type=null, $query=null)
 
 postQueryAstRequest ($zap_trace_span=null, $content_type=null, $language_request=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\QueryService::__construct ( ClientInterface  $client = null,
Configuration  $config = null,
HeaderSelector  $selector = null 
)
Parameters
ClientInterface$client
Configuration$config
HeaderSelector$selector

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\QueryService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ getConfig()

InfluxDB2\Service\QueryService::getConfig ( )
Returns
Configuration

◆ getQuerySuggestions()

InfluxDB2\Service\QueryService::getQuerySuggestions (   $zap_trace_span = null)

Operation getQuerySuggestions

Retrieve query suggestions

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\FluxSuggestions|\InfluxDB2\Model\Error

◆ getQuerySuggestionsAsync()

InfluxDB2\Service\QueryService::getQuerySuggestionsAsync (   $zap_trace_span = null)

Operation getQuerySuggestionsAsync

Retrieve query suggestions

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getQuerySuggestionsAsyncWithHttpInfo()

InfluxDB2\Service\QueryService::getQuerySuggestionsAsyncWithHttpInfo (   $zap_trace_span = null)

Operation getQuerySuggestionsAsyncWithHttpInfo

Retrieve query suggestions

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getQuerySuggestionsName()

InfluxDB2\Service\QueryService::getQuerySuggestionsName (   $name,
  $zap_trace_span = null 
)

Operation getQuerySuggestionsName

Retrieve query suggestions for a branching suggestion

Parameters
string$nameThe name of the branching suggestion. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\FluxSuggestion|\InfluxDB2\Model\Error

◆ getQuerySuggestionsNameAsync()

InfluxDB2\Service\QueryService::getQuerySuggestionsNameAsync (   $name,
  $zap_trace_span = null 
)

Operation getQuerySuggestionsNameAsync

Retrieve query suggestions for a branching suggestion

Parameters
string$nameThe name of the branching suggestion. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getQuerySuggestionsNameAsyncWithHttpInfo()

InfluxDB2\Service\QueryService::getQuerySuggestionsNameAsyncWithHttpInfo (   $name,
  $zap_trace_span = null 
)

Operation getQuerySuggestionsNameAsyncWithHttpInfo

Retrieve query suggestions for a branching suggestion

Parameters
string$nameThe name of the branching suggestion. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getQuerySuggestionsNameRequest()

InfluxDB2\Service\QueryService::getQuerySuggestionsNameRequest (   $name,
  $zap_trace_span = null 
)
protected

Create request for operation 'getQuerySuggestionsName'

Parameters
string$nameThe name of the branching suggestion. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getQuerySuggestionsNameWithHttpInfo()

InfluxDB2\Service\QueryService::getQuerySuggestionsNameWithHttpInfo (   $name,
  $zap_trace_span = null 
)

Operation getQuerySuggestionsNameWithHttpInfo

Retrieve query suggestions for a branching suggestion

Parameters
string$nameThe name of the branching suggestion. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\FluxSuggestion|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getQuerySuggestionsRequest()

InfluxDB2\Service\QueryService::getQuerySuggestionsRequest (   $zap_trace_span = null)
protected

Create request for operation 'getQuerySuggestions'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getQuerySuggestionsWithHttpInfo()

InfluxDB2\Service\QueryService::getQuerySuggestionsWithHttpInfo (   $zap_trace_span = null)

Operation getQuerySuggestionsWithHttpInfo

Retrieve query suggestions

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\FluxSuggestions|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postQuery()

InfluxDB2\Service\QueryService::postQuery (   $zap_trace_span = null,
  $accept_encoding = 'identity',
  $content_type = null,
  $org = null,
  $org_id = null,
  $unknown_base_type = null 
)

Operation postQuery

Query InfluxDB

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
string$content_typecontent_type (optional)
string$orgSpecifies the name of the organization executing the query. Takes either the ID or Name interchangeably. If both `orgID` and `org` are specified, `org` takes precedence. (optional)
string$org_idSpecifies the ID of the organization executing the query. If both `orgID` and `org` are specified, `org` takes precedence. (optional)
\InfluxDB2\Model\UNKNOWN_BASE_TYPE$unknown_base_typeFlux query or specification to execute (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
string|\InfluxDB2\Model\Error

◆ postQueryAnalyze()

InfluxDB2\Service\QueryService::postQueryAnalyze (   $zap_trace_span = null,
  $content_type = null,
  $query = null 
)

Operation postQueryAnalyze

Analyze an InfluxQL or Flux query

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$content_typecontent_type (optional)
\InfluxDB2\Model\Query$queryFlux or InfluxQL query to analyze (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\AnalyzeQueryResponse|\InfluxDB2\Model\Error

◆ postQueryAnalyzeAsync()

InfluxDB2\Service\QueryService::postQueryAnalyzeAsync (   $zap_trace_span = null,
  $content_type = null,
  $query = null 
)

Operation postQueryAnalyzeAsync

Analyze an InfluxQL or Flux query

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$content_type(optional)
\InfluxDB2\Model\Query$queryFlux or InfluxQL query to analyze (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postQueryAnalyzeAsyncWithHttpInfo()

InfluxDB2\Service\QueryService::postQueryAnalyzeAsyncWithHttpInfo (   $zap_trace_span = null,
  $content_type = null,
  $query = null 
)

Operation postQueryAnalyzeAsyncWithHttpInfo

Analyze an InfluxQL or Flux query

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$content_type(optional)
\InfluxDB2\Model\Query$queryFlux or InfluxQL query to analyze (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postQueryAnalyzeRequest()

InfluxDB2\Service\QueryService::postQueryAnalyzeRequest (   $zap_trace_span = null,
  $content_type = null,
  $query = null 
)
protected

Create request for operation 'postQueryAnalyze'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$content_type(optional)
\InfluxDB2\Model\Query$queryFlux or InfluxQL query to analyze (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postQueryAnalyzeWithHttpInfo()

InfluxDB2\Service\QueryService::postQueryAnalyzeWithHttpInfo (   $zap_trace_span = null,
  $content_type = null,
  $query = null 
)

Operation postQueryAnalyzeWithHttpInfo

Analyze an InfluxQL or Flux query

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$content_type(optional)
\InfluxDB2\Model\Query$queryFlux or InfluxQL query to analyze (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\AnalyzeQueryResponse|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postQueryAst()

InfluxDB2\Service\QueryService::postQueryAst (   $zap_trace_span = null,
  $content_type = null,
  $language_request = null 
)

Operation postQueryAst

Generate an Abstract Syntax Tree (AST) from a query

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$content_typecontent_type (optional)
\InfluxDB2\Model\LanguageRequest$language_requestAnalyzed Flux query to generate abstract syntax tree. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ASTResponse|\InfluxDB2\Model\Error

◆ postQueryAstAsync()

InfluxDB2\Service\QueryService::postQueryAstAsync (   $zap_trace_span = null,
  $content_type = null,
  $language_request = null 
)

Operation postQueryAstAsync

Generate an Abstract Syntax Tree (AST) from a query

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$content_type(optional)
\InfluxDB2\Model\LanguageRequest$language_requestAnalyzed Flux query to generate abstract syntax tree. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postQueryAstAsyncWithHttpInfo()

InfluxDB2\Service\QueryService::postQueryAstAsyncWithHttpInfo (   $zap_trace_span = null,
  $content_type = null,
  $language_request = null 
)

Operation postQueryAstAsyncWithHttpInfo

Generate an Abstract Syntax Tree (AST) from a query

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$content_type(optional)
\InfluxDB2\Model\LanguageRequest$language_requestAnalyzed Flux query to generate abstract syntax tree. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postQueryAstRequest()

InfluxDB2\Service\QueryService::postQueryAstRequest (   $zap_trace_span = null,
  $content_type = null,
  $language_request = null 
)
protected

Create request for operation 'postQueryAst'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$content_type(optional)
\InfluxDB2\Model\LanguageRequest$language_requestAnalyzed Flux query to generate abstract syntax tree. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postQueryAstWithHttpInfo()

InfluxDB2\Service\QueryService::postQueryAstWithHttpInfo (   $zap_trace_span = null,
  $content_type = null,
  $language_request = null 
)

Operation postQueryAstWithHttpInfo

Generate an Abstract Syntax Tree (AST) from a query

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$content_type(optional)
\InfluxDB2\Model\LanguageRequest$language_requestAnalyzed Flux query to generate abstract syntax tree. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\ASTResponse|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postQueryAsync()

InfluxDB2\Service\QueryService::postQueryAsync (   $zap_trace_span = null,
  $accept_encoding = 'identity',
  $content_type = null,
  $org = null,
  $org_id = null,
  $unknown_base_type = null 
)

Operation postQueryAsync

Query InfluxDB

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
string$content_type(optional)
string$orgSpecifies the name of the organization executing the query. Takes either the ID or Name interchangeably. If both `orgID` and `org` are specified, `org` takes precedence. (optional)
string$org_idSpecifies the ID of the organization executing the query. If both `orgID` and `org` are specified, `org` takes precedence. (optional)
\InfluxDB2\Model\UNKNOWN_BASE_TYPE$unknown_base_typeFlux query or specification to execute (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postQueryAsyncWithHttpInfo()

InfluxDB2\Service\QueryService::postQueryAsyncWithHttpInfo (   $zap_trace_span = null,
  $accept_encoding = 'identity',
  $content_type = null,
  $org = null,
  $org_id = null,
  $unknown_base_type = null 
)

Operation postQueryAsyncWithHttpInfo

Query InfluxDB

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
string$content_type(optional)
string$orgSpecifies the name of the organization executing the query. Takes either the ID or Name interchangeably. If both `orgID` and `org` are specified, `org` takes precedence. (optional)
string$org_idSpecifies the ID of the organization executing the query. If both `orgID` and `org` are specified, `org` takes precedence. (optional)
\InfluxDB2\Model\UNKNOWN_BASE_TYPE$unknown_base_typeFlux query or specification to execute (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postQueryRequest()

InfluxDB2\Service\QueryService::postQueryRequest (   $zap_trace_span = null,
  $accept_encoding = 'identity',
  $content_type = null,
  $org = null,
  $org_id = null,
  $unknown_base_type = null 
)
protected

Create request for operation 'postQuery'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
string$content_type(optional)
string$orgSpecifies the name of the organization executing the query. Takes either the ID or Name interchangeably. If both `orgID` and `org` are specified, `org` takes precedence. (optional)
string$org_idSpecifies the ID of the organization executing the query. If both `orgID` and `org` are specified, `org` takes precedence. (optional)
\InfluxDB2\Model\UNKNOWN_BASE_TYPE$unknown_base_typeFlux query or specification to execute (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postQueryWithHttpInfo()

InfluxDB2\Service\QueryService::postQueryWithHttpInfo (   $zap_trace_span = null,
  $accept_encoding = 'identity',
  $content_type = null,
  $org = null,
  $org_id = null,
  $unknown_base_type = null 
)

Operation postQueryWithHttpInfo

Query InfluxDB

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. (optional, default to 'identity')
string$content_type(optional)
string$orgSpecifies the name of the organization executing the query. Takes either the ID or Name interchangeably. If both `orgID` and `org` are specified, `org` takes precedence. (optional)
string$org_idSpecifies the ID of the organization executing the query. If both `orgID` and `org` are specified, `org` takes precedence. (optional)
\InfluxDB2\Model\UNKNOWN_BASE_TYPE$unknown_base_typeFlux query or specification to execute (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of string|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

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